204131a Refined ENVIRONMENT sections in manpages — HardenedBSD-pkg

modified pkg/pkg-add.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-ADD 1
 .Os
 .Sh NAME

@@ -41,12 +41,19 @@ The following options are supported by

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev ASSUME_ALWAYS_YES
 .It Ev HANDLE_RC_SCRIPTS
 .It Ev PKG_DBDIR
 .El
 .P
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-create 1 ,

modified pkg/pkg-autoremove.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-AUTOREMOVE 1
 .Os
 .Sh NAME

@@ -37,20 +37,18 @@ Assume yes when asked for confirmation before package autoremoval.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev ASSUME_ALWAYS_YES"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev ASSUME_ALWAYS_YES
 When this option is set to
 .Fa YES
 pkgng will automatically assume "yes" to all questions
 which require confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified.
 .It Ev HANDLE_RC_SCRIPTS
 .It Ev PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-backup.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-BACKUP 1
 .Os
 .Sh NAME

@@ -51,12 +51,16 @@ This option is currently not implemented.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-create.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Os
 .Dt PKG-CREATE 1
 .\" ---------------------------------------------------------------------------

@@ -169,15 +169,19 @@ entry but for directories.

 .\" ---------------------------------------------------------------------------
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PKG_DBDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev PKG_DBDIR
 Specifies an alternative location for the installed package database.
 .It Ev PLIST_KEYWORDS_DIR
 .It Ev PORTSDIR
 .El
 .\" ---------------------------------------------------------------------------
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .\" ---------------------------------------------------------------------------
 .Sh SEE ALSO
 .Xr pkg 1 ,

modified pkg/pkg-delete.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-DELETE 1
 .Os
 .Sh NAME

@@ -50,20 +50,18 @@ Treat the package names as extended regular expressions.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev ASSUME_ALWAYS_YES"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev ASSUME_ALWAYS_YES
 When this option is set to
 .Fa YES
 pkgng will automatically assume "yes" to all questions
 which require confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified.
 .It Ev HANDLE_RC_SCRIPTS
 .It Ev PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-info.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-INFO 1
 .Os
 .Sh NAME

@@ -100,12 +100,16 @@ Displays information from the package archive

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-install.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-INSTALL 1
 .Os
 .Sh NAME

@@ -67,29 +67,21 @@ Treat the package names as extended regular expressions.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PACKAGESITE"
 .It Ev PACKAGESITE
 When \fBPACKAGESITE\fP is defined
 .Nm
 will only use the remote repository to which it points. Otherwise
 .Nm
 will work on multiple repositories as listed in the
 .Nm .
 See
 .Xr pkg.conf 5
 file. Please note that multiple remote repositories is still considered
 highly experimental.
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev ASSUME_ALWAYS_YES
 When this option is set to
 .Fa YES
 pkgng will automatically assume "yes" to all questions
 which require confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified.
 .It Ev HANDLE_RC_SCRIPTS
 .It Ev PACKAGESITE
 .It Ev PKG_CACHEDIR
 .It Ev PKG_DBDIR
 .It Ev PKG_MULTIREPOS
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .El
 .Sh SEE ALSO
 .Xr pkg 1 ,

modified pkg/pkg-query.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-QUERY 1
 .Os
 .Sh NAME

@@ -129,12 +129,16 @@ Expands to the list of scripts for the matching packages - install, deinstall, e

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .IT PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-register.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-REGISTER 1
 .Os
 .Sh NAME

@@ -30,8 +30,7 @@

 .Fl i Ar <input-path>
 .Sh DESCRIPTION
 .Nm
 is used for registering a package into the local package
 database
 is used for registering a package into the local package database.
 .Sh OPTIONS
 The following options are supported by
 .Nm :

@@ -58,12 +57,16 @@ Specifies the package input path.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-repo.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-REPO 1
 .Os
 .Sh NAME

@@ -49,12 +49,16 @@ The following options are supported by

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PUBKEY
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-search.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-SEARCH 1
 .Os
 .Sh NAME

@@ -85,20 +85,17 @@ Displays the installation prefix for each package matching

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PACKAGESITE"
 .It Ev PACKAGESITE
 When \fBPACKAGESITE\fP is defined
 .Nm
 will only use the remote repository to which it points. Otherwise
 .Nm
 will work on multiple repositories as listed in the
 .Nm .
 See
 .Xr pkg.conf 5
 file.
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev PACKAGESITE
 .It Ev PKG_MULTIREPOS
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-update.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-UPDATE 1
 .Os
 .Sh NAME

@@ -43,21 +43,18 @@ The following options are supported by

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PACKAGESITE"
 .It Ev PACKAGESITE
 When \fBPACKAGESITE\fP is defined
 .Nm
 will only use the remote repository to which it points. Otherwise
 .Nm
 will work on multiple repositories as listed in the
 .Nm .
 See
 .Xr pkg.conf 5
 file. Please note that multiple remote repositories is still considered
 highly experimental.
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev PACKAGESITE
 .It Ev PKG_DBDIR
 .It Ev PKG_MULTIREPOS
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-upgrade.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-UPGRADE 1
 .Os
 .Sh NAME

@@ -44,31 +44,21 @@ Assume yes when asked for confirmation before package installation.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PACKAGESITE"
 .It Ev PACKAGESITE
 When \fBPACKAGESITE\fP is defined
 .Nm
 will only use the remote repository to which it points. Otherwise
 .Nm
 will work on multiple repositories as listed in the
 .Pa /etc/pkg/repositories
 file. Please note that multiple remote repositories is still considered
 highly experimental. Currently multiple package repositories is not
 implemented yet in
 .Nm
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It Ev ASSUME_ALWAYS_YES
 When this option is set to
 .Fa YES
 pkgng will automatically assume "yes" to all questions
 which require confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified.
 .It Ev HANDLE_RC_SCRIPTS
 .It Ev PACKAGESITE
 .It Ev PKG_CACHEDIR
 .It Ev PKG_DBDIR
 .It Ev PKG_MULTIREPOS
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-version.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-VERSION 1
 .Os
 .Sh NAME

@@ -88,12 +88,17 @@ with matching package names/patterns are echoed to standard output.

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PKG_DBDIR
 .It PORTSDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg-which.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG-WHICH 1
 .Os
 .Sh NAME

@@ -35,12 +35,16 @@ The following commands are supported by

 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev TMPDIR"
 .Nm .
 See
 .Xr pkg.conf 5
 for further description.
 .Bl -tag -width ".Ev NO_DESCRIPTIONS"
 .It PKG_DBDIR
 .El
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,

modified pkg/pkg.1

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG 1
 .Os
 .\" ---------------------------------------------------------------------------

@@ -69,16 +69,16 @@ protocol to use when fetching the package.

 .Pp
 Currently supported protocols are FTP, HTTP and HTTPS.
 .It \fBaudit\fP
 ????
 < To be added >
 .It \fBautoremove\fP
 Deletes packages not depended on by anyother packages and that were
 automatically installed.
 .It \fBbackup\fP
 Dumps the local package database to a file specified on the command-line.
 .It \fBcheck\fP
 ????
 < To be added >
 .It \fBclean\fP
 ????
 < To be added >
 .It \fBcreate\fP
 Creates a package
 .It \fBdelete\fP

@@ -106,7 +106,7 @@ repositories.

 Update the available remote repositories as listed in
 .Xr pkg.conf 5 .
 .It \fBupdating\fP
 ????
 < To be added >
 .It \fBupgrade\fP
 Upgrades a package to a newer version.
 .It \fBversion\fP

@@ -117,18 +117,14 @@ file.

 .El
 .\" ---------------------------------------------------------------------------
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Nm :
 .Bl -tag -width ".Ev PKG_DBDIR"
 .It Ev PKG_DBDIR
 .El
 See
 .Xr pkg.conf 5
 for explanation.
 The list of environment variables that affect the execution of
 .Nm
 is in
 .Xr pkg.conf 5 .
 .\" ---------------------------------------------------------------------------
 .Sh FILES
 See
 .Xr pkg.conf 5
 .Xr pkg.conf 5 .
 .\" ---------------------------------------------------------------------------
 .Sh SEE ALSO
 .Xr pkg-autoremove 1 ,

modified pkg/pkg.conf.5

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

 .\"     @(#)pkg.1
 .\" $FreeBSD$
 .\"
 .Dd January 23, 2012
 .Dd January 24, 2012
 .Dt PKG.CONF 5
 .Os
 .Sh NAME

@@ -49,22 +49,15 @@ and

 .Sh OPTIONS
 The following options can be defined in
 .Nm :
 .Bl -tag -width F1
 .It Cm PACKAGESITE(string)
 Specifies the remote location to use
 when fetching the database file and packages.
 .It Cm PKG_DBDIR(string)
 Specifies the directory to use for storing the package
 database files. The default value for this option is
 .Fa /var/db/pkg
 .It Cm PKG_CACHEDIR(string)
 Specifies the cache directory for packages. The default value
 for this option is
 .Fa /var/cache/pkg
 .It Cm PORTSDIR(string)
 Specifies the location to the Ports directory. The default value
 for this option is
 .Fa /usr/ports
 .Bl -tag -width ".Cm ASSUME_ALWAYS_YES(boolean)"
 .It Cm ASSUME_ALWAYS_YES(boolean)
 When this option is enabled
 .Xr pkg 1
 will automatically assume "yes" to all questions
 which require user confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified. By default this option is disabled.
 .It Cm PUBKEY(string)
 Specifies the location to the public RSA key used for signing the
 repository database. The default value for this file is

@@ -76,30 +69,32 @@ installation and deinstallation. Services are started on installation only

 if they are enabled in
 .Fa /etc/rc.conf .
 By default this option is disabled.
 .It Cm ASSUME_ALWAYS_YES(boolean)
 This option when enabled
 .Xr pkg 1
 will automatically assume "yes" to all questions
 which require user confirmation before doing anything, as if it
 the
 .Fl y
 flag was specified. By default this option is disabled.
 .It Cm PACKAGESITE(string)
 Specifies the remote location to use
 when fetching the database file and packages.
 .It Cm PKG_CACHEDIR(string)
 Specifies the cache directory for packages. The default value
 for this option is
 .Fa /var/cache/pkg
 .It Cm PKG_DBDIR(string)
 Specifies the directory to use for storing the package
 database files. The default value for this option is
 .Fa /var/db/pkg
 .It Cm PKG_MULTIREPOS(boolean)
 This option when enabled will tell
 .Xr pkg 1
 to work in mutliple repositories mode. For example repositories
 definitions, please have a look at the sample configuration file.
 .It Cm PLIST_KEYWORS_DIR(string)
 ????
 < To be added >
 .It Cm PORTSDIR(string)
 Specifies the location to the Ports directory. The default value
 for this option is
 .Fa /usr/ports
 .El
 .Sh ENVIRONMENT
 The following environment variables affect the execution of
 .Xr pkg 1
 .Pp
 An environment variable with the name of the configuration file
 always overrides the value of an option set in
 .Xr pkg.conf 5
 file.
 An environment variable with the same name as the option in the configuration
 file always overrides the value of an option set in the file.
 .Sh SEE ALSO
 .Xr pkg 1 ,
 .Xr pkg-add 1 ,