Skip to content

Commit

Permalink
Refined ENVIRONMENT sections in manpages
Browse files Browse the repository at this point in the history
all: Cleaned ENVIRONMENT sections
all: ???? -> < To be added >
pkg.conf(5): Sorted the variable names
  • Loading branch information
toddnni committed Jan 24, 2012
1 parent 4bd4310 commit 204131a
Show file tree
Hide file tree
Showing 17 changed files with 174 additions and 172 deletions.
15 changes: 11 additions & 4 deletions pkg/pkg-add.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-ADD 1
.Os
.Sh NAME
Expand All @@ -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 ,
Expand Down
20 changes: 9 additions & 11 deletions pkg/pkg-autoremove.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-AUTOREMOVE 1
.Os
.Sh NAME
Expand All @@ -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 ,
Expand Down
12 changes: 8 additions & 4 deletions pkg/pkg-backup.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-BACKUP 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
14 changes: 9 additions & 5 deletions pkg/pkg-create.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Os
.Dt PKG-CREATE 1
.\" ---------------------------------------------------------------------------
Expand Down Expand Up @@ -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 ,
Expand Down
20 changes: 9 additions & 11 deletions pkg/pkg-delete.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-DELETE 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
12 changes: 8 additions & 4 deletions pkg/pkg-info.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-INFO 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
30 changes: 11 additions & 19 deletions pkg/pkg-install.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-INSTALL 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
12 changes: 8 additions & 4 deletions pkg/pkg-query.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-QUERY 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
15 changes: 9 additions & 6 deletions pkg/pkg-register.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-REGISTER 1
.Os
.Sh NAME
Expand All @@ -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 :
Expand All @@ -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 ,
Expand Down
12 changes: 8 additions & 4 deletions pkg/pkg-repo.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-REPO 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down
19 changes: 8 additions & 11 deletions pkg/pkg-search.1
Expand Up @@ -15,7 +15,7 @@
.\" @(#)pkg.1
.\" $FreeBSD$
.\"
.Dd January 23, 2012
.Dd January 24, 2012
.Dt PKG-SEARCH 1
.Os
.Sh NAME
Expand Down Expand Up @@ -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 ,
Expand Down

0 comments on commit 204131a

Please sign in to comment.