aboutsummaryrefslogtreecommitdiff
path: root/usr.sbin/pkg_install/info/pkg_info.1
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/pkg_install/info/pkg_info.1')
-rw-r--r--usr.sbin/pkg_install/info/pkg_info.1147
1 files changed, 79 insertions, 68 deletions
diff --git a/usr.sbin/pkg_install/info/pkg_info.1 b/usr.sbin/pkg_install/info/pkg_info.1
index 1f28c17bc322..df996ceca048 100644
--- a/usr.sbin/pkg_install/info/pkg_info.1
+++ b/usr.sbin/pkg_install/info/pkg_info.1
@@ -16,108 +16,119 @@
.\"
.\" @(#)pkg_info.1
.\"
-.TH pkg_info 1 "July 18, 1993" "" "FreeBSD"
-
-.SH NAME
-pkg_info - a utility for getting information on software package distributions.
-.SH SYNOPSIS
-.na
-.B pkg_info
-.RB [options]
-.RB "pkg-file|pkg-name\ [.. pkg-file|pkg-name]"
-
-.SH DESCRIPTION
+.Dd November 25, 1994
+.Dt pkg_info 1
+.Os NetBSD 1.0
+.Sh NAME
+.Nm pkg_info
+.Nd a utility for displaying information on software packages.
+.Sh SYNOPSIS
+.Nm pkg_info
+.Op Fl cdDikrRpLqImv
+.Op Fl e Ar package
+.Op Fl l Ar prefix
+.Ar pkg-name ...
+.Nm pkg_info
+.Fl a
+.Op Ar flags
+.Sh DESCRIPTION
The
-.B pkg_info
+.Nm
command is used to dump out information for packages, either packed up in
files or already installed on the system
with the
-.B pkg_create
+.Xr pkg_create 8
command.
-
-.SH OPTIONS
-.TP
+.Sh OPTIONS
The following command line options are supported.
-.TP
-.B \-a
+.Bl -tag -width indent
+.It Ar pkg-name ...
+The named packages are described. Names may either be installed package
+names or pathnames to package distribution files.
+.It Fl a
Show all currently installed packages.
-.TP
-.B \-v
+.It Fl v
Turns on verbose output.
-.TP
-.B \-p
+.It Fl p
Show the installation prefix for each package.
-.TP
-.B \-q
-Be "quiet" in emitting report headers and such, just dump the
+.It Fl q
+Be ``quiet'' in emitting report headers and such, just dump the
raw info (basically, assume a non-human reading).
-.TP
-.B \-c
+.It Fl c
Show the comment (one liner) field for each package.
-.TP
-.B \-d
+.It Fl d
Show the long description field for each package.
-.TP
-.B \-f
+.It Fl D
+Show the install-message file for each package.
+.It Fl f
Show the packing list instructions for each package.
-.TP
-.B \-i
+.It Fl i
Show the install script (if any) for each package.
-.TP
-.B \-k
+.It Fl k
Show the de-install script (if any) for each package.
-.TP
-.B \-r
+.It Fl r
Show the requirements script (if any) for each package.
-.TP
-.B \-L
+.It Fl m
+Show the mtree file (if any) for each package.
+.It Fl L
Show the files within each package. This is different from just
viewing the packing list, since full pathnames for everything
are generated.
-.TP
-.BI "\-e\ " pkg-name
+.It Fl e Ar pkg-name
If the package identified by
-.I pkg-name
+.Ar pkg-name
is currently installed, return 0, otherwise return 1. This option
allows you to easily test for the presence of another (perhaps
prerequisite) package from a script.
-.TP
-.BI "\-l\ " str
+.It Fl l Ar str
Prefix each information catagory header (see
-.I \-q)
+.Fl q )
shown with
-.I str.
+.Ar str .
This is primarily of use to front-end programs who want to request a
lot of different information fields at once for a package, but don't
necessary want the output intermingled in such a way that they can't
organize it. This lets you add a special token to the start of
each field.
-.TP
-.BI "\-t\ " template
+.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.
+for
+.Xr mktemp 3
+to fill in with a unique ID.
+.Bd -filled -offset indent -compact
Note: This should really not be necessary with pkg_info,
since very little information is extracted from each package
-and one would have to have a very small /tmp indeed to overflow
-it.
-.PP
-.SH "TECHNICAL DETAILS"
-Package info is either extracted from files supplied on the
+and one would have to have a very small
+.Pa /tmp
+indeed to overflow it.
+.Ed
+.Sh TECHNICAL DETAILS
+Package info is either extracted from package files named on the
command line, or from already installed package information
-in /var/db/pkg/<pkg-name>.
-.SH BUGS
+in
+.Pa /var/db/pkg/<pkg-name> .
+.Sh SEE ALSO
+.Xr mktemp 3 ,
+.Xr mtree 8 ,
+.Xr pkg_add 1 ,
+.Xr pkg_create 1 ,
+.Xr pkg_delete 1 .
+.Sh AUTHORS
+.Bl -tag -width indent -compact
+.It "Jordan Hubbard"
+most of the work
+.It "John Kohl"
+refined it for NetBSD
+.El
+.Sh BUGS
Sure to be some.
-.SH "SEE ALSO"
-.BR pkg_add "(" 1 "),"
-.BR pkg_create "(" 1 "),"
-.BR pkg_delete "(" 1 "),"
-.SH AUTHORS
-Jordan Hubbard
-