33b2ccf Document long options — HardenedBSD-pkg

HardenedBSD-pkg

rad:z3QDZAW2FAfuLvihrhiyDC9fAD8G9

HardenedBSD Package Manager

Document long options

Matthew Seaman committed 11 years ago

commit 33b2ccf3741eb0700ec350065d3772cc7e768730
parent 8df47a8

1 file changed +44 -28

modified docs/pkg-info.8

@@ -15,7 +15,7 @@

 .\"     @(#)pkg.8
 .\" $FreeBSD$
 .\"
 .Dd April 18, 2014
 .Dd May 26, 2014
 .Dt PKG-INFO 8
 .Os
 .Sh NAME

@@ -27,48 +27,64 @@

 .Nm
 .Fl a
 .Nm
 .Op Fl AbBDdefIklOqRrs
 .Op Fl AbBDdefIklOpqRrs
 .Op Fl Cgix
 .Ar pkg-name
 .Nm
 .Op Fl AbBDdfIlqRrs
 .Op Fl AbBDdfIlpqRrs
 .Fl F Ar pkg-file
 .Pp
 .Nm
 .Ar pkg-name
 .Nm
 .Cm --all
 .Nm
 .Op Cm --{annotations,provided-shlibs,required-shlibs}
 .Op Cm --{pkg-message,dependencies,exists,full,comment,locked}
 .Op Cm --{list-files,by-origin,quiet,prefix,raw,required-by,size}
 .Op Cm --{case-sensitive,glob,case-insensitive,regex}
 .Ar pkg-name
 .Nm
 .Op Cm --{annotations,provided-shlibs,required-shlibs}
 .Op Cm --{pkg-message,dependencies,full,comment,list-files}
 .Op Cm --{quiet,prefix,raw,required-by,size}
 .Cm --file Ar pkg-file
 .Sh DESCRIPTION
 .Nm
 is used for displaying information for packages.
 .Sh OPTIONS
 The following options are supported by
 .Nm :
 .Bl -tag -width F1
 .It Fl a
 .Bl -tag -width origin
 .It Fl a , Cm --all
 Display all installed packages.
 .It Fl A
 .It Fl A , Cm --annotations
 Display any annotations added to the package.
 .It Fl C
 .It Fl C , Cm --case-insensitive
 Make the standard or the regular expression
 .Fl ( x )
 matching against
 .Ar pkg-name
 case sensitive.
 .It Fl f
 .It Fl f , Cm --full
 Display full information about the packages matching
 .Ar pkg-name .
 This is the default.
 .It Fl R
 Display the full manifest (raw) about the packages matching
 .It Fl R , Cm --raw
 Display the full manifest (raw) for the packages matching
 .Ar pkg-name .
 .It Fl e
 .It Fl e , Cm --exists
 If
 .Ar pkg-name
 is installed and registered in the database, return 0, otherwise return 1.
 Useful for checking whether the package is installed.
 .It Fl D
 .It Fl D , Cm --pkg-message
 Show the pkg-message for matching packages.
 .It Fl g
 .It Fl g , Cm --glob
 Treat
 .Ar pkg-name
 as a shell glob pattern.
 .It Fl i
 .It Fl i , Cm --case-insensitive
 Make the standard or the regular expression
 .Fl ( x )
 matching against

@@ -78,20 +94,20 @@ This is the default, unless modified by setting

 .Ev CASE_SENSITIVE_MATCH
 to true in
 .Pa pkg.conf .
 .It Fl x
 .It Fl x , Cm --regex
 Treat
 .Ar pkg-name
 as a regular expression according to the "modern" or "extended" syntax
 of
 .Xr re_format 7 .
 .It Fl d
 .It Fl d , Cm --dependencies
 Display the list of packages on which
 .Ar pkg-name
 depends.
 .It Fl r
 .It Fl r , Cm --required-by
 Display the list of packages which require
 .Ar pkg-name .
 .It Fl k
 .It Fl k , Cm --locked
 Show the locking status for
 .Ar pkg-name .
 When used in combination with

@@ -104,39 +120,39 @@ Locking status is only meaningful for installed packages; all locking

 statuses will show as unlocked when information about a
 .Ar pkg-file
 is queried.
 .It Fl l
 .It Fl l , Cm --list-files
 Display all files installed by
 .Ar pkg-name .
 .It Fl b
 .It Fl b , Cm --provided-shlibs
 Display all shared libraries provided by
 .Ar pkg-name .
 .It Fl B
 .It Fl B , Cm --required-shlibs
 Display all shared libraries used by
 .Ar pkg-name .
 .It Fl s
 .It Fl s , Cm --size
 Display the total size of files installed by
 .Ar pkg-name
 .It Fl q
 .It Fl q , Cm --quiet
 Be
 .Dq quiet .
 Prints only the requested information without displaying many hints.
 .It Fl O
 .It Fl O , Cm --by-origin
 Search is done by the
 .Ar pkg-name
 origin.
 Added only for Ports compatibility.
 .Pp
 .It Fl E
 .It Fl E , Cm --show-name-only
 Hides the full package output and only shows the package name.
 This option is deprecated and exists only for Ports compatibility.
 .It Fl o
 .It Fl o , Cm --origin
 Display
 .Ar pkg-name
 origin.
 .It Fl p
 .It Fl p , --prefix
 Display the installation prefix for each package matching
 .Ar pkg-name .
 .It Fl F Ar pkg-file
 .It Fl F Ar pkg-file , Cm --file Ar pkg-file
 Displays information from the package archive
 .Ar pkg-file .
 .El