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~exp12ubuntu1~20151005\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2015-10-05 18:29+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:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
501 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
505 #. type: Content of: <refentry><refmeta><refmiscinfo>
506 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
507 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
508 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
509 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
513 #. type: Content of: <refentry><refnamediv><refpurpose>
515 msgid "command-line interface"
518 #. type: Content of: <refentry><refsect1><title>
519 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
520 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
521 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
522 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
526 #. type: Content of: <refentry><refsect1><para>
529 "<command>apt</command> (Advanced Package Tool) is the command-line tool for "
530 "handling packages. It provides a commandline interface for the package "
531 "management of the system. See also &apt-get; and &apt-cache; for more "
532 "low-level command options."
535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
538 "<literal>list</literal> is used to display a list of packages. It supports "
539 "shell pattern for matching package names and the following options: "
540 "<option>--installed</option>, <option>--upgradable</option>, "
541 "<option>--upgradeable</option>, <option>--all-versions</option> are "
545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
548 "<literal>search</literal> searches for the given term(s) and display "
552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
555 "<literal>show</literal> shows the package information for the given "
559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
562 "<literal>install</literal> is followed by one or more package names desired "
563 "for installation or upgrading."
566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
567 #: apt.8.xml:1 apt-get.8.xml:1
569 "A specific version of a package can be selected for installation by "
570 "following the package name with an equals and the version of the package to "
571 "select. This will cause that version to be located and selected for "
572 "install. Alternatively a specific distribution can be selected by following "
573 "the package name with a slash and the version of the distribution or the "
574 "Archive name (stable, testing, unstable)."
577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
578 #: apt.8.xml:1 apt-get.8.xml:1
580 "<literal>remove</literal> is identical to <literal>install</literal> except "
581 "that packages are removed instead of installed. Note that removing a package "
582 "leaves its configuration files on the system. If a plus sign is appended to "
583 "the package name (with no intervening space), the identified package will be "
584 "installed instead of removed."
587 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
588 #: apt.8.xml:1 apt-get.8.xml:1 apt-get.8.xml:1
592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
593 #: apt.8.xml:1 apt-get.8.xml:1 apt-get.8.xml:1
594 msgid "alias since 1.1)"
597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
598 #: apt.8.xml:1 apt-get.8.xml:1
600 "<literal>autoremove</literal> is used to remove packages that were "
601 "automatically installed to satisfy dependencies for other packages and are "
602 "now no longer needed."
605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
608 "<literal>edit-sources</literal> lets you edit your sources.list file and "
609 "provides basic sanity checks."
612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
615 "<literal>update</literal> is used to resynchronize the package index files "
616 "from their sources."
619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
622 "<literal>upgrade</literal> is used to install the newest versions of all "
623 "packages currently installed on the system from the sources enumerated in "
624 "<filename>/etc/apt/sources.list</filename>. New packages will be installed, "
625 "but existing packages will never be removed."
628 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
631 "<literal>full-upgrade</literal> performs the function of upgrade but may "
632 "also remove installed packages if that is required in order to resolve a "
636 #. type: Content of: <refentry><refsect1><title>
637 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-mark.8.xml:1
638 #: apt-config.8.xml:1 apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1
639 #: apt-ftparchive.1.xml:1
643 #. type: Content of: <refentry><refsect1><title>
648 #. type: Content of: <refentry><refsect1><para>
651 "The &apt; commandline is designed as a end-user tool and it may change the "
652 "output between versions. While it tries to not break backward compatibility "
653 "there is no guarantee for it either. All features of &apt; are available in "
654 "&apt-cache; and &apt-get; via APT options. Please prefer using these "
655 "commands in your scripts."
658 #. type: Content of: <refentry><refsect1><title>
660 msgid "Differences to &apt-get;"
663 #. type: Content of: <refentry><refsect1><para>
666 "The <command>apt</command> command is meant to be pleasant for end users and "
667 "does not need to be backward compatible like &apt-get;. Therefore some "
668 "options are different:"
671 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
673 msgid "The option <literal>DPkg::Progress-Fancy</literal> is enabled."
676 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
678 msgid "The option <literal>APT::Color</literal> is enabled."
681 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
684 "A new <literal>list</literal> command is available similar to <literal>dpkg "
688 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
691 "The option <literal>upgrade</literal> has <literal>--with-new-pkgs</literal> "
692 "enabled by default."
695 #. type: Content of: <refentry><refsect1><title>
696 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
697 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
698 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
699 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
703 #. type: Content of: <refentry><refsect1><para>
706 "&apt-get;, &apt-cache;, &sources-list;, &apt-conf;, &apt-config;, The APT "
707 "User's guide in &guidesdir;, &apt-preferences;, the APT Howto."
710 #. type: Content of: <refentry><refsect1><title>
711 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-mark.8.xml:1
712 #: apt-cdrom.8.xml:1 apt-config.8.xml:1 apt-extracttemplates.1.xml:1
713 #: apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
717 #. type: Content of: <refentry><refsect1><para>
720 "<command>apt</command> returns zero on normal operation, decimal 100 on "
724 #. type: Content of: <refentry><refnamediv><refpurpose>
726 msgid "APT package handling utility -- command-line interface"
729 #. type: Content of: <refentry><refsect1><para>
732 "<command>apt-get</command> is the command-line tool for handling packages, "
733 "and may be considered the user's \"back-end\" to other tools using the APT "
734 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
735 "&synaptic; and &wajig;."
738 #. type: Content of: <refentry><refsect1><para>
739 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
740 #: apt-ftparchive.1.xml:1
742 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
743 "one of the commands below must be present."
746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
749 "<literal>update</literal> is used to resynchronize the package index files "
750 "from their sources. The indexes of available packages are fetched from the "
751 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
752 "example, when using a Debian archive, this command retrieves and scans the "
753 "<filename>Packages.gz</filename> files, so that information about new and "
754 "updated packages is available. An <literal>update</literal> should always be "
755 "performed before an <literal>upgrade</literal> or "
756 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
757 "meter will be incorrect as the size of the package files cannot be known in "
761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
764 "<literal>upgrade</literal> is used to install the newest versions of all "
765 "packages currently installed on the system from the sources enumerated in "
766 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
767 "with new versions available are retrieved and upgraded; under no "
768 "circumstances are currently installed packages removed, or packages not "
769 "already installed retrieved and installed. New versions of currently "
770 "installed packages that cannot be upgraded without changing the install "
771 "status of another package will be left at their current version. An "
772 "<literal>update</literal> must be performed first so that "
773 "<command>apt-get</command> knows that new versions of packages are "
777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
780 "<literal>dist-upgrade</literal> in addition to performing the function of "
781 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
782 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
783 "conflict resolution system, and it will attempt to upgrade the most "
784 "important packages at the expense of less important ones if necessary. The "
785 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
786 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
787 "locations from which to retrieve desired package files. See also "
788 "&apt-preferences; for a mechanism for overriding the general settings for "
789 "individual packages."
792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
795 "<literal>dselect-upgrade</literal> is used in conjunction with the "
796 "traditional Debian packaging front-end, "
797 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
798 "&dselect; to the <literal>Status</literal> field of available packages, and "
799 "performs the actions necessary to realize that state (for instance, the "
800 "removal of old and the installation of new packages)."
803 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
806 "<literal>install</literal> is followed by one or more packages desired for "
807 "installation or upgrading. Each package is a package name, not a fully "
808 "qualified filename (for instance, in a Debian system, "
809 "<package>apt-utils</package> would be the argument provided, not "
810 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
811 "packages required by the package(s) specified for installation will also be "
812 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
813 "file is used to locate the desired packages. If a hyphen is appended to the "
814 "package name (with no intervening space), the identified package will be "
815 "removed if it is installed. Similarly a plus sign can be used to designate "
816 "a package to install. These latter features may be used to override "
817 "decisions made by apt-get's conflict resolution system."
820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
823 "Both of the version selection mechanisms can downgrade packages and must be "
827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
830 "This is also the target to use if you want to upgrade one or more "
831 "already-installed packages without upgrading every package you have on your "
832 "system. Unlike the \"upgrade\" target, which installs the newest version of "
833 "all currently installed packages, \"install\" will install the newest "
834 "version of only the package(s) specified. Simply provide the name of the "
835 "package(s) you wish to upgrade, and if a newer version is available, it (and "
836 "its dependencies, as described above) will be downloaded and installed."
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
842 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
843 "installation policy for individual packages."
846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
849 "If no package matches the given expression and the expression contains one "
850 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
851 "it is applied to all package names in the database. Any matches are then "
852 "installed (or removed). Note that matching is done by substring so 'lo.*' "
853 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
854 "expression with a '^' or '$' character, or create a more specific regular "
858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
861 "<literal>purge</literal> is identical to <literal>remove</literal> except "
862 "that packages are removed and purged (any configuration files are deleted "
866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
869 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
870 "packages. APT will examine the available packages to decide which source "
871 "package to fetch. It will then find and download into the current directory "
872 "the newest available version of that source package while respecting the "
873 "default release, set with the option "
874 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
875 "per package with the <literal>pkg/release</literal> syntax, if possible."
878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
881 "Source packages are tracked separately from binary packages via "
882 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
883 "you will need to add such a line for each repository you want to get sources "
884 "from; otherwise you will probably get either the wrong (too old/too new) "
885 "source versions or none at all."
888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
891 "If the <option>--compile</option> option is specified then the package will "
892 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
893 "the architecture as defined by the <command>--host-architecture</command> "
894 "option. If <option>--download-only</option> is specified then the source "
895 "package will not be unpacked."
898 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
901 "A specific source version can be retrieved by postfixing the source name "
902 "with an equals and then the version to fetch, similar to the mechanism used "
903 "for the package files. This enables exact matching of the source package "
904 "name and version, implicitly enabling the "
905 "<literal>APT::Get::Only-Source</literal> option."
908 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
911 "Note that source packages are not installed and tracked in the "
912 "<command>dpkg</command> database like binary packages; they are simply "
913 "downloaded to the current directory, like source tarballs."
916 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
919 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
920 "attempt to satisfy the build dependencies for a source package. By default "
921 "the dependencies are satisfied to build the package natively. If desired a "
922 "host-architecture can be specified with the "
923 "<option>--host-architecture</option> option instead."
926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
929 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
930 "and checks for broken dependencies."
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
936 "<literal>download</literal> will download the given binary package into the "
940 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
943 "<literal>clean</literal> clears out the local repository of retrieved "
944 "package files. It removes everything but the lock file from "
945 "<filename>&cachedir;/archives/</filename> and "
946 "<filename>&cachedir;/archives/partial/</filename>."
949 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
952 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
953 "local repository of retrieved package files. The difference is that it only "
954 "removes package files that can no longer be downloaded, and are largely "
955 "useless. This allows a cache to be maintained over a long period without it "
956 "growing out of control. The configuration option "
957 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
958 "being erased if it is set to off."
961 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
964 "<literal>changelog</literal> tries to download the changelog of a package "
965 "and displays it through <command>sensible-pager</command>. By default it "
966 "displays the changelog for the version that is installed. However, you can "
967 "specify the same options as for the <option>install</option> command."
970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
973 "Displays by default a deb822 formatted listing of information about all data "
974 "files (aka index targets) <command>apt-get update</command> would "
975 "download. Supports a <option>--format</option> option to modify the output "
976 "format as well as accepts lines of the default output to filter the records "
977 "by. The command is mainly used as an interface for external tools working "
978 "with APT to get information as well as filenames for downloaded files so "
979 "they can use them as well instead of downloading them again on their "
980 "own. Detailed documentation is omitted here and can instead be found in the "
982 "<literal><filename>doc/acquire-additional-files.txt</filename></literal>."
985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
988 "Do not consider recommended packages as a dependency for installing. "
989 "Configuration Item: <literal>APT::Install-Recommends</literal>."
992 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
995 "Consider suggested packages as a dependency for installing. Configuration "
996 "Item: <literal>APT::Install-Suggests</literal>."
999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1002 "Download only; package files are only retrieved, not unpacked or installed. "
1003 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
1006 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1009 "Fix; attempt to correct a system with broken dependencies in place. This "
1010 "option, when used with install/remove, can omit any packages to permit APT "
1011 "to deduce a likely solution. If packages are specified, these have to "
1012 "completely correct the problem. The option is sometimes necessary when "
1013 "running APT for the first time; APT itself does not allow broken package "
1014 "dependencies to exist on a system. It is possible that a system's dependency "
1015 "structure can be so corrupt as to require manual intervention (which usually "
1016 "means using <command>dpkg --remove</command> to eliminate some of the "
1017 "offending packages). Use of this option together with <option>-m</option> "
1018 "may produce an error in some situations. Configuration Item: "
1019 "<literal>APT::Get::Fix-Broken</literal>."
1022 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1025 "Ignore missing packages; if packages cannot be retrieved or fail the "
1026 "integrity check after retrieval (corrupted package files), hold back those "
1027 "packages and handle the result. Use of this option together with "
1028 "<option>-f</option> may produce an error in some situations. If a package is "
1029 "selected for installation (particularly if it is mentioned on the command "
1030 "line) and it could not be downloaded then it will be silently held back. "
1031 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
1034 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1037 "Disables downloading of packages. This is best used with "
1038 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
1039 "already downloaded. Configuration Item: "
1040 "<literal>APT::Get::Download</literal>."
1043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1046 "Quiet; produces output suitable for logging, omitting progress indicators. "
1047 "More q's will produce more quiet up to a maximum of 2. You can also use "
1048 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1049 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
1050 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
1051 "may decide to do something you did not expect. Configuration Item: "
1052 "<literal>quiet</literal>."
1055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1058 "No action; perform a simulation of events that would occur based on the "
1059 "current system state but do not actually change the system. Locking will be "
1060 "disabled (<option>Debug::NoLocking</option>) so the system state could "
1061 "change while <command>apt-get</command> is running. Simulations can also be "
1062 "executed by non-root users which might not have read access to all apt "
1063 "configuration distorting the simulation. A notice expressing this warning "
1064 "is also shown by default for non-root users "
1065 "(<option>APT::Get::Show-User-Simulation-Note</option>). Configuration Item: "
1066 "<literal>APT::Get::Simulate</literal>."
1069 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1072 "Simulated runs print out a series of lines, each representing a "
1073 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
1074 "remove (<literal>Remv</literal>) or unpack "
1075 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
1076 "empty square brackets indicate breaks that are of no consequence (rare)."
1079 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1082 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
1083 "non-interactively. If an undesirable situation, such as changing a held "
1084 "package, trying to install a unauthenticated package or removing an "
1085 "essential package occurs then <literal>apt-get</literal> will abort. "
1086 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
1089 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1092 "Automatic \"no\" to all prompts. Configuration Item: "
1093 "<literal>APT::Get::Assume-No</literal>."
1096 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1099 "Show upgraded packages; print out a list of all packages that are to be "
1100 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
1103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1106 "Show full versions for upgraded and installed packages. Configuration Item: "
1107 "<literal>APT::Get::Show-Versions</literal>."
1110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1113 "This option controls the architecture packages are built for by "
1114 "<command>apt-get source --compile</command> and how cross-builddependencies "
1115 "are satisfied. By default is it not set which means that the host "
1116 "architecture is the same as the build architecture (which is defined by "
1117 "<literal>APT::Architecture</literal>). Configuration Item: "
1118 "<literal>APT::Get::Host-Architecture</literal>."
1121 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1124 "This option controls the activated build profiles for which a source package "
1125 "is built by <command>apt-get source --compile</command> and how build "
1126 "dependencies are satisfied. By default no build profile is active. More "
1127 "than one build profile can be activated at a time by concatenating them with "
1128 "a comma. Configuration Item: <literal>APT::Build-Profiles</literal>."
1131 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1134 "Compile source packages after downloading them. Configuration Item: "
1135 "<literal>APT::Get::Compile</literal>."
1138 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1141 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
1142 "hold placed on a package. This may be useful in conjunction with "
1143 "<literal>dist-upgrade</literal> to override a large number of undesired "
1144 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
1147 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1150 "Allow installing new packages when used in conjunction with "
1151 "<literal>upgrade</literal>. This is useful if the update of a installed "
1152 "package requires new dependencies to be installed. Instead of holding the "
1153 "package back <literal>upgrade</literal> will upgrade the package and install "
1154 "the new dependencies. Note that <literal>upgrade</literal> with this option "
1155 "will never remove packages, only allow adding new ones. Configuration Item: "
1156 "<literal>APT::Get::Upgrade-Allow-New</literal>."
1159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1162 "Do not upgrade packages; when used in conjunction with "
1163 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
1164 "packages on the command line from being upgraded if they are already "
1165 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
1168 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1171 "Do not install new packages; when used in conjunction with "
1172 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
1173 "upgrades for already installed packages only and ignore requests to install "
1174 "new packages. Configuration Item: "
1175 "<literal>APT::Get::Only-Upgrade</literal>."
1178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1181 "This is a dangerous option that will cause apt to continue without prompting "
1182 "if it is doing downgrades. It should not be used except in very special "
1183 "situations. Using it can potentially destroy your system! Configuration "
1184 "Item: <literal>APT::Get::allow-downgrades</literal>. Introduced in APT 1.1."
1187 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1190 "Force yes; this is a dangerous option that will cause apt to continue "
1191 "without prompting if it is removing essentials. It should not be used except "
1192 "in very special situations. Using it can potentially destroy your system! "
1193 "Configuration Item: "
1194 "<literal>APT::Get::allow-remove-essential</literal>. Introduced in APT 1.1."
1197 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1200 "Force yes; this is a dangerous option that will cause apt to continue "
1201 "without prompting if it is changing held packages. It should not be used "
1202 "except in very special situations. Using it can potentially destroy your "
1203 "system! Configuration Item: "
1204 "<literal>APT::Get::allow-change-held-packages</literal>. Introduced in APT "
1208 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1211 "Force yes; this is a dangerous option that will cause apt to continue "
1212 "without prompting if it is doing something potentially harmful. It should "
1213 "not be used except in very special situations. Using "
1214 "<literal>force-yes</literal> can potentially destroy your system! "
1215 "Configuration Item: <literal>APT::Get::force-yes</literal>. This is "
1216 "deprecated and replaced by <option>--allow-downgrades</option>, "
1217 "<option>--allow-remove-essential</option>, "
1218 "<option>--allow-change-held-packages</option> in 1.1."
1221 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1224 "Instead of fetching the files to install their URIs are printed. Each URI "
1225 "will have the path, the destination file name, the size and the expected MD5 "
1226 "hash. Note that the file name to write to will not always match the file "
1227 "name on the remote site! This also works with the <literal>source</literal> "
1228 "and <literal>update</literal> commands. When used with the "
1229 "<literal>update</literal> command the MD5 and size are not included, and it "
1230 "is up to the user to decompress any compressed files. Configuration Item: "
1231 "<literal>APT::Get::Print-URIs</literal>."
1234 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1237 "Use purge instead of remove for anything that would be removed. An asterisk "
1238 "(\"*\") will be displayed next to packages which are scheduled to be "
1239 "purged. <option>remove --purge</option> is equivalent to the "
1240 "<option>purge</option> command. Configuration Item: "
1241 "<literal>APT::Get::Purge</literal>."
1244 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1247 "Re-install packages that are already installed and at the newest version. "
1248 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1251 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1254 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1255 "turn it off. When it is on, <command>apt-get</command> will automatically "
1256 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1257 "obsolete files are erased. The only reason to turn it off is if you "
1258 "frequently change your sources list. Configuration Item: "
1259 "<literal>APT::Get::List-Cleanup</literal>."
1262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1265 "This option controls the default input to the policy engine; it creates a "
1266 "default pin at priority 990 using the specified release string. This "
1267 "overrides the general settings in "
1268 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1269 "not affected by the value of this option. In short, this option lets you "
1270 "have simple control over which distribution packages will be retrieved "
1271 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1272 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1273 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1277 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1280 "Only perform operations that are 'trivial'. Logically this can be considered "
1281 "related to <option>--assume-yes</option>; where "
1282 "<option>--assume-yes</option> will answer yes to any prompt, "
1283 "<option>--trivial-only</option> will answer no. Configuration Item: "
1284 "<literal>APT::Get::Trivial-Only</literal>."
1287 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1290 "If any packages are to be removed apt-get immediately aborts without "
1291 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1297 "If the command is either <literal>install</literal> or "
1298 "<literal>remove</literal>, then this option acts like running the "
1299 "<literal>autoremove</literal> command, removing unused dependency "
1300 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1303 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1306 "Only has meaning for the <literal>source</literal> and "
1307 "<literal>build-dep</literal> commands. Indicates that the given source "
1308 "names are not to be mapped through the binary table. This means that if "
1309 "this option is specified, these commands will only accept source package "
1310 "names as arguments, rather than accepting binary package names and looking "
1311 "up the corresponding source package. Configuration Item: "
1312 "<literal>APT::Get::Only-Source</literal>."
1315 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1318 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1319 "Item: <literal>APT::Get::Diff-Only</literal>, "
1320 "<literal>APT::Get::Dsc-Only</literal>, and "
1321 "<literal>APT::Get::Tar-Only</literal>."
1324 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1327 "Only process architecture-dependent build-dependencies. Configuration Item: "
1328 "<literal>APT::Get::Arch-Only</literal>."
1331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1334 "Ignore if packages can't be authenticated and don't prompt about it. This "
1335 "can be useful while working with local repositories, but is a huge security "
1336 "risk if data authenticity isn't ensured in another way by the user itself. "
1337 "The usage of the <option>Trusted</option> option for &sources-list; entries "
1338 "should usually be preferred over this global override. Configuration Item: "
1339 "<literal>APT::Get::AllowUnauthenticated</literal>."
1342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1345 "Forbid the update command to acquire unverifiable data from configured "
1346 "sources. Apt will fail at the update command for repositories without valid "
1347 "cryptographically signatures. Configuration Item: "
1348 "<literal>Acquire::AllowInsecureRepositories</literal>."
1351 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1354 "Show user friendly progress information in the terminal window when packages "
1355 "are installed, upgraded or removed. For a machine parsable version of this "
1356 "data see README.progress-reporting in the apt doc directory. Configuration "
1357 "Item: <literal>Dpkg::Progress</literal> and "
1358 "<literal>Dpkg::Progress-Fancy</literal>."
1361 #. type: Content of: <refentry><refsect1><title>
1362 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1 apt-mark.8.xml:1
1363 #: apt.conf.5.xml:1 apt_preferences.5.xml:1
1367 #. type: Content of: <refentry><refsect1><para>
1370 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1371 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1375 #. type: Content of: <refentry><refsect1><para>
1378 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1382 #. type: Content of: <refentry><refnamediv><refpurpose>
1383 #: apt-cache.8.xml:1
1384 msgid "query the APT cache"
1387 #. type: Content of: <refentry><refsect1><para>
1388 #: apt-cache.8.xml:1
1390 "<command>apt-cache</command> performs a variety of operations on APT's "
1391 "package cache. <command>apt-cache</command> does not manipulate the state of "
1392 "the system but does provide operations to search and generate interesting "
1393 "output from the package metadata."
1396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1397 #: apt-cache.8.xml:1
1399 "<literal>gencaches</literal> creates APT's package cache. This is done "
1400 "implicitly by all commands needing this cache if it is missing or outdated."
1403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1404 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1405 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1406 msgid "&synopsis-pkg;"
1409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1410 #: apt-cache.8.xml:1
1412 "<literal>showpkg</literal> displays information about the packages listed on "
1413 "the command line. Remaining arguments are package names. The available "
1414 "versions and reverse dependencies of each package listed are listed, as well "
1415 "as forward dependencies for each version. Forward (normal) dependencies are "
1416 "those packages upon which the package in question depends; reverse "
1417 "dependencies are those packages that depend upon the package in "
1418 "question. Thus, forward dependencies must be satisfied for a package, but "
1419 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1420 "libreadline2</command> would produce output similar to the following:"
1423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1424 #: apt-cache.8.xml:1
1427 "Package: libreadline2\n"
1428 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1429 "Reverse Depends: \n"
1430 " libreadlineg2,libreadline2\n"
1431 " libreadline2-altdev,libreadline2\n"
1433 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1436 "Reverse Provides: \n"
1439 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1440 #: apt-cache.8.xml:1
1442 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1443 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1444 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1445 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1446 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1447 "installed. For the specific meaning of the remainder of the output it is "
1448 "best to consult the apt source code."
1451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1452 #: apt-cache.8.xml:1
1454 "<literal>stats</literal> displays some statistics about the cache. No "
1455 "further arguments are expected. Statistics reported are:"
1458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1459 #: apt-cache.8.xml:1
1461 "<literal>Total package names</literal> is the number of package names found "
1465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1466 #: apt-cache.8.xml:1
1468 "<literal>Normal packages</literal> is the number of regular, ordinary "
1469 "package names; these are packages that bear a one-to-one correspondence "
1470 "between their names and the names used by other packages for them in "
1471 "dependencies. The majority of packages fall into this category."
1474 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1475 #: apt-cache.8.xml:1
1477 "<literal>Pure virtual packages</literal> is the number of packages that "
1478 "exist only as a virtual package name; that is, packages only \"provide\" the "
1479 "virtual package name, and no package actually uses the name. For instance, "
1480 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1481 "several packages provide \"mail-transport-agent\", but there is no package "
1482 "named \"mail-transport-agent\"."
1485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1486 #: apt-cache.8.xml:1
1488 "<literal>Single virtual packages</literal> is the number of packages with "
1489 "only one package providing a particular virtual package. For example, in the "
1490 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1491 "package, xless, provides \"X11-text-viewer\"."
1494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1495 #: apt-cache.8.xml:1
1497 "<literal>Mixed virtual packages</literal> is the number of packages that "
1498 "either provide a particular virtual package or have the virtual package name "
1499 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1500 "an actual package, and provided by the debconf-tiny package."
1503 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1504 #: apt-cache.8.xml:1
1506 "<literal>Missing</literal> is the number of package names that were "
1507 "referenced in a dependency but were not provided by any package. Missing "
1508 "packages may be an evidence if a full distribution is not accessed, or if a "
1509 "package (real or virtual) has been dropped from the distribution. Usually "
1510 "they are referenced from Conflicts or Breaks statements."
1513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1514 #: apt-cache.8.xml:1
1516 "<literal>Total distinct</literal> versions is the number of package versions "
1517 "found in the cache. If more than one distribution is being accessed (for "
1518 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1519 "larger than the number of total package names."
1522 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1523 #: apt-cache.8.xml:1
1525 "<literal>Total dependencies</literal> is the number of dependency "
1526 "relationships claimed by all of the packages in the cache."
1529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1530 #: apt-cache.8.xml:1
1532 "<literal>showsrc</literal> displays all the source package records that "
1533 "match the given package names. All versions are shown, as well as all "
1534 "records that declare the name to be a binary package. Use "
1535 "<option>--only-source</option> to display only source package names."
1538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1539 #: apt-cache.8.xml:1
1541 "<literal>dump</literal> shows a short listing of every package in the "
1542 "cache. It is primarily for debugging."
1545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1546 #: apt-cache.8.xml:1
1548 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1549 "suitable for use with &dpkg; and is used by the &dselect; method."
1552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1553 #: apt-cache.8.xml:1
1555 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1560 #: apt-cache.8.xml:1
1562 "<literal>show</literal> performs a function similar to <command>dpkg "
1563 "--print-avail</command>; it displays the package records for the named "
1567 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1568 #: apt-cache.8.xml:1
1569 msgid "&synopsis-regex;"
1572 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1573 #: apt-cache.8.xml:1
1575 "<literal>search</literal> performs a full text search on all available "
1576 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1577 "the package names and the descriptions for an occurrence of the regular "
1578 "expression and prints out the package name and the short description, "
1579 "including virtual package names. If <option>--full</option> is given then "
1580 "output identical to <literal>show</literal> is produced for each matched "
1581 "package, and if <option>--names-only</option> is given then the long "
1582 "description is not searched, only the package name and provided packages "
1586 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1587 #: apt-cache.8.xml:1
1589 "Separate arguments can be used to specify multiple search patterns that are "
1593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1594 #: apt-cache.8.xml:1
1596 "<literal>depends</literal> shows a listing of each dependency a package has "
1597 "and all the possible other packages that can fulfill that dependency."
1600 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1601 #: apt-cache.8.xml:1
1603 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1607 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1608 #: apt-cache.8.xml:1
1609 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1613 #: apt-cache.8.xml:1
1615 "This command prints the name of each package APT knows. The optional "
1616 "argument is a prefix match to filter the name list. The output is suitable "
1617 "for use in a shell tab complete function and the output is generated "
1618 "extremely quickly. This command is best used with the "
1619 "<option>--generate</option> option."
1622 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1623 #: apt-cache.8.xml:1
1625 "Note that a package which APT knows of is not necessarily available to "
1626 "download, installable or installed, e.g. virtual packages are also listed in "
1627 "the generated list."
1630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1631 #: apt-cache.8.xml:1
1633 "<literal>dotty</literal> takes a list of packages on the command line and "
1634 "generates output suitable for use by dotty from the <ulink "
1635 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1636 "package. The result will be a set of nodes and edges representing the "
1637 "relationships between the packages. By default the given packages will trace "
1638 "out all dependent packages; this can produce a very large graph. To limit "
1639 "the output to only the packages listed on the command line, set the "
1640 "<literal>APT::Cache::GivenOnly</literal> option."
1643 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1644 #: apt-cache.8.xml:1
1646 "The resulting nodes will have several shapes; normal packages are boxes, "
1647 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1648 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1649 "packages), blue lines are pre-depends, green lines are conflicts."
1652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1653 #: apt-cache.8.xml:1
1654 msgid "Caution, dotty cannot graph larger sets of packages."
1657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1658 #: apt-cache.8.xml:1
1660 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1661 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1665 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1666 #: apt-cache.8.xml:1
1667 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1670 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1671 #: apt-cache.8.xml:1
1673 "<literal>policy</literal> is meant to help debug issues relating to the "
1674 "preferences file. With no arguments it will print out the priorities of each "
1675 "source. Otherwise it prints out detailed information about the priority "
1676 "selection of the named package."
1679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1680 #: apt-cache.8.xml:1
1682 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1683 "to mimic the output format and a subset of the functionality of the Debian "
1684 "archive management tool, <literal>madison</literal>. It displays available "
1685 "versions of a package in a tabular format. Unlike the original "
1686 "<literal>madison</literal>, it can only display information for the "
1687 "architecture for which APT has retrieved package lists "
1688 "(<literal>APT::Architecture</literal>)."
1691 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1692 #: apt-cache.8.xml:1
1694 "Select the file to store the package cache. The package cache is the primary "
1695 "cache used by all operations. Configuration Item: "
1696 "<literal>Dir::Cache::pkgcache</literal>."
1699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1700 #: apt-cache.8.xml:1
1702 "Select the file to store the source cache. The source is used only by "
1703 "<literal>gencaches</literal> and it stores a parsed version of the package "
1704 "information from remote sources. When building the package cache the source "
1705 "cache is used to avoid reparsing all of the package files. Configuration "
1706 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1710 #: apt-cache.8.xml:1
1712 "Quiet; produces output suitable for logging, omitting progress indicators. "
1713 "More q's will produce more quietness up to a maximum of 2. You can also use "
1714 "<option>-q=#</option> to set the quietness level, overriding the "
1715 "configuration file. Configuration Item: <literal>quiet</literal>."
1718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1719 #: apt-cache.8.xml:1
1721 "Print only important dependencies; for use with <literal>unmet</literal> and "
1722 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1723 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1727 #: apt-cache.8.xml:1
1729 "Per default the <command>depends</command> and <command>rdepends</command> "
1730 "print all dependencies. This can be tweaked with these flags which will omit "
1731 "the specified dependency type. Configuration Item: "
1732 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1733 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1737 #: apt-cache.8.xml:1
1739 "Per default <command>depends</command> and <command>rdepends</command> print "
1740 "only dependencies explicitly expressed in the metadata. With this flag it "
1741 "will also show dependencies implicitely added based on the encountered "
1742 "data. A <literal>Conflicts: foo</literal> e.g. expresses implicitely that "
1743 "this package also conflicts with the package foo from any other "
1744 "architecture. Configuration Item: "
1745 "<literal>APT::Cache::ShowImplicit</literal>."
1748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1749 #: apt-cache.8.xml:1
1751 "Print full package records when searching. Configuration Item: "
1752 "<literal>APT::Cache::ShowFull</literal>."
1755 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1756 #: apt-cache.8.xml:1
1758 "Print full records for all available versions. This is the default; to turn "
1759 "it off, use <option>--no-all-versions</option>. If "
1760 "<option>--no-all-versions</option> is specified, only the candidate version "
1761 "will be displayed (the one which would be selected for installation). This "
1762 "option is only applicable to the <literal>show</literal> command. "
1763 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1766 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1767 #: apt-cache.8.xml:1
1769 "Perform automatic package cache regeneration, rather than use the cache as "
1770 "it is. This is the default; to turn it off, use "
1771 "<option>--no-generate</option>. Configuration Item: "
1772 "<literal>APT::Cache::Generate</literal>."
1775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1776 #: apt-cache.8.xml:1
1778 "Only search on the package and provided package names, not the long "
1779 "descriptions. Configuration Item: <literal>APT::Cache::NamesOnly</literal>."
1782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1783 #: apt-cache.8.xml:1
1785 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1786 "and missing dependencies. Configuration Item: "
1787 "<literal>APT::Cache::AllNames</literal>."
1790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1791 #: apt-cache.8.xml:1
1793 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1794 "that all packages mentioned are printed once. Configuration Item: "
1795 "<literal>APT::Cache::RecurseDepends</literal>."
1798 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1799 #: apt-cache.8.xml:1
1801 "Limit the output of <literal>depends</literal> and "
1802 "<literal>rdepends</literal> to packages which are currently installed. "
1803 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1806 #. type: Content of: <refentry><refsect1><para>
1807 #: apt-cache.8.xml:1
1808 msgid "&apt-conf;, &sources-list;, &apt-get;"
1811 #. type: Content of: <refentry><refsect1><para>
1812 #: apt-cache.8.xml:1
1814 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1818 #. type: Content of: <refentry><refnamediv><refpurpose>
1820 msgid "APT key management utility"
1823 #. type: Content of: <refentry><refsect1><para>
1826 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1827 "authenticate packages. Packages which have been authenticated using these "
1828 "keys will be considered trusted."
1831 #. type: Content of: <refentry><refsect1><title>
1836 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1839 "Add a new key to the list of trusted keys. The key is read from the "
1840 "filename given with the parameter &synopsis-param-filename; or if the "
1841 "filename is <literal>-</literal> from standard input."
1844 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1846 msgid "Remove a key from the list of trusted keys."
1849 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1851 msgid "Output the key &synopsis-param-keyid; to standard output."
1854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1856 msgid "Output all trusted keys to standard output."
1859 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1861 msgid "List trusted keys."
1864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1866 msgid "List fingerprints of trusted keys."
1869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1872 "Pass advanced options to gpg. With adv --recv-key you can download the "
1876 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1879 "Update the local keyring with the archive keyring and remove from the local "
1880 "keyring the archive keys which are no longer valid. The archive keyring is "
1881 "shipped in the <literal>archive-keyring</literal> package of your "
1882 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1885 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1888 "Perform an update working similarly to the <command>update</command> command "
1889 "above, but get the archive keyring from a URI instead and validate it "
1890 "against a master key. This requires an installed &wget; and an APT build "
1891 "configured to have a server to fetch from and a master keyring to validate. "
1892 "APT in Debian does not support this command, relying on "
1893 "<command>update</command> instead, but Ubuntu's APT does."
1896 #. type: Content of: <refentry><refsect1><title>
1897 #: apt-key.8.xml:1 apt-cdrom.8.xml:1
1901 #. type: Content of: <refentry><refsect1><para>
1904 "Note that options need to be defined before the commands described in the "
1908 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1911 "With this option it is possible to specify a particular keyring file the "
1912 "command should operate on. The default is that a command is executed on the "
1913 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1914 "<filename>trusted.gpg.d</filename> directory, though "
1915 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1916 "e.g. new keys are added to this one."
1919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1921 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1924 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1926 msgid "Local trust database of archive keys."
1929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1931 msgid "&keyring-filename;"
1934 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1936 msgid "Keyring of &keyring-distro; archive trusted keys."
1939 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1941 msgid "&keyring-removed-filename;"
1944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1946 msgid "Keyring of &keyring-distro; archive removed trusted keys."
1949 #. type: Content of: <refentry><refsect1><para>
1951 msgid "&apt-get;, &apt-secure;"
1954 #. type: Content of: <refentry><refnamediv><refpurpose>
1956 msgid "mark/unmark a package as being automatically-installed"
1959 #. type: Content of: <refentry><refsect1><para>
1962 "<command>apt-mark</command> will change whether a package has been marked as "
1963 "being automatically installed."
1966 #. type: Content of: <refentry><refsect1><para>
1969 "When you request that a package is installed, and as a result other packages "
1970 "are installed to satisfy its dependencies, the dependencies are marked as "
1971 "being automatically installed. Once these automatically installed packages "
1972 "are no longer depended on by any manually installed packages, they will be "
1973 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1976 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1979 "<literal>auto</literal> is used to mark a package as being automatically "
1980 "installed, which will cause the package to be removed when no more manually "
1981 "installed packages depend on this package."
1984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1987 "<literal>manual</literal> is used to mark a package as being manually "
1988 "installed, which will prevent the package from being automatically removed "
1989 "if no other packages depend on it."
1992 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1995 "<literal>hold</literal> is used to mark a package as held back, which will "
1996 "prevent the package from being automatically installed, upgraded or "
1997 "removed. The command is only a wrapper around <command>dpkg "
1998 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1999 "and not affected by the <option>--file</option> option."
2002 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2005 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2006 "package to allow all actions again."
2009 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2012 "<literal>showauto</literal> is used to print a list of automatically "
2013 "installed packages with each package on a new line. All automatically "
2014 "installed packages will be listed if no package is given. If packages are "
2015 "given only those which are automatically installed will be shown."
2018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2021 "<literal>showmanual</literal> can be used in the same way as "
2022 "<literal>showauto</literal> except that it will print a list of manually "
2023 "installed packages instead."
2026 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2029 "<literal>showhold</literal> is used to print a list of packages on hold in "
2030 "the same way as for the other show commands."
2033 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2036 "Read/Write package stats from the filename given with the parameter "
2037 "&synopsis-param-filename; instead of from the default location, which is "
2038 "<filename>extended_status</filename> in the directory defined by the "
2039 "Configuration Item: <literal>Dir::State</literal>."
2042 #. type: Content of: <refentry><refsect1><para>
2045 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2049 #. type: Content of: <refentry><refnamediv><refpurpose>
2050 #: apt-secure.8.xml:1
2051 msgid "Archive authentication support for APT"
2054 #. type: Content of: <refentry><refsect1><para>
2055 #: apt-secure.8.xml:1
2057 "Starting with version 0.6, <command>apt</command> contains code that does "
2058 "signature checking of the Release file for all archives. This ensures that "
2059 "packages in the archive can't be modified by people who have no access to "
2060 "the Release file signing key."
2063 #. type: Content of: <refentry><refsect1><para>
2064 #: apt-secure.8.xml:1
2066 "If a package comes from a archive without a signature, or with a signature "
2067 "that apt does not have a key for, that package is considered untrusted, and "
2068 "installing it will result in a big warning. <command>apt-get</command> will "
2069 "currently only warn for unsigned archives; future releases might force all "
2070 "sources to be verified before downloading packages from them."
2073 #. type: Content of: <refentry><refsect1><para>
2074 #: apt-secure.8.xml:1
2076 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2077 "authentication feature."
2080 #. type: Content of: <refentry><refsect1><title>
2081 #: apt-secure.8.xml:1
2082 msgid "Trusted archives"
2085 #. type: Content of: <refentry><refsect1><para>
2086 #: apt-secure.8.xml:1
2088 "The chain of trust from an apt archive to the end user is made up of several "
2089 "steps. <command>apt-secure</command> is the last step in this chain; "
2090 "trusting an archive does not mean that you trust its packages not to contain "
2091 "malicious code, but means that you trust the archive maintainer. It's the "
2092 "archive maintainer's responsibility to ensure that the archive's integrity "
2096 #. type: Content of: <refentry><refsect1><para>
2097 #: apt-secure.8.xml:1
2099 "apt-secure does not review signatures at a package level. If you require "
2100 "tools to do this you should look at <command>debsig-verify</command> and "
2101 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2102 "packages respectively)."
2105 #. type: Content of: <refentry><refsect1><para>
2106 #: apt-secure.8.xml:1
2108 "The chain of trust in Debian starts when a maintainer uploads a new package "
2109 "or a new version of a package to the Debian archive. In order to become "
2110 "effective, this upload needs to be signed by a key contained in the Debian "
2111 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
2112 "keys are signed by other maintainers following pre-established procedures to "
2113 "ensure the identity of the key holder."
2116 #. type: Content of: <refentry><refsect1><para>
2117 #: apt-secure.8.xml:1
2119 "Once the uploaded package is verified and included in the archive, the "
2120 "maintainer signature is stripped off, and checksums of the package are "
2121 "computed and put in the Packages file. The checksums of all of the Packages "
2122 "files are then computed and put into the Release file. The Release file is "
2123 "then signed by the archive key for this &keyring-distro; release, and "
2124 "distributed alongside the packages and the Packages files on "
2125 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2126 "keyring available in the &keyring-package; package."
2129 #. type: Content of: <refentry><refsect1><para>
2130 #: apt-secure.8.xml:1
2132 "End users can check the signature of the Release file, extract a checksum of "
2133 "a package from it and compare it with the checksum of the package they "
2134 "downloaded by hand - or rely on APT doing this automatically."
2137 #. type: Content of: <refentry><refsect1><para>
2138 #: apt-secure.8.xml:1
2140 "Notice that this is distinct from checking signatures on a per package "
2141 "basis. It is designed to prevent two possible attacks:"
2144 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2145 #: apt-secure.8.xml:1
2147 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2148 "checking, malicious agents can introduce themselves into the package "
2149 "download process and provide malicious software either by controlling a "
2150 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2151 "server (through ARP or DNS spoofing attacks)."
2154 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2155 #: apt-secure.8.xml:1
2157 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2158 "malicious agent can compromise a mirror host and modify the files in it to "
2159 "propagate malicious software to all users downloading packages from that "
2163 #. type: Content of: <refentry><refsect1><para>
2164 #: apt-secure.8.xml:1
2166 "However, it does not defend against a compromise of the Debian master server "
2167 "itself (which signs the packages) or against a compromise of the key used to "
2168 "sign the Release files. In any case, this mechanism can complement a "
2169 "per-package signature."
2172 #. type: Content of: <refentry><refsect1><title>
2173 #: apt-secure.8.xml:1
2174 msgid "User configuration"
2177 #. type: Content of: <refentry><refsect1><para>
2178 #: apt-secure.8.xml:1
2180 "<command>apt-key</command> is the program that manages the list of keys used "
2181 "by apt. It can be used to add or remove keys, although an installation of "
2182 "this release will automatically contain the default Debian archive signing "
2183 "keys used in the Debian package repositories."
2186 #. type: Content of: <refentry><refsect1><para>
2187 #: apt-secure.8.xml:1
2189 "In order to add a new key you need to first download it (you should make "
2190 "sure you are using a trusted communication channel when retrieving it), add "
2191 "it with <command>apt-key</command> and then run <command>apt-get "
2192 "update</command> so that apt can download and verify the "
2193 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2194 "from the archives you have configured."
2197 #. type: Content of: <refentry><refsect1><title>
2198 #: apt-secure.8.xml:1
2199 msgid "Archive configuration"
2202 #. type: Content of: <refentry><refsect1><para>
2203 #: apt-secure.8.xml:1
2205 "If you want to provide archive signatures in an archive under your "
2206 "maintenance you have to:"
2209 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2210 #: apt-secure.8.xml:1
2212 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2213 "already. You can do this by running <command>apt-ftparchive "
2214 "release</command> (provided in apt-utils)."
2217 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2218 #: apt-secure.8.xml:1
2220 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2221 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2222 "Release.gpg Release</command>."
2225 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2226 #: apt-secure.8.xml:1
2228 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
2229 "know what key they need to import in order to authenticate the files in the "
2233 #. type: Content of: <refentry><refsect1><para>
2234 #: apt-secure.8.xml:1
2236 "Whenever the contents of the archive change (new packages are added or "
2237 "removed) the archive maintainer has to follow the first two steps outlined "
2241 #. type: Content of: <refentry><refsect1><para>
2242 #: apt-secure.8.xml:1
2244 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2245 "&debsign;, &debsig-verify;, &gpg;"
2248 #. type: Content of: <refentry><refsect1><para>
2249 #: apt-secure.8.xml:1
2251 "For more background information you might want to review the <ulink "
2252 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2253 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2254 "(available also in the harden-doc package) and the <ulink "
2255 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2256 "Distribution HOWTO</ulink> by V. Alex Brennen."
2259 #. type: Content of: <refentry><refsect1><title>
2260 #: apt-secure.8.xml:1
2261 msgid "Manpage Authors"
2264 #. type: Content of: <refentry><refsect1><para>
2265 #: apt-secure.8.xml:1
2267 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2268 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2271 #. type: Content of: <refentry><refnamediv><refpurpose>
2272 #: apt-cdrom.8.xml:1
2273 msgid "APT CD-ROM management utility"
2276 #. type: Content of: <refentry><refsect1><para>
2277 #: apt-cdrom.8.xml:1
2279 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2280 "available sources. <command>apt-cdrom</command> takes care of determining "
2281 "the structure of the disc as well as correcting for several possible "
2282 "mis-burns and verifying the index files."
2285 #. type: Content of: <refentry><refsect1><para>
2286 #: apt-cdrom.8.xml:1
2288 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2289 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2290 "must be inserted and scanned separately to account for possible mis-burns."
2293 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2294 #: apt-cdrom.8.xml:1
2296 "<literal>add</literal> is used to add a new disc to the source list. It will "
2297 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2298 "to scan it and copy the index files. If the disc does not have a proper "
2299 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2303 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2304 #: apt-cdrom.8.xml:1
2306 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2307 "maintains a database of these IDs in "
2308 "<filename>&statedir;/cdroms.list</filename>"
2311 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2312 #: apt-cdrom.8.xml:1
2314 "A debugging tool to report the identity of the current disc as well as the "
2318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2319 #: apt-cdrom.8.xml:1
2321 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2322 "<option>--cdrom</option> option. Configuration Item: "
2323 "<literal>Acquire::cdrom::AutoDetect</literal>."
2326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2327 #: apt-cdrom.8.xml:1
2329 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2330 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2331 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2334 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2335 #: apt-cdrom.8.xml:1
2337 "Rename a disc; change the label of a disc or override the disc's given "
2338 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2339 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2343 #: apt-cdrom.8.xml:1
2345 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2346 "unmounting the mount point. Configuration Item: "
2347 "<literal>APT::CDROM::NoMount</literal>."
2350 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2351 #: apt-cdrom.8.xml:1
2353 "Fast Copy; Assume the package files are valid and do not check every "
2354 "package. This option should be used only if <command>apt-cdrom</command> has "
2355 "been run on this disc before and did not detect any errors. Configuration "
2356 "Item: <literal>APT::CDROM::Fast</literal>."
2359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2360 #: apt-cdrom.8.xml:1
2362 "Thorough Package Scan; This option may be needed with some old Debian "
2363 "1.1/1.2 discs that have Package files in strange places. It takes much "
2364 "longer to scan the CD but will pick them all up."
2367 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2368 #: apt-cdrom.8.xml:1
2370 "No Changes; Do not change the &sources-list; file and do not write index "
2371 "files. Everything is still checked however. Configuration Item: "
2372 "<literal>APT::CDROM::NoAct</literal>."
2375 #. type: Content of: <refentry><refsect1><para>
2376 #: apt-cdrom.8.xml:1
2377 msgid "&apt-conf;, &apt-get;, &sources-list;"
2380 #. type: Content of: <refentry><refsect1><para>
2381 #: apt-cdrom.8.xml:1
2383 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2387 #. type: Content of: <refentry><refnamediv><refpurpose>
2388 #: apt-config.8.xml:1
2389 msgid "APT Configuration Query program"
2392 #. type: Content of: <refentry><refsect1><para>
2393 #: apt-config.8.xml:1
2395 "<command>apt-config</command> is an internal program used by various "
2396 "portions of the APT suite to provide consistent configurability. It accesses "
2397 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2398 "manner that is easy to use for scripted applications."
2401 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2402 #: apt-config.8.xml:1
2404 "shell is used to access the configuration information from a shell "
2405 "script. It is given pairs of arguments, the first being a shell variable and "
2406 "the second the configuration value to query. As output it lists shell "
2407 "assignment commands for each value present. In a shell script it should be "
2411 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2412 #: apt-config.8.xml:1
2416 "RES=`apt-config shell OPTS MyApp::options`\n"
2420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2421 #: apt-config.8.xml:1
2423 "This will set the shell environment variable $OPTS to the value of "
2424 "MyApp::options with a default of <option>-f</option>."
2427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2428 #: apt-config.8.xml:1
2430 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2431 "names, d returns directories, b returns true or false and i returns an "
2432 "integer. Each of the returns is normalized and verified internally."
2435 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2436 #: apt-config.8.xml:1
2437 msgid "Just show the contents of the configuration space."
2440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2441 #: apt-config.8.xml:1
2443 "Include options which have an empty value. This is the default, so use "
2444 "--no-empty to remove them from the output."
2447 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2448 #: apt-config.8.xml:1
2449 msgid "%f "%v";%n"
2452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2453 #: apt-config.8.xml:1
2455 "Defines the output of each config option. %t will be replaced with "
2456 "its individual name, %f with its full hierarchical name and %v "
2457 "with its value. Use uppercase letters and special characters in the value "
2458 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2459 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2460 "and %N by a tab. A % can be printed by using %%."
2463 #. type: Content of: <refentry><refsect1><para>
2464 #: apt-config.8.xml:1 apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1
2465 #: apt-ftparchive.1.xml:1
2469 #. type: Content of: <refentry><refsect1><para>
2470 #: apt-config.8.xml:1
2472 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2476 #. type: Content of: <refentry><refentryinfo><author><contrib>
2478 msgid "Initial documentation of Debug::*."
2481 #. type: Content of: <refentry><refentryinfo><author><email>
2483 msgid "dburrows@debian.org"
2486 #. type: Content of: <refentry><refmeta><manvolnum>
2487 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
2491 #. type: Content of: <refentry><refnamediv><refpurpose>
2493 msgid "Configuration file for APT"
2496 #. type: Content of: <refentry><refsect1><para>
2499 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2500 "by all the tools in the APT suite of tools, though it is by no means the "
2501 "only place options can be set. The suite also shares a common command line "
2502 "parser to provide a uniform environment."
2505 #. type: Content of: <refentry><refsect1><orderedlist><para>
2508 "When an APT tool starts up it will read the configuration files in the "
2512 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2515 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2519 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2522 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2523 "order which have either no or \"<literal>conf</literal>\" as filename "
2524 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2525 "and period (.) characters. Otherwise APT will print a notice that it has "
2526 "ignored a file, unless that file matches a pattern in the "
2527 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2528 "case it will be silently ignored."
2531 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2533 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2536 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2539 "the command line options are applied to override the configuration "
2540 "directives or to load even more configuration files."
2543 #. type: Content of: <refentry><refsect1><title>
2548 #. type: Content of: <refentry><refsect1><para>
2551 "The configuration file is organized in a tree with options organized into "
2552 "functional groups. Option specification is given with a double colon "
2553 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2554 "within the APT tool group, for the Get tool. Options do not inherit from "
2555 "their parent groups."
2558 #. type: Content of: <refentry><refsect1><para>
2561 "Syntactically the configuration language is modeled after what the ISC tools "
2562 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2563 "treated as comments (ignored), as well as all text between "
2564 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2565 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2566 "The quotation marks and trailing semicolon are required. The value must be "
2567 "on one line, and there is no kind of string concatenation. Values must not "
2568 "include backslashes or extra quotation marks. Option names are made up of "
2569 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2570 "opened with curly braces, like this:"
2573 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2579 " Assume-Yes \"true\";\n"
2580 " Fix-Broken \"true\";\n"
2585 #. type: Content of: <refentry><refsect1><para>
2588 "with newlines placed to make it more readable. Lists can be created by "
2589 "opening a scope and including a single string enclosed in quotes followed by "
2590 "a semicolon. Multiple entries can be included, separated by a semicolon."
2593 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2596 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2599 #. type: Content of: <refentry><refsect1><para>
2602 "In general the sample configuration file &configureindex; is a good guide "
2603 "for how it should look."
2606 #. type: Content of: <refentry><refsect1><para>
2609 "Case is not significant in names of configuration items, so in the previous "
2610 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2613 #. type: Content of: <refentry><refsect1><para>
2616 "Names for the configuration items are optional if a list is defined as can "
2617 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2618 "you don't specify a name a new entry will simply add a new option to the "
2619 "list. If you specify a name you can override the option in the same way as "
2620 "any other option by reassigning a new value to the option."
2623 #. type: Content of: <refentry><refsect1><para>
2626 "Two special commands are defined: <literal>#include</literal> (which is "
2627 "deprecated and not supported by alternative implementations) and "
2628 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2629 "given file, unless the filename ends in a slash, in which case the whole "
2630 "directory is included. <literal>#clear</literal> is used to erase a part of "
2631 "the configuration tree. The specified element and all its descendants are "
2632 "erased. (Note that these lines also need to end with a semicolon.)"
2635 #. type: Content of: <refentry><refsect1><para>
2638 "The <literal>#clear</literal> command is the only way to delete a list or a "
2639 "complete scope. Reopening a scope (or using the syntax described below with "
2640 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2641 "previously written entries. Options can only be overridden by addressing a "
2642 "new value to them - lists and scopes can't be overridden, only cleared."
2645 #. type: Content of: <refentry><refsect1><para>
2648 "All of the APT tools take an -o option which allows an arbitrary "
2649 "configuration directive to be specified on the command line. The syntax is a "
2650 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2651 "followed by an equals sign then the new value of the option. To append a new "
2652 "element to a list, add a trailing <literal>::</literal> to the name of the "
2653 "list. (As you might suspect, the scope syntax can't be used on the command "
2657 #. type: Content of: <refentry><refsect1><para>
2660 "Note that appending items to a list using <literal>::</literal> only works "
2661 "for one item per line, and that you should not use it in combination with "
2662 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2663 "syntaxes together will trigger a bug which some users unfortunately depend "
2664 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2665 "like every other option with a name. This introduces many problems; for one "
2666 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2667 "syntax in the hope of appending to a list will achieve the opposite, as only "
2668 "the last assignment for this option \"<literal>::</literal>\" will be "
2669 "used. Future versions of APT will raise errors and stop working if they "
2670 "encounter this misuse, so please correct such statements now while APT "
2671 "doesn't explicitly complain about them."
2674 #. type: Content of: <refentry><refsect1><title>
2676 msgid "The APT Group"
2679 #. type: Content of: <refentry><refsect1><para>
2682 "This group of options controls general APT behavior as well as holding the "
2683 "options for all of the tools."
2686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2689 "System Architecture; sets the architecture to use when fetching files and "
2690 "parsing package lists. The internal default is the architecture apt was "
2694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2697 "All Architectures the system supports. For instance, CPUs implementing the "
2698 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2699 "instruction set are also able to execute binaries compiled for the "
2700 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2701 "is used when fetching files and parsing package lists. The initial default "
2702 "is always the system's native architecture "
2703 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2704 "to the default list when they are registered via <command>dpkg "
2705 "--add-architecture</command>."
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2711 "List of all build profiles enabled for build-dependency resolution, without "
2712 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2713 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2714 "&dpkg-buildpackage; overrides the list notation."
2717 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2720 "Default release to install packages from if more than one version is "
2721 "available. Contains release name, codename or release version. Examples: "
2722 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2723 "'4.0', '5.0*'. See also &apt-preferences;."
2726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2729 "Ignore held packages; this global option causes the problem resolver to "
2730 "ignore held packages in its decision making."
2733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2736 "Defaults to on. When turned on the autoclean feature will remove any "
2737 "packages which can no longer be downloaded from the cache. If turned off "
2738 "then packages that are locally installed are also excluded from cleaning - "
2739 "but note that APT provides no direct means to reinstall them."
2742 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2745 "Defaults to on, which will cause APT to install essential and important "
2746 "packages as soon as possible in an install/upgrade operation, in order to "
2747 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2748 "treats an important package in the same way as an extra package: between the "
2749 "unpacking of the package A and its configuration there can be many other "
2750 "unpack or configuration calls for other unrelated packages B, C etc. If "
2751 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2752 "scripts generate an error), this results in a system state in which package "
2753 "A is unpacked but unconfigured - so any package depending on A is now no "
2754 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2760 "The immediate configuration marker is also applied in the potentially "
2761 "problematic case of circular dependencies, since a dependency with the "
2762 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2763 "to recognise a situation in which it is unable to perform immediate "
2764 "configuration, abort, and suggest to the user that the option should be "
2765 "temporarily deactivated in order to allow the operation to proceed. Note "
2766 "the use of the word \"theory\" here; in the real world this problem has "
2767 "rarely been encountered, in non-stable distribution versions, and was caused "
2768 "by wrong dependencies of the package in question or by a system in an "
2769 "already broken state; so you should not blindly disable this option, as the "
2770 "scenario mentioned above is not the only problem it can help to prevent in "
2774 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2777 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2778 "option disabled you should try to explicitly <literal>install</literal> the "
2779 "package APT is unable to configure immediately; but please make sure you "
2780 "also report your problem to your distribution and to the APT team with the "
2781 "buglink below, so they can work on improving or correcting the upgrade "
2785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2788 "Never enable this option unless you <emphasis>really</emphasis> know what "
2789 "you are doing. It permits APT to temporarily remove an essential package to "
2790 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2791 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2792 "bug</emphasis>. This option will work if the essential packages are not "
2793 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2794 "<command>dpkg</command>, <command>dash</command> or anything that those "
2795 "packages depend on."
2798 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2801 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2802 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2803 "the size the cache will grow to, and is therefore the amount of memory APT "
2804 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2805 "that this amount of space needs to be available for APT; otherwise it will "
2806 "likely fail ungracefully, so for memory restricted devices this value should "
2807 "be lowered while on systems with a lot of configured sources it should be "
2808 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2809 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2810 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2811 "value will be applied again and again until either the cache is big enough "
2812 "to store all information or the size of the cache reaches the "
2813 "<literal>Cache-Limit</literal>. The default of "
2814 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2815 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2821 msgid "Defines which packages are considered essential build dependencies."
2824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2827 "The Get subsection controls the &apt-get; tool; please see its documentation "
2828 "for more information about the options here."
2831 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2834 "The Cache subsection controls the &apt-cache; tool; please see its "
2835 "documentation for more information about the options here."
2838 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2841 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2842 "documentation for more information about the options here."
2845 #. type: Content of: <refentry><refsect1><title>
2847 msgid "The Acquire Group"
2850 #. type: Content of: <refentry><refsect1><para>
2853 "The <literal>Acquire</literal> group of options controls the download of "
2854 "packages as well as the various \"acquire methods\" responsible for the "
2855 "download itself (see also &sources-list;)."
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2861 "Security related option defaulting to true, as giving a Release file's "
2862 "validation an expiration date prevents replay attacks over a long timescale, "
2863 "and can also for example help users to identify mirrors that are no longer "
2864 "updated - but the feature depends on the correctness of the clock on the "
2865 "user system. Archive maintainers are encouraged to create Release files with "
2866 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2867 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2868 "used. The <option>Check-Valid-Until</option> option of &sources-list; "
2869 "entries should be preferred to disable the check selectively instead of "
2870 "using this global override."
2873 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2876 "Maximum time (in seconds) after its creation (as indicated by the "
2877 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2878 "should be considered valid. If the Release file itself includes a "
2879 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2880 "the expiration date. The default value is <literal>0</literal> which stands "
2881 "for \"valid forever\". Archive specific settings can be made by appending "
2882 "the label of the archive to the option name. Preferably, the same can be "
2883 "achieved for specific &sources-list; entries by using the "
2884 "<option>Valid-Until-Max</option> option there."
2887 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2890 "Minimum time (in seconds) after its creation (as indicated by the "
2891 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2892 "should be considered valid. Use this if you need to use a seldom updated "
2893 "(local) mirror of a more frequently updated archive with a "
2894 "<literal>Valid-Until</literal> header instead of completely disabling the "
2895 "expiration date checking. Archive specific settings can and should be used "
2896 "by appending the label of the archive to the option name. Preferably, the "
2897 "same can be achieved for specific &sources-list; entries by using the "
2898 "<option>Valid-Until-Min</option> option there."
2901 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2904 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2905 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2906 "by default. Preferably, this can be set for specific &sources-list; entries "
2907 "or index files by using the <option>PDiffs</option> option there."
2910 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2913 "Two sub-options to limit the use of PDiffs are also available: "
2914 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2915 "PDiff files should be downloaded to update a "
2916 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2917 "percentage of the size of all patches compared to the size of the targeted "
2918 "file. If one of these limits is exceeded the complete file is downloaded "
2919 "instead of the patches."
2922 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2925 "Try to download indexes via an URI constructed from a hashsum of the "
2926 "expected file rather than downloaded via a well-known stable filename. True "
2927 "by default, but automatically disabled if the source indicates no support "
2928 "for it. Usage can be forced with the special value \"force\". Preferably, "
2929 "this can be set for specific &sources-list; entries or index files by using "
2930 "the <option>By-Hash</option> option there."
2933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2936 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2937 "<literal>host</literal> or <literal>access</literal> which determines how "
2938 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2939 "one connection per target host will be opened, <literal>access</literal> "
2940 "means that one connection per URI type will be opened."
2943 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2946 "Number of retries to perform. If this is non-zero APT will retry failed "
2947 "files the given number of times."
2950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2953 "Use symlinks for source archives. If set to true then source archives will "
2954 "be symlinked when possible instead of copying. True is the default."
2957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2960 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2961 "URIs. It is in the standard form of "
2962 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2963 "can also be specified by using the form "
2964 "<literal>http::Proxy::<host></literal> with the special keyword "
2965 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2966 "settings is specified, <envar>http_proxy</envar> environment variable will "
2970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2973 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2974 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2975 "response under any circumstances. <literal>Max-Age</literal> sets the "
2976 "allowed maximum age (in seconds) of an index file in the cache of the "
2977 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2978 "store the requested archive files in its cache, which can be used to prevent "
2979 "the proxy from polluting its cache with (big) .deb files."
2982 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2983 #: apt.conf.5.xml:1 apt.conf.5.xml:1
2985 "The option <literal>timeout</literal> sets the timeout timer used by the "
2986 "method; this value applies to the connection as well as the data timeout."
2989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2992 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2993 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2994 "e.g. on high-latency connections. It specifies how many requests are sent in "
2995 "a pipeline. APT tries to detect and workaround misbehaving webservers and "
2996 "proxies at runtime, but if you know that yours does not conform to the "
2997 "HTTP/1.1 specification pipelining can be disabled by setting the value to "
2998 "0. It is enabled by default with the value 10."
3001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3004 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
3005 "follow redirects, which is enabled by default."
3008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3011 "The used bandwidth can be limited with "
3012 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3013 "kilobytes per second. The default value is 0 which deactivates the limit and "
3014 "tries to use all available bandwidth. Note that this option implicitly "
3015 "disables downloading from multiple servers at the same time."
3018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3021 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3022 "User-Agent for the http download method as some proxies allow access for "
3023 "clients only if the client uses a known identifier."
3026 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3029 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
3030 "an external command to discover the http proxy to use. Apt expects the "
3031 "command to output the proxy on stdout in the style "
3032 "<literal>http://proxy:port/</literal>. This will override the generic "
3033 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
3034 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
3035 "the &squid-deb-proxy-client; package for an example implementation that uses "
3036 "avahi. This option takes precedence over the legacy option name "
3037 "<literal>ProxyAutoDetect</literal>."
3040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3043 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
3044 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
3045 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
3046 "the <literal>http</literal> method, and default to the same values if they "
3047 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
3051 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3054 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3055 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
3056 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3057 "suboption determines whether or not the server's host certificate should be "
3058 "verified against trusted certificates. "
3059 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
3060 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
3061 "or not the server's hostname should be verified. "
3062 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
3063 "option. <literal>SslCert</literal> determines what certificate to use for "
3064 "client authentication. <literal><host>::SslCert</literal> is the "
3065 "corresponding per-host option. <literal>SslKey</literal> determines what "
3066 "private key to use for client "
3067 "authentication. <literal><host>::SslKey</literal> is the corresponding "
3068 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3069 "version to use. It can contain either of the strings "
3070 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
3071 "<literal><host>::SslForceVersion</literal> is the corresponding "
3075 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3078 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
3079 "It is in the standard form of "
3080 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
3081 "also be specified by using the form "
3082 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3083 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3084 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3085 "used. To use an FTP proxy you will have to set the "
3086 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3087 "entry specifies the commands to send to tell the proxy server what to "
3088 "connect to. Please see &configureindex; for an example of how to do "
3089 "this. The substitution variables representing the corresponding URI "
3090 "component are <literal>$(PROXY_USER)</literal>, "
3091 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
3092 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
3093 "<literal>$(SITE_PORT)</literal>."
3096 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3099 "Several settings are provided to control passive mode. Generally it is safe "
3100 "to leave passive mode on; it works in nearly every environment. However, "
3101 "some situations require that passive mode be disabled and port mode FTP used "
3102 "instead. This can be done globally or for connections that go through a "
3103 "proxy or for a specific host (see the sample config file for examples)."
3106 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3109 "It is possible to proxy FTP over HTTP by setting the "
3110 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3111 "discussion of the http method above for syntax. You cannot set this in the "
3112 "configuration file and it is not recommended to use FTP over HTTP due to its "
3116 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3119 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3120 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3121 "false, which means these commands are only used if the control connection is "
3122 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3123 "that most FTP servers do not support RFC2428."
3126 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3129 msgid "/cdrom/::Mount \"foo\";"
3132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3135 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3136 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3137 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3138 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3139 "and unmount commands if your mount point cannot be listed in the fstab. The "
3140 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3141 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3142 "Unmount commands can be specified using UMount."
3145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3148 "For GPGV URIs the only configurable option is "
3149 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3153 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3157 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3158 "\"<replaceable>Methodname</replaceable>\";"
3161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3164 "List of compression types which are understood by the acquire methods. "
3165 "Files like <filename>Packages</filename> can be available in various "
3166 "compression formats. By default the acquire methods can decompress "
3167 "<command>bzip2</command>, <command>lzma</command> and "
3168 "<command>gzip</command> compressed files; with this setting more formats can "
3169 "be added on the fly or the used method can be changed. The syntax for this "
3170 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3173 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3176 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3179 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3182 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3188 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3189 "order the acquire system will try to download the compressed files. The "
3190 "acquire system will try the first and proceed with the next compression type "
3191 "in this list on error, so to prefer one over the other type simply add the "
3192 "preferred type first - default types not already added will be implicitly "
3193 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3194 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3195 "over <command>bzip2</command> and <command>lzma</command>. If "
3196 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3197 "<command>bzip2</command> the configure setting should look like this: "
3198 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3199 "<literal>bz2</literal> to the list explicitly as it will be added "
3203 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3206 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3209 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3213 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3214 "checked at run time. If this option has been set, the method will only be "
3215 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
3216 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
3217 "also that list entries specified on the command line will be added at the "
3218 "end of the list specified in the configuration files, but before the default "
3219 "entries. To prefer a type in this case over the ones specified in the "
3220 "configuration files you can set the option direct - not in list style. This "
3221 "will not override the defined list; it will only prefix the list with this "
3225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3228 "The special type <literal>uncompressed</literal> can be used to give "
3229 "uncompressed files a preference, but note that most archives don't provide "
3230 "uncompressed files so this is mostly only useable for local mirrors."
3233 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3236 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3237 "Sources, or Translations), keep them gzip compressed locally instead of "
3238 "unpacking them. This saves quite a lot of disk space at the expense of more "
3239 "CPU requirements when building the local package caches. False by default."
3242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3245 "The Languages subsection controls which <filename>Translation</filename> "
3246 "files are downloaded and in which order APT tries to display the "
3247 "description-translations. APT will try to display the first available "
3248 "description in the language which is listed first. Languages can be defined "
3249 "with their short or long language codes. Note that not all archives provide "
3250 "<filename>Translation</filename> files for every language - the long "
3251 "language codes are especially rare."
3254 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3257 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3260 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3263 "The default list includes \"environment\" and "
3264 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3265 "will be replaced at runtime with the language codes extracted from the "
3266 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3267 "that these codes are not included twice in the list. If "
3268 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3269 "<filename>Translation-en</filename> file (if available) will be used. To "
3270 "force APT to use no Translation file use the setting "
3271 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3272 "another special meaning code which will stop the search for a suitable "
3273 "<filename>Translation</filename> file. This tells APT to download these "
3274 "translations too, without actually using them unless the environment "
3275 "specifies the languages. So the following example configuration will result "
3276 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3277 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3278 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3279 "type=\"programlisting\" id=\"0\"/>"
3282 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3285 "Note: To prevent problems resulting from APT being executed in different "
3286 "environments (e.g. by different users or by other programs) all Translation "
3287 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3288 "added to the end of the list (after an implicit "
3289 "\"<literal>none</literal>\")."
3292 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3294 msgid "When downloading, force to use only the IPv4 protocol."
3297 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3299 msgid "When downloading, force to use only the IPv6 protocol."
3302 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3305 "The maximum file size of Release/Release.gpg/InRelease files. The default "
3309 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3312 "This option controls if apt will use the DNS SRV server record as specified "
3313 "in RFC 2782 to select an alternative server to connect to. The default is "
3317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3320 "Allow the update operation to load data files from a repository without a "
3321 "trusted signature. If enabled this option no data files will be loaded and "
3322 "the update operation fails with a error for this source. The default is "
3323 "false for backward compatibility. This will be changed in the future."
3326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3329 "Allow that a repository that was previously gpg signed to become unsigned "
3330 "durign a update operation. When there is no valid signature of a perviously "
3331 "trusted repository apt will refuse the update. This option can be used to "
3332 "override this protection. You almost certainly never want to enable "
3333 "this. The default is false. Note that apt will still consider packages from "
3334 "this source untrusted and warn about them if you try to install them."
3337 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3345 "Acquiring changelogs can only be done if an URI is known from where to get "
3346 "them. Preferable the Release file indicates this in a 'Changelogs' "
3347 "field. If this isn't available the Label/Origin field of the Release file is "
3348 "used to check if a "
3349 "<literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> "
3351 "<literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> "
3352 "option exists and if so this value is taken. The value in the Release file "
3353 "can be overridden with "
3354 "<literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal> "
3356 "<literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>. "
3357 "The value should be a normal URI to a text file, expect that package "
3358 "specific data is replaced with the placeholder "
3359 "<literal>CHANGEPATH</literal>. The value for it is: 1. if the package is "
3360 "from a component (e.g. <literal>main</literal>) this is the first part "
3361 "otherwise it is omitted, 2. the first letter of source package name, expect "
3362 "if the source package name starts with '<literal>lib</literal>' in which "
3363 "case it will be the first four letters. 3. The complete source package "
3364 "name. 4. the complete name again and 5. the source version. The first (if "
3365 "present), second, third and fourth part are separated by a slash "
3366 "('<literal>/</literal>') and between the fourth and fifth part is an "
3367 "underscore ('<literal>_</literal>'). The special value "
3368 "'<literal>no</literal>' is available for this option indicating that this "
3369 "source can't be used to acquire changelog files from. Another source will be "
3370 "tried if available in this case."
3373 #. type: Content of: <refentry><refsect1><title>
3378 #. type: Content of: <refentry><refsect1><para>
3381 "The <literal>Dir::State</literal> section has directories that pertain to "
3382 "local state information. <literal>lists</literal> is the directory to place "
3383 "downloaded package lists in and <literal>status</literal> is the name of the "
3384 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3385 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3386 "contains the default directory to prefix on all sub-items if they do not "
3387 "start with <filename>/</filename> or <filename>./</filename>."
3390 #. type: Content of: <refentry><refsect1><para>
3393 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3394 "information, such as the two package caches <literal>srcpkgcache</literal> "
3395 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3396 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3397 "be turned off by setting <literal>pkgcache</literal> or "
3398 "<literal>srcpkgcache</literal> to <literal>\"\"</literal>. This will slow "
3399 "down startup but save disk space. It is probably preferable to turn off the "
3400 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> "
3401 "the default directory is contained in <literal>Dir::Cache</literal>"
3404 #. type: Content of: <refentry><refsect1><para>
3407 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3408 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3409 "<literal>main</literal> is the default configuration file (setting has no "
3410 "effect, unless it is done from the config file specified by "
3411 "<envar>APT_CONFIG</envar>)."
3414 #. type: Content of: <refentry><refsect1><para>
3417 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3418 "in lexical order from the directory specified. After this is done then the "
3419 "main config file is loaded."
3422 #. type: Content of: <refentry><refsect1><para>
3425 "Binary programs are pointed to by "
3426 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3427 "the location of the method handlers and <literal>gzip</literal>, "
3428 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3429 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3430 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3431 "specify the location of the respective programs."
3434 #. type: Content of: <refentry><refsect1><para>
3437 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3438 "set, all paths will be relative to <literal>RootDir</literal>, "
3439 "<emphasis>even paths that are specified absolutely</emphasis>. So, for "
3440 "instance, if <literal>RootDir</literal> is set to "
3441 "<filename>/tmp/staging</filename> and <literal>Dir::State::status</literal> "
3442 "is set to <filename>/var/lib/dpkg/status</filename>, then the status file "
3443 "will be looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>. "
3444 "If you want to prefix only relative paths, set <literal>Dir</literal> "
3448 #. type: Content of: <refentry><refsect1><para>
3451 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3452 "which files APT should silently ignore while parsing the files in the "
3453 "fragment directories. Per default a file which end with "
3454 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3455 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3456 "default value these patterns can use regular expression syntax."
3459 #. type: Content of: <refentry><refsect1><title>
3461 msgid "APT in DSelect"
3464 #. type: Content of: <refentry><refsect1><para>
3467 "When APT is used as a &dselect; method several configuration directives "
3468 "control the default behavior. These are in the <literal>DSelect</literal> "
3472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3475 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3476 "<literal>prompt</literal>, <literal>auto</literal>, "
3477 "<literal>pre-auto</literal> and <literal>never</literal>. "
3478 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3479 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3480 "default) does so conditionally. <literal>auto</literal> removes only those "
3481 "packages which are no longer downloadable (replaced with a new version for "
3482 "instance). <literal>pre-auto</literal> performs this action before "
3483 "downloading new packages."
3486 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3489 "The contents of this variable are passed to &apt-get; as command line "
3490 "options when it is run for the install phase."
3493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3496 "The contents of this variable are passed to &apt-get; as command line "
3497 "options when it is run for the update phase."
3500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3503 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3504 "The default is to prompt only on error."
3507 #. type: Content of: <refentry><refsect1><title>
3509 msgid "How APT calls &dpkg;"
3512 #. type: Content of: <refentry><refsect1><para>
3515 "Several configuration directives control how APT invokes &dpkg;. These are "
3516 "in the <literal>DPkg</literal> section."
3519 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3522 "This is a list of options to pass to &dpkg;. The options must be specified "
3523 "using the list notation and each list item is passed as a single argument to "
3527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3530 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3531 "<literal>options</literal> this must be specified in list notation. The "
3532 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3533 "fail APT will abort."
3536 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3539 "This is a list of shell commands to run before invoking &dpkg;. Like "
3540 "<literal>options</literal> this must be specified in list notation. The "
3541 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3542 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3543 "going to install to the commands, one per line on the requested file "
3544 "descriptor, defaulting to standard input."
3547 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3550 "Version 2 of this protocol sends more information through the requested file "
3551 "descriptor: a line with the text <literal>VERSION 2</literal>, the APT "
3552 "configuration space, and a list of package actions with filename and version "
3556 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3559 "Each configuration directive line has the form "
3560 "<literal>key=value</literal>. Special characters (equal signs, newlines, "
3561 "nonprintable characters, quotation marks, and percent signs in "
3562 "<literal>key</literal> and newlines, nonprintable characters, and percent "
3563 "signs in <literal>value</literal>) are %-encoded. Lists are represented by "
3564 "multiple <literal>key::=value</literal> lines with the same key. The "
3565 "configuration section ends with a blank line."
3568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3571 "Package action lines consist of five fields in Version 2: old version, "
3572 "direction of version change (< for upgrades, > for downgrades, = for "
3573 "no change), new version, action. The version fields are \"-\" for no version "
3574 "at all (for example when installing a package for the first time; no version "
3575 "is treated as earlier than any real version, so that is an upgrade, "
3576 "indicated as <literal>- < 1.23.4</literal>). The action field is "
3577 "\"**CONFIGURE**\" if the package is being configured, \"**REMOVE**\" if it "
3578 "is being removed, or the filename of a .deb file if it is being unpacked."
3581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3584 "In Version 3 after each version field follows the architecture of this "
3585 "version, which is \"-\" if there is no version, and a field showing the "
3586 "MultiArch type \"same\", foreign\", \"allowed\" or \"none\". Note that "
3587 "\"none\" is an incorrect typename which is just kept to remain compatible, "
3588 "it should be read as \"no\" and users are encouraged to support both."
3591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3594 "The version of the protocol to be used for the command "
3595 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3596 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3597 "accordingly, the default being version 1. If APT isn't supporting the "
3598 "requested version it will send the information in the highest version it has "
3599 "support for instead."
3602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3605 "The file descriptor to be used to send the information can be requested with "
3606 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3607 "which defaults to <literal>0</literal> for standard input and is available "
3608 "since version 0.9.11. Support for the option can be detected by looking for "
3609 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3610 "number of the used file descriptor as a confirmation."
3613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3616 "APT chdirs to this directory before invoking &dpkg;, the default is "
3617 "<filename>/</filename>."
3620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3623 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3624 "default is to disable signing and produce all binaries."
3627 #. type: Content of: <refentry><refsect1><refsect2><title>
3629 msgid "dpkg trigger usage (and related options)"
3632 #. type: Content of: <refentry><refsect1><refsect2><para>
3635 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3636 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3637 "use triggers once each time it runs. Activating these options can therefore "
3638 "decrease the time needed to perform the install or upgrade. Note that it is "
3639 "intended to activate these options per default in the future, but as it "
3640 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3641 "<emphasis>These options are therefore currently experimental and should not "
3642 "be used in production environments.</emphasis> It also breaks progress "
3643 "reporting such that all front-ends will currently stay around half (or more) "
3644 "of the time in the 100% state while it actually configures all packages."
3647 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3651 "DPkg::NoTriggers \"true\";\n"
3652 "PackageManager::Configure \"smart\";\n"
3653 "DPkg::ConfigurePending \"true\";\n"
3654 "DPkg::TriggersPending \"true\";"
3657 #. type: Content of: <refentry><refsect1><refsect2><para>
3660 "Note that it is not guaranteed that APT will support these options or that "
3661 "these options will not cause (big) trouble in the future. If you have "
3662 "understand the current risks and problems with these options, but are brave "
3663 "enough to help testing them, create a new configuration file and test a "
3664 "combination of options. Please report any bugs, problems and improvements "
3665 "you encounter and make sure to note which options you have used in your "
3666 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3667 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3668 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3671 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3674 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3675 "call). See &dpkg; if you are interested in what this actually means. In "
3676 "short: &dpkg; will not run the triggers when this flag is present unless it "
3677 "is explicitly called to do so in an extra call. Note that this option "
3678 "exists (undocumented) also in older APT versions with a slightly different "
3679 "meaning: Previously these option only append --no-triggers to the configure "
3680 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3684 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3687 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3688 "and \"<literal>no</literal>\". The default value is "
3689 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3690 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3691 "be configured before another package can be unpacked (Pre-Depends), and let "
3692 "the rest be configured by &dpkg; with a call generated by the "
3693 "ConfigurePending option (see below). On the other hand, "
3694 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3695 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3696 "encountered). Setting this option to any value other than "
3697 "<literal>all</literal> will implicitly also activate the next option by "
3698 "default, as otherwise the system could end in an unconfigured and "
3699 "potentially unbootable state."
3702 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3705 "If this option is set APT will call <command>dpkg --configure "
3706 "--pending</command> to let &dpkg; handle all required configurations and "
3707 "triggers. This option is activated automatically per default if the previous "
3708 "option is not set to <literal>all</literal>, but deactivating it could be "
3709 "useful if you want to run APT multiple times in a row - e.g. in an "
3710 "installer. In these sceneries you could deactivate this option in all but "
3714 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3717 "Useful for the <literal>smart</literal> configuration as a package which has "
3718 "pending triggers is not considered as <literal>installed</literal>, and "
3719 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3720 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3721 "process all triggers, not only the triggers needed to configure this "
3725 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3729 "OrderList::Score {\n"
3731 "\tEssential 200;\n"
3733 "\tPreDepends 50;\n"
3737 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3740 "Essential packages (and their dependencies) should be configured immediately "
3741 "after unpacking. It is a good idea to do this quite early in the upgrade "
3742 "process as these configure calls also currently require "
3743 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3744 "(which may not be needed). Essentials get per default a high score but the "
3745 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3746 "higher). These option and the others in the same group can be used to "
3747 "change the scoring. The following example shows the settings with their "
3748 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3751 #. type: Content of: <refentry><refsect1><title>
3753 msgid "Periodic and Archives options"
3756 #. type: Content of: <refentry><refsect1><para>
3759 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3760 "of options configure behavior of apt periodic updates, which is done by the "
3761 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3762 "for the brief documentation of these options."
3765 #. type: Content of: <refentry><refsect1><title>
3767 msgid "Debug options"
3770 #. type: Content of: <refentry><refsect1><para>
3773 "Enabling options in the <literal>Debug::</literal> section will cause "
3774 "debugging information to be sent to the standard error stream of the program "
3775 "utilizing the <literal>apt</literal> libraries, or enable special program "
3776 "modes that are primarily useful for debugging the behavior of "
3777 "<literal>apt</literal>. Most of these options are not interesting to a "
3778 "normal user, but a few may be:"
3781 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3784 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3785 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3789 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3792 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3793 "used to run some operations (for instance, <literal>apt-get -s "
3794 "install</literal>) as a non-root user."
3797 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3800 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3801 "time that <literal>apt</literal> invokes &dpkg;."
3805 #. motivating example, except I haven't a clue why you'd want
3807 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3810 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3814 #. type: Content of: <refentry><refsect1><para>
3816 msgid "A full list of debugging options to apt follows."
3819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3821 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3826 msgid "Print information related to downloading packages using FTP."
3829 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3831 msgid "Print information related to downloading packages using HTTP."
3834 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3836 msgid "Print information related to downloading packages using HTTPS."
3839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3842 "Print information related to verifying cryptographic signatures using "
3843 "<literal>gpg</literal>."
3846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3849 "Output information about the process of accessing collections of packages "
3850 "stored on CD-ROMs."
3853 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3855 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3861 "Output each cryptographic hash that is generated by the "
3862 "<literal>apt</literal> libraries."
3865 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3868 "Do not include information from <literal>statfs</literal>, namely the number "
3869 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3873 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3876 "Disable all file locking. For instance, this will allow two instances of "
3877 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3882 msgid "Log when items are added to or removed from the global download queue."
3885 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3888 "Output status messages and errors related to verifying checksums and "
3889 "cryptographic signatures of downloaded files."
3892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3895 "Output information about downloading and applying package index list diffs, "
3896 "and errors relating to package index list diffs."
3899 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3902 "Output information related to patching apt package lists when downloading "
3903 "index diffs instead of full indices."
3906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3908 msgid "Log all interactions with the sub-processes that actually perform downloads."
3911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3914 "Log events related to the automatically-installed status of packages and to "
3915 "the removal of unused packages."
3918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3921 "Generate debug messages describing which packages are being automatically "
3922 "installed to resolve dependencies. This corresponds to the initial "
3923 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3924 "and not to the full <literal>apt</literal> dependency resolver; see "
3925 "<literal>Debug::pkgProblemResolver</literal> for that."
3928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3931 "Generate debug messages describing which packages are marked as "
3932 "keep/install/remove while the ProblemResolver does his work. Each addition "
3933 "or deletion may trigger additional actions; they are shown indented two "
3934 "additional spaces under the original entry. The format for each line is "
3935 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3936 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3937 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3938 "is the current version of the package, <literal>d.e.f</literal> is the "
3939 "version considered for installation and <literal>x.y.z</literal> is a newer "
3940 "version, but not considered for installation (because of a low pin "
3941 "score). The later two can be omitted if there is none or if it is the same "
3942 "as the installed version. <literal>section</literal> is the name of the "
3943 "section the package appears in."
3946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3949 "When invoking &dpkg;, output the precise command line with which it is being "
3950 "invoked, with arguments separated by a single space character."
3953 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3956 "Output all the data received from &dpkg; on the status file descriptor and "
3957 "any errors encountered while parsing it."
3960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3963 "Generate a trace of the algorithm that decides the order in which "
3964 "<literal>apt</literal> should pass packages to &dpkg;."
3967 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3969 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3974 msgid "Output the priority of each package list on startup."
3977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3980 "Trace the execution of the dependency resolver (this applies only to what "
3981 "happens when a complex dependency problem is encountered)."
3984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3987 "Display a list of all installed packages with their calculated score used by "
3988 "the pkgProblemResolver. The description of the package is the same as "
3989 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3992 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3995 "Print information about the vendors read from "
3996 "<filename>/etc/apt/vendors.list</filename>."
3999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4002 "Display the external commands that are called by apt hooks. This includes "
4003 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
4004 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
4007 #. type: Content of: <refentry><refsect1><title>
4008 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
4009 #: apt-ftparchive.1.xml:1
4013 #. type: Content of: <refentry><refsect1><para>
4016 "&configureindex; is a configuration file showing example values for all "
4020 #. ? reading apt.conf
4021 #. type: Content of: <refentry><refsect1><para>
4023 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4026 #. type: Content of: <refentry><refnamediv><refpurpose>
4027 #: apt_preferences.5.xml:1
4028 msgid "Preference control file for APT"
4031 #. type: Content of: <refentry><refsect1><para>
4032 #: apt_preferences.5.xml:1
4034 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4035 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4036 "can be used to control which versions of packages will be selected for "
4040 #. type: Content of: <refentry><refsect1><para>
4041 #: apt_preferences.5.xml:1
4043 "Several versions of a package may be available for installation when the "
4044 "&sources-list; file contains references to more than one distribution (for "
4045 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4046 "assigns a priority to each version that is available. Subject to dependency "
4047 "constraints, <command>apt-get</command> selects the version with the highest "
4048 "priority for installation. The APT preferences override the priorities that "
4049 "APT assigns to package versions by default, thus giving the user control "
4050 "over which one is selected for installation."
4053 #. type: Content of: <refentry><refsect1><para>
4054 #: apt_preferences.5.xml:1
4056 "Several instances of the same version of a package may be available when the "
4057 "&sources-list; file contains references to more than one source. In this "
4058 "case <command>apt-get</command> downloads the instance listed earliest in "
4059 "the &sources-list; file. The APT preferences do not affect the choice of "
4060 "instance, only the choice of version."
4063 #. type: Content of: <refentry><refsect1><para>
4064 #: apt_preferences.5.xml:1
4066 "Preferences are a strong power in the hands of a system administrator but "
4067 "they can become also their biggest nightmare if used without care! APT will "
4068 "not question the preferences, so wrong settings can lead to uninstallable "
4069 "packages or wrong decisions while upgrading packages. Even more problems "
4070 "will arise if multiple distribution releases are mixed without a good "
4071 "understanding of the following paragraphs. Packages included in a specific "
4072 "release aren't tested in (and therefore don't always work as expected in) "
4073 "older or newer releases, or together with other packages from different "
4074 "releases. You have been warned."
4077 #. type: Content of: <refentry><refsect1><para>
4078 #: apt_preferences.5.xml:1
4080 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4081 "directory are parsed in alphanumeric ascending order and need to obey the "
4082 "following naming convention: The files have either no or "
4083 "\"<literal>pref</literal>\" as filename extension and only contain "
4084 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4085 "Otherwise APT will print a notice that it has ignored a file, unless that "
4086 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4087 "configuration list - in which case it will be silently ignored."
4090 #. type: Content of: <refentry><refsect1><refsect2><title>
4091 #: apt_preferences.5.xml:1
4092 msgid "APT's Default Priority Assignments"
4095 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4096 #: apt_preferences.5.xml:1
4099 "<command>apt-get install -t testing "
4100 "<replaceable>some-package</replaceable></command>\n"
4103 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4104 #: apt_preferences.5.xml:1
4106 msgid "APT::Default-Release \"stable\";\n"
4109 #. type: Content of: <refentry><refsect1><refsect2><para>
4110 #: apt_preferences.5.xml:1
4112 "If there is no preferences file or if there is no entry in the file that "
4113 "applies to a particular version then the priority assigned to that version "
4114 "is the priority of the distribution to which that version belongs. It is "
4115 "possible to single out a distribution, \"the target release\", which "
4116 "receives a higher priority than other distributions do by default. The "
4117 "target release can be set on the <command>apt-get</command> command line or "
4118 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4119 "that this has precedence over any general priority you set in the "
4120 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4121 "specifically pinned packages. For example, <placeholder "
4122 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4126 #. type: Content of: <refentry><refsect1><refsect2><para>
4127 #: apt_preferences.5.xml:1
4129 "If the target release has been specified then APT uses the following "
4130 "algorithm to set the priorities of the versions of a package. Assign:"
4133 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4134 #: apt_preferences.5.xml:1
4138 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4139 #: apt_preferences.5.xml:1
4141 "to the versions coming from archives which in their "
4142 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4143 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
4144 "<literal>experimental</literal> archive."
4147 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4148 #: apt_preferences.5.xml:1
4149 msgid "priority 100"
4152 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4153 #: apt_preferences.5.xml:1
4155 "to the version that is already installed (if any) and to the versions coming "
4156 "from archives which in their <filename>Release</filename> files are marked "
4157 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
4158 "backports archive since <literal>squeeze-backports</literal>."
4161 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4162 #: apt_preferences.5.xml:1
4163 msgid "priority 500"
4166 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4167 #: apt_preferences.5.xml:1
4168 msgid "to the versions that do not belong to the target release."
4171 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4172 #: apt_preferences.5.xml:1
4173 msgid "priority 990"
4176 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4177 #: apt_preferences.5.xml:1
4178 msgid "to the versions that belong to the target release."
4181 #. type: Content of: <refentry><refsect1><refsect2><para>
4182 #: apt_preferences.5.xml:1
4184 "The highest of those priorities whose description matches the version is "
4185 "assigned to the version."
4188 #. type: Content of: <refentry><refsect1><refsect2><para>
4189 #: apt_preferences.5.xml:1
4191 "If the target release has not been specified then APT simply assigns "
4192 "priority 100 to all installed package versions and priority 500 to all "
4193 "uninstalled package versions, except versions coming from archives which in "
4194 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4195 "- these versions get the priority 1 or priority 100 if it is additionally "
4196 "marked as \"ButAutomaticUpgrades: yes\"."
4199 #. type: Content of: <refentry><refsect1><refsect2><para>
4200 #: apt_preferences.5.xml:1
4202 "APT then applies the following rules, listed in order of precedence, to "
4203 "determine which version of a package to install."
4206 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4207 #: apt_preferences.5.xml:1
4209 "Never downgrade unless the priority of an available version exceeds 1000. "
4210 "(\"Downgrading\" is installing a less recent version of a package in place "
4211 "of a more recent version. Note that none of APT's default priorities "
4212 "exceeds 1000; such high priorities can only be set in the preferences file. "
4213 "Note also that downgrading a package can be risky.)"
4216 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4217 #: apt_preferences.5.xml:1
4218 msgid "Install the highest priority version."
4221 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4222 #: apt_preferences.5.xml:1
4224 "If two or more versions have the same priority, install the most recent one "
4225 "(that is, the one with the higher version number)."
4228 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4229 #: apt_preferences.5.xml:1
4231 "If two or more versions have the same priority and version number but either "
4232 "the packages differ in some of their metadata or the "
4233 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4236 #. type: Content of: <refentry><refsect1><refsect2><para>
4237 #: apt_preferences.5.xml:1
4239 "In a typical situation, the installed version of a package (priority 100) "
4240 "is not as recent as one of the versions available from the sources listed in "
4241 "the &sources-list; file (priority 500 or 990). Then the package will be "
4242 "upgraded when <command>apt-get install "
4243 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4244 "upgrade</command> is executed."
4247 #. type: Content of: <refentry><refsect1><refsect2><para>
4248 #: apt_preferences.5.xml:1
4250 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4251 "recent than any of the other available versions. The package will not be "
4252 "downgraded when <command>apt-get install "
4253 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4254 "upgrade</command> is executed."
4257 #. type: Content of: <refentry><refsect1><refsect2><para>
4258 #: apt_preferences.5.xml:1
4260 "Sometimes the installed version of a package is more recent than the version "
4261 "belonging to the target release, but not as recent as a version belonging to "
4262 "some other distribution. Such a package will indeed be upgraded when "
4263 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4264 "or <command>apt-get upgrade</command> is executed, because at least "
4265 "<emphasis>one</emphasis> of the available versions has a higher priority "
4266 "than the installed version."
4269 #. type: Content of: <refentry><refsect1><refsect2><title>
4270 #: apt_preferences.5.xml:1
4271 msgid "The Effect of APT Preferences"
4274 #. type: Content of: <refentry><refsect1><refsect2><para>
4275 #: apt_preferences.5.xml:1
4277 "The APT preferences file allows the system administrator to control the "
4278 "assignment of priorities. The file consists of one or more multi-line "
4279 "records separated by blank lines. Records can have one of two forms, a "
4280 "specific form and a general form."
4283 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4284 #: apt_preferences.5.xml:1
4286 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4287 "specified packages with a specified version or version range. For example, "
4288 "the following record assigns a high priority to all versions of the "
4289 "<filename>perl</filename> package whose version number begins with "
4290 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4294 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4295 #: apt_preferences.5.xml:1
4299 "Pin: version &good-perl;*\n"
4300 "Pin-Priority: 1001\n"
4303 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4304 #: apt_preferences.5.xml:1
4306 "The general form assigns a priority to all of the package versions in a "
4307 "given distribution (that is, to all the versions of packages that are listed "
4308 "in a certain <filename>Release</filename> file) or to all of the package "
4309 "versions coming from a particular Internet site, as identified by the site's "
4310 "fully qualified domain name."
4313 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4314 #: apt_preferences.5.xml:1
4316 "This general-form entry in the APT preferences file applies only to groups "
4317 "of packages. For example, the following record assigns a high priority to "
4318 "all package versions available from the local site."
4321 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4322 #: apt_preferences.5.xml:1
4326 "Pin: origin \"\"\n"
4327 "Pin-Priority: 999\n"
4330 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4331 #: apt_preferences.5.xml:1
4333 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4334 "which can be used to match a hostname. The following record will assign a "
4335 "high priority to all versions available from the server identified by the "
4336 "hostname \"ftp.de.debian.org\""
4339 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4340 #: apt_preferences.5.xml:1
4344 "Pin: origin \"ftp.de.debian.org\"\n"
4345 "Pin-Priority: 999\n"
4348 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4349 #: apt_preferences.5.xml:1
4351 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4352 "distribution as specified in a <filename>Release</filename> file. What "
4353 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4354 "Internet address but an author or vendor name, such as \"Debian\" or "
4358 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4359 #: apt_preferences.5.xml:1
4361 "The following record assigns a low priority to all package versions "
4362 "belonging to any distribution whose Archive name is "
4363 "\"<literal>unstable</literal>\"."
4366 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4367 #: apt_preferences.5.xml:1
4371 "Pin: release a=unstable\n"
4372 "Pin-Priority: 50\n"
4375 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4376 #: apt_preferences.5.xml:1
4378 "The following record assigns a high priority to all package versions "
4379 "belonging to any distribution whose Codename is "
4380 "\"<literal>&testing-codename;</literal>\"."
4383 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4384 #: apt_preferences.5.xml:1
4388 "Pin: release n=&testing-codename;\n"
4389 "Pin-Priority: 900\n"
4392 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4393 #: apt_preferences.5.xml:1
4395 "The following record assigns a high priority to all package versions "
4396 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4397 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4400 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4401 #: apt_preferences.5.xml:1
4405 "Pin: release a=stable, v=&stable-version;\n"
4406 "Pin-Priority: 500\n"
4409 #. type: Content of: <refentry><refsect1><refsect2><para>
4410 #: apt_preferences.5.xml:1
4412 "The effect of the comma operator is similar to an \"and\" in logic: All "
4413 "conditions must be satisfied for the pin to match. There is one exception: "
4414 "For any type of condition (such as two \"a\" conditions), only the last such "
4415 "condition is checked."
4418 #. type: Content of: <refentry><refsect1><refsect2><title>
4419 #: apt_preferences.5.xml:1
4420 msgid "Regular expressions and &glob; syntax"
4423 #. type: Content of: <refentry><refsect1><refsect2><para>
4424 #: apt_preferences.5.xml:1
4426 "APT also supports pinning by &glob; expressions, and regular expressions "
4427 "surrounded by slashes. For example, the following example assigns the "
4428 "priority 500 to all packages from experimental where the name starts with "
4429 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4430 "extended regular expression surrounded by slashes)."
4433 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4434 #: apt_preferences.5.xml:1
4437 "Package: gnome* /kde/\n"
4438 "Pin: release a=experimental\n"
4439 "Pin-Priority: 500\n"
4442 #. type: Content of: <refentry><refsect1><refsect2><para>
4443 #: apt_preferences.5.xml:1
4445 "The rule for those expressions is that they can occur anywhere where a "
4446 "string can occur. Thus, the following pin assigns the priority 990 to all "
4447 "packages from a release starting with &ubuntu-codename;."
4450 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4451 #: apt_preferences.5.xml:1
4455 "Pin: release n=&ubuntu-codename;*\n"
4456 "Pin-Priority: 990\n"
4459 #. type: Content of: <refentry><refsect1><refsect2><para>
4460 #: apt_preferences.5.xml:1
4462 "If a regular expression occurs in a <literal>Package</literal> field, the "
4463 "behavior is the same as if this regular expression were replaced with a list "
4464 "of all package names it matches. It is undecided whether this will change in "
4465 "the future; thus you should always list wild-card pins first, so later "
4466 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4467 "Package field is not considered a &glob; expression in itself."
4470 #. type: Content of: <refentry><refsect1><refsect2><title>
4471 #: apt_preferences.5.xml:1
4472 msgid "How APT Interprets Priorities"
4475 #. type: Content of: <refentry><refsect1><refsect2><para>
4476 #: apt_preferences.5.xml:1
4478 "Priorities (P) assigned in the APT preferences file must be positive or "
4479 "negative integers. They are interpreted as follows (roughly speaking):"
4482 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4483 #: apt_preferences.5.xml:1
4484 msgid "P >= 1000"
4487 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4488 #: apt_preferences.5.xml:1
4490 "causes a version to be installed even if this constitutes a downgrade of the "
4494 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4495 #: apt_preferences.5.xml:1
4496 msgid "990 <= P < 1000"
4499 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4500 #: apt_preferences.5.xml:1
4502 "causes a version to be installed even if it does not come from the target "
4503 "release, unless the installed version is more recent"
4506 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4507 #: apt_preferences.5.xml:1
4508 msgid "500 <= P < 990"
4511 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4512 #: apt_preferences.5.xml:1
4514 "causes a version to be installed unless there is a version available "
4515 "belonging to the target release or the installed version is more recent"
4518 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4519 #: apt_preferences.5.xml:1
4520 msgid "100 <= P < 500"
4523 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4524 #: apt_preferences.5.xml:1
4526 "causes a version to be installed unless there is a version available "
4527 "belonging to some other distribution or the installed version is more recent"
4530 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4531 #: apt_preferences.5.xml:1
4532 msgid "0 < P < 100"
4535 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4536 #: apt_preferences.5.xml:1
4538 "causes a version to be installed only if there is no installed version of "
4542 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4543 #: apt_preferences.5.xml:1
4547 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4548 #: apt_preferences.5.xml:1
4549 msgid "prevents the version from being installed"
4552 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4553 #: apt_preferences.5.xml:1
4557 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4558 #: apt_preferences.5.xml:1
4559 msgid "has undefined behaviour, do not use it."
4562 #. type: Content of: <refentry><refsect1><refsect2><para>
4563 #: apt_preferences.5.xml:1
4565 "The first specific-form record matching an available package version "
4566 "determines the priority of the package version. Failing that, the priority "
4567 "of the package is defined as the maximum of all priorities defined by "
4568 "generic-form records matching the version. Records defined using patterns "
4569 "in the Pin field other than \"*\" are treated like specific-form records."
4572 #. type: Content of: <refentry><refsect1><refsect2><para>
4573 #: apt_preferences.5.xml:1
4575 "For example, suppose the APT preferences file contains the three records "
4576 "presented earlier:"
4579 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4580 #: apt_preferences.5.xml:1
4584 "Pin: version &good-perl;*\n"
4585 "Pin-Priority: 1001\n"
4588 "Pin: origin \"\"\n"
4589 "Pin-Priority: 999\n"
4592 "Pin: release unstable\n"
4593 "Pin-Priority: 50\n"
4596 #. type: Content of: <refentry><refsect1><refsect2><para>
4597 #: apt_preferences.5.xml:1
4601 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4602 #: apt_preferences.5.xml:1
4604 "The most recent available version of the <literal>perl</literal> package "
4605 "will be installed, so long as that version's version number begins with "
4606 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4607 "&good-perl;* version of <literal>perl</literal> is available and the "
4608 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4612 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4613 #: apt_preferences.5.xml:1
4615 "A version of any package other than <literal>perl</literal> that is "
4616 "available from the local system has priority over other versions, even "
4617 "versions belonging to the target release."
4620 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4621 #: apt_preferences.5.xml:1
4623 "A version of a package whose origin is not the local system but some other "
4624 "site listed in &sources-list; and which belongs to an "
4625 "<literal>unstable</literal> distribution is only installed if it is selected "
4626 "for installation and no version of the package is already installed."
4629 #. type: Content of: <refentry><refsect1><refsect2><title>
4630 #: apt_preferences.5.xml:1
4631 msgid "Determination of Package Version and Distribution Properties"
4634 #. type: Content of: <refentry><refsect1><refsect2><para>
4635 #: apt_preferences.5.xml:1
4637 "The locations listed in the &sources-list; file should provide "
4638 "<filename>Packages</filename> and <filename>Release</filename> files to "
4639 "describe the packages available at that location."
4642 #. type: Content of: <refentry><refsect1><refsect2><para>
4643 #: apt_preferences.5.xml:1
4645 "The <filename>Packages</filename> file is normally found in the directory "
4646 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4648 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4649 "consists of a series of multi-line records, one for each package available "
4650 "in that directory. Only two lines in each record are relevant for setting "
4654 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4655 #: apt_preferences.5.xml:1
4656 msgid "the <literal>Package:</literal> line"
4659 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4660 #: apt_preferences.5.xml:1
4661 msgid "gives the package name"
4664 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4665 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1
4666 msgid "the <literal>Version:</literal> line"
4669 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4670 #: apt_preferences.5.xml:1
4671 msgid "gives the version number for the named package"
4674 #. type: Content of: <refentry><refsect1><refsect2><para>
4675 #: apt_preferences.5.xml:1
4677 "The <filename>Release</filename> file is normally found in the directory "
4678 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4679 "example, <filename>.../dists/stable/Release</filename>, or "
4680 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4681 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4682 "packages in the directory tree below its parent. Unlike the "
4683 "<filename>Packages</filename> file, nearly all of the lines in a "
4684 "<filename>Release</filename> file are relevant for setting APT priorities:"
4687 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4688 #: apt_preferences.5.xml:1
4689 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4692 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4693 #: apt_preferences.5.xml:1
4695 "names the archive to which all the packages in the directory tree belong. "
4696 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4697 "that all of the packages in the directory tree below the parent of the "
4698 "<filename>Release</filename> file are in a <literal>stable</literal> "
4699 "archive. Specifying this value in the APT preferences file would require "
4703 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4704 #: apt_preferences.5.xml:1
4706 msgid "Pin: release a=stable\n"
4709 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4710 #: apt_preferences.5.xml:1
4711 msgid "the <literal>Codename:</literal> line"
4714 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4715 #: apt_preferences.5.xml:1
4717 "names the codename to which all the packages in the directory tree belong. "
4718 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4719 "the packages in the directory tree below the parent of the "
4720 "<filename>Release</filename> file belong to a version named "
4721 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4722 "preferences file would require the line:"
4725 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4726 #: apt_preferences.5.xml:1
4728 msgid "Pin: release n=&testing-codename;\n"
4731 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4732 #: apt_preferences.5.xml:1
4734 "names the release version. For example, the packages in the tree might "
4735 "belong to Debian release version &stable-version;. Note that there is "
4736 "normally no version number for the <literal>testing</literal> and "
4737 "<literal>unstable</literal> distributions because they have not been "
4738 "released yet. Specifying this in the APT preferences file would require one "
4739 "of the following lines."
4742 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4743 #: apt_preferences.5.xml:1
4746 "Pin: release v=&stable-version;\n"
4747 "Pin: release a=stable, v=&stable-version;\n"
4748 "Pin: release &stable-version;\n"
4751 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4752 #: apt_preferences.5.xml:1
4753 msgid "the <literal>Component:</literal> line"
4756 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4757 #: apt_preferences.5.xml:1
4759 "names the licensing component associated with the packages in the directory "
4760 "tree of the <filename>Release</filename> file. For example, the line "
4761 "\"Component: main\" specifies that all the packages in the directory tree "
4762 "are from the <literal>main</literal> component, which entails that they are "
4763 "licensed under terms listed in the Debian Free Software Guidelines. "
4764 "Specifying this component in the APT preferences file would require the "
4768 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4769 #: apt_preferences.5.xml:1
4771 msgid "Pin: release c=main\n"
4774 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4775 #: apt_preferences.5.xml:1
4776 msgid "the <literal>Origin:</literal> line"
4779 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4780 #: apt_preferences.5.xml:1
4782 "names the originator of the packages in the directory tree of the "
4783 "<filename>Release</filename> file. Most commonly, this is "
4784 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4785 "file would require the line:"
4788 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4789 #: apt_preferences.5.xml:1
4791 msgid "Pin: release o=Debian\n"
4794 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4795 #: apt_preferences.5.xml:1
4796 msgid "the <literal>Label:</literal> line"
4799 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4800 #: apt_preferences.5.xml:1
4802 "names the label of the packages in the directory tree of the "
4803 "<filename>Release</filename> file. Most commonly, this is "
4804 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4805 "file would require the line:"
4808 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4809 #: apt_preferences.5.xml:1
4811 msgid "Pin: release l=Debian\n"
4814 #. type: Content of: <refentry><refsect1><refsect2><para>
4815 #: apt_preferences.5.xml:1
4817 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4818 "files retrieved from locations listed in the &sources-list; file are stored "
4819 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4820 "named by the variable <literal>Dir::State::Lists</literal> in the "
4821 "<filename>apt.conf</filename> file. For example, the file "
4822 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4823 "contains the <filename>Release</filename> file retrieved from the site "
4824 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4825 "architecture files from the <literal>contrib</literal> component of the "
4826 "<literal>unstable</literal> distribution."
4829 #. type: Content of: <refentry><refsect1><refsect2><title>
4830 #: apt_preferences.5.xml:1
4831 msgid "Optional Lines in an APT Preferences Record"
4834 #. type: Content of: <refentry><refsect1><refsect2><para>
4835 #: apt_preferences.5.xml:1
4837 "Each record in the APT preferences file can optionally begin with one or "
4838 "more lines beginning with the word <literal>Explanation:</literal>. This "
4839 "provides a place for comments."
4842 #. type: Content of: <refentry><refsect1><refsect2><title>
4843 #: apt_preferences.5.xml:1
4844 msgid "Tracking Stable"
4847 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4848 #: apt_preferences.5.xml:1
4851 "Explanation: Uninstall or do not install any Debian-originated\n"
4852 "Explanation: package versions other than those in the stable distro\n"
4854 "Pin: release a=stable\n"
4855 "Pin-Priority: 900\n"
4858 "Pin: release o=Debian\n"
4859 "Pin-Priority: -10\n"
4862 #. type: Content of: <refentry><refsect1><refsect2><para>
4863 #: apt_preferences.5.xml:1
4865 "The following APT preferences file will cause APT to assign a priority "
4866 "higher than the default (500) to all package versions belonging to a "
4867 "<literal>stable</literal> distribution and a prohibitively low priority to "
4868 "package versions belonging to other <literal>Debian</literal> "
4869 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4872 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4873 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1 apt_preferences.5.xml:1
4876 "apt-get install <replaceable>package-name</replaceable>\n"
4878 "apt-get dist-upgrade\n"
4881 #. type: Content of: <refentry><refsect1><refsect2><para>
4882 #: apt_preferences.5.xml:1
4884 "With a suitable &sources-list; file and the above preferences file, any of "
4885 "the following commands will cause APT to upgrade to the latest "
4886 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4890 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4891 #: apt_preferences.5.xml:1
4893 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4896 #. type: Content of: <refentry><refsect1><refsect2><para>
4897 #: apt_preferences.5.xml:1
4899 "The following command will cause APT to upgrade the specified package to the "
4900 "latest version from the <literal>testing</literal> distribution; the package "
4901 "will not be upgraded again unless this command is given again. <placeholder "
4902 "type=\"programlisting\" id=\"0\"/>"
4905 #. type: Content of: <refentry><refsect1><refsect2><title>
4906 #: apt_preferences.5.xml:1
4907 msgid "Tracking Testing or Unstable"
4910 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4911 #: apt_preferences.5.xml:1
4915 "Pin: release a=testing\n"
4916 "Pin-Priority: 900\n"
4919 "Pin: release a=unstable\n"
4920 "Pin-Priority: 800\n"
4923 "Pin: release o=Debian\n"
4924 "Pin-Priority: -10\n"
4927 #. type: Content of: <refentry><refsect1><refsect2><para>
4928 #: apt_preferences.5.xml:1
4930 "The following APT preferences file will cause APT to assign a high priority "
4931 "to package versions from the <literal>testing</literal> distribution, a "
4932 "lower priority to package versions from the <literal>unstable</literal> "
4933 "distribution, and a prohibitively low priority to package versions from "
4934 "other <literal>Debian</literal> distributions. <placeholder "
4935 "type=\"programlisting\" id=\"0\"/>"
4938 #. type: Content of: <refentry><refsect1><refsect2><para>
4939 #: apt_preferences.5.xml:1
4941 "With a suitable &sources-list; file and the above preferences file, any of "
4942 "the following commands will cause APT to upgrade to the latest "
4943 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4947 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4948 #: apt_preferences.5.xml:1
4950 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4953 #. type: Content of: <refentry><refsect1><refsect2><para>
4954 #: apt_preferences.5.xml:1
4956 "The following command will cause APT to upgrade the specified package to the "
4957 "latest version from the <literal>unstable</literal> distribution. "
4958 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4959 "the most recent <literal>testing</literal> version if that is more recent "
4960 "than the installed version, otherwise, to the most recent "
4961 "<literal>unstable</literal> version if that is more recent than the "
4962 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4965 #. type: Content of: <refentry><refsect1><refsect2><title>
4966 #: apt_preferences.5.xml:1
4967 msgid "Tracking the evolution of a codename release"
4970 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4971 #: apt_preferences.5.xml:1
4974 "Explanation: Uninstall or do not install any Debian-originated package "
4976 "Explanation: other than those in the distribution codenamed with "
4977 "&testing-codename; or sid\n"
4979 "Pin: release n=&testing-codename;\n"
4980 "Pin-Priority: 900\n"
4982 "Explanation: Debian unstable is always codenamed with sid\n"
4984 "Pin: release n=sid\n"
4985 "Pin-Priority: 800\n"
4988 "Pin: release o=Debian\n"
4989 "Pin-Priority: -10\n"
4992 #. type: Content of: <refentry><refsect1><refsect2><para>
4993 #: apt_preferences.5.xml:1
4995 "The following APT preferences file will cause APT to assign a priority "
4996 "higher than the default (500) to all package versions belonging to a "
4997 "specified codename of a distribution and a prohibitively low priority to "
4998 "package versions belonging to other <literal>Debian</literal> distributions, "
4999 "codenames and archives. Note that with this APT preference APT will follow "
5000 "the migration of a release from the archive <literal>testing</literal> to "
5001 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5002 "want to follow for example the progress in <literal>testing</literal> "
5003 "notwithstanding the codename changes you should use the example "
5004 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5007 #. type: Content of: <refentry><refsect1><refsect2><para>
5008 #: apt_preferences.5.xml:1
5010 "With a suitable &sources-list; file and the above preferences file, any of "
5011 "the following commands will cause APT to upgrade to the latest version(s) in "
5012 "the release codenamed with <literal>&testing-codename;</literal>. "
5013 "<placeholder type=\"programlisting\" id=\"0\"/>"
5016 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5017 #: apt_preferences.5.xml:1
5019 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5022 #. type: Content of: <refentry><refsect1><refsect2><para>
5023 #: apt_preferences.5.xml:1
5025 "The following command will cause APT to upgrade the specified package to the "
5026 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5027 "<command>apt-get upgrade</command> will upgrade the package to the most "
5028 "recent <literal>&testing-codename;</literal> version if that is more recent "
5029 "than the installed version, otherwise, to the most recent "
5030 "<literal>sid</literal> version if that is more recent than the installed "
5031 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5034 #. type: Content of: <refentry><refsect1><para>
5035 #: apt_preferences.5.xml:1
5036 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5039 #. type: Content of: <refentry><refnamediv><refpurpose>
5040 #: sources.list.5.xml:1
5041 msgid "List of configured APT data sources"
5044 #. type: Content of: <refentry><refsect1><para>
5045 #: sources.list.5.xml:1
5047 "The source list <filename>/etc/apt/sources.list</filename> and the the files "
5048 "contained in <filename>/etc/apt/sources.list.d/</filename> are designed to "
5049 "support any number of active sources and a variety of source media. The "
5050 "files list one source per line (one line style) or contain multiline stanzas "
5051 "defining one or more sources per stanza (deb822 style), with the most "
5052 "preferred source listed first (in case a single version is available from "
5053 "more than one source). The information available from the configured sources "
5054 "is acquired by <command>apt-get update</command> (or by an equivalent "
5055 "command from another APT front-end)."
5058 #. type: Content of: <refentry><refsect1><title>
5059 #: sources.list.5.xml:1
5060 msgid "sources.list.d"
5063 #. type: Content of: <refentry><refsect1><para>
5064 #: sources.list.5.xml:1
5066 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5067 "add sources.list entries in separate files. Two different file formats are "
5068 "allowed as described in the next two sections. Filenames need to have "
5069 "either the extension <filename>.list</filename> or "
5070 "<filename>.sources</filename> depending on the contained format. The "
5071 "filenames may only contain letters (a-z and A-Z), digits (0-9), underscore "
5072 "(_), hyphen (-) and period (.) characters. Otherwise APT will print a "
5073 "notice that it has ignored a file, unless that file matches a pattern in the "
5074 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
5075 "case it will be silently ignored."
5078 #. type: Content of: <refentry><refsect1><title>
5079 #: sources.list.5.xml:1
5080 msgid "one line style format"
5083 #. type: Content of: <refentry><refsect1><para>
5084 #: sources.list.5.xml:1
5086 "Files in this format have the extension <filename>.list</filename>. Each "
5087 "line specifying a source starts with a type "
5088 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
5089 "this type. Individual entries cannot be continued onto a following "
5090 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
5091 "on a line marks the remainder of that line as a comment. Consequently an "
5092 "entry can be disabled by commenting out the entire line. If options should "
5093 "be provided they are separated by spaces and all of them together are "
5094 "enclosed by square brackets (<literal>[]</literal>) included in the line "
5095 "after the type separated from it with a space. If an option allows multiple "
5096 "values these are separated from each other with a comma "
5097 "(<literal>,</literal>). An option name is separated from its value(s) by a "
5098 "equal sign (<literal>=</literal>). Multivalue options have also "
5099 "<literal>-=</literal> and <literal>+=</literal> as separator which instead "
5100 "of replacing the default with the given value(s) modify the default value(s) "
5101 "to remove or include the given values."
5104 #. type: Content of: <refentry><refsect1><para>
5105 #: sources.list.5.xml:1
5107 "This is the traditional format and supported by all apt versions. Note that "
5108 "not all options as described below are supported by all apt versions. Note "
5109 "also that some older applications parsing this format on its own might not "
5110 "expect to encounter options as they were uncommon before the introduction of "
5111 "multi-architecture support."
5114 #. type: Content of: <refentry><refsect1><title>
5115 #: sources.list.5.xml:1
5116 msgid "deb822 style format"
5119 #. type: Content of: <refentry><refsect1><para>
5120 #: sources.list.5.xml:1
5122 "Files in this format have the extension <filename>.sources</filename>. The "
5123 "format is similar in syntax to other files used by Debian and its "
5124 "derivatives, like the metadata itself apt will download from the configured "
5125 "sources or the <filename>debian/control</filename> file in a Debian source "
5126 "package. Individual entries are separated by an empty line, additional "
5127 "empty lines are ignored, and a <literal>#</literal> character at the start "
5128 "of the line marks the entire line as a comment. An entry can hence be "
5129 "disabled by commenting out each line belonging to the stanza, but it is "
5130 "usually easier to add the field \"Enabled: no\" to the stanza to disable the "
5131 "entry. Removing the field or setting it to yes reenables it. Options have "
5132 "the same syntax as every other field: A fieldname separated by a colon "
5133 "(<literal>:</literal>) and optionally spaces from its value(s). Note "
5134 "especially that multiple values are separated by spaces, not by commas as in "
5135 "the one line format. Multivalue fields like <literal>Architectures</literal> "
5136 "also have <literal>Architectures-Add</literal> and "
5137 "<literal>Architectures-Remove</literal> to modify the default value rather "
5138 "than replacing it."
5141 #. type: Content of: <refentry><refsect1><para>
5142 #: sources.list.5.xml:1
5144 "This is a new format supported by apt itself since version 1.1. Previous "
5145 "versions ignore such files with a notice message as described earlier. It "
5146 "is intended to make this format gradually the default format and deprecating "
5147 "the previously described one line style format as it is easier to create, "
5148 "extend and modify by humans and machines alike especially if a lot of "
5149 "sources and/or options are involved. Developers who are working with and/or "
5150 "parsing apt sources are highly encouraged to add support for this format and "
5151 "to contact the APT team to coordinate and share this work. Users can freely "
5152 "adopt this format already, but could encounter problems with software not "
5153 "supporting the format yet."
5156 #. type: Content of: <refentry><refsect1><title>
5157 #: sources.list.5.xml:1
5158 msgid "The deb and deb-src types: General Format"
5161 #. type: Content of: <refentry><refsect1><para>
5162 #: sources.list.5.xml:1
5164 "The <literal>deb</literal> type references a typical two-level Debian "
5165 "archive, <filename>distribution/component</filename>. The "
5166 "<literal>distribution</literal> is generally a suite name like "
5167 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5168 "<literal>&stable-codename;</literal> or "
5169 "<literal>&testing-codename;</literal> while component is one of "
5170 "<literal>main</literal>, <literal>contrib</literal> or "
5171 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
5172 "a Debian distribution's source code in the same form as the "
5173 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5174 "to fetch source indexes."
5177 #. type: Content of: <refentry><refsect1><para>
5178 #: sources.list.5.xml:1
5180 "The format for two one line style entries using the <literal>deb</literal> "
5181 "and <literal>deb-src</literal> types is:"
5184 #. type: Content of: <refentry><refsect1><literallayout>
5185 #: sources.list.5.xml:1
5188 "deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] "
5190 "deb-src [ option1=value1 option2=value2 ] uri suite [component1] "
5191 "[component2] [...]"
5194 #. type: Content of: <refentry><refsect1><para><literallayout>
5195 #: sources.list.5.xml:1
5198 " Types: deb deb-src\n"
5201 " Components: [component1] [component2] [...]\n"
5202 " option1: value1\n"
5203 " option2: value2\n"
5207 #. type: Content of: <refentry><refsect1><para>
5208 #: sources.list.5.xml:1
5210 "Alternatively the equivalent entry in deb822 style looks like this: "
5211 "<placeholder type=\"literallayout\" id=\"0\"/>"
5214 #. type: Content of: <refentry><refsect1><para>
5215 #: sources.list.5.xml:1
5217 "The URI for the <literal>deb</literal> type must specify the base of the "
5218 "Debian distribution, from which APT will find the information it needs. "
5219 "<literal>suite</literal> can specify an exact path, in which case the "
5220 "components must be omitted and <literal>suite</literal> must end with a "
5221 "slash (<literal>/</literal>). This is useful for the case when only a "
5222 "particular sub-directory of the archive denoted by the URI is of interest. "
5223 "If <literal>suite</literal> does not specify an exact path, at least one "
5224 "<literal>component</literal> must be present."
5227 #. type: Content of: <refentry><refsect1><para>
5228 #: sources.list.5.xml:1
5230 "<literal>suite</literal> may also contain a variable, "
5231 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
5232 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
5233 "system. This permits architecture-independent "
5234 "<filename>sources.list</filename> files to be used. In general this is only "
5235 "of interest when specifying an exact path, <literal>APT</literal> will "
5236 "automatically generate a URI with the current architecture otherwise."
5239 #. type: Content of: <refentry><refsect1><para>
5240 #: sources.list.5.xml:1
5242 "Especially in the one line style format since only one distribution can be "
5243 "specified per line it may be necessary to have multiple lines for the same "
5244 "URI, if a subset of all available distributions or components at that "
5245 "location is desired. APT will sort the URI list after it has generated a "
5246 "complete set internally, and will collapse multiple references to the same "
5247 "Internet host, for instance, into a single connection, so that it does not "
5248 "inefficiently establish a connection, close it, do something else, and then "
5249 "re-establish a connection to that same host. APT also parallelizes "
5250 "connections to different hosts to more effectively deal with sites with low "
5254 #. type: Content of: <refentry><refsect1><para>
5255 #: sources.list.5.xml:1
5257 "It is important to list sources in order of preference, with the most "
5258 "preferred source listed first. Typically this will result in sorting by "
5259 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5260 "followed by distant Internet hosts, for example)."
5263 #. type: Content of: <refentry><refsect1><para><literallayout>
5264 #: sources.list.5.xml:1
5266 msgid "&sourceslist-list-format;"
5269 #. type: Content of: <refentry><refsect1><para><literallayout>
5270 #: sources.list.5.xml:1
5272 msgid "&sourceslist-sources-format;"
5275 #. type: Content of: <refentry><refsect1><para>
5276 #: sources.list.5.xml:1
5278 "As an example, the sources for your distribution could look like this in one "
5279 "line style format: <placeholder type=\"literallayout\" id=\"0\"/> or like "
5280 "this in deb822 style format: <placeholder type=\"literallayout\" id=\"1\"/>"
5283 #. type: Content of: <refentry><refsect1><title>
5284 #: sources.list.5.xml:1
5285 msgid "The deb and deb-src types: Options"
5288 #. type: Content of: <refentry><refsect1><para>
5289 #: sources.list.5.xml:1
5291 "Each source entry can have options specified modifying which and how the "
5292 "source is accessed and data acquired from it. Format, syntax and names of "
5293 "the options varies between the two formats one line and deb822 style as "
5294 "described, but they have both the same options available. For simplicity we "
5295 "list the deb822 fieldname and provide the one line name in brackets. "
5296 "Remember that beside setting multivalue options explicitly, there is also "
5297 "the option to modify them based on the default, but we aren't listing those "
5298 "names explicitly here. Unsupported options are silently ignored by all APT "
5302 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5303 #: sources.list.5.xml:1
5305 "<option>Architectures</option> (<option>arch</option>) is a multivalue "
5306 "option defining for which architectures information should be downloaded. If "
5307 "this option isn't set the default is all architectures as defined by the "
5308 "<option>APT::Architectures</option> config option."
5311 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5312 #: sources.list.5.xml:1
5314 "<option>Languages</option> (<option>lang</option>) is a multivalue option "
5315 "defining for which languages information like translated package "
5316 "descriptions should be downloaded. If this option isn't set the default is "
5317 "all languages as defined by the <option>Acquire::Languages</option> config "
5321 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5322 #: sources.list.5.xml:1
5324 "<option>Targets</option> (<option>target</option>) is a multivalue option "
5325 "defining which download targets apt will try to acquire from this source. If "
5326 "not specified, the default set is defined by the "
5327 "<option>Acquire::IndexTargets</option> configuration scope. Aditionally, "
5328 "specific targets can be enabled or disabled by using the identifier as field "
5329 "name instead of using this multivalue option."
5332 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5333 #: sources.list.5.xml:1
5335 "<option>PDiffs</option> (<option>pdiffs</option>) is a yes/no value which "
5336 "controls if APT should try to use PDiffs to update old indexes instead of "
5337 "downloading the new indexes entirely. The value of this option is ignored if "
5338 "the repository doesn't announce the availability of PDiffs. Defaults to the "
5339 "value of the option with the same name for a specific index file defined in "
5340 "the <option>Acquire::IndexTargets</option> scope, which itself default to "
5341 "the value of configuration option <option>Acquire::PDiffs</option> which "
5342 "defaults to <literal>yes</literal>."
5345 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5346 #: sources.list.5.xml:1
5348 "<option>By-Hash</option> (<option>by-hash</option>) can have the value "
5349 "\"yes\", \"no\" or \"force\" and controls if APT should try to acquire "
5350 "indexes via an URI constructed from a hashsum of the expected file instead "
5351 "of using the well-known stable filename of the index. Using this can avoid "
5352 "hashsum mismatches, but requires a supporting mirror. The value "
5353 "\"yes\"/\"no\" activates/disables the use of this feature if this source "
5354 "indicates support for it, while \"force\" will enable the feature regardless "
5355 "of what the source indicates. Defaults to the value of the option of the "
5356 "same name for a specific index file defined in the "
5357 "<option>Acquire::IndexTargets</option> scope, which itself defaults to the "
5358 "value of configuration option <option>Acquire::By-Hash</option> which "
5359 "defaults to <literal>yes</literal>."
5362 #. type: Content of: <refentry><refsect1><para>
5363 #: sources.list.5.xml:1
5365 "Further more, there are options which if set effect <emphasis>all</emphasis> "
5366 "sources with the same URI and Suite, so they have to be set on all such "
5367 "entries and can not be varied between different components. APT will try to "
5368 "detect and error out on such anomalies."
5371 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5372 #: sources.list.5.xml:1
5374 "<option>Signed-By</option> (<option>signed-by</option>) is either an "
5375 "absolute path to a keyring file (has to be accessible and readable for the "
5376 "<literal>_apt</literal> user, so ensure everyone has read-permissions on the "
5377 "file) or a fingerprint of a key in either the "
5378 "<filename>trusted.gpg</filename> keyring or in one of the keyrings in the "
5379 "<filename>trusted.gpg.d/</filename> directory (see <command>apt-key "
5380 "fingerprint</command>). If the option is set only the key(s) in this keyring "
5381 "or only the key with this fingerprint is used for the &apt-secure; "
5382 "verification of this repository. Otherwise all keys in the trusted keyrings "
5383 "are considered valid signers for this repository."
5386 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5387 #: sources.list.5.xml:1
5389 "<option>Check-Valid-Until</option> (<option>check-valid-until</option>) is "
5390 "a yes/no value which controls if APT should try to detect replay attacks. A "
5391 "repository creator can declare until then the data provided in the "
5392 "repository should be considered valid and if this time is reached, but no "
5393 "new data is provided the data is considered expired and an error is raised. "
5394 "Beside increasing security as a malicious attacker can't sent old data "
5395 "forever denying a user to be able to upgrade to a new version, this also "
5396 "helps users identify mirrors which are no longer updated. Some repositories "
5397 "like historic archives aren't updated anymore by design through, so this "
5398 "check can be disabled by setting this option to <literal>no</literal>. "
5399 "Defaults to the value of configuration option "
5400 "<option>Acquire::Check-Valid-Until</option> which itself defaults to "
5401 "<literal>yes</literal>."
5404 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5405 #: sources.list.5.xml:1
5407 "<option>Valid-Until-Min</option> (<option>valid-until-min</option>) and "
5408 "<option>Valid-Until-Max</option> (<option>valid-until-max</option>) can be "
5409 "used to raise or lower the time period in seconds in which the data from "
5410 "this repository is considered valid. -Max can be especially useful if the "
5411 "repository provides no Valid-Until field on its Release file to set your own "
5412 "value, while -Min can be used to increase the valid time on seldom updated "
5413 "(local) mirrors of a more frequently updated but less accessible archive "
5414 "(which is in the sources.list as well) instead of disabling the check "
5415 "entirely. Default to the value of the configuration options "
5416 "<option>Acquire::Min-ValidTime</option> and "
5417 "<option>Acquire::Max-ValidTime</option> which are both unset by default."
5420 #. type: Content of: <refentry><refsect1><title>
5421 #: sources.list.5.xml:1
5422 msgid "URI specification"
5425 #. type: Content of: <refentry><refsect1><para>
5426 #: sources.list.5.xml:1
5427 msgid "The currently recognized URI types are:"
5430 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5431 #: sources.list.5.xml:1
5433 "The file scheme allows an arbitrary directory in the file system to be "
5434 "considered an archive. This is useful for NFS mounts and local mirrors or "
5438 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5439 #: sources.list.5.xml:1
5441 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5442 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5446 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5447 #: sources.list.5.xml:1
5449 "The http scheme specifies an HTTP server for the archive. If an environment "
5450 "variable <envar>http_proxy</envar> is set with the format "
5451 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5452 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5453 "the format http://user:pass@server:port/. Note that this is an insecure "
5454 "method of authentication."
5457 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5458 #: sources.list.5.xml:1
5460 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5461 "is highly configurable; for more information see the &apt-conf; manual "
5462 "page. Please note that an FTP proxy can be specified by using the "
5463 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5464 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5465 "environment variable and <emphasis>only</emphasis> this environment "
5466 "variable. Proxies using HTTP specified in the configuration file will be "
5470 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5471 #: sources.list.5.xml:1
5473 "The copy scheme is identical to the file scheme except that packages are "
5474 "copied into the cache directory instead of used directly at their location. "
5475 "This is useful for people using removable media to copy files around with "
5479 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5480 #: sources.list.5.xml:1
5482 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5483 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5484 "recommended. The standard <command>find</command> and <command>dd</command> "
5485 "commands are used to perform the file transfers from the remote host."
5488 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5489 #: sources.list.5.xml:1
5490 msgid "adding more recognizable URI types"
5493 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5494 #: sources.list.5.xml:1
5496 "APT can be extended with more methods shipped in other optional packages, "
5497 "which should follow the naming scheme "
5498 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5499 "instance, the APT team also maintains the package "
5500 "<package>apt-transport-https</package>, which provides access methods for "
5501 "HTTPS URIs with features similar to the http method. Methods for using "
5502 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5505 #. type: Content of: <refentry><refsect1><para>
5506 #: sources.list.5.xml:1
5508 "Uses the archive stored locally (or NFS mounted) at /home/apt/debian for "
5509 "stable/main, stable/contrib, and stable/non-free."
5512 #. type: Content of: <refentry><refsect1><literallayout>
5513 #: sources.list.5.xml:1
5515 msgid "deb file:/home/apt/debian stable main contrib non-free"
5518 #. type: Content of: <refentry><refsect1><literallayout>
5519 #: sources.list.5.xml:1
5523 "URIs: file:/home/apt/debian\n"
5525 "Components: main contrib non-free"
5528 #. type: Content of: <refentry><refsect1><para>
5529 #: sources.list.5.xml:1
5530 msgid "As above, except this uses the unstable (development) distribution."
5533 #. type: Content of: <refentry><refsect1><literallayout>
5534 #: sources.list.5.xml:1
5536 msgid "deb file:/home/apt/debian unstable main contrib non-free"
5539 #. type: Content of: <refentry><refsect1><literallayout>
5540 #: sources.list.5.xml:1
5544 "URIs: file:/home/apt/debian\n"
5545 "Suites: unstable\n"
5546 "Components: main contrib non-free"
5549 #. type: Content of: <refentry><refsect1><para>
5550 #: sources.list.5.xml:1
5551 msgid "Source line for the above"
5554 #. type: Content of: <refentry><refsect1><literallayout>
5555 #: sources.list.5.xml:1
5557 msgid "deb-src file:/home/apt/debian unstable main contrib non-free"
5560 #. type: Content of: <refentry><refsect1><literallayout>
5561 #: sources.list.5.xml:1
5565 "URIs: file:/home/apt/debian\n"
5566 "Suites: unstable\n"
5567 "Components: main contrib non-free"
5570 #. type: Content of: <refentry><refsect1><para>
5571 #: sources.list.5.xml:1
5573 "The first line gets package information for the architectures in "
5574 "<literal>APT::Architectures</literal> while the second always retrieves "
5575 "<literal>amd64</literal> and <literal>armel</literal>."
5578 #. type: Content of: <refentry><refsect1><literallayout>
5579 #: sources.list.5.xml:1
5582 "deb http://httpredir.debian.org/debian &stable-codename; main\n"
5583 "deb [ arch=amd64,armel ] http://httpredir.debian.org/debian "
5584 "&stable-codename; main"
5587 #. type: Content of: <refentry><refsect1><literallayout>
5588 #: sources.list.5.xml:1
5592 "URIs: http://httpredir.debian.org/debian\n"
5593 "Suites: &stable-codename;\n"
5594 "Components: main\n"
5597 "URIs: http://httpredir.debian.org/debian\n"
5598 "Suites: &stable-codename;\n"
5599 "Components: main\n"
5600 "Architectures: amd64 armel\n"
5603 #. type: Content of: <refentry><refsect1><para>
5604 #: sources.list.5.xml:1
5606 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5610 #. type: Content of: <refentry><refsect1><literallayout>
5611 #: sources.list.5.xml:1
5613 msgid "deb http://archive.debian.org/debian-archive hamm main"
5616 #. type: Content of: <refentry><refsect1><literallayout>
5617 #: sources.list.5.xml:1
5621 "URIs: http://archive.debian.org/debian-archive\n"
5626 #. type: Content of: <refentry><refsect1><para>
5627 #: sources.list.5.xml:1
5629 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5630 "directory, and uses only the &stable-codename;/contrib area."
5633 #. type: Content of: <refentry><refsect1><literallayout>
5634 #: sources.list.5.xml:1
5636 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5639 #. type: Content of: <refentry><refsect1><literallayout>
5640 #: sources.list.5.xml:1
5644 "URIs: ftp://ftp.debian.org/debian\n"
5645 "Suites: &stable-codename;\n"
5646 "Components: contrib"
5649 #. type: Content of: <refentry><refsect1><para>
5650 #: sources.list.5.xml:1
5652 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5653 "directory, and uses only the unstable/contrib area. If this line appears as "
5654 "well as the one in the previous example in <filename>sources.list</filename> "
5655 "a single FTP session will be used for both resource lines."
5658 #. type: Content of: <refentry><refsect1><literallayout>
5659 #: sources.list.5.xml:1
5661 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5664 #. type: Content of: <refentry><refsect1><literallayout>
5665 #: sources.list.5.xml:1
5669 "URIs: ftp://ftp.debian.org/debian\n"
5670 "Suites: unstable\n"
5671 "Components: contrib"
5674 #. type: Content of: <refentry><refsect1><para><literallayout>
5675 #: sources.list.5.xml:1
5677 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5680 #. type: Content of: <refentry><refsect1><para><literallayout>
5681 #: sources.list.5.xml:1
5685 "URIs: http://ftp.tlh.debian.org/universe\n"
5686 "Suites: unstable/binary-$(ARCH)/"
5689 #. type: Content of: <refentry><refsect1><para>
5690 #: sources.list.5.xml:1
5692 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5693 "directory, and uses only files found under "
5694 "<filename>unstable/binary-i386</filename> on i386 machines, "
5695 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5696 "supported architectures. [Note this example only illustrates how to use the "
5697 "substitution variable; official debian archives are not structured like "
5698 "this] <placeholder type=\"literallayout\" id=\"0\"/> <placeholder "
5699 "type=\"literallayout\" id=\"1\"/>"
5702 #. type: Content of: <refentry><refsect1><para>
5703 #: sources.list.5.xml:1
5705 "Uses HTTP to get binary packages as well as sources from the stable, testing "
5706 "and unstable suites and the components main and contrib."
5709 #. type: Content of: <refentry><refsect1><literallayout>
5710 #: sources.list.5.xml:1
5713 "deb http://httpredir.debian.org/debian stable main contrib\n"
5714 "deb-src http://httpredir.debian.org/debian stable main contrib\n"
5715 "deb http://httpredir.debian.org/debian testing main contrib\n"
5716 "deb-src http://httpredir.debian.org/debian testing main contrib\n"
5717 "deb http://httpredir.debian.org/debian unstable main contrib\n"
5718 "deb-src http://httpredir.debian.org/debian unstable main contrib"
5721 #. type: Content of: <refentry><refsect1><literallayout>
5722 #: sources.list.5.xml:1
5725 "Types: deb deb-src\n"
5726 "URIs: http://httpredir.debian.org/debian\n"
5727 "Suites: stable testing unstable\n"
5728 "Components: main contrib\n"
5731 #. type: Content of: <refentry><refsect1><para>
5732 #: sources.list.5.xml:1
5733 msgid "&apt-get;, &apt-conf;"
5736 #. type: Content of: <refentry><refmeta><manvolnum>
5737 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
5741 #. type: Content of: <refentry><refnamediv><refpurpose>
5742 #: apt-extracttemplates.1.xml:1
5744 "Utility to extract <command>debconf</command> config and templates from "
5748 #. type: Content of: <refentry><refsect1><para>
5749 #: apt-extracttemplates.1.xml:1
5751 "<command>apt-extracttemplates</command> will take one or more Debian package "
5752 "files as input and write out (to a temporary directory) all associated "
5753 "config scripts and template files. For each passed in package that contains "
5754 "config scripts and templates, one line of output will be generated in the "
5758 #. type: Content of: <refentry><refsect1><para>
5759 #: apt-extracttemplates.1.xml:1
5760 msgid "package version template-file config-script"
5763 #. type: Content of: <refentry><refsect1><para>
5764 #: apt-extracttemplates.1.xml:1
5766 "template-file and config-script are written to the temporary directory "
5767 "specified by the <option>-t</option> or <option>--tempdir</option> "
5768 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5769 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5770 "<filename>package.config.XXXXXX</filename>"
5773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5774 #: apt-extracttemplates.1.xml:1
5776 "Temporary directory in which to write extracted <command>debconf</command> "
5777 "template files and config scripts. Configuration Item: "
5778 "<literal>APT::ExtractTemplates::TempDir</literal>"
5781 #. type: Content of: <refentry><refsect1><para>
5782 #: apt-extracttemplates.1.xml:1
5784 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5785 "decimal 100 on error."
5788 #. type: Content of: <refentry><refnamediv><refpurpose>
5789 #: apt-sortpkgs.1.xml:1
5790 msgid "Utility to sort package index files"
5793 #. type: Content of: <refentry><refsect1><para>
5794 #: apt-sortpkgs.1.xml:1
5796 "<command>apt-sortpkgs</command> will take an index file (source index or "
5797 "package index) and sort the records so that they are ordered by the package "
5798 "name. It will also sort the internal fields of each record according to the "
5799 "internal sorting rules."
5802 #. type: Content of: <refentry><refsect1><para>
5803 #: apt-sortpkgs.1.xml:1
5804 msgid "All output is sent to standard output; the input must be a seekable file."
5807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5808 #: apt-sortpkgs.1.xml:1
5810 "Use source index field ordering. Configuration Item: "
5811 "<literal>APT::SortPkgs::Source</literal>."
5814 #. type: Content of: <refentry><refsect1><para>
5815 #: apt-sortpkgs.1.xml:1
5817 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5821 #. type: Content of: <refentry><refnamediv><refpurpose>
5822 #: apt-ftparchive.1.xml:1
5823 msgid "Utility to generate index files"
5826 #. type: Content of: <refentry><refsect1><para>
5827 #: apt-ftparchive.1.xml:1
5829 "<command>apt-ftparchive</command> is the command line tool that generates "
5830 "the index files that APT uses to access a distribution source. The index "
5831 "files should be generated on the origin site based on the content of that "
5835 #. type: Content of: <refentry><refsect1><para>
5836 #: apt-ftparchive.1.xml:1
5838 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5839 "program, incorporating its entire functionality via the "
5840 "<literal>packages</literal> command. It also contains a contents file "
5841 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5842 "the generation process for a complete archive."
5845 #. type: Content of: <refentry><refsect1><para>
5846 #: apt-ftparchive.1.xml:1
5848 "Internally <command>apt-ftparchive</command> can make use of binary "
5849 "databases to cache the contents of a .deb file and it does not rely on any "
5850 "external programs aside from &gzip;. When doing a full generate it "
5851 "automatically performs file-change checks and builds the desired compressed "
5855 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5856 #: apt-ftparchive.1.xml:1
5858 "The packages command generates a package file from a directory tree. It "
5859 "takes the given directory and recursively searches it for .deb files, "
5860 "emitting a package record to stdout for each. This command is approximately "
5861 "equivalent to &dpkg-scanpackages;."
5864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5865 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
5866 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5870 #: apt-ftparchive.1.xml:1
5872 "The <literal>sources</literal> command generates a source index file from a "
5873 "directory tree. It takes the given directory and recursively searches it "
5874 "for .dsc files, emitting a source record to stdout for each. This command is "
5875 "approximately equivalent to &dpkg-scansources;."
5878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5879 #: apt-ftparchive.1.xml:1
5881 "If an override file is specified then a source override file will be looked "
5882 "for with an extension of .src. The --source-override option can be used to "
5883 "change the source override file that will be used."
5886 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5887 #: apt-ftparchive.1.xml:1
5889 "The <literal>contents</literal> command generates a contents file from a "
5890 "directory tree. It takes the given directory and recursively searches it for "
5891 ".deb files, and reads the file list from each file. It then sorts and writes "
5892 "to stdout the list of files matched to packages. Directories are not written "
5893 "to the output. If multiple packages own the same file then each package is "
5894 "separated by a comma in the output."
5897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5898 #: apt-ftparchive.1.xml:1
5900 "The <literal>release</literal> command generates a Release file from a "
5901 "directory tree. It recursively searches the given directory for uncompressed "
5902 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5903 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5904 "<command>lzma</command> as well as <filename>Release</filename> and "
5905 "<filename>md5sum.txt</filename> files by default "
5906 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5907 "filename patterns can be added by listing them in "
5908 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5909 "stdout a <filename>Release</filename> file containing (by default) an MD5, "
5910 "SHA1, SHA256 and SHA512 digest for each file."
5913 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5914 #: apt-ftparchive.1.xml:1
5916 "Values for the additional metadata fields in the Release file are taken from "
5917 "the corresponding variables under "
5918 "<literal>APT::FTPArchive::Release</literal>, "
5919 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5920 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5921 "<literal>Suite</literal>, <literal>Version</literal>, "
5922 "<literal>Codename</literal>, <literal>Date</literal>, "
5923 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5924 "<literal>Components</literal>, <literal>Description</literal>."
5927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5928 #: apt-ftparchive.1.xml:1
5930 "The <literal>generate</literal> command is designed to be runnable from a "
5931 "cron script and builds indexes according to the given config file. The "
5932 "config language provides a flexible means of specifying which index files "
5933 "are built from which directories, as well as providing a simple means of "
5934 "maintaining the required settings."
5937 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5938 #: apt-ftparchive.1.xml:1
5940 "The <literal>clean</literal> command tidies the databases used by the given "
5941 "configuration file by removing any records that are no longer necessary."
5944 #. type: Content of: <refentry><refsect1><title>
5945 #: apt-ftparchive.1.xml:1
5946 msgid "The Generate Configuration"
5949 #. type: Content of: <refentry><refsect1><para>
5950 #: apt-ftparchive.1.xml:1
5952 "The <literal>generate</literal> command uses a configuration file to "
5953 "describe the archives that are going to be generated. It follows the typical "
5954 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5955 "&apt-conf; contains a description of the syntax. Note that the generate "
5956 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5957 "tree manner. This only effects how the scope tag is handled."
5960 #. type: Content of: <refentry><refsect1><para>
5961 #: apt-ftparchive.1.xml:1
5962 msgid "The generate configuration has four separate sections, each described below."
5965 #. type: Content of: <refentry><refsect1><refsect2><title>
5966 #: apt-ftparchive.1.xml:1
5967 msgid "<literal>Dir</literal> Section"
5970 #. type: Content of: <refentry><refsect1><refsect2><para>
5971 #: apt-ftparchive.1.xml:1
5973 "The <literal>Dir</literal> section defines the standard directories needed "
5974 "to locate the files required during the generation process. These "
5975 "directories are prepended certain relative paths defined in later sections "
5976 "to produce a complete an absolute path."
5979 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5980 #: apt-ftparchive.1.xml:1
5982 "Specifies the root of the FTP archive, in a standard Debian configuration "
5983 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5987 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5988 #: apt-ftparchive.1.xml:1
5989 msgid "Specifies the location of the override files."
5992 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5993 #: apt-ftparchive.1.xml:1
5994 msgid "Specifies the location of the cache files."
5997 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5998 #: apt-ftparchive.1.xml:1
6000 "Specifies the location of the file list files, if the "
6001 "<literal>FileList</literal> setting is used below."
6004 #. type: Content of: <refentry><refsect1><refsect2><title>
6005 #: apt-ftparchive.1.xml:1
6006 msgid "<literal>Default</literal> Section"
6009 #. type: Content of: <refentry><refsect1><refsect2><para>
6010 #: apt-ftparchive.1.xml:1
6012 "The <literal>Default</literal> section specifies default values, and "
6013 "settings that control the operation of the generator. Other sections may "
6014 "override these defaults with a per-section setting."
6017 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6018 #: apt-ftparchive.1.xml:1
6020 "Sets the default compression schemes to use for the package index files. It "
6021 "is a string that contains a space separated list of at least one of: '.' (no "
6022 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
6026 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6027 #: apt-ftparchive.1.xml:1
6029 "Sets the default list of file extensions that are package files. This "
6030 "defaults to '.deb'."
6033 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6034 #: apt-ftparchive.1.xml:1
6036 "This is similar to <literal>Packages::Compress</literal> except that it "
6037 "controls the compression for the Sources files."
6040 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6041 #: apt-ftparchive.1.xml:1
6043 "Sets the default list of file extensions that are source files. This "
6044 "defaults to '.dsc'."
6047 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6048 #: apt-ftparchive.1.xml:1
6050 "This is similar to <literal>Packages::Compress</literal> except that it "
6051 "controls the compression for the Contents files."
6054 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6055 #: apt-ftparchive.1.xml:1
6057 "This is similar to <literal>Packages::Compress</literal> except that it "
6058 "controls the compression for the Translation-en master file."
6061 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6062 #: apt-ftparchive.1.xml:1
6064 "Specifies the number of kilobytes to delink (and replace with hard links) "
6065 "per run. This is used in conjunction with the per-section "
6066 "<literal>External-Links</literal> setting."
6069 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6070 #: apt-ftparchive.1.xml:1
6072 "Specifies the mode of all created index files. It defaults to 0644. All "
6073 "index files are set to this mode with no regard to the umask."
6076 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6077 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6079 "Specifies whether long descriptions should be included in the "
6080 "<filename>Packages</filename> file or split out into a master "
6081 "<filename>Translation-en</filename> file."
6084 #. type: Content of: <refentry><refsect1><refsect2><title>
6085 #: apt-ftparchive.1.xml:1
6086 msgid "<literal>TreeDefault</literal> Section"
6089 #. type: Content of: <refentry><refsect1><refsect2><para>
6090 #: apt-ftparchive.1.xml:1
6092 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
6093 "variables are substitution variables and have the strings $(DIST), "
6094 "$(SECTION) and $(ARCH) replaced with their respective values."
6097 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6098 #: apt-ftparchive.1.xml:1
6100 "Sets the number of kilobytes of contents files that are generated each "
6101 "day. The contents files are round-robined so that over several days they "
6102 "will all be rebuilt."
6105 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6106 #: apt-ftparchive.1.xml:1
6108 "Controls the number of days a contents file is allowed to be checked without "
6109 "changing. If this limit is passed the mtime of the contents file is "
6110 "updated. This case can occur if the package file is changed in such a way "
6111 "that does not result in a new contents file [override edit for instance]. A "
6112 "hold off is allowed in hopes that new .debs will be installed, requiring a "
6113 "new file anyhow. The default is 10, the units are in days."
6116 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6117 #: apt-ftparchive.1.xml:1
6119 "Sets the top of the .deb directory tree. Defaults to "
6120 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
6123 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6124 #: apt-ftparchive.1.xml:1
6126 "Sets the top of the source package directory tree. Defaults to "
6127 "<filename>$(DIST)/$(SECTION)/source/</filename>"
6130 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6131 #: apt-ftparchive.1.xml:1
6133 "Sets the output Packages file. Defaults to "
6134 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
6137 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6138 #: apt-ftparchive.1.xml:1
6140 "Sets the output Sources file. Defaults to "
6141 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
6144 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6145 #: apt-ftparchive.1.xml:1
6147 "Sets the output Translation-en master file with the long descriptions if "
6148 "they should be not included in the Packages file. Defaults to "
6149 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
6152 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6153 #: apt-ftparchive.1.xml:1
6155 "Sets the path prefix that causes a symlink to be considered an internal link "
6156 "instead of an external link. Defaults to "
6157 "<filename>$(DIST)/$(SECTION)/</filename>"
6160 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6161 #: apt-ftparchive.1.xml:1
6163 "Sets the output Contents file. Defaults to "
6164 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
6165 "causes multiple Packages files to map onto a single Contents file (as is the "
6166 "default) then <command>apt-ftparchive</command> will integrate those "
6167 "package files together automatically."
6170 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6171 #: apt-ftparchive.1.xml:1
6172 msgid "Sets header file to prepend to the contents output."
6175 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6176 #: apt-ftparchive.1.xml:1
6178 "Sets the binary cache database to use for this section. Multiple sections "
6179 "can share the same database."
6182 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6183 #: apt-ftparchive.1.xml:1
6185 "Specifies that instead of walking the directory tree, "
6186 "<command>apt-ftparchive</command> should read the list of files from the "
6187 "given file. Relative files names are prefixed with the archive directory."
6190 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6191 #: apt-ftparchive.1.xml:1
6193 "Specifies that instead of walking the directory tree, "
6194 "<command>apt-ftparchive</command> should read the list of files from the "
6195 "given file. Relative files names are prefixed with the archive directory. "
6196 "This is used when processing source indexes."
6199 #. type: Content of: <refentry><refsect1><refsect2><title>
6200 #: apt-ftparchive.1.xml:1
6201 msgid "<literal>Tree</literal> Section"
6204 #. type: Content of: <refentry><refsect1><refsect2><para>
6205 #: apt-ftparchive.1.xml:1
6207 "The <literal>Tree</literal> section defines a standard Debian file tree "
6208 "which consists of a base directory, then multiple sections in that base "
6209 "directory and finally multiple Architectures in each section. The exact "
6210 "pathing used is defined by the <literal>Directory</literal> substitution "
6214 #. type: Content of: <refentry><refsect1><refsect2><para>
6215 #: apt-ftparchive.1.xml:1
6217 "The <literal>Tree</literal> section takes a scope tag which sets the "
6218 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
6219 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
6220 "setting such as <filename>dists/&stable-codename;</filename>."
6223 #. type: Content of: <refentry><refsect1><refsect2><para>
6224 #: apt-ftparchive.1.xml:1
6226 "All of the settings defined in the <literal>TreeDefault</literal> section "
6227 "can be used in a <literal>Tree</literal> section as well as three new "
6231 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6232 #: apt-ftparchive.1.xml:1
6235 "for i in Sections do \n"
6236 " for j in Architectures do\n"
6237 " Generate for DIST=scope SECTION=i ARCH=j\n"
6241 #. type: Content of: <refentry><refsect1><refsect2><para>
6242 #: apt-ftparchive.1.xml:1
6244 "When processing a <literal>Tree</literal> section "
6245 "<command>apt-ftparchive</command> performs an operation similar to: "
6246 "<placeholder type=\"programlisting\" id=\"0\"/>"
6249 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6250 #: apt-ftparchive.1.xml:1
6252 "This is a space separated list of sections which appear under the "
6253 "distribution; typically this is something like <literal>main contrib "
6254 "non-free</literal>"
6257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6258 #: apt-ftparchive.1.xml:1
6260 "This is a space separated list of all the architectures that appear under "
6261 "search section. The special architecture 'source' is used to indicate that "
6262 "this tree has a source archive."
6265 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6266 #: apt-ftparchive.1.xml:1
6268 "Sets the binary override file. The override file contains section, priority "
6269 "and maintainer address information."
6272 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6273 #: apt-ftparchive.1.xml:1
6275 "Sets the source override file. The override file contains section "
6279 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6280 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6281 msgid "Sets the binary extra override file."
6284 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6285 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6286 msgid "Sets the source extra override file."
6289 #. type: Content of: <refentry><refsect1><refsect2><title>
6290 #: apt-ftparchive.1.xml:1
6291 msgid "<literal>BinDirectory</literal> Section"
6294 #. type: Content of: <refentry><refsect1><refsect2><para>
6295 #: apt-ftparchive.1.xml:1
6297 "The <literal>bindirectory</literal> section defines a binary directory tree "
6298 "with no special structure. The scope tag specifies the location of the "
6299 "binary directory and the settings are similar to the <literal>Tree</literal> "
6300 "section with no substitution variables or "
6301 "<literal>Section</literal><literal>Architecture</literal> settings."
6304 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6305 #: apt-ftparchive.1.xml:1
6306 msgid "Sets the Packages file output."
6309 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6310 #: apt-ftparchive.1.xml:1
6312 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
6313 "<literal>Sources</literal> is required."
6316 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6317 #: apt-ftparchive.1.xml:1
6318 msgid "Sets the Contents file output (optional)."
6321 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6322 #: apt-ftparchive.1.xml:1
6323 msgid "Sets the binary override file."
6326 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6327 #: apt-ftparchive.1.xml:1
6328 msgid "Sets the source override file."
6331 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6332 #: apt-ftparchive.1.xml:1
6333 msgid "Sets the cache DB."
6336 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6337 #: apt-ftparchive.1.xml:1
6338 msgid "Appends a path to all the output paths."
6341 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6342 #: apt-ftparchive.1.xml:1
6343 msgid "Specifies the file list file."
6346 #. type: Content of: <refentry><refsect1><title>
6347 #: apt-ftparchive.1.xml:1
6348 msgid "The Binary Override File"
6351 #. type: Content of: <refentry><refsect1><para>
6352 #: apt-ftparchive.1.xml:1
6354 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
6355 "contains four fields separated by spaces. The first field is the package "
6356 "name, the second is the priority to force that package to, the third is the "
6357 "section to force that package to and the final field is the maintainer "
6358 "permutation field."
6361 #. type: Content of: <refentry><refsect1><para><literallayout>
6362 #: apt-ftparchive.1.xml:1
6364 msgid "old [// oldn]* => new"
6367 #. type: Content of: <refentry><refsect1><para><literallayout>
6368 #: apt-ftparchive.1.xml:1
6373 #. type: Content of: <refentry><refsect1><para>
6374 #: apt-ftparchive.1.xml:1
6376 "The general form of the maintainer field is: <placeholder "
6377 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
6378 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
6379 "separated list of old email addresses to be specified. If any of those are "
6380 "found then new is substituted for the maintainer field. The second form "
6381 "unconditionally substitutes the maintainer field."
6384 #. type: Content of: <refentry><refsect1><title>
6385 #: apt-ftparchive.1.xml:1
6386 msgid "The Source Override File"
6389 #. type: Content of: <refentry><refsect1><para>
6390 #: apt-ftparchive.1.xml:1
6392 "The source override file is fully compatible with &dpkg-scansources;. It "
6393 "contains two fields separated by spaces. The first field is the source "
6394 "package name, the second is the section to assign it."
6397 #. type: Content of: <refentry><refsect1><title>
6398 #: apt-ftparchive.1.xml:1
6399 msgid "The Extra Override File"
6402 #. type: Content of: <refentry><refsect1><para>
6403 #: apt-ftparchive.1.xml:1
6405 "The extra override file allows any arbitrary tag to be added or replaced in "
6406 "the output. It has three columns, the first is the package, the second is "
6407 "the tag and the remainder of the line is the new value."
6410 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6411 #: apt-ftparchive.1.xml:1
6413 "Generate the given checksum. These options default to on, when turned off "
6414 "the generated index files will not have the checksum fields where possible. "
6415 "Configuration Items: "
6416 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
6417 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
6418 "where <literal><replaceable>Index</replaceable></literal> can be "
6419 "<literal>Packages</literal>, <literal>Sources</literal> or "
6420 "<literal>Release</literal> and "
6421 "<literal><replaceable>Checksum</replaceable></literal> can be "
6422 "<literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA256</literal> "
6423 "or <literal>SHA512</literal>."
6426 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6427 #: apt-ftparchive.1.xml:1
6429 "Use a binary caching DB. This has no effect on the generate command. "
6430 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
6433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6434 #: apt-ftparchive.1.xml:1
6436 "Quiet; produces output suitable for logging, omitting progress indicators. "
6437 "More q's will produce more quiet up to a maximum of 2. You can also use "
6438 "<option>-q=#</option> to set the quiet level, overriding the configuration "
6439 "file. Configuration Item: <literal>quiet</literal>."
6442 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6443 #: apt-ftparchive.1.xml:1
6445 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
6446 "then this option actually enables delinking of the files. It defaults to on "
6447 "and can be turned off with <option>--no-delink</option>. Configuration "
6448 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
6451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6452 #: apt-ftparchive.1.xml:1
6454 "Perform contents generation. When this option is set and package indexes are "
6455 "being generated with a cache DB then the file listing will also be extracted "
6456 "and stored in the DB for later use. When using the generate command this "
6457 "option also allows the creation of any Contents files. The default is on. "
6458 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
6461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6462 #: apt-ftparchive.1.xml:1
6464 "Select the source override file to use with the <literal>sources</literal> "
6465 "command. Configuration Item: "
6466 "<literal>APT::FTPArchive::SourceOverride</literal>."
6469 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6470 #: apt-ftparchive.1.xml:1
6472 "Make the caching databases read only. Configuration Item: "
6473 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
6476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6477 #: apt-ftparchive.1.xml:1
6479 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
6480 "commands only package files matching <literal>*_arch.deb</literal> or "
6481 "<literal>*_all.deb</literal> instead of all package files in the given "
6482 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
6485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6486 #: apt-ftparchive.1.xml:1
6488 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
6489 "packages are recompiled and/or republished with the same version again, this "
6490 "will lead to problems as the now outdated cached metadata like size and "
6491 "checksums will be used. With this option enabled this will no longer happen "
6492 "as it will be checked if the file was changed. Note that this option is set "
6493 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
6494 "multiply versions/builds of a package with the same versionnumber, so in "
6495 "theory nobody will have these problems and therefore all these extra checks "
6499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6500 #: apt-ftparchive.1.xml:1
6502 "This configuration option defaults to \"<literal>true</literal>\" and should "
6503 "only be set to <literal>\"false\"</literal> if the Archive generated with "
6504 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
6505 "that the <filename>Translation-en</filename> master file can only be created "
6506 "in the generate command."
6509 #. type: Content of: <refentry><refsect1><para><programlisting>
6510 #: apt-ftparchive.1.xml:1
6513 "<command>apt-ftparchive</command> packages "
6514 "<replaceable>directory</replaceable> | <command>gzip</command> > "
6515 "<filename>Packages.gz</filename>\n"
6518 #. type: Content of: <refentry><refsect1><para>
6519 #: apt-ftparchive.1.xml:1
6521 "To create a compressed Packages file for a directory containing binary "
6522 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6525 #. type: Content of: <refentry><refsect1><para>
6526 #: apt-ftparchive.1.xml:1
6528 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6532 #. type: Attribute 'lang' of: <book>
6533 #: guide.dbk:1 offline.dbk:1
6537 #. type: Content of: <book><title>
6539 msgid "APT User's Guide"
6542 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6543 #: guide.dbk:1 offline.dbk:1
6544 msgid "Jason Gunthorpe"
6547 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6548 #: guide.dbk:1 offline.dbk:1
6549 msgid "jgg@debian.org"
6552 #. type: Content of: <book><bookinfo><releaseinfo>
6553 #: guide.dbk:1 offline.dbk:1
6554 msgid "Version &apt-product-version;"
6557 #. type: Content of: <book><bookinfo><abstract><para>
6560 "This document provides an overview of how to use the the APT package "
6564 #. type: Content of: <book><bookinfo>
6566 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6569 #. type: Content of: <book><bookinfo><legalnotice><title>
6570 #: guide.dbk:1 offline.dbk:1
6571 msgid "License Notice"
6574 #. type: Content of: <book><bookinfo><legalnotice><para>
6575 #: guide.dbk:1 offline.dbk:1
6577 "\"APT\" and this document are free software; you can redistribute them "
6578 "and/or modify them under the terms of the GNU General Public License as "
6579 "published by the Free Software Foundation; either version 2 of the License, "
6580 "or (at your option) any later version."
6583 #. type: Content of: <book><bookinfo><legalnotice><para>
6584 #: guide.dbk:1 offline.dbk:1
6586 "For more details, on Debian systems, see the file "
6587 "/usr/share/common-licenses/GPL for the full license."
6590 #. type: Content of: <book><chapter><title>
6595 #. type: Content of: <book><chapter><para>
6598 "The APT package currently contains two sections, the APT "
6599 "<command>dselect</command> method and the <command>apt-get</command> command "
6600 "line user interface. Both provide a way to install and remove packages as "
6601 "well as download new packages from the Internet."
6604 #. type: Content of: <book><chapter><section><title>
6606 msgid "Anatomy of the Package System"
6609 #. type: Content of: <book><chapter><section><para>
6612 "The Debian packaging system has a large amount of information associated "
6613 "with each package to help assure that it integrates cleanly and easily into "
6614 "the system. The most prominent of its features is the dependency system."
6617 #. type: Content of: <book><chapter><section><para>
6620 "The dependency system allows individual programs to make use of shared "
6621 "elements in the system such as libraries. It simplifies placing infrequently "
6622 "used portions of a program in separate packages to reduce the number of "
6623 "things the average user is required to install. Also, it allows for choices "
6624 "in mail transport agents, X servers and so on."
6627 #. type: Content of: <book><chapter><section><para>
6630 "The first step to understanding the dependency system is to grasp the "
6631 "concept of a simple dependency. The meaning of a simple dependency is that a "
6632 "package requires another package to be installed at the same time to work "
6636 #. type: Content of: <book><chapter><section><para>
6639 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6640 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6641 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6642 "simple dependency on emacs, without emacs it is completely useless."
6645 #. type: Content of: <book><chapter><section><para>
6648 "The other important dependency to understand is a conflicting dependency. It "
6649 "means that a package, when installed with another package, will not work and "
6650 "may possibly be extremely harmful to the system. As an example consider a "
6651 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6652 "have two mail transport agents installed because both need to listen to the "
6653 "network to receive mail. Attempting to install two will seriously damage the "
6654 "system so all mail transport agents have a conflicting dependency with all "
6655 "other mail transport agents."
6658 #. type: Content of: <book><chapter><section><para>
6661 "As an added complication there is the possibility for a package to pretend "
6662 "to be another package. Consider that exim and sendmail for many intents are "
6663 "identical, they both deliver mail and understand a common interface. Hence, "
6664 "the package system has a way for them to declare that they are both "
6665 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6666 "a mail-transport-agent and other packages that need a mail transport agent "
6667 "depend on mail-transport-agent. This can add a great deal of confusion when "
6668 "trying to manually fix packages."
6671 #. type: Content of: <book><chapter><section><para>
6674 "At any given time a single dependency may be met by packages that are "
6675 "already installed or it may not be. APT attempts to help resolve dependency "
6676 "issues by providing a number of automatic algorithms that help in selecting "
6677 "packages for installation."
6680 #. type: Content of: <book><chapter><title>
6685 #. type: Content of: <book><chapter><para>
6688 "<command>apt-get</command> provides a simple way to install packages from "
6689 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6690 "does not understand .deb files, it works with the package's proper name and "
6691 "can only install .deb archives from a <emphasis>Source</emphasis>."
6694 #. type: Content of: <book><chapter><para><footnote><para>
6697 "If you are using an http proxy server you must set the http_proxy "
6698 "environment variable first, see sources.list(5)"
6701 #. type: Content of: <book><chapter><para>
6704 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6705 "done before using <command>apt-get</command> is to fetch the package lists "
6706 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6707 "available. This is done with <literal>apt-get update</literal>. For "
6711 #. type: Content of: <book><chapter><screen>
6715 "# apt-get update\n"
6716 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6717 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6718 "Reading Package Lists... Done\n"
6719 "Building Dependency Tree... Done\n"
6722 #. type: Content of: <book><chapter><para>
6724 msgid "Once updated there are several commands that can be used:"
6727 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6732 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6735 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6736 "install a new package or remove an existing package, nor will it ever "
6737 "upgrade a package that might cause some other package to break. This can be "
6738 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6739 "the packages that it could not upgrade, this usually means that they depend "
6740 "on new packages or conflict with some other "
6741 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6742 "can be used to force these packages to install."
6745 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6750 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6753 "Install is used to install packages by name. The package is automatically "
6754 "fetched and installed. This can be useful if you already know the name of "
6755 "the package to install and do not want to go into a GUI to select it. Any "
6756 "number of packages may be passed to install, they will all be "
6757 "fetched. Install automatically attempts to resolve dependency problems with "
6758 "the listed packages and will print a summary and ask for confirmation if "
6759 "anything other than its arguments are changed."
6762 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6764 msgid "dist-upgrade"
6767 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6770 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6771 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6772 "set of packages to install, upgrade and remove to get as much of the system "
6773 "to the newest release. In some situations it may be desired to use "
6774 "dist-upgrade rather than spend the time manually resolving dependencies in "
6775 "<command>dselect</command>. Once dist-upgrade has completed then "
6776 "<command>dselect</command> can be used to install any packages that may have "
6780 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6783 "It is important to closely look at what dist-upgrade is going to do, its "
6784 "decisions may sometimes be quite surprising."
6787 #. type: Content of: <book><chapter><para>
6790 "<command>apt-get</command> has several command line options that are "
6791 "detailed in its man page, "
6792 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
6793 "The most useful option is <literal>-d</literal> which does not install the "
6794 "fetched files. If the system has to download a large number of package it "
6795 "would be undesired to start installing them in case something goes "
6796 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
6797 "installed by simply running the command that caused them to be downloaded "
6798 "again without <literal>-d</literal>."
6801 #. type: Content of: <book><chapter><title>
6806 #. type: Content of: <book><chapter><para>
6809 "The APT <command>dselect</command> method provides the complete APT system "
6810 "with the <command>dselect</command> package selection "
6811 "GUI. <command>dselect</command> is used to select the packages to be "
6812 "installed or removed and APT actually installs them."
6815 #. type: Content of: <book><chapter><para>
6818 "To enable the APT method you need to select [A]ccess in "
6819 "<command>dselect</command> and then choose the APT method. You will be "
6820 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
6821 "archives from. These can be remote Internet sites, local Debian mirrors or "
6822 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
6823 "will automatically combine them to form a complete set of packages. If you "
6824 "have a CD-ROM then it is a good idea to specify it first and then specify a "
6825 "mirror so that you have access to the latest bug fixes. APT will "
6826 "automatically use packages on your CD-ROM before downloading from the "
6830 #. type: Content of: <book><chapter><screen>
6834 " Set up a list of distribution source locations\n"
6836 " Please give the base URL of the debian distribution.\n"
6837 " The access schemes I know about are: http file\n"
6840 " file:/mnt/debian,\n"
6841 " ftp://ftp.debian.org/debian,\n"
6842 " http://ftp.de.debian.org/debian,\n"
6845 " URL [http://llug.sep.bnl.gov/debian]:\n"
6848 #. type: Content of: <book><chapter><para>
6851 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
6852 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
6853 "distribution to get."
6856 #. type: Content of: <book><chapter><screen>
6860 " Please give the distribution tag to get or a path to the\n"
6861 " package file ending in a /. The distribution\n"
6862 " tags are typically something like: stable unstable testing non-US\n"
6864 " Distribution [stable]:\n"
6867 #. type: Content of: <book><chapter><para>
6870 "The distribution refers to the Debian version in the archive, "
6871 "<emphasis>stable</emphasis> refers to the latest released version and "
6872 "<emphasis>unstable</emphasis> refers to the developmental "
6873 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
6874 "refers to packages that contain encryption technology or other things that "
6875 "cannot be exported from the United States. Importing these packages into the "
6876 "US is legal however."
6879 #. type: Content of: <book><chapter><screen>
6883 " Please give the components to get\n"
6884 " The components are typically something like: main contrib non-free\n"
6886 " Components [main contrib non-free]:\n"
6889 #. type: Content of: <book><chapter><para>
6892 "The components list refers to the list of sub distributions to fetch. The "
6893 "distribution is split up based on software licenses, main being DFSG free "
6894 "packages while contrib and non-free contain things that have various "
6895 "restrictions placed on their use and distribution."
6898 #. type: Content of: <book><chapter><para>
6901 "Any number of sources can be added, the setup script will continue to prompt "
6902 "until you have specified all that you want."
6905 #. type: Content of: <book><chapter><para>
6908 "Before starting to use <command>dselect</command> it is necessary to update "
6909 "the available list by selecting [U]pdate from the menu. This is a superset "
6910 "of <literal>apt-get update</literal> that makes the fetched information "
6911 "available to <command>dselect</command>. [U]pdate must be performed even if "
6912 "<literal>apt-get update</literal> has been run before."
6915 #. type: Content of: <book><chapter><para>
6918 "You can then go on and make your selections using [S]elect and then perform "
6919 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6920 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6924 #. type: Content of: <book><chapter><para>
6927 "By default APT will automatically remove the package (.deb) files once they "
6928 "have been successfully installed. To change this behavior place "
6929 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
6932 #. type: Content of: <book><chapter><title>
6934 msgid "The Interface"
6937 #. type: Content of: <book><chapter><para><footnote><para>
6940 "The <command>dselect</command> method actually is a set of wrapper scripts "
6941 "to <command>apt-get</command>. The method actually provides more "
6942 "functionality than is present in <command>apt-get</command> alone."
6945 #. type: Content of: <book><chapter><para>
6948 "Both that APT <command>dselect</command> method and "
6949 "<command>apt-get</command> share the same interface. It is a simple system "
6950 "that generally tells you what it will do and then goes and does "
6951 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
6952 "of what will happen APT then will print out some informative status messages "
6953 "so that you can estimate how far along it is and how much is left to do."
6956 #. type: Content of: <book><chapter><section><title>
6961 #. type: Content of: <book><chapter><section><para>
6964 "Before all operations except update, APT performs a number of actions to "
6965 "prepare its internal state. It also does some checks of the system's "
6966 "state. At any time these operations can be performed by running "
6967 "<literal>apt-get check</literal>."
6970 #. type: Content of: <book><chapter><section><screen>
6975 "Reading Package Lists... Done\n"
6976 "Building Dependency Tree... Done\n"
6979 #. type: Content of: <book><chapter><section><para>
6982 "The first thing it does is read all the package files into memory. APT uses "
6983 "a caching scheme so this operation will be faster the second time it is "
6984 "run. If some of the package files are not found then they will be ignored "
6985 "and a warning will be printed when apt-get exits."
6988 #. type: Content of: <book><chapter><section><para>
6991 "The final operation performs a detailed analysis of the system's "
6992 "dependencies. It checks every dependency of every installed or unpacked "
6993 "package and considers if it is OK. Should this find a problem then a report "
6994 "will be printed out and <command>apt-get</command> will refuse to run."
6997 #. type: Content of: <book><chapter><section><screen>
7002 "Reading Package Lists... Done\n"
7003 "Building Dependency Tree... Done\n"
7004 "You might want to run apt-get -f install' to correct these.\n"
7005 "Sorry, but the following packages have unmet dependencies:\n"
7006 " 9fonts: Depends: xlib6g but it is not installed\n"
7007 " uucp: Depends: mailx but it is not installed\n"
7008 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7009 " adduser: Depends: perl-base but it is not installed\n"
7010 " aumix: Depends: libgpmg1 but it is not installed\n"
7011 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7012 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7013 " cthugha: Depends: svgalibg1 but it is not installed\n"
7014 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7015 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
7018 #. type: Content of: <book><chapter><section><para>
7021 "In this example the system has many problems, including a serious problem "
7022 "with libreadlineg2. For each package that has unmet dependencies a line is "
7023 "printed out indicating the package with the problem and the dependencies "
7024 "that are unmet. A short explanation of why the package has a dependency "
7025 "problem is also included."
7028 #. type: Content of: <book><chapter><section><para><footnote><para>
7031 "APT however considers all known dependencies and attempts to prevent broken "
7035 #. type: Content of: <book><chapter><section><para>
7038 "There are two ways a system can get into a broken state like this. The first "
7039 "is caused by <command>dpkg</command> missing some subtle relationships "
7040 "between packages when performing upgrades. <placeholder type=\"footnote\" "
7041 "id=\"0\"/>. The second is if a package installation fails during an "
7042 "operation. In this situation a package may have been unpacked without its "
7043 "dependents being installed."
7046 #. type: Content of: <book><chapter><section><para>
7049 "The second situation is much less serious than the first because APT places "
7050 "certain constraints on the order that packages are installed. In both cases "
7051 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
7052 "will cause APT to deduce a possible solution to the problem and then "
7053 "continue on. The APT <command>dselect</command> method always supplies the "
7054 "<literal>-f</literal> option to allow for easy continuation of failed "
7055 "maintainer scripts."
7058 #. type: Content of: <book><chapter><section><para>
7061 "However, if the <literal>-f</literal> option is used to correct a seriously "
7062 "broken system caused by the first case then it is possible that it will "
7063 "either fail immediately or the installation sequence will fail. In either "
7064 "case it is necessary to manually use dpkg (possibly with forcing options) to "
7065 "correct the situation enough to allow APT to proceed."
7068 #. type: Content of: <book><chapter><section><title>
7070 msgid "The Status Report"
7073 #. type: Content of: <book><chapter><section><para>
7076 "Before proceeding <command>apt-get</command> will present a report on what "
7077 "will happen. Generally the report reflects the type of operation being "
7078 "performed but there are several common elements. In all cases the lists "
7079 "reflect the final state of things, taking into account the "
7080 "<literal>-f</literal> option and any other relevant activities to the "
7081 "command being executed."
7084 #. type: Content of: <book><chapter><section><section><title>
7086 msgid "The Extra Package list"
7089 #. type: Content of: <book><chapter><section><section><screen>
7093 "The following extra packages will be installed:\n"
7094 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7095 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7096 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7097 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7101 #. type: Content of: <book><chapter><section><section><para>
7104 "The Extra Package list shows all of the packages that will be installed or "
7105 "upgraded in excess of the ones mentioned on the command line. It is only "
7106 "generated for an <literal>install</literal> command. The listed packages are "
7107 "often the result of an Auto Install."
7110 #. type: Content of: <book><chapter><section><section><title>
7112 msgid "The Packages to Remove"
7115 #. type: Content of: <book><chapter><section><section><screen>
7119 "The following packages will be REMOVED:\n"
7120 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7121 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7122 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7123 " nas xpilot xfig\n"
7126 #. type: Content of: <book><chapter><section><section><para>
7129 "The Packages to Remove list shows all of the packages that will be removed "
7130 "from the system. It can be shown for any of the operations and should be "
7131 "given a careful inspection to ensure nothing important is to be taken "
7132 "off. The <literal>-f</literal> option is especially good at generating "
7133 "packages to remove so extreme care should be used in that case. The list may "
7134 "contain packages that are going to be removed because they are only "
7135 "partially installed, possibly due to an aborted installation."
7138 #. type: Content of: <book><chapter><section><section><title>
7140 msgid "The New Packages list"
7143 #. type: Content of: <book><chapter><section><section><screen>
7147 "The following NEW packages will installed:\n"
7148 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
7151 #. type: Content of: <book><chapter><section><section><para>
7154 "The New Packages list is simply a reminder of what will happen. The packages "
7155 "listed are not presently installed in the system but will be when APT is "
7159 #. type: Content of: <book><chapter><section><section><title>
7161 msgid "The Kept Back list"
7164 #. type: Content of: <book><chapter><section><section><screen>
7168 "The following packages have been kept back\n"
7169 " compface man-db tetex-base msql libpaper svgalib1\n"
7170 " gs snmp arena lynx xpat2 groff xscreensaver\n"
7173 #. type: Content of: <book><chapter><section><section><para>
7176 "Whenever the whole system is being upgraded there is the possibility that "
7177 "new versions of packages cannot be installed because they require new things "
7178 "or conflict with already installed things. In this case the package will "
7179 "appear in the Kept Back list. The best way to convince packages listed there "
7180 "to install is with <literal>apt-get install</literal> or by using "
7181 "<command>dselect</command> to resolve their problems."
7184 #. type: Content of: <book><chapter><section><section><title>
7186 msgid "Held Packages warning"
7189 #. type: Content of: <book><chapter><section><section><screen>
7193 "The following held packages will be changed:\n"
7197 #. type: Content of: <book><chapter><section><section><para>
7200 "Sometimes you can ask APT to install a package that is on hold, in such a "
7201 "case it prints out a warning that the held package is going to be "
7202 "changed. This should only happen during dist-upgrade or install."
7205 #. type: Content of: <book><chapter><section><section><title>
7207 msgid "Final summary"
7210 #. type: Content of: <book><chapter><section><section><para>
7212 msgid "Finally, APT will print out a summary of all the changes that will occur."
7215 #. type: Content of: <book><chapter><section><section><screen>
7219 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7221 "12 packages not fully installed or removed.\n"
7222 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
7225 #. type: Content of: <book><chapter><section><section><para>
7228 "The first line of the summary simply is a reduced version of all of the "
7229 "lists and includes the number of upgrades - that is packages already "
7230 "installed that have new versions available. The second line indicates the "
7231 "number of poorly configured packages, possibly the result of an aborted "
7232 "installation. The final line shows the space requirements that the "
7233 "installation needs. The first pair of numbers refer to the size of the "
7234 "archive files. The first number indicates the number of bytes that must be "
7235 "fetched from remote locations and the second indicates the total size of all "
7236 "the archives required. The next number indicates the size difference between "
7237 "the presently installed packages and the newly installed packages. It is "
7238 "roughly equivalent to the space required in /usr after everything is "
7239 "done. If a large number of packages are being removed then the value may "
7240 "indicate the amount of space that will be freed."
7243 #. type: Content of: <book><chapter><section><section><para>
7246 "Some other reports can be generated by using the -u option to show packages "
7247 "to upgrade, they are similar to the previous examples."
7250 #. type: Content of: <book><chapter><section><title>
7252 msgid "The Status Display"
7255 #. type: Content of: <book><chapter><section><para>
7258 "During the download of archives and package files APT prints out a series of "
7262 #. type: Content of: <book><chapter><section><screen>
7266 "# apt-get update\n"
7267 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7268 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7269 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7270 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7272 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7273 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
7276 #. type: Content of: <book><chapter><section><para>
7279 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
7280 "begins to fetch a file while the last line indicates the progress of the "
7281 "download. The first percent value on the progress line indicates the total "
7282 "percent done of all files. Unfortunately since the size of the Package files "
7283 "is unknown <literal>apt-get update</literal> estimates the percent done "
7284 "which causes some inaccuracies."
7287 #. type: Content of: <book><chapter><section><para>
7290 "The next section of the status line is repeated once for each download "
7291 "thread and indicates the operation being performed and some useful "
7292 "information about what is happening. Sometimes this section will simply read "
7293 "<emphasis>Forking</emphasis> which means the OS is loading the download "
7294 "module. The first word after the [ is the fetch number as shown on the "
7295 "history lines. The next word is the short form name of the object being "
7296 "downloaded. For archives it will contain the name of the package that is "
7300 #. type: Content of: <book><chapter><section><para>
7303 "Inside of the single quote is an informative string indicating the progress "
7304 "of the negotiation phase of the download. Typically it progresses from "
7305 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
7306 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
7307 "value is the number of bytes downloaded from the remote site. Once the "
7308 "download begins this is represented as <literal>102/10.2k</literal> "
7309 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
7310 "expected. The total size is always shown in 4 figure notation to preserve "
7311 "space. After the size display is a percent meter for the file itself. The "
7312 "second last element is the instantaneous average speed. This values is "
7313 "updated every 5 seconds and reflects the rate of data transfer for that "
7314 "period. Finally is shown the estimated transfer time. This is updated "
7315 "regularly and reflects the time to complete everything at the shown transfer "
7319 #. type: Content of: <book><chapter><section><para>
7322 "The status display updates every half second to provide a constant feedback "
7323 "on the download progress while the Get lines scroll back whenever a new file "
7324 "is started. Since the status display is constantly updated it is unsuitable "
7325 "for logging to a file, use the <literal>-q</literal> option to remove the "
7329 #. type: Content of: <book><chapter><section><title>
7334 #. type: Content of: <book><chapter><section><para>
7337 "APT uses <command>dpkg</command> for installing the archives and will switch "
7338 "over to the <command>dpkg</command> interface once downloading is "
7339 "completed. <command>dpkg</command> will also ask a number of questions as it "
7340 "processes the packages and the packages themselves may also ask several "
7341 "questions. Before each question there is usually a description of what it is "
7342 "asking and the questions are too varied to discuss completely here."
7345 #. type: Content of: <book><title>
7347 msgid "Using APT Offline"
7350 #. type: Content of: <book><bookinfo><abstract><para>
7353 "This document describes how to use APT in a non-networked environment, "
7354 "specifically a 'sneaker-net' approach for performing upgrades."
7357 #. type: Content of: <book><bookinfo>
7359 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
7362 #. type: Content of: <book><chapter><title>
7364 msgid "Introduction"
7367 #. type: Content of: <book><chapter><section><title>
7368 #: offline.dbk:1 offline.dbk:1 offline.dbk:1
7372 #. type: Content of: <book><chapter><section><para>
7375 "Normally APT requires direct access to a Debian archive, either from a local "
7376 "media or through a network. Another common complaint is that a Debian "
7377 "machine is on a slow link, such as a modem and another machine has a very "
7378 "fast connection but they are physically distant."
7381 #. type: Content of: <book><chapter><section><para>
7384 "The solution to this is to use large removable media such as a Zip disc or a "
7385 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7386 "archive but can easily fit a subset large enough for most users. The idea is "
7387 "to use APT to generate a list of packages that are required and then fetch "
7388 "them onto the disc using another machine with good connectivity. It is even "
7389 "possible to use another Debian machine with APT or to use a completely "
7390 "different OS and a download tool like wget. Let <emphasis>remote "
7391 "host</emphasis> mean the machine downloading the packages, and "
7392 "<emphasis>target host</emphasis> the one with bad or no connection."
7395 #. type: Content of: <book><chapter><section><para>
7398 "This is achieved by creatively manipulating the APT configuration file. The "
7399 "essential premise to tell APT to look on a disc for it's archive files. Note "
7400 "that the disc should be formatted with a filesystem that can handle long "
7401 "file names such as ext2, fat32 or vfat."
7404 #. type: Content of: <book><chapter><title>
7406 msgid "Using APT on both machines"
7409 #. type: Content of: <book><chapter><section><para>
7412 "APT being available on both machines gives the simplest configuration. The "
7413 "basic idea is to place a copy of the status file on the disc and use the "
7414 "remote machine to fetch the latest package files and decide which packages "
7415 "to download. The disk directory structure should look like:"
7418 #. type: Content of: <book><chapter><section><screen>
7432 #. type: Content of: <book><chapter><section><title>
7434 msgid "The configuration file"
7437 #. type: Content of: <book><chapter><section><para>
7440 "The configuration file should tell APT to store its files on the disc and to "
7441 "use the configuration files on the disc as well. The sources.list should "
7442 "contain the proper sites that you wish to use from the remote machine, and "
7443 "the status file should be a copy of "
7444 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
7445 "host</emphasis>. Please note, if you are using a local archive you must use "
7446 "copy URIs, the syntax is identical to file URIs."
7449 #. type: Content of: <book><chapter><section><para>
7452 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
7456 #. type: Content of: <book><chapter><section><screen>
7462 " /* This is not necessary if the two machines are the same arch, it "
7464 " the remote APT what architecture the target machine is */\n"
7465 " Architecture \"i386\";\n"
7467 " Get::Download-Only \"true\";\n"
7472 " /* Use the disc for state information and redirect the status file from\n"
7473 " the /var/lib/dpkg default */\n"
7474 " State \"/disc/\";\n"
7475 " State::status \"status\";\n"
7477 " // Binary caches will be stored locally\n"
7478 " Cache::archives \"/disc/archives/\";\n"
7479 " Cache \"/tmp/\";\n"
7481 " // Location of the source list.\n"
7482 " Etc \"/disc/\";\n"
7486 #. type: Content of: <book><chapter><section><para>
7489 "More details can be seen by examining the apt.conf man page and the sample "
7490 "configuration file in "
7491 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
7494 #. type: Content of: <book><chapter><section><para>
7497 "On the target machine the first thing to do is mount the disc and copy "
7498 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
7499 "create the directories outlined in the Overview, "
7500 "<emphasis>archives/partial/</emphasis> and "
7501 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
7502 "machine and configure the sources.list. On the remote machine execute the "
7506 #. type: Content of: <book><chapter><section><screen>
7510 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7511 " # apt-get update\n"
7512 " [ APT fetches the package files ]\n"
7513 " # apt-get dist-upgrade\n"
7514 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
7517 #. type: Content of: <book><chapter><section><para>
7520 "The dist-upgrade command can be replaced with any other standard APT "
7521 "commands, particularly dselect-upgrade. You can even use an APT front end "
7522 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
7523 "communicating your selections back to the local computer."
7526 #. type: Content of: <book><chapter><section><para>
7529 "Now the disc contains all of the index files and archives needed to upgrade "
7530 "the target machine. Take the disc back and run:"
7533 #. type: Content of: <book><chapter><section><screen>
7537 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7538 " # apt-get check\n"
7539 " [ APT generates a local copy of the cache files ]\n"
7540 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7541 " [ Or any other APT command ]\n"
7544 #. type: Content of: <book><chapter><section><para>
7547 "It is necessary for proper function to re-specify the status file to be the "
7548 "local one. This is very important!"
7551 #. type: Content of: <book><chapter><section><para>
7554 "If you are using dselect you can do the very risky operation of copying "
7555 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7556 "remote machine are updated. I highly recommend that people only make "
7557 "selections on the local machine - but this may not always be possible. DO "
7558 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7561 #. type: Content of: <book><chapter><title>
7563 msgid "Using APT and wget"
7566 #. type: Content of: <book><chapter><section><para>
7569 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7570 "run on nearly any machine. Unlike the method above this requires that the "
7571 "Debian machine already has a list of available packages."
7574 #. type: Content of: <book><chapter><section><para>
7577 "The basic idea is to create a disc that has only the archive files "
7578 "downloaded from the remote site. This is done by using the --print-uris "
7579 "option to apt-get and then preparing a wget script to actually fetch the "
7583 #. type: Content of: <book><chapter><section><title>
7588 #. type: Content of: <book><chapter><section><para>
7591 "Unlike the previous technique no special configuration files are "
7592 "required. We merely use the standard APT commands to generate the file list."
7595 #. type: Content of: <book><chapter><section><screen>
7599 " # apt-get dist-upgrade\n"
7600 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7601 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7602 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7605 #. type: Content of: <book><chapter><section><para>
7608 "Any command other than dist-upgrade could be used here, including "
7612 #. type: Content of: <book><chapter><section><para>
7615 "The /disc/wget-script file will now contain a list of wget commands to "
7616 "execute in order to fetch the necessary archives. This script should be run "
7617 "with the current directory as the disc's mount point so as to save the "
7618 "output on the disc."
7621 #. type: Content of: <book><chapter><section><para>
7623 msgid "The remote machine would do something like"
7626 #. type: Content of: <book><chapter><section><screen>
7631 " # sh -x ./wget-script\n"
7635 #. type: Content of: <book><chapter><section><para>
7638 "Once the archives are downloaded and the disc returned to the Debian machine "
7639 "installation can proceed using,"
7642 #. type: Content of: <book><chapter><section><screen>
7645 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7648 #. type: Content of: <book><chapter><section><para>
7650 msgid "Which will use the already fetched archives on the disc."