Alphabetize options.

This commit is contained in:
hubertf 2001-01-07 01:39:20 +00:00
parent 610a127a3d
commit f4f6931307
4 changed files with 145 additions and 146 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pkg_add.1,v 1.20 2000/10/05 12:45:22 ad Exp $ .\" $NetBSD: pkg_add.1,v 1.21 2001/01/07 01:39:20 hubertf Exp $
.\" .\"
.\" FreeBSD install - a package for the installation and maintainance .\" FreeBSD install - a package for the installation and maintainance
.\" of non-core utilities. .\" of non-core utilities.
@ -86,23 +86,37 @@ will search them in each directory named by the
environment variable. environment variable.
Any dependencies required by the installed package will be searched Any dependencies required by the installed package will be searched
in the same location that the original package was installed from. in the same location that the original package was installed from.
.It Fl v
Turn on verbose output.
.It Fl I
If an installation script exists for a given package, do not execute it.
.It Fl n
Don't actually install a package, just report the steps that
would be taken if it was.
.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!
.It Fl f .It Fl f
Force installation to proceed even if prerequisite packages are not Force installation to proceed even if prerequisite packages are not
installed or the requirements script fails. Although installed or the requirements script fails. Although
.Nm .Nm
will still try to find and auto-install missing prerequisite packages, will still try to find and auto-install missing prerequisite packages,
a failure to find one will not be fatal. a failure to find one will not be fatal.
.It Fl I
If an installation script exists for a given package, do not execute it.
.It Fl M
Run in
.Cm MASTER
mode. This is a very specialized mode for running
.Nm
and is meant to be run in conjunction with
.Cm SLAVE
mode. When run in this mode,
.Nm
does no work beyond extracting the package into a temporary staging
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
.Xr sed 1 .
When used in conjunction with
.Cm SLAVE
mode, it allows you to make radical changes to the package structure
before acting on its contents.
.It Fl n
Don't actually install a package, just report the steps that
would be taken if it was.
.It Fl p Ar prefix .It Fl p Ar prefix
Set Set
.Ar prefix .Ar prefix
@ -125,6 +139,23 @@ modes (see the
and and
.Fl S .Fl S
options). options).
.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!
.It Fl S
Run in
.Cm SLAVE
mode. This is a very specialized mode for running
.Nm
and is meant to be run in conjunction with
.Cm MASTER
mode. When run in this mode,
.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.
.It Fl t Ar template .It Fl t Ar template
Use Use
.Ar template .Ar template
@ -146,39 +177,8 @@ You can get a performance boost by setting the staging area
to reside on the same disk partition as target directories for package to reside on the same disk partition as target directories for package
file installation; often this is file installation; often this is
.Pa /usr . .Pa /usr .
.It Fl M .It Fl v
Run in Turn on verbose output.
.Cm MASTER
mode. This is a very specialized mode for running
.Nm
and is meant to be run in conjunction with
.Cm SLAVE
mode. When run in this mode,
.Nm
does no work beyond extracting the package into a temporary staging
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
.Xr sed 1 .
When used in conjunction with
.Cm SLAVE
mode, it allows you to make radical changes to the package structure
before acting on its contents.
.It Fl S
Run in
.Cm SLAVE
mode. This is a very specialized mode for running
.Nm
and is meant to be run in conjunction with
.Cm MASTER
mode. When run in this mode,
.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.
.El .El
.Pp .Pp
One or more One or more

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pkg_admin.1,v 1.10 2000/11/12 15:32:57 wiz Exp $ .\" $NetBSD: pkg_admin.1,v 1.11 2001/01/07 01:39:20 hubertf Exp $
.\" .\"
.\" Copyright (c) 1999 Hubert Feyrer. All rights reserved. .\" Copyright (c) 1999 Hubert Feyrer. All rights reserved.
.\" .\"
@ -43,25 +43,6 @@ This command performs various administrative tasks around the NetBSD
Packages System. Available commands are: Packages System. Available commands are:
.Pp .Pp
.Bl -tag -width check [pkg] .Bl -tag -width check [pkg]
.It Cm rebuild
Rebuild the package database mapping from scratch, scanning
subdirectories in
.Pa /var/db/pkg
for
.Pa +CONTENTS
files, parsing them and writing the resulting absolute pathnames
together with the package they belong to into the package database.
.Pp
This option is intended to be used for upgrading from non-pkgdb-pkg_*
tools to pkgdb-pkg_* tools, further manipulation of the pkgdb will be
done by
.Xr pkg_add 1 ,
.Xr pkg_delete 1
and
.Xr pkg_create 1 .
.Pp
Needs to be run as root.
.Pp
.It Cm check Ar [pkg ...] .It Cm check Ar [pkg ...]
Use this command to check the files belonging to some or all of the Use this command to check the files belonging to some or all of the
packages installed on the local machine against their MD5 checksum packages installed on the local machine against their MD5 checksum
@ -110,6 +91,25 @@ yui# pkg_admin lsall /usr/pkgsrc/packages/i386ELF/All/'{mit,unproven}-pthread*'
/usr/pkgsrc/packages/i386ELF/All/mit-pthreads-1.60b6.tgz /usr/pkgsrc/packages/i386ELF/All/mit-pthreads-1.60b6.tgz
/usr/pkgsrc/packages/i386ELF/All/unproven-pthreads-0.15.tgz /usr/pkgsrc/packages/i386ELF/All/unproven-pthreads-0.15.tgz
.Ed .Ed
.It Cm rebuild
Rebuild the package database mapping from scratch, scanning
subdirectories in
.Pa /var/db/pkg
for
.Pa +CONTENTS
files, parsing them and writing the resulting absolute pathnames
together with the package they belong to into the package database.
.Pp
This option is intended to be used for upgrading from non-pkgdb-pkg_*
tools to pkgdb-pkg_* tools, further manipulation of the pkgdb will be
done by
.Xr pkg_add 1 ,
.Xr pkg_delete 1
and
.Xr pkg_create 1 .
.Pp
Needs to be run as root.
.Pp
.El .El
.Pp .Pp
.Sh ENVIRONMENT .Sh ENVIRONMENT

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pkg_create.1,v 1.24 2000/07/05 15:45:36 msaitoh Exp $ .\" $NetBSD: pkg_create.1,v 1.25 2001/01/07 01:39:20 hubertf Exp $
.\" .\"
.\" FreeBSD install - a package for the installation and maintainance .\" FreeBSD install - a package for the installation and maintainance
.\" of non-core utilities. .\" of non-core utilities.
@ -104,6 +104,15 @@ description of the input syntax is included in this document.
.Sh OPTIONS .Sh OPTIONS
The following command line options are supported: The following command line options are supported:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl b Ar build-version-file
Install the file
.Ar build-version-file
so that users of binary packages can see what versions of
the files used to control the build were used when creating the
binary package. This allows some fine-grained version control information
to be retained in a binary package and viewed wherever it is installed,
using
.Xr pkg_info 1 .
.It Fl B Ar build-info-file .It Fl B Ar build-info-file
Install the file Install the file
.Ar build-info-file .Ar build-info-file
@ -115,65 +124,6 @@ binary package. This allows various build definitions
to be retained in a binary package and viewed wherever it is installed, to be retained in a binary package and viewed wherever it is installed,
using using
.Xr pkg_info 1 . .Xr pkg_info 1 .
.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).
.It Fl D Ar displayfile
Display the file after installing the package. Useful for things like
legal notices on almost-free software, etc.
.It Fl L Ar SrcDir
This sets the package's @src directive; see below for a description
of what this does.
.It Fl O
Go into a `packing list Only' mode.
This is used to do `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 P Ar dpkgs
Set the initial package dependency list to
.Ar dpkgs .
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).
.It Fl R
Re-order any directories in the pkg/PLIST file into reverse alphabetic
order, so that child directories will automatically be removed before
parent directories.
.It Fl S Ar size-all-file
Store the given file for later querying with the
.Xr pkg_info 1
.Ar -S
flag. The file is expected to contain the size (in bytes) of all files of
this package plus any required packages added up and stored as a
ASCII string, terminated by a newline.
.It Fl X Ar excludefile
Pass
.Ar excludefile
as a
.Fl -exclude-from
argument to
.Cm tar
when creating final package. See
.Cm tar
man page (or run
.Cm tar
with
.Fl -help
flag) for further information on using this flag.
.It Fl b Ar build-version-file
Install the file
.Ar build-version-file
so that users of binary packages can see what versions of
the files used to control the build were used when creating the
binary package. This allows some fine-grained version control information
to be retained in a binary package and viewed wherever it is installed,
using
.Xr pkg_info 1 .
.It Fl c Ar [-]desc .It Fl c Ar [-]desc
Fetch package ``one line description'' from file Fetch package ``one line description'' from file
.Ar desc .Ar desc
@ -182,12 +132,22 @@ or, if preceded by
the argument itself. This string should also the argument itself. This string should also
give some idea of which version of the product (if any) the package give some idea of which version of the product (if any) the package
represents. represents.
.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).
.It Fl d Ar [-]desc .It Fl d Ar [-]desc
Fetch long description for package from file Fetch long description for package from file
.Ar desc .Ar desc
or, if preceded by or, if preceded by
.Cm - , .Cm - ,
the argument itself. the argument itself.
.It Fl D Ar displayfile
Display the file after installing the package. Useful for things like
legal notices on almost-free software, etc.
.It Fl f Ar packinglist .It Fl f Ar packinglist
Fetch ``packing list'' for package from the file Fetch ``packing list'' for package from the file
.Ar packinglist .Ar packinglist
@ -221,6 +181,9 @@ and
.Xr symlink 2 .Xr symlink 2
to remove and re-link to remove and re-link
any symbolic links which are targetted at full path names. any symbolic links which are targetted at full path names.
.It Fl L Ar SrcDir
This sets the package's @src directive; see below for a description
of what this does.
.It Fl m Ar mtreefile .It Fl m Ar mtreefile
Run Run
.Xr mtree 8 .Xr mtree 8
@ -239,11 +202,23 @@ where
is the name of the first directory named by a is the name of the first directory named by a
.Cm @cwd .Cm @cwd
directive. directive.
.It Fl O
Go into a `packing list Only' mode.
This is used to do `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 p Ar prefix .It Fl p Ar prefix
Set Set
.Ar prefix .Ar prefix
as the initial directory ``base'' to start from in selecting files for as the initial directory ``base'' to start from in selecting files for
the package. the package.
.It Fl P Ar dpkgs
Set the initial package dependency list to
.Ar dpkgs .
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).
.It Fl r Ar rscript .It Fl r Ar rscript
Set Set
.Ar rscript .Ar rscript
@ -251,12 +226,23 @@ to be the ``requirements'' procedure for the package. This can be any
executable program (or shell script). It will be invoked automatically executable program (or shell script). It will be invoked automatically
at installation/deinstallation time to determine whether or not at installation/deinstallation time to determine whether or not
installation/deinstallation should proceed. installation/deinstallation should proceed.
.It Fl R
Re-order any directories in the pkg/PLIST file into reverse alphabetic
order, so that child directories will automatically be removed before
parent directories.
.It Fl s Ar size-pkg-file .It Fl s Ar size-pkg-file
Store the given file for later querying with the Store the given file for later querying with the
.Xr pkg_info 1 .Xr pkg_info 1
.Ar -s .Ar -s
flag. The file is expected to contain the the size (in bytes) of all files of flag. The file is expected to contain the the size (in bytes) of all files of
this package added up and stored as a ASCII string, terminated by a newline. this package added up and stored as a ASCII string, terminated by a newline.
.It Fl S Ar size-all-file
Store the given file for later querying with the
.Xr pkg_info 1
.Ar -S
flag. The file is expected to contain the size (in bytes) of all files of
this package plus any required packages added up and stored as a
ASCII string, terminated by a newline.
.It Fl t Ar template .It Fl t Ar template
Use Use
.Ar template .Ar template
@ -273,6 +259,20 @@ for
to fill in with a unique ID. to fill in with a unique ID.
.It Fl v .It Fl v
Turn on verbose output. Turn on verbose output.
.It Fl X Ar excludefile
Pass
.Ar excludefile
as a
.Fl -exclude-from
argument to
.Cm tar
when creating final package. See
.Cm tar
man page (or run
.Cm tar
with
.Fl -help
flag) for further information on using this flag.
.El .El
.Pp .Pp
.Sh PACKING LIST DETAILS .Sh PACKING LIST DETAILS

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pkg_delete.1,v 1.17 2000/11/07 06:43:37 lukem Exp $ .\" $NetBSD: pkg_delete.1,v 1.18 2001/01/07 01:39:21 hubertf Exp $
.\" .\"
.\" FreeBSD install - a package for the installation and maintainance .\" FreeBSD install - a package for the installation and maintainance
.\" of non-core utilities. .\" of non-core utilities.
@ -78,10 +78,25 @@ If the
flag is given, one or more (absolute) filenames may be specified and flag is given, one or more (absolute) filenames may be specified and
the Package Database will be consulted for the package to which the the Package Database will be consulted for the package to which the
given file belongs. These packages are then deinstalled. given file belongs. These packages are then deinstalled.
.It Fl v .It Fl d
Turn on verbose output. Remove empty directories created by file cleanup. By default, only
files/directories explicitly listed in a package's contents (either as
normal files/directories or with the
.Cm @dirrm
directive) will be removed at deinstallation time. This option tells
.Nm
to also remove any directories that were emptied as a result of removing
the package.
.It Fl D .It Fl D
If a deinstallation script exists for a given package, do not execute it. If a deinstallation script exists for a given package, do not execute it.
.It Fl f
Force removal of the package, even if a dependency is recorded or the
deinstall or require script fails.
.It Fl F
Any pkg-name given will be interpreted as pathname which is
subsequently transformed in a (real) package name via the Package
Database. That way, packges can be deleted by giving a filename
instead of the package-name.
.It Fl n .It Fl n
Don't actually deinstall a package, just report the steps that Don't actually deinstall a package, just report the steps that
would be taken if it were. would be taken if it were.
@ -109,25 +124,9 @@ option, this does a recursive delete. The
option deletes the given package and any packages required by option deletes the given package and any packages required by
it, unless some other package still needs them. This can be used it, unless some other package still needs them. This can be used
to delete a package and all the packages it needs. to delete a package and all the packages it needs.
.It Fl d .It Fl v
Remove empty directories created by file cleanup. By default, only Turn on verbose output.
files/directories explicitly listed in a package's contents (either as
normal files/directories or with the
.Cm @dirrm
directive) will be removed at deinstallation time. This option tells
.Nm
to also remove any directories that were emptied as a result of removing
the package.
.It Fl F
Any pkg-name given will be interpreted as pathname which is
subsequently transformed in a (real) package name via the Package
Database. That way, packges can be deleted by giving a filename
instead of the package-name.
.It Fl f
Force removal of the package, even if a dependency is recorded or the
deinstall or require script fails.
.El .El
.Pp .Pp
.Sh TECHNICAL DETAILS .Sh TECHNICAL DETAILS
.Nm .Nm