From 46ecb27be87b8d41cc76e7f0ffa04d757de9db0b Mon Sep 17 00:00:00 2001 From: jkh Date: Tue, 6 Dec 1994 01:04:17 +0000 Subject: More changes from John T. Kohl. Man pages, mostly. Submitted by: jtkohl --- usr.sbin/pkg_install/add/pkg_add.1 | 367 +++++++++++++++++---------- usr.sbin/pkg_install/create/pkg_create.1 | 414 ++++++++++++++++++------------- usr.sbin/pkg_install/delete/pkg_delete.1 | 224 +++++++++++------ usr.sbin/pkg_install/info/pkg_info.1 | 6 +- usr.sbin/pkg_install/lib/Makefile | 1 + 5 files changed, 630 insertions(+), 382 deletions(-) (limited to 'usr.sbin') diff --git a/usr.sbin/pkg_install/add/pkg_add.1 b/usr.sbin/pkg_install/add/pkg_add.1 index 1863144..eef976c 100644 --- a/usr.sbin/pkg_install/add/pkg_add.1 +++ b/usr.sbin/pkg_install/add/pkg_add.1 @@ -14,190 +14,295 @@ .\" Jordan K. Hubbard .\" .\" -.\" @(#)pkg_add.1 +.\" @(#)pkg_add.8 .\" -.TH pkg_add 1 "July 18, 1993" "" "FreeBSD" - -.SH NAME -pkg_add - a utility for installing software package distributions. -.SH SYNOPSIS -.na -.B pkg_add -.RB [options] -.RB "pkg-name\ [.. pkg-name]" - -.SH DESCRIPTION +.Dd November 25, 1994 +.Dt pkg_add 8 +.Os NetBSD 1.0 +.Sh NAME +.Nm pkg_add +.Nd a utility for installing software package distributions. +.Sh SYNOPSIS +.Nm +.Op Fl vInfRMS +.Op Fl t Ar template +.Op Fl p Ar prefix +.Ar pkg-name ... +.Sh DESCRIPTION The -.B pkg_add +.Nm command is used to extract packages that have been previously created with the -.B pkg_create +.Xr pkg_create 8 command. -.SH OPTIONS -.TP -The following command line options are supported. -.TP -.B \-v +.Sh WARNING +.Bf -emphasis +Since the +.Nm +command may execute scripts or programs contained within a package file, +your system may be susceptible to ``trojan horses'' or other subtle +attacks from miscreants who create dangerous package files. +.Pp +You are advised to verify the competence and identity of those who +provide installable package files. For extra protection, use the +.Fl M +flag to extract the package file, and inspect its contents and scripts +to insure it poses no danger to your system's integrity. Pay particular +attention to any +INSTALL, +DEINSTALL, +REQUIRE or +MTREE_DIRS files, +and inspect the +CONTENTS file for +.Cm @cwd , +.Cm @mode +(check for setuid), +.Cm @dirrm , +.Cm @exec , +and +.Cm @unexec +directives, and/or use the +.Xr pkg_info 1 +command to examine the package file. +.Ef + +.Sh OPTIONS +The following command line arguments are supported. +.Bl -tag -width indent +.It Ar pkg-name ... +Packages in the named files are installed. +.It Fl v Turns on verbose output. -.B "Optional." -.TP -.B \-I +.Em "Optional." +.It Fl I If an installation script exists for a given package, do not execute it. -.B "Optional." -.TP -.B \-n +.Em "Optional." +.It Fl n Don't actually install a package, just report the steps that would be taken if it was. -.B "Optional." -.TP -.B \-R +.Em "Optional." +.It Fl R Do not record the installation of a package. This means that you cannot deinstall it later, so only use this option if you know what you are doing! -.B "Optional." -.TP -.BI "\-p\ " prefix +.Em "Optional." +.It Fl f +Forces installation to proceed even if prerequisite packages are not +installed or the requirements script fails. +.Em "Optional." +.It Fl p Ar prefix Sets -.I prefix +.Ar prefix as the directory in which to extract files from a package. If a package has set its default directory, it will be overridden by this flag. Note that only the first directory default will be replaced, since -.B pkg_add +.Nm has no way of knowing which directory settings are relative and which are absolute. It is rare, in any case, that more than one directory transition is made, but when such is the case then you may wish to look into the use of -.B MASTER +.Cm MASTER and -.B SLAVE -mode (see -.B \-M +.Cm SLAVE +mode (see the +.Fl M and -.B \-S +.Fl S options). -.B "Optional." -.TP -.BI "\-t\ " template +.Em "Optional." +.It Fl t Ar template Use -.I template -as the input to mktemp(3). By default, this is the string -.B /tmp/instmp.XXXXXX -, but it may be necessary to override it in the situation where +.Ar template +as the input to +.Xr mktemp 3 +when creating a ``staging area.'' +By default, this is the string +.Pa /tmp/instmp.XXXXXX , +but it may be necessary to override it in the situation where space in your -.B /tmp +.Pa /tmp directory is limited. Be sure to leave some number of `X' characters -for mktemp(3) to fill in with a unique ID. -.B "Optional." -.TP -.B \-M +for +.Xr mktemp 3 +to fill in with a unique ID. +.Pp +You can get a performance boost by setting the staging area +.Ar template +to reside on the same disk partition as target directories for package +file installation; often this is +.Pa /usr . +.Em "Optional." +.It Fl M Run in -.B MASTER +.Cm MASTER mode. This is a very specialized mode for running -.B pkg_add +.Nm and is meant to be run in conjunction with -.B SLAVE +.Cm SLAVE mode. When run in this mode, -.B pkg_add +.Nm does no work beyond extracting the package into a temporary staging -area (see -.B \-t +area (see the +.Fl t option), reading in the packing list, and then dumping it (prefaced by the current staging area) to stdout where it may be filtered by a program such as -.B sed(1). +.Xr sed 1 . When used in conjunction with -.B SLAVE +.Cm SLAVE mode, it allows you to make radical changes to the package structure before acting on its contents. -.TP -.B \-S +.It Fl S Run in -.B SLAVE +.Cm SLAVE mode. This is a very specialized mode for running -.B pkg_add +.Nm and is meant to be run in conjunction with -.B MASTER +.Cm MASTER mode. When run in this mode, -.B pkg_add +.Nm expects the release contents to be already extracted and waiting in the staging area, the location of which is read as a string from stdin. The complete packing list is also read from stdin, and the contents then acted on as normal. -.PP -.SH "TECHNICAL DETAILS" -.B -pkg_add +.El +.Sh TECHNICAL DETAILS +.Nm is fairly simple. It simply extracts the requested packages into -a "staging area" directory and then performs the following steps: -.PP +a ``staging area'' directory and then performs the following steps: +.Bl -enum -indent indent +.It +It checks whether the package is already recorded as installed; if so, +the installation terminates. +.It +It checks whether all the package dependencies (from +.Cm @pkgdep +directives, see +.Xr pkg_create 8 ) +are met; if not, the missing dependencies are printed and the +installation terminates. +.It If the package contains a -.B require +.Ar require file (see -.B pkg_create -), then this is executed first with the flags -.PP -.B