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 1.1~exp12\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2015-09-12 11:06+0200\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.8.xml:21 apt-get.8.xml:22 apt-cache.8.xml:22 apt-key.8.xml:21 apt-mark.8.xml:22 apt-secure.8.xml:21 apt-cdrom.8.xml:21 apt-config.8.xml:22
504 #. type: Content of: <refentry><refmeta><refmiscinfo>
505 #: apt.8.xml:22 apt-get.8.xml:23 apt-cache.8.xml:23 apt-key.8.xml:22 apt-mark.8.xml:23 apt-secure.8.xml:22 apt-cdrom.8.xml:22 apt-config.8.xml:23 apt.conf.5.xml:28 apt_preferences.5.xml:22 sources.list.5.xml:23 apt-extracttemplates.1.xml:23 apt-sortpkgs.1.xml:23 apt-ftparchive.1.xml:23
509 #. type: Content of: <refentry><refnamediv><refpurpose>
511 msgid "command-line interface"
514 #. type: Content of: <refentry><refsect1><title>
515 #: apt.8.xml:33 apt-get.8.xml:34 apt-cache.8.xml:34 apt-key.8.xml:33 apt-mark.8.xml:34 apt-secure.8.xml:46 apt-cdrom.8.xml:33 apt-config.8.xml:34 apt.conf.5.xml:37 apt_preferences.5.xml:32 sources.list.5.xml:32 apt-extracttemplates.1.xml:34 apt-sortpkgs.1.xml:34 apt-ftparchive.1.xml:34
519 #. type: Content of: <refentry><refsect1><para>
522 "<command>apt</command> (Advanced Package Tool) is the command-line tool for "
523 "handling packages. It provides a commandline interface for the package "
524 "management of the system. See also &apt-get; and &apt-cache; for more "
525 "low-level command options."
528 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
531 "<literal>list</literal> is used to display a list of packages. It supports "
532 "shell pattern for matching package names and the following options: "
533 "<option>--installed</option>, <option>--upgradable</option>, "
534 "<option>--upgradeable</option>, <option>--all-versions</option> are "
538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
541 "<literal>search</literal> searches for the given term(s) and display "
545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
548 "<literal>show</literal> shows the package information for the given "
552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
555 "<literal>install</literal> is followed by one or more package names desired "
556 "for installation or upgrading."
559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
560 #: apt.8.xml:72 apt-get.8.xml:112
562 "A specific version of a package can be selected for installation by "
563 "following the package name with an equals and the version of the package to "
564 "select. This will cause that version to be located and selected for "
565 "install. Alternatively a specific distribution can be selected by following "
566 "the package name with a slash and the version of the distribution or the "
567 "Archive name (stable, testing, unstable)."
570 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
571 #: apt.8.xml:82 apt-get.8.xml:147
573 "<literal>remove</literal> is identical to <literal>install</literal> except "
574 "that packages are removed instead of installed. Note that removing a package "
575 "leaves its configuration files on the system. If a plus sign is appended to "
576 "the package name (with no intervening space), the identified package will be "
577 "installed instead of removed."
580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
581 #: apt.8.xml:89 apt-get.8.xml:217 apt-get.8.xml:227
585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
586 #: apt.8.xml:89 apt-get.8.xml:217 apt-get.8.xml:227
587 msgid "alias since 1.1)"
590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
591 #: apt.8.xml:90 apt-get.8.xml:228
593 "<literal>autoremove</literal> is used to remove packages that were "
594 "automatically installed to satisfy dependencies for other packages and are "
595 "now no longer needed."
598 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
601 "<literal>edit-sources</literal> lets you edit your sources.list file and "
602 "provides basic sanity checks."
605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
608 "<literal>update</literal> is used to resynchronize the package index files "
609 "from their sources."
612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
615 "<literal>upgrade</literal> is used to install the newest versions of all "
616 "packages currently installed on the system from the sources enumerated in "
617 "<filename>/etc/apt/sources.list</filename>. New packages will be installed, "
618 "but existing packages will never be removed."
621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
624 "<literal>full-upgrade</literal> performs the function of upgrade but may "
625 "also remove installed packages if that is required in order to resolve a "
629 #. type: Content of: <refentry><refsect1><title>
630 #: apt.8.xml:126 apt-get.8.xml:262 apt-cache.8.xml:246 apt-mark.8.xml:104 apt-config.8.xml:80 apt-extracttemplates.1.xml:48 apt-sortpkgs.1.xml:44 apt-ftparchive.1.xml:500
634 #. type: Content of: <refentry><refsect1><title>
639 #. type: Content of: <refentry><refsect1><para>
642 "The &apt; commandline is designed as a end-user tool and it may change the "
643 "output between versions. While it tries to not break backward compatibility "
644 "there is no guarantee for it either. All features of &apt; are available in "
645 "&apt-cache; and &apt-get; via APT options. Please prefer using these "
646 "commands in your scripts."
649 #. type: Content of: <refentry><refsect1><title>
651 msgid "Differences to &apt-get;"
654 #. type: Content of: <refentry><refsect1><para>
657 "The <command>apt</command> command is meant to be pleasant for end users and "
658 "does not need to be backward compatible like &apt-get;. Therefore some "
659 "options are different:"
662 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
664 msgid "The option <literal>DPkg::Progress-Fancy</literal> is enabled."
667 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
669 msgid "The option <literal>APT::Color</literal> is enabled."
672 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
675 "A new <literal>list</literal> command is available similar to <literal>dpkg "
679 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
682 "The option <literal>upgrade</literal> has <literal>--with-new-pkgs</literal> "
683 "enabled by default."
686 #. type: Content of: <refentry><refsect1><title>
687 #: apt.8.xml:176 apt-get.8.xml:597 apt-cache.8.xml:359 apt-key.8.xml:191 apt-mark.8.xml:127 apt-secure.8.xml:187 apt-cdrom.8.xml:148 apt-config.8.xml:105 apt.conf.5.xml:1321 apt_preferences.5.xml:716 sources.list.5.xml:470 apt-extracttemplates.1.xml:66 apt-sortpkgs.1.xml:59 apt-ftparchive.1.xml:603
691 #. type: Content of: <refentry><refsect1><para>
694 "&apt-get;, &apt-cache;, &sources-list;, &apt-conf;, &apt-config;, The APT "
695 "User's guide in &guidesdir;, &apt-preferences;, the APT Howto."
698 #. type: Content of: <refentry><refsect1><title>
699 #: apt.8.xml:182 apt-get.8.xml:603 apt-cache.8.xml:364 apt-mark.8.xml:131 apt-cdrom.8.xml:153 apt-config.8.xml:110 apt-extracttemplates.1.xml:70 apt-sortpkgs.1.xml:63 apt-ftparchive.1.xml:607
703 #. type: Content of: <refentry><refsect1><para>
706 "<command>apt</command> returns zero on normal operation, decimal 100 on "
710 #. type: Content of: <refentry><refnamediv><refpurpose>
712 msgid "APT package handling utility -- command-line interface"
715 #. type: Content of: <refentry><refsect1><para>
718 "<command>apt-get</command> is the command-line tool for handling packages, "
719 "and may be considered the user's \"back-end\" to other tools using the APT "
720 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
721 "&synaptic; and &wajig;."
724 #. type: Content of: <refentry><refsect1><para>
725 #: apt-get.8.xml:40 apt-cache.8.xml:40 apt-cdrom.8.xml:47 apt-config.8.xml:40 apt-ftparchive.1.xml:50
727 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
728 "one of the commands below must be present."
731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
734 "<literal>update</literal> is used to resynchronize the package index files "
735 "from their sources. The indexes of available packages are fetched from the "
736 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
737 "example, when using a Debian archive, this command retrieves and scans the "
738 "<filename>Packages.gz</filename> files, so that information about new and "
739 "updated packages is available. An <literal>update</literal> should always be "
740 "performed before an <literal>upgrade</literal> or "
741 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
742 "meter will be incorrect as the size of the package files cannot be known in "
746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
749 "<literal>upgrade</literal> is used to install the newest versions of all "
750 "packages currently installed on the system from the sources enumerated in "
751 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
752 "with new versions available are retrieved and upgraded; under no "
753 "circumstances are currently installed packages removed, or packages not "
754 "already installed retrieved and installed. New versions of currently "
755 "installed packages that cannot be upgraded without changing the install "
756 "status of another package will be left at their current version. An "
757 "<literal>update</literal> must be performed first so that "
758 "<command>apt-get</command> knows that new versions of packages are "
762 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
765 "<literal>dist-upgrade</literal> in addition to performing the function of "
766 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
767 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
768 "conflict resolution system, and it will attempt to upgrade the most "
769 "important packages at the expense of less important ones if necessary. The "
770 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
771 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
772 "locations from which to retrieve desired package files. See also "
773 "&apt-preferences; for a mechanism for overriding the general settings for "
774 "individual packages."
777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
780 "<literal>dselect-upgrade</literal> is used in conjunction with the "
781 "traditional Debian packaging front-end, "
782 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
783 "&dselect; to the <literal>Status</literal> field of available packages, and "
784 "performs the actions necessary to realize that state (for instance, the "
785 "removal of old and the installation of new packages)."
788 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
791 "<literal>install</literal> is followed by one or more packages desired for "
792 "installation or upgrading. Each package is a package name, not a fully "
793 "qualified filename (for instance, in a Debian system, "
794 "<package>apt-utils</package> would be the argument provided, not "
795 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
796 "packages required by the package(s) specified for installation will also be "
797 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
798 "file is used to locate the desired packages. If a hyphen is appended to the "
799 "package name (with no intervening space), the identified package will be "
800 "removed if it is installed. Similarly a plus sign can be used to designate "
801 "a package to install. These latter features may be used to override "
802 "decisions made by apt-get's conflict resolution system."
805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
808 "Both of the version selection mechanisms can downgrade packages and must be "
812 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
815 "This is also the target to use if you want to upgrade one or more "
816 "already-installed packages without upgrading every package you have on your "
817 "system. Unlike the \"upgrade\" target, which installs the newest version of "
818 "all currently installed packages, \"install\" will install the newest "
819 "version of only the package(s) specified. Simply provide the name of the "
820 "package(s) you wish to upgrade, and if a newer version is available, it (and "
821 "its dependencies, as described above) will be downloaded and installed."
824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
827 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
828 "installation policy for individual packages."
831 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
834 "If no package matches the given expression and the expression contains one "
835 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
836 "it is applied to all package names in the database. Any matches are then "
837 "installed (or removed). Note that matching is done by substring so 'lo.*' "
838 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
839 "expression with a '^' or '$' character, or create a more specific regular "
843 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
846 "<literal>purge</literal> is identical to <literal>remove</literal> except "
847 "that packages are removed and purged (any configuration files are deleted "
851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
854 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
855 "packages. APT will examine the available packages to decide which source "
856 "package to fetch. It will then find and download into the current directory "
857 "the newest available version of that source package while respecting the "
858 "default release, set with the option "
859 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
860 "per package with the <literal>pkg/release</literal> syntax, if possible."
863 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
866 "Source packages are tracked separately from binary packages via "
867 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
868 "you will need to add such a line for each repository you want to get sources "
869 "from; otherwise you will probably get either the wrong (too old/too new) "
870 "source versions or none at all."
873 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
876 "If the <option>--compile</option> option is specified then the package will "
877 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
878 "the architecture as defined by the <command>--host-architecture</command> "
879 "option. If <option>--download-only</option> is specified then the source "
880 "package will not be unpacked."
883 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
886 "A specific source version can be retrieved by postfixing the source name "
887 "with an equals and then the version to fetch, similar to the mechanism used "
888 "for the package files. This enables exact matching of the source package "
889 "name and version, implicitly enabling the "
890 "<literal>APT::Get::Only-Source</literal> option."
893 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
896 "Note that source packages are not installed and tracked in the "
897 "<command>dpkg</command> database like binary packages; they are simply "
898 "downloaded to the current directory, like source tarballs."
901 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
904 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
905 "attempt to satisfy the build dependencies for a source package. By default "
906 "the dependencies are satisfied to build the package natively. If desired a "
907 "host-architecture can be specified with the "
908 "<option>--host-architecture</option> option instead."
911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
914 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
915 "and checks for broken dependencies."
918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
921 "<literal>download</literal> will download the given binary package into the "
925 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
928 "<literal>clean</literal> clears out the local repository of retrieved "
929 "package files. It removes everything but the lock file from "
930 "<filename>&cachedir;/archives/</filename> and "
931 "<filename>&cachedir;/archives/partial/</filename>."
934 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
937 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
938 "local repository of retrieved package files. The difference is that it only "
939 "removes package files that can no longer be downloaded, and are largely "
940 "useless. This allows a cache to be maintained over a long period without it "
941 "growing out of control. The configuration option "
942 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
943 "being erased if it is set to off."
946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
949 "<literal>changelog</literal> tries to download the changelog of a package "
950 "and displays it through <command>sensible-pager</command>. By default it "
951 "displays the changelog for the version that is installed. However, you can "
952 "specify the same options as for the <option>install</option> command."
955 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
958 "Displays by default a deb822 formatted listing of information about all data "
959 "files (aka index targets) <command>apt-get update</command> would "
960 "download. Supports a <option>--format</option> option to modify the output "
961 "format as well as accepts lines of the default output to filter the records "
962 "by. The command is mainly used as an interface for external tools working "
963 "with APT to get information as well as filenames for downloaded files so "
964 "they can use them as well instead of downloading them again on their "
965 "own. Detailed documentation is omitted here and can instead be found in the "
967 "<literal><filename>doc/acquire-additional-files.txt</filename></literal>."
970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
973 "Do not consider recommended packages as a dependency for installing. "
974 "Configuration Item: <literal>APT::Install-Recommends</literal>."
977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
980 "Consider suggested packages as a dependency for installing. Configuration "
981 "Item: <literal>APT::Install-Suggests</literal>."
984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
987 "Download only; package files are only retrieved, not unpacked or installed. "
988 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
991 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
994 "Fix; attempt to correct a system with broken dependencies in place. This "
995 "option, when used with install/remove, can omit any packages to permit APT "
996 "to deduce a likely solution. If packages are specified, these have to "
997 "completely correct the problem. The option is sometimes necessary when "
998 "running APT for the first time; APT itself does not allow broken package "
999 "dependencies to exist on a system. It is possible that a system's dependency "
1000 "structure can be so corrupt as to require manual intervention (which usually "
1001 "means using <command>dpkg --remove</command> to eliminate some of the "
1002 "offending packages). Use of this option together with <option>-m</option> "
1003 "may produce an error in some situations. Configuration Item: "
1004 "<literal>APT::Get::Fix-Broken</literal>."
1007 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1008 #: apt-get.8.xml:297
1010 "Ignore missing packages; if packages cannot be retrieved or fail the "
1011 "integrity check after retrieval (corrupted package files), hold back those "
1012 "packages and handle the result. Use of this option together with "
1013 "<option>-f</option> may produce an error in some situations. If a package is "
1014 "selected for installation (particularly if it is mentioned on the command "
1015 "line) and it could not be downloaded then it will be silently held back. "
1016 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
1019 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1020 #: apt-get.8.xml:308
1022 "Disables downloading of packages. This is best used with "
1023 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
1024 "already downloaded. Configuration Item: "
1025 "<literal>APT::Get::Download</literal>."
1028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1029 #: apt-get.8.xml:315
1031 "Quiet; produces output suitable for logging, omitting progress indicators. "
1032 "More q's will produce more quiet up to a maximum of 2. You can also use "
1033 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1034 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
1035 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
1036 "may decide to do something you did not expect. Configuration Item: "
1037 "<literal>quiet</literal>."
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1041 #: apt-get.8.xml:330
1043 "No action; perform a simulation of events that would occur based on the "
1044 "current system state but do not actually change the system. Locking will be "
1045 "disabled (<option>Debug::NoLocking</option>) so the system state could "
1046 "change while <command>apt-get</command> is running. Simulations can also be "
1047 "executed by non-root users which might not have read access to all apt "
1048 "configuration distorting the simulation. A notice expressing this warning "
1049 "is also shown by default for non-root users "
1050 "(<option>APT::Get::Show-User-Simulation-Note</option>). Configuration Item: "
1051 "<literal>APT::Get::Simulate</literal>."
1054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1055 #: apt-get.8.xml:340
1057 "Simulated runs print out a series of lines, each representing a "
1058 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
1059 "remove (<literal>Remv</literal>) or unpack "
1060 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
1061 "empty square brackets indicate breaks that are of no consequence (rare)."
1064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1065 #: apt-get.8.xml:348
1067 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
1068 "non-interactively. If an undesirable situation, such as changing a held "
1069 "package, trying to install a unauthenticated package or removing an "
1070 "essential package occurs then <literal>apt-get</literal> will abort. "
1071 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
1074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1075 #: apt-get.8.xml:356
1077 "Automatic \"no\" to all prompts. Configuration Item: "
1078 "<literal>APT::Get::Assume-No</literal>."
1081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1082 #: apt-get.8.xml:361
1084 "Show upgraded packages; print out a list of all packages that are to be "
1085 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
1088 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1089 #: apt-get.8.xml:367
1091 "Show full versions for upgraded and installed packages. Configuration Item: "
1092 "<literal>APT::Get::Show-Versions</literal>."
1095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1096 #: apt-get.8.xml:373
1098 "This option controls the architecture packages are built for by "
1099 "<command>apt-get source --compile</command> and how cross-builddependencies "
1100 "are satisfied. By default is it not set which means that the host "
1101 "architecture is the same as the build architecture (which is defined by "
1102 "<literal>APT::Architecture</literal>). Configuration Item: "
1103 "<literal>APT::Get::Host-Architecture</literal>."
1106 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1107 #: apt-get.8.xml:383
1109 "This option controls the activated build profiles for which a source package "
1110 "is built by <command>apt-get source --compile</command> and how build "
1111 "dependencies are satisfied. By default no build profile is active. More "
1112 "than one build profile can be activated at a time by concatenating them with "
1113 "a comma. Configuration Item: <literal>APT::Build-Profiles</literal>."
1116 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1117 #: apt-get.8.xml:394
1119 "Compile source packages after downloading them. Configuration Item: "
1120 "<literal>APT::Get::Compile</literal>."
1123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1124 #: apt-get.8.xml:399
1126 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
1127 "hold placed on a package. This may be useful in conjunction with "
1128 "<literal>dist-upgrade</literal> to override a large number of undesired "
1129 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
1132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1133 #: apt-get.8.xml:406
1135 "Allow installing new packages when used in conjunction with "
1136 "<literal>upgrade</literal>. This is useful if the update of a installed "
1137 "package requires new dependencies to be installed. Instead of holding the "
1138 "package back <literal>upgrade</literal> will upgrade the package and install "
1139 "the new dependencies. Note that <literal>upgrade</literal> with this option "
1140 "will never remove packages, only allow adding new ones. Configuration Item: "
1141 "<literal>APT::Get::Upgrade-Allow-New</literal>."
1144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1145 #: apt-get.8.xml:418
1147 "Do not upgrade packages; when used in conjunction with "
1148 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
1149 "packages on the command line from being upgraded if they are already "
1150 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
1153 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1154 #: apt-get.8.xml:425
1156 "Do not install new packages; when used in conjunction with "
1157 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
1158 "upgrades for already installed packages only and ignore requests to install "
1159 "new packages. Configuration Item: "
1160 "<literal>APT::Get::Only-Upgrade</literal>."
1163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1164 #: apt-get.8.xml:433
1166 "This is a dangerous option that will cause apt to continue without prompting "
1167 "if it is doing downgrades. It should not be used except in very special "
1168 "situations. Using it can potentially destroy your system! Configuration "
1169 "Item: <literal>APT::Get::allow-downgrades</literal>. Introduced in APT 1.1."
1172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1173 #: apt-get.8.xml:441
1175 "Force yes; this is a dangerous option that will cause apt to continue "
1176 "without prompting if it is removing essentials. It should not be used except "
1177 "in very special situations. Using it can potentially destroy your system! "
1178 "Configuration Item: "
1179 "<literal>APT::Get::allow-remove-essential</literal>. Introduced in APT 1.1."
1182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1183 #: apt-get.8.xml:449
1185 "Force yes; this is a dangerous option that will cause apt to continue "
1186 "without prompting if it is changing held packages. It should not be used "
1187 "except in very special situations. Using it can potentially destroy your "
1188 "system! Configuration Item: "
1189 "<literal>APT::Get::allow-change-held-packages</literal>. Introduced in APT "
1193 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1194 #: apt-get.8.xml:457
1196 "Force yes; this is a dangerous option that will cause apt to continue "
1197 "without prompting if it is doing something potentially harmful. It should "
1198 "not be used except in very special situations. Using "
1199 "<literal>force-yes</literal> can potentially destroy your system! "
1200 "Configuration Item: <literal>APT::Get::force-yes</literal>. This is "
1201 "deprecated and replaced by <option>--allow-downgrades</option>, "
1202 "<option>--allow-remove-essential</option>, "
1203 "<option>--allow-change-held-packages</option> in 1.1."
1206 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1207 #: apt-get.8.xml:465
1209 "Instead of fetching the files to install their URIs are printed. Each URI "
1210 "will have the path, the destination file name, the size and the expected MD5 "
1211 "hash. Note that the file name to write to will not always match the file "
1212 "name on the remote site! This also works with the <literal>source</literal> "
1213 "and <literal>update</literal> commands. When used with the "
1214 "<literal>update</literal> command the MD5 and size are not included, and it "
1215 "is up to the user to decompress any compressed files. Configuration Item: "
1216 "<literal>APT::Get::Print-URIs</literal>."
1219 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1220 #: apt-get.8.xml:476
1222 "Use purge instead of remove for anything that would be removed. An asterisk "
1223 "(\"*\") will be displayed next to packages which are scheduled to be "
1224 "purged. <option>remove --purge</option> is equivalent to the "
1225 "<option>purge</option> command. Configuration Item: "
1226 "<literal>APT::Get::Purge</literal>."
1229 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1230 #: apt-get.8.xml:484
1232 "Re-install packages that are already installed and at the newest version. "
1233 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1236 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1237 #: apt-get.8.xml:489
1239 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1240 "turn it off. When it is on, <command>apt-get</command> will automatically "
1241 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1242 "obsolete files are erased. The only reason to turn it off is if you "
1243 "frequently change your sources list. Configuration Item: "
1244 "<literal>APT::Get::List-Cleanup</literal>."
1247 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1248 #: apt-get.8.xml:499
1250 "This option controls the default input to the policy engine; it creates a "
1251 "default pin at priority 990 using the specified release string. This "
1252 "overrides the general settings in "
1253 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1254 "not affected by the value of this option. In short, this option lets you "
1255 "have simple control over which distribution packages will be retrieved "
1256 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1257 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1258 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1263 #: apt-get.8.xml:514
1265 "Only perform operations that are 'trivial'. Logically this can be considered "
1266 "related to <option>--assume-yes</option>; where "
1267 "<option>--assume-yes</option> will answer yes to any prompt, "
1268 "<option>--trivial-only</option> will answer no. Configuration Item: "
1269 "<literal>APT::Get::Trivial-Only</literal>."
1272 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1273 #: apt-get.8.xml:521
1275 "If any packages are to be removed apt-get immediately aborts without "
1276 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1279 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1280 #: apt-get.8.xml:527
1282 "If the command is either <literal>install</literal> or "
1283 "<literal>remove</literal>, then this option acts like running the "
1284 "<literal>autoremove</literal> command, removing unused dependency "
1285 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1288 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1289 #: apt-get.8.xml:534
1291 "Only has meaning for the <literal>source</literal> and "
1292 "<literal>build-dep</literal> commands. Indicates that the given source "
1293 "names are not to be mapped through the binary table. This means that if "
1294 "this option is specified, these commands will only accept source package "
1295 "names as arguments, rather than accepting binary package names and looking "
1296 "up the corresponding source package. Configuration Item: "
1297 "<literal>APT::Get::Only-Source</literal>."
1300 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1301 #: apt-get.8.xml:545
1303 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1304 "Item: <literal>APT::Get::Diff-Only</literal>, "
1305 "<literal>APT::Get::Dsc-Only</literal>, and "
1306 "<literal>APT::Get::Tar-Only</literal>."
1309 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1310 #: apt-get.8.xml:551
1312 "Only process architecture-dependent build-dependencies. Configuration Item: "
1313 "<literal>APT::Get::Arch-Only</literal>."
1316 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1317 #: apt-get.8.xml:556
1319 "Ignore if packages can't be authenticated and don't prompt about it. This "
1320 "can be useful while working with local repositories, but is a huge security "
1321 "risk if data authenticity isn't ensured in another way by the user itself. "
1322 "The usage of the <option>Trusted</option> option for &sources-list; entries "
1323 "should usually be preferred over this global override. Configuration Item: "
1324 "<literal>APT::Get::AllowUnauthenticated</literal>."
1327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1328 #: apt-get.8.xml:566
1330 "Forbid the update command to acquire unverifiable data from configured "
1331 "sources. Apt will fail at the update command for repositories without valid "
1332 "cryptographically signatures. Configuration Item: "
1333 "<literal>Acquire::AllowInsecureRepositories</literal>."
1336 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1337 #: apt-get.8.xml:574
1339 "Show user friendly progress information in the terminal window when packages "
1340 "are installed, upgraded or removed. For a machine parsable version of this "
1341 "data see README.progress-reporting in the apt doc directory. Configuration "
1342 "Item: <literal>Dpkg::Progress</literal> and "
1343 "<literal>Dpkg::Progress-Fancy</literal>."
1346 #. type: Content of: <refentry><refsect1><title>
1347 #: apt-get.8.xml:587 apt-cache.8.xml:352 apt-key.8.xml:170 apt-mark.8.xml:121 apt.conf.5.xml:1315 apt_preferences.5.xml:709
1351 #. type: Content of: <refentry><refsect1><para>
1352 #: apt-get.8.xml:598
1354 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1355 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1359 #. type: Content of: <refentry><refsect1><para>
1360 #: apt-get.8.xml:604
1362 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1366 #. type: Content of: <refentry><refnamediv><refpurpose>
1367 #: apt-cache.8.xml:29
1368 msgid "query the APT cache"
1371 #. type: Content of: <refentry><refsect1><para>
1372 #: apt-cache.8.xml:35
1374 "<command>apt-cache</command> performs a variety of operations on APT's "
1375 "package cache. <command>apt-cache</command> does not manipulate the state of "
1376 "the system but does provide operations to search and generate interesting "
1377 "output from the package metadata."
1380 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1381 #: apt-cache.8.xml:45
1383 "<literal>gencaches</literal> creates APT's package cache. This is done "
1384 "implicitly by all commands needing this cache if it is missing or outdated."
1387 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1388 #: apt-cache.8.xml:49 apt-cache.8.xml:137 apt-cache.8.xml:161 apt-cache.8.xml:183 apt-cache.8.xml:188 apt-cache.8.xml:204 apt-cache.8.xml:222 apt-cache.8.xml:234
1389 msgid "&synopsis-pkg;"
1392 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1393 #: apt-cache.8.xml:50
1395 "<literal>showpkg</literal> displays information about the packages listed on "
1396 "the command line. Remaining arguments are package names. The available "
1397 "versions and reverse dependencies of each package listed are listed, as well "
1398 "as forward dependencies for each version. Forward (normal) dependencies are "
1399 "those packages upon which the package in question depends; reverse "
1400 "dependencies are those packages that depend upon the package in "
1401 "question. Thus, forward dependencies must be satisfied for a package, but "
1402 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1403 "libreadline2</command> would produce output similar to the following:"
1406 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1407 #: apt-cache.8.xml:62
1410 "Package: libreadline2\n"
1411 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1412 "Reverse Depends: \n"
1413 " libreadlineg2,libreadline2\n"
1414 " libreadline2-altdev,libreadline2\n"
1416 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1419 "Reverse Provides: \n"
1422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1423 #: apt-cache.8.xml:74
1425 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1426 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1427 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1428 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1429 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1430 "installed. For the specific meaning of the remainder of the output it is "
1431 "best to consult the apt source code."
1434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1435 #: apt-cache.8.xml:83
1437 "<literal>stats</literal> displays some statistics about the cache. No "
1438 "further arguments are expected. Statistics reported are:"
1441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1442 #: apt-cache.8.xml:86
1444 "<literal>Total package names</literal> is the number of package names found "
1448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1449 #: apt-cache.8.xml:90
1451 "<literal>Normal packages</literal> is the number of regular, ordinary "
1452 "package names; these are packages that bear a one-to-one correspondence "
1453 "between their names and the names used by other packages for them in "
1454 "dependencies. The majority of packages fall into this category."
1457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1458 #: apt-cache.8.xml:96
1460 "<literal>Pure virtual packages</literal> is the number of packages that "
1461 "exist only as a virtual package name; that is, packages only \"provide\" the "
1462 "virtual package name, and no package actually uses the name. For instance, "
1463 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1464 "several packages provide \"mail-transport-agent\", but there is no package "
1465 "named \"mail-transport-agent\"."
1468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1469 #: apt-cache.8.xml:104
1471 "<literal>Single virtual packages</literal> is the number of packages with "
1472 "only one package providing a particular virtual package. For example, in the "
1473 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1474 "package, xless, provides \"X11-text-viewer\"."
1477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1478 #: apt-cache.8.xml:110
1480 "<literal>Mixed virtual packages</literal> is the number of packages that "
1481 "either provide a particular virtual package or have the virtual package name "
1482 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1483 "an actual package, and provided by the debconf-tiny package."
1486 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1487 #: apt-cache.8.xml:117
1489 "<literal>Missing</literal> is the number of package names that were "
1490 "referenced in a dependency but were not provided by any package. Missing "
1491 "packages may be an evidence if a full distribution is not accessed, or if a "
1492 "package (real or virtual) has been dropped from the distribution. Usually "
1493 "they are referenced from Conflicts or Breaks statements."
1496 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1497 #: apt-cache.8.xml:124
1499 "<literal>Total distinct</literal> versions is the number of package versions "
1500 "found in the cache. If more than one distribution is being accessed (for "
1501 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1502 "larger than the number of total package names."
1505 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1506 #: apt-cache.8.xml:130
1508 "<literal>Total dependencies</literal> is the number of dependency "
1509 "relationships claimed by all of the packages in the cache."
1512 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1513 #: apt-cache.8.xml:138
1515 "<literal>showsrc</literal> displays all the source package records that "
1516 "match the given package names. All versions are shown, as well as all "
1517 "records that declare the name to be a binary package. Use "
1518 "<option>--only-source</option> to display only source package names."
1521 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1522 #: apt-cache.8.xml:147
1524 "<literal>dump</literal> shows a short listing of every package in the "
1525 "cache. It is primarily for debugging."
1528 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1529 #: apt-cache.8.xml:152
1531 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1532 "suitable for use with &dpkg; and is used by the &dselect; method."
1535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1536 #: apt-cache.8.xml:157
1538 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1543 #: apt-cache.8.xml:162
1545 "<literal>show</literal> performs a function similar to <command>dpkg "
1546 "--print-avail</command>; it displays the package records for the named "
1550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1551 #: apt-cache.8.xml:167
1552 msgid "&synopsis-regex;"
1555 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1556 #: apt-cache.8.xml:168
1558 "<literal>search</literal> performs a full text search on all available "
1559 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1560 "the package names and the descriptions for an occurrence of the regular "
1561 "expression and prints out the package name and the short description, "
1562 "including virtual package names. If <option>--full</option> is given then "
1563 "output identical to <literal>show</literal> is produced for each matched "
1564 "package, and if <option>--names-only</option> is given then the long "
1565 "description is not searched, only the package name and provided packages "
1569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1570 #: apt-cache.8.xml:179
1572 "Separate arguments can be used to specify multiple search patterns that are "
1576 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1577 #: apt-cache.8.xml:184
1579 "<literal>depends</literal> shows a listing of each dependency a package has "
1580 "and all the possible other packages that can fulfill that dependency."
1583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1584 #: apt-cache.8.xml:189
1586 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1591 #: apt-cache.8.xml:193
1592 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1595 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1596 #: apt-cache.8.xml:194
1598 "This command prints the name of each package APT knows. The optional "
1599 "argument is a prefix match to filter the name list. The output is suitable "
1600 "for use in a shell tab complete function and the output is generated "
1601 "extremely quickly. This command is best used with the "
1602 "<option>--generate</option> option."
1605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1606 #: apt-cache.8.xml:199
1608 "Note that a package which APT knows of is not necessarily available to "
1609 "download, installable or installed, e.g. virtual packages are also listed in "
1610 "the generated list."
1613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1614 #: apt-cache.8.xml:205
1616 "<literal>dotty</literal> takes a list of packages on the command line and "
1617 "generates output suitable for use by dotty from the <ulink "
1618 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1619 "package. The result will be a set of nodes and edges representing the "
1620 "relationships between the packages. By default the given packages will trace "
1621 "out all dependent packages; this can produce a very large graph. To limit "
1622 "the output to only the packages listed on the command line, set the "
1623 "<literal>APT::Cache::GivenOnly</literal> option."
1626 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1627 #: apt-cache.8.xml:214
1629 "The resulting nodes will have several shapes; normal packages are boxes, "
1630 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1631 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1632 "packages), blue lines are pre-depends, green lines are conflicts."
1635 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1636 #: apt-cache.8.xml:219
1637 msgid "Caution, dotty cannot graph larger sets of packages."
1640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1641 #: apt-cache.8.xml:223
1643 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1644 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1649 #: apt-cache.8.xml:227
1650 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1653 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1654 #: apt-cache.8.xml:228
1656 "<literal>policy</literal> is meant to help debug issues relating to the "
1657 "preferences file. With no arguments it will print out the priorities of each "
1658 "source. Otherwise it prints out detailed information about the priority "
1659 "selection of the named package."
1662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1663 #: apt-cache.8.xml:235
1665 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1666 "to mimic the output format and a subset of the functionality of the Debian "
1667 "archive management tool, <literal>madison</literal>. It displays available "
1668 "versions of a package in a tabular format. Unlike the original "
1669 "<literal>madison</literal>, it can only display information for the "
1670 "architecture for which APT has retrieved package lists "
1671 "(<literal>APT::Architecture</literal>)."
1674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1675 #: apt-cache.8.xml:251
1677 "Select the file to store the package cache. The package cache is the primary "
1678 "cache used by all operations. Configuration Item: "
1679 "<literal>Dir::Cache::pkgcache</literal>."
1682 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1683 #: apt-cache.8.xml:257
1685 "Select the file to store the source cache. The source is used only by "
1686 "<literal>gencaches</literal> and it stores a parsed version of the package "
1687 "information from remote sources. When building the package cache the source "
1688 "cache is used to avoid reparsing all of the package files. Configuration "
1689 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1693 #: apt-cache.8.xml:265
1695 "Quiet; produces output suitable for logging, omitting progress indicators. "
1696 "More q's will produce more quietness up to a maximum of 2. You can also use "
1697 "<option>-q=#</option> to set the quietness level, overriding the "
1698 "configuration file. Configuration Item: <literal>quiet</literal>."
1701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1702 #: apt-cache.8.xml:272
1704 "Print only important dependencies; for use with <literal>unmet</literal> and "
1705 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1706 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1710 #: apt-cache.8.xml:286
1712 "Per default the <command>depends</command> and <command>rdepends</command> "
1713 "print all dependencies. This can be tweaked with these flags which will omit "
1714 "the specified dependency type. Configuration Item: "
1715 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1716 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1720 #: apt-cache.8.xml:294
1722 "Per default <command>depends</command> and <command>rdepends</command> print "
1723 "only dependencies explicitly expressed in the metadata. With this flag it "
1724 "will also show dependencies implicitely added based on the encountered "
1725 "data. A <literal>Conflicts: foo</literal> e.g. expresses implicitely that "
1726 "this package also conflicts with the package foo from any other "
1727 "architecture. Configuration Item: "
1728 "<literal>APT::Cache::ShowImplicit</literal>."
1731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1732 #: apt-cache.8.xml:304
1734 "Print full package records when searching. Configuration Item: "
1735 "<literal>APT::Cache::ShowFull</literal>."
1738 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1739 #: apt-cache.8.xml:309
1741 "Print full records for all available versions. This is the default; to turn "
1742 "it off, use <option>--no-all-versions</option>. If "
1743 "<option>--no-all-versions</option> is specified, only the candidate version "
1744 "will be displayed (the one which would be selected for installation). This "
1745 "option is only applicable to the <literal>show</literal> command. "
1746 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1749 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1750 #: apt-cache.8.xml:318
1752 "Perform automatic package cache regeneration, rather than use the cache as "
1753 "it is. This is the default; to turn it off, use "
1754 "<option>--no-generate</option>. Configuration Item: "
1755 "<literal>APT::Cache::Generate</literal>."
1758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1759 #: apt-cache.8.xml:324
1761 "Only search on the package and provided package names, not the long "
1762 "descriptions. Configuration Item: <literal>APT::Cache::NamesOnly</literal>."
1765 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1766 #: apt-cache.8.xml:329
1768 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1769 "and missing dependencies. Configuration Item: "
1770 "<literal>APT::Cache::AllNames</literal>."
1773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1774 #: apt-cache.8.xml:335
1776 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1777 "that all packages mentioned are printed once. Configuration Item: "
1778 "<literal>APT::Cache::RecurseDepends</literal>."
1781 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1782 #: apt-cache.8.xml:342
1784 "Limit the output of <literal>depends</literal> and "
1785 "<literal>rdepends</literal> to packages which are currently installed. "
1786 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1789 #. type: Content of: <refentry><refsect1><para>
1790 #: apt-cache.8.xml:360
1791 msgid "&apt-conf;, &sources-list;, &apt-get;"
1794 #. type: Content of: <refentry><refsect1><para>
1795 #: apt-cache.8.xml:365
1797 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1801 #. type: Content of: <refentry><refnamediv><refpurpose>
1803 msgid "APT key management utility"
1806 #. type: Content of: <refentry><refsect1><para>
1809 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1810 "authenticate packages. Packages which have been authenticated using these "
1811 "keys will be considered trusted."
1814 #. type: Content of: <refentry><refsect1><title>
1819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1822 "Add a new key to the list of trusted keys. The key is read from the "
1823 "filename given with the parameter &synopsis-param-filename; or if the "
1824 "filename is <literal>-</literal> from standard input."
1827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1829 msgid "Remove a key from the list of trusted keys."
1832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1834 msgid "Output the key &synopsis-param-keyid; to standard output."
1837 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1839 msgid "Output all trusted keys to standard output."
1842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1844 msgid "List trusted keys."
1847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1848 #: apt-key.8.xml:103
1849 msgid "List fingerprints of trusted keys."
1852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1853 #: apt-key.8.xml:114
1855 "Pass advanced options to gpg. With adv --recv-key you can download the "
1859 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1860 #: apt-key.8.xml:126
1862 "Update the local keyring with the archive keyring and remove from the local "
1863 "keyring the archive keys which are no longer valid. The archive keyring is "
1864 "shipped in the <literal>archive-keyring</literal> package of your "
1865 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1868 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1869 #: apt-key.8.xml:140
1871 "Perform an update working similarly to the <command>update</command> command "
1872 "above, but get the archive keyring from a URI instead and validate it "
1873 "against a master key. This requires an installed &wget; and an APT build "
1874 "configured to have a server to fetch from and a master keyring to validate. "
1875 "APT in Debian does not support this command, relying on "
1876 "<command>update</command> instead, but Ubuntu's APT does."
1879 #. type: Content of: <refentry><refsect1><title>
1880 #: apt-key.8.xml:156 apt-cdrom.8.xml:76
1884 #. type: Content of: <refentry><refsect1><para>
1885 #: apt-key.8.xml:157
1887 "Note that options need to be defined before the commands described in the "
1891 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1892 #: apt-key.8.xml:160
1894 "With this option it is possible to specify a particular keyring file the "
1895 "command should operate on. The default is that a command is executed on the "
1896 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1897 "<filename>trusted.gpg.d</filename> directory, though "
1898 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1899 "e.g. new keys are added to this one."
1902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1903 #: apt-key.8.xml:175
1904 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1907 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1908 #: apt-key.8.xml:176
1909 msgid "Local trust database of archive keys."
1912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1913 #: apt-key.8.xml:179
1914 msgid "&keyring-filename;"
1917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1918 #: apt-key.8.xml:180
1919 msgid "Keyring of &keyring-distro; archive trusted keys."
1922 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1923 #: apt-key.8.xml:183
1924 msgid "&keyring-removed-filename;"
1927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1928 #: apt-key.8.xml:184
1929 msgid "Keyring of &keyring-distro; archive removed trusted keys."
1932 #. type: Content of: <refentry><refsect1><para>
1933 #: apt-key.8.xml:193
1934 msgid "&apt-get;, &apt-secure;"
1937 #. type: Content of: <refentry><refnamediv><refpurpose>
1938 #: apt-mark.8.xml:29
1939 msgid "mark/unmark a package as being automatically-installed"
1942 #. type: Content of: <refentry><refsect1><para>
1943 #: apt-mark.8.xml:35
1945 "<command>apt-mark</command> will change whether a package has been marked as "
1946 "being automatically installed."
1949 #. type: Content of: <refentry><refsect1><para>
1950 #: apt-mark.8.xml:39
1952 "When you request that a package is installed, and as a result other packages "
1953 "are installed to satisfy its dependencies, the dependencies are marked as "
1954 "being automatically installed. Once these automatically installed packages "
1955 "are no longer depended on by any manually installed packages, they will be "
1956 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1959 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1960 #: apt-mark.8.xml:48
1962 "<literal>auto</literal> is used to mark a package as being automatically "
1963 "installed, which will cause the package to be removed when no more manually "
1964 "installed packages depend on this package."
1967 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1968 #: apt-mark.8.xml:56
1970 "<literal>manual</literal> is used to mark a package as being manually "
1971 "installed, which will prevent the package from being automatically removed "
1972 "if no other packages depend on it."
1975 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1976 #: apt-mark.8.xml:64
1978 "<literal>hold</literal> is used to mark a package as held back, which will "
1979 "prevent the package from being automatically installed, upgraded or "
1980 "removed. The command is only a wrapper around <command>dpkg "
1981 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1982 "and not affected by the <option>--file</option> option."
1985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1986 #: apt-mark.8.xml:74
1988 "<literal>unhold</literal> is used to cancel a previously set hold on a "
1989 "package to allow all actions again."
1992 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1993 #: apt-mark.8.xml:80
1995 "<literal>showauto</literal> is used to print a list of automatically "
1996 "installed packages with each package on a new line. All automatically "
1997 "installed packages will be listed if no package is given. If packages are "
1998 "given only those which are automatically installed will be shown."
2001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2002 #: apt-mark.8.xml:88
2004 "<literal>showmanual</literal> can be used in the same way as "
2005 "<literal>showauto</literal> except that it will print a list of manually "
2006 "installed packages instead."
2009 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2010 #: apt-mark.8.xml:95
2012 "<literal>showhold</literal> is used to print a list of packages on hold in "
2013 "the same way as for the other show commands."
2016 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2017 #: apt-mark.8.xml:111
2019 "Read/Write package stats from the filename given with the parameter "
2020 "&synopsis-param-filename; instead of from the default location, which is "
2021 "<filename>extended_status</filename> in the directory defined by the "
2022 "Configuration Item: <literal>Dir::State</literal>."
2025 #. type: Content of: <refentry><refsect1><para>
2026 #: apt-mark.8.xml:132
2028 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2032 #. type: Content of: <refentry><refnamediv><refpurpose>
2033 #: apt-secure.8.xml:43
2034 msgid "Archive authentication support for APT"
2037 #. type: Content of: <refentry><refsect1><para>
2038 #: apt-secure.8.xml:48
2040 "Starting with version 0.6, <command>apt</command> contains code that does "
2041 "signature checking of the Release file for all archives. This ensures that "
2042 "packages in the archive can't be modified by people who have no access to "
2043 "the Release file signing key."
2046 #. type: Content of: <refentry><refsect1><para>
2047 #: apt-secure.8.xml:56
2049 "If a package comes from a archive without a signature, or with a signature "
2050 "that apt does not have a key for, that package is considered untrusted, and "
2051 "installing it will result in a big warning. <command>apt-get</command> will "
2052 "currently only warn for unsigned archives; future releases might force all "
2053 "sources to be verified before downloading packages from them."
2056 #. type: Content of: <refentry><refsect1><para>
2057 #: apt-secure.8.xml:65
2059 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2060 "authentication feature."
2063 #. type: Content of: <refentry><refsect1><title>
2064 #: apt-secure.8.xml:70
2065 msgid "Trusted archives"
2068 #. type: Content of: <refentry><refsect1><para>
2069 #: apt-secure.8.xml:73
2071 "The chain of trust from an apt archive to the end user is made up of several "
2072 "steps. <command>apt-secure</command> is the last step in this chain; "
2073 "trusting an archive does not mean that you trust its packages not to contain "
2074 "malicious code, but means that you trust the archive maintainer. It's the "
2075 "archive maintainer's responsibility to ensure that the archive's integrity "
2079 #. type: Content of: <refentry><refsect1><para>
2080 #: apt-secure.8.xml:81
2082 "apt-secure does not review signatures at a package level. If you require "
2083 "tools to do this you should look at <command>debsig-verify</command> and "
2084 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2085 "packages respectively)."
2088 #. type: Content of: <refentry><refsect1><para>
2089 #: apt-secure.8.xml:88
2091 "The chain of trust in Debian starts when a maintainer uploads a new package "
2092 "or a new version of a package to the Debian archive. In order to become "
2093 "effective, this upload needs to be signed by a key contained in the Debian "
2094 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
2095 "keys are signed by other maintainers following pre-established procedures to "
2096 "ensure the identity of the key holder."
2099 #. type: Content of: <refentry><refsect1><para>
2100 #: apt-secure.8.xml:98
2102 "Once the uploaded package is verified and included in the archive, the "
2103 "maintainer signature is stripped off, and checksums of the package are "
2104 "computed and put in the Packages file. The checksums of all of the Packages "
2105 "files are then computed and put into the Release file. The Release file is "
2106 "then signed by the archive key for this &keyring-distro; release, and "
2107 "distributed alongside the packages and the Packages files on "
2108 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2109 "keyring available in the &keyring-package; package."
2112 #. type: Content of: <refentry><refsect1><para>
2113 #: apt-secure.8.xml:109
2115 "End users can check the signature of the Release file, extract a checksum of "
2116 "a package from it and compare it with the checksum of the package they "
2117 "downloaded by hand - or rely on APT doing this automatically."
2120 #. type: Content of: <refentry><refsect1><para>
2121 #: apt-secure.8.xml:114
2123 "Notice that this is distinct from checking signatures on a per package "
2124 "basis. It is designed to prevent two possible attacks:"
2127 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2128 #: apt-secure.8.xml:119
2130 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2131 "checking, malicious agents can introduce themselves into the package "
2132 "download process and provide malicious software either by controlling a "
2133 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2134 "server (through ARP or DNS spoofing attacks)."
2137 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2138 #: apt-secure.8.xml:127
2140 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2141 "malicious agent can compromise a mirror host and modify the files in it to "
2142 "propagate malicious software to all users downloading packages from that "
2146 #. type: Content of: <refentry><refsect1><para>
2147 #: apt-secure.8.xml:134
2149 "However, it does not defend against a compromise of the Debian master server "
2150 "itself (which signs the packages) or against a compromise of the key used to "
2151 "sign the Release files. In any case, this mechanism can complement a "
2152 "per-package signature."
2155 #. type: Content of: <refentry><refsect1><title>
2156 #: apt-secure.8.xml:140
2157 msgid "User configuration"
2160 #. type: Content of: <refentry><refsect1><para>
2161 #: apt-secure.8.xml:142
2163 "<command>apt-key</command> is the program that manages the list of keys used "
2164 "by apt. It can be used to add or remove keys, although an installation of "
2165 "this release will automatically contain the default Debian archive signing "
2166 "keys used in the Debian package repositories."
2169 #. type: Content of: <refentry><refsect1><para>
2170 #: apt-secure.8.xml:149
2172 "In order to add a new key you need to first download it (you should make "
2173 "sure you are using a trusted communication channel when retrieving it), add "
2174 "it with <command>apt-key</command> and then run <command>apt-get "
2175 "update</command> so that apt can download and verify the "
2176 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2177 "from the archives you have configured."
2180 #. type: Content of: <refentry><refsect1><title>
2181 #: apt-secure.8.xml:158
2182 msgid "Archive configuration"
2185 #. type: Content of: <refentry><refsect1><para>
2186 #: apt-secure.8.xml:160
2188 "If you want to provide archive signatures in an archive under your "
2189 "maintenance you have to:"
2192 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2193 #: apt-secure.8.xml:165
2195 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2196 "already. You can do this by running <command>apt-ftparchive "
2197 "release</command> (provided in apt-utils)."
2200 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2201 #: apt-secure.8.xml:170
2203 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2204 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2205 "Release.gpg Release</command>."
2208 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2209 #: apt-secure.8.xml:174
2211 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
2212 "know what key they need to import in order to authenticate the files in the "
2216 #. type: Content of: <refentry><refsect1><para>
2217 #: apt-secure.8.xml:181
2219 "Whenever the contents of the archive change (new packages are added or "
2220 "removed) the archive maintainer has to follow the first two steps outlined "
2224 #. type: Content of: <refentry><refsect1><para>
2225 #: apt-secure.8.xml:189
2227 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2228 "&debsign;, &debsig-verify;, &gpg;"
2231 #. type: Content of: <refentry><refsect1><para>
2232 #: apt-secure.8.xml:193
2234 "For more background information you might want to review the <ulink "
2235 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2236 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2237 "(available also in the harden-doc package) and the <ulink "
2238 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2239 "Distribution HOWTO</ulink> by V. Alex Brennen."
2242 #. type: Content of: <refentry><refsect1><title>
2243 #: apt-secure.8.xml:206
2244 msgid "Manpage Authors"
2247 #. type: Content of: <refentry><refsect1><para>
2248 #: apt-secure.8.xml:208
2250 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2251 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2254 #. type: Content of: <refentry><refnamediv><refpurpose>
2255 #: apt-cdrom.8.xml:28
2256 msgid "APT CD-ROM management utility"
2259 #. type: Content of: <refentry><refsect1><para>
2260 #: apt-cdrom.8.xml:34
2262 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2263 "available sources. <command>apt-cdrom</command> takes care of determining "
2264 "the structure of the disc as well as correcting for several possible "
2265 "mis-burns and verifying the index files."
2268 #. type: Content of: <refentry><refsect1><para>
2269 #: apt-cdrom.8.xml:41
2271 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2272 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2273 "must be inserted and scanned separately to account for possible mis-burns."
2276 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2277 #: apt-cdrom.8.xml:52
2279 "<literal>add</literal> is used to add a new disc to the source list. It will "
2280 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2281 "to scan it and copy the index files. If the disc does not have a proper "
2282 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2286 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2287 #: apt-cdrom.8.xml:60
2289 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2290 "maintains a database of these IDs in "
2291 "<filename>&statedir;/cdroms.list</filename>"
2294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2295 #: apt-cdrom.8.xml:68
2297 "A debugging tool to report the identity of the current disc as well as the "
2301 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2302 #: apt-cdrom.8.xml:81
2304 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2305 "<option>--cdrom</option> option. Configuration Item: "
2306 "<literal>Acquire::cdrom::AutoDetect</literal>."
2309 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2310 #: apt-cdrom.8.xml:89
2312 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2313 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2314 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2318 #: apt-cdrom.8.xml:98
2320 "Rename a disc; change the label of a disc or override the disc's given "
2321 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2322 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2325 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2326 #: apt-cdrom.8.xml:107
2328 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2329 "unmounting the mount point. Configuration Item: "
2330 "<literal>APT::CDROM::NoMount</literal>."
2333 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2334 #: apt-cdrom.8.xml:115
2336 "Fast Copy; Assume the package files are valid and do not check every "
2337 "package. This option should be used only if <command>apt-cdrom</command> has "
2338 "been run on this disc before and did not detect any errors. Configuration "
2339 "Item: <literal>APT::CDROM::Fast</literal>."
2342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2343 #: apt-cdrom.8.xml:125
2345 "Thorough Package Scan; This option may be needed with some old Debian "
2346 "1.1/1.2 discs that have Package files in strange places. It takes much "
2347 "longer to scan the CD but will pick them all up."
2350 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2351 #: apt-cdrom.8.xml:136
2353 "No Changes; Do not change the &sources-list; file and do not write index "
2354 "files. Everything is still checked however. Configuration Item: "
2355 "<literal>APT::CDROM::NoAct</literal>."
2358 #. type: Content of: <refentry><refsect1><para>
2359 #: apt-cdrom.8.xml:149
2360 msgid "&apt-conf;, &apt-get;, &sources-list;"
2363 #. type: Content of: <refentry><refsect1><para>
2364 #: apt-cdrom.8.xml:154
2366 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2370 #. type: Content of: <refentry><refnamediv><refpurpose>
2371 #: apt-config.8.xml:29
2372 msgid "APT Configuration Query program"
2375 #. type: Content of: <refentry><refsect1><para>
2376 #: apt-config.8.xml:35
2378 "<command>apt-config</command> is an internal program used by various "
2379 "portions of the APT suite to provide consistent configurability. It accesses "
2380 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2381 "manner that is easy to use for scripted applications."
2384 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2385 #: apt-config.8.xml:47
2387 "shell is used to access the configuration information from a shell "
2388 "script. It is given pairs of arguments, the first being a shell variable and "
2389 "the second the configuration value to query. As output it lists shell "
2390 "assignment commands for each value present. In a shell script it should be "
2394 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2395 #: apt-config.8.xml:55
2399 "RES=`apt-config shell OPTS MyApp::options`\n"
2403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2404 #: apt-config.8.xml:60
2406 "This will set the shell environment variable $OPTS to the value of "
2407 "MyApp::options with a default of <option>-f</option>."
2410 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2411 #: apt-config.8.xml:64
2413 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2414 "names, d returns directories, b returns true or false and i returns an "
2415 "integer. Each of the returns is normalized and verified internally."
2418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2419 #: apt-config.8.xml:73
2420 msgid "Just show the contents of the configuration space."
2423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2424 #: apt-config.8.xml:86
2426 "Include options which have an empty value. This is the default, so use "
2427 "--no-empty to remove them from the output."
2430 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2431 #: apt-config.8.xml:91
2432 msgid "%f "%v";%n"
2435 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2436 #: apt-config.8.xml:92
2438 "Defines the output of each config option. %t will be replaced with "
2439 "its individual name, %f with its full hierarchical name and %v "
2440 "with its value. Use uppercase letters and special characters in the value "
2441 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2442 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2443 "and %N by a tab. A % can be printed by using %%."
2446 #. type: Content of: <refentry><refsect1><para>
2447 #: apt-config.8.xml:106 apt-extracttemplates.1.xml:67 apt-sortpkgs.1.xml:60 apt-ftparchive.1.xml:604
2451 #. type: Content of: <refentry><refsect1><para>
2452 #: apt-config.8.xml:111
2454 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2458 #. type: Content of: <refentry><refentryinfo><author><contrib>
2459 #: apt.conf.5.xml:16
2460 msgid "Initial documentation of Debug::*."
2463 #. type: Content of: <refentry><refentryinfo><author><email>
2464 #: apt.conf.5.xml:17
2465 msgid "dburrows@debian.org"
2468 #. type: Content of: <refentry><refmeta><manvolnum>
2469 #: apt.conf.5.xml:27 apt_preferences.5.xml:21 sources.list.5.xml:22
2473 #. type: Content of: <refentry><refnamediv><refpurpose>
2474 #: apt.conf.5.xml:34
2475 msgid "Configuration file for APT"
2478 #. type: Content of: <refentry><refsect1><para>
2479 #: apt.conf.5.xml:38
2481 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2482 "by all the tools in the APT suite of tools, though it is by no means the "
2483 "only place options can be set. The suite also shares a common command line "
2484 "parser to provide a uniform environment."
2487 #. type: Content of: <refentry><refsect1><orderedlist><para>
2488 #: apt.conf.5.xml:44
2490 "When an APT tool starts up it will read the configuration files in the "
2494 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2495 #: apt.conf.5.xml:46
2497 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2501 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2502 #: apt.conf.5.xml:48
2504 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2505 "order which have either no or \"<literal>conf</literal>\" as filename "
2506 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2507 "and period (.) characters. Otherwise APT will print a notice that it has "
2508 "ignored a file, unless that file matches a pattern in the "
2509 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2510 "case it will be silently ignored."
2513 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2514 #: apt.conf.5.xml:55
2515 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2518 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2519 #: apt.conf.5.xml:57
2521 "the command line options are applied to override the configuration "
2522 "directives or to load even more configuration files."
2525 #. type: Content of: <refentry><refsect1><title>
2526 #: apt.conf.5.xml:61
2530 #. type: Content of: <refentry><refsect1><para>
2531 #: apt.conf.5.xml:62
2533 "The configuration file is organized in a tree with options organized into "
2534 "functional groups. Option specification is given with a double colon "
2535 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2536 "within the APT tool group, for the Get tool. Options do not inherit from "
2537 "their parent groups."
2540 #. type: Content of: <refentry><refsect1><para>
2541 #: apt.conf.5.xml:68
2543 "Syntactically the configuration language is modeled after what the ISC tools "
2544 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2545 "treated as comments (ignored), as well as all text between "
2546 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2547 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2548 "The quotation marks and trailing semicolon are required. The value must be "
2549 "on one line, and there is no kind of string concatenation. Values must not "
2550 "include backslashes or extra quotation marks. Option names are made up of "
2551 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2552 "opened with curly braces, like this:"
2555 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2556 #: apt.conf.5.xml:81
2561 " Assume-Yes \"true\";\n"
2562 " Fix-Broken \"true\";\n"
2567 #. type: Content of: <refentry><refsect1><para>
2568 #: apt.conf.5.xml:89
2570 "with newlines placed to make it more readable. Lists can be created by "
2571 "opening a scope and including a single string enclosed in quotes followed by "
2572 "a semicolon. Multiple entries can be included, separated by a semicolon."
2575 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2576 #: apt.conf.5.xml:94
2578 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2581 #. type: Content of: <refentry><refsect1><para>
2582 #: apt.conf.5.xml:97
2584 "In general the sample configuration file &configureindex; is a good guide "
2585 "for how it should look."
2588 #. type: Content of: <refentry><refsect1><para>
2589 #: apt.conf.5.xml:100
2591 "Case is not significant in names of configuration items, so in the previous "
2592 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2595 #. type: Content of: <refentry><refsect1><para>
2596 #: apt.conf.5.xml:103
2598 "Names for the configuration items are optional if a list is defined as can "
2599 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2600 "you don't specify a name a new entry will simply add a new option to the "
2601 "list. If you specify a name you can override the option in the same way as "
2602 "any other option by reassigning a new value to the option."
2605 #. type: Content of: <refentry><refsect1><para>
2606 #: apt.conf.5.xml:108
2608 "Two special commands are defined: <literal>#include</literal> (which is "
2609 "deprecated and not supported by alternative implementations) and "
2610 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2611 "given file, unless the filename ends in a slash, in which case the whole "
2612 "directory is included. <literal>#clear</literal> is used to erase a part of "
2613 "the configuration tree. The specified element and all its descendants are "
2614 "erased. (Note that these lines also need to end with a semicolon.)"
2617 #. type: Content of: <refentry><refsect1><para>
2618 #: apt.conf.5.xml:118
2620 "The <literal>#clear</literal> command is the only way to delete a list or a "
2621 "complete scope. Reopening a scope (or using the syntax described below with "
2622 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2623 "previously written entries. Options can only be overridden by addressing a "
2624 "new value to them - lists and scopes can't be overridden, only cleared."
2627 #. type: Content of: <refentry><refsect1><para>
2628 #: apt.conf.5.xml:126
2630 "All of the APT tools take an -o option which allows an arbitrary "
2631 "configuration directive to be specified on the command line. The syntax is a "
2632 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2633 "followed by an equals sign then the new value of the option. To append a new "
2634 "element to a list, add a trailing <literal>::</literal> to the name of the "
2635 "list. (As you might suspect, the scope syntax can't be used on the command "
2639 #. type: Content of: <refentry><refsect1><para>
2640 #: apt.conf.5.xml:134
2642 "Note that appending items to a list using <literal>::</literal> only works "
2643 "for one item per line, and that you should not use it in combination with "
2644 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2645 "syntaxes together will trigger a bug which some users unfortunately depend "
2646 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2647 "like every other option with a name. This introduces many problems; for one "
2648 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2649 "syntax in the hope of appending to a list will achieve the opposite, as only "
2650 "the last assignment for this option \"<literal>::</literal>\" will be "
2651 "used. Future versions of APT will raise errors and stop working if they "
2652 "encounter this misuse, so please correct such statements now while APT "
2653 "doesn't explicitly complain about them."
2656 #. type: Content of: <refentry><refsect1><title>
2657 #: apt.conf.5.xml:149
2658 msgid "The APT Group"
2661 #. type: Content of: <refentry><refsect1><para>
2662 #: apt.conf.5.xml:150
2664 "This group of options controls general APT behavior as well as holding the "
2665 "options for all of the tools."
2668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2669 #: apt.conf.5.xml:155
2671 "System Architecture; sets the architecture to use when fetching files and "
2672 "parsing package lists. The internal default is the architecture apt was "
2676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2677 #: apt.conf.5.xml:162
2679 "All Architectures the system supports. For instance, CPUs implementing the "
2680 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2681 "instruction set are also able to execute binaries compiled for the "
2682 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2683 "is used when fetching files and parsing package lists. The initial default "
2684 "is always the system's native architecture "
2685 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2686 "to the default list when they are registered via <command>dpkg "
2687 "--add-architecture</command>."
2690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2691 #: apt.conf.5.xml:176
2693 "List of all build profiles enabled for build-dependency resolution, without "
2694 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2695 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2696 "&dpkg-buildpackage; overrides the list notation."
2699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2700 #: apt.conf.5.xml:184
2702 "Default release to install packages from if more than one version is "
2703 "available. Contains release name, codename or release version. Examples: "
2704 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2705 "'4.0', '5.0*'. See also &apt-preferences;."
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2709 #: apt.conf.5.xml:190
2711 "Ignore held packages; this global option causes the problem resolver to "
2712 "ignore held packages in its decision making."
2715 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2716 #: apt.conf.5.xml:195
2718 "Defaults to on. When turned on the autoclean feature will remove any "
2719 "packages which can no longer be downloaded from the cache. If turned off "
2720 "then packages that are locally installed are also excluded from cleaning - "
2721 "but note that APT provides no direct means to reinstall them."
2724 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2725 #: apt.conf.5.xml:203
2727 "Defaults to on, which will cause APT to install essential and important "
2728 "packages as soon as possible in an install/upgrade operation, in order to "
2729 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2730 "treats an important package in the same way as an extra package: between the "
2731 "unpacking of the package A and its configuration there can be many other "
2732 "unpack or configuration calls for other unrelated packages B, C etc. If "
2733 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2734 "scripts generate an error), this results in a system state in which package "
2735 "A is unpacked but unconfigured - so any package depending on A is now no "
2736 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2739 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2740 #: apt.conf.5.xml:215
2742 "The immediate configuration marker is also applied in the potentially "
2743 "problematic case of circular dependencies, since a dependency with the "
2744 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2745 "to recognise a situation in which it is unable to perform immediate "
2746 "configuration, abort, and suggest to the user that the option should be "
2747 "temporarily deactivated in order to allow the operation to proceed. Note "
2748 "the use of the word \"theory\" here; in the real world this problem has "
2749 "rarely been encountered, in non-stable distribution versions, and was caused "
2750 "by wrong dependencies of the package in question or by a system in an "
2751 "already broken state; so you should not blindly disable this option, as the "
2752 "scenario mentioned above is not the only problem it can help to prevent in "
2756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2757 #: apt.conf.5.xml:228
2759 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2760 "option disabled you should try to explicitly <literal>install</literal> the "
2761 "package APT is unable to configure immediately; but please make sure you "
2762 "also report your problem to your distribution and to the APT team with the "
2763 "buglink below, so they can work on improving or correcting the upgrade "
2767 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2768 #: apt.conf.5.xml:239
2770 "Never enable this option unless you <emphasis>really</emphasis> know what "
2771 "you are doing. It permits APT to temporarily remove an essential package to "
2772 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2773 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2774 "bug</emphasis>. This option will work if the essential packages are not "
2775 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2776 "<command>dpkg</command>, <command>dash</command> or anything that those "
2777 "packages depend on."
2780 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2781 #: apt.conf.5.xml:251
2783 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2784 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2785 "the size the cache will grow to, and is therefore the amount of memory APT "
2786 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2787 "that this amount of space needs to be available for APT; otherwise it will "
2788 "likely fail ungracefully, so for memory restricted devices this value should "
2789 "be lowered while on systems with a lot of configured sources it should be "
2790 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2791 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2792 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2793 "value will be applied again and again until either the cache is big enough "
2794 "to store all information or the size of the cache reaches the "
2795 "<literal>Cache-Limit</literal>. The default of "
2796 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2797 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2801 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2802 #: apt.conf.5.xml:267
2803 msgid "Defines which packages are considered essential build dependencies."
2806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2807 #: apt.conf.5.xml:271
2809 "The Get subsection controls the &apt-get; tool; please see its documentation "
2810 "for more information about the options here."
2813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2814 #: apt.conf.5.xml:276
2816 "The Cache subsection controls the &apt-cache; tool; please see its "
2817 "documentation for more information about the options here."
2820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2821 #: apt.conf.5.xml:281
2823 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2824 "documentation for more information about the options here."
2827 #. type: Content of: <refentry><refsect1><title>
2828 #: apt.conf.5.xml:287
2829 msgid "The Acquire Group"
2832 #. type: Content of: <refentry><refsect1><para>
2833 #: apt.conf.5.xml:288
2835 "The <literal>Acquire</literal> group of options controls the download of "
2836 "packages as well as the various \"acquire methods\" responsible for the "
2837 "download itself (see also &sources-list;)."
2840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2841 #: apt.conf.5.xml:295
2843 "Security related option defaulting to true, as giving a Release file's "
2844 "validation an expiration date prevents replay attacks over a long timescale, "
2845 "and can also for example help users to identify mirrors that are no longer "
2846 "updated - but the feature depends on the correctness of the clock on the "
2847 "user system. Archive maintainers are encouraged to create Release files with "
2848 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2849 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2850 "used. The <option>Check-Valid-Until</option> option of &sources-list; "
2851 "entries should be preferred to disable the check selectively instead of "
2852 "using this global override."
2855 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2856 #: apt.conf.5.xml:310
2858 "Maximum time (in seconds) after its creation (as indicated by the "
2859 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2860 "should be considered valid. If the Release file itself includes a "
2861 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2862 "the expiration date. The default value is <literal>0</literal> which stands "
2863 "for \"valid forever\". Archive specific settings can be made by appending "
2864 "the label of the archive to the option name. Preferably, the same can be "
2865 "achieved for specific &sources-list; entries by using the "
2866 "<option>Valid-Until-Max</option> option there."
2869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2870 #: apt.conf.5.xml:323
2872 "Minimum time (in seconds) after its creation (as indicated by the "
2873 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2874 "should be considered valid. Use this if you need to use a seldom updated "
2875 "(local) mirror of a more frequently updated archive with a "
2876 "<literal>Valid-Until</literal> header instead of completely disabling the "
2877 "expiration date checking. Archive specific settings can and should be used "
2878 "by appending the label of the archive to the option name. Preferably, the "
2879 "same can be achieved for specific &sources-list; entries by using the "
2880 "<option>Valid-Until-Min</option> option there."
2883 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2884 #: apt.conf.5.xml:336
2886 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2887 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2888 "by default. Preferably, this can be set for specific &sources-list; entries "
2889 "or index files by using the <option>PDiffs</option> option there."
2892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2893 #: apt.conf.5.xml:341
2895 "Two sub-options to limit the use of PDiffs are also available: "
2896 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2897 "PDiff files should be downloaded to update a "
2898 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2899 "percentage of the size of all patches compared to the size of the targeted "
2900 "file. If one of these limits is exceeded the complete file is downloaded "
2901 "instead of the patches."
2904 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2905 #: apt.conf.5.xml:351
2907 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2908 "<literal>host</literal> or <literal>access</literal> which determines how "
2909 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2910 "one connection per target host will be opened, <literal>access</literal> "
2911 "means that one connection per URI type will be opened."
2914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2915 #: apt.conf.5.xml:359
2917 "Number of retries to perform. If this is non-zero APT will retry failed "
2918 "files the given number of times."
2921 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2922 #: apt.conf.5.xml:364
2924 "Use symlinks for source archives. If set to true then source archives will "
2925 "be symlinked when possible instead of copying. True is the default."
2928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2929 #: apt.conf.5.xml:369
2931 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2932 "URIs. It is in the standard form of "
2933 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2934 "can also be specified by using the form "
2935 "<literal>http::Proxy::<host></literal> with the special keyword "
2936 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2937 "settings is specified, <envar>http_proxy</envar> environment variable will "
2941 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2942 #: apt.conf.5.xml:377
2944 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2945 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2946 "response under any circumstances. <literal>Max-Age</literal> sets the "
2947 "allowed maximum age (in seconds) of an index file in the cache of the "
2948 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2949 "store the requested archive files in its cache, which can be used to prevent "
2950 "the proxy from polluting its cache with (big) .deb files."
2953 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2954 #: apt.conf.5.xml:387 apt.conf.5.xml:475
2956 "The option <literal>timeout</literal> sets the timeout timer used by the "
2957 "method; this value applies to the connection as well as the data timeout."
2960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2961 #: apt.conf.5.xml:390
2963 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2964 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2965 "e.g. on high-latency connections. It specifies how many requests are sent in "
2966 "a pipeline. APT tries to detect and workaround misbehaving webservers and "
2967 "proxies at runtime, but if you know that yours does not conform to the "
2968 "HTTP/1.1 specification pipelining can be disabled by setting the value to "
2969 "0. It is enabled by default with the value 10."
2972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2973 #: apt.conf.5.xml:397
2975 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
2976 "follow redirects, which is enabled by default."
2979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2980 #: apt.conf.5.xml:400
2982 "The used bandwidth can be limited with "
2983 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
2984 "kilobytes per second. The default value is 0 which deactivates the limit and "
2985 "tries to use all available bandwidth. Note that this option implicitly "
2986 "disables downloading from multiple servers at the same time."
2989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2990 #: apt.conf.5.xml:407
2992 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
2993 "User-Agent for the http download method as some proxies allow access for "
2994 "clients only if the client uses a known identifier."
2997 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2998 #: apt.conf.5.xml:411
3000 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
3001 "an external command to discover the http proxy to use. Apt expects the "
3002 "command to output the proxy on stdout in the style "
3003 "<literal>http://proxy:port/</literal>. This will override the generic "
3004 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
3005 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
3006 "the &squid-deb-proxy-client; package for an example implementation that uses "
3007 "avahi. This option takes precedence over the legacy option name "
3008 "<literal>ProxyAutoDetect</literal>."
3011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3012 #: apt.conf.5.xml:429
3014 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
3015 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
3016 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
3017 "the <literal>http</literal> method, and default to the same values if they "
3018 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
3022 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3023 #: apt.conf.5.xml:437
3025 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3026 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
3027 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3028 "suboption determines whether or not the server's host certificate should be "
3029 "verified against trusted certificates. "
3030 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
3031 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
3032 "or not the server's hostname should be verified. "
3033 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
3034 "option. <literal>SslCert</literal> determines what certificate to use for "
3035 "client authentication. <literal><host>::SslCert</literal> is the "
3036 "corresponding per-host option. <literal>SslKey</literal> determines what "
3037 "private key to use for client "
3038 "authentication. <literal><host>::SslKey</literal> is the corresponding "
3039 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3040 "version to use. It can contain either of the strings "
3041 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
3042 "<literal><host>::SslForceVersion</literal> is the corresponding "
3046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3047 #: apt.conf.5.xml:458
3049 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
3050 "It is in the standard form of "
3051 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
3052 "also be specified by using the form "
3053 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3054 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3055 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3056 "used. To use an FTP proxy you will have to set the "
3057 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3058 "entry specifies the commands to send to tell the proxy server what to "
3059 "connect to. Please see &configureindex; for an example of how to do "
3060 "this. The substitution variables representing the corresponding URI "
3061 "component are <literal>$(PROXY_USER)</literal>, "
3062 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
3063 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
3064 "<literal>$(SITE_PORT)</literal>."
3067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3068 #: apt.conf.5.xml:478
3070 "Several settings are provided to control passive mode. Generally it is safe "
3071 "to leave passive mode on; it works in nearly every environment. However, "
3072 "some situations require that passive mode be disabled and port mode FTP used "
3073 "instead. This can be done globally or for connections that go through a "
3074 "proxy or for a specific host (see the sample config file for examples)."
3077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3078 #: apt.conf.5.xml:485
3080 "It is possible to proxy FTP over HTTP by setting the "
3081 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3082 "discussion of the http method above for syntax. You cannot set this in the "
3083 "configuration file and it is not recommended to use FTP over HTTP due to its "
3087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3088 #: apt.conf.5.xml:490
3090 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3091 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3092 "false, which means these commands are only used if the control connection is "
3093 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3094 "that most FTP servers do not support RFC2428."
3097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3098 #: apt.conf.5.xml:504
3100 msgid "/cdrom/::Mount \"foo\";"
3103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3104 #: apt.conf.5.xml:499
3106 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3107 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3108 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3109 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3110 "and unmount commands if your mount point cannot be listed in the fstab. The "
3111 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3112 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3113 "Unmount commands can be specified using UMount."
3116 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3117 #: apt.conf.5.xml:512
3119 "For GPGV URIs the only configurable option is "
3120 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3124 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3125 #: apt.conf.5.xml:523
3128 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3129 "\"<replaceable>Methodname</replaceable>\";"
3132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3133 #: apt.conf.5.xml:518
3135 "List of compression types which are understood by the acquire methods. "
3136 "Files like <filename>Packages</filename> can be available in various "
3137 "compression formats. By default the acquire methods can decompress "
3138 "<command>bzip2</command>, <command>lzma</command> and "
3139 "<command>gzip</command> compressed files; with this setting more formats can "
3140 "be added on the fly or the used method can be changed. The syntax for this "
3141 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3145 #: apt.conf.5.xml:528
3147 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3151 #: apt.conf.5.xml:531
3153 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3157 #: apt.conf.5.xml:524
3159 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3160 "order the acquire system will try to download the compressed files. The "
3161 "acquire system will try the first and proceed with the next compression type "
3162 "in this list on error, so to prefer one over the other type simply add the "
3163 "preferred type first - default types not already added will be implicitly "
3164 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3165 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3166 "over <command>bzip2</command> and <command>lzma</command>. If "
3167 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3168 "<command>bzip2</command> the configure setting should look like this: "
3169 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3170 "<literal>bz2</literal> to the list explicitly as it will be added "
3174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3175 #: apt.conf.5.xml:538
3177 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3181 #: apt.conf.5.xml:533
3184 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3185 "checked at run time. If this option has been set, the method will only be "
3186 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
3187 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
3188 "also that list entries specified on the command line will be added at the "
3189 "end of the list specified in the configuration files, but before the default "
3190 "entries. To prefer a type in this case over the ones specified in the "
3191 "configuration files you can set the option direct - not in list style. This "
3192 "will not override the defined list; it will only prefix the list with this "
3196 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3197 #: apt.conf.5.xml:543
3199 "The special type <literal>uncompressed</literal> can be used to give "
3200 "uncompressed files a preference, but note that most archives don't provide "
3201 "uncompressed files so this is mostly only useable for local mirrors."
3204 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3205 #: apt.conf.5.xml:550
3207 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3208 "Sources, or Translations), keep them gzip compressed locally instead of "
3209 "unpacking them. This saves quite a lot of disk space at the expense of more "
3210 "CPU requirements when building the local package caches. False by default."
3213 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3214 #: apt.conf.5.xml:558
3216 "The Languages subsection controls which <filename>Translation</filename> "
3217 "files are downloaded and in which order APT tries to display the "
3218 "description-translations. APT will try to display the first available "
3219 "description in the language which is listed first. Languages can be defined "
3220 "with their short or long language codes. Note that not all archives provide "
3221 "<filename>Translation</filename> files for every language - the long "
3222 "language codes are especially rare."
3225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3226 #: apt.conf.5.xml:575
3228 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3231 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3232 #: apt.conf.5.xml:563
3234 "The default list includes \"environment\" and "
3235 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3236 "will be replaced at runtime with the language codes extracted from the "
3237 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3238 "that these codes are not included twice in the list. If "
3239 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3240 "<filename>Translation-en</filename> file (if available) will be used. To "
3241 "force APT to use no Translation file use the setting "
3242 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3243 "another special meaning code which will stop the search for a suitable "
3244 "<filename>Translation</filename> file. This tells APT to download these "
3245 "translations too, without actually using them unless the environment "
3246 "specifies the languages. So the following example configuration will result "
3247 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3248 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3249 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3250 "type=\"programlisting\" id=\"0\"/>"
3253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3254 #: apt.conf.5.xml:576
3256 "Note: To prevent problems resulting from APT being executed in different "
3257 "environments (e.g. by different users or by other programs) all Translation "
3258 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3259 "added to the end of the list (after an implicit "
3260 "\"<literal>none</literal>\")."
3263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3264 #: apt.conf.5.xml:585
3265 msgid "When downloading, force to use only the IPv4 protocol."
3268 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3269 #: apt.conf.5.xml:591
3270 msgid "When downloading, force to use only the IPv6 protocol."
3273 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3274 #: apt.conf.5.xml:597
3276 "The maximum file size of Release/Release.gpg/InRelease files. The default "
3280 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3281 #: apt.conf.5.xml:604
3283 "This option controls if apt will use the DNS SRV server record as specified "
3284 "in RFC 2782 to select an alternative server to connect to. The default is "
3288 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3289 #: apt.conf.5.xml:613
3291 "Allow the update operation to load data files from a repository without a "
3292 "trusted signature. If enabled this option no data files will be loaded and "
3293 "the update operation fails with a error for this source. The default is "
3294 "false for backward compatibility. This will be changed in the future."
3297 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3298 #: apt.conf.5.xml:624
3300 "Allow that a repository that was previously gpg signed to become unsigned "
3301 "durign a update operation. When there is no valid signature of a perviously "
3302 "trusted repository apt will refuse the update. This option can be used to "
3303 "override this protection. You almost certainly never want to enable "
3304 "this. The default is false. Note that apt will still consider packages from "
3305 "this source untrusted and warn about them if you try to install them."
3308 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3309 #: apt.conf.5.xml:636
3313 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3314 #: apt.conf.5.xml:638
3316 "Acquiring changelogs can only be done if an URI is known from where to get "
3317 "them. Preferable the Release file indicates this in a 'Changelogs' "
3318 "field. If this isn't available the Label/Origin field of the Release file is "
3319 "used to check if a "
3320 "<literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> "
3322 "<literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> "
3323 "option exists and if so this value is taken. The value in the Release file "
3324 "can be overridden with "
3325 "<literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal> "
3327 "<literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>. "
3328 "The value should be a normal URI to a text file, expect that package "
3329 "specific data is replaced with the placeholder "
3330 "<literal>CHANGEPATH</literal>. The value for it is: 1. if the package is "
3331 "from a component (e.g. <literal>main</literal>) this is the first part "
3332 "otherwise it is omitted, 2. the first letter of source package name, expect "
3333 "if the source package name starts with '<literal>lib</literal>' in which "
3334 "case it will be the first four letters. 3. The complete source package "
3335 "name. 4. the complete name again and 5. the source version. The first (if "
3336 "present), second, third and fourth part are separated by a slash "
3337 "('<literal>/</literal>') and between the fourth and fifth part is an "
3338 "underscore ('<literal>_</literal>'). The special value "
3339 "'<literal>no</literal>' is available for this option indicating that this "
3340 "source can't be used to acquire changelog files from. Another source will be "
3341 "tried if available in this case."
3344 #. type: Content of: <refentry><refsect1><title>
3345 #: apt.conf.5.xml:666
3349 #. type: Content of: <refentry><refsect1><para>
3350 #: apt.conf.5.xml:668
3352 "The <literal>Dir::State</literal> section has directories that pertain to "
3353 "local state information. <literal>lists</literal> is the directory to place "
3354 "downloaded package lists in and <literal>status</literal> is the name of the "
3355 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3356 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3357 "contains the default directory to prefix on all sub-items if they do not "
3358 "start with <filename>/</filename> or <filename>./</filename>."
3361 #. type: Content of: <refentry><refsect1><para>
3362 #: apt.conf.5.xml:675
3364 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3365 "information, such as the two package caches <literal>srcpkgcache</literal> "
3366 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3367 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3368 "be turned off by setting <literal>pkgcache</literal> or "
3369 "<literal>srcpkgcache</literal> to <literal>\"\"</literal>. This will slow "
3370 "down startup but save disk space. It is probably preferable to turn off the "
3371 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> "
3372 "the default directory is contained in <literal>Dir::Cache</literal>"
3375 #. type: Content of: <refentry><refsect1><para>
3376 #: apt.conf.5.xml:685
3378 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3379 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3380 "<literal>main</literal> is the default configuration file (setting has no "
3381 "effect, unless it is done from the config file specified by "
3382 "<envar>APT_CONFIG</envar>)."
3385 #. type: Content of: <refentry><refsect1><para>
3386 #: apt.conf.5.xml:691
3388 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3389 "in lexical order from the directory specified. After this is done then the "
3390 "main config file is loaded."
3393 #. type: Content of: <refentry><refsect1><para>
3394 #: apt.conf.5.xml:695
3396 "Binary programs are pointed to by "
3397 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3398 "the location of the method handlers and <literal>gzip</literal>, "
3399 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3400 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3401 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3402 "specify the location of the respective programs."
3405 #. type: Content of: <refentry><refsect1><para>
3406 #: apt.conf.5.xml:703
3408 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3409 "set, all paths will be relative to <literal>RootDir</literal>, "
3410 "<emphasis>even paths that are specified absolutely</emphasis>. So, for "
3411 "instance, if <literal>RootDir</literal> is set to "
3412 "<filename>/tmp/staging</filename> and <literal>Dir::State::status</literal> "
3413 "is set to <filename>/var/lib/dpkg/status</filename>, then the status file "
3414 "will be looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>. "
3415 "If you want to prefix only relative paths, set <literal>Dir</literal> "
3419 #. type: Content of: <refentry><refsect1><para>
3420 #: apt.conf.5.xml:717
3422 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3423 "which files APT should silently ignore while parsing the files in the "
3424 "fragment directories. Per default a file which end with "
3425 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3426 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3427 "default value these patterns can use regular expression syntax."
3430 #. type: Content of: <refentry><refsect1><title>
3431 #: apt.conf.5.xml:726
3432 msgid "APT in DSelect"
3435 #. type: Content of: <refentry><refsect1><para>
3436 #: apt.conf.5.xml:728
3438 "When APT is used as a &dselect; method several configuration directives "
3439 "control the default behavior. These are in the <literal>DSelect</literal> "
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3444 #: apt.conf.5.xml:733
3446 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3447 "<literal>prompt</literal>, <literal>auto</literal>, "
3448 "<literal>pre-auto</literal> and <literal>never</literal>. "
3449 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3450 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3451 "default) does so conditionally. <literal>auto</literal> removes only those "
3452 "packages which are no longer downloadable (replaced with a new version for "
3453 "instance). <literal>pre-auto</literal> performs this action before "
3454 "downloading new packages."
3457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3458 #: apt.conf.5.xml:747
3460 "The contents of this variable are passed to &apt-get; as command line "
3461 "options when it is run for the install phase."
3464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3465 #: apt.conf.5.xml:752
3467 "The contents of this variable are passed to &apt-get; as command line "
3468 "options when it is run for the update phase."
3471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3472 #: apt.conf.5.xml:757
3474 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3475 "The default is to prompt only on error."
3478 #. type: Content of: <refentry><refsect1><title>
3479 #: apt.conf.5.xml:763
3480 msgid "How APT calls &dpkg;"
3483 #. type: Content of: <refentry><refsect1><para>
3484 #: apt.conf.5.xml:764
3486 "Several configuration directives control how APT invokes &dpkg;. These are "
3487 "in the <literal>DPkg</literal> section."
3490 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3491 #: apt.conf.5.xml:769
3493 "This is a list of options to pass to &dpkg;. The options must be specified "
3494 "using the list notation and each list item is passed as a single argument to "
3498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3499 #: apt.conf.5.xml:775
3501 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3502 "<literal>options</literal> this must be specified in list notation. The "
3503 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3504 "fail APT will abort."
3507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3508 #: apt.conf.5.xml:782
3510 "This is a list of shell commands to run before invoking &dpkg;. Like "
3511 "<literal>options</literal> this must be specified in list notation. The "
3512 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3513 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3514 "going to install to the commands, one per line on the requested file "
3515 "descriptor, defaulting to standard input."
3518 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3519 #: apt.conf.5.xml:789
3521 "Version 2 of this protocol sends more information through the requested file "
3522 "descriptor: a line with the text <literal>VERSION 2</literal>, the APT "
3523 "configuration space, and a list of package actions with filename and version "
3527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3528 #: apt.conf.5.xml:794
3530 "Each configuration directive line has the form "
3531 "<literal>key=value</literal>. Special characters (equal signs, newlines, "
3532 "nonprintable characters, quotation marks, and percent signs in "
3533 "<literal>key</literal> and newlines, nonprintable characters, and percent "
3534 "signs in <literal>value</literal>) are %-encoded. Lists are represented by "
3535 "multiple <literal>key::=value</literal> lines with the same key. The "
3536 "configuration section ends with a blank line."
3539 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3540 #: apt.conf.5.xml:802
3542 "Package action lines consist of five fields in Version 2: old version, "
3543 "direction of version change (< for upgrades, > for downgrades, = for "
3544 "no change), new version, action. The version fields are \"-\" for no version "
3545 "at all (for example when installing a package for the first time; no version "
3546 "is treated as earlier than any real version, so that is an upgrade, "
3547 "indicated as <literal>- < 1.23.4</literal>). The action field is "
3548 "\"**CONFIGURE**\" if the package is being configured, \"**REMOVE**\" if it "
3549 "is being removed, or the filename of a .deb file if it is being unpacked."
3552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3553 #: apt.conf.5.xml:812
3555 "In Version 3 after each version field follows the architecture of this "
3556 "version, which is \"-\" if there is no version, and a field showing the "
3557 "MultiArch type \"same\", foreign\", \"allowed\" or \"none\". Note that "
3558 "\"none\" is an incorrect typename which is just kept to remain compatible, "
3559 "it should be read as \"no\" and users are encouraged to support both."
3562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3563 #: apt.conf.5.xml:818
3565 "The version of the protocol to be used for the command "
3566 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3567 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3568 "accordingly, the default being version 1. If APT isn't supporting the "
3569 "requested version it will send the information in the highest version it has "
3570 "support for instead."
3573 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3574 #: apt.conf.5.xml:825
3576 "The file descriptor to be used to send the information can be requested with "
3577 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3578 "which defaults to <literal>0</literal> for standard input and is available "
3579 "since version 0.9.11. Support for the option can be detected by looking for "
3580 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3581 "number of the used file descriptor as a confirmation."
3584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3585 #: apt.conf.5.xml:835
3587 "APT chdirs to this directory before invoking &dpkg;, the default is "
3588 "<filename>/</filename>."
3591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3592 #: apt.conf.5.xml:840
3594 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3595 "default is to disable signing and produce all binaries."
3598 #. type: Content of: <refentry><refsect1><refsect2><title>
3599 #: apt.conf.5.xml:845
3600 msgid "dpkg trigger usage (and related options)"
3603 #. type: Content of: <refentry><refsect1><refsect2><para>
3604 #: apt.conf.5.xml:846
3606 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3607 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3608 "use triggers once each time it runs. Activating these options can therefore "
3609 "decrease the time needed to perform the install or upgrade. Note that it is "
3610 "intended to activate these options per default in the future, but as it "
3611 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3612 "<emphasis>These options are therefore currently experimental and should not "
3613 "be used in production environments.</emphasis> It also breaks progress "
3614 "reporting such that all front-ends will currently stay around half (or more) "
3615 "of the time in the 100% state while it actually configures all packages."
3618 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3619 #: apt.conf.5.xml:861
3622 "DPkg::NoTriggers \"true\";\n"
3623 "PackageManager::Configure \"smart\";\n"
3624 "DPkg::ConfigurePending \"true\";\n"
3625 "DPkg::TriggersPending \"true\";"
3628 #. type: Content of: <refentry><refsect1><refsect2><para>
3629 #: apt.conf.5.xml:855
3631 "Note that it is not guaranteed that APT will support these options or that "
3632 "these options will not cause (big) trouble in the future. If you have "
3633 "understand the current risks and problems with these options, but are brave "
3634 "enough to help testing them, create a new configuration file and test a "
3635 "combination of options. Please report any bugs, problems and improvements "
3636 "you encounter and make sure to note which options you have used in your "
3637 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3638 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3639 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3642 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3643 #: apt.conf.5.xml:868
3645 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3646 "call). See &dpkg; if you are interested in what this actually means. In "
3647 "short: &dpkg; will not run the triggers when this flag is present unless it "
3648 "is explicitly called to do so in an extra call. Note that this option "
3649 "exists (undocumented) also in older APT versions with a slightly different "
3650 "meaning: Previously these option only append --no-triggers to the configure "
3651 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3655 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3656 #: apt.conf.5.xml:876
3658 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3659 "and \"<literal>no</literal>\". The default value is "
3660 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3661 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3662 "be configured before another package can be unpacked (Pre-Depends), and let "
3663 "the rest be configured by &dpkg; with a call generated by the "
3664 "ConfigurePending option (see below). On the other hand, "
3665 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3666 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3667 "encountered). Setting this option to any value other than "
3668 "<literal>all</literal> will implicitly also activate the next option by "
3669 "default, as otherwise the system could end in an unconfigured and "
3670 "potentially unbootable state."
3673 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3674 #: apt.conf.5.xml:891
3676 "If this option is set APT will call <command>dpkg --configure "
3677 "--pending</command> to let &dpkg; handle all required configurations and "
3678 "triggers. This option is activated automatically per default if the previous "
3679 "option is not set to <literal>all</literal>, but deactivating it could be "
3680 "useful if you want to run APT multiple times in a row - e.g. in an "
3681 "installer. In these sceneries you could deactivate this option in all but "
3685 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3686 #: apt.conf.5.xml:898
3688 "Useful for the <literal>smart</literal> configuration as a package which has "
3689 "pending triggers is not considered as <literal>installed</literal>, and "
3690 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3691 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3692 "process all triggers, not only the triggers needed to configure this "
3696 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3697 #: apt.conf.5.xml:911
3700 "OrderList::Score {\n"
3702 "\tEssential 200;\n"
3704 "\tPreDepends 50;\n"
3708 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3709 #: apt.conf.5.xml:904
3711 "Essential packages (and their dependencies) should be configured immediately "
3712 "after unpacking. It is a good idea to do this quite early in the upgrade "
3713 "process as these configure calls also currently require "
3714 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3715 "(which may not be needed). Essentials get per default a high score but the "
3716 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3717 "higher). These option and the others in the same group can be used to "
3718 "change the scoring. The following example shows the settings with their "
3719 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3722 #. type: Content of: <refentry><refsect1><title>
3723 #: apt.conf.5.xml:924
3724 msgid "Periodic and Archives options"
3727 #. type: Content of: <refentry><refsect1><para>
3728 #: apt.conf.5.xml:925
3730 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3731 "of options configure behavior of apt periodic updates, which is done by the "
3732 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3733 "for the brief documentation of these options."
3736 #. type: Content of: <refentry><refsect1><title>
3737 #: apt.conf.5.xml:933
3738 msgid "Debug options"
3741 #. type: Content of: <refentry><refsect1><para>
3742 #: apt.conf.5.xml:935
3744 "Enabling options in the <literal>Debug::</literal> section will cause "
3745 "debugging information to be sent to the standard error stream of the program "
3746 "utilizing the <literal>apt</literal> libraries, or enable special program "
3747 "modes that are primarily useful for debugging the behavior of "
3748 "<literal>apt</literal>. Most of these options are not interesting to a "
3749 "normal user, but a few may be:"
3752 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3753 #: apt.conf.5.xml:946
3755 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3756 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3760 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3761 #: apt.conf.5.xml:954
3763 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3764 "used to run some operations (for instance, <literal>apt-get -s "
3765 "install</literal>) as a non-root user."
3768 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3769 #: apt.conf.5.xml:963
3771 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3772 "time that <literal>apt</literal> invokes &dpkg;."
3776 #. motivating example, except I haven't a clue why you'd want
3778 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3779 #: apt.conf.5.xml:971
3781 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3785 #. type: Content of: <refentry><refsect1><para>
3786 #: apt.conf.5.xml:981
3787 msgid "A full list of debugging options to apt follows."
3790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3791 #: apt.conf.5.xml:990
3792 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3796 #: apt.conf.5.xml:1001
3797 msgid "Print information related to downloading packages using FTP."
3800 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3801 #: apt.conf.5.xml:1012
3802 msgid "Print information related to downloading packages using HTTP."
3805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3806 #: apt.conf.5.xml:1023
3807 msgid "Print information related to downloading packages using HTTPS."
3810 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3811 #: apt.conf.5.xml:1034
3813 "Print information related to verifying cryptographic signatures using "
3814 "<literal>gpg</literal>."
3817 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3818 #: apt.conf.5.xml:1045
3820 "Output information about the process of accessing collections of packages "
3821 "stored on CD-ROMs."
3824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3825 #: apt.conf.5.xml:1055
3826 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3829 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3830 #: apt.conf.5.xml:1065
3832 "Output each cryptographic hash that is generated by the "
3833 "<literal>apt</literal> libraries."
3836 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3837 #: apt.conf.5.xml:1075
3839 "Do not include information from <literal>statfs</literal>, namely the number "
3840 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3844 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3845 #: apt.conf.5.xml:1086
3847 "Disable all file locking. For instance, this will allow two instances of "
3848 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3852 #: apt.conf.5.xml:1098
3853 msgid "Log when items are added to or removed from the global download queue."
3856 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3857 #: apt.conf.5.xml:1108
3859 "Output status messages and errors related to verifying checksums and "
3860 "cryptographic signatures of downloaded files."
3863 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3864 #: apt.conf.5.xml:1118
3866 "Output information about downloading and applying package index list diffs, "
3867 "and errors relating to package index list diffs."
3870 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3871 #: apt.conf.5.xml:1130
3873 "Output information related to patching apt package lists when downloading "
3874 "index diffs instead of full indices."
3877 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3878 #: apt.conf.5.xml:1141
3879 msgid "Log all interactions with the sub-processes that actually perform downloads."
3882 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3883 #: apt.conf.5.xml:1152
3885 "Log events related to the automatically-installed status of packages and to "
3886 "the removal of unused packages."
3889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3890 #: apt.conf.5.xml:1162
3892 "Generate debug messages describing which packages are being automatically "
3893 "installed to resolve dependencies. This corresponds to the initial "
3894 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3895 "and not to the full <literal>apt</literal> dependency resolver; see "
3896 "<literal>Debug::pkgProblemResolver</literal> for that."
3899 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3900 #: apt.conf.5.xml:1176
3902 "Generate debug messages describing which packages are marked as "
3903 "keep/install/remove while the ProblemResolver does his work. Each addition "
3904 "or deletion may trigger additional actions; they are shown indented two "
3905 "additional spaces under the original entry. The format for each line is "
3906 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3907 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3908 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3909 "is the current version of the package, <literal>d.e.f</literal> is the "
3910 "version considered for installation and <literal>x.y.z</literal> is a newer "
3911 "version, but not considered for installation (because of a low pin "
3912 "score). The later two can be omitted if there is none or if it is the same "
3913 "as the installed version. <literal>section</literal> is the name of the "
3914 "section the package appears in."
3917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3918 #: apt.conf.5.xml:1197
3920 "When invoking &dpkg;, output the precise command line with which it is being "
3921 "invoked, with arguments separated by a single space character."
3924 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3925 #: apt.conf.5.xml:1208
3927 "Output all the data received from &dpkg; on the status file descriptor and "
3928 "any errors encountered while parsing it."
3931 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3932 #: apt.conf.5.xml:1219
3934 "Generate a trace of the algorithm that decides the order in which "
3935 "<literal>apt</literal> should pass packages to &dpkg;."
3938 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3939 #: apt.conf.5.xml:1231
3940 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3943 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3944 #: apt.conf.5.xml:1242
3945 msgid "Output the priority of each package list on startup."
3948 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3949 #: apt.conf.5.xml:1252
3951 "Trace the execution of the dependency resolver (this applies only to what "
3952 "happens when a complex dependency problem is encountered)."
3955 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3956 #: apt.conf.5.xml:1263
3958 "Display a list of all installed packages with their calculated score used by "
3959 "the pkgProblemResolver. The description of the package is the same as "
3960 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3963 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3964 #: apt.conf.5.xml:1275
3966 "Print information about the vendors read from "
3967 "<filename>/etc/apt/vendors.list</filename>."
3970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3971 #: apt.conf.5.xml:1285
3973 "Display the external commands that are called by apt hooks. This includes "
3974 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
3975 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
3978 #. type: Content of: <refentry><refsect1><title>
3979 #: apt.conf.5.xml:1309 apt_preferences.5.xml:556 sources.list.5.xml:375 apt-ftparchive.1.xml:592
3983 #. type: Content of: <refentry><refsect1><para>
3984 #: apt.conf.5.xml:1310
3986 "&configureindex; is a configuration file showing example values for all "
3990 #. ? reading apt.conf
3991 #. type: Content of: <refentry><refsect1><para>
3992 #: apt.conf.5.xml:1322
3993 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
3996 #. type: Content of: <refentry><refnamediv><refpurpose>
3997 #: apt_preferences.5.xml:28
3998 msgid "Preference control file for APT"
4001 #. type: Content of: <refentry><refsect1><para>
4002 #: apt_preferences.5.xml:33
4004 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4005 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4006 "can be used to control which versions of packages will be selected for "
4010 #. type: Content of: <refentry><refsect1><para>
4011 #: apt_preferences.5.xml:38
4013 "Several versions of a package may be available for installation when the "
4014 "&sources-list; file contains references to more than one distribution (for "
4015 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4016 "assigns a priority to each version that is available. Subject to dependency "
4017 "constraints, <command>apt-get</command> selects the version with the highest "
4018 "priority for installation. The APT preferences override the priorities that "
4019 "APT assigns to package versions by default, thus giving the user control "
4020 "over which one is selected for installation."
4023 #. type: Content of: <refentry><refsect1><para>
4024 #: apt_preferences.5.xml:48
4026 "Several instances of the same version of a package may be available when the "
4027 "&sources-list; file contains references to more than one source. In this "
4028 "case <command>apt-get</command> downloads the instance listed earliest in "
4029 "the &sources-list; file. The APT preferences do not affect the choice of "
4030 "instance, only the choice of version."
4033 #. type: Content of: <refentry><refsect1><para>
4034 #: apt_preferences.5.xml:55
4036 "Preferences are a strong power in the hands of a system administrator but "
4037 "they can become also their biggest nightmare if used without care! APT will "
4038 "not question the preferences, so wrong settings can lead to uninstallable "
4039 "packages or wrong decisions while upgrading packages. Even more problems "
4040 "will arise if multiple distribution releases are mixed without a good "
4041 "understanding of the following paragraphs. Packages included in a specific "
4042 "release aren't tested in (and therefore don't always work as expected in) "
4043 "older or newer releases, or together with other packages from different "
4044 "releases. You have been warned."
4047 #. type: Content of: <refentry><refsect1><para>
4048 #: apt_preferences.5.xml:66
4050 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4051 "directory are parsed in alphanumeric ascending order and need to obey the "
4052 "following naming convention: The files have either no or "
4053 "\"<literal>pref</literal>\" as filename extension and only contain "
4054 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4055 "Otherwise APT will print a notice that it has ignored a file, unless that "
4056 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4057 "configuration list - in which case it will be silently ignored."
4060 #. type: Content of: <refentry><refsect1><refsect2><title>
4061 #: apt_preferences.5.xml:75
4062 msgid "APT's Default Priority Assignments"
4065 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4066 #: apt_preferences.5.xml:90
4069 "<command>apt-get install -t testing "
4070 "<replaceable>some-package</replaceable></command>\n"
4073 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4074 #: apt_preferences.5.xml:93
4076 msgid "APT::Default-Release \"stable\";\n"
4079 #. type: Content of: <refentry><refsect1><refsect2><para>
4080 #: apt_preferences.5.xml:77
4082 "If there is no preferences file or if there is no entry in the file that "
4083 "applies to a particular version then the priority assigned to that version "
4084 "is the priority of the distribution to which that version belongs. It is "
4085 "possible to single out a distribution, \"the target release\", which "
4086 "receives a higher priority than other distributions do by default. The "
4087 "target release can be set on the <command>apt-get</command> command line or "
4088 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4089 "that this has precedence over any general priority you set in the "
4090 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4091 "specifically pinned packages. For example, <placeholder "
4092 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4096 #. type: Content of: <refentry><refsect1><refsect2><para>
4097 #: apt_preferences.5.xml:97
4099 "If the target release has been specified then APT uses the following "
4100 "algorithm to set the priorities of the versions of a package. Assign:"
4103 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4104 #: apt_preferences.5.xml:102
4108 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4109 #: apt_preferences.5.xml:103
4111 "to the versions coming from archives which in their "
4112 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4113 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
4114 "<literal>experimental</literal> archive."
4117 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4118 #: apt_preferences.5.xml:109
4119 msgid "priority 100"
4122 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4123 #: apt_preferences.5.xml:110
4125 "to the version that is already installed (if any) and to the versions coming "
4126 "from archives which in their <filename>Release</filename> files are marked "
4127 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
4128 "backports archive since <literal>squeeze-backports</literal>."
4131 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4132 #: apt_preferences.5.xml:117
4133 msgid "priority 500"
4136 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4137 #: apt_preferences.5.xml:118
4138 msgid "to the versions that do not belong to the target release."
4141 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4142 #: apt_preferences.5.xml:122
4143 msgid "priority 990"
4146 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4147 #: apt_preferences.5.xml:123
4148 msgid "to the versions that belong to the target release."
4151 #. type: Content of: <refentry><refsect1><refsect2><para>
4152 #: apt_preferences.5.xml:127
4154 "The highest of those priorities whose description matches the version is "
4155 "assigned to the version."
4158 #. type: Content of: <refentry><refsect1><refsect2><para>
4159 #: apt_preferences.5.xml:131
4161 "If the target release has not been specified then APT simply assigns "
4162 "priority 100 to all installed package versions and priority 500 to all "
4163 "uninstalled package versions, except versions coming from archives which in "
4164 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4165 "- these versions get the priority 1 or priority 100 if it is additionally "
4166 "marked as \"ButAutomaticUpgrades: yes\"."
4169 #. type: Content of: <refentry><refsect1><refsect2><para>
4170 #: apt_preferences.5.xml:138
4172 "APT then applies the following rules, listed in order of precedence, to "
4173 "determine which version of a package to install."
4176 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4177 #: apt_preferences.5.xml:141
4179 "Never downgrade unless the priority of an available version exceeds 1000. "
4180 "(\"Downgrading\" is installing a less recent version of a package in place "
4181 "of a more recent version. Note that none of APT's default priorities "
4182 "exceeds 1000; such high priorities can only be set in the preferences file. "
4183 "Note also that downgrading a package can be risky.)"
4186 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4187 #: apt_preferences.5.xml:147
4188 msgid "Install the highest priority version."
4191 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4192 #: apt_preferences.5.xml:148
4194 "If two or more versions have the same priority, install the most recent one "
4195 "(that is, the one with the higher version number)."
4198 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4199 #: apt_preferences.5.xml:151
4201 "If two or more versions have the same priority and version number but either "
4202 "the packages differ in some of their metadata or the "
4203 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4206 #. type: Content of: <refentry><refsect1><refsect2><para>
4207 #: apt_preferences.5.xml:157
4209 "In a typical situation, the installed version of a package (priority 100) "
4210 "is not as recent as one of the versions available from the sources listed in "
4211 "the &sources-list; file (priority 500 or 990). Then the package will be "
4212 "upgraded when <command>apt-get install "
4213 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4214 "upgrade</command> is executed."
4217 #. type: Content of: <refentry><refsect1><refsect2><para>
4218 #: apt_preferences.5.xml:164
4220 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4221 "recent than any of the other available versions. The package will not be "
4222 "downgraded when <command>apt-get install "
4223 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4224 "upgrade</command> is executed."
4227 #. type: Content of: <refentry><refsect1><refsect2><para>
4228 #: apt_preferences.5.xml:169
4230 "Sometimes the installed version of a package is more recent than the version "
4231 "belonging to the target release, but not as recent as a version belonging to "
4232 "some other distribution. Such a package will indeed be upgraded when "
4233 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4234 "or <command>apt-get upgrade</command> is executed, because at least "
4235 "<emphasis>one</emphasis> of the available versions has a higher priority "
4236 "than the installed version."
4239 #. type: Content of: <refentry><refsect1><refsect2><title>
4240 #: apt_preferences.5.xml:178
4241 msgid "The Effect of APT Preferences"
4244 #. type: Content of: <refentry><refsect1><refsect2><para>
4245 #: apt_preferences.5.xml:180
4247 "The APT preferences file allows the system administrator to control the "
4248 "assignment of priorities. The file consists of one or more multi-line "
4249 "records separated by blank lines. Records can have one of two forms, a "
4250 "specific form and a general form."
4253 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4254 #: apt_preferences.5.xml:186
4256 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4257 "specified packages with a specified version or version range. For example, "
4258 "the following record assigns a high priority to all versions of the "
4259 "<filename>perl</filename> package whose version number begins with "
4260 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4264 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4265 #: apt_preferences.5.xml:193
4269 "Pin: version &good-perl;*\n"
4270 "Pin-Priority: 1001\n"
4273 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4274 #: apt_preferences.5.xml:199
4276 "The general form assigns a priority to all of the package versions in a "
4277 "given distribution (that is, to all the versions of packages that are listed "
4278 "in a certain <filename>Release</filename> file) or to all of the package "
4279 "versions coming from a particular Internet site, as identified by the site's "
4280 "fully qualified domain name."
4283 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4284 #: apt_preferences.5.xml:205
4286 "This general-form entry in the APT preferences file applies only to groups "
4287 "of packages. For example, the following record assigns a high priority to "
4288 "all package versions available from the local site."
4291 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4292 #: apt_preferences.5.xml:210
4296 "Pin: origin \"\"\n"
4297 "Pin-Priority: 999\n"
4300 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4301 #: apt_preferences.5.xml:215
4303 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4304 "which can be used to match a hostname. The following record will assign a "
4305 "high priority to all versions available from the server identified by the "
4306 "hostname \"ftp.de.debian.org\""
4309 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4310 #: apt_preferences.5.xml:219
4314 "Pin: origin \"ftp.de.debian.org\"\n"
4315 "Pin-Priority: 999\n"
4318 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4319 #: apt_preferences.5.xml:223
4321 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4322 "distribution as specified in a <filename>Release</filename> file. What "
4323 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4324 "Internet address but an author or vendor name, such as \"Debian\" or "
4328 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4329 #: apt_preferences.5.xml:228
4331 "The following record assigns a low priority to all package versions "
4332 "belonging to any distribution whose Archive name is "
4333 "\"<literal>unstable</literal>\"."
4336 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4337 #: apt_preferences.5.xml:232
4341 "Pin: release a=unstable\n"
4342 "Pin-Priority: 50\n"
4345 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4346 #: apt_preferences.5.xml:237
4348 "The following record assigns a high priority to all package versions "
4349 "belonging to any distribution whose Codename is "
4350 "\"<literal>&testing-codename;</literal>\"."
4353 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4354 #: apt_preferences.5.xml:241
4358 "Pin: release n=&testing-codename;\n"
4359 "Pin-Priority: 900\n"
4362 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4363 #: apt_preferences.5.xml:246
4365 "The following record assigns a high priority to all package versions "
4366 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4367 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4370 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4371 #: apt_preferences.5.xml:251
4375 "Pin: release a=stable, v=&stable-version;\n"
4376 "Pin-Priority: 500\n"
4379 #. type: Content of: <refentry><refsect1><refsect2><para>
4380 #: apt_preferences.5.xml:258
4382 "The effect of the comma operator is similar to an \"and\" in logic: All "
4383 "conditions must be satisfied for the pin to match. There is one exception: "
4384 "For any type of condition (such as two \"a\" conditions), only the last such "
4385 "condition is checked."
4388 #. type: Content of: <refentry><refsect1><refsect2><title>
4389 #: apt_preferences.5.xml:266
4390 msgid "Regular expressions and &glob; syntax"
4393 #. type: Content of: <refentry><refsect1><refsect2><para>
4394 #: apt_preferences.5.xml:268
4396 "APT also supports pinning by &glob; expressions, and regular expressions "
4397 "surrounded by slashes. For example, the following example assigns the "
4398 "priority 500 to all packages from experimental where the name starts with "
4399 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4400 "extended regular expression surrounded by slashes)."
4403 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4404 #: apt_preferences.5.xml:277
4407 "Package: gnome* /kde/\n"
4408 "Pin: release a=experimental\n"
4409 "Pin-Priority: 500\n"
4412 #. type: Content of: <refentry><refsect1><refsect2><para>
4413 #: apt_preferences.5.xml:283
4415 "The rule for those expressions is that they can occur anywhere where a "
4416 "string can occur. Thus, the following pin assigns the priority 990 to all "
4417 "packages from a release starting with &ubuntu-codename;."
4420 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4421 #: apt_preferences.5.xml:289
4425 "Pin: release n=&ubuntu-codename;*\n"
4426 "Pin-Priority: 990\n"
4429 #. type: Content of: <refentry><refsect1><refsect2><para>
4430 #: apt_preferences.5.xml:295
4432 "If a regular expression occurs in a <literal>Package</literal> field, the "
4433 "behavior is the same as if this regular expression were replaced with a list "
4434 "of all package names it matches. It is undecided whether this will change in "
4435 "the future; thus you should always list wild-card pins first, so later "
4436 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4437 "Package field is not considered a &glob; expression in itself."
4440 #. type: Content of: <refentry><refsect1><refsect2><title>
4441 #: apt_preferences.5.xml:311
4442 msgid "How APT Interprets Priorities"
4445 #. type: Content of: <refentry><refsect1><refsect2><para>
4446 #: apt_preferences.5.xml:314
4448 "Priorities (P) assigned in the APT preferences file must be positive or "
4449 "negative integers. They are interpreted as follows (roughly speaking):"
4452 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4453 #: apt_preferences.5.xml:319
4454 msgid "P >= 1000"
4457 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4458 #: apt_preferences.5.xml:320
4460 "causes a version to be installed even if this constitutes a downgrade of the "
4464 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4465 #: apt_preferences.5.xml:324
4466 msgid "990 <= P < 1000"
4469 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4470 #: apt_preferences.5.xml:325
4472 "causes a version to be installed even if it does not come from the target "
4473 "release, unless the installed version is more recent"
4476 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4477 #: apt_preferences.5.xml:330
4478 msgid "500 <= P < 990"
4481 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4482 #: apt_preferences.5.xml:331
4484 "causes a version to be installed unless there is a version available "
4485 "belonging to the target release or the installed version is more recent"
4488 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4489 #: apt_preferences.5.xml:336
4490 msgid "100 <= P < 500"
4493 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4494 #: apt_preferences.5.xml:337
4496 "causes a version to be installed unless there is a version available "
4497 "belonging to some other distribution or the installed version is more recent"
4500 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4501 #: apt_preferences.5.xml:342
4502 msgid "0 < P < 100"
4505 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4506 #: apt_preferences.5.xml:343
4508 "causes a version to be installed only if there is no installed version of "
4512 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4513 #: apt_preferences.5.xml:347
4517 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4518 #: apt_preferences.5.xml:348
4519 msgid "prevents the version from being installed"
4522 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4523 #: apt_preferences.5.xml:351
4527 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4528 #: apt_preferences.5.xml:352
4529 msgid "has undefined behaviour, do not use it."
4532 #. type: Content of: <refentry><refsect1><refsect2><para>
4533 #: apt_preferences.5.xml:358
4535 "The first specific-form record matching an available package version "
4536 "determines the priority of the package version. Failing that, the priority "
4537 "of the package is defined as the maximum of all priorities defined by "
4538 "generic-form records matching the version. Records defined using patterns "
4539 "in the Pin field other than \"*\" are treated like specific-form records."
4542 #. type: Content of: <refentry><refsect1><refsect2><para>
4543 #: apt_preferences.5.xml:366
4545 "For example, suppose the APT preferences file contains the three records "
4546 "presented earlier:"
4549 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4550 #: apt_preferences.5.xml:370
4554 "Pin: version &good-perl;*\n"
4555 "Pin-Priority: 1001\n"
4558 "Pin: origin \"\"\n"
4559 "Pin-Priority: 999\n"
4562 "Pin: release unstable\n"
4563 "Pin-Priority: 50\n"
4566 #. type: Content of: <refentry><refsect1><refsect2><para>
4567 #: apt_preferences.5.xml:383
4571 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4572 #: apt_preferences.5.xml:385
4574 "The most recent available version of the <literal>perl</literal> package "
4575 "will be installed, so long as that version's version number begins with "
4576 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4577 "&good-perl;* version of <literal>perl</literal> is available and the "
4578 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4582 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4583 #: apt_preferences.5.xml:390
4585 "A version of any package other than <literal>perl</literal> that is "
4586 "available from the local system has priority over other versions, even "
4587 "versions belonging to the target release."
4590 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4591 #: apt_preferences.5.xml:394
4593 "A version of a package whose origin is not the local system but some other "
4594 "site listed in &sources-list; and which belongs to an "
4595 "<literal>unstable</literal> distribution is only installed if it is selected "
4596 "for installation and no version of the package is already installed."
4599 #. type: Content of: <refentry><refsect1><refsect2><title>
4600 #: apt_preferences.5.xml:404
4601 msgid "Determination of Package Version and Distribution Properties"
4604 #. type: Content of: <refentry><refsect1><refsect2><para>
4605 #: apt_preferences.5.xml:406
4607 "The locations listed in the &sources-list; file should provide "
4608 "<filename>Packages</filename> and <filename>Release</filename> files to "
4609 "describe the packages available at that location."
4612 #. type: Content of: <refentry><refsect1><refsect2><para>
4613 #: apt_preferences.5.xml:410
4615 "The <filename>Packages</filename> file is normally found in the directory "
4616 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4618 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4619 "consists of a series of multi-line records, one for each package available "
4620 "in that directory. Only two lines in each record are relevant for setting "
4624 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4625 #: apt_preferences.5.xml:418
4626 msgid "the <literal>Package:</literal> line"
4629 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4630 #: apt_preferences.5.xml:419
4631 msgid "gives the package name"
4634 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4635 #: apt_preferences.5.xml:422 apt_preferences.5.xml:472
4636 msgid "the <literal>Version:</literal> line"
4639 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4640 #: apt_preferences.5.xml:423
4641 msgid "gives the version number for the named package"
4644 #. type: Content of: <refentry><refsect1><refsect2><para>
4645 #: apt_preferences.5.xml:428
4647 "The <filename>Release</filename> file is normally found in the directory "
4648 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4649 "example, <filename>.../dists/stable/Release</filename>, or "
4650 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4651 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4652 "packages in the directory tree below its parent. Unlike the "
4653 "<filename>Packages</filename> file, nearly all of the lines in a "
4654 "<filename>Release</filename> file are relevant for setting APT priorities:"
4657 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4658 #: apt_preferences.5.xml:439
4659 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4662 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4663 #: apt_preferences.5.xml:440
4665 "names the archive to which all the packages in the directory tree belong. "
4666 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4667 "that all of the packages in the directory tree below the parent of the "
4668 "<filename>Release</filename> file are in a <literal>stable</literal> "
4669 "archive. Specifying this value in the APT preferences file would require "
4673 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4674 #: apt_preferences.5.xml:450
4676 msgid "Pin: release a=stable\n"
4679 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4680 #: apt_preferences.5.xml:456
4681 msgid "the <literal>Codename:</literal> line"
4684 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4685 #: apt_preferences.5.xml:457
4687 "names the codename to which all the packages in the directory tree belong. "
4688 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4689 "the packages in the directory tree below the parent of the "
4690 "<filename>Release</filename> file belong to a version named "
4691 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4692 "preferences file would require the line:"
4695 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4696 #: apt_preferences.5.xml:466
4698 msgid "Pin: release n=&testing-codename;\n"
4701 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4702 #: apt_preferences.5.xml:473
4704 "names the release version. For example, the packages in the tree might "
4705 "belong to Debian release version &stable-version;. Note that there is "
4706 "normally no version number for the <literal>testing</literal> and "
4707 "<literal>unstable</literal> distributions because they have not been "
4708 "released yet. Specifying this in the APT preferences file would require one "
4709 "of the following lines."
4712 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4713 #: apt_preferences.5.xml:482
4716 "Pin: release v=&stable-version;\n"
4717 "Pin: release a=stable, v=&stable-version;\n"
4718 "Pin: release &stable-version;\n"
4721 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4722 #: apt_preferences.5.xml:491
4723 msgid "the <literal>Component:</literal> line"
4726 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4727 #: apt_preferences.5.xml:492
4729 "names the licensing component associated with the packages in the directory "
4730 "tree of the <filename>Release</filename> file. For example, the line "
4731 "\"Component: main\" specifies that all the packages in the directory tree "
4732 "are from the <literal>main</literal> component, which entails that they are "
4733 "licensed under terms listed in the Debian Free Software Guidelines. "
4734 "Specifying this component in the APT preferences file would require the "
4738 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4739 #: apt_preferences.5.xml:501
4741 msgid "Pin: release c=main\n"
4744 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4745 #: apt_preferences.5.xml:507
4746 msgid "the <literal>Origin:</literal> line"
4749 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4750 #: apt_preferences.5.xml:508
4752 "names the originator of the packages in the directory tree of the "
4753 "<filename>Release</filename> file. Most commonly, this is "
4754 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4755 "file would require the line:"
4758 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4759 #: apt_preferences.5.xml:514
4761 msgid "Pin: release o=Debian\n"
4764 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4765 #: apt_preferences.5.xml:520
4766 msgid "the <literal>Label:</literal> line"
4769 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4770 #: apt_preferences.5.xml:521
4772 "names the label of the packages in the directory tree of the "
4773 "<filename>Release</filename> file. Most commonly, this is "
4774 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4775 "file would require the line:"
4778 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4779 #: apt_preferences.5.xml:527
4781 msgid "Pin: release l=Debian\n"
4784 #. type: Content of: <refentry><refsect1><refsect2><para>
4785 #: apt_preferences.5.xml:534
4787 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4788 "files retrieved from locations listed in the &sources-list; file are stored "
4789 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4790 "named by the variable <literal>Dir::State::Lists</literal> in the "
4791 "<filename>apt.conf</filename> file. For example, the file "
4792 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4793 "contains the <filename>Release</filename> file retrieved from the site "
4794 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4795 "architecture files from the <literal>contrib</literal> component of the "
4796 "<literal>unstable</literal> distribution."
4799 #. type: Content of: <refentry><refsect1><refsect2><title>
4800 #: apt_preferences.5.xml:547
4801 msgid "Optional Lines in an APT Preferences Record"
4804 #. type: Content of: <refentry><refsect1><refsect2><para>
4805 #: apt_preferences.5.xml:549
4807 "Each record in the APT preferences file can optionally begin with one or "
4808 "more lines beginning with the word <literal>Explanation:</literal>. This "
4809 "provides a place for comments."
4812 #. type: Content of: <refentry><refsect1><refsect2><title>
4813 #: apt_preferences.5.xml:558
4814 msgid "Tracking Stable"
4817 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4818 #: apt_preferences.5.xml:566
4821 "Explanation: Uninstall or do not install any Debian-originated\n"
4822 "Explanation: package versions other than those in the stable distro\n"
4824 "Pin: release a=stable\n"
4825 "Pin-Priority: 900\n"
4828 "Pin: release o=Debian\n"
4829 "Pin-Priority: -10\n"
4832 #. type: Content of: <refentry><refsect1><refsect2><para>
4833 #: apt_preferences.5.xml:560
4835 "The following APT preferences file will cause APT to assign a priority "
4836 "higher than the default (500) to all package versions belonging to a "
4837 "<literal>stable</literal> distribution and a prohibitively low priority to "
4838 "package versions belonging to other <literal>Debian</literal> "
4839 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4842 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4843 #: apt_preferences.5.xml:583 apt_preferences.5.xml:629 apt_preferences.5.xml:687
4846 "apt-get install <replaceable>package-name</replaceable>\n"
4848 "apt-get dist-upgrade\n"
4851 #. type: Content of: <refentry><refsect1><refsect2><para>
4852 #: apt_preferences.5.xml:578
4854 "With a suitable &sources-list; file and the above preferences file, any of "
4855 "the following commands will cause APT to upgrade to the latest "
4856 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4860 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4861 #: apt_preferences.5.xml:595
4863 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4866 #. type: Content of: <refentry><refsect1><refsect2><para>
4867 #: apt_preferences.5.xml:589
4869 "The following command will cause APT to upgrade the specified package to the "
4870 "latest version from the <literal>testing</literal> distribution; the package "
4871 "will not be upgraded again unless this command is given again. <placeholder "
4872 "type=\"programlisting\" id=\"0\"/>"
4875 #. type: Content of: <refentry><refsect1><refsect2><title>
4876 #: apt_preferences.5.xml:601
4877 msgid "Tracking Testing or Unstable"
4880 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4881 #: apt_preferences.5.xml:610
4885 "Pin: release a=testing\n"
4886 "Pin-Priority: 900\n"
4889 "Pin: release a=unstable\n"
4890 "Pin-Priority: 800\n"
4893 "Pin: release o=Debian\n"
4894 "Pin-Priority: -10\n"
4897 #. type: Content of: <refentry><refsect1><refsect2><para>
4898 #: apt_preferences.5.xml:603
4900 "The following APT preferences file will cause APT to assign a high priority "
4901 "to package versions from the <literal>testing</literal> distribution, a "
4902 "lower priority to package versions from the <literal>unstable</literal> "
4903 "distribution, and a prohibitively low priority to package versions from "
4904 "other <literal>Debian</literal> distributions. <placeholder "
4905 "type=\"programlisting\" id=\"0\"/>"
4908 #. type: Content of: <refentry><refsect1><refsect2><para>
4909 #: apt_preferences.5.xml:624
4911 "With a suitable &sources-list; file and the above preferences file, any of "
4912 "the following commands will cause APT to upgrade to the latest "
4913 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4917 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4918 #: apt_preferences.5.xml:644
4920 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4923 #. type: Content of: <refentry><refsect1><refsect2><para>
4924 #: apt_preferences.5.xml:635
4926 "The following command will cause APT to upgrade the specified package to the "
4927 "latest version from the <literal>unstable</literal> distribution. "
4928 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4929 "the most recent <literal>testing</literal> version if that is more recent "
4930 "than the installed version, otherwise, to the most recent "
4931 "<literal>unstable</literal> version if that is more recent than the "
4932 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4935 #. type: Content of: <refentry><refsect1><refsect2><title>
4936 #: apt_preferences.5.xml:651
4937 msgid "Tracking the evolution of a codename release"
4940 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4941 #: apt_preferences.5.xml:665
4944 "Explanation: Uninstall or do not install any Debian-originated package "
4946 "Explanation: other than those in the distribution codenamed with "
4947 "&testing-codename; or sid\n"
4949 "Pin: release n=&testing-codename;\n"
4950 "Pin-Priority: 900\n"
4952 "Explanation: Debian unstable is always codenamed with sid\n"
4954 "Pin: release n=sid\n"
4955 "Pin-Priority: 800\n"
4958 "Pin: release o=Debian\n"
4959 "Pin-Priority: -10\n"
4962 #. type: Content of: <refentry><refsect1><refsect2><para>
4963 #: apt_preferences.5.xml:653
4965 "The following APT preferences file will cause APT to assign a priority "
4966 "higher than the default (500) to all package versions belonging to a "
4967 "specified codename of a distribution and a prohibitively low priority to "
4968 "package versions belonging to other <literal>Debian</literal> distributions, "
4969 "codenames and archives. Note that with this APT preference APT will follow "
4970 "the migration of a release from the archive <literal>testing</literal> to "
4971 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
4972 "want to follow for example the progress in <literal>testing</literal> "
4973 "notwithstanding the codename changes you should use the example "
4974 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
4977 #. type: Content of: <refentry><refsect1><refsect2><para>
4978 #: apt_preferences.5.xml:682
4980 "With a suitable &sources-list; file and the above preferences file, any of "
4981 "the following commands will cause APT to upgrade to the latest version(s) in "
4982 "the release codenamed with <literal>&testing-codename;</literal>. "
4983 "<placeholder type=\"programlisting\" id=\"0\"/>"
4986 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4987 #: apt_preferences.5.xml:702
4989 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
4992 #. type: Content of: <refentry><refsect1><refsect2><para>
4993 #: apt_preferences.5.xml:693
4995 "The following command will cause APT to upgrade the specified package to the "
4996 "latest version from the <literal>sid</literal> distribution. Thereafter, "
4997 "<command>apt-get upgrade</command> will upgrade the package to the most "
4998 "recent <literal>&testing-codename;</literal> version if that is more recent "
4999 "than the installed version, otherwise, to the most recent "
5000 "<literal>sid</literal> version if that is more recent than the installed "
5001 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5004 #. type: Content of: <refentry><refsect1><para>
5005 #: apt_preferences.5.xml:717
5006 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5009 #. type: Content of: <refentry><refnamediv><refpurpose>
5010 #: sources.list.5.xml:29
5011 msgid "List of configured APT data sources"
5014 #. type: Content of: <refentry><refsect1><para>
5015 #: sources.list.5.xml:34
5017 "The source list <filename>/etc/apt/sources.list</filename> and the the files "
5018 "contained in <filename>/etc/apt/sources.list.d/</filename> are designed to "
5019 "support any number of active sources and a variety of source media. The "
5020 "files list one source per line (one line style) or contain multiline stanzas "
5021 "defining one or more sources per stanza (deb822 style), with the most "
5022 "preferred source listed first (in case a single version is available from "
5023 "more than one source). The information available from the configured sources "
5024 "is acquired by <command>apt-get update</command> (or by an equivalent "
5025 "command from another APT front-end)."
5028 #. type: Content of: <refentry><refsect1><title>
5029 #: sources.list.5.xml:45
5030 msgid "sources.list.d"
5033 #. type: Content of: <refentry><refsect1><para>
5034 #: sources.list.5.xml:46
5036 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5037 "add sources.list entries in separate files. Two different file formats are "
5038 "allowed as described in the next two sections. Filenames need to have "
5039 "either the extension <filename>.list</filename> or "
5040 "<filename>.sources</filename> depending on the contained format. The "
5041 "filenames may only contain letters (a-z and A-Z), digits (0-9), underscore "
5042 "(_), hyphen (-) and period (.) characters. Otherwise APT will print a "
5043 "notice that it has ignored a file, unless that file matches a pattern in the "
5044 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
5045 "case it will be silently ignored."
5048 #. type: Content of: <refentry><refsect1><title>
5049 #: sources.list.5.xml:58
5050 msgid "one line style format"
5053 #. type: Content of: <refentry><refsect1><para>
5054 #: sources.list.5.xml:60
5056 "Files in this format have the extension <filename>.list</filename>. Each "
5057 "line specifying a source starts with a type "
5058 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
5059 "this type. Individual entries cannot be continued onto a following "
5060 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
5061 "on a line marks the remainder of that line as a comment. Consequently an "
5062 "entry can be disabled by commenting out the entire line. If options should "
5063 "be provided they are separated by spaces and all of them together are "
5064 "enclosed by square brackets (<literal>[]</literal>) included in the line "
5065 "after the type separated from it with a space. If an option allows multiple "
5066 "values these are separated from each other with a comma "
5067 "(<literal>,</literal>). An option name is separated from its value(s) by a "
5068 "equal sign (<literal>=</literal>). Multivalue options have also "
5069 "<literal>-=</literal> and <literal>+=</literal> as separator which instead "
5070 "of replacing the default with the given value(s) modify the default value(s) "
5071 "to remove or include the given values."
5074 #. type: Content of: <refentry><refsect1><para>
5075 #: sources.list.5.xml:79
5077 "This is the traditional format and supported by all apt versions. Note that "
5078 "not all options as described below are supported by all apt versions. Note "
5079 "also that some older applications parsing this format on its own might not "
5080 "expect to encounter options as they were uncommon before the introduction of "
5081 "multi-architecture support."
5084 #. type: Content of: <refentry><refsect1><title>
5085 #: sources.list.5.xml:87
5086 msgid "deb822 style format"
5089 #. type: Content of: <refentry><refsect1><para>
5090 #: sources.list.5.xml:89
5092 "Files in this format have the extension <filename>.sources</filename>. The "
5093 "format is similar in syntax to other files used by Debian and its "
5094 "derivatives, like the metadata itself apt will download from the configured "
5095 "sources or the <filename>debian/control</filename> file in a Debian source "
5096 "package. Individual entries are separated by an empty line, additional "
5097 "empty lines are ignored, and a <literal>#</literal> character at the start "
5098 "of the line marks the entire line as a comment. An entry can hence be "
5099 "disabled by commenting out each line belonging to the stanza, but it is "
5100 "usually easier to add the field \"Enabled: no\" to the stanza to disable the "
5101 "entry. Removing the field or setting it to yes reenables it. Options have "
5102 "the same syntax as every other field: A fieldname separated by a colon "
5103 "(<literal>:</literal>) and optionally spaces from its value(s). Note "
5104 "especially that multiple values are separated by spaces, not by commas as in "
5105 "the one line format. Multivalue fields like <literal>Architectures</literal> "
5106 "also have <literal>Architectures-Add</literal> and "
5107 "<literal>Architectures-Remove</literal> to modify the default value rather "
5108 "than replacing it."
5111 #. type: Content of: <refentry><refsect1><para>
5112 #: sources.list.5.xml:108
5114 "This is a new format supported by apt itself since version 1.1. Previous "
5115 "versions ignore such files with a notice message as described earlier. It "
5116 "is intended to make this format gradually the default format and deprecating "
5117 "the previously described one line style format as it is easier to create, "
5118 "extend and modify by humans and machines alike especially if a lot of "
5119 "sources and/or options are involved. Developers who are working with and/or "
5120 "parsing apt sources are highly encouraged to add support for this format and "
5121 "to contact the APT team to coordinate and share this work. Users can freely "
5122 "adopt this format already, but could encounter problems with software not "
5123 "supporting the format yet."
5126 #. type: Content of: <refentry><refsect1><title>
5127 #: sources.list.5.xml:123
5128 msgid "The deb and deb-src types: General Format"
5131 #. type: Content of: <refentry><refsect1><para>
5132 #: sources.list.5.xml:124
5134 "The <literal>deb</literal> type references a typical two-level Debian "
5135 "archive, <filename>distribution/component</filename>. The "
5136 "<literal>distribution</literal> is generally a suite name like "
5137 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5138 "<literal>&stable-codename;</literal> or "
5139 "<literal>&testing-codename;</literal> while component is one of "
5140 "<literal>main</literal>, <literal>contrib</literal> or "
5141 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
5142 "a Debian distribution's source code in the same form as the "
5143 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5144 "to fetch source indexes."
5147 #. type: Content of: <refentry><refsect1><para>
5148 #: sources.list.5.xml:135
5150 "The format for two one line style entries using the <literal>deb</literal> "
5151 "and <literal>deb-src</literal> types is:"
5154 #. type: Content of: <refentry><refsect1><literallayout>
5155 #: sources.list.5.xml:138
5158 "deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] "
5160 "deb-src [ option1=value1 option2=value2 ] uri suite [component1] "
5161 "[component2] [...]"
5164 #. type: Content of: <refentry><refsect1><para><literallayout>
5165 #: sources.list.5.xml:143
5168 " Types: deb deb-src\n"
5171 " Components: [component1] [component2] [...]\n"
5172 " option1: value1\n"
5173 " option2: value2\n"
5177 #. type: Content of: <refentry><refsect1><para>
5178 #: sources.list.5.xml:141
5180 "Alternatively the equivalent entry in deb822 style looks like this: "
5181 "<placeholder type=\"literallayout\" id=\"0\"/>"
5184 #. type: Content of: <refentry><refsect1><para>
5185 #: sources.list.5.xml:152
5187 "The URI for the <literal>deb</literal> type must specify the base of the "
5188 "Debian distribution, from which APT will find the information it needs. "
5189 "<literal>suite</literal> can specify an exact path, in which case the "
5190 "components must be omitted and <literal>suite</literal> must end with a "
5191 "slash (<literal>/</literal>). This is useful for the case when only a "
5192 "particular sub-directory of the archive denoted by the URI is of interest. "
5193 "If <literal>suite</literal> does not specify an exact path, at least one "
5194 "<literal>component</literal> must be present."
5197 #. type: Content of: <refentry><refsect1><para>
5198 #: sources.list.5.xml:161
5200 "<literal>suite</literal> may also contain a variable, "
5201 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
5202 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
5203 "system. This permits architecture-independent "
5204 "<filename>sources.list</filename> files to be used. In general this is only "
5205 "of interest when specifying an exact path, <literal>APT</literal> will "
5206 "automatically generate a URI with the current architecture otherwise."
5209 #. type: Content of: <refentry><refsect1><para>
5210 #: sources.list.5.xml:169
5212 "Especially in the one line style format since only one distribution can be "
5213 "specified per line it may be necessary to have multiple lines for the same "
5214 "URI, if a subset of all available distributions or components at that "
5215 "location is desired. APT will sort the URI list after it has generated a "
5216 "complete set internally, and will collapse multiple references to the same "
5217 "Internet host, for instance, into a single connection, so that it does not "
5218 "inefficiently establish a connection, close it, do something else, and then "
5219 "re-establish a connection to that same host. APT also parallelizes "
5220 "connections to different hosts to more effectively deal with sites with low "
5224 #. type: Content of: <refentry><refsect1><para>
5225 #: sources.list.5.xml:181
5227 "It is important to list sources in order of preference, with the most "
5228 "preferred source listed first. Typically this will result in sorting by "
5229 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5230 "followed by distant Internet hosts, for example)."
5233 #. type: Content of: <refentry><refsect1><para><literallayout>
5234 #: sources.list.5.xml:188
5236 msgid "&sourceslist-list-format;"
5239 #. type: Content of: <refentry><refsect1><para><literallayout>
5240 #: sources.list.5.xml:190
5242 msgid "&sourceslist-sources-format;"
5245 #. type: Content of: <refentry><refsect1><para>
5246 #: sources.list.5.xml:186
5248 "As an example, the sources for your distribution could look like this in one "
5249 "line style format: <placeholder type=\"literallayout\" id=\"0\"/> or like "
5250 "this in deb822 style format: <placeholder type=\"literallayout\" id=\"1\"/>"
5253 #. type: Content of: <refentry><refsect1><title>
5254 #: sources.list.5.xml:193
5255 msgid "The deb and deb-src types: Options"
5258 #. type: Content of: <refentry><refsect1><para>
5259 #: sources.list.5.xml:194
5261 "Each source entry can have options specified modifying which and how the "
5262 "source is accessed and data acquired from it. Format, syntax and names of "
5263 "the options varies between the two formats one line and deb822 style as "
5264 "described, but they have both the same options available. For simplicity we "
5265 "list the deb822 fieldname and provide the one line name in brackets. "
5266 "Remember that beside setting multivalue options explicitly, there is also "
5267 "the option to modify them based on the default, but we aren't listing those "
5268 "names explicitly here. Unsupported options are silently ignored by all APT "
5272 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5273 #: sources.list.5.xml:205
5275 "<option>Architectures</option> (<option>arch</option>) is a multivalue "
5276 "option defining for which architectures information should be downloaded. If "
5277 "this option isn't set the default is all architectures as defined by the "
5278 "<option>APT::Architectures</option> config option."
5281 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5282 #: sources.list.5.xml:212
5284 "<option>Languages</option> (<option>lang</option>) is a multivalue option "
5285 "defining for which languages information like translated package "
5286 "descriptions should be downloaded. If this option isn't set the default is "
5287 "all languages as defined by the <option>Acquire::Languages</option> config "
5291 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5292 #: sources.list.5.xml:220
5294 "<option>Targets</option> (<option>target</option>) is a multivalue option "
5295 "defining which download targets apt will try to acquire from this source. If "
5296 "not specified, the default set is defined by the "
5297 "<option>Acquire::IndexTargets</option> configuration scope. Aditionally, "
5298 "specific targets can be enabled or disabled by using the identifier as field "
5299 "name instead of using this multivalue option."
5302 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5303 #: sources.list.5.xml:230
5305 "<option>PDiffs</option> (<option>pdiffs</option>) is a yes/no value which "
5306 "controls if APT should try to use PDiffs to update old indexes instead of "
5307 "downloading the new indexes entirely. The value of this option is ignored if "
5308 "the repository doesn't announce the availability of PDiffs. Defaults to the "
5309 "value of the option with the same name for a specific index file defined in "
5310 "the <option>Acquire::IndexTargets</option> scope, which itself default to "
5311 "the value of configuration option <option>Acquire::PDiffs</option> which "
5312 "defaults to <literal>yes</literal>."
5315 #. type: Content of: <refentry><refsect1><para>
5316 #: sources.list.5.xml:245
5318 "Further more, there are options which if set effect <emphasis>all</emphasis> "
5319 "sources with the same URI and Suite, so they have to be set on all such "
5320 "entries and can not be varied between different components. APT will try to "
5321 "detect and error out on such anomalies."
5324 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5325 #: sources.list.5.xml:252
5327 "<option>Signed-By</option> (<option>signed-by</option>) is either an "
5328 "absolute path to a keyring file (has to be accessible and readable for the "
5329 "<literal>_apt</literal> user, so ensure everyone has read-permissions on the "
5330 "file) or a fingerprint of a key in either the "
5331 "<filename>trusted.gpg</filename> keyring or in one of the keyrings in the "
5332 "<filename>trusted.gpg.d/</filename> directory (see <command>apt-key "
5333 "fingerprint</command>). If the option is set only the key(s) in this keyring "
5334 "or only the key with this fingerprint is used for the &apt-secure; "
5335 "verification of this repository. Otherwise all keys in the trusted keyrings "
5336 "are considered valid signers for this repository."
5339 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5340 #: sources.list.5.xml:266
5342 "<option>Check-Valid-Until</option> (<option>check-valid-until</option>) is "
5343 "a yes/no value which controls if APT should try to detect replay attacks. A "
5344 "repository creator can declare until then the data provided in the "
5345 "repository should be considered valid and if this time is reached, but no "
5346 "new data is provided the data is considered expired and an error is raised. "
5347 "Beside increasing security as a malicious attacker can't sent old data "
5348 "forever denying a user to be able to upgrade to a new version, this also "
5349 "helps users identify mirrors which are no longer updated. Some repositories "
5350 "like historic archives aren't updated anymore by design through, so this "
5351 "check can be disabled by setting this option to <literal>no</literal>. "
5352 "Defaults to the value of configuration option "
5353 "<option>Acquire::Check-Valid-Until</option> which itself defaults to "
5354 "<literal>yes</literal>."
5357 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5358 #: sources.list.5.xml:283
5360 "<option>Valid-Until-Min</option> (<option>valid-until-min</option>) and "
5361 "<option>Valid-Until-Max</option> (<option>valid-until-max</option>) can be "
5362 "used to raise or lower the time period in seconds in which the data from "
5363 "this repository is considered valid. -Max can be especially useful if the "
5364 "repository provides no Valid-Until field on its Release file to set your own "
5365 "value, while -Min can be used to increase the valid time on seldom updated "
5366 "(local) mirrors of a more frequently updated but less accessible archive "
5367 "(which is in the sources.list as well) instead of disabling the check "
5368 "entirely. Default to the value of the configuration options "
5369 "<option>Acquire::Min-ValidTime</option> and "
5370 "<option>Acquire::Max-ValidTime</option> which are both unset by default."
5373 #. type: Content of: <refentry><refsect1><title>
5374 #: sources.list.5.xml:305
5375 msgid "URI specification"
5378 #. type: Content of: <refentry><refsect1><para>
5379 #: sources.list.5.xml:307
5380 msgid "The currently recognized URI types are:"
5383 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5384 #: sources.list.5.xml:311
5386 "The file scheme allows an arbitrary directory in the file system to be "
5387 "considered an archive. This is useful for NFS mounts and local mirrors or "
5391 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5392 #: sources.list.5.xml:318
5394 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5395 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5399 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5400 #: sources.list.5.xml:325
5402 "The http scheme specifies an HTTP server for the archive. If an environment "
5403 "variable <envar>http_proxy</envar> is set with the format "
5404 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5405 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5406 "the format http://user:pass@server:port/. Note that this is an insecure "
5407 "method of authentication."
5410 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5411 #: sources.list.5.xml:336
5413 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5414 "is highly configurable; for more information see the &apt-conf; manual "
5415 "page. Please note that an FTP proxy can be specified by using the "
5416 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5417 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5418 "environment variable and <emphasis>only</emphasis> this environment "
5419 "variable. Proxies using HTTP specified in the configuration file will be "
5423 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5424 #: sources.list.5.xml:348
5426 "The copy scheme is identical to the file scheme except that packages are "
5427 "copied into the cache directory instead of used directly at their location. "
5428 "This is useful for people using removable media to copy files around with "
5432 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5433 #: sources.list.5.xml:355
5435 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5436 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5437 "recommended. The standard <command>find</command> and <command>dd</command> "
5438 "commands are used to perform the file transfers from the remote host."
5441 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5442 #: sources.list.5.xml:362
5443 msgid "adding more recognizable URI types"
5446 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5447 #: sources.list.5.xml:364
5449 "APT can be extended with more methods shipped in other optional packages, "
5450 "which should follow the naming scheme "
5451 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5452 "instance, the APT team also maintains the package "
5453 "<package>apt-transport-https</package>, which provides access methods for "
5454 "HTTPS URIs with features similar to the http method. Methods for using "
5455 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5458 #. type: Content of: <refentry><refsect1><para>
5459 #: sources.list.5.xml:376
5461 "Uses the archive stored locally (or NFS mounted) at /home/apt/debian for "
5462 "stable/main, stable/contrib, and stable/non-free."
5465 #. type: Content of: <refentry><refsect1><literallayout>
5466 #: sources.list.5.xml:378
5468 msgid "deb file:/home/apt/debian stable main contrib non-free"
5471 #. type: Content of: <refentry><refsect1><literallayout>
5472 #: sources.list.5.xml:379
5476 "URIs: file:/home/apt/debian\n"
5478 "Components: main contrib non-free"
5481 #. type: Content of: <refentry><refsect1><para>
5482 #: sources.list.5.xml:384
5483 msgid "As above, except this uses the unstable (development) distribution."
5486 #. type: Content of: <refentry><refsect1><literallayout>
5487 #: sources.list.5.xml:385
5489 msgid "deb file:/home/apt/debian unstable main contrib non-free"
5492 #. type: Content of: <refentry><refsect1><literallayout>
5493 #: sources.list.5.xml:386
5497 "URIs: file:/home/apt/debian\n"
5498 "Suites: unstable\n"
5499 "Components: main contrib non-free"
5502 #. type: Content of: <refentry><refsect1><para>
5503 #: sources.list.5.xml:391
5504 msgid "Source line for the above"
5507 #. type: Content of: <refentry><refsect1><literallayout>
5508 #: sources.list.5.xml:392
5510 msgid "deb-src file:/home/apt/debian unstable main contrib non-free"
5513 #. type: Content of: <refentry><refsect1><literallayout>
5514 #: sources.list.5.xml:393
5518 "URIs: file:/home/apt/debian\n"
5519 "Suites: unstable\n"
5520 "Components: main contrib non-free"
5523 #. type: Content of: <refentry><refsect1><para>
5524 #: sources.list.5.xml:399
5526 "The first line gets package information for the architectures in "
5527 "<literal>APT::Architectures</literal> while the second always retrieves "
5528 "<literal>amd64</literal> and <literal>armel</literal>."
5531 #. type: Content of: <refentry><refsect1><literallayout>
5532 #: sources.list.5.xml:401
5535 "deb http://httpredir.debian.org/debian &stable-codename; main\n"
5536 "deb [ arch=amd64,armel ] http://httpredir.debian.org/debian "
5537 "&stable-codename; main"
5540 #. type: Content of: <refentry><refsect1><literallayout>
5541 #: sources.list.5.xml:403
5545 "URIs: http://httpredir.debian.org/debian\n"
5546 "Suites: &stable-codename;\n"
5547 "Components: main\n"
5550 "URIs: http://httpredir.debian.org/debian\n"
5551 "Suites: &stable-codename;\n"
5552 "Components: main\n"
5553 "Architectures: amd64 armel\n"
5556 #. type: Content of: <refentry><refsect1><para>
5557 #: sources.list.5.xml:415
5559 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5563 #. type: Content of: <refentry><refsect1><literallayout>
5564 #: sources.list.5.xml:417
5566 msgid "deb http://archive.debian.org/debian-archive hamm main"
5569 #. type: Content of: <refentry><refsect1><literallayout>
5570 #: sources.list.5.xml:418
5574 "URIs: http://archive.debian.org/debian-archive\n"
5579 #. type: Content of: <refentry><refsect1><para>
5580 #: sources.list.5.xml:423
5582 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5583 "directory, and uses only the &stable-codename;/contrib area."
5586 #. type: Content of: <refentry><refsect1><literallayout>
5587 #: sources.list.5.xml:425
5589 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5592 #. type: Content of: <refentry><refsect1><literallayout>
5593 #: sources.list.5.xml:426
5597 "URIs: ftp://ftp.debian.org/debian\n"
5598 "Suites: &stable-codename;\n"
5599 "Components: contrib"
5602 #. type: Content of: <refentry><refsect1><para>
5603 #: sources.list.5.xml:431
5605 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5606 "directory, and uses only the unstable/contrib area. If this line appears as "
5607 "well as the one in the previous example in <filename>sources.list</filename> "
5608 "a single FTP session will be used for both resource lines."
5611 #. type: Content of: <refentry><refsect1><literallayout>
5612 #: sources.list.5.xml:435
5614 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5617 #. type: Content of: <refentry><refsect1><literallayout>
5618 #: sources.list.5.xml:436
5622 "URIs: ftp://ftp.debian.org/debian\n"
5623 "Suites: unstable\n"
5624 "Components: contrib"
5627 #. type: Content of: <refentry><refsect1><para><literallayout>
5628 #: sources.list.5.xml:448
5630 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5633 #. type: Content of: <refentry><refsect1><para><literallayout>
5634 #: sources.list.5.xml:449
5638 "URIs: http://ftp.tlh.debian.org/universe\n"
5639 "Suites: unstable/binary-$(ARCH)/"
5642 #. type: Content of: <refentry><refsect1><para>
5643 #: sources.list.5.xml:441
5645 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5646 "directory, and uses only files found under "
5647 "<filename>unstable/binary-i386</filename> on i386 machines, "
5648 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5649 "supported architectures. [Note this example only illustrates how to use the "
5650 "substitution variable; official debian archives are not structured like "
5651 "this] <placeholder type=\"literallayout\" id=\"0\"/> <placeholder "
5652 "type=\"literallayout\" id=\"1\"/>"
5655 #. type: Content of: <refentry><refsect1><para>
5656 #: sources.list.5.xml:454
5658 "Uses HTTP to get binary packages as well as sources from the stable, testing "
5659 "and unstable suites and the components main and contrib."
5662 #. type: Content of: <refentry><refsect1><literallayout>
5663 #: sources.list.5.xml:456
5666 "deb http://httpredir.debian.org/debian stable main contrib\n"
5667 "deb-src http://httpredir.debian.org/debian stable main contrib\n"
5668 "deb http://httpredir.debian.org/debian testing main contrib\n"
5669 "deb-src http://httpredir.debian.org/debian testing main contrib\n"
5670 "deb http://httpredir.debian.org/debian unstable main contrib\n"
5671 "deb-src http://httpredir.debian.org/debian unstable main contrib"
5674 #. type: Content of: <refentry><refsect1><literallayout>
5675 #: sources.list.5.xml:462
5678 "Types: deb deb-src\n"
5679 "URIs: http://httpredir.debian.org/debian\n"
5680 "Suites: stable testing unstable\n"
5681 "Components: main contrib\n"
5684 #. type: Content of: <refentry><refsect1><para>
5685 #: sources.list.5.xml:471
5686 msgid "&apt-get;, &apt-conf;"
5689 #. type: Content of: <refentry><refmeta><manvolnum>
5690 #: apt-extracttemplates.1.xml:22 apt-sortpkgs.1.xml:22 apt-ftparchive.1.xml:22
5694 #. type: Content of: <refentry><refnamediv><refpurpose>
5695 #: apt-extracttemplates.1.xml:29
5697 "Utility to extract <command>debconf</command> config and templates from "
5701 #. type: Content of: <refentry><refsect1><para>
5702 #: apt-extracttemplates.1.xml:35
5704 "<command>apt-extracttemplates</command> will take one or more Debian package "
5705 "files as input and write out (to a temporary directory) all associated "
5706 "config scripts and template files. For each passed in package that contains "
5707 "config scripts and templates, one line of output will be generated in the "
5711 #. type: Content of: <refentry><refsect1><para>
5712 #: apt-extracttemplates.1.xml:40
5713 msgid "package version template-file config-script"
5716 #. type: Content of: <refentry><refsect1><para>
5717 #: apt-extracttemplates.1.xml:41
5719 "template-file and config-script are written to the temporary directory "
5720 "specified by the <option>-t</option> or <option>--tempdir</option> "
5721 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5722 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5723 "<filename>package.config.XXXXXX</filename>"
5726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5727 #: apt-extracttemplates.1.xml:54
5729 "Temporary directory in which to write extracted <command>debconf</command> "
5730 "template files and config scripts. Configuration Item: "
5731 "<literal>APT::ExtractTemplates::TempDir</literal>"
5734 #. type: Content of: <refentry><refsect1><para>
5735 #: apt-extracttemplates.1.xml:71
5737 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5738 "decimal 100 on error."
5741 #. type: Content of: <refentry><refnamediv><refpurpose>
5742 #: apt-sortpkgs.1.xml:29
5743 msgid "Utility to sort package index files"
5746 #. type: Content of: <refentry><refsect1><para>
5747 #: apt-sortpkgs.1.xml:35
5749 "<command>apt-sortpkgs</command> will take an index file (source index or "
5750 "package index) and sort the records so that they are ordered by the package "
5751 "name. It will also sort the internal fields of each record according to the "
5752 "internal sorting rules."
5755 #. type: Content of: <refentry><refsect1><para>
5756 #: apt-sortpkgs.1.xml:41
5757 msgid "All output is sent to standard output; the input must be a seekable file."
5760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5761 #: apt-sortpkgs.1.xml:50
5763 "Use source index field ordering. Configuration Item: "
5764 "<literal>APT::SortPkgs::Source</literal>."
5767 #. type: Content of: <refentry><refsect1><para>
5768 #: apt-sortpkgs.1.xml:64
5770 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5774 #. type: Content of: <refentry><refnamediv><refpurpose>
5775 #: apt-ftparchive.1.xml:29
5776 msgid "Utility to generate index files"
5779 #. type: Content of: <refentry><refsect1><para>
5780 #: apt-ftparchive.1.xml:35
5782 "<command>apt-ftparchive</command> is the command line tool that generates "
5783 "the index files that APT uses to access a distribution source. The index "
5784 "files should be generated on the origin site based on the content of that "
5788 #. type: Content of: <refentry><refsect1><para>
5789 #: apt-ftparchive.1.xml:39
5791 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5792 "program, incorporating its entire functionality via the "
5793 "<literal>packages</literal> command. It also contains a contents file "
5794 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5795 "the generation process for a complete archive."
5798 #. type: Content of: <refentry><refsect1><para>
5799 #: apt-ftparchive.1.xml:45
5801 "Internally <command>apt-ftparchive</command> can make use of binary "
5802 "databases to cache the contents of a .deb file and it does not rely on any "
5803 "external programs aside from &gzip;. When doing a full generate it "
5804 "automatically performs file-change checks and builds the desired compressed "
5808 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5809 #: apt-ftparchive.1.xml:56
5811 "The packages command generates a package file from a directory tree. It "
5812 "takes the given directory and recursively searches it for .deb files, "
5813 "emitting a package record to stdout for each. This command is approximately "
5814 "equivalent to &dpkg-scanpackages;."
5817 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5818 #: apt-ftparchive.1.xml:61 apt-ftparchive.1.xml:85
5819 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5823 #: apt-ftparchive.1.xml:66
5825 "The <literal>sources</literal> command generates a source index file from a "
5826 "directory tree. It takes the given directory and recursively searches it "
5827 "for .dsc files, emitting a source record to stdout for each. This command is "
5828 "approximately equivalent to &dpkg-scansources;."
5831 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5832 #: apt-ftparchive.1.xml:71
5834 "If an override file is specified then a source override file will be looked "
5835 "for with an extension of .src. The --source-override option can be used to "
5836 "change the source override file that will be used."
5839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5840 #: apt-ftparchive.1.xml:78
5842 "The <literal>contents</literal> command generates a contents file from a "
5843 "directory tree. It takes the given directory and recursively searches it for "
5844 ".deb files, and reads the file list from each file. It then sorts and writes "
5845 "to stdout the list of files matched to packages. Directories are not written "
5846 "to the output. If multiple packages own the same file then each package is "
5847 "separated by a comma in the output."
5850 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5851 #: apt-ftparchive.1.xml:90
5853 "The <literal>release</literal> command generates a Release file from a "
5854 "directory tree. It recursively searches the given directory for uncompressed "
5855 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5856 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5857 "<command>lzma</command> as well as <filename>Release</filename> and "
5858 "<filename>md5sum.txt</filename> files by default "
5859 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5860 "filename patterns can be added by listing them in "
5861 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5862 "stdout a <filename>Release</filename> file containing an MD5, SHA1 and "
5863 "SHA256 digest for each file."
5866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5867 #: apt-ftparchive.1.xml:100
5869 "Values for the additional metadata fields in the Release file are taken from "
5870 "the corresponding variables under "
5871 "<literal>APT::FTPArchive::Release</literal>, "
5872 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5873 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5874 "<literal>Suite</literal>, <literal>Version</literal>, "
5875 "<literal>Codename</literal>, <literal>Date</literal>, "
5876 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5877 "<literal>Components</literal>, <literal>Description</literal>."
5880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5881 #: apt-ftparchive.1.xml:113
5883 "The <literal>generate</literal> command is designed to be runnable from a "
5884 "cron script and builds indexes according to the given config file. The "
5885 "config language provides a flexible means of specifying which index files "
5886 "are built from which directories, as well as providing a simple means of "
5887 "maintaining the required settings."
5890 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5891 #: apt-ftparchive.1.xml:122
5893 "The <literal>clean</literal> command tidies the databases used by the given "
5894 "configuration file by removing any records that are no longer necessary."
5897 #. type: Content of: <refentry><refsect1><title>
5898 #: apt-ftparchive.1.xml:128
5899 msgid "The Generate Configuration"
5902 #. type: Content of: <refentry><refsect1><para>
5903 #: apt-ftparchive.1.xml:130
5905 "The <literal>generate</literal> command uses a configuration file to "
5906 "describe the archives that are going to be generated. It follows the typical "
5907 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5908 "&apt-conf; contains a description of the syntax. Note that the generate "
5909 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5910 "tree manner. This only effects how the scope tag is handled."
5913 #. type: Content of: <refentry><refsect1><para>
5914 #: apt-ftparchive.1.xml:138
5915 msgid "The generate configuration has four separate sections, each described below."
5918 #. type: Content of: <refentry><refsect1><refsect2><title>
5919 #: apt-ftparchive.1.xml:140
5920 msgid "<literal>Dir</literal> Section"
5923 #. type: Content of: <refentry><refsect1><refsect2><para>
5924 #: apt-ftparchive.1.xml:142
5926 "The <literal>Dir</literal> section defines the standard directories needed "
5927 "to locate the files required during the generation process. These "
5928 "directories are prepended certain relative paths defined in later sections "
5929 "to produce a complete an absolute path."
5932 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5933 #: apt-ftparchive.1.xml:149
5935 "Specifies the root of the FTP archive, in a standard Debian configuration "
5936 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5940 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5941 #: apt-ftparchive.1.xml:156
5942 msgid "Specifies the location of the override files."
5945 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5946 #: apt-ftparchive.1.xml:161
5947 msgid "Specifies the location of the cache files."
5950 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5951 #: apt-ftparchive.1.xml:166
5953 "Specifies the location of the file list files, if the "
5954 "<literal>FileList</literal> setting is used below."
5957 #. type: Content of: <refentry><refsect1><refsect2><title>
5958 #: apt-ftparchive.1.xml:172
5959 msgid "<literal>Default</literal> Section"
5962 #. type: Content of: <refentry><refsect1><refsect2><para>
5963 #: apt-ftparchive.1.xml:174
5965 "The <literal>Default</literal> section specifies default values, and "
5966 "settings that control the operation of the generator. Other sections may "
5967 "override these defaults with a per-section setting."
5970 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5971 #: apt-ftparchive.1.xml:180
5973 "Sets the default compression schemes to use for the package index files. It "
5974 "is a string that contains a space separated list of at least one of: '.' (no "
5975 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
5979 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5980 #: apt-ftparchive.1.xml:188
5982 "Sets the default list of file extensions that are package files. This "
5983 "defaults to '.deb'."
5986 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5987 #: apt-ftparchive.1.xml:194
5989 "This is similar to <literal>Packages::Compress</literal> except that it "
5990 "controls the compression for the Sources files."
5993 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5994 #: apt-ftparchive.1.xml:200
5996 "Sets the default list of file extensions that are source files. This "
5997 "defaults to '.dsc'."
6000 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6001 #: apt-ftparchive.1.xml:206
6003 "This is similar to <literal>Packages::Compress</literal> except that it "
6004 "controls the compression for the Contents files."
6007 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6008 #: apt-ftparchive.1.xml:212
6010 "This is similar to <literal>Packages::Compress</literal> except that it "
6011 "controls the compression for the Translation-en master file."
6014 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6015 #: apt-ftparchive.1.xml:218
6017 "Specifies the number of kilobytes to delink (and replace with hard links) "
6018 "per run. This is used in conjunction with the per-section "
6019 "<literal>External-Links</literal> setting."
6022 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6023 #: apt-ftparchive.1.xml:225
6025 "Specifies the mode of all created index files. It defaults to 0644. All "
6026 "index files are set to this mode with no regard to the umask."
6029 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6030 #: apt-ftparchive.1.xml:232 apt-ftparchive.1.xml:378
6032 "Specifies whether long descriptions should be included in the "
6033 "<filename>Packages</filename> file or split out into a master "
6034 "<filename>Translation-en</filename> file."
6037 #. type: Content of: <refentry><refsect1><refsect2><title>
6038 #: apt-ftparchive.1.xml:238
6039 msgid "<literal>TreeDefault</literal> Section"
6042 #. type: Content of: <refentry><refsect1><refsect2><para>
6043 #: apt-ftparchive.1.xml:240
6045 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
6046 "variables are substitution variables and have the strings $(DIST), "
6047 "$(SECTION) and $(ARCH) replaced with their respective values."
6050 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6051 #: apt-ftparchive.1.xml:247
6053 "Sets the number of kilobytes of contents files that are generated each "
6054 "day. The contents files are round-robined so that over several days they "
6055 "will all be rebuilt."
6058 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6059 #: apt-ftparchive.1.xml:254
6061 "Controls the number of days a contents file is allowed to be checked without "
6062 "changing. If this limit is passed the mtime of the contents file is "
6063 "updated. This case can occur if the package file is changed in such a way "
6064 "that does not result in a new contents file [override edit for instance]. A "
6065 "hold off is allowed in hopes that new .debs will be installed, requiring a "
6066 "new file anyhow. The default is 10, the units are in days."
6069 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6070 #: apt-ftparchive.1.xml:265
6072 "Sets the top of the .deb directory tree. Defaults to "
6073 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
6076 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6077 #: apt-ftparchive.1.xml:271
6079 "Sets the top of the source package directory tree. Defaults to "
6080 "<filename>$(DIST)/$(SECTION)/source/</filename>"
6083 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6084 #: apt-ftparchive.1.xml:277
6086 "Sets the output Packages file. Defaults to "
6087 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
6090 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6091 #: apt-ftparchive.1.xml:283
6093 "Sets the output Sources file. Defaults to "
6094 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
6097 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6098 #: apt-ftparchive.1.xml:289
6100 "Sets the output Translation-en master file with the long descriptions if "
6101 "they should be not included in the Packages file. Defaults to "
6102 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
6105 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6106 #: apt-ftparchive.1.xml:296
6108 "Sets the path prefix that causes a symlink to be considered an internal link "
6109 "instead of an external link. Defaults to "
6110 "<filename>$(DIST)/$(SECTION)/</filename>"
6113 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6114 #: apt-ftparchive.1.xml:303
6116 "Sets the output Contents file. Defaults to "
6117 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
6118 "causes multiple Packages files to map onto a single Contents file (as is the "
6119 "default) then <command>apt-ftparchive</command> will integrate those "
6120 "package files together automatically."
6123 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6124 #: apt-ftparchive.1.xml:312
6125 msgid "Sets header file to prepend to the contents output."
6128 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6129 #: apt-ftparchive.1.xml:317
6131 "Sets the binary cache database to use for this section. Multiple sections "
6132 "can share the same database."
6135 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6136 #: apt-ftparchive.1.xml:323
6138 "Specifies that instead of walking the directory tree, "
6139 "<command>apt-ftparchive</command> should read the list of files from the "
6140 "given file. Relative files names are prefixed with the archive directory."
6143 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6144 #: apt-ftparchive.1.xml:330
6146 "Specifies that instead of walking the directory tree, "
6147 "<command>apt-ftparchive</command> should read the list of files from the "
6148 "given file. Relative files names are prefixed with the archive directory. "
6149 "This is used when processing source indexes."
6152 #. type: Content of: <refentry><refsect1><refsect2><title>
6153 #: apt-ftparchive.1.xml:338
6154 msgid "<literal>Tree</literal> Section"
6157 #. type: Content of: <refentry><refsect1><refsect2><para>
6158 #: apt-ftparchive.1.xml:340
6160 "The <literal>Tree</literal> section defines a standard Debian file tree "
6161 "which consists of a base directory, then multiple sections in that base "
6162 "directory and finally multiple Architectures in each section. The exact "
6163 "pathing used is defined by the <literal>Directory</literal> substitution "
6167 #. type: Content of: <refentry><refsect1><refsect2><para>
6168 #: apt-ftparchive.1.xml:345
6170 "The <literal>Tree</literal> section takes a scope tag which sets the "
6171 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
6172 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
6173 "setting such as <filename>dists/&stable-codename;</filename>."
6176 #. type: Content of: <refentry><refsect1><refsect2><para>
6177 #: apt-ftparchive.1.xml:350
6179 "All of the settings defined in the <literal>TreeDefault</literal> section "
6180 "can be used in a <literal>Tree</literal> section as well as three new "
6184 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6185 #: apt-ftparchive.1.xml:356
6188 "for i in Sections do \n"
6189 " for j in Architectures do\n"
6190 " Generate for DIST=scope SECTION=i ARCH=j\n"
6194 #. type: Content of: <refentry><refsect1><refsect2><para>
6195 #: apt-ftparchive.1.xml:353
6197 "When processing a <literal>Tree</literal> section "
6198 "<command>apt-ftparchive</command> performs an operation similar to: "
6199 "<placeholder type=\"programlisting\" id=\"0\"/>"
6202 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6203 #: apt-ftparchive.1.xml:364
6205 "This is a space separated list of sections which appear under the "
6206 "distribution; typically this is something like <literal>main contrib "
6207 "non-free</literal>"
6210 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6211 #: apt-ftparchive.1.xml:371
6213 "This is a space separated list of all the architectures that appear under "
6214 "search section. The special architecture 'source' is used to indicate that "
6215 "this tree has a source archive."
6218 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6219 #: apt-ftparchive.1.xml:384
6221 "Sets the binary override file. The override file contains section, priority "
6222 "and maintainer address information."
6225 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6226 #: apt-ftparchive.1.xml:390
6228 "Sets the source override file. The override file contains section "
6232 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6233 #: apt-ftparchive.1.xml:396 apt-ftparchive.1.xml:442
6234 msgid "Sets the binary extra override file."
6237 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6238 #: apt-ftparchive.1.xml:401 apt-ftparchive.1.xml:447
6239 msgid "Sets the source extra override file."
6242 #. type: Content of: <refentry><refsect1><refsect2><title>
6243 #: apt-ftparchive.1.xml:406
6244 msgid "<literal>BinDirectory</literal> Section"
6247 #. type: Content of: <refentry><refsect1><refsect2><para>
6248 #: apt-ftparchive.1.xml:408
6250 "The <literal>bindirectory</literal> section defines a binary directory tree "
6251 "with no special structure. The scope tag specifies the location of the "
6252 "binary directory and the settings are similar to the <literal>Tree</literal> "
6253 "section with no substitution variables or "
6254 "<literal>Section</literal><literal>Architecture</literal> settings."
6257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6258 #: apt-ftparchive.1.xml:416
6259 msgid "Sets the Packages file output."
6262 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6263 #: apt-ftparchive.1.xml:421
6265 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
6266 "<literal>Sources</literal> is required."
6269 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6270 #: apt-ftparchive.1.xml:427
6271 msgid "Sets the Contents file output (optional)."
6274 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6275 #: apt-ftparchive.1.xml:432
6276 msgid "Sets the binary override file."
6279 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6280 #: apt-ftparchive.1.xml:437
6281 msgid "Sets the source override file."
6284 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6285 #: apt-ftparchive.1.xml:452
6286 msgid "Sets the cache DB."
6289 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6290 #: apt-ftparchive.1.xml:457
6291 msgid "Appends a path to all the output paths."
6294 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6295 #: apt-ftparchive.1.xml:462
6296 msgid "Specifies the file list file."
6299 #. type: Content of: <refentry><refsect1><title>
6300 #: apt-ftparchive.1.xml:469
6301 msgid "The Binary Override File"
6304 #. type: Content of: <refentry><refsect1><para>
6305 #: apt-ftparchive.1.xml:470
6307 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
6308 "contains four fields separated by spaces. The first field is the package "
6309 "name, the second is the priority to force that package to, the third is the "
6310 "section to force that package to and the final field is the maintainer "
6311 "permutation field."
6314 #. type: Content of: <refentry><refsect1><para><literallayout>
6315 #: apt-ftparchive.1.xml:476
6317 msgid "old [// oldn]* => new"
6320 #. type: Content of: <refentry><refsect1><para><literallayout>
6321 #: apt-ftparchive.1.xml:478
6326 #. type: Content of: <refentry><refsect1><para>
6327 #: apt-ftparchive.1.xml:475
6329 "The general form of the maintainer field is: <placeholder "
6330 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
6331 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
6332 "separated list of old email addresses to be specified. If any of those are "
6333 "found then new is substituted for the maintainer field. The second form "
6334 "unconditionally substitutes the maintainer field."
6337 #. type: Content of: <refentry><refsect1><title>
6338 #: apt-ftparchive.1.xml:486
6339 msgid "The Source Override File"
6342 #. type: Content of: <refentry><refsect1><para>
6343 #: apt-ftparchive.1.xml:488
6345 "The source override file is fully compatible with &dpkg-scansources;. It "
6346 "contains two fields separated by spaces. The first field is the source "
6347 "package name, the second is the section to assign it."
6350 #. type: Content of: <refentry><refsect1><title>
6351 #: apt-ftparchive.1.xml:493
6352 msgid "The Extra Override File"
6355 #. type: Content of: <refentry><refsect1><para>
6356 #: apt-ftparchive.1.xml:495
6358 "The extra override file allows any arbitrary tag to be added or replaced in "
6359 "the output. It has three columns, the first is the package, the second is "
6360 "the tag and the remainder of the line is the new value."
6363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6364 #: apt-ftparchive.1.xml:506
6366 "Generate the given checksum. These options default to on, when turned off "
6367 "the generated index files will not have the checksum fields where possible. "
6368 "Configuration Items: "
6369 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
6370 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
6371 "where <literal><replaceable>Index</replaceable></literal> can be "
6372 "<literal>Packages</literal>, <literal>Sources</literal> or "
6373 "<literal>Release</literal> and "
6374 "<literal><replaceable>Checksum</replaceable></literal> can be "
6375 "<literal>MD5</literal>, <literal>SHA1</literal> or "
6376 "<literal>SHA256</literal>."
6379 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6380 #: apt-ftparchive.1.xml:517
6382 "Use a binary caching DB. This has no effect on the generate command. "
6383 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
6386 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6387 #: apt-ftparchive.1.xml:523
6389 "Quiet; produces output suitable for logging, omitting progress indicators. "
6390 "More q's will produce more quiet up to a maximum of 2. You can also use "
6391 "<option>-q=#</option> to set the quiet level, overriding the configuration "
6392 "file. Configuration Item: <literal>quiet</literal>."
6395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6396 #: apt-ftparchive.1.xml:531
6398 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
6399 "then this option actually enables delinking of the files. It defaults to on "
6400 "and can be turned off with <option>--no-delink</option>. Configuration "
6401 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
6404 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6405 #: apt-ftparchive.1.xml:539
6407 "Perform contents generation. When this option is set and package indexes are "
6408 "being generated with a cache DB then the file listing will also be extracted "
6409 "and stored in the DB for later use. When using the generate command this "
6410 "option also allows the creation of any Contents files. The default is on. "
6411 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
6414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6415 #: apt-ftparchive.1.xml:549
6417 "Select the source override file to use with the <literal>sources</literal> "
6418 "command. Configuration Item: "
6419 "<literal>APT::FTPArchive::SourceOverride</literal>."
6422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6423 #: apt-ftparchive.1.xml:555
6425 "Make the caching databases read only. Configuration Item: "
6426 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
6429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6430 #: apt-ftparchive.1.xml:560
6432 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
6433 "commands only package files matching <literal>*_arch.deb</literal> or "
6434 "<literal>*_all.deb</literal> instead of all package files in the given "
6435 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
6438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6439 #: apt-ftparchive.1.xml:568
6441 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
6442 "packages are recompiled and/or republished with the same version again, this "
6443 "will lead to problems as the now outdated cached metadata like size and "
6444 "checksums will be used. With this option enabled this will no longer happen "
6445 "as it will be checked if the file was changed. Note that this option is set "
6446 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
6447 "multiply versions/builds of a package with the same versionnumber, so in "
6448 "theory nobody will have these problems and therefore all these extra checks "
6452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6453 #: apt-ftparchive.1.xml:580
6455 "This configuration option defaults to \"<literal>true</literal>\" and should "
6456 "only be set to <literal>\"false\"</literal> if the Archive generated with "
6457 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
6458 "that the <filename>Translation-en</filename> master file can only be created "
6459 "in the generate command."
6462 #. type: Content of: <refentry><refsect1><para><programlisting>
6463 #: apt-ftparchive.1.xml:598
6466 "<command>apt-ftparchive</command> packages "
6467 "<replaceable>directory</replaceable> | <command>gzip</command> > "
6468 "<filename>Packages.gz</filename>\n"
6471 #. type: Content of: <refentry><refsect1><para>
6472 #: apt-ftparchive.1.xml:594
6474 "To create a compressed Packages file for a directory containing binary "
6475 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6478 #. type: Content of: <refentry><refsect1><para>
6479 #: apt-ftparchive.1.xml:608
6481 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6485 #. type: Attribute 'lang' of: <book>
6486 #: guide.dbk:9 offline.dbk:9
6490 #. type: Content of: <book><title>
6492 msgid "APT User's Guide"
6495 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6496 #: guide.dbk:17 offline.dbk:17
6497 msgid "Jason Gunthorpe"
6500 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6501 #: guide.dbk:17 offline.dbk:17
6502 msgid "jgg@debian.org"
6505 #. type: Content of: <book><bookinfo><releaseinfo>
6506 #: guide.dbk:21 offline.dbk:21
6507 msgid "Version &apt-product-version;"
6510 #. type: Content of: <book><bookinfo><abstract><para>
6513 "This document provides an overview of how to use the the APT package "
6517 #. type: Content of: <book><bookinfo>
6519 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6522 #. type: Content of: <book><bookinfo><legalnotice><title>
6523 #: guide.dbk:32 offline.dbk:33
6524 msgid "License Notice"
6527 #. type: Content of: <book><bookinfo><legalnotice><para>
6528 #: guide.dbk:34 offline.dbk:35
6530 "\"APT\" and this document are free software; you can redistribute them "
6531 "and/or modify them under the terms of the GNU General Public License as "
6532 "published by the Free Software Foundation; either version 2 of the License, "
6533 "or (at your option) any later version."
6536 #. type: Content of: <book><bookinfo><legalnotice><para>
6537 #: guide.dbk:43 offline.dbk:41
6539 "For more details, on Debian systems, see the file "
6540 "/usr/share/common-licenses/GPL for the full license."
6543 #. type: Content of: <book><chapter><title>
6548 #. type: Content of: <book><chapter><para>
6551 "The APT package currently contains two sections, the APT "
6552 "<command>dselect</command> method and the <command>apt-get</command> command "
6553 "line user interface. Both provide a way to install and remove packages as "
6554 "well as download new packages from the Internet."
6557 #. type: Content of: <book><chapter><section><title>
6559 msgid "Anatomy of the Package System"
6562 #. type: Content of: <book><chapter><section><para>
6565 "The Debian packaging system has a large amount of information associated "
6566 "with each package to help assure that it integrates cleanly and easily into "
6567 "the system. The most prominent of its features is the dependency system."
6570 #. type: Content of: <book><chapter><section><para>
6573 "The dependency system allows individual programs to make use of shared "
6574 "elements in the system such as libraries. It simplifies placing infrequently "
6575 "used portions of a program in separate packages to reduce the number of "
6576 "things the average user is required to install. Also, it allows for choices "
6577 "in mail transport agents, X servers and so on."
6580 #. type: Content of: <book><chapter><section><para>
6583 "The first step to understanding the dependency system is to grasp the "
6584 "concept of a simple dependency. The meaning of a simple dependency is that a "
6585 "package requires another package to be installed at the same time to work "
6589 #. type: Content of: <book><chapter><section><para>
6592 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6593 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6594 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6595 "simple dependency on emacs, without emacs it is completely useless."
6598 #. type: Content of: <book><chapter><section><para>
6601 "The other important dependency to understand is a conflicting dependency. It "
6602 "means that a package, when installed with another package, will not work and "
6603 "may possibly be extremely harmful to the system. As an example consider a "
6604 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6605 "have two mail transport agents installed because both need to listen to the "
6606 "network to receive mail. Attempting to install two will seriously damage the "
6607 "system so all mail transport agents have a conflicting dependency with all "
6608 "other mail transport agents."
6611 #. type: Content of: <book><chapter><section><para>
6614 "As an added complication there is the possibility for a package to pretend "
6615 "to be another package. Consider that exim and sendmail for many intents are "
6616 "identical, they both deliver mail and understand a common interface. Hence, "
6617 "the package system has a way for them to declare that they are both "
6618 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6619 "a mail-transport-agent and other packages that need a mail transport agent "
6620 "depend on mail-transport-agent. This can add a great deal of confusion when "
6621 "trying to manually fix packages."
6624 #. type: Content of: <book><chapter><section><para>
6627 "At any given time a single dependency may be met by packages that are "
6628 "already installed or it may not be. APT attempts to help resolve dependency "
6629 "issues by providing a number of automatic algorithms that help in selecting "
6630 "packages for installation."
6633 #. type: Content of: <book><chapter><title>
6638 #. type: Content of: <book><chapter><para>
6641 "<command>apt-get</command> provides a simple way to install packages from "
6642 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6643 "does not understand .deb files, it works with the package's proper name and "
6644 "can only install .deb archives from a <emphasis>Source</emphasis>."
6647 #. type: Content of: <book><chapter><para><footnote><para>
6650 "If you are using an http proxy server you must set the http_proxy "
6651 "environment variable first, see sources.list(5)"
6654 #. type: Content of: <book><chapter><para>
6657 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6658 "done before using <command>apt-get</command> is to fetch the package lists "
6659 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6660 "available. This is done with <literal>apt-get update</literal>. For "
6664 #. type: Content of: <book><chapter><screen>
6668 "# apt-get update\n"
6669 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6670 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6671 "Reading Package Lists... Done\n"
6672 "Building Dependency Tree... Done\n"
6675 #. type: Content of: <book><chapter><para>
6677 msgid "Once updated there are several commands that can be used:"
6680 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6685 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6688 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6689 "install a new package or remove an existing package, nor will it ever "
6690 "upgrade a package that might cause some other package to break. This can be "
6691 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6692 "the packages that it could not upgrade, this usually means that they depend "
6693 "on new packages or conflict with some other "
6694 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6695 "can be used to force these packages to install."
6698 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6703 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6706 "Install is used to install packages by name. The package is automatically "
6707 "fetched and installed. This can be useful if you already know the name of "
6708 "the package to install and do not want to go into a GUI to select it. Any "
6709 "number of packages may be passed to install, they will all be "
6710 "fetched. Install automatically attempts to resolve dependency problems with "
6711 "the listed packages and will print a summary and ask for confirmation if "
6712 "anything other than its arguments are changed."
6715 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6717 msgid "dist-upgrade"
6720 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6723 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6724 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6725 "set of packages to install, upgrade and remove to get as much of the system "
6726 "to the newest release. In some situations it may be desired to use "
6727 "dist-upgrade rather than spend the time manually resolving dependencies in "
6728 "<command>dselect</command>. Once dist-upgrade has completed then "
6729 "<command>dselect</command> can be used to install any packages that may have "
6733 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6736 "It is important to closely look at what dist-upgrade is going to do, its "
6737 "decisions may sometimes be quite surprising."
6740 #. type: Content of: <book><chapter><para>
6743 "<command>apt-get</command> has several command line options that are "
6744 "detailed in its man page, "
6745 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
6746 "The most useful option is <literal>-d</literal> which does not install the "
6747 "fetched files. If the system has to download a large number of package it "
6748 "would be undesired to start installing them in case something goes "
6749 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
6750 "installed by simply running the command that caused them to be downloaded "
6751 "again without <literal>-d</literal>."
6754 #. type: Content of: <book><chapter><title>
6759 #. type: Content of: <book><chapter><para>
6762 "The APT <command>dselect</command> method provides the complete APT system "
6763 "with the <command>dselect</command> package selection "
6764 "GUI. <command>dselect</command> is used to select the packages to be "
6765 "installed or removed and APT actually installs them."
6768 #. type: Content of: <book><chapter><para>
6771 "To enable the APT method you need to select [A]ccess in "
6772 "<command>dselect</command> and then choose the APT method. You will be "
6773 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
6774 "archives from. These can be remote Internet sites, local Debian mirrors or "
6775 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
6776 "will automatically combine them to form a complete set of packages. If you "
6777 "have a CD-ROM then it is a good idea to specify it first and then specify a "
6778 "mirror so that you have access to the latest bug fixes. APT will "
6779 "automatically use packages on your CD-ROM before downloading from the "
6783 #. type: Content of: <book><chapter><screen>
6787 " Set up a list of distribution source locations\n"
6789 " Please give the base URL of the debian distribution.\n"
6790 " The access schemes I know about are: http file\n"
6793 " file:/mnt/debian,\n"
6794 " ftp://ftp.debian.org/debian,\n"
6795 " http://ftp.de.debian.org/debian,\n"
6798 " URL [http://llug.sep.bnl.gov/debian]:\n"
6801 #. type: Content of: <book><chapter><para>
6804 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
6805 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
6806 "distribution to get."
6809 #. type: Content of: <book><chapter><screen>
6813 " Please give the distribution tag to get or a path to the\n"
6814 " package file ending in a /. The distribution\n"
6815 " tags are typically something like: stable unstable testing non-US\n"
6817 " Distribution [stable]:\n"
6820 #. type: Content of: <book><chapter><para>
6823 "The distribution refers to the Debian version in the archive, "
6824 "<emphasis>stable</emphasis> refers to the latest released version and "
6825 "<emphasis>unstable</emphasis> refers to the developmental "
6826 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
6827 "refers to packages that contain encryption technology or other things that "
6828 "cannot be exported from the United States. Importing these packages into the "
6829 "US is legal however."
6832 #. type: Content of: <book><chapter><screen>
6836 " Please give the components to get\n"
6837 " The components are typically something like: main contrib non-free\n"
6839 " Components [main contrib non-free]:\n"
6842 #. type: Content of: <book><chapter><para>
6845 "The components list refers to the list of sub distributions to fetch. The "
6846 "distribution is split up based on software licenses, main being DFSG free "
6847 "packages while contrib and non-free contain things that have various "
6848 "restrictions placed on their use and distribution."
6851 #. type: Content of: <book><chapter><para>
6854 "Any number of sources can be added, the setup script will continue to prompt "
6855 "until you have specified all that you want."
6858 #. type: Content of: <book><chapter><para>
6861 "Before starting to use <command>dselect</command> it is necessary to update "
6862 "the available list by selecting [U]pdate from the menu. This is a superset "
6863 "of <literal>apt-get update</literal> that makes the fetched information "
6864 "available to <command>dselect</command>. [U]pdate must be performed even if "
6865 "<literal>apt-get update</literal> has been run before."
6868 #. type: Content of: <book><chapter><para>
6871 "You can then go on and make your selections using [S]elect and then perform "
6872 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6873 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6877 #. type: Content of: <book><chapter><para>
6880 "By default APT will automatically remove the package (.deb) files once they "
6881 "have been successfully installed. To change this behavior place "
6882 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
6885 #. type: Content of: <book><chapter><title>
6887 msgid "The Interface"
6890 #. type: Content of: <book><chapter><para><footnote><para>
6893 "The <command>dselect</command> method actually is a set of wrapper scripts "
6894 "to <command>apt-get</command>. The method actually provides more "
6895 "functionality than is present in <command>apt-get</command> alone."
6898 #. type: Content of: <book><chapter><para>
6901 "Both that APT <command>dselect</command> method and "
6902 "<command>apt-get</command> share the same interface. It is a simple system "
6903 "that generally tells you what it will do and then goes and does "
6904 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
6905 "of what will happen APT then will print out some informative status messages "
6906 "so that you can estimate how far along it is and how much is left to do."
6909 #. type: Content of: <book><chapter><section><title>
6914 #. type: Content of: <book><chapter><section><para>
6917 "Before all operations except update, APT performs a number of actions to "
6918 "prepare its internal state. It also does some checks of the system's "
6919 "state. At any time these operations can be performed by running "
6920 "<literal>apt-get check</literal>."
6923 #. type: Content of: <book><chapter><section><screen>
6928 "Reading Package Lists... Done\n"
6929 "Building Dependency Tree... Done\n"
6932 #. type: Content of: <book><chapter><section><para>
6935 "The first thing it does is read all the package files into memory. APT uses "
6936 "a caching scheme so this operation will be faster the second time it is "
6937 "run. If some of the package files are not found then they will be ignored "
6938 "and a warning will be printed when apt-get exits."
6941 #. type: Content of: <book><chapter><section><para>
6944 "The final operation performs a detailed analysis of the system's "
6945 "dependencies. It checks every dependency of every installed or unpacked "
6946 "package and considers if it is OK. Should this find a problem then a report "
6947 "will be printed out and <command>apt-get</command> will refuse to run."
6950 #. type: Content of: <book><chapter><section><screen>
6955 "Reading Package Lists... Done\n"
6956 "Building Dependency Tree... Done\n"
6957 "You might want to run apt-get -f install' to correct these.\n"
6958 "Sorry, but the following packages have unmet dependencies:\n"
6959 " 9fonts: Depends: xlib6g but it is not installed\n"
6960 " uucp: Depends: mailx but it is not installed\n"
6961 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6962 " adduser: Depends: perl-base but it is not installed\n"
6963 " aumix: Depends: libgpmg1 but it is not installed\n"
6964 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6965 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6966 " cthugha: Depends: svgalibg1 but it is not installed\n"
6967 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6968 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
6971 #. type: Content of: <book><chapter><section><para>
6974 "In this example the system has many problems, including a serious problem "
6975 "with libreadlineg2. For each package that has unmet dependencies a line is "
6976 "printed out indicating the package with the problem and the dependencies "
6977 "that are unmet. A short explanation of why the package has a dependency "
6978 "problem is also included."
6981 #. type: Content of: <book><chapter><section><para><footnote><para>
6984 "APT however considers all known dependencies and attempts to prevent broken "
6988 #. type: Content of: <book><chapter><section><para>
6991 "There are two ways a system can get into a broken state like this. The first "
6992 "is caused by <command>dpkg</command> missing some subtle relationships "
6993 "between packages when performing upgrades. <placeholder type=\"footnote\" "
6994 "id=\"0\"/>. The second is if a package installation fails during an "
6995 "operation. In this situation a package may have been unpacked without its "
6996 "dependents being installed."
6999 #. type: Content of: <book><chapter><section><para>
7002 "The second situation is much less serious than the first because APT places "
7003 "certain constraints on the order that packages are installed. In both cases "
7004 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
7005 "will cause APT to deduce a possible solution to the problem and then "
7006 "continue on. The APT <command>dselect</command> method always supplies the "
7007 "<literal>-f</literal> option to allow for easy continuation of failed "
7008 "maintainer scripts."
7011 #. type: Content of: <book><chapter><section><para>
7014 "However, if the <literal>-f</literal> option is used to correct a seriously "
7015 "broken system caused by the first case then it is possible that it will "
7016 "either fail immediately or the installation sequence will fail. In either "
7017 "case it is necessary to manually use dpkg (possibly with forcing options) to "
7018 "correct the situation enough to allow APT to proceed."
7021 #. type: Content of: <book><chapter><section><title>
7023 msgid "The Status Report"
7026 #. type: Content of: <book><chapter><section><para>
7029 "Before proceeding <command>apt-get</command> will present a report on what "
7030 "will happen. Generally the report reflects the type of operation being "
7031 "performed but there are several common elements. In all cases the lists "
7032 "reflect the final state of things, taking into account the "
7033 "<literal>-f</literal> option and any other relevant activities to the "
7034 "command being executed."
7037 #. type: Content of: <book><chapter><section><section><title>
7039 msgid "The Extra Package list"
7042 #. type: Content of: <book><chapter><section><section><screen>
7046 "The following extra packages will be installed:\n"
7047 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7048 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7049 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7050 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7054 #. type: Content of: <book><chapter><section><section><para>
7057 "The Extra Package list shows all of the packages that will be installed or "
7058 "upgraded in excess of the ones mentioned on the command line. It is only "
7059 "generated for an <literal>install</literal> command. The listed packages are "
7060 "often the result of an Auto Install."
7063 #. type: Content of: <book><chapter><section><section><title>
7065 msgid "The Packages to Remove"
7068 #. type: Content of: <book><chapter><section><section><screen>
7072 "The following packages will be REMOVED:\n"
7073 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7074 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7075 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7076 " nas xpilot xfig\n"
7079 #. type: Content of: <book><chapter><section><section><para>
7082 "The Packages to Remove list shows all of the packages that will be removed "
7083 "from the system. It can be shown for any of the operations and should be "
7084 "given a careful inspection to ensure nothing important is to be taken "
7085 "off. The <literal>-f</literal> option is especially good at generating "
7086 "packages to remove so extreme care should be used in that case. The list may "
7087 "contain packages that are going to be removed because they are only "
7088 "partially installed, possibly due to an aborted installation."
7091 #. type: Content of: <book><chapter><section><section><title>
7093 msgid "The New Packages list"
7096 #. type: Content of: <book><chapter><section><section><screen>
7100 "The following NEW packages will installed:\n"
7101 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
7104 #. type: Content of: <book><chapter><section><section><para>
7107 "The New Packages list is simply a reminder of what will happen. The packages "
7108 "listed are not presently installed in the system but will be when APT is "
7112 #. type: Content of: <book><chapter><section><section><title>
7114 msgid "The Kept Back list"
7117 #. type: Content of: <book><chapter><section><section><screen>
7121 "The following packages have been kept back\n"
7122 " compface man-db tetex-base msql libpaper svgalib1\n"
7123 " gs snmp arena lynx xpat2 groff xscreensaver\n"
7126 #. type: Content of: <book><chapter><section><section><para>
7129 "Whenever the whole system is being upgraded there is the possibility that "
7130 "new versions of packages cannot be installed because they require new things "
7131 "or conflict with already installed things. In this case the package will "
7132 "appear in the Kept Back list. The best way to convince packages listed there "
7133 "to install is with <literal>apt-get install</literal> or by using "
7134 "<command>dselect</command> to resolve their problems."
7137 #. type: Content of: <book><chapter><section><section><title>
7139 msgid "Held Packages warning"
7142 #. type: Content of: <book><chapter><section><section><screen>
7146 "The following held packages will be changed:\n"
7150 #. type: Content of: <book><chapter><section><section><para>
7153 "Sometimes you can ask APT to install a package that is on hold, in such a "
7154 "case it prints out a warning that the held package is going to be "
7155 "changed. This should only happen during dist-upgrade or install."
7158 #. type: Content of: <book><chapter><section><section><title>
7160 msgid "Final summary"
7163 #. type: Content of: <book><chapter><section><section><para>
7165 msgid "Finally, APT will print out a summary of all the changes that will occur."
7168 #. type: Content of: <book><chapter><section><section><screen>
7172 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7174 "12 packages not fully installed or removed.\n"
7175 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
7178 #. type: Content of: <book><chapter><section><section><para>
7181 "The first line of the summary simply is a reduced version of all of the "
7182 "lists and includes the number of upgrades - that is packages already "
7183 "installed that have new versions available. The second line indicates the "
7184 "number of poorly configured packages, possibly the result of an aborted "
7185 "installation. The final line shows the space requirements that the "
7186 "installation needs. The first pair of numbers refer to the size of the "
7187 "archive files. The first number indicates the number of bytes that must be "
7188 "fetched from remote locations and the second indicates the total size of all "
7189 "the archives required. The next number indicates the size difference between "
7190 "the presently installed packages and the newly installed packages. It is "
7191 "roughly equivalent to the space required in /usr after everything is "
7192 "done. If a large number of packages are being removed then the value may "
7193 "indicate the amount of space that will be freed."
7196 #. type: Content of: <book><chapter><section><section><para>
7199 "Some other reports can be generated by using the -u option to show packages "
7200 "to upgrade, they are similar to the previous examples."
7203 #. type: Content of: <book><chapter><section><title>
7205 msgid "The Status Display"
7208 #. type: Content of: <book><chapter><section><para>
7211 "During the download of archives and package files APT prints out a series of "
7215 #. type: Content of: <book><chapter><section><screen>
7219 "# apt-get update\n"
7220 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7221 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7222 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7223 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7225 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7226 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
7229 #. type: Content of: <book><chapter><section><para>
7232 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
7233 "begins to fetch a file while the last line indicates the progress of the "
7234 "download. The first percent value on the progress line indicates the total "
7235 "percent done of all files. Unfortunately since the size of the Package files "
7236 "is unknown <literal>apt-get update</literal> estimates the percent done "
7237 "which causes some inaccuracies."
7240 #. type: Content of: <book><chapter><section><para>
7243 "The next section of the status line is repeated once for each download "
7244 "thread and indicates the operation being performed and some useful "
7245 "information about what is happening. Sometimes this section will simply read "
7246 "<emphasis>Forking</emphasis> which means the OS is loading the download "
7247 "module. The first word after the [ is the fetch number as shown on the "
7248 "history lines. The next word is the short form name of the object being "
7249 "downloaded. For archives it will contain the name of the package that is "
7253 #. type: Content of: <book><chapter><section><para>
7256 "Inside of the single quote is an informative string indicating the progress "
7257 "of the negotiation phase of the download. Typically it progresses from "
7258 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
7259 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
7260 "value is the number of bytes downloaded from the remote site. Once the "
7261 "download begins this is represented as <literal>102/10.2k</literal> "
7262 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
7263 "expected. The total size is always shown in 4 figure notation to preserve "
7264 "space. After the size display is a percent meter for the file itself. The "
7265 "second last element is the instantaneous average speed. This values is "
7266 "updated every 5 seconds and reflects the rate of data transfer for that "
7267 "period. Finally is shown the estimated transfer time. This is updated "
7268 "regularly and reflects the time to complete everything at the shown transfer "
7272 #. type: Content of: <book><chapter><section><para>
7275 "The status display updates every half second to provide a constant feedback "
7276 "on the download progress while the Get lines scroll back whenever a new file "
7277 "is started. Since the status display is constantly updated it is unsuitable "
7278 "for logging to a file, use the <literal>-q</literal> option to remove the "
7282 #. type: Content of: <book><chapter><section><title>
7287 #. type: Content of: <book><chapter><section><para>
7290 "APT uses <command>dpkg</command> for installing the archives and will switch "
7291 "over to the <command>dpkg</command> interface once downloading is "
7292 "completed. <command>dpkg</command> will also ask a number of questions as it "
7293 "processes the packages and the packages themselves may also ask several "
7294 "questions. Before each question there is usually a description of what it is "
7295 "asking and the questions are too varied to discuss completely here."
7298 #. type: Content of: <book><title>
7300 msgid "Using APT Offline"
7303 #. type: Content of: <book><bookinfo><abstract><para>
7306 "This document describes how to use APT in a non-networked environment, "
7307 "specifically a 'sneaker-net' approach for performing upgrades."
7310 #. type: Content of: <book><bookinfo>
7312 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
7315 #. type: Content of: <book><chapter><title>
7317 msgid "Introduction"
7320 #. type: Content of: <book><chapter><section><title>
7321 #: offline.dbk:50 offline.dbk:80 offline.dbk:192
7325 #. type: Content of: <book><chapter><section><para>
7328 "Normally APT requires direct access to a Debian archive, either from a local "
7329 "media or through a network. Another common complaint is that a Debian "
7330 "machine is on a slow link, such as a modem and another machine has a very "
7331 "fast connection but they are physically distant."
7334 #. type: Content of: <book><chapter><section><para>
7337 "The solution to this is to use large removable media such as a Zip disc or a "
7338 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7339 "archive but can easily fit a subset large enough for most users. The idea is "
7340 "to use APT to generate a list of packages that are required and then fetch "
7341 "them onto the disc using another machine with good connectivity. It is even "
7342 "possible to use another Debian machine with APT or to use a completely "
7343 "different OS and a download tool like wget. Let <emphasis>remote "
7344 "host</emphasis> mean the machine downloading the packages, and "
7345 "<emphasis>target host</emphasis> the one with bad or no connection."
7348 #. type: Content of: <book><chapter><section><para>
7351 "This is achieved by creatively manipulating the APT configuration file. The "
7352 "essential premise to tell APT to look on a disc for it's archive files. Note "
7353 "that the disc should be formatted with a filesystem that can handle long "
7354 "file names such as ext2, fat32 or vfat."
7357 #. type: Content of: <book><chapter><title>
7359 msgid "Using APT on both machines"
7362 #. type: Content of: <book><chapter><section><para>
7365 "APT being available on both machines gives the simplest configuration. The "
7366 "basic idea is to place a copy of the status file on the disc and use the "
7367 "remote machine to fetch the latest package files and decide which packages "
7368 "to download. The disk directory structure should look like:"
7371 #. type: Content of: <book><chapter><section><screen>
7385 #. type: Content of: <book><chapter><section><title>
7387 msgid "The configuration file"
7390 #. type: Content of: <book><chapter><section><para>
7393 "The configuration file should tell APT to store its files on the disc and to "
7394 "use the configuration files on the disc as well. The sources.list should "
7395 "contain the proper sites that you wish to use from the remote machine, and "
7396 "the status file should be a copy of "
7397 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
7398 "host</emphasis>. Please note, if you are using a local archive you must use "
7399 "copy URIs, the syntax is identical to file URIs."
7402 #. type: Content of: <book><chapter><section><para>
7405 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
7409 #. type: Content of: <book><chapter><section><screen>
7415 " /* This is not necessary if the two machines are the same arch, it "
7417 " the remote APT what architecture the target machine is */\n"
7418 " Architecture \"i386\";\n"
7420 " Get::Download-Only \"true\";\n"
7425 " /* Use the disc for state information and redirect the status file from\n"
7426 " the /var/lib/dpkg default */\n"
7427 " State \"/disc/\";\n"
7428 " State::status \"status\";\n"
7430 " // Binary caches will be stored locally\n"
7431 " Cache::archives \"/disc/archives/\";\n"
7432 " Cache \"/tmp/\";\n"
7434 " // Location of the source list.\n"
7435 " Etc \"/disc/\";\n"
7439 #. type: Content of: <book><chapter><section><para>
7442 "More details can be seen by examining the apt.conf man page and the sample "
7443 "configuration file in "
7444 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
7447 #. type: Content of: <book><chapter><section><para>
7450 "On the target machine the first thing to do is mount the disc and copy "
7451 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
7452 "create the directories outlined in the Overview, "
7453 "<emphasis>archives/partial/</emphasis> and "
7454 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
7455 "machine and configure the sources.list. On the remote machine execute the "
7459 #. type: Content of: <book><chapter><section><screen>
7463 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7464 " # apt-get update\n"
7465 " [ APT fetches the package files ]\n"
7466 " # apt-get dist-upgrade\n"
7467 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
7470 #. type: Content of: <book><chapter><section><para>
7473 "The dist-upgrade command can be replaced with any other standard APT "
7474 "commands, particularly dselect-upgrade. You can even use an APT front end "
7475 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
7476 "communicating your selections back to the local computer."
7479 #. type: Content of: <book><chapter><section><para>
7482 "Now the disc contains all of the index files and archives needed to upgrade "
7483 "the target machine. Take the disc back and run:"
7486 #. type: Content of: <book><chapter><section><screen>
7490 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7491 " # apt-get check\n"
7492 " [ APT generates a local copy of the cache files ]\n"
7493 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7494 " [ Or any other APT command ]\n"
7497 #. type: Content of: <book><chapter><section><para>
7500 "It is necessary for proper function to re-specify the status file to be the "
7501 "local one. This is very important!"
7504 #. type: Content of: <book><chapter><section><para>
7507 "If you are using dselect you can do the very risky operation of copying "
7508 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7509 "remote machine are updated. I highly recommend that people only make "
7510 "selections on the local machine - but this may not always be possible. DO "
7511 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7514 #. type: Content of: <book><chapter><title>
7516 msgid "Using APT and wget"
7519 #. type: Content of: <book><chapter><section><para>
7522 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7523 "run on nearly any machine. Unlike the method above this requires that the "
7524 "Debian machine already has a list of available packages."
7527 #. type: Content of: <book><chapter><section><para>
7530 "The basic idea is to create a disc that has only the archive files "
7531 "downloaded from the remote site. This is done by using the --print-uris "
7532 "option to apt-get and then preparing a wget script to actually fetch the "
7536 #. type: Content of: <book><chapter><section><title>
7541 #. type: Content of: <book><chapter><section><para>
7544 "Unlike the previous technique no special configuration files are "
7545 "required. We merely use the standard APT commands to generate the file list."
7548 #. type: Content of: <book><chapter><section><screen>
7552 " # apt-get dist-upgrade\n"
7553 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7554 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7555 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7558 #. type: Content of: <book><chapter><section><para>
7561 "Any command other than dist-upgrade could be used here, including "
7565 #. type: Content of: <book><chapter><section><para>
7568 "The /disc/wget-script file will now contain a list of wget commands to "
7569 "execute in order to fetch the necessary archives. This script should be run "
7570 "with the current directory as the disc's mount point so as to save the "
7571 "output on the disc."
7574 #. type: Content of: <book><chapter><section><para>
7576 msgid "The remote machine would do something like"
7579 #. type: Content of: <book><chapter><section><screen>
7584 " # sh -x ./wget-script\n"
7588 #. type: Content of: <book><chapter><section><para>
7591 "Once the archives are downloaded and the disc returned to the Debian machine "
7592 "installation can proceed using,"
7595 #. type: Content of: <book><chapter><section><screen>
7598 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7601 #. type: Content of: <book><chapter><section><para>
7603 msgid "Which will use the already fetched archives on the disc."