2 .\" FreeBSD install - a package for the installation and maintenance
3 .\" of non-core utilities.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in the
12 .\" documentation and/or other materials provided with the distribution.
18 .\" $FreeBSD: src/usr.sbin/pkg_install/info/pkg_info.1,v 1.24.2.13 2002/08/02 11:09:05 sobomax Exp $
25 .Nd a utility for displaying information on software packages
28 .Op Fl cdDfgGiIkLmopqrRsvVx
45 command is used to dump out information for packages, either packed up in
48 command or already installed on the system
53 The following command line options are supported:
54 .Bl -tag -width indent
56 The named packages are described. A package name may either be the name of
57 an installed package, the pathname to a package distribution file or a
58 URL to an FTP available package.
60 Show all currently installed packages.
62 Turn on verbose output.
64 Show the installation prefix for each package.
68 in emitting report headers and such, just dump the
69 raw info (basically, assume a non-human reading).
71 Show the (one line) comment field for each package.
73 Show the long description field for each package.
75 Show the install-message file for each package.
77 Show the packing list instructions for each package.
79 Show files that don't match the recorded checksum.
81 Show the install script (if any) for each package.
83 Show an index line for each package. This option takes
84 precedence over all other package formatting options.
86 Show the de-install script (if any) for each package.
88 Show the requirements script (if any) for each package.
90 Show the list of installed packages which require each package.
92 Show the mtree file (if any) for each package.
94 Show the files within each package. This is different from just
95 viewing the packing list, since full pathnames for everything
98 Show the total size occupied by files installed within each package.
102 path recorded on package generation. This path
103 intended to give an idea as to where the underlying port, from which
104 package was generated, is located in the
106 .Em "Ports Collection" .
108 Do not try to expand shell glob patterns in the
110 when selecting packages to be displayed (by default
112 automatically expands shell glob patterns in the
117 argument show which package it belongs to. If the file is not in the
118 current directory, and does not have an absolute path, then the
125 argument list all packages having this origin.
129 as a regular expression and display information only for packages
130 whose names match that regular expression. Multiple regular
131 expressions could be provided, in that case
133 displays information about all packages that match at least one
134 regular expression from the list.
136 If the package identified by
138 is currently installed, return 0, otherwise return 1. This option
139 allows you to easily test for the presence of another (perhaps
140 prerequisite) package from a script.
142 Prefix each information category header (see
146 This is primarily of use to front-end programs who want to request a
147 lot of different information fields at once for a package, but don't
148 necessary want the output intermingled in such a way that they can't
149 organize it. This lets you add a special token to the start of
158 By default, this is the string
159 .Pa /tmp/instmp.XXXXXX ,
160 but it may be necessary to override it in the situation where
163 directory is limited. Be sure to leave some number of `X' characters
166 to fill in with a unique ID.
167 .Bd -ragged -offset indent -compact
168 Note: This should really not be necessary with
170 since very little information is extracted from each package
171 and one would have to have a very small
173 indeed to overflow it.
176 Show revision number of the packing list format.
178 .Sh TECHNICAL DETAILS
179 Package info is either extracted from package files named on the
180 command line, or from already installed package information
182 .Pa /var/db/pkg/ Ns Aq Ar pkg-name .
185 points to the directory where
187 creates its temporary files.
188 If this variable is not set,
190 is used. If both are unset, the builtin defaults are used.
193 specifies an alternative location for the installed package database.
195 .Bl -tag -width /var/db/pkg -compact
197 Used if the environment variables
201 are not set, or if the directories named have insufficient space.
205 does not exist or has insufficient space.
211 Default location of the installed package database.
223 .An John Kohl Aq jtk@rational.com