summaryrefslogtreecommitdiff
path: root/usr.sbin/pkg_install/add/pkg_add.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/pkg_install/add/pkg_add.1')
-rw-r--r--usr.sbin/pkg_install/add/pkg_add.178
1 files changed, 41 insertions, 37 deletions
diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1
index 7d902056677..e403f7e7f19 100644
--- a/usr.sbin/pkg_install/add/pkg_add.1
+++ b/usr.sbin/pkg_install/add/pkg_add.1
@@ -1,4 +1,4 @@
-.\" $OpenBSD: pkg_add.1,v 1.6 1998/09/07 22:30:14 marc Exp $
+.\" $OpenBSD: pkg_add.1,v 1.7 1998/12/16 02:47:52 aaron Exp $
.\"
.\" FreeBSD install - a package for the installation and maintainance
.\" of non-core utilities.
@@ -18,17 +18,17 @@
.\" @(#)pkg_add.1
.\"
.Dd November 25, 1994
-.Dt pkg_add 1
+.Dt PKG_ADD 1
.Os
.Sh NAME
.Nm pkg_add
.Nd a utility for installing software package distributions
.Sh SYNOPSIS
-.Nm
+.Nm pkg_add
.Op Fl vInfRMS
.Op Fl t Ar template
.Op Fl p Ar prefix
-.Ar pkg-name [pkg-name ...]
+.Ar pkg-name Op Ar pkg-name ...
.Sh DESCRIPTION
The
.Nm
@@ -36,7 +36,6 @@ command is used to extract packages that have been previously created
with the
.Xr pkg_create 1
command.
-
.Sh WARNING
.Bf -emphasis
Since the
@@ -67,8 +66,10 @@ command to examine the package file.
.Sh OPTIONS
The following command line arguments are supported:
.Bl -tag -width indent
-.It Ar pkg-name [... pkg-name]
-The named packages are installed. A package name of - will cause
+.It Ar pkg-name Op Ar ... pkg-name
+The named packages are installed. A package name of
+.Dq \&-
+will cause
.Nm
to read from stdin. If the packages are not found in the current
working directory,
@@ -104,8 +105,9 @@ directive will be replaced, since
has no way of knowing which directory settings are relative and
which are absolute. It is rare in any case to see more than one
directory transition made, but when such does happen and you wish
-to have control over *all* directory transitions, then you
-may then wish to look into the use of
+to have control over
+.Em all
+directory transitions, then you may then wish to look into the use of
.Cm MASTER
and
.Cm SLAVE
@@ -119,14 +121,16 @@ Use
.Ar template
as the input to
.Xr mkdtemp 3
-when creating a ``staging area.''
+when creating a
+.Dq staging area .
By default, this is the string
.Pa /var/tmp/instmp.XXXXXX ,
but it may be necessary to override it in the situation where
space in your
.Pa /var/tmp
-directory is limited. Be sure to leave some number of `X' characters
-for
+directory is limited. Be sure to leave some number of
+.Dq X
+characters for
.Xr mkdtemp 3
to fill in with a unique ID.
.Pp
@@ -173,7 +177,9 @@ and the contents then acted on as normal.
One or more
.Ar pkg-name
arguments may be specified, each being either a file containing the
-package (these usually ending with the ``.tgz'' suffix) or a
+package (these usually ending with the
+.Dq .tgz
+suffix) or a
URL pointing at a file available on an ftp site. Thus you may
extract files directly from their anonymous ftp locations (e.g.
.Nm
@@ -184,38 +190,32 @@ active mode
.Ef
ftp in such transfers, set
the variable
-.Bf -emphasis
-FTPMODE
-.Ef
+.Ev FTPMODE
to
.Dq active
in your environment. Otherwise, the more flexible
-PASSIVE mode may be used. (see
+.Dq passive
+mode may be used (see
.Xr ftp 1
for more info on the
.Ev FTPMODE
-environment variable.) If
+environment variable). If
.Nm
consistently fails to fetch a package from a site known to work,
it may be because the site does not support
-.Bf -emphasis
-passive mode
-.Ef
-ftp correctly. This is very rare since
+passive mode ftp correctly. This is very rare since
.Nm
-will try
-.Bf -emphasis
-active mode
-.Ef
-ftp if the server refuses a
-.Bf -emphasis
-passive mode
-.Ef
+will try active mode ftp if the server refuses a passive mode
connection.
.Sh TECHNICAL DETAILS
.Nm
-extracts each package's "packing list"
-into a special staging directory in /tmp (or $PKG_TMPDIR if set)
+extracts each package's
+.Dq packing list
+into a special staging directory in
+.Pa /tmp
+(or
+.Ev PKG_TMPDIR
+if set)
and then runs through the following sequence to fully extract the contents
of the package:
.Bl -enum -indent indent
@@ -236,7 +236,7 @@ All package dependencies (from
directives, see
.Xr pkg_create 1 )
are read from the packing list.
-If any of these required packages is not currently installed,
+If any of these required packages are not currently installed,
an attempt is made to find and install it;
if the missing package cannot be found or installed,
the installation is terminated.
@@ -265,8 +265,8 @@ it is executed with the following arguments:
The name of the package being installed
.It Cm INSTALL
Keyword denoting to the script that it is to run an installation requirements
-check.
-(The keyword is useful only to scripts which serve multiple functions).
+check
+(the keyword is useful only to scripts which serve multiple functions).
.El
.Pp
If the
@@ -299,6 +299,7 @@ If the package contains an
file (see
.Xr pkg_create 1 ),
then mtree is invoked as:
+.Pp
.Bd -filled -offset indent -compact
.Cm mtree
.Fl u
@@ -309,6 +310,7 @@ then mtree is invoked as:
.Fl p
.Pa prefix
.Ed
+.Pp
where
.Pa prefix
is either the prefix specified with the
@@ -339,7 +341,9 @@ for subsequent possible use by
Any package dependencies are recorded in the other packages'
.Pa /var/db/pkg/<other-pkg>/+REQUIRED_BY
file
-(if the environment variable PKG_DBDIR is set, this overrides the
+(if the environment variable
+.Ev PKG_DBDIR
+is set, this overrides the
.Pa /var/db/pkg/
path shown above).
.It
@@ -364,7 +368,7 @@ flag to
.Ss PKG_PATH
The value of the
.Ev PKG_PATH
-is used if a given package can't be found, it's usually set to
+is used if a given package can't be found; it's usually set to
.Pa /usr/pkgsrc/packages/All .
The environment variable
should be a series of entries seperated by colons. Each entry