diff options
author | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-12-16 02:47:54 +0000 |
---|---|---|
committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1998-12-16 02:47:54 +0000 |
commit | 6a26f4e5665aafb119a6c982696504a62aa2d328 (patch) | |
tree | 118dcbef70b15a9117183e39ed0f6c9a9b314367 /usr.sbin/pkg_install | |
parent | 783d78e9b875e3ddacabbed3c6a76d35546471ef (diff) |
more .Nm fixes
Diffstat (limited to 'usr.sbin/pkg_install')
-rw-r--r-- | usr.sbin/pkg_install/add/pkg_add.1 | 78 | ||||
-rw-r--r-- | usr.sbin/pkg_install/create/pkg_create.1 | 137 | ||||
-rw-r--r-- | usr.sbin/pkg_install/delete/pkg_delete.1 | 21 |
3 files changed, 137 insertions, 99 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 diff --git a/usr.sbin/pkg_install/create/pkg_create.1 b/usr.sbin/pkg_install/create/pkg_create.1 index a44dd8005a3..41cd3e2bd83 100644 --- a/usr.sbin/pkg_install/create/pkg_create.1 +++ b/usr.sbin/pkg_install/create/pkg_create.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_create.1,v 1.5 1998/10/13 23:09:50 marc Exp $ +.\" $OpenBSD: pkg_create.1,v 1.6 1998/12/16 02:47:53 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -25,13 +25,13 @@ .\" better integration with FreeBSD's new ports collection. .\" .Dd April 21, 1995 -.Dt pkg_create 1 +.Dt PKG_CREATE 1 .Os .Sh NAME .Nm pkg_create .Nd a utility for creating software package distributions .Sh SYNOPSIS -.Nm +.Nm pkg_create .Op Fl Ohv .Op Fl P Ar dpkgs .Op Fl C Ar cpkgs @@ -62,42 +62,53 @@ description of the input syntax is included in this document. The following command line options are supported: .Bl -tag -width indent .It Fl f Ar packinglist -Fetch ``packing list'' for package from the file +Fetch +.Dq packing list +for package from the file .Ar packinglist -or -.Cm stdin -if +or stdin if .Ar packinglist -is a -.Cm - -(dash). -.It Fl c Ar [-]desc -Fetch package ``one line description'' from file +is a dash +.Dq \&- . +.It Fl c [ Ar \&- ] Ns Ar desc +Fetch package +.Dq one line description +from file .Ar desc or, if preceded by -.Cm - , +.Dq \&- , the argument itself. This string should also give some idea of which version of the product (if any) the package represents. -.It Fl d Ar [-]desc +.It Fl d [ Ar \&- ] Ns Ar desc Fetch long description for package from file .Ar desc or, if preceded by -.Cm - , +.Dq \&- , the argument itself. .It Fl Y -Assume a default answer of `Yes' for any questions asked. +Assume a default answer of +.Dq Yes +for any questions asked. .It Fl N -Assume a default answer of `No' for any questions asked. +Assume a default answer of +.Dq \&No +for any questions asked. .It Fl O -Go into a `packing list Only' mode. -This is used to do `fake pkg_add' operations when a package is installed. +Go into a +.Dq packing list only +mode. +This is used to do +.Dq fake pkg_add +operations when a package is installed. In such cases, it is necessary to know what the final, adjusted packing list will look like. .It Fl v Turn on verbose output. .It Fl h -Force tar to follow symbolic links, so that the files they point to +Force +.Xr tar +to follow symbolic links, so that the files they point to are dumped, rather than the links themselves. .It Fl i Ar iscript Set @@ -111,18 +122,24 @@ Set the initial package dependency list to This is assumed to be a whitespace separated list of package names and is meant as a convenient shorthand for specifying multiple .Cm @pkgdep -directives in the packing list (see PACKING LIST DETAILS section below). +directives in the packing list (see +.Sx PACKING LIST DETAILS +section below). .It Fl C Ar cpkgs Set the initial package conflict list to .Ar cpkgs . This is assumed to be a whitespace separated list of package names and is meant as a convenient shorthand for specifying multiple .Cm @pkgcfl -directives in the packing list (see PACKING LIST DETAILS section below). +directives in the packing list (see +.Sx PACKING LIST DETAILS +section below). .It Fl p Ar prefix Set .Ar prefix -as the initial directory ``base'' to start from in selecting files for +as the initial directory +.Dq base +to start from in selecting files for the package. .It Fl k Ar dscript Set @@ -133,7 +150,9 @@ when the package is later (if ever) de-installed. .It Fl r Ar rscript Set .Ar rscript -to be the ``requirements'' procedure for the package. This can be any +to be the +.Dq requirements +procedure for the package. This can be any executable program (or shell script). It will be invoked automatically at installation/deinstallation time to determine whether or not installation/deinstallation should proceed. @@ -147,8 +166,9 @@ By default, this is the string but it may be necessary to override it in the situation where space in your .Pa /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 mktemp 3 to fill in with a unique ID. .It Fl X Ar excludefile @@ -157,11 +177,11 @@ Pass as a .Fl exclude-from argument to -.Cm tar +.Xr tar when creating final package. See -.Cm tar +.Xr tar man page (or run -.Cm tar +.Xr tar with .Fl -help flag) for further information on using this flag. @@ -174,7 +194,8 @@ legal notices on almost-free software, etc. Run .Xr mtree 8 with input from mtreefile before the package is installed. -Mtree is invoked as +.Xr mtree +is invoked as .Cm mtree .Fl u .Fl f @@ -191,7 +212,9 @@ directive. .El .Pp .Sh PACKING LIST DETAILS -The ``packing list'' format (see +The +.Dq packing list +format (see .Fl f ) is fairly simple, being nothing more than a single column of filenames to include in the @@ -199,9 +222,9 @@ package. However, since absolute pathnames are generally a bad idea for a package that could be installed potentially anywhere, there is another method of specifying where things are supposed to go and, optionally, what ownership and mode information they should be -installed with. This is done by imbeding specialized command sequences +installed with. This is done by imbedding specialized command sequences in the packing list. Briefly described, these sequences are: -.Bl -tag -width indent -compact +.Bl -tag -width indent .It Cm @cwd Ar directory Set the internal directory pointer to point to .Ar directory . @@ -210,7 +233,9 @@ Note: .Cm @cd is also an alias for this command. .It Cm @srcdir Ar directory -Set the internal directory pointer for _creation only_ to +Set the internal directory pointer for creation +.Em only +to .Ar directory . That is to say that it overrides .Cm @cwd @@ -227,25 +252,29 @@ is set to .Pa /usr/local and the last extracted file was .Pa bin/emacs . -.Bl -tag -width indent -compact +.Bl -tag -width indent .It Cm "%F" -Expands to the last filename extracted (as specified), in the example case -.Pa bin/emacs +Expands to the last filename extracted (as specified); in the example case, +.Pa bin/emacs . .It Cm "%D" -Expand to the current directory prefix, as set with -.Cm @cwd , +Expands to the current directory prefix, as set with +.Cm @cwd ; in the example case .Pa /usr/local . .It Cm "%B" -Expand to the ``basename'' of the fully qualified filename, that +Expands to the +.Dq basename +of the fully qualified filename, that is the current directory prefix, plus the last filespec, minus the trailing filename. In the example case, that would be .Pa /usr/local/bin . .It Cm "%f" -Expand to the ``filename'' part of the fully qualified name, or +Expands to the +.Dq filename +part of the fully qualified name, or the converse of -.Cm %B , -being in the example case, +.Cm %B ; +in the example case, .Pa emacs . .El .It Cm @unexec Ar command @@ -263,8 +292,9 @@ as a result of adding the package, but not directly known to the package's table of contents (and hence not automatically removable). The advantage of using .Cm @unexec -over a deinstallation script is that you can use the ``special -sequence expansion'' to get at files regardless of where they've +over a deinstallation script is that you can use the +.Dq special sequence expansion +to get at files regardless of where they've been potentially redirected (see .Fl p ) . .It Cm @mode Ar mode @@ -279,14 +309,19 @@ permissions. Set internal package options, the only two currently supported ones being .Ar extract-in-place , -which tells the pkg_add command not to extract the package's tarball +which tells the +.Nm pkg_add +command not to extract the package's tarball into a staging area but rather directly into the target hierarchy (this is typically meant to be used only by distributions or other special package types), and .Ar preserve , -which tells pkg_add to move any existing files out of the way, +which tells +.Nm pkg_add +to move any existing files out of the way, preserving the previous contents (which are also resurrected on -pkg_delete, so caveat emptor). +.Nm pkg_delete , +so caveat emptor). .It Cm @owner Ar user Set default ownership for all subsequently extracted files to .Ar user . @@ -329,7 +364,7 @@ package installation are not deleted when the package is deinstalled; this provides an explicit directory cleanup method. This directive should appear at the end of the package list. If more than one .Cm @dirrm -directives are used, the directories are removed in the order specified. +directive is used, the directories are removed in the order specified. The .Pa name directory will not be removed unless it is empty. @@ -366,7 +401,7 @@ Declare a conflict to the package. The .Ar pkgcflname package must -.Cm not +.Em not be installed if .Ar pkgname package gets installed cause they install the same files and thus conflict. @@ -393,7 +428,7 @@ Hard links between files in a distribution must be bracketed by .Cm @cwd directives in order to be preserved as hard links when the package is extracted. They additionally must not end up being split between -.Cm tar +.Xr tar invocations due to exec argument-space limitations (this depends on the value returned by .Fn sysconf _SC_ARG_MAX ) . diff --git a/usr.sbin/pkg_install/delete/pkg_delete.1 b/usr.sbin/pkg_install/delete/pkg_delete.1 index 44b20bf25af..fecba972110 100644 --- a/usr.sbin/pkg_install/delete/pkg_delete.1 +++ b/usr.sbin/pkg_install/delete/pkg_delete.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pkg_delete.1,v 1.3 1998/09/07 22:30:15 marc Exp $ +.\" $OpenBSD: pkg_delete.1,v 1.4 1998/12/16 02:47:53 aaron Exp $ .\" .\" FreeBSD install - a package for the installation and maintainance .\" of non-core utilities. @@ -18,16 +18,16 @@ .\" from FreeBSD: @(#)pkg_delete.1 .\" .Dd November 25, 1994 -.Dt pkg_delete 1 +.Dt PKG_DELETE 1 .Os .Sh NAME .Nm pkg_delete .Nd a utility for deleting previously installed software package distributions .Sh SYNOPSIS -.Nm +.Nm pkg_delete .Op Fl vDdnf .Op Fl p Ar prefix -.Ar pkg-name ... +.Ar pkg-name Op Ar ... .Sh DESCRIPTION The .Nm @@ -35,7 +35,6 @@ command is used to delete packages that have been previously installed with the .Xr pkg_add 1 command. - .Sh WARNING .Bf -emphasis Since the @@ -62,11 +61,10 @@ directives, and/or use the .Xr pkg_info 1 command to examine the installed package control files. .Ef - .Sh OPTIONS The following command line options are supported: .Bl -tag -width indent -.It Ar pkg-name ... +.It Ar pkg-name Op Ar ... The named packages are deinstalled. .It Fl v Turn on verbose output. @@ -95,7 +93,6 @@ the package. Force removal of the package, even if a dependency is recorded or the deinstall or require script fails. .El - .Pp .Sh TECHNICAL DETAILS .Nm @@ -115,11 +112,12 @@ If the package contains a file (see .Xr pkg_create 1 ), then this is executed first as -.Bd -filled -offset indent -compact +.Bd -filled -offset indent .Cm require .Ar <pkg-name> .Ar DEINSTALL .Ed +.Pp (where .Ar pkg-name is the name of the package in question and @@ -140,11 +138,12 @@ knows how to do is delete the files created in the original distribution. The .Nm deinstall script is called as: -.Bd -filled -offset indent -compact +.Bd -filled -offset indent .Cm deinstall .Ar <pkg-name> .Ar DEINSTALL .Ed +.Pp Passing the keyword .Ar DEINSTALL lets you potentially write only one program/script that handles all @@ -167,7 +166,7 @@ or .Xr pkg_create 1 , .Xr pkg_info 1 , .Xr mktemp 3 , -.Xr mtree 8 . +.Xr mtree 8 .Sh AUTHORS .Bl -tag -width indent -compact .It "Jordan Hubbard" |