Document environment variables used by pkg_{add,create,info}. These

include PKG_TMPDIR, TMPDIR, PKG_DBDIR.  Add a FILES section to these
manual pages.

PR: docs/7064

3 files changed, 108 insertions, 2 deletions

diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1
index 16b956f..e5ab036 100644
--- a/usr.sbin/pkg_install/add/pkg_add.1
+++ b/usr.sbin/pkg_install/add/pkg_add.1
@@ -198,7 +198,7 @@ ftp.
 .Sh TECHNICAL DETAILS
 .Nm Pkg_add
 is fairly simple.  It extracts each package's "packing list"
-into a special staging directory in /tmp (or $PKG_TMPDIR if set), parses it,
+into a special staging directory, parses it,
 and then runs through the following sequence to fully extract the contents:
 .Bl -enum -indent indent
 .It
@@ -334,6 +334,48 @@ should be a series of entries seperated by colons.  Each entry
 consists of a directory name. The current directory may be indicated
 implicitly by an empty directory name, or explicitly by a single
 period.
+.Pp
+The environment variable
+.Ev PKG_DBDIR
+specifies an alternative location for the installed package database.
+.Pp
+The environment variables
+.Ev PKG_TMPDIR
+and
+.Ev TMPDIR ,
+in that order, are taken to name temporary directories where
+.Nm 
+will attempt to create its staging area in.
+If these variables are not present or if the directories named lack
+sufficient space, then 
+.Nm
+will use the first of 
+.Pa /var/tmp ,
+.Pa /tmp 
+or
+.Pa /usr/tmp
+with sufficient space.
+.Sh FILES
+.Bl -tag -width /var/db/pkg -compact
+.It Pa /var/tmp
+Temporary directory for creating the staging area, if environmental variables
+.Ev PKG_TMPDIR
+or
+.Ev TMPDIR
+do not point to a suitable directory.
+.It Pa /tmp
+Next choice if
+.Pa /var/tmp
+does not exist or has insufficient space.
+.It Pa /usr/tmp
+Last choice if 
+.Pa /var/tmp
+and
+.Pa /tmp
+are not suitable for creating the staging area.
+.It Pa /var/db/pkg
+Default location of the installed package database.
+.El
 .Sh SEE ALSO
 .Xr pkg_create 1 ,
 .Xr pkg_delete 1 ,
diff --git a/usr.sbin/pkg_install/create/pkg_create.1 b/usr.sbin/pkg_install/create/pkg_create.1
index a78e0d6..eaec8fb 100644
--- a/usr.sbin/pkg_install/create/pkg_create.1
+++ b/usr.sbin/pkg_install/create/pkg_create.1
@@ -15,7 +15,7 @@
 .\"
 .\"
 .\"     @(#)pkg_create.1
-.\"	$Id: pkg_create.1,v 1.24 1998/03/23 08:27:14 charnier Exp $	
+.\"	$Id: pkg_create.1,v 1.25 1998/05/24 03:11:17 steve Exp $	
 .\"
 .\" hacked up by John Kohl for NetBSD--fixed a few bugs, extended keywords,
 .\" added dependency tracking, etc.
@@ -359,6 +359,40 @@ package is deinstalled.  Multiple
 .Cm @pkgdep
 directives may be used if the package depends on multiple other packages.
 .El
+.Sh ENVIRONMENT
+The environment variable
+.Ev PKG_TMPDIR
+names the directory where
+.Nm
+will attempt to create its temporary files.  
+If
+.Ev PKG_TMPDIR
+is not set, 
+the directory named by the contents of
+.Ev TMPDIR 
+will be used.
+If neither of 
+.Ev PKG_TMPDIR
+and
+.Ev TMPDIR
+are set, the builtin defaults are used.
+.Sh FILES
+.Bl -tag -width /usr/tmp -compact
+.It Pa /var/tmp
+Temporary directory if environmental variables
+.Ev PKG_TMPDIR 
+and
+.Ev TMPDIR
+are not set.
+.It Pa /tmp
+The next choice if 
+.Pa /var/tmp
+does not exist.
+.It Pa /usr/tmp
+The last choice if 
+.Pa /tmp
+is unsuitable.
+.El
 .Sh SEE ALSO
 .Xr pkg_add 1 ,
 .Xr pkg_delete 1 ,
diff --git a/usr.sbin/pkg_install/info/pkg_info.1 b/usr.sbin/pkg_install/info/pkg_info.1
index 9c3df4b..1c78616 100644
--- a/usr.sbin/pkg_install/info/pkg_info.1
+++ b/usr.sbin/pkg_install/info/pkg_info.1
@@ -118,6 +118,36 @@ Package info is either extracted from package files named on the
 command line, or from already installed package information
 in
 .Pa /var/db/pkg/<pkg-name> .
+.Sh ENVIRONMENT
+.Ev PKG_TMPDIR
+points to the directory where
+.Nm
+creates its temporary files.
+If this variable is not set,
+.Ev TMPDIR
+is used.  If both are unset, the builtin defaults are used.
+.Pp
+.Ev PKG_DBDIR
+names the location of the installed package database.
+.Sh FILES
+.Bl -tag -width /var/db/pkg -compact
+.It Pa /var/tmp
+Used if the environment variables
+.Ev PKG_TMPDIR
+and 
+.Ev TMPDIR
+are not set, or if the directories named have insufficient space.
+.It Pa /tmp
+The next choice if 
+.Pa /var/tmp
+does not exist or has insufficient space.
+.It Pa /usr/tmp
+The last choice if 
+.Pa /tmp 
+is unsuitable.
+.It Pa /var/db/pkg
+Default location of the installed package database.
+.El
 .Sh SEE ALSO
 .Xr pkg_add 1 ,
 .Xr pkg_create 1 ,