Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/netbsd-1-6]: src/usr.sbin/pkg_install/create Pull up revision 1.34 (requ...
details: https://anonhg.NetBSD.org/src/rev/509f9191ce7a
branches: netbsd-1-6
changeset: 529516:509f9191ce7a
user: tron <tron%NetBSD.org@localhost>
date: Sun Nov 24 22:32:05 2002 +0000
description:
Pull up revision 1.34 (requested by jschauma in ticket #1011):
Ispell. Begin new sentences on a new line.
diffstat:
usr.sbin/pkg_install/create/pkg_create.1 | 151 +++++++++++++++++-------------
1 files changed, 86 insertions(+), 65 deletions(-)
diffs (truncated from 333 to 300 lines):
diff -r bcae4b80b0cb -r 509f9191ce7a usr.sbin/pkg_install/create/pkg_create.1
--- a/usr.sbin/pkg_install/create/pkg_create.1 Sun Nov 24 22:31:28 2002 +0000
+++ b/usr.sbin/pkg_install/create/pkg_create.1 Sun Nov 24 22:32:05 2002 +0000
@@ -1,6 +1,6 @@
-.\" $NetBSD: pkg_create.1,v 1.32.2.1 2002/11/24 22:31:15 tron Exp $
+.\" $NetBSD: pkg_create.1,v 1.32.2.2 2002/11/24 22:32:05 tron Exp $
.\"
-.\" FreeBSD install - a package for the installation and maintainance
+.\" FreeBSD install - a package for the installation and maintenance
.\" of non-core utilities.
.\"
.\" Redistribution and use in source and binary forms, with or without
@@ -98,12 +98,14 @@
The
.Nm
command is used to create packages that will subsequently be fed to
-one of the package extraction/info utilities. The input description
-and command line arguments for the creation of a package are not
-really meant to be human-generated, though it is easy enough to
-do so. It is more expected that you will use a front-end tool for
-the job rather than muddling through it yourself. Nonetheless, a short
-description of the input syntax is included in this document.
+one of the package extraction/info utilities.
+The input description and command line arguments for the creation of a
+package are not really meant to be human-generated, though it is easy
+enough to do so.
+It is more expected that you will use a front-end tool for
+the job rather than muddling through it yourself.
+Nonetheless, a short description of the input syntax is included in this
+document.
.Sh OPTIONS
The following command line options are supported:
.Bl -tag -width indent
@@ -114,18 +116,18 @@
.Xr make 1
definitions
were used to control the build when creating the
-binary package. This allows various build definitions
-to be retained in a binary package and viewed wherever it is installed,
-using
+binary package.
+This allows various build definitions to be retained in a binary package
+and viewed wherever it is installed, using
.Xr pkg_info 1 .
.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
+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 cpkgs
Set the initial package conflict list to
@@ -139,12 +141,12 @@
.Ar desc
or, if preceded by
.Cm - ,
-the argument itself. This string should also
-give some idea of which version of the product (if any) the package
-represents.
+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 displayfile
-Display the file after installing the package. Useful for things like
-legal notices on almost-free software, etc.
+Display the file after installing the package.
+Useful for things like legal notices on almost-free software, etc.
.It Fl d Ar [-]desc
Fetch long description for package from file
.Ar desc
@@ -170,26 +172,28 @@
.It Fl i Ar iscript
Set
.Ar iscript
-to be the install procedure for the package. This can be any
-executable program (or shell script). It will be invoked automatically
-when the package is later installed.
+to be the install procedure for the package.
+This can be any executable program (or shell script).
+It will be invoked automatically when the package is later installed.
.It Fl k Ar dscript
Set
.Ar dscript
-to be the de-install procedure for the package. This can be any
-executable program (or shell script). It will be invoked automatically
+to be the de-install procedure for the package.
+This can be any executable program (or shell script).
+It will be invoked automatically
when the package is later (if ever) de-installed.
.It Fl L Ar SrcDir
This sets the package's @src directive; see below for a description
of what this does.
.It Fl l
Check that any symbolic links which are to be placed in the package are
-relative to the current prefix. This means using
+relative to the current prefix.
+This means using
.Xr unlink 2
and
.Xr symlink 2
to remove and re-link
-any symbolic links which are targetted at full path names.
+any symbolic links which are targeted at full path names.
.It Fl m Ar mtreefile
Run
.Xr mtree 8
@@ -237,22 +241,24 @@
.It Fl r Ar rscript
Set
.Ar rscript
-to be the ``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.
+to be the ``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.
.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
+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 s Ar size-pkg-file
Store the given file for later querying with the
.Xr pkg_info 1
.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.
.It Fl t Ar template
Use
@@ -264,8 +270,8 @@
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 `X' characters for
.Xr mktemp 3
to fill in with a unique ID.
.It Fl U
@@ -281,7 +287,8 @@
.Fl -exclude-from
argument to
.Cm tar
-when creating final package. See
+when creating final package.
+See
.Cm tar
man page (or run
.Cm tar
@@ -294,12 +301,15 @@
.Fl f )
is fairly simple, being
nothing more than a single column of filenames to include in the
-package. However, since absolute pathnames are generally a bad idea
+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
-in the packing list. Briefly described, these sequences are:
+installed with.
+This is done by embedding specialized command sequences
+in the packing list.
+Briefly described, these sequences are:
.Bl -tag -width indent -compact
.It Cm @cwd Ar directory
Set the internal directory pointer to point to
@@ -317,10 +327,12 @@
.It Cm @exec Ar command
Execute
.Ar command
-as part of the unpacking process. If
+as part of the unpacking process.
+If
.Ar command
contains any of the following sequences somewhere in it, they will
-be expanded inline. For the following examples, assume that
+be expanded inline.
+For the following examples, assume that
.Cm @cwd
is set to
.Pa /usr/local
@@ -338,7 +350,8 @@
.It Cm "%B"
Expand to the ``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
+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
@@ -350,17 +363,18 @@
.It Cm @unexec Ar command
Execute
.Ar command
-as part of the deinstallation process. Expansion of special
+as part of the deinstallation process.
+Expansion of special
.Cm %
sequences is the same as for
.Cm @exec .
This command is not executed during the package add, as
.Cm @exec
-is, but rather when the package is deleted. This is useful
-for deleting links and other ancillary files that were created
-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
+is, but rather when the package is deleted.
+This is useful for deleting links and other ancillary files that were created
+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
@@ -372,8 +386,8 @@
Format is the same as that used by the
.Cm chmod
command (well, considering that it's later handed off to it, that's
-no surprise). Use without an arg to set back to default (extraction)
-permissions.
+no surprise).
+Use without an arg to set back to default (extraction) permissions.
.It Cm @option Ar option
Set internal package options, the only two currently supported ones
being
@@ -397,8 +411,8 @@
Use without an arg to set back to default (extraction)
group ownership.
.It Cm @comment Ar string
-Imbed a comment in the packing list. Useful in
-trying to document some particularly hairy sequence that
+Imbed a comment in the packing list.
+Useful in trying to document some particularly hairy sequence that
may trip someone up later.
.It Cm @ignore
Used internally to tell extraction to ignore the next file (don't
@@ -406,27 +420,30 @@
.It Cm @ignore_inst
Similar to
.Cm @ignore ,
-but the ignoring of the next file is delayed one evaluation cycle. This
-makes it possible to use this directive in the
+but the ignoring of the next file is delayed one evaluation cycle.
+This makes it possible to use this directive in the
.Ar packinglist
file, so you can pack a
specialized datafile in with a distribution for your install script (or
something) yet have the installer ignore it.
.It Cm @name Ar name
-Set the name of the package. This is mandatory and is usually
-put at the top. This name is potentially different than the name of
-the file it came in, and is used when keeping track of the package
-for later deinstallation. Note that
+Set the name of the package.
+This is mandatory and is usually put at the top.
+This name is potentially different than the name of the file it came in,
+and is used when keeping track of the package for later deinstallation.
+Note that
.Nm
will derive this field from the package name and add it automatically
if none is given.
.It Cm @dirrm Ar name
Declare directory
.Pa name
-to be deleted at deinstall time. By default, directories created by a
-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
+to be deleted at deinstall time.
+By default, directories created by a 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.
The
@@ -439,7 +456,8 @@
.Xr mtree 8
input file to be used at install time (see
.Fl m
Home |
Main Index |
Thread Index |
Old Index