You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

372 lines
18 KiB

  1. <?xml version="1.0" encoding="utf-8" standalone="no"?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "" [
  4. <!ENTITY % aptent SYSTEM "apt.ent">
  5. %aptent;
  6. ]>
  7. <refentry>
  8. &apt-docinfo;
  9. <refmeta>
  10. <refentrytitle>apt-cache</refentrytitle>
  11. <manvolnum>8</manvolnum>
  12. </refmeta>
  13. <!-- Man page title -->
  14. <refnamediv>
  15. <refname>apt-cache</refname>
  16. <refpurpose>APT package handling utility -- cache manipulator</refpurpose>
  17. </refnamediv>
  18. <!-- Arguments -->
  19. <refsynopsisdiv>
  20. <cmdsynopsis>
  21. <command>apt-cache</command>
  22. <arg><option>-hvsn</option></arg>
  23. <arg><option>-o=<replaceable>config string</replaceable></option></arg>
  24. <arg><option>-c=<replaceable>file</replaceable></option></arg>
  25. <group choice="req">
  26. <arg>add <arg choice="plain" rep="repeat"><replaceable>file</replaceable></arg></arg>
  27. <arg>gencaches</arg>
  28. <arg>showpkg <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  29. <arg>showsrc <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  30. <arg>stats</arg>
  31. <arg>dump</arg>
  32. <arg>dumpavail</arg>
  33. <arg>unmet</arg>
  34. <arg>search <arg choice="plain"><replaceable>regex</replaceable></arg></arg>
  35. <arg>show <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  36. <arg>depends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  37. <arg>rdepends <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  38. <arg>pkgnames <arg choice="plain"><replaceable>prefix</replaceable></arg></arg>
  39. <arg>dotty <arg choice="plain" rep="repeat"><replaceable>pkg</replaceable></arg></arg>
  40. <arg>policy <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
  41. <arg>madison <arg choice="plain" rep="repeat"><replaceable>pkgs</replaceable></arg></arg>
  42. </group>
  43. </cmdsynopsis>
  44. </refsynopsisdiv>
  45. <refsect1><title>Description</title>
  46. <para><command>apt-cache</command> performs a variety of operations on APT's package
  47. cache. <command>apt-cache</command> does not manipulate the state of the system
  48. but does provide operations to search and generate interesting output
  49. from the package metadata.</para>
  50. <para>Unless the <option>-h</option>, or <option>--help</option> option is given, one of the
  51. commands below must be present.</para>
  52. <variablelist>
  53. <varlistentry><term>add <replaceable>file(s)</replaceable></term>
  54. <listitem><para><literal>add</literal> adds the named package index files to the package cache.
  55. This is for debugging only.</para></listitem>
  56. </varlistentry>
  57. <varlistentry><term>gencaches</term>
  58. <listitem><para><literal>gencaches</literal> performs the same operation as
  59. <command>apt-get check</command>. It builds the source and package caches from
  60. the sources in &sources-list; and from
  61. <filename>/var/lib/dpkg/status</filename>.</para></listitem>
  62. </varlistentry>
  63. <varlistentry><term>showpkg <replaceable>pkg(s)</replaceable></term>
  64. <listitem><para><literal>showpkg</literal> displays information about the packages listed on the
  65. command line. Remaining arguments are package names. The available
  66. versions and reverse dependencies of each package listed are listed, as
  67. well as forward dependencies for each version. Forward (normal)
  68. dependencies are those packages upon which the package in question
  69. depends; reverse dependencies are those packages that depend upon the
  70. package in question. Thus, forward dependencies must be satisfied for a
  71. package, but reverse dependencies need not be.
  72. For instance, <command>apt-cache showpkg libreadline2</command> would produce
  73. output similar to the following:</para>
  74. <informalexample><programlisting>
  75. Package: libreadline2
  76. Versions: 2.1-12(/var/state/apt/lists/foo_Packages),
  77. Reverse Depends:
  78. libreadlineg2,libreadline2
  79. libreadline2-altdev,libreadline2
  80. Dependencies:
  81. 2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))
  82. Provides:
  83. 2.1-12 -
  84. Reverse Provides:
  85. </programlisting></informalexample>
  86. <para>Thus it may be seen that libreadline2, version 2.1-12, depends on
  87. libc5 and ncurses3.0 which must be installed for libreadline2 to work.
  88. In turn, libreadlineg2 and libreadline2-altdev depend on libreadline2. If
  89. libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be
  90. installed; libreadlineg2 and libreadline2-altdev do not have to be
  91. installed. For the specific meaning of the remainder of the output it
  92. is best to consult the apt source code.</para></listitem>
  93. </varlistentry>
  94. <varlistentry><term>stats</term><listitem><para><literal>stats</literal> displays some statistics about the cache.
  95. No further arguments are expected. Statistics reported are:
  96. <itemizedlist>
  97. <listitem><para><literal>Total package names</literal> is the number of package names found
  98. in the cache.</para>
  99. </listitem>
  100. <listitem><para><literal>Normal packages</literal> is the number of regular, ordinary package
  101. names; these are packages that bear a one-to-one correspondence between
  102. their names and the names used by other packages for them in
  103. dependencies. The majority of packages fall into this category.</para>
  104. </listitem>
  105. <listitem><para><literal>Pure virtual packages</literal> is the number of packages that exist
  106. only as a virtual package name; that is, packages only "provide" the
  107. virtual package name, and no package actually uses the name. For
  108. instance, "mail-transport-agent" in the Debian GNU/Linux system is a
  109. pure virtual package; several packages provide "mail-transport-agent",
  110. but there is no package named "mail-transport-agent".</para>
  111. </listitem>
  112. <listitem><para><literal>Single virtual packages</literal> is the number of packages with only
  113. one package providing a particular virtual package. For example, in the
  114. Debian GNU/Linux system, "X11-text-viewer" is a virtual package, but
  115. only one package, xless, provides "X11-text-viewer".</para>
  116. </listitem>
  117. <listitem><para><literal>Mixed virtual packages</literal> is the number of packages that either
  118. provide a particular virtual package or have the virtual package name
  119. as the package name. For instance, in the Debian GNU/Linux system,
  120. "debconf" is both an actual package, and provided by the debconf-tiny
  121. package.</para>
  122. </listitem>
  123. <listitem><para><literal>Missing</literal> is the number of package names that were referenced in
  124. a dependency but were not provided by any package. Missing packages may
  125. be in evidence if a full distribution is not accessed, or if a package
  126. (real or virtual) has been dropped from the distribution. Usually they
  127. are referenced from Conflicts statements.</para>
  128. </listitem>
  129. <listitem><para><literal>Total distinct</literal> versions is the number of package versions
  130. found in the cache; this value is therefore at least equal to the
  131. number of total package names. If more than one distribution (both
  132. "stable" and "unstable", for instance), is being accessed, this value
  133. can be considerably larger than the number of total package names.</para>
  134. </listitem>
  135. <listitem><para><literal>Total dependencies</literal> is the number of dependency relationships
  136. claimed by all of the packages in the cache.</para>
  137. </listitem>
  138. </itemizedlist>
  139. </para></listitem>
  140. </varlistentry>
  141. <varlistentry><term>showsrc <replaceable>pkg(s)</replaceable></term>
  142. <listitem><para><literal>showsrc</literal> displays all the source package records that match
  143. the given package names. All versions are shown, as well as all
  144. records that declare the name to be a Binary.</para></listitem>
  145. </varlistentry>
  146. <varlistentry><term>dump</term>
  147. <listitem><para><literal>dump</literal> shows a short listing of every package in the cache. It is
  148. primarily for debugging.</para></listitem>
  149. </varlistentry>
  150. <varlistentry><term>dumpavail</term>
  151. <listitem><para><literal>dumpavail</literal> prints out an available list to stdout. This is
  152. suitable for use with &dpkg; and is used by the &dselect; method.</para></listitem>
  153. </varlistentry>
  154. <varlistentry><term>unmet</term>
  155. <listitem><para><literal>unmet</literal> displays a summary of all unmet dependencies in the
  156. package cache.</para></listitem>
  157. </varlistentry>
  158. <varlistentry><term>show <replaceable>pkg(s)</replaceable></term>
  159. <listitem><para><literal>show</literal> performs a function similar to
  160. <command>dpkg --print-avail</command>i; it displays the package records for the
  161. named packages.</para></listitem>
  162. </varlistentry>
  163. <varlistentry><term>search <replaceable>regex [ regex ... ]</replaceable></term>
  164. <listitem><para><literal>search</literal> performs a full text search on all available package
  165. lists for the regex pattern given. It searches the package names and the
  166. descriptions for an occurrence of the regular expression and prints out
  167. the package name and the short description. If <option>--full</option> is given
  168. then output identical to <literal>show</literal> is produced for each matched
  169. package, and if <option>--names-only</option> is given then the long description
  170. is not searched, only the package name is.</para>
  171. <para>
  172. Separate arguments can be used to specify multiple search patterns that
  173. are and'ed together.</para></listitem>
  174. </varlistentry>
  175. <varlistentry><term>depends <replaceable>pkg(s)</replaceable></term>
  176. <listitem><para><literal>depends</literal> shows a listing of each dependency a package has
  177. and all the possible other packages that can fulfill that dependency.</para></listitem>
  178. </varlistentry>
  179. <varlistentry><term>rdepends <replaceable>pkg(s)</replaceable></term>
  180. <listitem><para><literal>rdepends</literal>shows a listing of each reverse dependency a
  181. package has.</para></listitem>
  182. </varlistentry>
  183. <varlistentry><term>pkgnames <replaceable>[ prefix ]</replaceable></term>
  184. <listitem><para>This command prints the name of each package in the system. The optional
  185. argument is a prefix match to filter the name list. The output is suitable
  186. for use in a shell tab complete function and the output is generated
  187. extremely quickly. This command is best used with the
  188. <option>--generate</option> option.</para></listitem>
  189. </varlistentry>
  190. <varlistentry><term>dotty <replaceable>pkg(s)</replaceable></term>
  191. <listitem><para><literal>dotty</literal> takes a list of packages on the command line and
  192. generates output suitable for use by dotty from the
  193. <ulink url="">GraphViz</ulink>
  194. package. The result will be a set of nodes and edges representing the
  195. relationships between the packages. By default the given packages will
  196. trace out all dependent packages; this can produce a very large graph.
  197. To limit the output to only the packages listed on the command line,
  198. set the <literal>APT::Cache::GivenOnly</literal> option.</para>
  199. <para>The resulting nodes will have several shapes; normal packages are boxes,
  200. pure provides are triangles, mixed provides are diamonds,
  201. missing packages are hexagons. Orange boxes mean recursion was stopped
  202. [leaf packages], blue lines are pre-depends, green lines are conflicts.</para>
  203. <para>Caution, dotty cannot graph larger sets of packages.</para></listitem>
  204. </varlistentry>
  205. <varlistentry><term>policy <replaceable>[ pkg(s) ]</replaceable></term>
  206. <listitem><para><literal>policy</literal> is ment to help debug issues relating to the
  207. preferences file. With no arguments it will print out the
  208. priorities of each source. Otherwise it prints out detailed information
  209. about the priority selection of the named package.</para></listitem>
  210. </varlistentry>
  211. <varlistentry><term>madison <replaceable>/[ pkg(s) ]</replaceable></term>
  212. <listitem><para><literal>apt-cache</literal>'s <literal>madison</literal> command attempts to mimic
  213. the output format and a subset of the functionality of the Debian
  214. archive management tool, <literal>madison</literal>. It displays
  215. available versions of a package in a tabular format. Unlike the
  216. original <literal>madison</literal>, it can only display information for
  217. the architecture for which APT has retrieved package lists
  218. (<literal>APT::Architecture</literal>).</para></listitem>
  219. </varlistentry>
  220. </variablelist>
  221. </refsect1>
  222. <refsect1><title>options</title>
  223. &apt-cmdblurb;
  224. <variablelist>
  225. <varlistentry><term><option>-p</option></term><term><option>--pkg-cache</option></term>
  226. <listitem><para>Select the file to store the package cache. The package cache is the
  227. primary cache used by all operations.
  228. Configuration Item: <literal>Dir::Cache::pkgcache</literal>.</para></listitem>
  229. </varlistentry>
  230. <varlistentry><term><option>-s</option></term><term><option>--src-cache</option></term>
  231. <listitem><para>Select the file to store the source cache. The source is used only by
  232. <literal>gencaches</literal> and it stores a parsed version of the package
  233. information from remote sources. When building the package cache the
  234. source cache is used to advoid reparsing all of the package files.
  235. Configuration Item: <literal>Dir::Cache::srcpkgcache</literal>.</para></listitem>
  236. </varlistentry>
  237. <varlistentry><term><option>-q</option></term><term><option>--quiet</option></term>
  238. <listitem><para>Quiet; produces output suitable for logging, omitting progress indicators.
  239. More q's will produce more quietness up to a maximum of 2. You can also use
  240. <option>-q=#</option> to set the quietness level, overriding the configuration file.
  241. Configuration Item: <literal>quiet</literal>.</para></listitem>
  242. </varlistentry>
  243. <varlistentry><term><option>-i</option></term><term><option>--important</option></term>
  244. <listitem><para>Print only important dependencies; for use with unmet. Causes only Depends and
  245. Pre-Depends relations to be printed.
  246. Configuration Item: <literal>APT::Cache::Important</literal>.</para></listitem>
  247. </varlistentry>
  248. <varlistentry><term><option>-f</option></term><term><option>--full</option></term>
  249. <listitem><para>Print full package records when searching.
  250. Configuration Item: <literal>APT::Cache::ShowFull</literal>.</para></listitem>
  251. </varlistentry>
  252. <varlistentry><term><option>-a</option></term><term><option>--all-versions</option></term>
  253. <listitem><para>Print full records for all available versions. This is the
  254. default; to turn it off, use <option>--no-all-versions</option>.
  255. If <option>--no-all-versions</option> is specified, only the candidate version
  256. will displayed (the one which would be selected for installation).
  257. This option is only applicable to the <literal>show</literal> command.
  258. Configuration Item: <literal>APT::Cache::AllVersions</literal>.</para></listitem>
  259. </varlistentry>
  260. <varlistentry><term><option>-g</option></term><term><option>--generate</option></term>
  261. <listitem><para>Perform automatic package cache regeneration, rather than use the cache
  262. as it is. This is the default; to turn it off, use <option>--no-generate</option>.
  263. Configuration Item: <literal>APT::Cache::Generate</literal>.</para></listitem>
  264. </varlistentry>
  265. <varlistentry><term><option>--names-only</option></term><term><option>-n</option></term>
  266. <listitem><para>Only search on the package names, not the long descriptions.
  267. Configuration Item: <literal>APT::Cache::NamesOnly</literal>.</para></listitem>
  268. </varlistentry>
  269. <varlistentry><term><option>--all-names</option></term>
  270. <listitem><para>Make <literal>pkgnames</literal> print all names, including virtual packages
  271. and missing dependencies.
  272. Configuration Item: <literal>APT::Cache::AllNames</literal>.</para></listitem>
  273. </varlistentry>
  274. <varlistentry><term><option>--recurse</option></term>
  275. <listitem><para>Make <literal>depends</literal> and <literal>rdepends</literal> recursive so
  276. that all packages mentioned are printed once.
  277. Configuration Item: <literal>APT::Cache::RecurseDepends</literal>.</para></listitem>
  278. </varlistentry>
  279. <varlistentry><term><option>--installed</option></term>
  280. <listitem><para>
  281. Limit the output of <literal>depends</literal> and <literal>rdepends</literal> to
  282. packages which are currently installed.
  283. Configuration Item: <literal>APT::Cache::Installed</literal>.</para></listitem>
  284. </varlistentry>
  285. &apt-commonoptions;
  286. </variablelist>
  287. </refsect1>
  288. <refsect1><title>Files</title>
  289. <variablelist>
  290. <varlistentry><term><filename>/etc/apt/sources.list</filename></term>
  291. <listitem><para>Locations to fetch packages from.
  292. Configuration Item: <literal>Dir::Etc::SourceList</literal>.</para></listitem>
  293. </varlistentry>
  294. <varlistentry><term><filename>&statedir;/lists/</filename></term>
  295. <listitem><para>Storage area for state information for each package resource specified in
  296. &sources-list;
  297. Configuration Item: <literal>Dir::State::Lists</literal>.</para></listitem>
  298. </varlistentry>
  299. <varlistentry><term><filename>&statedir;/lists/partial/</filename></term>
  300. <listitem><para>Storage area for state information in transit.
  301. Configuration Item: <literal>Dir::State::Lists</literal> (implicit partial).</para></listitem>
  302. </varlistentry>
  303. </variablelist>
  304. </refsect1>
  305. <refsect1><title>See Also</title>
  306. <para>&apt-conf;, &sources-list;, &apt-get;
  307. </para>
  308. </refsect1>
  309. <refsect1><title>Diagnostics</title>
  310. <para><command>apt-cache</command> returns zero on normal operation, decimal 100 on error.
  311. </para>
  312. </refsect1>
  313. &manbugs;
  314. &manauthor;
  315. </refentry>