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.54 2005/02/13 22:25:30 ru Exp $
19 .\" $DragonFly: src/usr.sbin/pkg_install/info/Attic/pkg_info.1,v 1.4 2005/03/08 19:11:30 joerg Exp $
26 .Nd a utility for displaying information on software packages
29 .Op Fl bcdDEfgGijIkLmopPqQrRsvVxX
33 .Fl a | Ar pkg-name ...
44 command is used to dump out information for packages, either packed up in
47 command or already installed on the system
52 The following command line options are supported:
53 .Bl -tag -width indent
55 The named packages are described.
56 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.
59 Package version numbers can also be matched in a relational manner using the
60 .Pa \*[Ge], \*[Le], \*[Gt]
65 .Pa pkg_info 'portupgrade\*[Ge]20030723'
66 will match versions 20030723 and later of the
70 Show all currently installed packages.
72 Use the BLOCKSIZE environment variable for output even when the
78 Turn on verbose output.
80 Show the installation prefix for each package.
84 in emitting report headers and such, just dump the
85 raw info (basically, assume a non-human reading).
89 as above but print preface output with the package name.
91 Show the (one line) comment field for each package.
93 Show the long description field for each package.
95 Show the install-message file for each package.
97 Show the packing list instructions for each package.
99 Show files that do not match the recorded checksum.
101 Show the install script (if any) for each package.
103 Show an index line for each package.
105 precedence over all other package formatting options.
107 Show the requirements script (if any) for each package.
109 Show the de-install script (if any) for each package.
111 Show the list of packages on which each package depends.
113 Show the list of installed packages which require each package.
115 Show the mtree file (if any) for each package.
117 Show the files within each package.
118 This is different from just
119 viewing the packing list, since full pathnames for everything
122 Show the total size occupied by files installed within each package.
126 path recorded on package generation.
128 intended to give an idea as to where the underlying port, from which
129 package was generated, is located in the
131 .Em "Ports Collection" .
133 Do not try to expand shell glob patterns in the
135 when selecting packages to be displayed (by default
137 automatically expands shell glob patterns in the
142 argument show which package it belongs to.
143 If the file is not in the
144 current directory, and does not have an absolute path, then the
151 argument list all packages having this origin.
155 as a regular expression and display information only for packages
156 whose names match that regular expression.
158 expressions could be provided, in that case
160 displays information about all packages that match at least one
161 regular expression from the list.
167 as an extended regular expression.
169 If the package identified by
171 is currently installed, return 0, otherwise return 1.
173 allows you to easily test for the presence of another (perhaps
174 prerequisite) package from a script.
176 Show only matching package names.
178 precedence over all other package formatting options.
179 If any packages match, return 0, otherwise return 1.
181 Prefix each information category header (see
185 This is primarily of use to front-end programs who want to request a
186 lot of different information fields at once for a package, but do not
187 necessary want the output intermingled in such a way that they cannot
189 This lets you add a special token to the start of
198 By default, this is the string
199 .Pa /tmp/instmp.XXXXXX ,
200 but it may be necessary to override it in the situation where
203 directory is limited.
204 Be sure to leave some number of `X' characters
207 to fill in with a unique ID.
208 .Bd -ragged -offset indent -compact
209 Note: This should really not be necessary with
211 since very little information is extracted from each package
212 and one would have to have a very small
214 indeed to overflow it.
217 Show revision number of the packing list format.
219 Show revision number of package tools.
221 .Sh TECHNICAL DETAILS
222 Package info is either extracted from package files named on the
223 command line, or from already installed package information
225 .Pa /var/db/pkg/ Ns Aq Ar pkg-name .
227 .Bl -tag -width PKG_TMPDIR
229 If the environment variable
231 is set the block counts will be displayed in units of that
234 Points to the directory where
236 creates its temporary files.
237 If this variable is not set,
240 If both are unset, the builtin defaults are used.
242 Specifies an alternative location for the installed package database.
245 .Bl -tag -width /var/db/pkg -compact
247 Used if the environment variables
251 are not set, or if the directories named have insufficient space.
255 does not exist or has insufficient space.
261 Default location of the installed package database.
273 .An John Kohl Aq jtk@rational.com ,
274 .An Oliver Eikemeier Aq eik@FreeBSD.org