1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the apt-doc package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: apt-doc 0.9.7.9~exp2\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2013-04-03 14:20+0300\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
24 "<!ENTITY apt-author.team \"\n"
26 " <othername>APT team</othername>\n"
27 " <contrib></contrib>\n"
36 "<!ENTITY apt-qapage \"\n"
38 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
47 "<!-- Boiler plate Bug reporting section -->\n"
48 "<!ENTITY manbugs \"\n"
49 " <refsect1><title>Bugs</title>\n"
50 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
51 " If you wish to report a bug in APT, please see\n"
52 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
53 " &reportbug; command.\n"
63 "<!-- Boiler plate Author section -->\n"
64 "<!ENTITY manauthor \"\n"
65 " <refsect1><title>Author</title>\n"
66 " <para>APT was written by the APT team "
67 "<email>apt@packages.debian.org</email>.\n"
77 "<!-- Should be used within the option section of the text to\n"
78 " put in the blurb about -h, -v, -c and -o -->\n"
79 "<!ENTITY apt-commonoptions \"\n"
80 " <varlistentry><term><option>-h</option></term>\n"
81 " <term><option>--help</option></term>\n"
82 " <listitem><para>Show a short usage summary.\n"
93 " <term><option>-v</option></term>\n"
94 " <term><option>--version</option></term>\n"
95 " <listitem><para>Show the program version.\n"
106 " <term><option>-c</option></term>\n"
107 " <term><option>--config-file</option></term>\n"
108 " <listitem><para>Configuration File; Specify a configuration file to "
110 " The program will read the default configuration file and then this \n"
111 " configuration file. If configuration settings need to be set before "
113 " default configuration files are parsed specify a file with the "
114 "<envar>APT_CONFIG</envar>\n"
115 " environment variable. See &apt-conf; for syntax information.\n"
126 " <term><option>-o</option></term>\n"
127 " <term><option>--option</option></term>\n"
128 " <listitem><para>Set a Configuration Option; This will set an "
130 " configuration option. The syntax is <option>-o "
131 "Foo::Bar=bar</option>.\n"
132 " <option>-o</option> and <option>--option</option> can be used "
134 " times to set different options.\n"
145 "<!-- Should be used within the option section of the text to\n"
146 " put in the blurb about -h, -v, -c and -o -->\n"
147 "<!ENTITY apt-cmdblurb \"\n"
148 " <para>All command line options may be set using the configuration file, "
150 " descriptions indicate the configuration option to set. For boolean\n"
151 " options you can override the config file by using something like \n"
152 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
153 " or several other variations.\n"
162 "<!ENTITY file-aptconf \"\n"
163 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
164 " <listitem><para>APT configuration file.\n"
165 " Configuration Item: "
166 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
174 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
175 " <listitem><para>APT configuration file fragments.\n"
176 " Configuration Item: "
177 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
186 "<!ENTITY file-cachearchives \"\n"
187 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
188 " <listitem><para>Storage area for retrieved package files.\n"
189 " Configuration Item: "
190 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
199 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
200 " <listitem><para>Storage area for package files in transit.\n"
201 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
202 "(<filename>partial</filename> will be implicitly "
203 "appended)</para></listitem>\n"
212 "<!ENTITY file-preferences \"\n"
213 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
214 " <listitem><para>Version preferences file.\n"
215 " This is where you would specify "pinning",\n"
216 " i.e. a preference to get certain packages\n"
217 " from a separate source\n"
218 " or from a different version of a distribution.\n"
219 " Configuration Item: "
220 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
229 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
230 " <listitem><para>File fragments for the version preferences.\n"
231 " Configuration Item: "
232 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
241 "<!ENTITY file-sourceslist \"\n"
242 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
243 " <listitem><para>Locations to fetch packages from.\n"
244 " Configuration Item: "
245 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
254 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
255 " <listitem><para>File fragments for locations to fetch packages from.\n"
256 " Configuration Item: "
257 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
266 "<!ENTITY file-statelists \"\n"
267 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
268 " <listitem><para>Storage area for state information for each package "
269 "resource specified in\n"
271 " Configuration Item: "
272 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
281 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
282 " <listitem><para>Storage area for state information in transit.\n"
283 " Configuration Item: <literal>Dir::State::Lists</literal> "
284 "(<filename>partial</filename> will be implicitly "
285 "appended)</para></listitem>\n"
294 "<!ENTITY file-trustedgpg \"\n"
295 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
296 " <listitem><para>Keyring of local trusted keys, new keys will be added "
298 " Configuration Item: "
299 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
308 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
309 " <listitem><para>File fragments for the trusted keys, additional "
311 " be stored here (by other packages or the administrator).\n"
312 " Configuration Item "
313 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
322 "<!ENTITY file-extended_states \"\n"
324 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
325 " <listitem><para>Status list of auto-installed packages.\n"
326 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
327 " </para></listitem>\n"
336 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
338 " to the other headers like NAME and DESCRIPTION and should therefore be "
340 "<!ENTITY translation-title \"TRANSLATION\">\n"
347 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
349 " to the translation in the past, who is responsible now and maybe "
350 "further information\n"
351 " specially related to your translation. -->\n"
352 "<!ENTITY translation-holder \"\n"
353 " The english translation was done by John Doe "
354 "<email>john@doe.org</email> in 2009,\n"
355 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
357 " Debian Dummy l10n Team "
358 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
366 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
367 "untranslated/fuzzy strings\n"
368 " in a shipped manpage newer/modified paragraphs will maybe appear in "
370 " the generated manpage. This sentence is therefore here to tell the "
372 " is not a mistake by the translator - obviously the target is that at "
374 " releases this sentence is not needed. :) -->\n"
375 "<!ENTITY translation-english \"\n"
376 " Note that this translated document may contain untranslated parts.\n"
377 " This is done on purpose, to avoid losing content when the\n"
378 " translation is lagging behind the original content.\n"
385 "<!-- TRANSLATOR: used as in -o=config_string "
386 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
393 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
394 "synopsis-config-file \"config_file\">"
400 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
401 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
402 "\"target_release\">"
408 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
409 "synopsis-architecture \"architecture\">"
415 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
416 "--> <!ENTITY synopsis-pkg \"pkg\">"
422 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
423 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
429 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
430 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
436 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
437 "awesome --> <!ENTITY synopsis-regex \"regex\">"
443 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
444 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
450 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
451 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
452 "\"temporary_directory\">"
458 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
459 "synopsis-filename \"filename\">"
465 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
466 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
472 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
473 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
480 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
481 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
488 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
489 "generate section --> <!ENTITY synopsis-section \"section\">"
495 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
496 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
499 #. type: Content of: <refentry><refmeta><manvolnum>
500 #: apt-get.8.xml:26 apt-cache.8.xml:26 apt-key.8.xml:25 apt-mark.8.xml:26 apt-secure.8.xml:25 apt-cdrom.8.xml:25 apt-config.8.xml:26
504 #. type: Content of: <refentry><refmeta><refmiscinfo>
505 #: apt-get.8.xml:27 apt-cache.8.xml:27 apt-key.8.xml:26 apt-mark.8.xml:27 apt-secure.8.xml:26 apt-cdrom.8.xml:26 apt-config.8.xml:27 apt.conf.5.xml:32 apt_preferences.5.xml:26 sources.list.5.xml:27 apt-extracttemplates.1.xml:27 apt-sortpkgs.1.xml:27 apt-ftparchive.1.xml:27
509 #. type: Content of: <refentry><refnamediv><refpurpose>
511 msgid "APT package handling utility -- command-line interface"
514 #. type: Content of: <refentry><refsect1><title>
515 #: apt-get.8.xml:38 apt-cache.8.xml:38 apt-key.8.xml:37 apt-mark.8.xml:38 apt-secure.8.xml:50 apt-cdrom.8.xml:37 apt-config.8.xml:38 apt.conf.5.xml:41 apt_preferences.5.xml:36 sources.list.5.xml:36 apt-extracttemplates.1.xml:38 apt-sortpkgs.1.xml:38 apt-ftparchive.1.xml:38
519 #. type: Content of: <refentry><refsect1><para>
522 "<command>apt-get</command> is the command-line tool for handling packages, "
523 "and may be considered the user's \"back-end\" to other tools using the APT "
524 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
525 "&aptitude;, &synaptic; and &wajig;."
528 #. type: Content of: <refentry><refsect1><para>
529 #: apt-get.8.xml:44 apt-cache.8.xml:44 apt-cdrom.8.xml:51 apt-config.8.xml:44 apt-ftparchive.1.xml:54
531 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
532 "one of the commands below must be present."
535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
538 "<literal>update</literal> is used to resynchronize the package index files "
539 "from their sources. The indexes of available packages are fetched from the "
540 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
541 "example, when using a Debian archive, this command retrieves and scans the "
542 "<filename>Packages.gz</filename> files, so that information about new and "
543 "updated packages is available. An <literal>update</literal> should always be "
544 "performed before an <literal>upgrade</literal> or "
545 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
546 "meter will be incorrect as the size of the package files cannot be known in "
550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
553 "<literal>upgrade</literal> is used to install the newest versions of all "
554 "packages currently installed on the system from the sources enumerated in "
555 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
556 "with new versions available are retrieved and upgraded; under no "
557 "circumstances are currently installed packages removed, or packages not "
558 "already installed retrieved and installed. New versions of currently "
559 "installed packages that cannot be upgraded without changing the install "
560 "status of another package will be left at their current version. An "
561 "<literal>update</literal> must be performed first so that "
562 "<command>apt-get</command> knows that new versions of packages are "
566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
569 "<literal>dist-upgrade</literal> in addition to performing the function of "
570 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
571 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
572 "conflict resolution system, and it will attempt to upgrade the most "
573 "important packages at the expense of less important ones if necessary. The "
574 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
575 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
576 "locations from which to retrieve desired package files. See also "
577 "&apt-preferences; for a mechanism for overriding the general settings for "
578 "individual packages."
581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
584 "<literal>dselect-upgrade</literal> is used in conjunction with the "
585 "traditional Debian packaging front-end, "
586 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
587 "&dselect; to the <literal>Status</literal> field of available packages, and "
588 "performs the actions necessary to realize that state (for instance, the "
589 "removal of old and the installation of new packages)."
592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
595 "<literal>install</literal> is followed by one or more packages desired for "
596 "installation or upgrading. Each package is a package name, not a fully "
597 "qualified filename (for instance, in a Debian system, "
598 "<package>apt-utils</package> would be the argument provided, not "
599 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
600 "packages required by the package(s) specified for installation will also be "
601 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
602 "file is used to locate the desired packages. If a hyphen is appended to the "
603 "package name (with no intervening space), the identified package will be "
604 "removed if it is installed. Similarly a plus sign can be used to designate "
605 "a package to install. These latter features may be used to override "
606 "decisions made by apt-get's conflict resolution system."
609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
612 "A specific version of a package can be selected for installation by "
613 "following the package name with an equals and the version of the package to "
614 "select. This will cause that version to be located and selected for "
615 "install. Alternatively a specific distribution can be selected by following "
616 "the package name with a slash and the version of the distribution or the "
617 "Archive name (stable, testing, unstable)."
620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
623 "Both of the version selection mechanisms can downgrade packages and must be "
627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
630 "This is also the target to use if you want to upgrade one or more "
631 "already-installed packages without upgrading every package you have on your "
632 "system. Unlike the \"upgrade\" target, which installs the newest version of "
633 "all currently installed packages, \"install\" will install the newest "
634 "version of only the package(s) specified. Simply provide the name of the "
635 "package(s) you wish to upgrade, and if a newer version is available, it (and "
636 "its dependencies, as described above) will be downloaded and installed."
639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
642 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
643 "installation policy for individual packages."
646 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
649 "If no package matches the given expression and the expression contains one "
650 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
651 "it is applied to all package names in the database. Any matches are then "
652 "installed (or removed). Note that matching is done by substring so 'lo.*' "
653 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
654 "expression with a '^' or '$' character, or create a more specific regular "
658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
661 "<literal>remove</literal> is identical to <literal>install</literal> except "
662 "that packages are removed instead of installed. Note that removing a package "
663 "leaves its configuration files on the system. If a plus sign is appended to "
664 "the package name (with no intervening space), the identified package will be "
665 "installed instead of removed."
668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
671 "<literal>purge</literal> is identical to <literal>remove</literal> except "
672 "that packages are removed and purged (any configuration files are deleted "
676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
679 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
680 "packages. APT will examine the available packages to decide which source "
681 "package to fetch. It will then find and download into the current directory "
682 "the newest available version of that source package while respecting the "
683 "default release, set with the option "
684 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
685 "per package with the <literal>pkg/release</literal> syntax, if possible."
688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
691 "Source packages are tracked separately from binary packages via "
692 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
693 "you will need to add such a line for each repository you want to get sources "
694 "from; otherwise you will probably get either the wrong (too old/too new) "
695 "source versions or none at all."
698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
701 "If the <option>--compile</option> option is specified then the package will "
702 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
703 "the architecture as defined by the <command>--host-architecture</command> "
704 "option. If <option>--download-only</option> is specified then the source "
705 "package will not be unpacked."
708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
711 "A specific source version can be retrieved by postfixing the source name "
712 "with an equals and then the version to fetch, similar to the mechanism used "
713 "for the package files. This enables exact matching of the source package "
714 "name and version, implicitly enabling the "
715 "<literal>APT::Get::Only-Source</literal> option."
718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
721 "Note that source packages are not installed and tracked in the "
722 "<command>dpkg</command> database like binary packages; they are simply "
723 "downloaded to the current directory, like source tarballs."
726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
729 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
730 "attempt to satisfy the build dependencies for a source package. By default "
731 "the dependencies are satisfied to build the package natively. If desired a "
732 "host-architecture can be specified with the "
733 "<option>--host-architecture</option> option instead."
736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
739 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
740 "and checks for broken dependencies."
743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
746 "<literal>download</literal> will download the given binary package into the "
750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
753 "<literal>clean</literal> clears out the local repository of retrieved "
754 "package files. It removes everything but the lock file from "
755 "<filename>&cachedir;/archives/</filename> and "
756 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
757 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
758 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
759 "from time to time to free up disk space."
762 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
765 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
766 "local repository of retrieved package files. The difference is that it only "
767 "removes package files that can no longer be downloaded, and are largely "
768 "useless. This allows a cache to be maintained over a long period without it "
769 "growing out of control. The configuration option "
770 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
771 "being erased if it is set to off."
774 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
777 "<literal>autoremove</literal> is used to remove packages that were "
778 "automatically installed to satisfy dependencies for other packages and are "
779 "now no longer needed."
782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
785 "<literal>changelog</literal> downloads a package changelog and displays it "
786 "through <command>sensible-pager</command>. The server name and base "
787 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
788 "variable (e.g. <ulink "
789 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
790 "for Debian or <ulink "
791 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
792 "for Ubuntu). By default it displays the changelog for the version that is "
793 "installed. However, you can specify the same options as for the "
794 "<option>install</option> command."
797 #. type: Content of: <refentry><refsect1><title>
798 #: apt-get.8.xml:258 apt-cache.8.xml:248 apt-mark.8.xml:108 apt-config.8.xml:84 apt-extracttemplates.1.xml:52 apt-sortpkgs.1.xml:48 apt-ftparchive.1.xml:504
802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
805 "Do not consider recommended packages as a dependency for installing. "
806 "Configuration Item: <literal>APT::Install-Recommends</literal>."
809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
812 "Consider suggested packages as a dependency for installing. Configuration "
813 "Item: <literal>APT::Install-Suggests</literal>."
816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
819 "Download only; package files are only retrieved, not unpacked or installed. "
820 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
823 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
826 "Fix; attempt to correct a system with broken dependencies in place. This "
827 "option, when used with install/remove, can omit any packages to permit APT "
828 "to deduce a likely solution. If packages are specified, these have to "
829 "completely correct the problem. The option is sometimes necessary when "
830 "running APT for the first time; APT itself does not allow broken package "
831 "dependencies to exist on a system. It is possible that a system's dependency "
832 "structure can be so corrupt as to require manual intervention (which usually "
833 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
834 "of the offending packages). Use of this option together with "
835 "<option>-m</option> may produce an error in some situations. Configuration "
836 "Item: <literal>APT::Get::Fix-Broken</literal>."
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
842 "Ignore missing packages; if packages cannot be retrieved or fail the "
843 "integrity check after retrieval (corrupted package files), hold back those "
844 "packages and handle the result. Use of this option together with "
845 "<option>-f</option> may produce an error in some situations. If a package is "
846 "selected for installation (particularly if it is mentioned on the command "
847 "line) and it could not be downloaded then it will be silently held back. "
848 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
854 "Disables downloading of packages. This is best used with "
855 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
856 "already downloaded. Configuration Item: "
857 "<literal>APT::Get::Download</literal>."
860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
863 "Quiet; produces output suitable for logging, omitting progress indicators. "
864 "More q's will produce more quiet up to a maximum of 2. You can also use "
865 "<option>-q=#</option> to set the quiet level, overriding the configuration "
866 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
867 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
868 "may decide to do something you did not expect. Configuration Item: "
869 "<literal>quiet</literal>."
872 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
875 "No action; perform a simulation of events that would occur but do not "
876 "actually change the system. Configuration Item: "
877 "<literal>APT::Get::Simulate</literal>."
880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
883 "Simulated runs performed as a user will automatically deactivate locking "
884 "(<literal>Debug::NoLocking</literal>), and if the option "
885 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (as it is by "
886 "default) a notice will also be displayed indicating that this is only a "
887 "simulation. Runs performed as root do not trigger either NoLocking or the "
888 "notice - superusers should know what they are doing without further warnings "
889 "from <literal>apt-get</literal>."
892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
895 "Simulated runs print out a series of lines, each representing a "
896 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
897 "remove (<literal>Remv</literal>) or unpack "
898 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
899 "empty square brackets indicate breaks that are of no consequence (rare)."
902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
905 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
906 "non-interactively. If an undesirable situation, such as changing a held "
907 "package, trying to install a unauthenticated package or removing an "
908 "essential package occurs then <literal>apt-get</literal> will abort. "
909 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
915 "Automatic \"no\" to all prompts. Configuration Item: "
916 "<literal>APT::Get::Assume-No</literal>."
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
922 "Show upgraded packages; print out a list of all packages that are to be "
923 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
929 "Show full versions for upgraded and installed packages. Configuration Item: "
930 "<literal>APT::Get::Show-Versions</literal>."
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
936 "This option controls the architecture packages are built for by "
937 "<command>apt-get source --compile</command> and how cross-builddependencies "
938 "are satisfied. By default is it not set which means that the host "
939 "architecture is the same as the build architecture (which is defined by "
940 "<literal>APT::Architecture</literal>). Configuration Item: "
941 "<literal>APT::Get::Host-Architecture</literal>"
944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
947 "Compile source packages after downloading them. Configuration Item: "
948 "<literal>APT::Get::Compile</literal>."
951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
954 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
955 "hold placed on a package. This may be useful in conjunction with "
956 "<literal>dist-upgrade</literal> to override a large number of undesired "
957 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
963 "Do not upgrade packages; when used in conjunction with "
964 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
965 "packages on the command line from being upgraded if they are already "
966 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
972 "Do not install new packages; when used in conjunction with "
973 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
974 "upgrades for already installed packages only and ignore requests to install "
975 "new packages. Configuration Item: "
976 "<literal>APT::Get::Only-Upgrade</literal>."
979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
982 "Force yes; this is a dangerous option that will cause apt to continue "
983 "without prompting if it is doing something potentially harmful. It should "
984 "not be used except in very special situations. Using "
985 "<literal>force-yes</literal> can potentially destroy your system! "
986 "Configuration Item: <literal>APT::Get::force-yes</literal>."
989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
992 "Instead of fetching the files to install their URIs are printed. Each URI "
993 "will have the path, the destination file name, the size and the expected MD5 "
994 "hash. Note that the file name to write to will not always match the file "
995 "name on the remote site! This also works with the <literal>source</literal> "
996 "and <literal>update</literal> commands. When used with the "
997 "<literal>update</literal> command the MD5 and size are not included, and it "
998 "is up to the user to decompress any compressed files. Configuration Item: "
999 "<literal>APT::Get::Print-URIs</literal>."
1002 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1003 #: apt-get.8.xml:427
1005 "Use purge instead of remove for anything that would be removed. An asterisk "
1006 "(\"*\") will be displayed next to packages which are scheduled to be "
1007 "purged. <option>remove --purge</option> is equivalent to the "
1008 "<option>purge</option> command. Configuration Item: "
1009 "<literal>APT::Get::Purge</literal>."
1012 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1013 #: apt-get.8.xml:435
1015 "Re-install packages that are already installed and at the newest version. "
1016 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1019 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1020 #: apt-get.8.xml:440
1022 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1023 "turn it off. When it is on, <command>apt-get</command> will automatically "
1024 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1025 "obsolete files are erased. The only reason to turn it off is if you "
1026 "frequently change your sources list. Configuration Item: "
1027 "<literal>APT::Get::List-Cleanup</literal>."
1030 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1031 #: apt-get.8.xml:450
1033 "This option controls the default input to the policy engine; it creates a "
1034 "default pin at priority 990 using the specified release string. This "
1035 "overrides the general settings in "
1036 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1037 "not affected by the value of this option. In short, this option lets you "
1038 "have simple control over which distribution packages will be retrieved "
1039 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1040 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1041 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1046 #: apt-get.8.xml:465
1048 "Only perform operations that are 'trivial'. Logically this can be considered "
1049 "related to <option>--assume-yes</option>; where "
1050 "<option>--assume-yes</option> will answer yes to any prompt, "
1051 "<option>--trivial-only</option> will answer no. Configuration Item: "
1052 "<literal>APT::Get::Trivial-Only</literal>."
1055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1056 #: apt-get.8.xml:472
1058 "If any packages are to be removed apt-get immediately aborts without "
1059 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1062 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1063 #: apt-get.8.xml:478
1065 "If the command is either <literal>install</literal> or "
1066 "<literal>remove</literal>, then this option acts like running the "
1067 "<literal>autoremove</literal> command, removing unused dependency "
1068 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1072 #: apt-get.8.xml:485
1074 "Only has meaning for the <literal>source</literal> and "
1075 "<literal>build-dep</literal> commands. Indicates that the given source "
1076 "names are not to be mapped through the binary table. This means that if "
1077 "this option is specified, these commands will only accept source package "
1078 "names as arguments, rather than accepting binary package names and looking "
1079 "up the corresponding source package. Configuration Item: "
1080 "<literal>APT::Get::Only-Source</literal>."
1083 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1084 #: apt-get.8.xml:496
1086 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1087 "Item: <literal>APT::Get::Diff-Only</literal>, "
1088 "<literal>APT::Get::Dsc-Only</literal>, and "
1089 "<literal>APT::Get::Tar-Only</literal>."
1092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1093 #: apt-get.8.xml:502
1095 "Only process architecture-dependent build-dependencies. Configuration Item: "
1096 "<literal>APT::Get::Arch-Only</literal>."
1099 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1100 #: apt-get.8.xml:507
1102 "Ignore if packages can't be authenticated and don't prompt about it. This "
1103 "is useful for tools like pbuilder. Configuration Item: "
1104 "<literal>APT::Get::AllowUnauthenticated</literal>."
1107 #. type: Content of: <refentry><refsect1><title>
1108 #: apt-get.8.xml:518 apt-cache.8.xml:343 apt-key.8.xml:174 apt-mark.8.xml:125 apt.conf.5.xml:1168 apt_preferences.5.xml:698
1112 #. type: Content of: <refentry><refsect1><title>
1113 #: apt-get.8.xml:528 apt-cache.8.xml:350 apt-key.8.xml:195 apt-mark.8.xml:131 apt-secure.8.xml:191 apt-cdrom.8.xml:144 apt-config.8.xml:109 apt.conf.5.xml:1174 apt_preferences.5.xml:705 sources.list.5.xml:252 apt-extracttemplates.1.xml:70 apt-sortpkgs.1.xml:63 apt-ftparchive.1.xml:607
1117 #. type: Content of: <refentry><refsect1><para>
1118 #: apt-get.8.xml:529
1120 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
1121 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
1122 "&apt-preferences;, the APT Howto."
1125 #. type: Content of: <refentry><refsect1><title>
1126 #: apt-get.8.xml:534 apt-cache.8.xml:355 apt-mark.8.xml:135 apt-cdrom.8.xml:149 apt-config.8.xml:114 apt-extracttemplates.1.xml:74 apt-sortpkgs.1.xml:67 apt-ftparchive.1.xml:611
1130 #. type: Content of: <refentry><refsect1><para>
1131 #: apt-get.8.xml:535
1133 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1137 #. type: Content of: <refentry><refnamediv><refpurpose>
1138 #: apt-cache.8.xml:33
1139 msgid "query the APT cache"
1142 #. type: Content of: <refentry><refsect1><para>
1143 #: apt-cache.8.xml:39
1145 "<command>apt-cache</command> performs a variety of operations on APT's "
1146 "package cache. <command>apt-cache</command> does not manipulate the state of "
1147 "the system but does provide operations to search and generate interesting "
1148 "output from the package metadata."
1151 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1152 #: apt-cache.8.xml:49
1154 "<literal>gencaches</literal> creates APT's package cache. This is done "
1155 "implicitly by all commands needing this cache if it is missing or outdated."
1158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1159 #: apt-cache.8.xml:53 apt-cache.8.xml:142 apt-cache.8.xml:163 apt-cache.8.xml:185 apt-cache.8.xml:190 apt-cache.8.xml:206 apt-cache.8.xml:224 apt-cache.8.xml:236
1160 msgid "&synopsis-pkg;"
1163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1164 #: apt-cache.8.xml:54
1166 "<literal>showpkg</literal> displays information about the packages listed on "
1167 "the command line. Remaining arguments are package names. The available "
1168 "versions and reverse dependencies of each package listed are listed, as well "
1169 "as forward dependencies for each version. Forward (normal) dependencies are "
1170 "those packages upon which the package in question depends; reverse "
1171 "dependencies are those packages that depend upon the package in "
1172 "question. Thus, forward dependencies must be satisfied for a package, but "
1173 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1174 "libreadline2</command> would produce output similar to the following:"
1177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1178 #: apt-cache.8.xml:66
1181 "Package: libreadline2\n"
1182 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1183 "Reverse Depends: \n"
1184 " libreadlineg2,libreadline2\n"
1185 " libreadline2-altdev,libreadline2\n"
1187 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1190 "Reverse Provides: \n"
1193 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1194 #: apt-cache.8.xml:78
1196 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1197 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1198 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1199 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1200 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1201 "installed. For the specific meaning of the remainder of the output it is "
1202 "best to consult the apt source code."
1205 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1206 #: apt-cache.8.xml:87
1208 "<literal>stats</literal> displays some statistics about the cache. No "
1209 "further arguments are expected. Statistics reported are:"
1212 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1213 #: apt-cache.8.xml:90
1215 "<literal>Total package names</literal> is the number of package names found "
1219 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1220 #: apt-cache.8.xml:94
1222 "<literal>Normal packages</literal> is the number of regular, ordinary "
1223 "package names; these are packages that bear a one-to-one correspondence "
1224 "between their names and the names used by other packages for them in "
1225 "dependencies. The majority of packages fall into this category."
1228 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1229 #: apt-cache.8.xml:100
1231 "<literal>Pure virtual packages</literal> is the number of packages that "
1232 "exist only as a virtual package name; that is, packages only \"provide\" the "
1233 "virtual package name, and no package actually uses the name. For instance, "
1234 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1235 "several packages provide \"mail-transport-agent\", but there is no package "
1236 "named \"mail-transport-agent\"."
1239 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1240 #: apt-cache.8.xml:108
1242 "<literal>Single virtual packages</literal> is the number of packages with "
1243 "only one package providing a particular virtual package. For example, in the "
1244 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1245 "package, xless, provides \"X11-text-viewer\"."
1248 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1249 #: apt-cache.8.xml:114
1251 "<literal>Mixed virtual packages</literal> is the number of packages that "
1252 "either provide a particular virtual package or have the virtual package name "
1253 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1254 "an actual package, and provided by the debconf-tiny package."
1257 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1258 #: apt-cache.8.xml:121
1260 "<literal>Missing</literal> is the number of package names that were "
1261 "referenced in a dependency but were not provided by any package. Missing "
1262 "packages may be an evidence if a full distribution is not accessed, or if a "
1263 "package (real or virtual) has been dropped from the distribution. Usually "
1264 "they are referenced from Conflicts or Breaks statements."
1267 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1268 #: apt-cache.8.xml:128
1270 "<literal>Total distinct</literal> versions is the number of package versions "
1271 "found in the cache; this value is therefore at least equal to the number of "
1272 "total package names. If more than one distribution is being accessed (for "
1273 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1274 "larger than the number of total package names."
1277 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1278 #: apt-cache.8.xml:135
1280 "<literal>Total dependencies</literal> is the number of dependency "
1281 "relationships claimed by all of the packages in the cache."
1284 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1285 #: apt-cache.8.xml:143
1287 "<literal>showsrc</literal> displays all the source package records that "
1288 "match the given package names. All versions are shown, as well as all "
1289 "records that declare the name to be a binary package."
1292 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1293 #: apt-cache.8.xml:149
1295 "<literal>dump</literal> shows a short listing of every package in the "
1296 "cache. It is primarily for debugging."
1299 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1300 #: apt-cache.8.xml:154
1302 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1303 "suitable for use with &dpkg; and is used by the &dselect; method."
1306 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1307 #: apt-cache.8.xml:159
1309 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1313 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1314 #: apt-cache.8.xml:164
1316 "<literal>show</literal> performs a function similar to <command>dpkg "
1317 "--print-avail</command>; it displays the package records for the named "
1321 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1322 #: apt-cache.8.xml:169
1323 msgid "&synopsis-regex;"
1326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1327 #: apt-cache.8.xml:170
1329 "<literal>search</literal> performs a full text search on all available "
1330 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1331 "the package names and the descriptions for an occurrence of the regular "
1332 "expression and prints out the package name and the short description, "
1333 "including virtual package names. If <option>--full</option> is given then "
1334 "output identical to <literal>show</literal> is produced for each matched "
1335 "package, and if <option>--names-only</option> is given then the long "
1336 "description is not searched, only the package name is."
1339 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1340 #: apt-cache.8.xml:181
1342 "Separate arguments can be used to specify multiple search patterns that are "
1346 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1347 #: apt-cache.8.xml:186
1349 "<literal>depends</literal> shows a listing of each dependency a package has "
1350 "and all the possible other packages that can fulfill that dependency."
1353 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1354 #: apt-cache.8.xml:191
1356 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1360 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1361 #: apt-cache.8.xml:195
1362 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1365 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1366 #: apt-cache.8.xml:196
1368 "This command prints the name of each package APT knows. The optional "
1369 "argument is a prefix match to filter the name list. The output is suitable "
1370 "for use in a shell tab complete function and the output is generated "
1371 "extremely quickly. This command is best used with the "
1372 "<option>--generate</option> option."
1375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1376 #: apt-cache.8.xml:201
1378 "Note that a package which APT knows of is not necessarily available to "
1379 "download, installable or installed, e.g. virtual packages are also listed in "
1380 "the generated list."
1383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1384 #: apt-cache.8.xml:207
1386 "<literal>dotty</literal> takes a list of packages on the command line and "
1387 "generates output suitable for use by dotty from the <ulink "
1388 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1389 "package. The result will be a set of nodes and edges representing the "
1390 "relationships between the packages. By default the given packages will trace "
1391 "out all dependent packages; this can produce a very large graph. To limit "
1392 "the output to only the packages listed on the command line, set the "
1393 "<literal>APT::Cache::GivenOnly</literal> option."
1396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1397 #: apt-cache.8.xml:216
1399 "The resulting nodes will have several shapes; normal packages are boxes, "
1400 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1401 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1402 "packages), blue lines are pre-depends, green lines are conflicts."
1405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1406 #: apt-cache.8.xml:221
1407 msgid "Caution, dotty cannot graph larger sets of packages."
1410 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1411 #: apt-cache.8.xml:225
1413 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1414 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1419 #: apt-cache.8.xml:229
1420 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1424 #: apt-cache.8.xml:230
1426 "<literal>policy</literal> is meant to help debug issues relating to the "
1427 "preferences file. With no arguments it will print out the priorities of each "
1428 "source. Otherwise it prints out detailed information about the priority "
1429 "selection of the named package."
1432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1433 #: apt-cache.8.xml:237
1435 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1436 "to mimic the output format and a subset of the functionality of the Debian "
1437 "archive management tool, <literal>madison</literal>. It displays available "
1438 "versions of a package in a tabular format. Unlike the original "
1439 "<literal>madison</literal>, it can only display information for the "
1440 "architecture for which APT has retrieved package lists "
1441 "(<literal>APT::Architecture</literal>)."
1444 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1445 #: apt-cache.8.xml:253
1447 "Select the file to store the package cache. The package cache is the primary "
1448 "cache used by all operations. Configuration Item: "
1449 "<literal>Dir::Cache::pkgcache</literal>."
1452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1453 #: apt-cache.8.xml:259
1455 "Select the file to store the source cache. The source is used only by "
1456 "<literal>gencaches</literal> and it stores a parsed version of the package "
1457 "information from remote sources. When building the package cache the source "
1458 "cache is used to avoid reparsing all of the package files. Configuration "
1459 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1463 #: apt-cache.8.xml:267
1465 "Quiet; produces output suitable for logging, omitting progress indicators. "
1466 "More q's will produce more quietness up to a maximum of 2. You can also use "
1467 "<option>-q=#</option> to set the quietness level, overriding the "
1468 "configuration file. Configuration Item: <literal>quiet</literal>."
1471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1472 #: apt-cache.8.xml:274
1474 "Print only important dependencies; for use with <literal>unmet</literal> and "
1475 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1476 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1479 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1480 #: apt-cache.8.xml:288
1482 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1483 "print all dependencies. This can be tweaked with these flags which will omit "
1484 "the specified dependency type. Configuration Item: "
1485 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1486 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1490 #: apt-cache.8.xml:295
1492 "Print full package records when searching. Configuration Item: "
1493 "<literal>APT::Cache::ShowFull</literal>."
1496 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1497 #: apt-cache.8.xml:300
1499 "Print full records for all available versions. This is the default; to turn "
1500 "it off, use <option>--no-all-versions</option>. If "
1501 "<option>--no-all-versions</option> is specified, only the candidate version "
1502 "will be displayed (the one which would be selected for installation). This "
1503 "option is only applicable to the <literal>show</literal> command. "
1504 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1508 #: apt-cache.8.xml:309
1510 "Perform automatic package cache regeneration, rather than use the cache as "
1511 "it is. This is the default; to turn it off, use "
1512 "<option>--no-generate</option>. Configuration Item: "
1513 "<literal>APT::Cache::Generate</literal>."
1516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1517 #: apt-cache.8.xml:315
1519 "Only search on the package names, not the long descriptions. Configuration "
1520 "Item: <literal>APT::Cache::NamesOnly</literal>."
1523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1524 #: apt-cache.8.xml:320
1526 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1527 "and missing dependencies. Configuration Item: "
1528 "<literal>APT::Cache::AllNames</literal>."
1531 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1532 #: apt-cache.8.xml:326
1534 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1535 "that all packages mentioned are printed once. Configuration Item: "
1536 "<literal>APT::Cache::RecurseDepends</literal>."
1539 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1540 #: apt-cache.8.xml:333
1542 "Limit the output of <literal>depends</literal> and "
1543 "<literal>rdepends</literal> to packages which are currently installed. "
1544 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1547 #. type: Content of: <refentry><refsect1><para>
1548 #: apt-cache.8.xml:351
1549 msgid "&apt-conf;, &sources-list;, &apt-get;"
1552 #. type: Content of: <refentry><refsect1><para>
1553 #: apt-cache.8.xml:356
1555 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1559 #. type: Content of: <refentry><refnamediv><refpurpose>
1561 msgid "APT key management utility"
1564 #. type: Content of: <refentry><refsect1><para>
1567 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1568 "authenticate packages. Packages which have been authenticated using these "
1569 "keys will be considered trusted."
1572 #. type: Content of: <refentry><refsect1><title>
1577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1580 "Add a new key to the list of trusted keys. The key is read from the "
1581 "filename given with the parameter &synopsis-param-filename; or if the "
1582 "filename is <literal>-</literal> from standard input."
1585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1587 msgid "Remove a key from the list of trusted keys."
1590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1592 msgid "Output the key &synopsis-param-keyid; to standard output."
1595 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1597 msgid "Output all trusted keys to standard output."
1600 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1602 msgid "List trusted keys."
1605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1606 #: apt-key.8.xml:107
1607 msgid "List fingerprints of trusted keys."
1610 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1611 #: apt-key.8.xml:118
1613 "Pass advanced options to gpg. With adv --recv-key you can download the "
1617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1618 #: apt-key.8.xml:130
1620 "Update the local keyring with the archive keyring and remove from the local "
1621 "keyring the archive keys which are no longer valid. The archive keyring is "
1622 "shipped in the <literal>archive-keyring</literal> package of your "
1623 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
1627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1628 #: apt-key.8.xml:144
1630 "Perform an update working similarly to the <command>update</command> command "
1631 "above, but get the archive keyring from a URI instead and validate it "
1632 "against a master key. This requires an installed &wget; and an APT build "
1633 "configured to have a server to fetch from and a master keyring to validate. "
1634 "APT in Debian does not support this command, relying on "
1635 "<command>update</command> instead, but Ubuntu's APT does."
1638 #. type: Content of: <refentry><refsect1><title>
1639 #: apt-key.8.xml:160 apt-cdrom.8.xml:80
1643 #. type: Content of: <refentry><refsect1><para>
1644 #: apt-key.8.xml:161
1646 "Note that options need to be defined before the commands described in the "
1650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1651 #: apt-key.8.xml:164
1653 "With this option it is possible to specify a particular keyring file the "
1654 "command should operate on. The default is that a command is executed on the "
1655 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1656 "<filename>trusted.gpg.d</filename> directory, though "
1657 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1658 "e.g. new keys are added to this one."
1661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1662 #: apt-key.8.xml:179
1663 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1666 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1667 #: apt-key.8.xml:180
1668 msgid "Local trust database of archive keys."
1671 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1672 #: apt-key.8.xml:183
1673 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
1676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1677 #: apt-key.8.xml:184
1678 msgid "Keyring of Debian archive trusted keys."
1681 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1682 #: apt-key.8.xml:187
1683 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
1686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1687 #: apt-key.8.xml:188
1688 msgid "Keyring of Debian archive removed trusted keys."
1691 #. type: Content of: <refentry><refsect1><para>
1692 #: apt-key.8.xml:197
1693 msgid "&apt-get;, &apt-secure;"
1696 #. type: Content of: <refentry><refnamediv><refpurpose>
1697 #: apt-mark.8.xml:33
1698 msgid "mark/unmark a package as being automatically-installed"
1701 #. type: Content of: <refentry><refsect1><para>
1702 #: apt-mark.8.xml:39
1704 "<command>apt-mark</command> will change whether a package has been marked as "
1705 "being automatically installed."
1708 #. type: Content of: <refentry><refsect1><para>
1709 #: apt-mark.8.xml:43
1711 "When you request that a package is installed, and as a result other packages "
1712 "are installed to satisfy its dependencies, the dependencies are marked as "
1713 "being automatically installed. Once these automatically installed packages "
1714 "are no longer depended on by any manually installed packages, they will be "
1715 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1719 #: apt-mark.8.xml:52
1721 "<literal>auto</literal> is used to mark a package as being automatically "
1722 "installed, which will cause the package to be removed when no more manually "
1723 "installed packages depend on this package."
1726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1727 #: apt-mark.8.xml:60
1729 "<literal>manual</literal> is used to mark a package as being manually "
1730 "installed, which will prevent the package from being automatically removed "
1731 "if no other packages depend on it."
1734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1735 #: apt-mark.8.xml:68
1737 "<literal>hold</literal> is used to mark a package as held back, which will "
1738 "prevent the package from being automatically installed, upgraded or "
1739 "removed. The command is only a wrapper around <command>dpkg "
1740 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1741 "and not affected by the <option>--file</option> option."
1744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1745 #: apt-mark.8.xml:78
1747 "<literal>unhold</literal> is used to cancel a previously set hold on a "
1748 "package to allow all actions again."
1751 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1752 #: apt-mark.8.xml:84
1754 "<literal>showauto</literal> is used to print a list of automatically "
1755 "installed packages with each package on a new line. All automatically "
1756 "installed packages will be listed if no package is given. If packages are "
1757 "given only those which are automatically installed will be shown."
1760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1761 #: apt-mark.8.xml:92
1763 "<literal>showmanual</literal> can be used in the same way as "
1764 "<literal>showauto</literal> except that it will print a list of manually "
1765 "installed packages instead."
1768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1769 #: apt-mark.8.xml:99
1771 "<literal>showhold</literal> is used to print a list of packages on hold in "
1772 "the same way as for the other show commands."
1775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1776 #: apt-mark.8.xml:115
1778 "Read/Write package stats from the filename given with the parameter "
1779 "&synopsis-param-filename; instead of from the default location, which is "
1780 "<filename>extended_status</filename> in the directory defined by the "
1781 "Configuration Item: <literal>Dir::State</literal>."
1784 #. type: Content of: <refentry><refsect1><para>
1785 #: apt-mark.8.xml:136
1787 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
1791 #. type: Content of: <refentry><refnamediv><refpurpose>
1792 #: apt-secure.8.xml:47
1793 msgid "Archive authentication support for APT"
1796 #. type: Content of: <refentry><refsect1><para>
1797 #: apt-secure.8.xml:52
1799 "Starting with version 0.6, <command>apt</command> contains code that does "
1800 "signature checking of the Release file for all archives. This ensures that "
1801 "packages in the archive can't be modified by people who have no access to "
1802 "the Release file signing key."
1805 #. type: Content of: <refentry><refsect1><para>
1806 #: apt-secure.8.xml:60
1808 "If a package comes from a archive without a signature, or with a signature "
1809 "that apt does not have a key for, that package is considered untrusted, and "
1810 "installing it will result in a big warning. <command>apt-get</command> will "
1811 "currently only warn for unsigned archives; future releases might force all "
1812 "sources to be verified before downloading packages from them."
1815 #. type: Content of: <refentry><refsect1><para>
1816 #: apt-secure.8.xml:69
1818 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
1819 "authentication feature."
1822 #. type: Content of: <refentry><refsect1><title>
1823 #: apt-secure.8.xml:74
1824 msgid "Trusted archives"
1827 #. type: Content of: <refentry><refsect1><para>
1828 #: apt-secure.8.xml:77
1830 "The chain of trust from an apt archive to the end user is made up of several "
1831 "steps. <command>apt-secure</command> is the last step in this chain; "
1832 "trusting an archive does not mean that you trust its packages not to contain "
1833 "malicious code, but means that you trust the archive maintainer. It's the "
1834 "archive maintainer's responsibility to ensure that the archive's integrity "
1838 #. type: Content of: <refentry><refsect1><para>
1839 #: apt-secure.8.xml:85
1841 "apt-secure does not review signatures at a package level. If you require "
1842 "tools to do this you should look at <command>debsig-verify</command> and "
1843 "<command>debsign</command> (provided in the debsig-verify and devscripts "
1844 "packages respectively)."
1847 #. type: Content of: <refentry><refsect1><para>
1848 #: apt-secure.8.xml:92
1850 "The chain of trust in Debian starts when a maintainer uploads a new package "
1851 "or a new version of a package to the Debian archive. In order to become "
1852 "effective, this upload needs to be signed by a key contained in the Debian "
1853 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
1854 "keys are signed by other maintainers following pre-established procedures to "
1855 "ensure the identity of the key holder."
1858 #. type: Content of: <refentry><refsect1><para>
1859 #: apt-secure.8.xml:102
1861 "Once the uploaded package is verified and included in the archive, the "
1862 "maintainer signature is stripped off, and checksums of the package are "
1863 "computed and put in the Packages file. The checksums of all of the Packages "
1864 "files are then computed and put into the Release file. The Release file is "
1865 "then signed by the archive key for this Debian release, and distributed "
1866 "alongside the packages and the Packages files on Debian mirrors. The keys "
1867 "are in the Debian archive keyring available in the "
1868 "<package>debian-archive-keyring</package> package."
1871 #. type: Content of: <refentry><refsect1><para>
1872 #: apt-secure.8.xml:113
1874 "End users can check the signature of the Release file, extract a checksum of "
1875 "a package from it and compare it with the checksum of the package they "
1876 "downloaded by hand - or rely on APT doing this automatically."
1879 #. type: Content of: <refentry><refsect1><para>
1880 #: apt-secure.8.xml:118
1882 "Notice that this is distinct from checking signatures on a per package "
1883 "basis. It is designed to prevent two possible attacks:"
1886 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1887 #: apt-secure.8.xml:123
1889 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
1890 "checking, malicious agents can introduce themselves into the package "
1891 "download process and provide malicious software either by controlling a "
1892 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
1893 "server (through ARP or DNS spoofing attacks)."
1896 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1897 #: apt-secure.8.xml:131
1899 "<literal>Mirror network compromise</literal>. Without signature checking, a "
1900 "malicious agent can compromise a mirror host and modify the files in it to "
1901 "propagate malicious software to all users downloading packages from that "
1905 #. type: Content of: <refentry><refsect1><para>
1906 #: apt-secure.8.xml:138
1908 "However, it does not defend against a compromise of the Debian master server "
1909 "itself (which signs the packages) or against a compromise of the key used to "
1910 "sign the Release files. In any case, this mechanism can complement a "
1911 "per-package signature."
1914 #. type: Content of: <refentry><refsect1><title>
1915 #: apt-secure.8.xml:144
1916 msgid "User configuration"
1919 #. type: Content of: <refentry><refsect1><para>
1920 #: apt-secure.8.xml:146
1922 "<command>apt-key</command> is the program that manages the list of keys used "
1923 "by apt. It can be used to add or remove keys, although an installation of "
1924 "this release will automatically contain the default Debian archive signing "
1925 "keys used in the Debian package repositories."
1928 #. type: Content of: <refentry><refsect1><para>
1929 #: apt-secure.8.xml:153
1931 "In order to add a new key you need to first download it (you should make "
1932 "sure you are using a trusted communication channel when retrieving it), add "
1933 "it with <command>apt-key</command> and then run <command>apt-get "
1934 "update</command> so that apt can download and verify the "
1935 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
1936 "from the archives you have configured."
1939 #. type: Content of: <refentry><refsect1><title>
1940 #: apt-secure.8.xml:162
1941 msgid "Archive configuration"
1944 #. type: Content of: <refentry><refsect1><para>
1945 #: apt-secure.8.xml:164
1947 "If you want to provide archive signatures in an archive under your "
1948 "maintenance you have to:"
1951 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1952 #: apt-secure.8.xml:169
1954 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
1955 "already. You can do this by running <command>apt-ftparchive "
1956 "release</command> (provided in apt-utils)."
1959 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1960 #: apt-secure.8.xml:174
1962 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
1963 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
1964 "Release.gpg Release</command>."
1967 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1968 #: apt-secure.8.xml:178
1970 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
1971 "know what key they need to import in order to authenticate the files in the "
1975 #. type: Content of: <refentry><refsect1><para>
1976 #: apt-secure.8.xml:185
1978 "Whenever the contents of the archive change (new packages are added or "
1979 "removed) the archive maintainer has to follow the first two steps outlined "
1983 #. type: Content of: <refentry><refsect1><para>
1984 #: apt-secure.8.xml:193
1986 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
1987 "&debsign; &debsig-verify;, &gpg;"
1990 #. type: Content of: <refentry><refsect1><para>
1991 #: apt-secure.8.xml:197
1993 "For more background information you might want to review the <ulink "
1994 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
1995 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
1996 "(available also in the harden-doc package) and the <ulink "
1997 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
1998 "Distribution HOWTO</ulink> by V. Alex Brennen."
2001 #. type: Content of: <refentry><refsect1><title>
2002 #: apt-secure.8.xml:210
2003 msgid "Manpage Authors"
2006 #. type: Content of: <refentry><refsect1><para>
2007 #: apt-secure.8.xml:212
2009 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2010 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2013 #. type: Content of: <refentry><refnamediv><refpurpose>
2014 #: apt-cdrom.8.xml:32
2015 msgid "APT CD-ROM management utility"
2018 #. type: Content of: <refentry><refsect1><para>
2019 #: apt-cdrom.8.xml:38
2021 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2022 "available sources. <command>apt-cdrom</command> takes care of determining "
2023 "the structure of the disc as well as correcting for several possible "
2024 "mis-burns and verifying the index files."
2027 #. type: Content of: <refentry><refsect1><para>
2028 #: apt-cdrom.8.xml:45
2030 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2031 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2032 "must be inserted and scanned separately to account for possible mis-burns."
2035 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2036 #: apt-cdrom.8.xml:56
2038 "<literal>add</literal> is used to add a new disc to the source list. It will "
2039 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2040 "to scan it and copy the index files. If the disc does not have a proper "
2041 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2046 #: apt-cdrom.8.xml:64
2048 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2049 "maintains a database of these IDs in "
2050 "<filename>&statedir;/cdroms.list</filename>"
2053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2054 #: apt-cdrom.8.xml:72
2056 "A debugging tool to report the identity of the current disc as well as the "
2060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2061 #: apt-cdrom.8.xml:85
2063 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2064 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2065 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2068 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2069 #: apt-cdrom.8.xml:94
2071 "Rename a disc; change the label of a disc or override the disc's given "
2072 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2073 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2076 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2077 #: apt-cdrom.8.xml:103
2079 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2080 "unmounting the mount point. Configuration Item: "
2081 "<literal>APT::CDROM::NoMount</literal>."
2084 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2085 #: apt-cdrom.8.xml:111
2087 "Fast Copy; Assume the package files are valid and do not check every "
2088 "package. This option should be used only if <command>apt-cdrom</command> has "
2089 "been run on this disc before and did not detect any errors. Configuration "
2090 "Item: <literal>APT::CDROM::Fast</literal>."
2093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2094 #: apt-cdrom.8.xml:121
2096 "Thorough Package Scan; This option may be needed with some old Debian "
2097 "1.1/1.2 discs that have Package files in strange places. It takes much "
2098 "longer to scan the CD but will pick them all up."
2101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2102 #: apt-cdrom.8.xml:132
2104 "No Changes; Do not change the &sources-list; file and do not write index "
2105 "files. Everything is still checked however. Configuration Item: "
2106 "<literal>APT::CDROM::NoAct</literal>."
2109 #. type: Content of: <refentry><refsect1><para>
2110 #: apt-cdrom.8.xml:145
2111 msgid "&apt-conf;, &apt-get;, &sources-list;"
2114 #. type: Content of: <refentry><refsect1><para>
2115 #: apt-cdrom.8.xml:150
2117 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2121 #. type: Content of: <refentry><refnamediv><refpurpose>
2122 #: apt-config.8.xml:33
2123 msgid "APT Configuration Query program"
2126 #. type: Content of: <refentry><refsect1><para>
2127 #: apt-config.8.xml:39
2129 "<command>apt-config</command> is an internal program used by various "
2130 "portions of the APT suite to provide consistent configurability. It accesses "
2131 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2132 "manner that is easy to use for scripted applications."
2135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2136 #: apt-config.8.xml:51
2138 "shell is used to access the configuration information from a shell "
2139 "script. It is given pairs of arguments, the first being a shell variable and "
2140 "the second the configuration value to query. As output it lists shell "
2141 "assignment commands for each value present. In a shell script it should be "
2145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2146 #: apt-config.8.xml:59
2150 "RES=`apt-config shell OPTS MyApp::options`\n"
2154 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2155 #: apt-config.8.xml:64
2157 "This will set the shell environment variable $OPTS to the value of "
2158 "MyApp::options with a default of <option>-f</option>."
2161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2162 #: apt-config.8.xml:68
2164 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2165 "names, d returns directories, b returns true or false and i returns an "
2166 "integer. Each of the returns is normalized and verified internally."
2169 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2170 #: apt-config.8.xml:77
2171 msgid "Just show the contents of the configuration space."
2174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2175 #: apt-config.8.xml:90
2177 "Include options which have an empty value. This is the default, so use "
2178 "--no-empty to remove them from the output."
2181 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2182 #: apt-config.8.xml:95
2183 msgid "%f "%v";%n"
2186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2187 #: apt-config.8.xml:96
2189 "Defines the output of each config option. %t will be replaced with "
2190 "its individual name, %f with its full hierarchical name and %v "
2191 "with its value. Use uppercase letters and special characters in the value "
2192 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2193 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2194 "and %N by a tab. A % can be printed by using %%."
2197 #. type: Content of: <refentry><refsect1><para>
2198 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-sortpkgs.1.xml:64 apt-ftparchive.1.xml:608
2202 #. type: Content of: <refentry><refsect1><para>
2203 #: apt-config.8.xml:115
2205 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2209 #. type: Content of: <refentry><refentryinfo><author><contrib>
2210 #: apt.conf.5.xml:20
2211 msgid "Initial documentation of Debug::*."
2214 #. type: Content of: <refentry><refentryinfo><author><email>
2215 #: apt.conf.5.xml:21
2216 msgid "dburrows@debian.org"
2219 #. type: Content of: <refentry><refmeta><manvolnum>
2220 #: apt.conf.5.xml:31 apt_preferences.5.xml:25 sources.list.5.xml:26
2224 #. type: Content of: <refentry><refnamediv><refpurpose>
2225 #: apt.conf.5.xml:38
2226 msgid "Configuration file for APT"
2229 #. type: Content of: <refentry><refsect1><para>
2230 #: apt.conf.5.xml:42
2232 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2233 "by all the tools in the APT suite of tools, though it is by no means the "
2234 "only place options can be set. The suite also shares a common command line "
2235 "parser to provide a uniform environment."
2238 #. type: Content of: <refentry><refsect1><orderedlist><para>
2239 #: apt.conf.5.xml:48
2241 "When an APT tool starts up it will read the configuration files in the "
2245 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2246 #: apt.conf.5.xml:50
2248 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2252 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2253 #: apt.conf.5.xml:52
2255 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2256 "order which have either no or \"<literal>conf</literal>\" as filename "
2257 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2258 "and period (.) characters. Otherwise APT will print a notice that it has "
2259 "ignored a file, unless that file matches a pattern in the "
2260 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2261 "case it will be silently ignored."
2264 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2265 #: apt.conf.5.xml:59
2266 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2269 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2270 #: apt.conf.5.xml:61
2272 "the command line options are applied to override the configuration "
2273 "directives or to load even more configuration files."
2276 #. type: Content of: <refentry><refsect1><title>
2277 #: apt.conf.5.xml:65
2281 #. type: Content of: <refentry><refsect1><para>
2282 #: apt.conf.5.xml:66
2284 "The configuration file is organized in a tree with options organized into "
2285 "functional groups. Option specification is given with a double colon "
2286 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2287 "within the APT tool group, for the Get tool. Options do not inherit from "
2288 "their parent groups."
2291 #. type: Content of: <refentry><refsect1><para>
2292 #: apt.conf.5.xml:72
2294 "Syntactically the configuration language is modeled after what the ISC tools "
2295 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2296 "treated as comments (ignored), as well as all text between "
2297 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2298 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2299 "The quotation marks and trailing semicolon are required. The value must be "
2300 "on one line, and there is no kind of string concatenation. Values must not "
2301 "include backslashes or extra quotation marks. Option names are made up of "
2302 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2303 "opened with curly braces, like this:"
2306 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2307 #: apt.conf.5.xml:85
2312 " Assume-Yes \"true\";\n"
2313 " Fix-Broken \"true\";\n"
2318 #. type: Content of: <refentry><refsect1><para>
2319 #: apt.conf.5.xml:93
2321 "with newlines placed to make it more readable. Lists can be created by "
2322 "opening a scope and including a single string enclosed in quotes followed by "
2323 "a semicolon. Multiple entries can be included, separated by a semicolon."
2326 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2327 #: apt.conf.5.xml:98
2329 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2332 #. type: Content of: <refentry><refsect1><para>
2333 #: apt.conf.5.xml:101
2335 "In general the sample configuration file in "
2336 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
2337 "guide for how it should look."
2340 #. type: Content of: <refentry><refsect1><para>
2341 #: apt.conf.5.xml:105
2343 "Case is not significant in names of configuration items, so in the previous "
2344 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2347 #. type: Content of: <refentry><refsect1><para>
2348 #: apt.conf.5.xml:108
2350 "Names for the configuration items are optional if a list is defined as can "
2351 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2352 "you don't specify a name a new entry will simply add a new option to the "
2353 "list. If you specify a name you can override the option in the same way as "
2354 "any other option by reassigning a new value to the option."
2357 #. type: Content of: <refentry><refsect1><para>
2358 #: apt.conf.5.xml:113
2360 "Two special commands are defined: <literal>#include</literal> (which is "
2361 "deprecated and not supported by alternative implementations) and "
2362 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2363 "given file, unless the filename ends in a slash, in which case the whole "
2364 "directory is included. <literal>#clear</literal> is used to erase a part of "
2365 "the configuration tree. The specified element and all its descendants are "
2366 "erased. (Note that these lines also need to end with a semicolon.)"
2369 #. type: Content of: <refentry><refsect1><para>
2370 #: apt.conf.5.xml:123
2372 "The <literal>#clear</literal> command is the only way to delete a list or a "
2373 "complete scope. Reopening a scope (or using the syntax described below with "
2374 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2375 "previously written entries. Options can only be overridden by addressing a "
2376 "new value to them - lists and scopes can't be overridden, only cleared."
2379 #. type: Content of: <refentry><refsect1><para>
2380 #: apt.conf.5.xml:131
2382 "All of the APT tools take an -o option which allows an arbitrary "
2383 "configuration directive to be specified on the command line. The syntax is a "
2384 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2385 "followed by an equals sign then the new value of the option. To append a new "
2386 "element to a list, add a trailing <literal>::</literal> to the name of the "
2387 "list. (As you might suspect, the scope syntax can't be used on the command "
2391 #. type: Content of: <refentry><refsect1><para>
2392 #: apt.conf.5.xml:139
2394 "Note that appending items to a list using <literal>::</literal> only works "
2395 "for one item per line, and that you should not use it in combination with "
2396 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2397 "syntaxes together will trigger a bug which some users unfortunately depend "
2398 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2399 "like every other option with a name. This introduces many problems; for one "
2400 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2401 "syntax in the hope of appending to a list will achieve the opposite, as only "
2402 "the last assignment for this option \"<literal>::</literal>\" will be "
2403 "used. Future versions of APT will raise errors and stop working if they "
2404 "encounter this misuse, so please correct such statements now while APT "
2405 "doesn't explicitly complain about them."
2408 #. type: Content of: <refentry><refsect1><title>
2409 #: apt.conf.5.xml:154
2410 msgid "The APT Group"
2413 #. type: Content of: <refentry><refsect1><para>
2414 #: apt.conf.5.xml:155
2416 "This group of options controls general APT behavior as well as holding the "
2417 "options for all of the tools."
2420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2421 #: apt.conf.5.xml:160
2423 "System Architecture; sets the architecture to use when fetching files and "
2424 "parsing package lists. The internal default is the architecture apt was "
2428 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2429 #: apt.conf.5.xml:167
2431 "All Architectures the system supports. For instance, CPUs implementing the "
2432 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2433 "instruction set are also able to execute binaries compiled for the "
2434 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2435 "is used when fetching files and parsing package lists. The initial default "
2436 "is always the system's native architecture "
2437 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2438 "to the default list when they are registered via <command>dpkg "
2439 "--add-architecture</command>."
2442 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2443 #: apt.conf.5.xml:180
2445 "Default release to install packages from if more than one version is "
2446 "available. Contains release name, codename or release version. Examples: "
2447 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2448 "'4.0', '5.0*'. See also &apt-preferences;."
2451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2452 #: apt.conf.5.xml:186
2454 "Ignore held packages; this global option causes the problem resolver to "
2455 "ignore held packages in its decision making."
2458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2459 #: apt.conf.5.xml:191
2461 "Defaults to on. When turned on the autoclean feature will remove any "
2462 "packages which can no longer be downloaded from the cache. If turned off "
2463 "then packages that are locally installed are also excluded from cleaning - "
2464 "but note that APT provides no direct means to reinstall them."
2467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2468 #: apt.conf.5.xml:199
2470 "Defaults to on, which will cause APT to install essential and important "
2471 "packages as soon as possible in an install/upgrade operation, in order to "
2472 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2473 "treats an important package in the same way as an extra package: between the "
2474 "unpacking of the package A and its configuration there can be many other "
2475 "unpack or configuration calls for other unrelated packages B, C etc. If "
2476 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2477 "scripts generate an error), this results in a system state in which package "
2478 "A is unpacked but unconfigured - so any package depending on A is now no "
2479 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2483 #: apt.conf.5.xml:211
2485 "The immediate configuration marker is also applied in the potentially "
2486 "problematic case of circular dependencies, since a dependency with the "
2487 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2488 "to recognise a situation in which it is unable to perform immediate "
2489 "configuration, abort, and suggest to the user that the option should be "
2490 "temporarily deactivated in order to allow the operation to proceed. Note "
2491 "the use of the word \"theory\" here; in the real world this problem has "
2492 "rarely been encountered, in non-stable distribution versions, and was caused "
2493 "by wrong dependencies of the package in question or by a system in an "
2494 "already broken state; so you should not blindly disable this option, as the "
2495 "scenario mentioned above is not the only problem it can help to prevent in "
2499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2500 #: apt.conf.5.xml:224
2502 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2503 "option disabled you should try to explicitly <literal>install</literal> the "
2504 "package APT is unable to configure immediately; but please make sure you "
2505 "also report your problem to your distribution and to the APT team with the "
2506 "buglink below, so they can work on improving or correcting the upgrade "
2510 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2511 #: apt.conf.5.xml:235
2513 "Never enable this option unless you <emphasis>really</emphasis> know what "
2514 "you are doing. It permits APT to temporarily remove an essential package to "
2515 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2516 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2517 "bug</emphasis>. This option will work if the essential packages are not "
2518 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2519 "<command>dpkg</command>, <command>dash</command> or anything that those "
2520 "packages depend on."
2523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2524 #: apt.conf.5.xml:247
2526 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2527 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2528 "the size the cache will grow to, and is therefore the amount of memory APT "
2529 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2530 "that this amount of space needs to be available for APT; otherwise it will "
2531 "likely fail ungracefully, so for memory restricted devices this value should "
2532 "be lowered while on systems with a lot of configured sources it should be "
2533 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2534 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2535 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2536 "value will be applied again and again until either the cache is big enough "
2537 "to store all information or the size of the cache reaches the "
2538 "<literal>Cache-Limit</literal>. The default of "
2539 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2540 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2545 #: apt.conf.5.xml:263
2546 msgid "Defines which packages are considered essential build dependencies."
2549 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2550 #: apt.conf.5.xml:267
2552 "The Get subsection controls the &apt-get; tool; please see its documentation "
2553 "for more information about the options here."
2556 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2557 #: apt.conf.5.xml:272
2559 "The Cache subsection controls the &apt-cache; tool; please see its "
2560 "documentation for more information about the options here."
2563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2564 #: apt.conf.5.xml:277
2566 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2567 "documentation for more information about the options here."
2570 #. type: Content of: <refentry><refsect1><title>
2571 #: apt.conf.5.xml:283
2572 msgid "The Acquire Group"
2575 #. type: Content of: <refentry><refsect1><para>
2576 #: apt.conf.5.xml:284
2578 "The <literal>Acquire</literal> group of options controls the download of "
2579 "packages as well as the various \"acquire methods\" responsible for the "
2580 "download itself (see also &sources-list;)."
2583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2584 #: apt.conf.5.xml:291
2586 "Security related option defaulting to true, as giving a Release file's "
2587 "validation an expiration date prevents replay attacks over a long timescale, "
2588 "and can also for example help users to identify mirrors that are no longer "
2589 "updated - but the feature depends on the correctness of the clock on the "
2590 "user system. Archive maintainers are encouraged to create Release files with "
2591 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2592 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2597 #: apt.conf.5.xml:304
2599 "Maximum time (in seconds) after its creation (as indicated by the "
2600 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2601 "should be considered valid. If the Release file itself includes a "
2602 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2603 "the expiration date. The default value is <literal>0</literal> which stands "
2604 "for \"valid forever\". Archive specific settings can be made by appending "
2605 "the label of the archive to the option name."
2608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2609 #: apt.conf.5.xml:316
2611 "Minimum time (in seconds) after its creation (as indicated by the "
2612 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2613 "should be considered valid. Use this if you need to use a seldom updated "
2614 "(local) mirror of a more frequently updated archive with a "
2615 "<literal>Valid-Until</literal> header instead of completely disabling the "
2616 "expiration date checking. Archive specific settings can and should be used "
2617 "by appending the label of the archive to the option name."
2620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2621 #: apt.conf.5.xml:328
2623 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2624 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2628 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2629 #: apt.conf.5.xml:331
2631 "Two sub-options to limit the use of PDiffs are also available: "
2632 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2633 "PDiff files should be downloaded to update a "
2634 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2635 "percentage of the size of all patches compared to the size of the targeted "
2636 "file. If one of these limits is exceeded the complete file is downloaded "
2637 "instead of the patches."
2640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2641 #: apt.conf.5.xml:341
2643 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2644 "<literal>host</literal> or <literal>access</literal> which determines how "
2645 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2646 "one connection per target host will be opened, <literal>access</literal> "
2647 "means that one connection per URI type will be opened."
2650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2651 #: apt.conf.5.xml:349
2653 "Number of retries to perform. If this is non-zero APT will retry failed "
2654 "files the given number of times."
2657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2658 #: apt.conf.5.xml:354
2660 "Use symlinks for source archives. If set to true then source archives will "
2661 "be symlinked when possible instead of copying. True is the default."
2664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2665 #: apt.conf.5.xml:359
2667 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2668 "URIs. It is in the standard form of "
2669 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2670 "can also be specified by using the form "
2671 "<literal>http::Proxy::<host></literal> with the special keyword "
2672 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2673 "settings is specified, <envar>http_proxy</envar> environment variable will "
2677 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2678 #: apt.conf.5.xml:367
2680 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2681 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2682 "response under any circumstances. <literal>Max-Age</literal> sets the "
2683 "allowed maximum age (in seconds) of an index file in the cache of the "
2684 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2685 "store the requested archive files in its cache, which can be used to prevent "
2686 "the proxy from polluting its cache with (big) .deb files."
2689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2690 #: apt.conf.5.xml:377 apt.conf.5.xml:449
2692 "The option <literal>timeout</literal> sets the timeout timer used by the "
2693 "method; this value applies to the connection as well as the data timeout."
2696 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2697 #: apt.conf.5.xml:380
2699 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2700 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2701 "e.g. on high-latency connections. It specifies how many requests are sent in "
2702 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
2703 "the default value is now 0 (= disabled) to avoid problems with the "
2704 "ever-growing amount of webservers and proxies which choose to not conform to "
2705 "the HTTP/1.1 specification."
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2709 #: apt.conf.5.xml:387
2711 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
2712 "follow redirects, which is enabled by default."
2715 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2716 #: apt.conf.5.xml:390
2718 "The used bandwidth can be limited with "
2719 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
2720 "kilobytes. The default value is 0 which deactivates the limit and tries to "
2721 "use all available bandwidth (note that this option implicitly disables "
2722 "downloading from multiple servers at the same time.)"
2725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2726 #: apt.conf.5.xml:395
2728 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
2729 "User-Agent for the http download method as some proxies allow access for "
2730 "clients only if the client uses a known identifier."
2733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2734 #: apt.conf.5.xml:403
2736 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
2737 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
2738 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
2739 "the <literal>http</literal> method, and default to the same values if they "
2740 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
2744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2745 #: apt.conf.5.xml:411
2747 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
2748 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
2749 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
2750 "suboption determines whether or not the server's host certificate should be "
2751 "verified against trusted certificates. "
2752 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
2753 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
2754 "or not the server's hostname should be verified. "
2755 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
2756 "option. <literal>SslCert</literal> determines what certificate to use for "
2757 "client authentication. <literal><host>::SslCert</literal> is the "
2758 "corresponding per-host option. <literal>SslKey</literal> determines what "
2759 "private key to use for client "
2760 "authentication. <literal><host>::SslKey</literal> is the corresponding "
2761 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
2762 "version to use. It can contain either of the strings "
2763 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
2764 "<literal><host>::SslForceVersion</literal> is the corresponding "
2768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2769 #: apt.conf.5.xml:432
2771 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
2772 "It is in the standard form of "
2773 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
2774 "also be specified by using the form "
2775 "<literal>ftp::Proxy::<host></literal> with the special keyword "
2776 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2777 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
2778 "used. To use an FTP proxy you will have to set the "
2779 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
2780 "entry specifies the commands to send to tell the proxy server what to "
2781 "connect to. Please see &configureindex; for an example of how to do "
2782 "this. The substitution variables representing the corresponding URI "
2783 "component are <literal>$(PROXY_USER)</literal>, "
2784 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
2785 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
2786 "<literal>$(SITE_PORT)</literal>."
2789 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2790 #: apt.conf.5.xml:452
2792 "Several settings are provided to control passive mode. Generally it is safe "
2793 "to leave passive mode on; it works in nearly every environment. However, "
2794 "some situations require that passive mode be disabled and port mode FTP used "
2795 "instead. This can be done globally or for connections that go through a "
2796 "proxy or for a specific host (see the sample config file for examples)."
2799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2800 #: apt.conf.5.xml:459
2802 "It is possible to proxy FTP over HTTP by setting the "
2803 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
2804 "discussion of the http method above for syntax. You cannot set this in the "
2805 "configuration file and it is not recommended to use FTP over HTTP due to its "
2809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2810 #: apt.conf.5.xml:464
2812 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
2813 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
2814 "false, which means these commands are only used if the control connection is "
2815 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
2816 "that most FTP servers do not support RFC2428."
2819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2820 #: apt.conf.5.xml:478
2822 msgid "/cdrom/::Mount \"foo\";"
2825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2826 #: apt.conf.5.xml:473
2828 "For URIs using the <literal>cdrom</literal> method, the only configurable "
2829 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
2830 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
2831 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
2832 "and unmount commands if your mount point cannot be listed in the fstab. The "
2833 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
2834 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
2835 "Unmount commands can be specified using UMount."
2838 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2839 #: apt.conf.5.xml:486
2841 "For GPGV URIs the only configurable option is "
2842 "<literal>gpgv::Options</literal>, which passes additional parameters to "
2846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2847 #: apt.conf.5.xml:497
2850 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
2851 "\"<replaceable>Methodname</replaceable>\";"
2854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2855 #: apt.conf.5.xml:492
2857 "List of compression types which are understood by the acquire methods. "
2858 "Files like <filename>Packages</filename> can be available in various "
2859 "compression formats. By default the acquire methods can decompress "
2860 "<command>bzip2</command>, <command>lzma</command> and "
2861 "<command>gzip</command> compressed files; with this setting more formats can "
2862 "be added on the fly or the used method can be changed. The syntax for this "
2863 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
2866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2867 #: apt.conf.5.xml:502
2869 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
2872 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2873 #: apt.conf.5.xml:505
2875 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
2878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2879 #: apt.conf.5.xml:498
2881 "Also, the <literal>Order</literal> subgroup can be used to define in which "
2882 "order the acquire system will try to download the compressed files. The "
2883 "acquire system will try the first and proceed with the next compression type "
2884 "in this list on error, so to prefer one over the other type simply add the "
2885 "preferred type first - default types not already added will be implicitly "
2886 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
2887 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
2888 "over <command>bzip2</command> and <command>lzma</command>. If "
2889 "<command>lzma</command> should be preferred over <command>gzip</command> and "
2890 "<command>bzip2</command> the configure setting should look like this: "
2891 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
2892 "<literal>bz2</literal> to the list explicitly as it will be added "
2896 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2897 #: apt.conf.5.xml:512
2899 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
2902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2903 #: apt.conf.5.xml:507
2906 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
2907 "checked at run time. If this option has been set, the method will only be "
2908 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
2909 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
2910 "also that list entries specified on the command line will be added at the "
2911 "end of the list specified in the configuration files, but before the default "
2912 "entries. To prefer a type in this case over the ones specified in the "
2913 "configuration files you can set the option direct - not in list style. This "
2914 "will not override the defined list; it will only prefix the list with this "
2918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2919 #: apt.conf.5.xml:517
2921 "The special type <literal>uncompressed</literal> can be used to give "
2922 "uncompressed files a preference, but note that most archives don't provide "
2923 "uncompressed files so this is mostly only useable for local mirrors."
2926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2927 #: apt.conf.5.xml:524
2929 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
2930 "Sources, or Translations), keep them gzip compressed locally instead of "
2931 "unpacking them. This saves quite a lot of disk space at the expense of more "
2932 "CPU requirements when building the local package caches. False by default."
2935 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2936 #: apt.conf.5.xml:532
2938 "The Languages subsection controls which <filename>Translation</filename> "
2939 "files are downloaded and in which order APT tries to display the "
2940 "description-translations. APT will try to display the first available "
2941 "description in the language which is listed first. Languages can be defined "
2942 "with their short or long language codes. Note that not all archives provide "
2943 "<filename>Translation</filename> files for every language - the long "
2944 "language codes are especially rare."
2947 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
2948 #: apt.conf.5.xml:549
2950 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
2953 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2954 #: apt.conf.5.xml:537
2956 "The default list includes \"environment\" and "
2957 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
2958 "will be replaced at runtime with the language codes extracted from the "
2959 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
2960 "that these codes are not included twice in the list. If "
2961 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
2962 "<filename>Translation-en</filename> file (if available) will be used. To "
2963 "force APT to use no Translation file use the setting "
2964 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
2965 "another special meaning code which will stop the search for a suitable "
2966 "<filename>Translation</filename> file. This tells APT to download these "
2967 "translations too, without actually using them unless the environment "
2968 "specifies the languages. So the following example configuration will result "
2969 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
2970 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
2971 "French locale (where the order would be \"fr, de, en\"). <placeholder "
2972 "type=\"programlisting\" id=\"0\"/>"
2975 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2976 #: apt.conf.5.xml:550
2978 "Note: To prevent problems resulting from APT being executed in different "
2979 "environments (e.g. by different users or by other programs) all Translation "
2980 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
2981 "added to the end of the list (after an implicit "
2982 "\"<literal>none</literal>\")."
2985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2986 #: apt.conf.5.xml:559
2987 msgid "When downloading, force to use only the IPv4 protocol."
2990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2991 #: apt.conf.5.xml:565
2992 msgid "When downloading, force to use only the IPv6 protocol."
2995 #. type: Content of: <refentry><refsect1><title>
2996 #: apt.conf.5.xml:572
3000 #. type: Content of: <refentry><refsect1><para>
3001 #: apt.conf.5.xml:574
3003 "The <literal>Dir::State</literal> section has directories that pertain to "
3004 "local state information. <literal>lists</literal> is the directory to place "
3005 "downloaded package lists in and <literal>status</literal> is the name of the "
3006 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3007 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3008 "contains the default directory to prefix on all sub-items if they do not "
3009 "start with <filename>/</filename> or <filename>./</filename>."
3012 #. type: Content of: <refentry><refsect1><para>
3013 #: apt.conf.5.xml:581
3015 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3016 "information, such as the two package caches <literal>srcpkgcache</literal> "
3017 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3018 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3019 "be turned off by setting their names to the empty string. This will slow "
3020 "down startup but save disk space. It is probably preferable to turn off the "
3021 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3022 "default directory is contained in <literal>Dir::Cache</literal>"
3025 #. type: Content of: <refentry><refsect1><para>
3026 #: apt.conf.5.xml:590
3028 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3029 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3030 "<literal>main</literal> is the default configuration file (setting has no "
3031 "effect, unless it is done from the config file specified by "
3032 "<envar>APT_CONFIG</envar>)."
3035 #. type: Content of: <refentry><refsect1><para>
3036 #: apt.conf.5.xml:596
3038 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3039 "in lexical order from the directory specified. After this is done then the "
3040 "main config file is loaded."
3043 #. type: Content of: <refentry><refsect1><para>
3044 #: apt.conf.5.xml:600
3046 "Binary programs are pointed to by "
3047 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3048 "the location of the method handlers and <literal>gzip</literal>, "
3049 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3050 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3051 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3052 "specify the location of the respective programs."
3055 #. type: Content of: <refentry><refsect1><para>
3056 #: apt.conf.5.xml:608
3058 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3059 "set, all paths in <literal>Dir::</literal> will be relative to "
3060 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3061 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3062 "set to <filename>/tmp/staging</filename> and "
3063 "<literal>Dir::State::status</literal> is set to "
3064 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3065 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
3068 #. type: Content of: <refentry><refsect1><para>
3069 #: apt.conf.5.xml:621
3071 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3072 "which files APT should silently ignore while parsing the files in the "
3073 "fragment directories. Per default a file which end with "
3074 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3075 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3076 "default value these patterns can use regular expression syntax."
3079 #. type: Content of: <refentry><refsect1><title>
3080 #: apt.conf.5.xml:630
3081 msgid "APT in DSelect"
3084 #. type: Content of: <refentry><refsect1><para>
3085 #: apt.conf.5.xml:632
3087 "When APT is used as a &dselect; method several configuration directives "
3088 "control the default behavior. These are in the <literal>DSelect</literal> "
3092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3093 #: apt.conf.5.xml:637
3095 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3096 "<literal>prompt</literal>, <literal>auto</literal>, "
3097 "<literal>pre-auto</literal> and <literal>never</literal>. "
3098 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3099 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3100 "default) does so conditionally. <literal>auto</literal> removes only those "
3101 "packages which are no longer downloadable (replaced with a new version for "
3102 "instance). <literal>pre-auto</literal> performs this action before "
3103 "downloading new packages."
3106 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3107 #: apt.conf.5.xml:651
3109 "The contents of this variable are passed to &apt-get; as command line "
3110 "options when it is run for the install phase."
3113 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3114 #: apt.conf.5.xml:656
3116 "The contents of this variable are passed to &apt-get; as command line "
3117 "options when it is run for the update phase."
3120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3121 #: apt.conf.5.xml:661
3123 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3124 "The default is to prompt only on error."
3127 #. type: Content of: <refentry><refsect1><title>
3128 #: apt.conf.5.xml:667
3129 msgid "How APT calls &dpkg;"
3132 #. type: Content of: <refentry><refsect1><para>
3133 #: apt.conf.5.xml:668
3135 "Several configuration directives control how APT invokes &dpkg;. These are "
3136 "in the <literal>DPkg</literal> section."
3139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3140 #: apt.conf.5.xml:673
3142 "This is a list of options to pass to &dpkg;. The options must be specified "
3143 "using the list notation and each list item is passed as a single argument to "
3147 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3148 #: apt.conf.5.xml:679
3150 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3151 "<literal>options</literal> this must be specified in list notation. The "
3152 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3153 "fail APT will abort."
3156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3157 #: apt.conf.5.xml:686
3159 "This is a list of shell commands to run before invoking &dpkg;. Like "
3160 "<literal>options</literal> this must be specified in list notation. The "
3161 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3162 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3163 "going to install to the commands, one per line on standard input."
3166 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3167 #: apt.conf.5.xml:692
3169 "Version 2 of this protocol dumps more information, including the protocol "
3170 "version, the APT configuration space and the packages, files and versions "
3171 "being changed. Version 2 is enabled by setting "
3172 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
3173 "2. <literal>cmd</literal> is a command given to "
3174 "<literal>Pre-Install-Pkgs</literal>."
3177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3178 #: apt.conf.5.xml:700
3180 "APT chdirs to this directory before invoking &dpkg;, the default is "
3181 "<filename>/</filename>."
3184 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3185 #: apt.conf.5.xml:705
3187 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3188 "default is to disable signing and produce all binaries."
3191 #. type: Content of: <refentry><refsect1><refsect2><title>
3192 #: apt.conf.5.xml:710
3193 msgid "dpkg trigger usage (and related options)"
3196 #. type: Content of: <refentry><refsect1><refsect2><para>
3197 #: apt.conf.5.xml:711
3199 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3200 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3201 "use triggers once each time it runs. Activating these options can therefore "
3202 "decrease the time needed to perform the install or upgrade. Note that it is "
3203 "intended to activate these options per default in the future, but as it "
3204 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3205 "<emphasis>These options are therefore currently experimental and should not "
3206 "be used in production environments.</emphasis> It also breaks progress "
3207 "reporting such that all front-ends will currently stay around half (or more) "
3208 "of the time in the 100% state while it actually configures all packages."
3211 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3212 #: apt.conf.5.xml:726
3215 "DPkg::NoTriggers \"true\";\n"
3216 "PackageManager::Configure \"smart\";\n"
3217 "DPkg::ConfigurePending \"true\";\n"
3218 "DPkg::TriggersPending \"true\";"
3221 #. type: Content of: <refentry><refsect1><refsect2><para>
3222 #: apt.conf.5.xml:720
3224 "Note that it is not guaranteed that APT will support these options or that "
3225 "these options will not cause (big) trouble in the future. If you have "
3226 "understand the current risks and problems with these options, but are brave "
3227 "enough to help testing them, create a new configuration file and test a "
3228 "combination of options. Please report any bugs, problems and improvements "
3229 "you encounter and make sure to note which options you have used in your "
3230 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3231 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3232 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3235 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3236 #: apt.conf.5.xml:733
3238 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3239 "call). See &dpkg; if you are interested in what this actually means. In "
3240 "short: &dpkg; will not run the triggers when this flag is present unless it "
3241 "is explicitly called to do so in an extra call. Note that this option "
3242 "exists (undocumented) also in older APT versions with a slightly different "
3243 "meaning: Previously these option only append --no-triggers to the configure "
3244 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3248 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3249 #: apt.conf.5.xml:741
3251 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3252 "and \"<literal>no</literal>\". The default value is "
3253 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3254 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3255 "be configured before another package can be unpacked (Pre-Depends), and let "
3256 "the rest be configured by &dpkg; with a call generated by the "
3257 "ConfigurePending option (see below). On the other hand, "
3258 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3259 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3260 "encountered). Setting this option to any value other than "
3261 "<literal>all</literal> will implicitly also activate the next option by "
3262 "default, as otherwise the system could end in an unconfigured and "
3263 "potentially unbootable state."
3266 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3267 #: apt.conf.5.xml:756
3269 "If this option is set APT will call <command>dpkg --configure "
3270 "--pending</command> to let &dpkg; handle all required configurations and "
3271 "triggers. This option is activated automatically per default if the previous "
3272 "option is not set to <literal>all</literal>, but deactivating it could be "
3273 "useful if you want to run APT multiple times in a row - e.g. in an "
3274 "installer. In these sceneries you could deactivate this option in all but "
3278 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3279 #: apt.conf.5.xml:763
3281 "Useful for the <literal>smart</literal> configuration as a package which has "
3282 "pending triggers is not considered as <literal>installed</literal>, and "
3283 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3284 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3285 "process all triggers, not only the triggers needed to configure this "
3289 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3290 #: apt.conf.5.xml:776
3293 "OrderList::Score {\n"
3295 "\tEssential 200;\n"
3297 "\tPreDepends 50;\n"
3301 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3302 #: apt.conf.5.xml:769
3304 "Essential packages (and their dependencies) should be configured immediately "
3305 "after unpacking. It is a good idea to do this quite early in the upgrade "
3306 "process as these configure calls also currently require "
3307 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3308 "(which may not be needed). Essentials get per default a high score but the "
3309 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3310 "higher). These option and the others in the same group can be used to "
3311 "change the scoring. The following example shows the settings with their "
3312 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3315 #. type: Content of: <refentry><refsect1><title>
3316 #: apt.conf.5.xml:789
3317 msgid "Periodic and Archives options"
3320 #. type: Content of: <refentry><refsect1><para>
3321 #: apt.conf.5.xml:790
3323 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3324 "of options configure behavior of apt periodic updates, which is done by the "
3325 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3326 "for the brief documentation of these options."
3329 #. type: Content of: <refentry><refsect1><title>
3330 #: apt.conf.5.xml:798
3331 msgid "Debug options"
3334 #. type: Content of: <refentry><refsect1><para>
3335 #: apt.conf.5.xml:800
3337 "Enabling options in the <literal>Debug::</literal> section will cause "
3338 "debugging information to be sent to the standard error stream of the program "
3339 "utilizing the <literal>apt</literal> libraries, or enable special program "
3340 "modes that are primarily useful for debugging the behavior of "
3341 "<literal>apt</literal>. Most of these options are not interesting to a "
3342 "normal user, but a few may be:"
3345 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3346 #: apt.conf.5.xml:811
3348 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3349 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3353 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3354 #: apt.conf.5.xml:819
3356 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3357 "used to run some operations (for instance, <literal>apt-get -s "
3358 "install</literal>) as a non-root user."
3361 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3362 #: apt.conf.5.xml:828
3364 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3365 "time that <literal>apt</literal> invokes &dpkg;."
3369 #. motivating example, except I haven't a clue why you'd want
3371 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3372 #: apt.conf.5.xml:836
3374 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3378 #. type: Content of: <refentry><refsect1><para>
3379 #: apt.conf.5.xml:846
3380 msgid "A full list of debugging options to apt follows."
3383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3384 #: apt.conf.5.xml:855
3385 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3389 #: apt.conf.5.xml:866
3390 msgid "Print information related to downloading packages using FTP."
3393 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3394 #: apt.conf.5.xml:877
3395 msgid "Print information related to downloading packages using HTTP."
3398 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3399 #: apt.conf.5.xml:888
3400 msgid "Print information related to downloading packages using HTTPS."
3403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3404 #: apt.conf.5.xml:899
3406 "Print information related to verifying cryptographic signatures using "
3407 "<literal>gpg</literal>."
3410 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3411 #: apt.conf.5.xml:910
3413 "Output information about the process of accessing collections of packages "
3414 "stored on CD-ROMs."
3417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3418 #: apt.conf.5.xml:920
3419 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3423 #: apt.conf.5.xml:930
3425 "Output each cryptographic hash that is generated by the "
3426 "<literal>apt</literal> libraries."
3429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3430 #: apt.conf.5.xml:940
3432 "Do not include information from <literal>statfs</literal>, namely the number "
3433 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3438 #: apt.conf.5.xml:951
3440 "Disable all file locking. For instance, this will allow two instances of "
3441 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3444 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3445 #: apt.conf.5.xml:963
3446 msgid "Log when items are added to or removed from the global download queue."
3449 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3450 #: apt.conf.5.xml:973
3452 "Output status messages and errors related to verifying checksums and "
3453 "cryptographic signatures of downloaded files."
3456 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3457 #: apt.conf.5.xml:983
3459 "Output information about downloading and applying package index list diffs, "
3460 "and errors relating to package index list diffs."
3463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3464 #: apt.conf.5.xml:995
3466 "Output information related to patching apt package lists when downloading "
3467 "index diffs instead of full indices."
3470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3471 #: apt.conf.5.xml:1006
3472 msgid "Log all interactions with the sub-processes that actually perform downloads."
3475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3476 #: apt.conf.5.xml:1017
3478 "Log events related to the automatically-installed status of packages and to "
3479 "the removal of unused packages."
3482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3483 #: apt.conf.5.xml:1027
3485 "Generate debug messages describing which packages are being automatically "
3486 "installed to resolve dependencies. This corresponds to the initial "
3487 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3488 "and not to the full <literal>apt</literal> dependency resolver; see "
3489 "<literal>Debug::pkgProblemResolver</literal> for that."
3492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3493 #: apt.conf.5.xml:1041
3495 "Generate debug messages describing which packages are marked as "
3496 "keep/install/remove while the ProblemResolver does his work. Each addition "
3497 "or deletion may trigger additional actions; they are shown indented two "
3498 "additional spaces under the original entry. The format for each line is "
3499 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3500 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3501 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3502 "is the current version of the package, <literal>d.e.f</literal> is the "
3503 "version considered for installation and <literal>x.y.z</literal> is a newer "
3504 "version, but not considered for installation (because of a low pin "
3505 "score). The later two can be omitted if there is none or if it is the same "
3506 "as the installed version. <literal>section</literal> is the name of the "
3507 "section the package appears in."
3510 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3511 #: apt.conf.5.xml:1062
3513 "When invoking &dpkg;, output the precise command line with which it is being "
3514 "invoked, with arguments separated by a single space character."
3517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3518 #: apt.conf.5.xml:1073
3520 "Output all the data received from &dpkg; on the status file descriptor and "
3521 "any errors encountered while parsing it."
3524 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3525 #: apt.conf.5.xml:1084
3527 "Generate a trace of the algorithm that decides the order in which "
3528 "<literal>apt</literal> should pass packages to &dpkg;."
3531 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3532 #: apt.conf.5.xml:1096
3533 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3536 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3537 #: apt.conf.5.xml:1107
3538 msgid "Output the priority of each package list on startup."
3541 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3542 #: apt.conf.5.xml:1117
3544 "Trace the execution of the dependency resolver (this applies only to what "
3545 "happens when a complex dependency problem is encountered)."
3548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3549 #: apt.conf.5.xml:1128
3551 "Display a list of all installed packages with their calculated score used by "
3552 "the pkgProblemResolver. The description of the package is the same as "
3553 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3556 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3557 #: apt.conf.5.xml:1140
3559 "Print information about the vendors read from "
3560 "<filename>/etc/apt/vendors.list</filename>."
3563 #. type: Content of: <refentry><refsect1><title>
3564 #: apt.conf.5.xml:1162 apt_preferences.5.xml:545 sources.list.5.xml:211 apt-ftparchive.1.xml:596
3568 #. type: Content of: <refentry><refsect1><para>
3569 #: apt.conf.5.xml:1163
3571 "&configureindex; is a configuration file showing example values for all "
3575 #. ? reading apt.conf
3576 #. type: Content of: <refentry><refsect1><para>
3577 #: apt.conf.5.xml:1175
3578 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
3581 #. type: Content of: <refentry><refnamediv><refpurpose>
3582 #: apt_preferences.5.xml:32
3583 msgid "Preference control file for APT"
3586 #. type: Content of: <refentry><refsect1><para>
3587 #: apt_preferences.5.xml:37
3589 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
3590 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
3591 "can be used to control which versions of packages will be selected for "
3595 #. type: Content of: <refentry><refsect1><para>
3596 #: apt_preferences.5.xml:42
3598 "Several versions of a package may be available for installation when the "
3599 "&sources-list; file contains references to more than one distribution (for "
3600 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
3601 "assigns a priority to each version that is available. Subject to dependency "
3602 "constraints, <command>apt-get</command> selects the version with the highest "
3603 "priority for installation. The APT preferences override the priorities that "
3604 "APT assigns to package versions by default, thus giving the user control "
3605 "over which one is selected for installation."
3608 #. type: Content of: <refentry><refsect1><para>
3609 #: apt_preferences.5.xml:52
3611 "Several instances of the same version of a package may be available when the "
3612 "&sources-list; file contains references to more than one source. In this "
3613 "case <command>apt-get</command> downloads the instance listed earliest in "
3614 "the &sources-list; file. The APT preferences do not affect the choice of "
3615 "instance, only the choice of version."
3618 #. type: Content of: <refentry><refsect1><para>
3619 #: apt_preferences.5.xml:59
3621 "Preferences are a strong power in the hands of a system administrator but "
3622 "they can become also their biggest nightmare if used without care! APT will "
3623 "not question the preferences, so wrong settings can lead to uninstallable "
3624 "packages or wrong decisions while upgrading packages. Even more problems "
3625 "will arise if multiple distribution releases are mixed without a good "
3626 "understanding of the following paragraphs. Packages included in a specific "
3627 "release aren't tested in (and therefore don't always work as expected in) "
3628 "older or newer releases, or together with other packages from different "
3629 "releases. You have been warned."
3632 #. type: Content of: <refentry><refsect1><para>
3633 #: apt_preferences.5.xml:70
3635 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
3636 "directory are parsed in alphanumeric ascending order and need to obey the "
3637 "following naming convention: The files have either no or "
3638 "\"<literal>pref</literal>\" as filename extension and only contain "
3639 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
3640 "Otherwise APT will print a notice that it has ignored a file, unless that "
3641 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
3642 "configuration list - in which case it will be silently ignored."
3645 #. type: Content of: <refentry><refsect1><refsect2><title>
3646 #: apt_preferences.5.xml:79
3647 msgid "APT's Default Priority Assignments"
3650 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3651 #: apt_preferences.5.xml:94
3654 "<command>apt-get install -t testing "
3655 "<replaceable>some-package</replaceable></command>\n"
3658 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3659 #: apt_preferences.5.xml:97
3661 msgid "APT::Default-Release \"stable\";\n"
3664 #. type: Content of: <refentry><refsect1><refsect2><para>
3665 #: apt_preferences.5.xml:81
3667 "If there is no preferences file or if there is no entry in the file that "
3668 "applies to a particular version then the priority assigned to that version "
3669 "is the priority of the distribution to which that version belongs. It is "
3670 "possible to single out a distribution, \"the target release\", which "
3671 "receives a higher priority than other distributions do by default. The "
3672 "target release can be set on the <command>apt-get</command> command line or "
3673 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
3674 "that this has precedence over any general priority you set in the "
3675 "<filename>/etc/apt/preferences</filename> file described later, but not over "
3676 "specifically pinned packages. For example, <placeholder "
3677 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
3681 #. type: Content of: <refentry><refsect1><refsect2><para>
3682 #: apt_preferences.5.xml:101
3684 "If the target release has been specified then APT uses the following "
3685 "algorithm to set the priorities of the versions of a package. Assign:"
3688 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3689 #: apt_preferences.5.xml:106
3693 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3694 #: apt_preferences.5.xml:107
3696 "to the versions coming from archives which in their "
3697 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
3698 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
3699 "<literal>experimental</literal> archive."
3702 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3703 #: apt_preferences.5.xml:113
3704 msgid "priority 100"
3707 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3708 #: apt_preferences.5.xml:114
3710 "to the version that is already installed (if any) and to the versions coming "
3711 "from archives which in their <filename>Release</filename> files are marked "
3712 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
3713 "backports archive since <literal>squeeze-backports</literal>."
3716 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3717 #: apt_preferences.5.xml:121
3718 msgid "priority 500"
3721 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3722 #: apt_preferences.5.xml:122
3724 "to the versions that are not installed and do not belong to the target "
3728 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3729 #: apt_preferences.5.xml:126
3730 msgid "priority 990"
3733 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3734 #: apt_preferences.5.xml:127
3735 msgid "to the versions that are not installed and belong to the target release."
3738 #. type: Content of: <refentry><refsect1><refsect2><para>
3739 #: apt_preferences.5.xml:132
3741 "If the target release has not been specified then APT simply assigns "
3742 "priority 100 to all installed package versions and priority 500 to all "
3743 "uninstalled package versions, except versions coming from archives which in "
3744 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
3745 "- these versions get the priority 1 or priority 100 if it is additionally "
3746 "marked as \"ButAutomaticUpgrades: yes\"."
3749 #. type: Content of: <refentry><refsect1><refsect2><para>
3750 #: apt_preferences.5.xml:139
3752 "APT then applies the following rules, listed in order of precedence, to "
3753 "determine which version of a package to install."
3756 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3757 #: apt_preferences.5.xml:142
3759 "Never downgrade unless the priority of an available version exceeds 1000. "
3760 "(\"Downgrading\" is installing a less recent version of a package in place "
3761 "of a more recent version. Note that none of APT's default priorities "
3762 "exceeds 1000; such high priorities can only be set in the preferences file. "
3763 "Note also that downgrading a package can be risky.)"
3766 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3767 #: apt_preferences.5.xml:148
3768 msgid "Install the highest priority version."
3771 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3772 #: apt_preferences.5.xml:149
3774 "If two or more versions have the same priority, install the most recent one "
3775 "(that is, the one with the higher version number)."
3778 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3779 #: apt_preferences.5.xml:152
3781 "If two or more versions have the same priority and version number but either "
3782 "the packages differ in some of their metadata or the "
3783 "<literal>--reinstall</literal> option is given, install the uninstalled one."
3786 #. type: Content of: <refentry><refsect1><refsect2><para>
3787 #: apt_preferences.5.xml:158
3789 "In a typical situation, the installed version of a package (priority 100) "
3790 "is not as recent as one of the versions available from the sources listed in "
3791 "the &sources-list; file (priority 500 or 990). Then the package will be "
3792 "upgraded when <command>apt-get install "
3793 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3794 "upgrade</command> is executed."
3797 #. type: Content of: <refentry><refsect1><refsect2><para>
3798 #: apt_preferences.5.xml:165
3800 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
3801 "recent than any of the other available versions. The package will not be "
3802 "downgraded when <command>apt-get install "
3803 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3804 "upgrade</command> is executed."
3807 #. type: Content of: <refentry><refsect1><refsect2><para>
3808 #: apt_preferences.5.xml:170
3810 "Sometimes the installed version of a package is more recent than the version "
3811 "belonging to the target release, but not as recent as a version belonging to "
3812 "some other distribution. Such a package will indeed be upgraded when "
3813 "<command>apt-get install <replaceable>some-package</replaceable></command> "
3814 "or <command>apt-get upgrade</command> is executed, because at least "
3815 "<emphasis>one</emphasis> of the available versions has a higher priority "
3816 "than the installed version."
3819 #. type: Content of: <refentry><refsect1><refsect2><title>
3820 #: apt_preferences.5.xml:179
3821 msgid "The Effect of APT Preferences"
3824 #. type: Content of: <refentry><refsect1><refsect2><para>
3825 #: apt_preferences.5.xml:181
3827 "The APT preferences file allows the system administrator to control the "
3828 "assignment of priorities. The file consists of one or more multi-line "
3829 "records separated by blank lines. Records can have one of two forms, a "
3830 "specific form and a general form."
3833 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3834 #: apt_preferences.5.xml:187
3836 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
3837 "specified packages with a specified version or version range. For example, "
3838 "the following record assigns a high priority to all versions of the "
3839 "<filename>perl</filename> package whose version number begins with "
3840 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
3844 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3845 #: apt_preferences.5.xml:194
3849 "Pin: version &good-perl;*\n"
3850 "Pin-Priority: 1001\n"
3853 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3854 #: apt_preferences.5.xml:200
3856 "The general form assigns a priority to all of the package versions in a "
3857 "given distribution (that is, to all the versions of packages that are listed "
3858 "in a certain <filename>Release</filename> file) or to all of the package "
3859 "versions coming from a particular Internet site, as identified by the site's "
3860 "fully qualified domain name."
3863 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3864 #: apt_preferences.5.xml:206
3866 "This general-form entry in the APT preferences file applies only to groups "
3867 "of packages. For example, the following record assigns a high priority to "
3868 "all package versions available from the local site."
3871 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3872 #: apt_preferences.5.xml:211
3876 "Pin: origin \"\"\n"
3877 "Pin-Priority: 999\n"
3880 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3881 #: apt_preferences.5.xml:216
3883 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
3884 "which can be used to match a hostname. The following record will assign a "
3885 "high priority to all versions available from the server identified by the "
3886 "hostname \"ftp.de.debian.org\""
3889 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3890 #: apt_preferences.5.xml:220
3894 "Pin: origin \"ftp.de.debian.org\"\n"
3895 "Pin-Priority: 999\n"
3898 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3899 #: apt_preferences.5.xml:224
3901 "This should <emphasis>not</emphasis> be confused with the Origin of a "
3902 "distribution as specified in a <filename>Release</filename> file. What "
3903 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
3904 "Internet address but an author or vendor name, such as \"Debian\" or "
3908 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3909 #: apt_preferences.5.xml:229
3911 "The following record assigns a low priority to all package versions "
3912 "belonging to any distribution whose Archive name is "
3913 "\"<literal>unstable</literal>\"."
3916 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3917 #: apt_preferences.5.xml:233
3921 "Pin: release a=unstable\n"
3922 "Pin-Priority: 50\n"
3925 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3926 #: apt_preferences.5.xml:238
3928 "The following record assigns a high priority to all package versions "
3929 "belonging to any distribution whose Codename is "
3930 "\"<literal>&testing-codename;</literal>\"."
3933 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3934 #: apt_preferences.5.xml:242
3938 "Pin: release n=&testing-codename;\n"
3939 "Pin-Priority: 900\n"
3942 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3943 #: apt_preferences.5.xml:247
3945 "The following record assigns a high priority to all package versions "
3946 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
3947 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
3950 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3951 #: apt_preferences.5.xml:252
3955 "Pin: release a=stable, v=&stable-version;\n"
3956 "Pin-Priority: 500\n"
3959 #. type: Content of: <refentry><refsect1><refsect2><title>
3960 #: apt_preferences.5.xml:262
3961 msgid "Regular expressions and &glob; syntax"
3964 #. type: Content of: <refentry><refsect1><refsect2><para>
3965 #: apt_preferences.5.xml:264
3967 "APT also supports pinning by &glob; expressions, and regular expressions "
3968 "surrounded by slashes. For example, the following example assigns the "
3969 "priority 500 to all packages from experimental where the name starts with "
3970 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
3971 "extended regular expression surrounded by slashes)."
3974 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
3975 #: apt_preferences.5.xml:273
3978 "Package: gnome* /kde/\n"
3979 "Pin: release n=experimental\n"
3980 "Pin-Priority: 500\n"
3983 #. type: Content of: <refentry><refsect1><refsect2><para>
3984 #: apt_preferences.5.xml:279
3986 "The rule for those expressions is that they can occur anywhere where a "
3987 "string can occur. Thus, the following pin assigns the priority 990 to all "
3988 "packages from a release starting with &ubuntu-codename;."
3991 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
3992 #: apt_preferences.5.xml:285
3996 "Pin: release n=&ubuntu-codename;*\n"
3997 "Pin-Priority: 990\n"
4000 #. type: Content of: <refentry><refsect1><refsect2><para>
4001 #: apt_preferences.5.xml:291
4003 "If a regular expression occurs in a <literal>Package</literal> field, the "
4004 "behavior is the same as if this regular expression were replaced with a list "
4005 "of all package names it matches. It is undecided whether this will change in "
4006 "the future; thus you should always list wild-card pins first, so later "
4007 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4008 "Package field is not considered a &glob; expression in itself."
4011 #. type: Content of: <refentry><refsect1><refsect2><title>
4012 #: apt_preferences.5.xml:307
4013 msgid "How APT Interprets Priorities"
4016 #. type: Content of: <refentry><refsect1><refsect2><para>
4017 #: apt_preferences.5.xml:310
4019 "Priorities (P) assigned in the APT preferences file must be positive or "
4020 "negative integers. They are interpreted as follows (roughly speaking):"
4023 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4024 #: apt_preferences.5.xml:315
4025 msgid "P >= 1000"
4028 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4029 #: apt_preferences.5.xml:316
4031 "causes a version to be installed even if this constitutes a downgrade of the "
4035 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4036 #: apt_preferences.5.xml:320
4037 msgid "990 <= P < 1000"
4040 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4041 #: apt_preferences.5.xml:321
4043 "causes a version to be installed even if it does not come from the target "
4044 "release, unless the installed version is more recent"
4047 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4048 #: apt_preferences.5.xml:326
4049 msgid "500 <= P < 990"
4052 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4053 #: apt_preferences.5.xml:327
4055 "causes a version to be installed unless there is a version available "
4056 "belonging to the target release or the installed version is more recent"
4059 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4060 #: apt_preferences.5.xml:332
4061 msgid "100 <= P < 500"
4064 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4065 #: apt_preferences.5.xml:333
4067 "causes a version to be installed unless there is a version available "
4068 "belonging to some other distribution or the installed version is more recent"
4071 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4072 #: apt_preferences.5.xml:338
4073 msgid "0 < P < 100"
4076 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4077 #: apt_preferences.5.xml:339
4079 "causes a version to be installed only if there is no installed version of "
4083 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4084 #: apt_preferences.5.xml:343
4088 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4089 #: apt_preferences.5.xml:344
4090 msgid "prevents the version from being installed"
4093 #. type: Content of: <refentry><refsect1><refsect2><para>
4094 #: apt_preferences.5.xml:349
4096 "If any specific-form records match an available package version then the "
4097 "first such record determines the priority of the package version. Failing "
4098 "that, if any general-form records match an available package version then "
4099 "the first such record determines the priority of the package version."
4102 #. type: Content of: <refentry><refsect1><refsect2><para>
4103 #: apt_preferences.5.xml:355
4105 "For example, suppose the APT preferences file contains the three records "
4106 "presented earlier:"
4109 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4110 #: apt_preferences.5.xml:359
4114 "Pin: version &good-perl;*\n"
4115 "Pin-Priority: 1001\n"
4118 "Pin: origin \"\"\n"
4119 "Pin-Priority: 999\n"
4122 "Pin: release unstable\n"
4123 "Pin-Priority: 50\n"
4126 #. type: Content of: <refentry><refsect1><refsect2><para>
4127 #: apt_preferences.5.xml:372
4131 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4132 #: apt_preferences.5.xml:374
4134 "The most recent available version of the <literal>perl</literal> package "
4135 "will be installed, so long as that version's version number begins with "
4136 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4137 "&good-perl;* version of <literal>perl</literal> is available and the "
4138 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4142 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4143 #: apt_preferences.5.xml:379
4145 "A version of any package other than <literal>perl</literal> that is "
4146 "available from the local system has priority over other versions, even "
4147 "versions belonging to the target release."
4150 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4151 #: apt_preferences.5.xml:383
4153 "A version of a package whose origin is not the local system but some other "
4154 "site listed in &sources-list; and which belongs to an "
4155 "<literal>unstable</literal> distribution is only installed if it is selected "
4156 "for installation and no version of the package is already installed."
4159 #. type: Content of: <refentry><refsect1><refsect2><title>
4160 #: apt_preferences.5.xml:393
4161 msgid "Determination of Package Version and Distribution Properties"
4164 #. type: Content of: <refentry><refsect1><refsect2><para>
4165 #: apt_preferences.5.xml:395
4167 "The locations listed in the &sources-list; file should provide "
4168 "<filename>Packages</filename> and <filename>Release</filename> files to "
4169 "describe the packages available at that location."
4172 #. type: Content of: <refentry><refsect1><refsect2><para>
4173 #: apt_preferences.5.xml:399
4175 "The <filename>Packages</filename> file is normally found in the directory "
4176 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4178 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4179 "consists of a series of multi-line records, one for each package available "
4180 "in that directory. Only two lines in each record are relevant for setting "
4184 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4185 #: apt_preferences.5.xml:407
4186 msgid "the <literal>Package:</literal> line"
4189 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4190 #: apt_preferences.5.xml:408
4191 msgid "gives the package name"
4194 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4195 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
4196 msgid "the <literal>Version:</literal> line"
4199 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4200 #: apt_preferences.5.xml:412
4201 msgid "gives the version number for the named package"
4204 #. type: Content of: <refentry><refsect1><refsect2><para>
4205 #: apt_preferences.5.xml:417
4207 "The <filename>Release</filename> file is normally found in the directory "
4208 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4209 "example, <filename>.../dists/stable/Release</filename>, or "
4210 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4211 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4212 "packages in the directory tree below its parent. Unlike the "
4213 "<filename>Packages</filename> file, nearly all of the lines in a "
4214 "<filename>Release</filename> file are relevant for setting APT priorities:"
4217 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4218 #: apt_preferences.5.xml:428
4219 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4222 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4223 #: apt_preferences.5.xml:429
4225 "names the archive to which all the packages in the directory tree belong. "
4226 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4227 "that all of the packages in the directory tree below the parent of the "
4228 "<filename>Release</filename> file are in a <literal>stable</literal> "
4229 "archive. Specifying this value in the APT preferences file would require "
4233 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4234 #: apt_preferences.5.xml:439
4236 msgid "Pin: release a=stable\n"
4239 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4240 #: apt_preferences.5.xml:445
4241 msgid "the <literal>Codename:</literal> line"
4244 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4245 #: apt_preferences.5.xml:446
4247 "names the codename to which all the packages in the directory tree belong. "
4248 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4249 "the packages in the directory tree below the parent of the "
4250 "<filename>Release</filename> file belong to a version named "
4251 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4252 "preferences file would require the line:"
4255 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4256 #: apt_preferences.5.xml:455
4258 msgid "Pin: release n=&testing-codename;\n"
4261 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4262 #: apt_preferences.5.xml:462
4264 "names the release version. For example, the packages in the tree might "
4265 "belong to Debian release version &stable-version;. Note that there is "
4266 "normally no version number for the <literal>testing</literal> and "
4267 "<literal>unstable</literal> distributions because they have not been "
4268 "released yet. Specifying this in the APT preferences file would require one "
4269 "of the following lines."
4272 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4273 #: apt_preferences.5.xml:471
4276 "Pin: release v=&stable-version;\n"
4277 "Pin: release a=stable, v=&stable-version;\n"
4278 "Pin: release &stable-version;\n"
4281 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4282 #: apt_preferences.5.xml:480
4283 msgid "the <literal>Component:</literal> line"
4286 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4287 #: apt_preferences.5.xml:481
4289 "names the licensing component associated with the packages in the directory "
4290 "tree of the <filename>Release</filename> file. For example, the line "
4291 "\"Component: main\" specifies that all the packages in the directory tree "
4292 "are from the <literal>main</literal> component, which entails that they are "
4293 "licensed under terms listed in the Debian Free Software Guidelines. "
4294 "Specifying this component in the APT preferences file would require the "
4298 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4299 #: apt_preferences.5.xml:490
4301 msgid "Pin: release c=main\n"
4304 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4305 #: apt_preferences.5.xml:496
4306 msgid "the <literal>Origin:</literal> line"
4309 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4310 #: apt_preferences.5.xml:497
4312 "names the originator of the packages in the directory tree of the "
4313 "<filename>Release</filename> file. Most commonly, this is "
4314 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4315 "file would require the line:"
4318 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4319 #: apt_preferences.5.xml:503
4321 msgid "Pin: release o=Debian\n"
4324 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4325 #: apt_preferences.5.xml:509
4326 msgid "the <literal>Label:</literal> line"
4329 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4330 #: apt_preferences.5.xml:510
4332 "names the label of the packages in the directory tree of the "
4333 "<filename>Release</filename> file. Most commonly, this is "
4334 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4335 "file would require the line:"
4338 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4339 #: apt_preferences.5.xml:516
4341 msgid "Pin: release l=Debian\n"
4344 #. type: Content of: <refentry><refsect1><refsect2><para>
4345 #: apt_preferences.5.xml:523
4347 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4348 "files retrieved from locations listed in the &sources-list; file are stored "
4349 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4350 "named by the variable <literal>Dir::State::Lists</literal> in the "
4351 "<filename>apt.conf</filename> file. For example, the file "
4352 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4353 "contains the <filename>Release</filename> file retrieved from the site "
4354 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4355 "architecture files from the <literal>contrib</literal> component of the "
4356 "<literal>unstable</literal> distribution."
4359 #. type: Content of: <refentry><refsect1><refsect2><title>
4360 #: apt_preferences.5.xml:536
4361 msgid "Optional Lines in an APT Preferences Record"
4364 #. type: Content of: <refentry><refsect1><refsect2><para>
4365 #: apt_preferences.5.xml:538
4367 "Each record in the APT preferences file can optionally begin with one or "
4368 "more lines beginning with the word <literal>Explanation:</literal>. This "
4369 "provides a place for comments."
4372 #. type: Content of: <refentry><refsect1><refsect2><title>
4373 #: apt_preferences.5.xml:547
4374 msgid "Tracking Stable"
4377 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4378 #: apt_preferences.5.xml:555
4381 "Explanation: Uninstall or do not install any Debian-originated\n"
4382 "Explanation: package versions other than those in the stable distro\n"
4384 "Pin: release a=stable\n"
4385 "Pin-Priority: 900\n"
4388 "Pin: release o=Debian\n"
4389 "Pin-Priority: -10\n"
4392 #. type: Content of: <refentry><refsect1><refsect2><para>
4393 #: apt_preferences.5.xml:549
4395 "The following APT preferences file will cause APT to assign a priority "
4396 "higher than the default (500) to all package versions belonging to a "
4397 "<literal>stable</literal> distribution and a prohibitively low priority to "
4398 "package versions belonging to other <literal>Debian</literal> "
4399 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4402 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4403 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
4406 "apt-get install <replaceable>package-name</replaceable>\n"
4408 "apt-get dist-upgrade\n"
4411 #. type: Content of: <refentry><refsect1><refsect2><para>
4412 #: apt_preferences.5.xml:567
4414 "With a suitable &sources-list; file and the above preferences file, any of "
4415 "the following commands will cause APT to upgrade to the latest "
4416 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4420 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4421 #: apt_preferences.5.xml:584
4423 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4426 #. type: Content of: <refentry><refsect1><refsect2><para>
4427 #: apt_preferences.5.xml:578
4429 "The following command will cause APT to upgrade the specified package to the "
4430 "latest version from the <literal>testing</literal> distribution; the package "
4431 "will not be upgraded again unless this command is given again. <placeholder "
4432 "type=\"programlisting\" id=\"0\"/>"
4435 #. type: Content of: <refentry><refsect1><refsect2><title>
4436 #: apt_preferences.5.xml:590
4437 msgid "Tracking Testing or Unstable"
4440 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4441 #: apt_preferences.5.xml:599
4445 "Pin: release a=testing\n"
4446 "Pin-Priority: 900\n"
4449 "Pin: release a=unstable\n"
4450 "Pin-Priority: 800\n"
4453 "Pin: release o=Debian\n"
4454 "Pin-Priority: -10\n"
4457 #. type: Content of: <refentry><refsect1><refsect2><para>
4458 #: apt_preferences.5.xml:592
4460 "The following APT preferences file will cause APT to assign a high priority "
4461 "to package versions from the <literal>testing</literal> distribution, a "
4462 "lower priority to package versions from the <literal>unstable</literal> "
4463 "distribution, and a prohibitively low priority to package versions from "
4464 "other <literal>Debian</literal> distributions. <placeholder "
4465 "type=\"programlisting\" id=\"0\"/>"
4468 #. type: Content of: <refentry><refsect1><refsect2><para>
4469 #: apt_preferences.5.xml:613
4471 "With a suitable &sources-list; file and the above preferences file, any of "
4472 "the following commands will cause APT to upgrade to the latest "
4473 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4477 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4478 #: apt_preferences.5.xml:633
4480 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4483 #. type: Content of: <refentry><refsect1><refsect2><para>
4484 #: apt_preferences.5.xml:624
4486 "The following command will cause APT to upgrade the specified package to the "
4487 "latest version from the <literal>unstable</literal> distribution. "
4488 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4489 "the most recent <literal>testing</literal> version if that is more recent "
4490 "than the installed version, otherwise, to the most recent "
4491 "<literal>unstable</literal> version if that is more recent than the "
4492 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4495 #. type: Content of: <refentry><refsect1><refsect2><title>
4496 #: apt_preferences.5.xml:640
4497 msgid "Tracking the evolution of a codename release"
4500 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4501 #: apt_preferences.5.xml:654
4504 "Explanation: Uninstall or do not install any Debian-originated package "
4506 "Explanation: other than those in the distribution codenamed with "
4507 "&testing-codename; or sid\n"
4509 "Pin: release n=&testing-codename;\n"
4510 "Pin-Priority: 900\n"
4512 "Explanation: Debian unstable is always codenamed with sid\n"
4514 "Pin: release n=sid\n"
4515 "Pin-Priority: 800\n"
4518 "Pin: release o=Debian\n"
4519 "Pin-Priority: -10\n"
4522 #. type: Content of: <refentry><refsect1><refsect2><para>
4523 #: apt_preferences.5.xml:642
4525 "The following APT preferences file will cause APT to assign a priority "
4526 "higher than the default (500) to all package versions belonging to a "
4527 "specified codename of a distribution and a prohibitively low priority to "
4528 "package versions belonging to other <literal>Debian</literal> distributions, "
4529 "codenames and archives. Note that with this APT preference APT will follow "
4530 "the migration of a release from the archive <literal>testing</literal> to "
4531 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
4532 "want to follow for example the progress in <literal>testing</literal> "
4533 "notwithstanding the codename changes you should use the example "
4534 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
4537 #. type: Content of: <refentry><refsect1><refsect2><para>
4538 #: apt_preferences.5.xml:671
4540 "With a suitable &sources-list; file and the above preferences file, any of "
4541 "the following commands will cause APT to upgrade to the latest version(s) in "
4542 "the release codenamed with <literal>&testing-codename;</literal>. "
4543 "<placeholder type=\"programlisting\" id=\"0\"/>"
4546 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4547 #: apt_preferences.5.xml:691
4549 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
4552 #. type: Content of: <refentry><refsect1><refsect2><para>
4553 #: apt_preferences.5.xml:682
4555 "The following command will cause APT to upgrade the specified package to the "
4556 "latest version from the <literal>sid</literal> distribution. Thereafter, "
4557 "<command>apt-get upgrade</command> will upgrade the package to the most "
4558 "recent <literal>&testing-codename;</literal> version if that is more recent "
4559 "than the installed version, otherwise, to the most recent "
4560 "<literal>sid</literal> version if that is more recent than the installed "
4561 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
4564 #. type: Content of: <refentry><refsect1><para>
4565 #: apt_preferences.5.xml:706
4566 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
4569 #. type: Content of: <refentry><refnamediv><refpurpose>
4570 #: sources.list.5.xml:33
4571 msgid "List of configured APT data sources"
4574 #. type: Content of: <refentry><refsect1><para>
4575 #: sources.list.5.xml:38
4577 "The source list <filename>/etc/apt/sources.list</filename> is designed to "
4578 "support any number of active sources and a variety of source media. The file "
4579 "lists one source per line, with the most preferred source listed first. The "
4580 "information available from the configured sources is acquired by "
4581 "<command>apt-get update</command> (or by an equivalent command from another "
4585 #. type: Content of: <refentry><refsect1><para>
4586 #: sources.list.5.xml:45
4588 "Each line specifying a source starts with type "
4589 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
4590 "this type. Individual entries cannot be continued onto a following "
4591 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
4592 "on a line marks the remainder of that line as a comment."
4595 #. type: Content of: <refentry><refsect1><title>
4596 #: sources.list.5.xml:53
4597 msgid "sources.list.d"
4600 #. type: Content of: <refentry><refsect1><para>
4601 #: sources.list.5.xml:54
4603 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
4604 "add sources.list entries in separate files. The format is the same as for "
4605 "the regular <filename>sources.list</filename> file. File names need to end "
4606 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
4607 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
4608 "Otherwise APT will print a notice that it has ignored a file, unless that "
4609 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4610 "configuration list - in which case it will be silently ignored."
4613 #. type: Content of: <refentry><refsect1><title>
4614 #: sources.list.5.xml:65
4615 msgid "The deb and deb-src types"
4618 #. type: Content of: <refentry><refsect1><para>
4619 #: sources.list.5.xml:66
4621 "The <literal>deb</literal> type references a typical two-level Debian "
4622 "archive, <filename>distribution/component</filename>. The "
4623 "<literal>distribution</literal> is generally an archive name like "
4624 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
4625 "<literal>&stable-codename;</literal> or "
4626 "<literal>&testing-codename;</literal> while component is one of "
4627 "<literal>main</literal>, <literal>contrib</literal> or "
4628 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
4629 "a Debian distribution's source code in the same form as the "
4630 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
4631 "to fetch source indexes."
4634 #. type: Content of: <refentry><refsect1><para>
4635 #: sources.list.5.xml:78
4637 "The format for a <filename>sources.list</filename> entry using the "
4638 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
4641 #. type: Content of: <refentry><refsect1><literallayout>
4642 #: sources.list.5.xml:81
4644 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
4647 #. type: Content of: <refentry><refsect1><para>
4648 #: sources.list.5.xml:83
4650 "The URI for the <literal>deb</literal> type must specify the base of the "
4651 "Debian distribution, from which APT will find the information it needs. "
4652 "<literal>distribution</literal> can specify an exact path, in which case the "
4653 "components must be omitted and <literal>distribution</literal> must end with "
4654 "a slash (<literal>/</literal>). This is useful for the case when only a "
4655 "particular sub-section of the archive denoted by the URI is of interest. If "
4656 "<literal>distribution</literal> does not specify an exact path, at least one "
4657 "<literal>component</literal> must be present."
4660 #. type: Content of: <refentry><refsect1><para>
4661 #: sources.list.5.xml:92
4663 "<literal>distribution</literal> may also contain a variable, "
4664 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
4665 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
4666 "system. This permits architecture-independent "
4667 "<filename>sources.list</filename> files to be used. In general this is only "
4668 "of interest when specifying an exact path, <literal>APT</literal> will "
4669 "automatically generate a URI with the current architecture otherwise."
4672 #. type: Content of: <refentry><refsect1><para>
4673 #: sources.list.5.xml:100
4675 "Since only one distribution can be specified per line it may be necessary to "
4676 "have multiple lines for the same URI, if a subset of all available "
4677 "distributions or components at that location is desired. APT will sort the "
4678 "URI list after it has generated a complete set internally, and will collapse "
4679 "multiple references to the same Internet host, for instance, into a single "
4680 "connection, so that it does not inefficiently establish an FTP connection, "
4681 "close it, do something else, and then re-establish a connection to that same "
4682 "host. This feature is useful for accessing busy FTP sites with limits on the "
4683 "number of simultaneous anonymous users. APT also parallelizes connections to "
4684 "different hosts to more effectively deal with sites with low bandwidth."
4687 #. type: Content of: <refentry><refsect1><para>
4688 #: sources.list.5.xml:112
4690 "<literal>options</literal> is always optional and needs to be surrounded by "
4691 "square brackets. It can consist of multiple settings in the form "
4692 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
4693 "Multiple settings are separated by spaces. The following settings are "
4694 "supported by APT (note however that unsupported settings will be ignored "
4698 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4699 #: sources.list.5.xml:117
4701 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4702 "can be used to specify for which architectures information should be "
4703 "downloaded. If this option is not set all architectures defined by the "
4704 "<literal>APT::Architectures</literal> option will be downloaded."
4707 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4708 #: sources.list.5.xml:121
4710 "<literal>trusted=yes</literal> can be set to indicate that packages from "
4711 "this source are always authenticated even if the "
4712 "<filename>Release</filename> file is not signed or the signature can't be "
4713 "checked. This disables parts of &apt-secure; and should therefore only be "
4714 "used in a local and trusted context. <literal>trusted=no</literal> is the "
4715 "opposite which handles even correctly authenticated sources as not "
4719 #. type: Content of: <refentry><refsect1><para>
4720 #: sources.list.5.xml:128
4722 "It is important to list sources in order of preference, with the most "
4723 "preferred source listed first. Typically this will result in sorting by "
4724 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
4725 "followed by distant Internet hosts, for example)."
4728 #. type: Content of: <refentry><refsect1><para>
4729 #: sources.list.5.xml:133
4730 msgid "Some examples:"
4733 #. type: Content of: <refentry><refsect1><literallayout>
4734 #: sources.list.5.xml:135
4737 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
4738 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
4743 #. type: Content of: <refentry><refsect1><title>
4744 #: sources.list.5.xml:141
4745 msgid "URI specification"
4748 #. type: Content of: <refentry><refsect1><para>
4749 #: sources.list.5.xml:143
4750 msgid "The currently recognized URI types are:"
4753 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4754 #: sources.list.5.xml:147
4756 "The file scheme allows an arbitrary directory in the file system to be "
4757 "considered an archive. This is useful for NFS mounts and local mirrors or "
4761 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4762 #: sources.list.5.xml:154
4764 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
4765 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
4769 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4770 #: sources.list.5.xml:161
4772 "The http scheme specifies an HTTP server for the archive. If an environment "
4773 "variable <envar>http_proxy</envar> is set with the format "
4774 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
4775 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
4776 "the format http://user:pass@server:port/. Note that this is an insecure "
4777 "method of authentication."
4780 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4781 #: sources.list.5.xml:172
4783 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
4784 "is highly configurable; for more information see the &apt-conf; manual "
4785 "page. Please note that an FTP proxy can be specified by using the "
4786 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
4787 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
4788 "environment variable and <emphasis>only</emphasis> this environment "
4789 "variable. Proxies using HTTP specified in the configuration file will be "
4793 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4794 #: sources.list.5.xml:184
4796 "The copy scheme is identical to the file scheme except that packages are "
4797 "copied into the cache directory instead of used directly at their location. "
4798 "This is useful for people using removable media to copy files around with "
4802 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4803 #: sources.list.5.xml:191
4805 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
4806 "the files as a given user. Prior configuration of rhosts or RSA keys is "
4807 "recommended. The standard <command>find</command> and <command>dd</command> "
4808 "commands are used to perform the file transfers from the remote host."
4811 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4812 #: sources.list.5.xml:198
4813 msgid "adding more recognizable URI types"
4816 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4817 #: sources.list.5.xml:200
4819 "APT can be extended with more methods shipped in other optional packages, "
4820 "which should follow the naming scheme "
4821 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
4822 "instance, the APT team also maintains the package "
4823 "<package>apt-transport-https</package>, which provides access methods for "
4824 "HTTPS URIs with features similar to the http method. Methods for using "
4825 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
4828 #. type: Content of: <refentry><refsect1><para>
4829 #: sources.list.5.xml:212
4831 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
4832 "stable/main, stable/contrib, and stable/non-free."
4835 #. type: Content of: <refentry><refsect1><literallayout>
4836 #: sources.list.5.xml:214
4838 msgid "deb file:/home/jason/debian stable main contrib non-free"
4841 #. type: Content of: <refentry><refsect1><para>
4842 #: sources.list.5.xml:216
4843 msgid "As above, except this uses the unstable (development) distribution."
4846 #. type: Content of: <refentry><refsect1><literallayout>
4847 #: sources.list.5.xml:217
4849 msgid "deb file:/home/jason/debian unstable main contrib non-free"
4852 #. type: Content of: <refentry><refsect1><para>
4853 #: sources.list.5.xml:219
4854 msgid "Source line for the above"
4857 #. type: Content of: <refentry><refsect1><literallayout>
4858 #: sources.list.5.xml:220
4860 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
4863 #. type: Content of: <refentry><refsect1><para>
4864 #: sources.list.5.xml:222
4866 "The first line gets package information for the architectures in "
4867 "<literal>APT::Architectures</literal> while the second always retrieves "
4868 "<literal>amd64</literal> and <literal>armel</literal>."
4871 #. type: Content of: <refentry><refsect1><literallayout>
4872 #: sources.list.5.xml:224
4875 "deb http://ftp.debian.org/debian &stable-codename; main\n"
4876 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
4879 #. type: Content of: <refentry><refsect1><para>
4880 #: sources.list.5.xml:227
4882 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
4886 #. type: Content of: <refentry><refsect1><literallayout>
4887 #: sources.list.5.xml:229
4889 msgid "deb http://archive.debian.org/debian-archive hamm main"
4892 #. type: Content of: <refentry><refsect1><para>
4893 #: sources.list.5.xml:231
4895 "Uses FTP to access the archive at ftp.debian.org, under the debian "
4896 "directory, and uses only the &stable-codename;/contrib area."
4899 #. type: Content of: <refentry><refsect1><literallayout>
4900 #: sources.list.5.xml:233
4902 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
4905 #. type: Content of: <refentry><refsect1><para>
4906 #: sources.list.5.xml:235
4908 "Uses FTP to access the archive at ftp.debian.org, under the debian "
4909 "directory, and uses only the unstable/contrib area. If this line appears as "
4910 "well as the one in the previous example in <filename>sources.list</filename> "
4911 "a single FTP session will be used for both resource lines."
4914 #. type: Content of: <refentry><refsect1><literallayout>
4915 #: sources.list.5.xml:239
4917 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
4920 #. type: Content of: <refentry><refsect1><para><literallayout>
4921 #: sources.list.5.xml:248
4923 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
4926 #. type: Content of: <refentry><refsect1><para>
4927 #: sources.list.5.xml:241
4929 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
4930 "directory, and uses only files found under "
4931 "<filename>unstable/binary-i386</filename> on i386 machines, "
4932 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
4933 "supported architectures. [Note this example only illustrates how to use the "
4934 "substitution variable; official debian archives are not structured like "
4935 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
4938 #. type: Content of: <refentry><refsect1><para>
4939 #: sources.list.5.xml:253
4940 msgid "&apt-cache; &apt-conf;"
4943 #. type: Content of: <refentry><refmeta><manvolnum>
4944 #: apt-extracttemplates.1.xml:26 apt-sortpkgs.1.xml:26 apt-ftparchive.1.xml:26
4948 #. type: Content of: <refentry><refnamediv><refpurpose>
4949 #: apt-extracttemplates.1.xml:33
4951 "Utility to extract <command>debconf</command> config and templates from "
4955 #. type: Content of: <refentry><refsect1><para>
4956 #: apt-extracttemplates.1.xml:39
4958 "<command>apt-extracttemplates</command> will take one or more Debian package "
4959 "files as input and write out (to a temporary directory) all associated "
4960 "config scripts and template files. For each passed in package that contains "
4961 "config scripts and templates, one line of output will be generated in the "
4965 #. type: Content of: <refentry><refsect1><para>
4966 #: apt-extracttemplates.1.xml:44
4967 msgid "package version template-file config-script"
4970 #. type: Content of: <refentry><refsect1><para>
4971 #: apt-extracttemplates.1.xml:45
4973 "template-file and config-script are written to the temporary directory "
4974 "specified by the <option>-t</option> or <option>--tempdir</option> "
4975 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
4976 "filenames of the form <filename>package.template.XXXX</filename> and "
4977 "<filename>package.config.XXXX</filename>"
4980 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4981 #: apt-extracttemplates.1.xml:58
4983 "Temporary directory in which to write extracted <command>debconf</command> "
4984 "template files and config scripts. Configuration Item: "
4985 "<literal>APT::ExtractTemplates::TempDir</literal>"
4988 #. type: Content of: <refentry><refsect1><para>
4989 #: apt-extracttemplates.1.xml:75
4991 "<command>apt-extracttemplates</command> returns zero on normal operation, "
4992 "decimal 100 on error."
4995 #. type: Content of: <refentry><refnamediv><refpurpose>
4996 #: apt-sortpkgs.1.xml:33
4997 msgid "Utility to sort package index files"
5000 #. type: Content of: <refentry><refsect1><para>
5001 #: apt-sortpkgs.1.xml:39
5003 "<command>apt-sortpkgs</command> will take an index file (source index or "
5004 "package index) and sort the records so that they are ordered by the package "
5005 "name. It will also sort the internal fields of each record according to the "
5006 "internal sorting rules."
5009 #. type: Content of: <refentry><refsect1><para>
5010 #: apt-sortpkgs.1.xml:45
5011 msgid "All output is sent to standard output; the input must be a seekable file."
5014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5015 #: apt-sortpkgs.1.xml:54
5017 "Use source index field ordering. Configuration Item: "
5018 "<literal>APT::SortPkgs::Source</literal>."
5021 #. type: Content of: <refentry><refsect1><para>
5022 #: apt-sortpkgs.1.xml:68
5024 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5028 #. type: Content of: <refentry><refnamediv><refpurpose>
5029 #: apt-ftparchive.1.xml:33
5030 msgid "Utility to generate index files"
5033 #. type: Content of: <refentry><refsect1><para>
5034 #: apt-ftparchive.1.xml:39
5036 "<command>apt-ftparchive</command> is the command line tool that generates "
5037 "the index files that APT uses to access a distribution source. The index "
5038 "files should be generated on the origin site based on the content of that "
5042 #. type: Content of: <refentry><refsect1><para>
5043 #: apt-ftparchive.1.xml:43
5045 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5046 "program, incorporating its entire functionality via the "
5047 "<literal>packages</literal> command. It also contains a contents file "
5048 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5049 "the generation process for a complete archive."
5052 #. type: Content of: <refentry><refsect1><para>
5053 #: apt-ftparchive.1.xml:49
5055 "Internally <command>apt-ftparchive</command> can make use of binary "
5056 "databases to cache the contents of a .deb file and it does not rely on any "
5057 "external programs aside from &gzip;. When doing a full generate it "
5058 "automatically performs file-change checks and builds the desired compressed "
5062 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5063 #: apt-ftparchive.1.xml:60
5065 "The packages command generates a package file from a directory tree. It "
5066 "takes the given directory and recursively searches it for .deb files, "
5067 "emitting a package record to stdout for each. This command is approximately "
5068 "equivalent to &dpkg-scanpackages;."
5071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5072 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
5073 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5076 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5077 #: apt-ftparchive.1.xml:70
5079 "The <literal>sources</literal> command generates a source index file from a "
5080 "directory tree. It takes the given directory and recursively searches it "
5081 "for .dsc files, emitting a source record to stdout for each. This command is "
5082 "approximately equivalent to &dpkg-scansources;."
5085 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5086 #: apt-ftparchive.1.xml:75
5088 "If an override file is specified then a source override file will be looked "
5089 "for with an extension of .src. The --source-override option can be used to "
5090 "change the source override file that will be used."
5093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5094 #: apt-ftparchive.1.xml:82
5096 "The <literal>contents</literal> command generates a contents file from a "
5097 "directory tree. It takes the given directory and recursively searches it for "
5098 ".deb files, and reads the file list from each file. It then sorts and writes "
5099 "to stdout the list of files matched to packages. Directories are not written "
5100 "to the output. If multiple packages own the same file then each package is "
5101 "separated by a comma in the output."
5104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5105 #: apt-ftparchive.1.xml:94
5107 "The <literal>release</literal> command generates a Release file from a "
5108 "directory tree. It recursively searches the given directory for uncompressed "
5109 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5110 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5111 "<command>lzma</command> as well as <filename>Release</filename> and "
5112 "<filename>md5sum.txt</filename> files by default "
5113 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5114 "filename patterns can be added by listing them in "
5115 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5116 "stdout a <filename>Release</filename> file containing an MD5, SHA1 and "
5117 "SHA256 digest for each file."
5120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5121 #: apt-ftparchive.1.xml:104
5123 "Values for the additional metadata fields in the Release file are taken from "
5124 "the corresponding variables under "
5125 "<literal>APT::FTPArchive::Release</literal>, "
5126 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5127 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5128 "<literal>Suite</literal>, <literal>Version</literal>, "
5129 "<literal>Codename</literal>, <literal>Date</literal>, "
5130 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5131 "<literal>Components</literal>, <literal>Description</literal>."
5134 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5135 #: apt-ftparchive.1.xml:117
5137 "The <literal>generate</literal> command is designed to be runnable from a "
5138 "cron script and builds indexes according to the given config file. The "
5139 "config language provides a flexible means of specifying which index files "
5140 "are built from which directories, as well as providing a simple means of "
5141 "maintaining the required settings."
5144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5145 #: apt-ftparchive.1.xml:126
5147 "The <literal>clean</literal> command tidies the databases used by the given "
5148 "configuration file by removing any records that are no longer necessary."
5151 #. type: Content of: <refentry><refsect1><title>
5152 #: apt-ftparchive.1.xml:132
5153 msgid "The Generate Configuration"
5156 #. type: Content of: <refentry><refsect1><para>
5157 #: apt-ftparchive.1.xml:134
5159 "The <literal>generate</literal> command uses a configuration file to "
5160 "describe the archives that are going to be generated. It follows the typical "
5161 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5162 "&apt-conf; contains a description of the syntax. Note that the generate "
5163 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5164 "tree manner. This only effects how the scope tag is handled."
5167 #. type: Content of: <refentry><refsect1><para>
5168 #: apt-ftparchive.1.xml:142
5169 msgid "The generate configuration has four separate sections, each described below."
5172 #. type: Content of: <refentry><refsect1><refsect2><title>
5173 #: apt-ftparchive.1.xml:144
5174 msgid "<literal>Dir</literal> Section"
5177 #. type: Content of: <refentry><refsect1><refsect2><para>
5178 #: apt-ftparchive.1.xml:146
5180 "The <literal>Dir</literal> section defines the standard directories needed "
5181 "to locate the files required during the generation process. These "
5182 "directories are prepended certain relative paths defined in later sections "
5183 "to produce a complete an absolute path."
5186 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5187 #: apt-ftparchive.1.xml:153
5189 "Specifies the root of the FTP archive, in a standard Debian configuration "
5190 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5194 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5195 #: apt-ftparchive.1.xml:160
5196 msgid "Specifies the location of the override files."
5199 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5200 #: apt-ftparchive.1.xml:165
5201 msgid "Specifies the location of the cache files."
5204 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5205 #: apt-ftparchive.1.xml:170
5207 "Specifies the location of the file list files, if the "
5208 "<literal>FileList</literal> setting is used below."
5211 #. type: Content of: <refentry><refsect1><refsect2><title>
5212 #: apt-ftparchive.1.xml:176
5213 msgid "<literal>Default</literal> Section"
5216 #. type: Content of: <refentry><refsect1><refsect2><para>
5217 #: apt-ftparchive.1.xml:178
5219 "The <literal>Default</literal> section specifies default values, and "
5220 "settings that control the operation of the generator. Other sections may "
5221 "override these defaults with a per-section setting."
5224 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5225 #: apt-ftparchive.1.xml:184
5227 "Sets the default compression schemes to use for the package index files. It "
5228 "is a string that contains a space separated list of at least one of: '.' (no "
5229 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
5233 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5234 #: apt-ftparchive.1.xml:192
5236 "Sets the default list of file extensions that are package files. This "
5237 "defaults to '.deb'."
5240 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5241 #: apt-ftparchive.1.xml:198
5243 "This is similar to <literal>Packages::Compress</literal> except that it "
5244 "controls the compression for the Sources files."
5247 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5248 #: apt-ftparchive.1.xml:204
5250 "Sets the default list of file extensions that are source files. This "
5251 "defaults to '.dsc'."
5254 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5255 #: apt-ftparchive.1.xml:210
5257 "This is similar to <literal>Packages::Compress</literal> except that it "
5258 "controls the compression for the Contents files."
5261 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5262 #: apt-ftparchive.1.xml:216
5264 "This is similar to <literal>Packages::Compress</literal> except that it "
5265 "controls the compression for the Translation-en master file."
5268 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5269 #: apt-ftparchive.1.xml:222
5271 "Specifies the number of kilobytes to delink (and replace with hard links) "
5272 "per run. This is used in conjunction with the per-section "
5273 "<literal>External-Links</literal> setting."
5276 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5277 #: apt-ftparchive.1.xml:229
5279 "Specifies the mode of all created index files. It defaults to 0644. All "
5280 "index files are set to this mode with no regard to the umask."
5283 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5284 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
5286 "Specifies whether long descriptions should be included in the "
5287 "<filename>Packages</filename> file or split out into a master "
5288 "<filename>Translation-en</filename> file."
5291 #. type: Content of: <refentry><refsect1><refsect2><title>
5292 #: apt-ftparchive.1.xml:242
5293 msgid "<literal>TreeDefault</literal> Section"
5296 #. type: Content of: <refentry><refsect1><refsect2><para>
5297 #: apt-ftparchive.1.xml:244
5299 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
5300 "variables are substitution variables and have the strings $(DIST), "
5301 "$(SECTION) and $(ARCH) replaced with their respective values."
5304 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5305 #: apt-ftparchive.1.xml:251
5307 "Sets the number of kilobytes of contents files that are generated each "
5308 "day. The contents files are round-robined so that over several days they "
5309 "will all be rebuilt."
5312 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5313 #: apt-ftparchive.1.xml:258
5315 "Controls the number of days a contents file is allowed to be checked without "
5316 "changing. If this limit is passed the mtime of the contents file is "
5317 "updated. This case can occur if the package file is changed in such a way "
5318 "that does not result in a new contents file [override edit for instance]. A "
5319 "hold off is allowed in hopes that new .debs will be installed, requiring a "
5320 "new file anyhow. The default is 10, the units are in days."
5323 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5324 #: apt-ftparchive.1.xml:269
5326 "Sets the top of the .deb directory tree. Defaults to "
5327 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
5330 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5331 #: apt-ftparchive.1.xml:275
5333 "Sets the top of the source package directory tree. Defaults to "
5334 "<filename>$(DIST)/$(SECTION)/source/</filename>"
5337 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5338 #: apt-ftparchive.1.xml:281
5340 "Sets the output Packages file. Defaults to "
5341 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
5344 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5345 #: apt-ftparchive.1.xml:287
5347 "Sets the output Sources file. Defaults to "
5348 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
5351 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5352 #: apt-ftparchive.1.xml:293
5354 "Sets the output Translation-en master file with the long descriptions if "
5355 "they should be not included in the Packages file. Defaults to "
5356 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
5359 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5360 #: apt-ftparchive.1.xml:300
5362 "Sets the path prefix that causes a symlink to be considered an internal link "
5363 "instead of an external link. Defaults to "
5364 "<filename>$(DIST)/$(SECTION)/</filename>"
5367 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5368 #: apt-ftparchive.1.xml:307
5370 "Sets the output Contents file. Defaults to "
5371 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
5372 "causes multiple Packages files to map onto a single Contents file (as is the "
5373 "default) then <command>apt-ftparchive</command> will integrate those "
5374 "package files together automatically."
5377 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5378 #: apt-ftparchive.1.xml:316
5379 msgid "Sets header file to prepend to the contents output."
5382 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5383 #: apt-ftparchive.1.xml:321
5385 "Sets the binary cache database to use for this section. Multiple sections "
5386 "can share the same database."
5389 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5390 #: apt-ftparchive.1.xml:327
5392 "Specifies that instead of walking the directory tree, "
5393 "<command>apt-ftparchive</command> should read the list of files from the "
5394 "given file. Relative files names are prefixed with the archive directory."
5397 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5398 #: apt-ftparchive.1.xml:334
5400 "Specifies that instead of walking the directory tree, "
5401 "<command>apt-ftparchive</command> should read the list of files from the "
5402 "given file. Relative files names are prefixed with the archive directory. "
5403 "This is used when processing source indexes."
5406 #. type: Content of: <refentry><refsect1><refsect2><title>
5407 #: apt-ftparchive.1.xml:342
5408 msgid "<literal>Tree</literal> Section"
5411 #. type: Content of: <refentry><refsect1><refsect2><para>
5412 #: apt-ftparchive.1.xml:344
5414 "The <literal>Tree</literal> section defines a standard Debian file tree "
5415 "which consists of a base directory, then multiple sections in that base "
5416 "directory and finally multiple Architectures in each section. The exact "
5417 "pathing used is defined by the <literal>Directory</literal> substitution "
5421 #. type: Content of: <refentry><refsect1><refsect2><para>
5422 #: apt-ftparchive.1.xml:349
5424 "The <literal>Tree</literal> section takes a scope tag which sets the "
5425 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
5426 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
5427 "setting such as <filename>dists/&stable-codename;</filename>."
5430 #. type: Content of: <refentry><refsect1><refsect2><para>
5431 #: apt-ftparchive.1.xml:354
5433 "All of the settings defined in the <literal>TreeDefault</literal> section "
5434 "can be used in a <literal>Tree</literal> section as well as three new "
5438 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5439 #: apt-ftparchive.1.xml:360
5442 "for i in Sections do \n"
5443 " for j in Architectures do\n"
5444 " Generate for DIST=scope SECTION=i ARCH=j\n"
5448 #. type: Content of: <refentry><refsect1><refsect2><para>
5449 #: apt-ftparchive.1.xml:357
5451 "When processing a <literal>Tree</literal> section "
5452 "<command>apt-ftparchive</command> performs an operation similar to: "
5453 "<placeholder type=\"programlisting\" id=\"0\"/>"
5456 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5457 #: apt-ftparchive.1.xml:368
5459 "This is a space separated list of sections which appear under the "
5460 "distribution; typically this is something like <literal>main contrib "
5461 "non-free</literal>"
5464 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5465 #: apt-ftparchive.1.xml:375
5467 "This is a space separated list of all the architectures that appear under "
5468 "search section. The special architecture 'source' is used to indicate that "
5469 "this tree has a source archive."
5472 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5473 #: apt-ftparchive.1.xml:388
5475 "Sets the binary override file. The override file contains section, priority "
5476 "and maintainer address information."
5479 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5480 #: apt-ftparchive.1.xml:394
5482 "Sets the source override file. The override file contains section "
5486 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5487 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
5488 msgid "Sets the binary extra override file."
5491 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5492 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
5493 msgid "Sets the source extra override file."
5496 #. type: Content of: <refentry><refsect1><refsect2><title>
5497 #: apt-ftparchive.1.xml:410
5498 msgid "<literal>BinDirectory</literal> Section"
5501 #. type: Content of: <refentry><refsect1><refsect2><para>
5502 #: apt-ftparchive.1.xml:412
5504 "The <literal>bindirectory</literal> section defines a binary directory tree "
5505 "with no special structure. The scope tag specifies the location of the "
5506 "binary directory and the settings are similar to the <literal>Tree</literal> "
5507 "section with no substitution variables or "
5508 "<literal>Section</literal><literal>Architecture</literal> settings."
5511 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5512 #: apt-ftparchive.1.xml:420
5513 msgid "Sets the Packages file output."
5516 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5517 #: apt-ftparchive.1.xml:425
5519 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
5520 "<literal>Sources</literal> is required."
5523 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5524 #: apt-ftparchive.1.xml:431
5525 msgid "Sets the Contents file output (optional)."
5528 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5529 #: apt-ftparchive.1.xml:436
5530 msgid "Sets the binary override file."
5533 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5534 #: apt-ftparchive.1.xml:441
5535 msgid "Sets the source override file."
5538 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5539 #: apt-ftparchive.1.xml:456
5540 msgid "Sets the cache DB."
5543 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5544 #: apt-ftparchive.1.xml:461
5545 msgid "Appends a path to all the output paths."
5548 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5549 #: apt-ftparchive.1.xml:466
5550 msgid "Specifies the file list file."
5553 #. type: Content of: <refentry><refsect1><title>
5554 #: apt-ftparchive.1.xml:473
5555 msgid "The Binary Override File"
5558 #. type: Content of: <refentry><refsect1><para>
5559 #: apt-ftparchive.1.xml:474
5561 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
5562 "contains four fields separated by spaces. The first field is the package "
5563 "name, the second is the priority to force that package to, the third is the "
5564 "section to force that package to and the final field is the maintainer "
5565 "permutation field."
5568 #. type: Content of: <refentry><refsect1><para><literallayout>
5569 #: apt-ftparchive.1.xml:480
5571 msgid "old [// oldn]* => new"
5574 #. type: Content of: <refentry><refsect1><para><literallayout>
5575 #: apt-ftparchive.1.xml:482
5580 #. type: Content of: <refentry><refsect1><para>
5581 #: apt-ftparchive.1.xml:479
5583 "The general form of the maintainer field is: <placeholder "
5584 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
5585 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
5586 "separated list of old email addresses to be specified. If any of those are "
5587 "found then new is substituted for the maintainer field. The second form "
5588 "unconditionally substitutes the maintainer field."
5591 #. type: Content of: <refentry><refsect1><title>
5592 #: apt-ftparchive.1.xml:490
5593 msgid "The Source Override File"
5596 #. type: Content of: <refentry><refsect1><para>
5597 #: apt-ftparchive.1.xml:492
5599 "The source override file is fully compatible with &dpkg-scansources;. It "
5600 "contains two fields separated by spaces. The first field is the source "
5601 "package name, the second is the section to assign it."
5604 #. type: Content of: <refentry><refsect1><title>
5605 #: apt-ftparchive.1.xml:497
5606 msgid "The Extra Override File"
5609 #. type: Content of: <refentry><refsect1><para>
5610 #: apt-ftparchive.1.xml:499
5612 "The extra override file allows any arbitrary tag to be added or replaced in "
5613 "the output. It has three columns, the first is the package, the second is "
5614 "the tag and the remainder of the line is the new value."
5617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5618 #: apt-ftparchive.1.xml:510
5620 "Generate the given checksum. These options default to on, when turned off "
5621 "the generated index files will not have the checksum fields where possible. "
5622 "Configuration Items: "
5623 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
5624 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
5625 "where <literal><replaceable>Index</replaceable></literal> can be "
5626 "<literal>Packages</literal>, <literal>Sources</literal> or "
5627 "<literal>Release</literal> and "
5628 "<literal><replaceable>Checksum</replaceable></literal> can be "
5629 "<literal>MD5</literal>, <literal>SHA1</literal> or "
5630 "<literal>SHA256</literal>."
5633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5634 #: apt-ftparchive.1.xml:521
5636 "Use a binary caching DB. This has no effect on the generate command. "
5637 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
5640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5641 #: apt-ftparchive.1.xml:527
5643 "Quiet; produces output suitable for logging, omitting progress indicators. "
5644 "More q's will produce more quiet up to a maximum of 2. You can also use "
5645 "<option>-q=#</option> to set the quiet level, overriding the configuration "
5646 "file. Configuration Item: <literal>quiet</literal>."
5649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5650 #: apt-ftparchive.1.xml:535
5652 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
5653 "then this option actually enables delinking of the files. It defaults to on "
5654 "and can be turned off with <option>--no-delink</option>. Configuration "
5655 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
5658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5659 #: apt-ftparchive.1.xml:543
5661 "Perform contents generation. When this option is set and package indexes are "
5662 "being generated with a cache DB then the file listing will also be extracted "
5663 "and stored in the DB for later use. When using the generate command this "
5664 "option also allows the creation of any Contents files. The default is on. "
5665 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
5668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5669 #: apt-ftparchive.1.xml:553
5671 "Select the source override file to use with the <literal>sources</literal> "
5672 "command. Configuration Item: "
5673 "<literal>APT::FTPArchive::SourceOverride</literal>."
5676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5677 #: apt-ftparchive.1.xml:559
5679 "Make the caching databases read only. Configuration Item: "
5680 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
5683 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5684 #: apt-ftparchive.1.xml:564
5686 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
5687 "commands only package files matching <literal>*_arch.deb</literal> or "
5688 "<literal>*_all.deb</literal> instead of all package files in the given "
5689 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
5692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5693 #: apt-ftparchive.1.xml:572
5695 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
5696 "packages are recompiled and/or republished with the same version again, this "
5697 "will lead to problems as the now outdated cached metadata like size and "
5698 "checksums will be used. With this option enabled this will no longer happen "
5699 "as it will be checked if the file was changed. Note that this option is set "
5700 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
5701 "multiply versions/builds of a package with the same versionnumber, so in "
5702 "theory nobody will have these problems and therefore all these extra checks "
5706 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5707 #: apt-ftparchive.1.xml:584
5709 "This configuration option defaults to \"<literal>true</literal>\" and should "
5710 "only be set to <literal>\"false\"</literal> if the Archive generated with "
5711 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
5712 "that the <filename>Translation-en</filename> master file can only be created "
5713 "in the generate command."
5716 #. type: Content of: <refentry><refsect1><para><programlisting>
5717 #: apt-ftparchive.1.xml:602
5720 "<command>apt-ftparchive</command> packages "
5721 "<replaceable>directory</replaceable> | <command>gzip</command> > "
5722 "<filename>Packages.gz</filename>\n"
5725 #. type: Content of: <refentry><refsect1><para>
5726 #: apt-ftparchive.1.xml:598
5728 "To create a compressed Packages file for a directory containing binary "
5729 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
5732 #. type: Content of: <refentry><refsect1><para>
5733 #: apt-ftparchive.1.xml:612
5735 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
5748 msgid "16 June 1998"
5765 msgid "apt - Advanced Package Tool"
5788 "APT is a management system for software packages. For normal day to day "
5789 "package management there are several frontends available, such as "
5790 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
5791 "System. Some options are only implemented in B<apt-get>(8) though."
5803 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
5804 "B<apt_preferences>(5), B<apt-secure>(8)"
5815 msgid "apt returns zero on normal operation, decimal 100 on error."
5826 msgid "This manpage isn't even started."
5832 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
5833 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
5834 "B<reportbug>(1) command."
5845 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
5848 #. type: <title></title>
5850 msgid "APT User's Guide"
5853 #. type: <author></author>
5854 #: guide.sgml:6 offline.sgml:6
5855 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5858 #. type: <version></version>
5860 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5863 #. type: <abstract></abstract>
5866 "This document provides an overview of how to use the the APT package "
5870 #. type: <copyrightsummary></copyrightsummary>
5872 msgid "Copyright © Jason Gunthorpe, 1998."
5876 #: guide.sgml:21 offline.sgml:22
5878 "\"APT\" and this document are free software; you can redistribute them "
5879 "and/or modify them under the terms of the GNU General Public License as "
5880 "published by the Free Software Foundation; either version 2 of the License, "
5881 "or (at your option) any later version."
5885 #: guide.sgml:24 offline.sgml:25
5887 "For more details, on Debian systems, see the file "
5888 "/usr/share/common-licenses/GPL for the full license."
5891 #. type: <heading></heading>
5899 "The APT package currently contains two sections, the APT "
5900 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
5901 "interface. Both provide a way to install and remove packages as well as "
5902 "download new packages from the Internet."
5905 #. type: <heading></heading>
5907 msgid "Anatomy of the Package System"
5913 "The Debian packaging system has a large amount of information associated "
5914 "with each package to help assure that it integrates cleanly and easily into "
5915 "the system. The most prominent of its features is the dependency system."
5921 "The dependency system allows individual programs to make use of shared "
5922 "elements in the system such as libraries. It simplifies placing infrequently "
5923 "used portions of a program in separate packages to reduce the number of "
5924 "things the average user is required to install. Also, it allows for choices "
5925 "in mail transport agents, X servers and so on."
5931 "The first step to understanding the dependency system is to grasp the "
5932 "concept of a simple dependency. The meaning of a simple dependency is that a "
5933 "package requires another package to be installed at the same time to work "
5940 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
5941 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
5942 "simple dependency on GPG. Also, because it is an emacs extension it has a "
5943 "simple dependency on emacs, without emacs it is completely useless."
5949 "The other important dependency to understand is a conflicting dependency. It "
5950 "means that a package, when installed with another package, will not work and "
5951 "may possibly be extremely harmful to the system. As an example consider a "
5952 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
5953 "have two mail transport agents installed because both need to listen to the "
5954 "network to receive mail. Attempting to install two will seriously damage the "
5955 "system so all mail transport agents have a conflicting dependency with all "
5956 "other mail transport agents."
5962 "As an added complication there is the possibility for a package to pretend "
5963 "to be another package. Consider that exim and sendmail for many intents are "
5964 "identical, they both deliver mail and understand a common interface. Hence, "
5965 "the package system has a way for them to declare that they are both "
5966 "mail-transport-agents. So, exim and sendmail both declare that they provide "
5967 "a mail-transport-agent and other packages that need a mail transport agent "
5968 "depend on mail-transport-agent. This can add a great deal of confusion when "
5969 "trying to manually fix packages."
5975 "At any given time a single dependency may be met by packages that are "
5976 "already installed or it may not be. APT attempts to help resolve dependency "
5977 "issues by providing a number of automatic algorithms that help in selecting "
5978 "packages for installation."
5981 #. type: <heading></heading>
5989 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
5990 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
5991 "understand .deb files, it works with the package's proper name and can only "
5992 "install .deb archives from a <em>Source</em>."
5998 "The first <footnote><p>If you are using an http proxy server you must set "
5999 "the http_proxy environment variable first, see "
6000 "sources.list(5)</p></footnote> thing that should be done before using "
6001 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6002 "so that it knows what packages are available. This is done with <tt>apt-get "
6003 "update</tt>. For instance,"
6006 #. type: <example></example>
6010 "# apt-get update\n"
6011 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6012 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6013 "Reading Package Lists... Done\n"
6014 "Building Dependency Tree... Done"
6017 #. type: <p><taglist>
6019 msgid "Once updated there are several commands that can be used:"
6022 #. type: <tag></tag>
6030 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6031 "install a new package or remove an existing package, nor will it ever "
6032 "upgrade a package that might cause some other package to break. This can be "
6033 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6034 "the packages that it could not upgrade, this usually means that they depend "
6035 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6036 "<tt>apt-get install</tt> can be used to force these packages to install."
6039 #. type: <tag></tag>
6047 "Install is used to install packages by name. The package is automatically "
6048 "fetched and installed. This can be useful if you already know the name of "
6049 "the package to install and do not want to go into a GUI to select it. Any "
6050 "number of packages may be passed to install, they will all be "
6051 "fetched. Install automatically attempts to resolve dependency problems with "
6052 "the listed packages and will print a summary and ask for confirmation if "
6053 "anything other than its arguments are changed."
6056 #. type: <tag></tag>
6058 msgid "dist-upgrade"
6064 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6065 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6066 "set of packages to install, upgrade and remove to get as much of the system "
6067 "to the newest release. In some situations it may be desired to use "
6068 "dist-upgrade rather than spend the time manually resolving dependencies in "
6069 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6070 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6077 "It is important to closely look at what dist-upgrade is going to do, its "
6078 "decisions may sometimes be quite surprising."
6084 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6085 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6086 "option is <tt>-d</tt> which does not install the fetched files. If the "
6087 "system has to download a large number of package it would be undesired to "
6088 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6089 "the downloaded archives can be installed by simply running the command that "
6090 "caused them to be downloaded again without <tt>-d</tt>."
6093 #. type: <heading></heading>
6101 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6102 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6103 "to select the packages to be installed or removed and APT actually installs "
6110 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6111 "and then choose the APT method. You will be prompted for a set of "
6112 "<em>Sources</em> which are places to fetch archives from. These can be "
6113 "remote Internet sites, local Debian mirrors or CD-ROMs. Each source can "
6114 "provide a fragment of the total Debian archive, APT will automatically "
6115 "combine them to form a complete set of packages. If you have a CD-ROM then "
6116 "it is a good idea to specify it first and then specify a mirror so that you "
6117 "have access to the latest bug fixes. APT will automatically use packages on "
6118 "your CD-ROM before downloading from the Internet."
6121 #. type: <example></example>
6125 " Set up a list of distribution source locations\n"
6127 " Please give the base URL of the debian distribution.\n"
6128 " The access schemes I know about are: http file\n"
6131 " file:/mnt/debian,\n"
6132 " ftp://ftp.debian.org/debian,\n"
6133 " http://ftp.de.debian.org/debian,\n"
6136 " URL [http://llug.sep.bnl.gov/debian]:"
6142 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6143 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6147 #. type: <example></example>
6151 " Please give the distribution tag to get or a path to the\n"
6152 " package file ending in a /. The distribution\n"
6153 " tags are typically something like: stable unstable testing non-US\n"
6155 " Distribution [stable]:"
6161 "The distribution refers to the Debian version in the archive, "
6162 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6163 "refers to the developmental version. <em>non-US</em> is only available on "
6164 "some mirrors and refers to packages that contain encryption technology or "
6165 "other things that cannot be exported from the United States. Importing these "
6166 "packages into the US is legal however."
6169 #. type: <example></example>
6173 " Please give the components to get\n"
6174 " The components are typically something like: main contrib non-free\n"
6176 " Components [main contrib non-free]:"
6182 "The components list refers to the list of sub distributions to fetch. The "
6183 "distribution is split up based on software licenses, main being DFSG free "
6184 "packages while contrib and non-free contain things that have various "
6185 "restrictions placed on their use and distribution."
6191 "Any number of sources can be added, the setup script will continue to prompt "
6192 "until you have specified all that you want."
6198 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6199 "available list by selecting [U]pdate from the menu. This is a superset of "
6200 "<tt>apt-get update</tt> that makes the fetched information available to "
6201 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6202 "update</tt> has been run before."
6208 "You can then go on and make your selections using [S]elect and then perform "
6209 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6210 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6217 "By default APT will automatically remove the package (.deb) files once they "
6218 "have been successfully installed. To change this behavior place "
6219 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6222 #. type: <heading></heading>
6224 msgid "The Interface"
6230 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6231 "same interface. It is a simple system that generally tells you what it will "
6232 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6233 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6234 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6235 "alone.</p></footnote> After printing out a summary of what will happen APT "
6236 "then will print out some informative status messages so that you can "
6237 "estimate how far along it is and how much is left to do."
6240 #. type: <heading></heading>
6248 "Before all operations except update, APT performs a number of actions to "
6249 "prepare its internal state. It also does some checks of the system's "
6250 "state. At any time these operations can be performed by running <tt>apt-get "
6254 #. type: <example></example>
6259 "Reading Package Lists... Done\n"
6260 "Building Dependency Tree... Done"
6266 "The first thing it does is read all the package files into memory. APT uses "
6267 "a caching scheme so this operation will be faster the second time it is "
6268 "run. If some of the package files are not found then they will be ignored "
6269 "and a warning will be printed when apt-get exits."
6275 "The final operation performs a detailed analysis of the system's "
6276 "dependencies. It checks every dependency of every installed or unpacked "
6277 "package and considers if it is OK. Should this find a problem then a report "
6278 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6281 #. type: <example></example>
6286 "Reading Package Lists... Done\n"
6287 "Building Dependency Tree... Done\n"
6288 "You might want to run apt-get -f install' to correct these.\n"
6289 "Sorry, but the following packages have unmet dependencies:\n"
6290 " 9fonts: Depends: xlib6g but it is not installed\n"
6291 " uucp: Depends: mailx but it is not installed\n"
6292 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6293 " adduser: Depends: perl-base but it is not installed\n"
6294 " aumix: Depends: libgpmg1 but it is not installed\n"
6295 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6296 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6297 " cthugha: Depends: svgalibg1 but it is not installed\n"
6298 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6299 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6305 "In this example the system has many problems, including a serious problem "
6306 "with libreadlineg2. For each package that has unmet dependencies a line is "
6307 "printed out indicating the package with the problem and the dependencies "
6308 "that are unmet. A short explanation of why the package has a dependency "
6309 "problem is also included."
6315 "There are two ways a system can get into a broken state like this. The first "
6316 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6317 "packages when performing upgrades. <footnote><p>APT however considers all "
6318 "known dependencies and attempts to prevent broken "
6319 "packages</p></footnote>. The second is if a package installation fails "
6320 "during an operation. In this situation a package may have been unpacked "
6321 "without its dependents being installed."
6327 "The second situation is much less serious than the first because APT places "
6328 "certain constraints on the order that packages are installed. In both cases "
6329 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6330 "deduce a possible solution to the problem and then continue on. The APT "
6331 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6332 "for easy continuation of failed maintainer scripts."
6338 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6339 "system caused by the first case then it is possible that it will either fail "
6340 "immediately or the installation sequence will fail. In either case it is "
6341 "necessary to manually use dpkg (possibly with forcing options) to correct "
6342 "the situation enough to allow APT to proceed."
6345 #. type: <heading></heading>
6347 msgid "The Status Report"
6353 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6354 "happen. Generally the report reflects the type of operation being performed "
6355 "but there are several common elements. In all cases the lists reflect the "
6356 "final state of things, taking into account the <tt>-f</tt> option and any "
6357 "other relevant activities to the command being executed."
6360 #. type: <heading></heading>
6362 msgid "The Extra Package list"
6365 #. type: <example></example>
6369 "The following extra packages will be installed:\n"
6370 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6371 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6372 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6373 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6380 "The Extra Package list shows all of the packages that will be installed or "
6381 "upgraded in excess of the ones mentioned on the command line. It is only "
6382 "generated for an <tt>install</tt> command. The listed packages are often the "
6383 "result of an Auto Install."
6386 #. type: <heading></heading>
6388 msgid "The Packages to Remove"
6391 #. type: <example></example>
6395 "The following packages will be REMOVED:\n"
6396 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6397 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6398 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6405 "The Packages to Remove list shows all of the packages that will be removed "
6406 "from the system. It can be shown for any of the operations and should be "
6407 "given a careful inspection to ensure nothing important is to be taken "
6408 "off. The <tt>-f</tt> option is especially good at generating packages to "
6409 "remove so extreme care should be used in that case. The list may contain "
6410 "packages that are going to be removed because they are only partially "
6411 "installed, possibly due to an aborted installation."
6414 #. type: <heading></heading>
6416 msgid "The New Packages list"
6419 #. type: <example></example>
6423 "The following NEW packages will installed:\n"
6424 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6430 "The New Packages list is simply a reminder of what will happen. The packages "
6431 "listed are not presently installed in the system but will be when APT is "
6435 #. type: <heading></heading>
6437 msgid "The Kept Back list"
6440 #. type: <example></example>
6444 "The following packages have been kept back\n"
6445 " compface man-db tetex-base msql libpaper svgalib1\n"
6446 " gs snmp arena lynx xpat2 groff xscreensaver"
6452 "Whenever the whole system is being upgraded there is the possibility that "
6453 "new versions of packages cannot be installed because they require new things "
6454 "or conflict with already installed things. In this case the package will "
6455 "appear in the Kept Back list. The best way to convince packages listed there "
6456 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6457 "to resolve their problems."
6460 #. type: <heading></heading>
6462 msgid "Held Packages warning"
6465 #. type: <example></example>
6469 "The following held packages will be changed:\n"
6476 "Sometimes you can ask APT to install a package that is on hold, in such a "
6477 "case it prints out a warning that the held package is going to be "
6478 "changed. This should only happen during dist-upgrade or install."
6481 #. type: <heading></heading>
6483 msgid "Final summary"
6488 msgid "Finally, APT will print out a summary of all the changes that will occur."
6491 #. type: <example></example>
6495 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6497 "12 packages not fully installed or removed.\n"
6498 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6504 "The first line of the summary simply is a reduced version of all of the "
6505 "lists and includes the number of upgrades - that is packages already "
6506 "installed that have new versions available. The second line indicates the "
6507 "number of poorly configured packages, possibly the result of an aborted "
6508 "installation. The final line shows the space requirements that the "
6509 "installation needs. The first pair of numbers refer to the size of the "
6510 "archive files. The first number indicates the number of bytes that must be "
6511 "fetched from remote locations and the second indicates the total size of all "
6512 "the archives required. The next number indicates the size difference between "
6513 "the presently installed packages and the newly installed packages. It is "
6514 "roughly equivalent to the space required in /usr after everything is "
6515 "done. If a large number of packages are being removed then the value may "
6516 "indicate the amount of space that will be freed."
6522 "Some other reports can be generated by using the -u option to show packages "
6523 "to upgrade, they are similar to the previous examples."
6526 #. type: <heading></heading>
6528 msgid "The Status Display"
6534 "During the download of archives and package files APT prints out a series of "
6538 #. type: <example></example>
6542 "# apt-get update\n"
6543 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6544 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6545 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6546 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6548 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6549 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6555 "The lines starting with <em>Get</em> are printed out when APT begins to "
6556 "fetch a file while the last line indicates the progress of the download. The "
6557 "first percent value on the progress line indicates the total percent done of "
6558 "all files. Unfortunately since the size of the Package files is unknown "
6559 "<tt>apt-get update</tt> estimates the percent done which causes some "
6566 "The next section of the status line is repeated once for each download "
6567 "thread and indicates the operation being performed and some useful "
6568 "information about what is happening. Sometimes this section will simply read "
6569 "<em>Forking</em> which means the OS is loading the download module. The "
6570 "first word after the [ is the fetch number as shown on the history "
6571 "lines. The next word is the short form name of the object being "
6572 "downloaded. For archives it will contain the name of the package that is "
6579 "Inside of the single quote is an informative string indicating the progress "
6580 "of the negotiation phase of the download. Typically it progresses from "
6581 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6582 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6583 "the remote site. Once the download begins this is represented as "
6584 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6585 "kilobytes is expected. The total size is always shown in 4 figure notation "
6586 "to preserve space. After the size display is a percent meter for the file "
6587 "itself. The second last element is the instantaneous average speed. This "
6588 "values is updated every 5 seconds and reflects the rate of data transfer for "
6589 "that period. Finally is shown the estimated transfer time. This is updated "
6590 "regularly and reflects the time to complete everything at the shown transfer "
6597 "The status display updates every half second to provide a constant feedback "
6598 "on the download progress while the Get lines scroll back whenever a new file "
6599 "is started. Since the status display is constantly updated it is unsuitable "
6600 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6604 #. type: <heading></heading>
6612 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6613 "to the <prgn>dpkg</prgn> interface once downloading is "
6614 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6615 "processes the packages and the packages themselves may also ask several "
6616 "questions. Before each question there is usually a description of what it is "
6617 "asking and the questions are too varied to discuss completely here."
6620 #. type: <title></title>
6622 msgid "Using APT Offline"
6625 #. type: <version></version>
6627 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6630 #. type: <abstract></abstract>
6633 "This document describes how to use APT in a non-networked environment, "
6634 "specifically a 'sneaker-net' approach for performing upgrades."
6637 #. type: <copyrightsummary></copyrightsummary>
6639 msgid "Copyright © Jason Gunthorpe, 1999."
6642 #. type: <heading></heading>
6644 msgid "Introduction"
6647 #. type: <heading></heading>
6648 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6655 "Normally APT requires direct access to a Debian archive, either from a local "
6656 "media or through a network. Another common complaint is that a Debian "
6657 "machine is on a slow link, such as a modem and another machine has a very "
6658 "fast connection but they are physically distant."
6664 "The solution to this is to use large removable media such as a Zip disc or a "
6665 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6666 "archive but can easily fit a subset large enough for most users. The idea is "
6667 "to use APT to generate a list of packages that are required and then fetch "
6668 "them onto the disc using another machine with good connectivity. It is even "
6669 "possible to use another Debian machine with APT or to use a completely "
6670 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6671 "the machine downloading the packages, and <em>target host</em> the one with "
6672 "bad or no connection."
6678 "This is achieved by creatively manipulating the APT configuration file. The "
6679 "essential premise to tell APT to look on a disc for it's archive files. Note "
6680 "that the disc should be formated with a filesystem that can handle long file "
6681 "names such as ext2, fat32 or vfat."
6684 #. type: <heading></heading>
6686 msgid "Using APT on both machines"
6689 #. type: <p><example>
6692 "APT being available on both machines gives the simplest configuration. The "
6693 "basic idea is to place a copy of the status file on the disc and use the "
6694 "remote machine to fetch the latest package files and decide which packages "
6695 "to download. The disk directory structure should look like:"
6698 #. type: <example></example>
6712 #. type: <heading></heading>
6714 msgid "The configuration file"
6720 "The configuration file should tell APT to store its files on the disc and to "
6721 "use the configuration files on the disc as well. The sources.list should "
6722 "contain the proper sites that you wish to use from the remote machine, and "
6723 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6724 "<em>target host</em>. Please note, if you are using a local archive you must "
6725 "use copy URIs, the syntax is identical to file URIs."
6728 #. type: <p><example>
6731 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6735 #. type: <example></example>
6741 " /* This is not necessary if the two machines are the same arch, it "
6743 " the remote APT what architecture the target machine is */\n"
6744 " Architecture \"i386\";\n"
6746 " Get::Download-Only \"true\";\n"
6751 " /* Use the disc for state information and redirect the status file from\n"
6752 " the /var/lib/dpkg default */\n"
6753 " State \"/disc/\";\n"
6754 " State::status \"status\";\n"
6756 " // Binary caches will be stored locally\n"
6757 " Cache::archives \"/disc/archives/\";\n"
6758 " Cache \"/tmp/\";\n"
6760 " // Location of the source list.\n"
6761 " Etc \"/disc/\";\n"
6765 #. type: </example></p>
6768 "More details can be seen by examining the apt.conf man page and the sample "
6769 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6772 #. type: <p><example>
6775 "On the target machine the first thing to do is mount the disc and copy "
6776 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6777 "directories outlined in the Overview, <em>archives/partial/</em> and "
6778 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6779 "configure the sources.list. On the remote machine execute the following:"
6782 #. type: <example></example>
6786 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6787 " # apt-get update\n"
6788 " [ APT fetches the package files ]\n"
6789 " # apt-get dist-upgrade\n"
6790 " [ APT fetches all the packages needed to upgrade the target machine ]"
6793 #. type: </example></p>
6796 "The dist-upgrade command can be replaced with any other standard APT "
6797 "commands, particularly dselect-upgrade. You can even use an APT front end "
6798 "such as <em>dselect</em>. However this presents a problem in communicating "
6799 "your selections back to the local computer."
6802 #. type: <p><example>
6805 "Now the disc contains all of the index files and archives needed to upgrade "
6806 "the target machine. Take the disc back and run:"
6809 #. type: <example></example>
6813 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6814 " # apt-get check\n"
6815 " [ APT generates a local copy of the cache files ]\n"
6816 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6817 " [ Or any other APT command ]"
6823 "It is necessary for proper function to re-specify the status file to be the "
6824 "local one. This is very important!"
6830 "If you are using dselect you can do the very risky operation of copying "
6831 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6832 "remote machine are updated. I highly recommend that people only make "
6833 "selections on the local machine - but this may not always be possible. DO "
6834 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6837 #. type: <heading></heading>
6839 msgid "Using APT and wget"
6845 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6846 "any machine. Unlike the method above this requires that the Debian machine "
6847 "already has a list of available packages."
6853 "The basic idea is to create a disc that has only the archive files "
6854 "downloaded from the remote site. This is done by using the --print-uris "
6855 "option to apt-get and then preparing a wget script to actually fetch the "
6859 #. type: <heading></heading>
6864 #. type: <p><example>
6867 "Unlike the previous technique no special configuration files are "
6868 "required. We merely use the standard APT commands to generate the file list."
6871 #. type: <example></example>
6875 " # apt-get dist-upgrade \n"
6876 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6877 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6878 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6881 #. type: </example></p>
6884 "Any command other than dist-upgrade could be used here, including "
6891 "The /disc/wget-script file will now contain a list of wget commands to "
6892 "execute in order to fetch the necessary archives. This script should be run "
6893 "with the current directory as the disc's mount point so as to save the "
6894 "output on the disc."
6897 #. type: <p><example>
6899 msgid "The remote machine would do something like"
6902 #. type: <example></example>
6907 " # sh -x ./wget-script\n"
6911 #. type: </example><example>
6914 "Once the archives are downloaded and the disc returned to the Debian machine "
6915 "installation can proceed using,"
6918 #. type: <example></example>
6921 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
6924 #. type: </example></p>
6926 msgid "Which will use the already fetched archives on the disc."