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.0.5\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2014-07-03 22:15+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:25 apt-get.8.xml:28 apt-cache.8.xml:28 apt-key.8.xml:27 apt-mark.8.xml:28 apt-secure.8.xml:27 apt-cdrom.8.xml:27 apt-config.8.xml:28
504 #. type: Content of: <refentry><refmeta><refmiscinfo>
505 #: apt.8.xml:26 apt-get.8.xml:29 apt-cache.8.xml:29 apt-key.8.xml:28 apt-mark.8.xml:29 apt-secure.8.xml:28 apt-cdrom.8.xml:28 apt-config.8.xml:29 apt.conf.5.xml:34 apt_preferences.5.xml:28 sources.list.5.xml:29 apt-extracttemplates.1.xml:29 apt-sortpkgs.1.xml:29 apt-ftparchive.1.xml:29
509 #. type: Content of: <refentry><refnamediv><refpurpose>
511 msgid "command-line interface"
514 #. type: Content of: <refentry><refsect1><title>
515 #: apt.8.xml:37 apt-get.8.xml:40 apt-cache.8.xml:40 apt-key.8.xml:39 apt-mark.8.xml:40 apt-secure.8.xml:52 apt-cdrom.8.xml:39 apt-config.8.xml:40 apt.conf.5.xml:43 apt_preferences.5.xml:38 sources.list.5.xml:38 apt-extracttemplates.1.xml:40 apt-sortpkgs.1.xml:40 apt-ftparchive.1.xml:40
519 #. type: Content of: <refentry><refsect1><para>
522 "<command>apt</command> (Advanced Package Tool) is the command-line tool for "
523 "handling packages. It provides a commandline interface for the package "
524 "management of the system. See also &apt-get; and &apt-cache; for more "
525 "low-level command options."
528 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
531 "<literal>list</literal> is used to display a list of packages. It supports "
532 "shell pattern for matching package names and the following options: "
533 "<option>--installed</option>, <option>--upgradable</option>, "
534 "<option>--all-versions</option> are supported."
537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
540 "<literal>search</literal> searches for the given term(s) and display "
544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
547 "<literal>show</literal> shows the package information for the given "
551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
554 "<literal>install</literal> is followed by one or more package names desired "
555 "for installation or upgrading."
558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
559 #: apt.8.xml:75 apt-get.8.xml:118
561 "A specific version of a package can be selected for installation by "
562 "following the package name with an equals and the version of the package to "
563 "select. This will cause that version to be located and selected for "
564 "install. Alternatively a specific distribution can be selected by following "
565 "the package name with a slash and the version of the distribution or the "
566 "Archive name (stable, testing, unstable)."
569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
570 #: apt.8.xml:85 apt-get.8.xml:153
572 "<literal>remove</literal> is identical to <literal>install</literal> except "
573 "that packages are removed instead of installed. Note that removing a package "
574 "leaves its configuration files on the system. If a plus sign is appended to "
575 "the package name (with no intervening space), the identified package will be "
576 "installed instead of removed."
579 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
582 "<literal>edit-sources</literal> lets you edit your sources.list file and "
583 "provides basic sanity checks."
586 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
589 "<literal>update</literal> is used to resynchronize the package index files "
590 "from their sources."
593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
596 "<literal>upgrade</literal> is used to install the newest versions of all "
597 "packages currently installed on the system from the sources enumerated in "
598 "<filename>/etc/apt/sources.list</filename>. New package will be installed, "
599 "but existing package will never removed."
602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
605 "<literal>full-upgrade</literal> performs the function of upgrade but may "
606 "also remove installed packages if that is required in order to resolve a "
610 #. type: Content of: <refentry><refsect1><title>
611 #: apt.8.xml:124 apt-get.8.xml:257 apt-cache.8.xml:250 apt-mark.8.xml:110 apt-config.8.xml:86 apt-extracttemplates.1.xml:54 apt-sortpkgs.1.xml:50 apt-ftparchive.1.xml:506
615 #. type: Content of: <refentry><refsect1><title>
620 #. type: Content of: <refentry><refsect1><para>
623 "The &apt; commandline is designed as a end-user tool and it may change the "
624 "output between versions. While it tries to not break backward compatibility "
625 "there is no guarantee for it either. All features of &apt; are available in "
626 "&apt-cache; and &apt-get; via APT options. Please prefer using these "
627 "commands in your scripts."
630 #. type: Content of: <refentry><refsect1><title>
632 msgid "Differences to &apt-get;"
635 #. type: Content of: <refentry><refsect1><para>
638 "The <command>apt</command> command is meant to be pleasant for end users and "
639 "does not need to be backward compatible like &apt-get;. Therefore some "
640 "options are different:"
643 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
645 msgid "The option <literal>DPkg::Progress-Fancy</literal> is enabled."
648 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
650 msgid "The option <literal>APT::Color</literal> is enabled."
653 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
656 "A new <literal>list</literal> command is available similar to <literal>dpkg "
660 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
663 "The option <literal>upgrade</literal> has <literal>--with-new-pkgs</literal> "
664 "enabled by default."
667 #. type: Content of: <refentry><refsect1><title>
668 #: apt.8.xml:174 apt-get.8.xml:558 apt-cache.8.xml:352 apt-key.8.xml:197 apt-mark.8.xml:133 apt-secure.8.xml:193 apt-cdrom.8.xml:154 apt-config.8.xml:111 apt.conf.5.xml:1227 apt_preferences.5.xml:707 sources.list.5.xml:280 apt-extracttemplates.1.xml:72 apt-sortpkgs.1.xml:65 apt-ftparchive.1.xml:609
672 #. type: Content of: <refentry><refsect1><para>
675 "&apt-get;, &apt-cache;, &sources-list;, &apt-conf;, &apt-config;, The APT "
676 "User's guide in &guidesdir;, &apt-preferences;, the APT Howto."
679 #. type: Content of: <refentry><refsect1><title>
680 #: apt.8.xml:180 apt-get.8.xml:564 apt-cache.8.xml:357 apt-mark.8.xml:137 apt-cdrom.8.xml:159 apt-config.8.xml:116 apt-extracttemplates.1.xml:76 apt-sortpkgs.1.xml:69 apt-ftparchive.1.xml:613
684 #. type: Content of: <refentry><refsect1><para>
687 "<command>apt</command> returns zero on normal operation, decimal 100 on "
691 #. type: Content of: <refentry><refnamediv><refpurpose>
693 msgid "APT package handling utility -- command-line interface"
696 #. type: Content of: <refentry><refsect1><para>
699 "<command>apt-get</command> is the command-line tool for handling packages, "
700 "and may be considered the user's \"back-end\" to other tools using the APT "
701 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
702 "&synaptic; and &wajig;."
705 #. type: Content of: <refentry><refsect1><para>
706 #: apt-get.8.xml:46 apt-cache.8.xml:46 apt-cdrom.8.xml:53 apt-config.8.xml:46 apt-ftparchive.1.xml:56
708 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
709 "one of the commands below must be present."
712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
715 "<literal>update</literal> is used to resynchronize the package index files "
716 "from their sources. The indexes of available packages are fetched from the "
717 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
718 "example, when using a Debian archive, this command retrieves and scans the "
719 "<filename>Packages.gz</filename> files, so that information about new and "
720 "updated packages is available. An <literal>update</literal> should always be "
721 "performed before an <literal>upgrade</literal> or "
722 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
723 "meter will be incorrect as the size of the package files cannot be known in "
727 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
730 "<literal>upgrade</literal> is used to install the newest versions of all "
731 "packages currently installed on the system from the sources enumerated in "
732 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
733 "with new versions available are retrieved and upgraded; under no "
734 "circumstances are currently installed packages removed, or packages not "
735 "already installed retrieved and installed. New versions of currently "
736 "installed packages that cannot be upgraded without changing the install "
737 "status of another package will be left at their current version. An "
738 "<literal>update</literal> must be performed first so that "
739 "<command>apt-get</command> knows that new versions of packages are "
743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
746 "<literal>dist-upgrade</literal> in addition to performing the function of "
747 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
748 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
749 "conflict resolution system, and it will attempt to upgrade the most "
750 "important packages at the expense of less important ones if necessary. The "
751 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
752 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
753 "locations from which to retrieve desired package files. See also "
754 "&apt-preferences; for a mechanism for overriding the general settings for "
755 "individual packages."
758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
761 "<literal>dselect-upgrade</literal> is used in conjunction with the "
762 "traditional Debian packaging front-end, "
763 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
764 "&dselect; to the <literal>Status</literal> field of available packages, and "
765 "performs the actions necessary to realize that state (for instance, the "
766 "removal of old and the installation of new packages)."
769 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
772 "<literal>install</literal> is followed by one or more packages desired for "
773 "installation or upgrading. Each package is a package name, not a fully "
774 "qualified filename (for instance, in a Debian system, "
775 "<package>apt-utils</package> would be the argument provided, not "
776 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
777 "packages required by the package(s) specified for installation will also be "
778 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
779 "file is used to locate the desired packages. If a hyphen is appended to the "
780 "package name (with no intervening space), the identified package will be "
781 "removed if it is installed. Similarly a plus sign can be used to designate "
782 "a package to install. These latter features may be used to override "
783 "decisions made by apt-get's conflict resolution system."
786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
789 "Both of the version selection mechanisms can downgrade packages and must be "
793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
796 "This is also the target to use if you want to upgrade one or more "
797 "already-installed packages without upgrading every package you have on your "
798 "system. Unlike the \"upgrade\" target, which installs the newest version of "
799 "all currently installed packages, \"install\" will install the newest "
800 "version of only the package(s) specified. Simply provide the name of the "
801 "package(s) you wish to upgrade, and if a newer version is available, it (and "
802 "its dependencies, as described above) will be downloaded and installed."
805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
808 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
809 "installation policy for individual packages."
812 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
815 "If no package matches the given expression and the expression contains one "
816 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
817 "it is applied to all package names in the database. Any matches are then "
818 "installed (or removed). Note that matching is done by substring so 'lo.*' "
819 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
820 "expression with a '^' or '$' character, or create a more specific regular "
824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
827 "<literal>purge</literal> is identical to <literal>remove</literal> except "
828 "that packages are removed and purged (any configuration files are deleted "
832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
835 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
836 "packages. APT will examine the available packages to decide which source "
837 "package to fetch. It will then find and download into the current directory "
838 "the newest available version of that source package while respecting the "
839 "default release, set with the option "
840 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
841 "per package with the <literal>pkg/release</literal> syntax, if possible."
844 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
847 "Source packages are tracked separately from binary packages via "
848 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
849 "you will need to add such a line for each repository you want to get sources "
850 "from; otherwise you will probably get either the wrong (too old/too new) "
851 "source versions or none at all."
854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
857 "If the <option>--compile</option> option is specified then the package will "
858 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
859 "the architecture as defined by the <command>--host-architecture</command> "
860 "option. If <option>--download-only</option> is specified then the source "
861 "package will not be unpacked."
864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
867 "A specific source version can be retrieved by postfixing the source name "
868 "with an equals and then the version to fetch, similar to the mechanism used "
869 "for the package files. This enables exact matching of the source package "
870 "name and version, implicitly enabling the "
871 "<literal>APT::Get::Only-Source</literal> option."
874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
877 "Note that source packages are not installed and tracked in the "
878 "<command>dpkg</command> database like binary packages; they are simply "
879 "downloaded to the current directory, like source tarballs."
882 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
885 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
886 "attempt to satisfy the build dependencies for a source package. By default "
887 "the dependencies are satisfied to build the package natively. If desired a "
888 "host-architecture can be specified with the "
889 "<option>--host-architecture</option> option instead."
892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
895 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
896 "and checks for broken dependencies."
899 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
902 "<literal>download</literal> will download the given binary package into the "
906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
909 "<literal>clean</literal> clears out the local repository of retrieved "
910 "package files. It removes everything but the lock file from "
911 "<filename>&cachedir;/archives/</filename> and "
912 "<filename>&cachedir;/archives/partial/</filename>."
915 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
918 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
919 "local repository of retrieved package files. The difference is that it only "
920 "removes package files that can no longer be downloaded, and are largely "
921 "useless. This allows a cache to be maintained over a long period without it "
922 "growing out of control. The configuration option "
923 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
924 "being erased if it is set to off."
927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
930 "<literal>autoremove</literal> is used to remove packages that were "
931 "automatically installed to satisfy dependencies for other packages and are "
932 "now no longer needed."
935 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
938 "<literal>changelog</literal> downloads a package changelog and displays it "
939 "through <command>sensible-pager</command>. The server name and base "
940 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
941 "variable (e.g. <ulink "
942 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
943 "for Debian or <ulink "
944 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
945 "for Ubuntu). By default it displays the changelog for the version that is "
946 "installed. However, you can specify the same options as for the "
947 "<option>install</option> command."
950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
953 "Do not consider recommended packages as a dependency for installing. "
954 "Configuration Item: <literal>APT::Install-Recommends</literal>."
957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
960 "Consider suggested packages as a dependency for installing. Configuration "
961 "Item: <literal>APT::Install-Suggests</literal>."
964 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
967 "Download only; package files are only retrieved, not unpacked or installed. "
968 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
971 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
974 "Fix; attempt to correct a system with broken dependencies in place. This "
975 "option, when used with install/remove, can omit any packages to permit APT "
976 "to deduce a likely solution. If packages are specified, these have to "
977 "completely correct the problem. The option is sometimes necessary when "
978 "running APT for the first time; APT itself does not allow broken package "
979 "dependencies to exist on a system. It is possible that a system's dependency "
980 "structure can be so corrupt as to require manual intervention (which usually "
981 "means using <command>dpkg --remove</command> to eliminate some of the "
982 "offending packages). Use of this option together with <option>-m</option> "
983 "may produce an error in some situations. Configuration Item: "
984 "<literal>APT::Get::Fix-Broken</literal>."
987 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
990 "Ignore missing packages; if packages cannot be retrieved or fail the "
991 "integrity check after retrieval (corrupted package files), hold back those "
992 "packages and handle the result. Use of this option together with "
993 "<option>-f</option> may produce an error in some situations. If a package is "
994 "selected for installation (particularly if it is mentioned on the command "
995 "line) and it could not be downloaded then it will be silently held back. "
996 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1000 #: apt-get.8.xml:303
1002 "Disables downloading of packages. This is best used with "
1003 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
1004 "already downloaded. Configuration Item: "
1005 "<literal>APT::Get::Download</literal>."
1008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1009 #: apt-get.8.xml:310
1011 "Quiet; produces output suitable for logging, omitting progress indicators. "
1012 "More q's will produce more quiet up to a maximum of 2. You can also use "
1013 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1014 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
1015 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
1016 "may decide to do something you did not expect. Configuration Item: "
1017 "<literal>quiet</literal>."
1020 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1021 #: apt-get.8.xml:325
1023 "No action; perform a simulation of events that would occur but do not "
1024 "actually change the system. Configuration Item: "
1025 "<literal>APT::Get::Simulate</literal>."
1028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1029 #: apt-get.8.xml:329
1031 "Simulated runs performed as a user will automatically deactivate locking "
1032 "(<literal>Debug::NoLocking</literal>), and if the option "
1033 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (as it is by "
1034 "default) a notice will also be displayed indicating that this is only a "
1035 "simulation. Runs performed as root do not trigger either NoLocking or the "
1036 "notice - superusers should know what they are doing without further warnings "
1037 "from <literal>apt-get</literal>."
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1041 #: apt-get.8.xml:337
1043 "Simulated runs print out a series of lines, each representing a "
1044 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
1045 "remove (<literal>Remv</literal>) or unpack "
1046 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
1047 "empty square brackets indicate breaks that are of no consequence (rare)."
1050 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1051 #: apt-get.8.xml:345
1053 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
1054 "non-interactively. If an undesirable situation, such as changing a held "
1055 "package, trying to install a unauthenticated package or removing an "
1056 "essential package occurs then <literal>apt-get</literal> will abort. "
1057 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
1060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1061 #: apt-get.8.xml:353
1063 "Automatic \"no\" to all prompts. Configuration Item: "
1064 "<literal>APT::Get::Assume-No</literal>."
1067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1068 #: apt-get.8.xml:358
1070 "Show upgraded packages; print out a list of all packages that are to be "
1071 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
1074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1075 #: apt-get.8.xml:364
1077 "Show full versions for upgraded and installed packages. Configuration Item: "
1078 "<literal>APT::Get::Show-Versions</literal>."
1081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1082 #: apt-get.8.xml:370
1084 "This option controls the architecture packages are built for by "
1085 "<command>apt-get source --compile</command> and how cross-builddependencies "
1086 "are satisfied. By default is it not set which means that the host "
1087 "architecture is the same as the build architecture (which is defined by "
1088 "<literal>APT::Architecture</literal>). Configuration Item: "
1089 "<literal>APT::Get::Host-Architecture</literal>."
1092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1093 #: apt-get.8.xml:380
1095 "This option controls the activated build profiles for which a source package "
1096 "is built by <command>apt-get source --compile</command> and how build "
1097 "dependencies are satisfied. By default no build profile is active. More "
1098 "than one build profile can be activated at a time by concatenating them with "
1099 "a comma. Configuration Item: <literal>APT::Build-Profiles</literal>."
1102 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1103 #: apt-get.8.xml:391
1105 "Compile source packages after downloading them. Configuration Item: "
1106 "<literal>APT::Get::Compile</literal>."
1109 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1110 #: apt-get.8.xml:396
1112 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
1113 "hold placed on a package. This may be useful in conjunction with "
1114 "<literal>dist-upgrade</literal> to override a large number of undesired "
1115 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
1118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1119 #: apt-get.8.xml:403
1121 "Allow installing new packages when used in conjunction with "
1122 "<literal>upgrade</literal>. This is useful if the update of a installed "
1123 "package requires new dependencies to be installed. Instead of holding the "
1124 "package back <literal>upgrade</literal> will upgrade the package and install "
1125 "the new dependencies. Note that <literal>upgrade</literal> with this option "
1126 "will never remove packages, only allow adding new ones. Configuration Item: "
1127 "<literal>APT::Get::Upgrade-Allow-New</literal>."
1130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1131 #: apt-get.8.xml:415
1133 "Do not upgrade packages; when used in conjunction with "
1134 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
1135 "packages on the command line from being upgraded if they are already "
1136 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
1139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1140 #: apt-get.8.xml:422
1142 "Do not install new packages; when used in conjunction with "
1143 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
1144 "upgrades for already installed packages only and ignore requests to install "
1145 "new packages. Configuration Item: "
1146 "<literal>APT::Get::Only-Upgrade</literal>."
1149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1150 #: apt-get.8.xml:430
1152 "Force yes; this is a dangerous option that will cause apt to continue "
1153 "without prompting if it is doing something potentially harmful. It should "
1154 "not be used except in very special situations. Using "
1155 "<literal>force-yes</literal> can potentially destroy your system! "
1156 "Configuration Item: <literal>APT::Get::force-yes</literal>."
1159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1160 #: apt-get.8.xml:438
1162 "Instead of fetching the files to install their URIs are printed. Each URI "
1163 "will have the path, the destination file name, the size and the expected MD5 "
1164 "hash. Note that the file name to write to will not always match the file "
1165 "name on the remote site! This also works with the <literal>source</literal> "
1166 "and <literal>update</literal> commands. When used with the "
1167 "<literal>update</literal> command the MD5 and size are not included, and it "
1168 "is up to the user to decompress any compressed files. Configuration Item: "
1169 "<literal>APT::Get::Print-URIs</literal>."
1172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1173 #: apt-get.8.xml:449
1175 "Use purge instead of remove for anything that would be removed. An asterisk "
1176 "(\"*\") will be displayed next to packages which are scheduled to be "
1177 "purged. <option>remove --purge</option> is equivalent to the "
1178 "<option>purge</option> command. Configuration Item: "
1179 "<literal>APT::Get::Purge</literal>."
1182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1183 #: apt-get.8.xml:457
1185 "Re-install packages that are already installed and at the newest version. "
1186 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1190 #: apt-get.8.xml:462
1192 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1193 "turn it off. When it is on, <command>apt-get</command> will automatically "
1194 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1195 "obsolete files are erased. The only reason to turn it off is if you "
1196 "frequently change your sources list. Configuration Item: "
1197 "<literal>APT::Get::List-Cleanup</literal>."
1200 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1201 #: apt-get.8.xml:472
1203 "This option controls the default input to the policy engine; it creates a "
1204 "default pin at priority 990 using the specified release string. This "
1205 "overrides the general settings in "
1206 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1207 "not affected by the value of this option. In short, this option lets you "
1208 "have simple control over which distribution packages will be retrieved "
1209 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1210 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1211 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1215 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1216 #: apt-get.8.xml:487
1218 "Only perform operations that are 'trivial'. Logically this can be considered "
1219 "related to <option>--assume-yes</option>; where "
1220 "<option>--assume-yes</option> will answer yes to any prompt, "
1221 "<option>--trivial-only</option> will answer no. Configuration Item: "
1222 "<literal>APT::Get::Trivial-Only</literal>."
1225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1226 #: apt-get.8.xml:494
1228 "If any packages are to be removed apt-get immediately aborts without "
1229 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1233 #: apt-get.8.xml:500
1235 "If the command is either <literal>install</literal> or "
1236 "<literal>remove</literal>, then this option acts like running the "
1237 "<literal>autoremove</literal> command, removing unused dependency "
1238 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1241 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1242 #: apt-get.8.xml:507
1244 "Only has meaning for the <literal>source</literal> and "
1245 "<literal>build-dep</literal> commands. Indicates that the given source "
1246 "names are not to be mapped through the binary table. This means that if "
1247 "this option is specified, these commands will only accept source package "
1248 "names as arguments, rather than accepting binary package names and looking "
1249 "up the corresponding source package. Configuration Item: "
1250 "<literal>APT::Get::Only-Source</literal>."
1253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1254 #: apt-get.8.xml:518
1256 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1257 "Item: <literal>APT::Get::Diff-Only</literal>, "
1258 "<literal>APT::Get::Dsc-Only</literal>, and "
1259 "<literal>APT::Get::Tar-Only</literal>."
1262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1263 #: apt-get.8.xml:524
1265 "Only process architecture-dependent build-dependencies. Configuration Item: "
1266 "<literal>APT::Get::Arch-Only</literal>."
1269 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1270 #: apt-get.8.xml:529
1272 "Ignore if packages can't be authenticated and don't prompt about it. This "
1273 "is useful for tools like pbuilder. Configuration Item: "
1274 "<literal>APT::Get::AllowUnauthenticated</literal>."
1277 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1278 #: apt-get.8.xml:535
1280 "Show user friendly progress information in the terminal window when packages "
1281 "are installed, upgraded or removed. For a machine parsable version of this "
1282 "data see README.progress-reporting in the apt doc directory. Configuration "
1283 "Item: <literal>Dpkg::Progress</literal> and "
1284 "<literal>Dpkg::Progress-Fancy</literal>."
1287 #. type: Content of: <refentry><refsect1><title>
1288 #: apt-get.8.xml:548 apt-cache.8.xml:345 apt-key.8.xml:176 apt-mark.8.xml:127 apt.conf.5.xml:1221 apt_preferences.5.xml:700
1292 #. type: Content of: <refentry><refsect1><para>
1293 #: apt-get.8.xml:559
1295 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1296 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1300 #. type: Content of: <refentry><refsect1><para>
1301 #: apt-get.8.xml:565
1303 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1307 #. type: Content of: <refentry><refnamediv><refpurpose>
1308 #: apt-cache.8.xml:35
1309 msgid "query the APT cache"
1312 #. type: Content of: <refentry><refsect1><para>
1313 #: apt-cache.8.xml:41
1315 "<command>apt-cache</command> performs a variety of operations on APT's "
1316 "package cache. <command>apt-cache</command> does not manipulate the state of "
1317 "the system but does provide operations to search and generate interesting "
1318 "output from the package metadata."
1321 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1322 #: apt-cache.8.xml:51
1324 "<literal>gencaches</literal> creates APT's package cache. This is done "
1325 "implicitly by all commands needing this cache if it is missing or outdated."
1328 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1329 #: apt-cache.8.xml:55 apt-cache.8.xml:144 apt-cache.8.xml:165 apt-cache.8.xml:187 apt-cache.8.xml:192 apt-cache.8.xml:208 apt-cache.8.xml:226 apt-cache.8.xml:238
1330 msgid "&synopsis-pkg;"
1333 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1334 #: apt-cache.8.xml:56
1336 "<literal>showpkg</literal> displays information about the packages listed on "
1337 "the command line. Remaining arguments are package names. The available "
1338 "versions and reverse dependencies of each package listed are listed, as well "
1339 "as forward dependencies for each version. Forward (normal) dependencies are "
1340 "those packages upon which the package in question depends; reverse "
1341 "dependencies are those packages that depend upon the package in "
1342 "question. Thus, forward dependencies must be satisfied for a package, but "
1343 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1344 "libreadline2</command> would produce output similar to the following:"
1347 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1348 #: apt-cache.8.xml:68
1351 "Package: libreadline2\n"
1352 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1353 "Reverse Depends: \n"
1354 " libreadlineg2,libreadline2\n"
1355 " libreadline2-altdev,libreadline2\n"
1357 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1360 "Reverse Provides: \n"
1363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1364 #: apt-cache.8.xml:80
1366 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1367 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1368 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1369 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1370 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1371 "installed. For the specific meaning of the remainder of the output it is "
1372 "best to consult the apt source code."
1375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1376 #: apt-cache.8.xml:89
1378 "<literal>stats</literal> displays some statistics about the cache. No "
1379 "further arguments are expected. Statistics reported are:"
1382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1383 #: apt-cache.8.xml:92
1385 "<literal>Total package names</literal> is the number of package names found "
1389 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1390 #: apt-cache.8.xml:96
1392 "<literal>Normal packages</literal> is the number of regular, ordinary "
1393 "package names; these are packages that bear a one-to-one correspondence "
1394 "between their names and the names used by other packages for them in "
1395 "dependencies. The majority of packages fall into this category."
1398 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1399 #: apt-cache.8.xml:102
1401 "<literal>Pure virtual packages</literal> is the number of packages that "
1402 "exist only as a virtual package name; that is, packages only \"provide\" the "
1403 "virtual package name, and no package actually uses the name. For instance, "
1404 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1405 "several packages provide \"mail-transport-agent\", but there is no package "
1406 "named \"mail-transport-agent\"."
1409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1410 #: apt-cache.8.xml:110
1412 "<literal>Single virtual packages</literal> is the number of packages with "
1413 "only one package providing a particular virtual package. For example, in the "
1414 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1415 "package, xless, provides \"X11-text-viewer\"."
1418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1419 #: apt-cache.8.xml:116
1421 "<literal>Mixed virtual packages</literal> is the number of packages that "
1422 "either provide a particular virtual package or have the virtual package name "
1423 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1424 "an actual package, and provided by the debconf-tiny package."
1427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1428 #: apt-cache.8.xml:123
1430 "<literal>Missing</literal> is the number of package names that were "
1431 "referenced in a dependency but were not provided by any package. Missing "
1432 "packages may be an evidence if a full distribution is not accessed, or if a "
1433 "package (real or virtual) has been dropped from the distribution. Usually "
1434 "they are referenced from Conflicts or Breaks statements."
1437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1438 #: apt-cache.8.xml:130
1440 "<literal>Total distinct</literal> versions is the number of package versions "
1441 "found in the cache; this value is therefore at least equal to the number of "
1442 "total package names. If more than one distribution is being accessed (for "
1443 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1444 "larger than the number of total package names."
1447 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1448 #: apt-cache.8.xml:137
1450 "<literal>Total dependencies</literal> is the number of dependency "
1451 "relationships claimed by all of the packages in the cache."
1454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1455 #: apt-cache.8.xml:145
1457 "<literal>showsrc</literal> displays all the source package records that "
1458 "match the given package names. All versions are shown, as well as all "
1459 "records that declare the name to be a binary package."
1462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1463 #: apt-cache.8.xml:151
1465 "<literal>dump</literal> shows a short listing of every package in the "
1466 "cache. It is primarily for debugging."
1469 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1470 #: apt-cache.8.xml:156
1472 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1473 "suitable for use with &dpkg; and is used by the &dselect; method."
1476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1477 #: apt-cache.8.xml:161
1479 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1484 #: apt-cache.8.xml:166
1486 "<literal>show</literal> performs a function similar to <command>dpkg "
1487 "--print-avail</command>; it displays the package records for the named "
1491 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1492 #: apt-cache.8.xml:171
1493 msgid "&synopsis-regex;"
1496 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1497 #: apt-cache.8.xml:172
1499 "<literal>search</literal> performs a full text search on all available "
1500 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1501 "the package names and the descriptions for an occurrence of the regular "
1502 "expression and prints out the package name and the short description, "
1503 "including virtual package names. If <option>--full</option> is given then "
1504 "output identical to <literal>show</literal> is produced for each matched "
1505 "package, and if <option>--names-only</option> is given then the long "
1506 "description is not searched, only the package name is."
1509 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1510 #: apt-cache.8.xml:183
1512 "Separate arguments can be used to specify multiple search patterns that are "
1516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1517 #: apt-cache.8.xml:188
1519 "<literal>depends</literal> shows a listing of each dependency a package has "
1520 "and all the possible other packages that can fulfill that dependency."
1523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1524 #: apt-cache.8.xml:193
1526 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1530 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1531 #: apt-cache.8.xml:197
1532 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1536 #: apt-cache.8.xml:198
1538 "This command prints the name of each package APT knows. The optional "
1539 "argument is a prefix match to filter the name list. The output is suitable "
1540 "for use in a shell tab complete function and the output is generated "
1541 "extremely quickly. This command is best used with the "
1542 "<option>--generate</option> option."
1545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1546 #: apt-cache.8.xml:203
1548 "Note that a package which APT knows of is not necessarily available to "
1549 "download, installable or installed, e.g. virtual packages are also listed in "
1550 "the generated list."
1553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1554 #: apt-cache.8.xml:209
1556 "<literal>dotty</literal> takes a list of packages on the command line and "
1557 "generates output suitable for use by dotty from the <ulink "
1558 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1559 "package. The result will be a set of nodes and edges representing the "
1560 "relationships between the packages. By default the given packages will trace "
1561 "out all dependent packages; this can produce a very large graph. To limit "
1562 "the output to only the packages listed on the command line, set the "
1563 "<literal>APT::Cache::GivenOnly</literal> option."
1566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1567 #: apt-cache.8.xml:218
1569 "The resulting nodes will have several shapes; normal packages are boxes, "
1570 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1571 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1572 "packages), blue lines are pre-depends, green lines are conflicts."
1575 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1576 #: apt-cache.8.xml:223
1577 msgid "Caution, dotty cannot graph larger sets of packages."
1580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1581 #: apt-cache.8.xml:227
1583 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1584 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1588 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1589 #: apt-cache.8.xml:231
1590 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1594 #: apt-cache.8.xml:232
1596 "<literal>policy</literal> is meant to help debug issues relating to the "
1597 "preferences file. With no arguments it will print out the priorities of each "
1598 "source. Otherwise it prints out detailed information about the priority "
1599 "selection of the named package."
1602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1603 #: apt-cache.8.xml:239
1605 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1606 "to mimic the output format and a subset of the functionality of the Debian "
1607 "archive management tool, <literal>madison</literal>. It displays available "
1608 "versions of a package in a tabular format. Unlike the original "
1609 "<literal>madison</literal>, it can only display information for the "
1610 "architecture for which APT has retrieved package lists "
1611 "(<literal>APT::Architecture</literal>)."
1614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1615 #: apt-cache.8.xml:255
1617 "Select the file to store the package cache. The package cache is the primary "
1618 "cache used by all operations. Configuration Item: "
1619 "<literal>Dir::Cache::pkgcache</literal>."
1622 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1623 #: apt-cache.8.xml:261
1625 "Select the file to store the source cache. The source is used only by "
1626 "<literal>gencaches</literal> and it stores a parsed version of the package "
1627 "information from remote sources. When building the package cache the source "
1628 "cache is used to avoid reparsing all of the package files. Configuration "
1629 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1632 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1633 #: apt-cache.8.xml:269
1635 "Quiet; produces output suitable for logging, omitting progress indicators. "
1636 "More q's will produce more quietness up to a maximum of 2. You can also use "
1637 "<option>-q=#</option> to set the quietness level, overriding the "
1638 "configuration file. Configuration Item: <literal>quiet</literal>."
1641 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1642 #: apt-cache.8.xml:276
1644 "Print only important dependencies; for use with <literal>unmet</literal> and "
1645 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1646 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1650 #: apt-cache.8.xml:290
1652 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1653 "print all dependencies. This can be tweaked with these flags which will omit "
1654 "the specified dependency type. Configuration Item: "
1655 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1656 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1659 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1660 #: apt-cache.8.xml:297
1662 "Print full package records when searching. Configuration Item: "
1663 "<literal>APT::Cache::ShowFull</literal>."
1666 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1667 #: apt-cache.8.xml:302
1669 "Print full records for all available versions. This is the default; to turn "
1670 "it off, use <option>--no-all-versions</option>. If "
1671 "<option>--no-all-versions</option> is specified, only the candidate version "
1672 "will be displayed (the one which would be selected for installation). This "
1673 "option is only applicable to the <literal>show</literal> command. "
1674 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1677 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1678 #: apt-cache.8.xml:311
1680 "Perform automatic package cache regeneration, rather than use the cache as "
1681 "it is. This is the default; to turn it off, use "
1682 "<option>--no-generate</option>. Configuration Item: "
1683 "<literal>APT::Cache::Generate</literal>."
1686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1687 #: apt-cache.8.xml:317
1689 "Only search on the package names, not the long descriptions. Configuration "
1690 "Item: <literal>APT::Cache::NamesOnly</literal>."
1693 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1694 #: apt-cache.8.xml:322
1696 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1697 "and missing dependencies. Configuration Item: "
1698 "<literal>APT::Cache::AllNames</literal>."
1701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1702 #: apt-cache.8.xml:328
1704 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1705 "that all packages mentioned are printed once. Configuration Item: "
1706 "<literal>APT::Cache::RecurseDepends</literal>."
1709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1710 #: apt-cache.8.xml:335
1712 "Limit the output of <literal>depends</literal> and "
1713 "<literal>rdepends</literal> to packages which are currently installed. "
1714 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1717 #. type: Content of: <refentry><refsect1><para>
1718 #: apt-cache.8.xml:353
1719 msgid "&apt-conf;, &sources-list;, &apt-get;"
1722 #. type: Content of: <refentry><refsect1><para>
1723 #: apt-cache.8.xml:358
1725 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1729 #. type: Content of: <refentry><refnamediv><refpurpose>
1731 msgid "APT key management utility"
1734 #. type: Content of: <refentry><refsect1><para>
1737 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1738 "authenticate packages. Packages which have been authenticated using these "
1739 "keys will be considered trusted."
1742 #. type: Content of: <refentry><refsect1><title>
1747 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1750 "Add a new key to the list of trusted keys. The key is read from the "
1751 "filename given with the parameter &synopsis-param-filename; or if the "
1752 "filename is <literal>-</literal> from standard input."
1755 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1757 msgid "Remove a key from the list of trusted keys."
1760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1762 msgid "Output the key &synopsis-param-keyid; to standard output."
1765 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1767 msgid "Output all trusted keys to standard output."
1770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1772 msgid "List trusted keys."
1775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1776 #: apt-key.8.xml:109
1777 msgid "List fingerprints of trusted keys."
1780 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1781 #: apt-key.8.xml:120
1783 "Pass advanced options to gpg. With adv --recv-key you can download the "
1787 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1788 #: apt-key.8.xml:132
1790 "Update the local keyring with the archive keyring and remove from the local "
1791 "keyring the archive keys which are no longer valid. The archive keyring is "
1792 "shipped in the <literal>archive-keyring</literal> package of your "
1793 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1796 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1797 #: apt-key.8.xml:146
1799 "Perform an update working similarly to the <command>update</command> command "
1800 "above, but get the archive keyring from a URI instead and validate it "
1801 "against a master key. This requires an installed &wget; and an APT build "
1802 "configured to have a server to fetch from and a master keyring to validate. "
1803 "APT in Debian does not support this command, relying on "
1804 "<command>update</command> instead, but Ubuntu's APT does."
1807 #. type: Content of: <refentry><refsect1><title>
1808 #: apt-key.8.xml:162 apt-cdrom.8.xml:82
1812 #. type: Content of: <refentry><refsect1><para>
1813 #: apt-key.8.xml:163
1815 "Note that options need to be defined before the commands described in the "
1819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1820 #: apt-key.8.xml:166
1822 "With this option it is possible to specify a particular keyring file the "
1823 "command should operate on. The default is that a command is executed on the "
1824 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1825 "<filename>trusted.gpg.d</filename> directory, though "
1826 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1827 "e.g. new keys are added to this one."
1830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1831 #: apt-key.8.xml:181
1832 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1836 #: apt-key.8.xml:182
1837 msgid "Local trust database of archive keys."
1840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1841 #: apt-key.8.xml:185
1842 msgid "&keyring-filename;"
1845 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1846 #: apt-key.8.xml:186
1847 msgid "Keyring of &keyring-distro; archive trusted keys."
1850 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1851 #: apt-key.8.xml:189
1852 msgid "&keyring-removed-filename;"
1855 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1856 #: apt-key.8.xml:190
1857 msgid "Keyring of &keyring-distro; archive removed trusted keys."
1860 #. type: Content of: <refentry><refsect1><para>
1861 #: apt-key.8.xml:199
1862 msgid "&apt-get;, &apt-secure;"
1865 #. type: Content of: <refentry><refnamediv><refpurpose>
1866 #: apt-mark.8.xml:35
1867 msgid "mark/unmark a package as being automatically-installed"
1870 #. type: Content of: <refentry><refsect1><para>
1871 #: apt-mark.8.xml:41
1873 "<command>apt-mark</command> will change whether a package has been marked as "
1874 "being automatically installed."
1877 #. type: Content of: <refentry><refsect1><para>
1878 #: apt-mark.8.xml:45
1880 "When you request that a package is installed, and as a result other packages "
1881 "are installed to satisfy its dependencies, the dependencies are marked as "
1882 "being automatically installed. Once these automatically installed packages "
1883 "are no longer depended on by any manually installed packages, they will be "
1884 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1887 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1888 #: apt-mark.8.xml:54
1890 "<literal>auto</literal> is used to mark a package as being automatically "
1891 "installed, which will cause the package to be removed when no more manually "
1892 "installed packages depend on this package."
1895 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1896 #: apt-mark.8.xml:62
1898 "<literal>manual</literal> is used to mark a package as being manually "
1899 "installed, which will prevent the package from being automatically removed "
1900 "if no other packages depend on it."
1903 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1904 #: apt-mark.8.xml:70
1906 "<literal>hold</literal> is used to mark a package as held back, which will "
1907 "prevent the package from being automatically installed, upgraded or "
1908 "removed. The command is only a wrapper around <command>dpkg "
1909 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1910 "and not affected by the <option>--file</option> option."
1913 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1914 #: apt-mark.8.xml:80
1916 "<literal>unhold</literal> is used to cancel a previously set hold on a "
1917 "package to allow all actions again."
1920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1921 #: apt-mark.8.xml:86
1923 "<literal>showauto</literal> is used to print a list of automatically "
1924 "installed packages with each package on a new line. All automatically "
1925 "installed packages will be listed if no package is given. If packages are "
1926 "given only those which are automatically installed will be shown."
1929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1930 #: apt-mark.8.xml:94
1932 "<literal>showmanual</literal> can be used in the same way as "
1933 "<literal>showauto</literal> except that it will print a list of manually "
1934 "installed packages instead."
1937 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1938 #: apt-mark.8.xml:101
1940 "<literal>showhold</literal> is used to print a list of packages on hold in "
1941 "the same way as for the other show commands."
1944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1945 #: apt-mark.8.xml:117
1947 "Read/Write package stats from the filename given with the parameter "
1948 "&synopsis-param-filename; instead of from the default location, which is "
1949 "<filename>extended_status</filename> in the directory defined by the "
1950 "Configuration Item: <literal>Dir::State</literal>."
1953 #. type: Content of: <refentry><refsect1><para>
1954 #: apt-mark.8.xml:138
1956 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
1960 #. type: Content of: <refentry><refnamediv><refpurpose>
1961 #: apt-secure.8.xml:49
1962 msgid "Archive authentication support for APT"
1965 #. type: Content of: <refentry><refsect1><para>
1966 #: apt-secure.8.xml:54
1968 "Starting with version 0.6, <command>apt</command> contains code that does "
1969 "signature checking of the Release file for all archives. This ensures that "
1970 "packages in the archive can't be modified by people who have no access to "
1971 "the Release file signing key."
1974 #. type: Content of: <refentry><refsect1><para>
1975 #: apt-secure.8.xml:62
1977 "If a package comes from a archive without a signature, or with a signature "
1978 "that apt does not have a key for, that package is considered untrusted, and "
1979 "installing it will result in a big warning. <command>apt-get</command> will "
1980 "currently only warn for unsigned archives; future releases might force all "
1981 "sources to be verified before downloading packages from them."
1984 #. type: Content of: <refentry><refsect1><para>
1985 #: apt-secure.8.xml:71
1987 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
1988 "authentication feature."
1991 #. type: Content of: <refentry><refsect1><title>
1992 #: apt-secure.8.xml:76
1993 msgid "Trusted archives"
1996 #. type: Content of: <refentry><refsect1><para>
1997 #: apt-secure.8.xml:79
1999 "The chain of trust from an apt archive to the end user is made up of several "
2000 "steps. <command>apt-secure</command> is the last step in this chain; "
2001 "trusting an archive does not mean that you trust its packages not to contain "
2002 "malicious code, but means that you trust the archive maintainer. It's the "
2003 "archive maintainer's responsibility to ensure that the archive's integrity "
2007 #. type: Content of: <refentry><refsect1><para>
2008 #: apt-secure.8.xml:87
2010 "apt-secure does not review signatures at a package level. If you require "
2011 "tools to do this you should look at <command>debsig-verify</command> and "
2012 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2013 "packages respectively)."
2016 #. type: Content of: <refentry><refsect1><para>
2017 #: apt-secure.8.xml:94
2019 "The chain of trust in Debian starts when a maintainer uploads a new package "
2020 "or a new version of a package to the Debian archive. In order to become "
2021 "effective, this upload needs to be signed by a key contained in the Debian "
2022 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
2023 "keys are signed by other maintainers following pre-established procedures to "
2024 "ensure the identity of the key holder."
2027 #. type: Content of: <refentry><refsect1><para>
2028 #: apt-secure.8.xml:104
2030 "Once the uploaded package is verified and included in the archive, the "
2031 "maintainer signature is stripped off, and checksums of the package are "
2032 "computed and put in the Packages file. The checksums of all of the Packages "
2033 "files are then computed and put into the Release file. The Release file is "
2034 "then signed by the archive key for this &keyring-distro; release, and "
2035 "distributed alongside the packages and the Packages files on "
2036 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2037 "keyring available in the &keyring-package; package."
2040 #. type: Content of: <refentry><refsect1><para>
2041 #: apt-secure.8.xml:115
2043 "End users can check the signature of the Release file, extract a checksum of "
2044 "a package from it and compare it with the checksum of the package they "
2045 "downloaded by hand - or rely on APT doing this automatically."
2048 #. type: Content of: <refentry><refsect1><para>
2049 #: apt-secure.8.xml:120
2051 "Notice that this is distinct from checking signatures on a per package "
2052 "basis. It is designed to prevent two possible attacks:"
2055 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2056 #: apt-secure.8.xml:125
2058 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2059 "checking, malicious agents can introduce themselves into the package "
2060 "download process and provide malicious software either by controlling a "
2061 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2062 "server (through ARP or DNS spoofing attacks)."
2065 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2066 #: apt-secure.8.xml:133
2068 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2069 "malicious agent can compromise a mirror host and modify the files in it to "
2070 "propagate malicious software to all users downloading packages from that "
2074 #. type: Content of: <refentry><refsect1><para>
2075 #: apt-secure.8.xml:140
2077 "However, it does not defend against a compromise of the Debian master server "
2078 "itself (which signs the packages) or against a compromise of the key used to "
2079 "sign the Release files. In any case, this mechanism can complement a "
2080 "per-package signature."
2083 #. type: Content of: <refentry><refsect1><title>
2084 #: apt-secure.8.xml:146
2085 msgid "User configuration"
2088 #. type: Content of: <refentry><refsect1><para>
2089 #: apt-secure.8.xml:148
2091 "<command>apt-key</command> is the program that manages the list of keys used "
2092 "by apt. It can be used to add or remove keys, although an installation of "
2093 "this release will automatically contain the default Debian archive signing "
2094 "keys used in the Debian package repositories."
2097 #. type: Content of: <refentry><refsect1><para>
2098 #: apt-secure.8.xml:155
2100 "In order to add a new key you need to first download it (you should make "
2101 "sure you are using a trusted communication channel when retrieving it), add "
2102 "it with <command>apt-key</command> and then run <command>apt-get "
2103 "update</command> so that apt can download and verify the "
2104 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2105 "from the archives you have configured."
2108 #. type: Content of: <refentry><refsect1><title>
2109 #: apt-secure.8.xml:164
2110 msgid "Archive configuration"
2113 #. type: Content of: <refentry><refsect1><para>
2114 #: apt-secure.8.xml:166
2116 "If you want to provide archive signatures in an archive under your "
2117 "maintenance you have to:"
2120 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2121 #: apt-secure.8.xml:171
2123 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2124 "already. You can do this by running <command>apt-ftparchive "
2125 "release</command> (provided in apt-utils)."
2128 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2129 #: apt-secure.8.xml:176
2131 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2132 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2133 "Release.gpg Release</command>."
2136 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2137 #: apt-secure.8.xml:180
2139 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
2140 "know what key they need to import in order to authenticate the files in the "
2144 #. type: Content of: <refentry><refsect1><para>
2145 #: apt-secure.8.xml:187
2147 "Whenever the contents of the archive change (new packages are added or "
2148 "removed) the archive maintainer has to follow the first two steps outlined "
2152 #. type: Content of: <refentry><refsect1><para>
2153 #: apt-secure.8.xml:195
2155 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2156 "&debsign;, &debsig-verify;, &gpg;"
2159 #. type: Content of: <refentry><refsect1><para>
2160 #: apt-secure.8.xml:199
2162 "For more background information you might want to review the <ulink "
2163 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2164 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2165 "(available also in the harden-doc package) and the <ulink "
2166 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2167 "Distribution HOWTO</ulink> by V. Alex Brennen."
2170 #. type: Content of: <refentry><refsect1><title>
2171 #: apt-secure.8.xml:212
2172 msgid "Manpage Authors"
2175 #. type: Content of: <refentry><refsect1><para>
2176 #: apt-secure.8.xml:214
2178 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2179 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2182 #. type: Content of: <refentry><refnamediv><refpurpose>
2183 #: apt-cdrom.8.xml:34
2184 msgid "APT CD-ROM management utility"
2187 #. type: Content of: <refentry><refsect1><para>
2188 #: apt-cdrom.8.xml:40
2190 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2191 "available sources. <command>apt-cdrom</command> takes care of determining "
2192 "the structure of the disc as well as correcting for several possible "
2193 "mis-burns and verifying the index files."
2196 #. type: Content of: <refentry><refsect1><para>
2197 #: apt-cdrom.8.xml:47
2199 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2200 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2201 "must be inserted and scanned separately to account for possible mis-burns."
2204 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2205 #: apt-cdrom.8.xml:58
2207 "<literal>add</literal> is used to add a new disc to the source list. It will "
2208 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2209 "to scan it and copy the index files. If the disc does not have a proper "
2210 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2214 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2215 #: apt-cdrom.8.xml:66
2217 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2218 "maintains a database of these IDs in "
2219 "<filename>&statedir;/cdroms.list</filename>"
2222 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2223 #: apt-cdrom.8.xml:74
2225 "A debugging tool to report the identity of the current disc as well as the "
2229 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2230 #: apt-cdrom.8.xml:87
2232 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2233 "<option>--cdrom</option> option. Configuration Item: "
2234 "<literal>Acquire::cdrom::AutoDetect</literal>."
2237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2238 #: apt-cdrom.8.xml:95
2240 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2241 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2242 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2245 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2246 #: apt-cdrom.8.xml:104
2248 "Rename a disc; change the label of a disc or override the disc's given "
2249 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2250 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2254 #: apt-cdrom.8.xml:113
2256 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2257 "unmounting the mount point. Configuration Item: "
2258 "<literal>APT::CDROM::NoMount</literal>."
2261 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2262 #: apt-cdrom.8.xml:121
2264 "Fast Copy; Assume the package files are valid and do not check every "
2265 "package. This option should be used only if <command>apt-cdrom</command> has "
2266 "been run on this disc before and did not detect any errors. Configuration "
2267 "Item: <literal>APT::CDROM::Fast</literal>."
2270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2271 #: apt-cdrom.8.xml:131
2273 "Thorough Package Scan; This option may be needed with some old Debian "
2274 "1.1/1.2 discs that have Package files in strange places. It takes much "
2275 "longer to scan the CD but will pick them all up."
2278 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2279 #: apt-cdrom.8.xml:142
2281 "No Changes; Do not change the &sources-list; file and do not write index "
2282 "files. Everything is still checked however. Configuration Item: "
2283 "<literal>APT::CDROM::NoAct</literal>."
2286 #. type: Content of: <refentry><refsect1><para>
2287 #: apt-cdrom.8.xml:155
2288 msgid "&apt-conf;, &apt-get;, &sources-list;"
2291 #. type: Content of: <refentry><refsect1><para>
2292 #: apt-cdrom.8.xml:160
2294 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2298 #. type: Content of: <refentry><refnamediv><refpurpose>
2299 #: apt-config.8.xml:35
2300 msgid "APT Configuration Query program"
2303 #. type: Content of: <refentry><refsect1><para>
2304 #: apt-config.8.xml:41
2306 "<command>apt-config</command> is an internal program used by various "
2307 "portions of the APT suite to provide consistent configurability. It accesses "
2308 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2309 "manner that is easy to use for scripted applications."
2312 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2313 #: apt-config.8.xml:53
2315 "shell is used to access the configuration information from a shell "
2316 "script. It is given pairs of arguments, the first being a shell variable and "
2317 "the second the configuration value to query. As output it lists shell "
2318 "assignment commands for each value present. In a shell script it should be "
2322 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2323 #: apt-config.8.xml:61
2327 "RES=`apt-config shell OPTS MyApp::options`\n"
2331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2332 #: apt-config.8.xml:66
2334 "This will set the shell environment variable $OPTS to the value of "
2335 "MyApp::options with a default of <option>-f</option>."
2338 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2339 #: apt-config.8.xml:70
2341 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2342 "names, d returns directories, b returns true or false and i returns an "
2343 "integer. Each of the returns is normalized and verified internally."
2346 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2347 #: apt-config.8.xml:79
2348 msgid "Just show the contents of the configuration space."
2351 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2352 #: apt-config.8.xml:92
2354 "Include options which have an empty value. This is the default, so use "
2355 "--no-empty to remove them from the output."
2358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2359 #: apt-config.8.xml:97
2360 msgid "%f "%v";%n"
2363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2364 #: apt-config.8.xml:98
2366 "Defines the output of each config option. %t will be replaced with "
2367 "its individual name, %f with its full hierarchical name and %v "
2368 "with its value. Use uppercase letters and special characters in the value "
2369 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2370 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2371 "and %N by a tab. A % can be printed by using %%."
2374 #. type: Content of: <refentry><refsect1><para>
2375 #: apt-config.8.xml:112 apt-extracttemplates.1.xml:73 apt-sortpkgs.1.xml:66 apt-ftparchive.1.xml:610
2379 #. type: Content of: <refentry><refsect1><para>
2380 #: apt-config.8.xml:117
2382 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2386 #. type: Content of: <refentry><refentryinfo><author><contrib>
2387 #: apt.conf.5.xml:22
2388 msgid "Initial documentation of Debug::*."
2391 #. type: Content of: <refentry><refentryinfo><author><email>
2392 #: apt.conf.5.xml:23
2393 msgid "dburrows@debian.org"
2396 #. type: Content of: <refentry><refmeta><manvolnum>
2397 #: apt.conf.5.xml:33 apt_preferences.5.xml:27 sources.list.5.xml:28
2401 #. type: Content of: <refentry><refnamediv><refpurpose>
2402 #: apt.conf.5.xml:40
2403 msgid "Configuration file for APT"
2406 #. type: Content of: <refentry><refsect1><para>
2407 #: apt.conf.5.xml:44
2409 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2410 "by all the tools in the APT suite of tools, though it is by no means the "
2411 "only place options can be set. The suite also shares a common command line "
2412 "parser to provide a uniform environment."
2415 #. type: Content of: <refentry><refsect1><orderedlist><para>
2416 #: apt.conf.5.xml:50
2418 "When an APT tool starts up it will read the configuration files in the "
2422 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2423 #: apt.conf.5.xml:52
2425 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2429 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2430 #: apt.conf.5.xml:54
2432 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2433 "order which have either no or \"<literal>conf</literal>\" as filename "
2434 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2435 "and period (.) characters. Otherwise APT will print a notice that it has "
2436 "ignored a file, unless that file matches a pattern in the "
2437 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2438 "case it will be silently ignored."
2441 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2442 #: apt.conf.5.xml:61
2443 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2446 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2447 #: apt.conf.5.xml:63
2449 "the command line options are applied to override the configuration "
2450 "directives or to load even more configuration files."
2453 #. type: Content of: <refentry><refsect1><title>
2454 #: apt.conf.5.xml:67
2458 #. type: Content of: <refentry><refsect1><para>
2459 #: apt.conf.5.xml:68
2461 "The configuration file is organized in a tree with options organized into "
2462 "functional groups. Option specification is given with a double colon "
2463 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2464 "within the APT tool group, for the Get tool. Options do not inherit from "
2465 "their parent groups."
2468 #. type: Content of: <refentry><refsect1><para>
2469 #: apt.conf.5.xml:74
2471 "Syntactically the configuration language is modeled after what the ISC tools "
2472 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2473 "treated as comments (ignored), as well as all text between "
2474 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2475 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2476 "The quotation marks and trailing semicolon are required. The value must be "
2477 "on one line, and there is no kind of string concatenation. Values must not "
2478 "include backslashes or extra quotation marks. Option names are made up of "
2479 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2480 "opened with curly braces, like this:"
2483 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2484 #: apt.conf.5.xml:87
2489 " Assume-Yes \"true\";\n"
2490 " Fix-Broken \"true\";\n"
2495 #. type: Content of: <refentry><refsect1><para>
2496 #: apt.conf.5.xml:95
2498 "with newlines placed to make it more readable. Lists can be created by "
2499 "opening a scope and including a single string enclosed in quotes followed by "
2500 "a semicolon. Multiple entries can be included, separated by a semicolon."
2503 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2504 #: apt.conf.5.xml:100
2506 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2509 #. type: Content of: <refentry><refsect1><para>
2510 #: apt.conf.5.xml:103
2512 "In general the sample configuration file &configureindex; is a good guide "
2513 "for how it should look."
2516 #. type: Content of: <refentry><refsect1><para>
2517 #: apt.conf.5.xml:106
2519 "Case is not significant in names of configuration items, so in the previous "
2520 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2523 #. type: Content of: <refentry><refsect1><para>
2524 #: apt.conf.5.xml:109
2526 "Names for the configuration items are optional if a list is defined as can "
2527 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2528 "you don't specify a name a new entry will simply add a new option to the "
2529 "list. If you specify a name you can override the option in the same way as "
2530 "any other option by reassigning a new value to the option."
2533 #. type: Content of: <refentry><refsect1><para>
2534 #: apt.conf.5.xml:114
2536 "Two special commands are defined: <literal>#include</literal> (which is "
2537 "deprecated and not supported by alternative implementations) and "
2538 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2539 "given file, unless the filename ends in a slash, in which case the whole "
2540 "directory is included. <literal>#clear</literal> is used to erase a part of "
2541 "the configuration tree. The specified element and all its descendants are "
2542 "erased. (Note that these lines also need to end with a semicolon.)"
2545 #. type: Content of: <refentry><refsect1><para>
2546 #: apt.conf.5.xml:124
2548 "The <literal>#clear</literal> command is the only way to delete a list or a "
2549 "complete scope. Reopening a scope (or using the syntax described below with "
2550 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2551 "previously written entries. Options can only be overridden by addressing a "
2552 "new value to them - lists and scopes can't be overridden, only cleared."
2555 #. type: Content of: <refentry><refsect1><para>
2556 #: apt.conf.5.xml:132
2558 "All of the APT tools take an -o option which allows an arbitrary "
2559 "configuration directive to be specified on the command line. The syntax is a "
2560 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2561 "followed by an equals sign then the new value of the option. To append a new "
2562 "element to a list, add a trailing <literal>::</literal> to the name of the "
2563 "list. (As you might suspect, the scope syntax can't be used on the command "
2567 #. type: Content of: <refentry><refsect1><para>
2568 #: apt.conf.5.xml:140
2570 "Note that appending items to a list using <literal>::</literal> only works "
2571 "for one item per line, and that you should not use it in combination with "
2572 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2573 "syntaxes together will trigger a bug which some users unfortunately depend "
2574 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2575 "like every other option with a name. This introduces many problems; for one "
2576 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2577 "syntax in the hope of appending to a list will achieve the opposite, as only "
2578 "the last assignment for this option \"<literal>::</literal>\" will be "
2579 "used. Future versions of APT will raise errors and stop working if they "
2580 "encounter this misuse, so please correct such statements now while APT "
2581 "doesn't explicitly complain about them."
2584 #. type: Content of: <refentry><refsect1><title>
2585 #: apt.conf.5.xml:155
2586 msgid "The APT Group"
2589 #. type: Content of: <refentry><refsect1><para>
2590 #: apt.conf.5.xml:156
2592 "This group of options controls general APT behavior as well as holding the "
2593 "options for all of the tools."
2596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2597 #: apt.conf.5.xml:161
2599 "System Architecture; sets the architecture to use when fetching files and "
2600 "parsing package lists. The internal default is the architecture apt was "
2604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2605 #: apt.conf.5.xml:168
2607 "All Architectures the system supports. For instance, CPUs implementing the "
2608 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2609 "instruction set are also able to execute binaries compiled for the "
2610 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2611 "is used when fetching files and parsing package lists. The initial default "
2612 "is always the system's native architecture "
2613 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2614 "to the default list when they are registered via <command>dpkg "
2615 "--add-architecture</command>."
2618 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2619 #: apt.conf.5.xml:182
2621 "List of all build profiles enabled for build-dependency resolution, without "
2622 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2623 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2624 "&dpkg-buildpackage; overrides the list notation."
2627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2628 #: apt.conf.5.xml:190
2630 "Default release to install packages from if more than one version is "
2631 "available. Contains release name, codename or release version. Examples: "
2632 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2633 "'4.0', '5.0*'. See also &apt-preferences;."
2636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2637 #: apt.conf.5.xml:196
2639 "Ignore held packages; this global option causes the problem resolver to "
2640 "ignore held packages in its decision making."
2643 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2644 #: apt.conf.5.xml:201
2646 "Defaults to on. When turned on the autoclean feature will remove any "
2647 "packages which can no longer be downloaded from the cache. If turned off "
2648 "then packages that are locally installed are also excluded from cleaning - "
2649 "but note that APT provides no direct means to reinstall them."
2652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2653 #: apt.conf.5.xml:209
2655 "Defaults to on, which will cause APT to install essential and important "
2656 "packages as soon as possible in an install/upgrade operation, in order to "
2657 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2658 "treats an important package in the same way as an extra package: between the "
2659 "unpacking of the package A and its configuration there can be many other "
2660 "unpack or configuration calls for other unrelated packages B, C etc. If "
2661 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2662 "scripts generate an error), this results in a system state in which package "
2663 "A is unpacked but unconfigured - so any package depending on A is now no "
2664 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2668 #: apt.conf.5.xml:221
2670 "The immediate configuration marker is also applied in the potentially "
2671 "problematic case of circular dependencies, since a dependency with the "
2672 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2673 "to recognise a situation in which it is unable to perform immediate "
2674 "configuration, abort, and suggest to the user that the option should be "
2675 "temporarily deactivated in order to allow the operation to proceed. Note "
2676 "the use of the word \"theory\" here; in the real world this problem has "
2677 "rarely been encountered, in non-stable distribution versions, and was caused "
2678 "by wrong dependencies of the package in question or by a system in an "
2679 "already broken state; so you should not blindly disable this option, as the "
2680 "scenario mentioned above is not the only problem it can help to prevent in "
2684 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2685 #: apt.conf.5.xml:234
2687 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2688 "option disabled you should try to explicitly <literal>install</literal> the "
2689 "package APT is unable to configure immediately; but please make sure you "
2690 "also report your problem to your distribution and to the APT team with the "
2691 "buglink below, so they can work on improving or correcting the upgrade "
2695 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2696 #: apt.conf.5.xml:245
2698 "Never enable this option unless you <emphasis>really</emphasis> know what "
2699 "you are doing. It permits APT to temporarily remove an essential package to "
2700 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2701 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2702 "bug</emphasis>. This option will work if the essential packages are not "
2703 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2704 "<command>dpkg</command>, <command>dash</command> or anything that those "
2705 "packages depend on."
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2709 #: apt.conf.5.xml:257
2711 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2712 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2713 "the size the cache will grow to, and is therefore the amount of memory APT "
2714 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2715 "that this amount of space needs to be available for APT; otherwise it will "
2716 "likely fail ungracefully, so for memory restricted devices this value should "
2717 "be lowered while on systems with a lot of configured sources it should be "
2718 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2719 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2720 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2721 "value will be applied again and again until either the cache is big enough "
2722 "to store all information or the size of the cache reaches the "
2723 "<literal>Cache-Limit</literal>. The default of "
2724 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2725 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2729 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2730 #: apt.conf.5.xml:273
2731 msgid "Defines which packages are considered essential build dependencies."
2734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2735 #: apt.conf.5.xml:277
2737 "The Get subsection controls the &apt-get; tool; please see its documentation "
2738 "for more information about the options here."
2741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2742 #: apt.conf.5.xml:282
2744 "The Cache subsection controls the &apt-cache; tool; please see its "
2745 "documentation for more information about the options here."
2748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2749 #: apt.conf.5.xml:287
2751 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2752 "documentation for more information about the options here."
2755 #. type: Content of: <refentry><refsect1><title>
2756 #: apt.conf.5.xml:293
2757 msgid "The Acquire Group"
2760 #. type: Content of: <refentry><refsect1><para>
2761 #: apt.conf.5.xml:294
2763 "The <literal>Acquire</literal> group of options controls the download of "
2764 "packages as well as the various \"acquire methods\" responsible for the "
2765 "download itself (see also &sources-list;)."
2768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2769 #: apt.conf.5.xml:301
2771 "Security related option defaulting to true, as giving a Release file's "
2772 "validation an expiration date prevents replay attacks over a long timescale, "
2773 "and can also for example help users to identify mirrors that are no longer "
2774 "updated - but the feature depends on the correctness of the clock on the "
2775 "user system. Archive maintainers are encouraged to create Release files with "
2776 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2777 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2781 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2782 #: apt.conf.5.xml:314
2784 "Maximum time (in seconds) after its creation (as indicated by the "
2785 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2786 "should be considered valid. If the Release file itself includes a "
2787 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2788 "the expiration date. The default value is <literal>0</literal> which stands "
2789 "for \"valid forever\". Archive specific settings can be made by appending "
2790 "the label of the archive to the option name."
2793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2794 #: apt.conf.5.xml:326
2796 "Minimum time (in seconds) after its creation (as indicated by the "
2797 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2798 "should be considered valid. Use this if you need to use a seldom updated "
2799 "(local) mirror of a more frequently updated archive with a "
2800 "<literal>Valid-Until</literal> header instead of completely disabling the "
2801 "expiration date checking. Archive specific settings can and should be used "
2802 "by appending the label of the archive to the option name."
2805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2806 #: apt.conf.5.xml:338
2808 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2809 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2814 #: apt.conf.5.xml:341
2816 "Two sub-options to limit the use of PDiffs are also available: "
2817 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2818 "PDiff files should be downloaded to update a "
2819 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2820 "percentage of the size of all patches compared to the size of the targeted "
2821 "file. If one of these limits is exceeded the complete file is downloaded "
2822 "instead of the patches."
2825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2826 #: apt.conf.5.xml:351
2828 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2829 "<literal>host</literal> or <literal>access</literal> which determines how "
2830 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2831 "one connection per target host will be opened, <literal>access</literal> "
2832 "means that one connection per URI type will be opened."
2835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2836 #: apt.conf.5.xml:359
2838 "Number of retries to perform. If this is non-zero APT will retry failed "
2839 "files the given number of times."
2842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2843 #: apt.conf.5.xml:364
2845 "Use symlinks for source archives. If set to true then source archives will "
2846 "be symlinked when possible instead of copying. True is the default."
2849 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2850 #: apt.conf.5.xml:369
2852 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2853 "URIs. It is in the standard form of "
2854 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2855 "can also be specified by using the form "
2856 "<literal>http::Proxy::<host></literal> with the special keyword "
2857 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2858 "settings is specified, <envar>http_proxy</envar> environment variable will "
2862 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2863 #: apt.conf.5.xml:377
2865 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2866 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2867 "response under any circumstances. <literal>Max-Age</literal> sets the "
2868 "allowed maximum age (in seconds) of an index file in the cache of the "
2869 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2870 "store the requested archive files in its cache, which can be used to prevent "
2871 "the proxy from polluting its cache with (big) .deb files."
2874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2875 #: apt.conf.5.xml:387 apt.conf.5.xml:475
2877 "The option <literal>timeout</literal> sets the timeout timer used by the "
2878 "method; this value applies to the connection as well as the data timeout."
2881 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2882 #: apt.conf.5.xml:390
2884 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2885 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2886 "e.g. on high-latency connections. It specifies how many requests are sent in "
2887 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
2888 "the default value is now 0 (= disabled) to avoid problems with the "
2889 "ever-growing amount of webservers and proxies which choose to not conform to "
2890 "the HTTP/1.1 specification."
2893 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2894 #: apt.conf.5.xml:397
2896 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
2897 "follow redirects, which is enabled by default."
2900 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2901 #: apt.conf.5.xml:400
2903 "The used bandwidth can be limited with "
2904 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
2905 "kilobytes per second. The default value is 0 which deactivates the limit and "
2906 "tries to use all available bandwidth. Note that this option implicitly "
2907 "disables downloading from multiple servers at the same time."
2910 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2911 #: apt.conf.5.xml:407
2913 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
2914 "User-Agent for the http download method as some proxies allow access for "
2915 "clients only if the client uses a known identifier."
2918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2919 #: apt.conf.5.xml:411
2921 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
2922 "an external command to discover the http proxy to use. Apt expects the "
2923 "command to output the proxy on stdout in the style "
2924 "<literal>http://proxy:port/</literal>. This will override the generic "
2925 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
2926 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
2927 "the &squid-deb-proxy-client; package for an example implementation that uses "
2928 "avahi. This option takes precedence over the legacy option name "
2929 "<literal>ProxyAutoDetect</literal>."
2932 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2933 #: apt.conf.5.xml:429
2935 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
2936 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
2937 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
2938 "the <literal>http</literal> method, and default to the same values if they "
2939 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
2943 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2944 #: apt.conf.5.xml:437
2946 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
2947 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
2948 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
2949 "suboption determines whether or not the server's host certificate should be "
2950 "verified against trusted certificates. "
2951 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
2952 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
2953 "or not the server's hostname should be verified. "
2954 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
2955 "option. <literal>SslCert</literal> determines what certificate to use for "
2956 "client authentication. <literal><host>::SslCert</literal> is the "
2957 "corresponding per-host option. <literal>SslKey</literal> determines what "
2958 "private key to use for client "
2959 "authentication. <literal><host>::SslKey</literal> is the corresponding "
2960 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
2961 "version to use. It can contain either of the strings "
2962 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
2963 "<literal><host>::SslForceVersion</literal> is the corresponding "
2967 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2968 #: apt.conf.5.xml:458
2970 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
2971 "It is in the standard form of "
2972 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
2973 "also be specified by using the form "
2974 "<literal>ftp::Proxy::<host></literal> with the special keyword "
2975 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2976 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
2977 "used. To use an FTP proxy you will have to set the "
2978 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
2979 "entry specifies the commands to send to tell the proxy server what to "
2980 "connect to. Please see &configureindex; for an example of how to do "
2981 "this. The substitution variables representing the corresponding URI "
2982 "component are <literal>$(PROXY_USER)</literal>, "
2983 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
2984 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
2985 "<literal>$(SITE_PORT)</literal>."
2988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2989 #: apt.conf.5.xml:478
2991 "Several settings are provided to control passive mode. Generally it is safe "
2992 "to leave passive mode on; it works in nearly every environment. However, "
2993 "some situations require that passive mode be disabled and port mode FTP used "
2994 "instead. This can be done globally or for connections that go through a "
2995 "proxy or for a specific host (see the sample config file for examples)."
2998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2999 #: apt.conf.5.xml:485
3001 "It is possible to proxy FTP over HTTP by setting the "
3002 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3003 "discussion of the http method above for syntax. You cannot set this in the "
3004 "configuration file and it is not recommended to use FTP over HTTP due to its "
3008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3009 #: apt.conf.5.xml:490
3011 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3012 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3013 "false, which means these commands are only used if the control connection is "
3014 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3015 "that most FTP servers do not support RFC2428."
3018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3019 #: apt.conf.5.xml:504
3021 msgid "/cdrom/::Mount \"foo\";"
3024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3025 #: apt.conf.5.xml:499
3027 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3028 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3029 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3030 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3031 "and unmount commands if your mount point cannot be listed in the fstab. The "
3032 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3033 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3034 "Unmount commands can be specified using UMount."
3037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3038 #: apt.conf.5.xml:512
3040 "For GPGV URIs the only configurable option is "
3041 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3046 #: apt.conf.5.xml:523
3049 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3050 "\"<replaceable>Methodname</replaceable>\";"
3053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3054 #: apt.conf.5.xml:518
3056 "List of compression types which are understood by the acquire methods. "
3057 "Files like <filename>Packages</filename> can be available in various "
3058 "compression formats. By default the acquire methods can decompress "
3059 "<command>bzip2</command>, <command>lzma</command> and "
3060 "<command>gzip</command> compressed files; with this setting more formats can "
3061 "be added on the fly or the used method can be changed. The syntax for this "
3062 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3065 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3066 #: apt.conf.5.xml:528
3068 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3072 #: apt.conf.5.xml:531
3074 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3078 #: apt.conf.5.xml:524
3080 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3081 "order the acquire system will try to download the compressed files. The "
3082 "acquire system will try the first and proceed with the next compression type "
3083 "in this list on error, so to prefer one over the other type simply add the "
3084 "preferred type first - default types not already added will be implicitly "
3085 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3086 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3087 "over <command>bzip2</command> and <command>lzma</command>. If "
3088 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3089 "<command>bzip2</command> the configure setting should look like this: "
3090 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3091 "<literal>bz2</literal> to the list explicitly as it will be added "
3095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3096 #: apt.conf.5.xml:538
3098 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3102 #: apt.conf.5.xml:533
3105 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3106 "checked at run time. If this option has been set, the method will only be "
3107 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
3108 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
3109 "also that list entries specified on the command line will be added at the "
3110 "end of the list specified in the configuration files, but before the default "
3111 "entries. To prefer a type in this case over the ones specified in the "
3112 "configuration files you can set the option direct - not in list style. This "
3113 "will not override the defined list; it will only prefix the list with this "
3117 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3118 #: apt.conf.5.xml:543
3120 "The special type <literal>uncompressed</literal> can be used to give "
3121 "uncompressed files a preference, but note that most archives don't provide "
3122 "uncompressed files so this is mostly only useable for local mirrors."
3125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3126 #: apt.conf.5.xml:550
3128 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3129 "Sources, or Translations), keep them gzip compressed locally instead of "
3130 "unpacking them. This saves quite a lot of disk space at the expense of more "
3131 "CPU requirements when building the local package caches. False by default."
3134 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3135 #: apt.conf.5.xml:558
3137 "The Languages subsection controls which <filename>Translation</filename> "
3138 "files are downloaded and in which order APT tries to display the "
3139 "description-translations. APT will try to display the first available "
3140 "description in the language which is listed first. Languages can be defined "
3141 "with their short or long language codes. Note that not all archives provide "
3142 "<filename>Translation</filename> files for every language - the long "
3143 "language codes are especially rare."
3146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3147 #: apt.conf.5.xml:575
3149 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3153 #: apt.conf.5.xml:563
3155 "The default list includes \"environment\" and "
3156 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3157 "will be replaced at runtime with the language codes extracted from the "
3158 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3159 "that these codes are not included twice in the list. If "
3160 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3161 "<filename>Translation-en</filename> file (if available) will be used. To "
3162 "force APT to use no Translation file use the setting "
3163 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3164 "another special meaning code which will stop the search for a suitable "
3165 "<filename>Translation</filename> file. This tells APT to download these "
3166 "translations too, without actually using them unless the environment "
3167 "specifies the languages. So the following example configuration will result "
3168 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3169 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3170 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3171 "type=\"programlisting\" id=\"0\"/>"
3174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3175 #: apt.conf.5.xml:576
3177 "Note: To prevent problems resulting from APT being executed in different "
3178 "environments (e.g. by different users or by other programs) all Translation "
3179 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3180 "added to the end of the list (after an implicit "
3181 "\"<literal>none</literal>\")."
3184 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3185 #: apt.conf.5.xml:585
3186 msgid "When downloading, force to use only the IPv4 protocol."
3189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3190 #: apt.conf.5.xml:591
3191 msgid "When downloading, force to use only the IPv6 protocol."
3194 #. type: Content of: <refentry><refsect1><title>
3195 #: apt.conf.5.xml:598
3199 #. type: Content of: <refentry><refsect1><para>
3200 #: apt.conf.5.xml:600
3202 "The <literal>Dir::State</literal> section has directories that pertain to "
3203 "local state information. <literal>lists</literal> is the directory to place "
3204 "downloaded package lists in and <literal>status</literal> is the name of the "
3205 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3206 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3207 "contains the default directory to prefix on all sub-items if they do not "
3208 "start with <filename>/</filename> or <filename>./</filename>."
3211 #. type: Content of: <refentry><refsect1><para>
3212 #: apt.conf.5.xml:607
3214 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3215 "information, such as the two package caches <literal>srcpkgcache</literal> "
3216 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3217 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3218 "be turned off by setting their names to the empty string. This will slow "
3219 "down startup but save disk space. It is probably preferable to turn off the "
3220 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3221 "default directory is contained in <literal>Dir::Cache</literal>"
3224 #. type: Content of: <refentry><refsect1><para>
3225 #: apt.conf.5.xml:616
3227 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3228 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3229 "<literal>main</literal> is the default configuration file (setting has no "
3230 "effect, unless it is done from the config file specified by "
3231 "<envar>APT_CONFIG</envar>)."
3234 #. type: Content of: <refentry><refsect1><para>
3235 #: apt.conf.5.xml:622
3237 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3238 "in lexical order from the directory specified. After this is done then the "
3239 "main config file is loaded."
3242 #. type: Content of: <refentry><refsect1><para>
3243 #: apt.conf.5.xml:626
3245 "Binary programs are pointed to by "
3246 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3247 "the location of the method handlers and <literal>gzip</literal>, "
3248 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3249 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3250 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3251 "specify the location of the respective programs."
3254 #. type: Content of: <refentry><refsect1><para>
3255 #: apt.conf.5.xml:634
3257 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3258 "set, all paths in <literal>Dir::</literal> will be relative to "
3259 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3260 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3261 "set to <filename>/tmp/staging</filename> and "
3262 "<literal>Dir::State::status</literal> is set to "
3263 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3264 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
3267 #. type: Content of: <refentry><refsect1><para>
3268 #: apt.conf.5.xml:647
3270 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3271 "which files APT should silently ignore while parsing the files in the "
3272 "fragment directories. Per default a file which end with "
3273 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3274 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3275 "default value these patterns can use regular expression syntax."
3278 #. type: Content of: <refentry><refsect1><title>
3279 #: apt.conf.5.xml:656
3280 msgid "APT in DSelect"
3283 #. type: Content of: <refentry><refsect1><para>
3284 #: apt.conf.5.xml:658
3286 "When APT is used as a &dselect; method several configuration directives "
3287 "control the default behavior. These are in the <literal>DSelect</literal> "
3291 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3292 #: apt.conf.5.xml:663
3294 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3295 "<literal>prompt</literal>, <literal>auto</literal>, "
3296 "<literal>pre-auto</literal> and <literal>never</literal>. "
3297 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3298 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3299 "default) does so conditionally. <literal>auto</literal> removes only those "
3300 "packages which are no longer downloadable (replaced with a new version for "
3301 "instance). <literal>pre-auto</literal> performs this action before "
3302 "downloading new packages."
3305 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3306 #: apt.conf.5.xml:677
3308 "The contents of this variable are passed to &apt-get; as command line "
3309 "options when it is run for the install phase."
3312 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3313 #: apt.conf.5.xml:682
3315 "The contents of this variable are passed to &apt-get; as command line "
3316 "options when it is run for the update phase."
3319 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3320 #: apt.conf.5.xml:687
3322 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3323 "The default is to prompt only on error."
3326 #. type: Content of: <refentry><refsect1><title>
3327 #: apt.conf.5.xml:693
3328 msgid "How APT calls &dpkg;"
3331 #. type: Content of: <refentry><refsect1><para>
3332 #: apt.conf.5.xml:694
3334 "Several configuration directives control how APT invokes &dpkg;. These are "
3335 "in the <literal>DPkg</literal> section."
3338 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3339 #: apt.conf.5.xml:699
3341 "This is a list of options to pass to &dpkg;. The options must be specified "
3342 "using the list notation and each list item is passed as a single argument to "
3346 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3347 #: apt.conf.5.xml:705
3349 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3350 "<literal>options</literal> this must be specified in list notation. The "
3351 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3352 "fail APT will abort."
3355 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3356 #: apt.conf.5.xml:712
3358 "This is a list of shell commands to run before invoking &dpkg;. Like "
3359 "<literal>options</literal> this must be specified in list notation. The "
3360 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3361 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3362 "going to install to the commands, one per line on the requested file "
3363 "descriptor, defaulting to standard input."
3366 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3367 #: apt.conf.5.xml:719
3369 "Version 2 of this protocol dumps more information, including the protocol "
3370 "version, the APT configuration space and the packages, files and versions "
3371 "being changed. Version 3 adds the architecture and "
3372 "<literal>MultiArch</literal> flag to each version being dumped."
3375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3376 #: apt.conf.5.xml:724
3378 "The version of the protocol to be used for the command "
3379 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3380 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3381 "accordingly, the default being version 1. If APT isn't supporting the "
3382 "requested version it will send the information in the highest version it has "
3383 "support for instead."
3386 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3387 #: apt.conf.5.xml:731
3389 "The file descriptor to be used to send the information can be requested with "
3390 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3391 "which defaults to <literal>0</literal> for standard input and is available "
3392 "since version 0.9.11. Support for the option can be detected by looking for "
3393 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3394 "number of the used file descriptor as a confirmation."
3397 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3398 #: apt.conf.5.xml:741
3400 "APT chdirs to this directory before invoking &dpkg;, the default is "
3401 "<filename>/</filename>."
3404 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3405 #: apt.conf.5.xml:746
3407 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3408 "default is to disable signing and produce all binaries."
3411 #. type: Content of: <refentry><refsect1><refsect2><title>
3412 #: apt.conf.5.xml:751
3413 msgid "dpkg trigger usage (and related options)"
3416 #. type: Content of: <refentry><refsect1><refsect2><para>
3417 #: apt.conf.5.xml:752
3419 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3420 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3421 "use triggers once each time it runs. Activating these options can therefore "
3422 "decrease the time needed to perform the install or upgrade. Note that it is "
3423 "intended to activate these options per default in the future, but as it "
3424 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3425 "<emphasis>These options are therefore currently experimental and should not "
3426 "be used in production environments.</emphasis> It also breaks progress "
3427 "reporting such that all front-ends will currently stay around half (or more) "
3428 "of the time in the 100% state while it actually configures all packages."
3431 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3432 #: apt.conf.5.xml:767
3435 "DPkg::NoTriggers \"true\";\n"
3436 "PackageManager::Configure \"smart\";\n"
3437 "DPkg::ConfigurePending \"true\";\n"
3438 "DPkg::TriggersPending \"true\";"
3441 #. type: Content of: <refentry><refsect1><refsect2><para>
3442 #: apt.conf.5.xml:761
3444 "Note that it is not guaranteed that APT will support these options or that "
3445 "these options will not cause (big) trouble in the future. If you have "
3446 "understand the current risks and problems with these options, but are brave "
3447 "enough to help testing them, create a new configuration file and test a "
3448 "combination of options. Please report any bugs, problems and improvements "
3449 "you encounter and make sure to note which options you have used in your "
3450 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3451 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3452 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3455 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3456 #: apt.conf.5.xml:774
3458 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3459 "call). See &dpkg; if you are interested in what this actually means. In "
3460 "short: &dpkg; will not run the triggers when this flag is present unless it "
3461 "is explicitly called to do so in an extra call. Note that this option "
3462 "exists (undocumented) also in older APT versions with a slightly different "
3463 "meaning: Previously these option only append --no-triggers to the configure "
3464 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3468 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3469 #: apt.conf.5.xml:782
3471 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3472 "and \"<literal>no</literal>\". The default value is "
3473 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3474 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3475 "be configured before another package can be unpacked (Pre-Depends), and let "
3476 "the rest be configured by &dpkg; with a call generated by the "
3477 "ConfigurePending option (see below). On the other hand, "
3478 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3479 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3480 "encountered). Setting this option to any value other than "
3481 "<literal>all</literal> will implicitly also activate the next option by "
3482 "default, as otherwise the system could end in an unconfigured and "
3483 "potentially unbootable state."
3486 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3487 #: apt.conf.5.xml:797
3489 "If this option is set APT will call <command>dpkg --configure "
3490 "--pending</command> to let &dpkg; handle all required configurations and "
3491 "triggers. This option is activated automatically per default if the previous "
3492 "option is not set to <literal>all</literal>, but deactivating it could be "
3493 "useful if you want to run APT multiple times in a row - e.g. in an "
3494 "installer. In these sceneries you could deactivate this option in all but "
3498 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3499 #: apt.conf.5.xml:804
3501 "Useful for the <literal>smart</literal> configuration as a package which has "
3502 "pending triggers is not considered as <literal>installed</literal>, and "
3503 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3504 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3505 "process all triggers, not only the triggers needed to configure this "
3509 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3510 #: apt.conf.5.xml:817
3513 "OrderList::Score {\n"
3515 "\tEssential 200;\n"
3517 "\tPreDepends 50;\n"
3521 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3522 #: apt.conf.5.xml:810
3524 "Essential packages (and their dependencies) should be configured immediately "
3525 "after unpacking. It is a good idea to do this quite early in the upgrade "
3526 "process as these configure calls also currently require "
3527 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3528 "(which may not be needed). Essentials get per default a high score but the "
3529 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3530 "higher). These option and the others in the same group can be used to "
3531 "change the scoring. The following example shows the settings with their "
3532 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3535 #. type: Content of: <refentry><refsect1><title>
3536 #: apt.conf.5.xml:830
3537 msgid "Periodic and Archives options"
3540 #. type: Content of: <refentry><refsect1><para>
3541 #: apt.conf.5.xml:831
3543 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3544 "of options configure behavior of apt periodic updates, which is done by the "
3545 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3546 "for the brief documentation of these options."
3549 #. type: Content of: <refentry><refsect1><title>
3550 #: apt.conf.5.xml:839
3551 msgid "Debug options"
3554 #. type: Content of: <refentry><refsect1><para>
3555 #: apt.conf.5.xml:841
3557 "Enabling options in the <literal>Debug::</literal> section will cause "
3558 "debugging information to be sent to the standard error stream of the program "
3559 "utilizing the <literal>apt</literal> libraries, or enable special program "
3560 "modes that are primarily useful for debugging the behavior of "
3561 "<literal>apt</literal>. Most of these options are not interesting to a "
3562 "normal user, but a few may be:"
3565 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3566 #: apt.conf.5.xml:852
3568 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3569 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3573 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3574 #: apt.conf.5.xml:860
3576 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3577 "used to run some operations (for instance, <literal>apt-get -s "
3578 "install</literal>) as a non-root user."
3581 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3582 #: apt.conf.5.xml:869
3584 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3585 "time that <literal>apt</literal> invokes &dpkg;."
3589 #. motivating example, except I haven't a clue why you'd want
3591 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3592 #: apt.conf.5.xml:877
3594 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3598 #. type: Content of: <refentry><refsect1><para>
3599 #: apt.conf.5.xml:887
3600 msgid "A full list of debugging options to apt follows."
3603 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3604 #: apt.conf.5.xml:896
3605 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3609 #: apt.conf.5.xml:907
3610 msgid "Print information related to downloading packages using FTP."
3613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3614 #: apt.conf.5.xml:918
3615 msgid "Print information related to downloading packages using HTTP."
3618 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3619 #: apt.conf.5.xml:929
3620 msgid "Print information related to downloading packages using HTTPS."
3623 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3624 #: apt.conf.5.xml:940
3626 "Print information related to verifying cryptographic signatures using "
3627 "<literal>gpg</literal>."
3630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3631 #: apt.conf.5.xml:951
3633 "Output information about the process of accessing collections of packages "
3634 "stored on CD-ROMs."
3637 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3638 #: apt.conf.5.xml:961
3639 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3642 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3643 #: apt.conf.5.xml:971
3645 "Output each cryptographic hash that is generated by the "
3646 "<literal>apt</literal> libraries."
3649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3650 #: apt.conf.5.xml:981
3652 "Do not include information from <literal>statfs</literal>, namely the number "
3653 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3658 #: apt.conf.5.xml:992
3660 "Disable all file locking. For instance, this will allow two instances of "
3661 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3665 #: apt.conf.5.xml:1004
3666 msgid "Log when items are added to or removed from the global download queue."
3669 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3670 #: apt.conf.5.xml:1014
3672 "Output status messages and errors related to verifying checksums and "
3673 "cryptographic signatures of downloaded files."
3676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3677 #: apt.conf.5.xml:1024
3679 "Output information about downloading and applying package index list diffs, "
3680 "and errors relating to package index list diffs."
3683 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3684 #: apt.conf.5.xml:1036
3686 "Output information related to patching apt package lists when downloading "
3687 "index diffs instead of full indices."
3690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3691 #: apt.conf.5.xml:1047
3692 msgid "Log all interactions with the sub-processes that actually perform downloads."
3695 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3696 #: apt.conf.5.xml:1058
3698 "Log events related to the automatically-installed status of packages and to "
3699 "the removal of unused packages."
3702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3703 #: apt.conf.5.xml:1068
3705 "Generate debug messages describing which packages are being automatically "
3706 "installed to resolve dependencies. This corresponds to the initial "
3707 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3708 "and not to the full <literal>apt</literal> dependency resolver; see "
3709 "<literal>Debug::pkgProblemResolver</literal> for that."
3712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3713 #: apt.conf.5.xml:1082
3715 "Generate debug messages describing which packages are marked as "
3716 "keep/install/remove while the ProblemResolver does his work. Each addition "
3717 "or deletion may trigger additional actions; they are shown indented two "
3718 "additional spaces under the original entry. The format for each line is "
3719 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3720 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3721 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3722 "is the current version of the package, <literal>d.e.f</literal> is the "
3723 "version considered for installation and <literal>x.y.z</literal> is a newer "
3724 "version, but not considered for installation (because of a low pin "
3725 "score). The later two can be omitted if there is none or if it is the same "
3726 "as the installed version. <literal>section</literal> is the name of the "
3727 "section the package appears in."
3730 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3731 #: apt.conf.5.xml:1103
3733 "When invoking &dpkg;, output the precise command line with which it is being "
3734 "invoked, with arguments separated by a single space character."
3737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3738 #: apt.conf.5.xml:1114
3740 "Output all the data received from &dpkg; on the status file descriptor and "
3741 "any errors encountered while parsing it."
3744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3745 #: apt.conf.5.xml:1125
3747 "Generate a trace of the algorithm that decides the order in which "
3748 "<literal>apt</literal> should pass packages to &dpkg;."
3751 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3752 #: apt.conf.5.xml:1137
3753 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3757 #: apt.conf.5.xml:1148
3758 msgid "Output the priority of each package list on startup."
3761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3762 #: apt.conf.5.xml:1158
3764 "Trace the execution of the dependency resolver (this applies only to what "
3765 "happens when a complex dependency problem is encountered)."
3768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3769 #: apt.conf.5.xml:1169
3771 "Display a list of all installed packages with their calculated score used by "
3772 "the pkgProblemResolver. The description of the package is the same as "
3773 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3777 #: apt.conf.5.xml:1181
3779 "Print information about the vendors read from "
3780 "<filename>/etc/apt/vendors.list</filename>."
3783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3784 #: apt.conf.5.xml:1191
3786 "Display the external commands that are called by apt hooks. This includes "
3787 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
3788 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
3791 #. type: Content of: <refentry><refsect1><title>
3792 #: apt.conf.5.xml:1215 apt_preferences.5.xml:547 sources.list.5.xml:239 apt-ftparchive.1.xml:598
3796 #. type: Content of: <refentry><refsect1><para>
3797 #: apt.conf.5.xml:1216
3799 "&configureindex; is a configuration file showing example values for all "
3803 #. ? reading apt.conf
3804 #. type: Content of: <refentry><refsect1><para>
3805 #: apt.conf.5.xml:1228
3806 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
3809 #. type: Content of: <refentry><refnamediv><refpurpose>
3810 #: apt_preferences.5.xml:34
3811 msgid "Preference control file for APT"
3814 #. type: Content of: <refentry><refsect1><para>
3815 #: apt_preferences.5.xml:39
3817 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
3818 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
3819 "can be used to control which versions of packages will be selected for "
3823 #. type: Content of: <refentry><refsect1><para>
3824 #: apt_preferences.5.xml:44
3826 "Several versions of a package may be available for installation when the "
3827 "&sources-list; file contains references to more than one distribution (for "
3828 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
3829 "assigns a priority to each version that is available. Subject to dependency "
3830 "constraints, <command>apt-get</command> selects the version with the highest "
3831 "priority for installation. The APT preferences override the priorities that "
3832 "APT assigns to package versions by default, thus giving the user control "
3833 "over which one is selected for installation."
3836 #. type: Content of: <refentry><refsect1><para>
3837 #: apt_preferences.5.xml:54
3839 "Several instances of the same version of a package may be available when the "
3840 "&sources-list; file contains references to more than one source. In this "
3841 "case <command>apt-get</command> downloads the instance listed earliest in "
3842 "the &sources-list; file. The APT preferences do not affect the choice of "
3843 "instance, only the choice of version."
3846 #. type: Content of: <refentry><refsect1><para>
3847 #: apt_preferences.5.xml:61
3849 "Preferences are a strong power in the hands of a system administrator but "
3850 "they can become also their biggest nightmare if used without care! APT will "
3851 "not question the preferences, so wrong settings can lead to uninstallable "
3852 "packages or wrong decisions while upgrading packages. Even more problems "
3853 "will arise if multiple distribution releases are mixed without a good "
3854 "understanding of the following paragraphs. Packages included in a specific "
3855 "release aren't tested in (and therefore don't always work as expected in) "
3856 "older or newer releases, or together with other packages from different "
3857 "releases. You have been warned."
3860 #. type: Content of: <refentry><refsect1><para>
3861 #: apt_preferences.5.xml:72
3863 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
3864 "directory are parsed in alphanumeric ascending order and need to obey the "
3865 "following naming convention: The files have either no or "
3866 "\"<literal>pref</literal>\" as filename extension and only contain "
3867 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
3868 "Otherwise APT will print a notice that it has ignored a file, unless that "
3869 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
3870 "configuration list - in which case it will be silently ignored."
3873 #. type: Content of: <refentry><refsect1><refsect2><title>
3874 #: apt_preferences.5.xml:81
3875 msgid "APT's Default Priority Assignments"
3878 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3879 #: apt_preferences.5.xml:96
3882 "<command>apt-get install -t testing "
3883 "<replaceable>some-package</replaceable></command>\n"
3886 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3887 #: apt_preferences.5.xml:99
3889 msgid "APT::Default-Release \"stable\";\n"
3892 #. type: Content of: <refentry><refsect1><refsect2><para>
3893 #: apt_preferences.5.xml:83
3895 "If there is no preferences file or if there is no entry in the file that "
3896 "applies to a particular version then the priority assigned to that version "
3897 "is the priority of the distribution to which that version belongs. It is "
3898 "possible to single out a distribution, \"the target release\", which "
3899 "receives a higher priority than other distributions do by default. The "
3900 "target release can be set on the <command>apt-get</command> command line or "
3901 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
3902 "that this has precedence over any general priority you set in the "
3903 "<filename>/etc/apt/preferences</filename> file described later, but not over "
3904 "specifically pinned packages. For example, <placeholder "
3905 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
3909 #. type: Content of: <refentry><refsect1><refsect2><para>
3910 #: apt_preferences.5.xml:103
3912 "If the target release has been specified then APT uses the following "
3913 "algorithm to set the priorities of the versions of a package. Assign:"
3916 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3917 #: apt_preferences.5.xml:108
3921 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3922 #: apt_preferences.5.xml:109
3924 "to the versions coming from archives which in their "
3925 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
3926 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
3927 "<literal>experimental</literal> archive."
3930 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3931 #: apt_preferences.5.xml:115
3932 msgid "priority 100"
3935 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3936 #: apt_preferences.5.xml:116
3938 "to the version that is already installed (if any) and to the versions coming "
3939 "from archives which in their <filename>Release</filename> files are marked "
3940 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
3941 "backports archive since <literal>squeeze-backports</literal>."
3944 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3945 #: apt_preferences.5.xml:123
3946 msgid "priority 500"
3949 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3950 #: apt_preferences.5.xml:124
3952 "to the versions that are not installed and do not belong to the target "
3956 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3957 #: apt_preferences.5.xml:128
3958 msgid "priority 990"
3961 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3962 #: apt_preferences.5.xml:129
3963 msgid "to the versions that are not installed and belong to the target release."
3966 #. type: Content of: <refentry><refsect1><refsect2><para>
3967 #: apt_preferences.5.xml:134
3969 "If the target release has not been specified then APT simply assigns "
3970 "priority 100 to all installed package versions and priority 500 to all "
3971 "uninstalled package versions, except versions coming from archives which in "
3972 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
3973 "- these versions get the priority 1 or priority 100 if it is additionally "
3974 "marked as \"ButAutomaticUpgrades: yes\"."
3977 #. type: Content of: <refentry><refsect1><refsect2><para>
3978 #: apt_preferences.5.xml:141
3980 "APT then applies the following rules, listed in order of precedence, to "
3981 "determine which version of a package to install."
3984 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3985 #: apt_preferences.5.xml:144
3987 "Never downgrade unless the priority of an available version exceeds 1000. "
3988 "(\"Downgrading\" is installing a less recent version of a package in place "
3989 "of a more recent version. Note that none of APT's default priorities "
3990 "exceeds 1000; such high priorities can only be set in the preferences file. "
3991 "Note also that downgrading a package can be risky.)"
3994 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3995 #: apt_preferences.5.xml:150
3996 msgid "Install the highest priority version."
3999 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4000 #: apt_preferences.5.xml:151
4002 "If two or more versions have the same priority, install the most recent one "
4003 "(that is, the one with the higher version number)."
4006 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4007 #: apt_preferences.5.xml:154
4009 "If two or more versions have the same priority and version number but either "
4010 "the packages differ in some of their metadata or the "
4011 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4014 #. type: Content of: <refentry><refsect1><refsect2><para>
4015 #: apt_preferences.5.xml:160
4017 "In a typical situation, the installed version of a package (priority 100) "
4018 "is not as recent as one of the versions available from the sources listed in "
4019 "the &sources-list; file (priority 500 or 990). Then the package will be "
4020 "upgraded when <command>apt-get install "
4021 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4022 "upgrade</command> is executed."
4025 #. type: Content of: <refentry><refsect1><refsect2><para>
4026 #: apt_preferences.5.xml:167
4028 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4029 "recent than any of the other available versions. The package will not be "
4030 "downgraded when <command>apt-get install "
4031 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4032 "upgrade</command> is executed."
4035 #. type: Content of: <refentry><refsect1><refsect2><para>
4036 #: apt_preferences.5.xml:172
4038 "Sometimes the installed version of a package is more recent than the version "
4039 "belonging to the target release, but not as recent as a version belonging to "
4040 "some other distribution. Such a package will indeed be upgraded when "
4041 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4042 "or <command>apt-get upgrade</command> is executed, because at least "
4043 "<emphasis>one</emphasis> of the available versions has a higher priority "
4044 "than the installed version."
4047 #. type: Content of: <refentry><refsect1><refsect2><title>
4048 #: apt_preferences.5.xml:181
4049 msgid "The Effect of APT Preferences"
4052 #. type: Content of: <refentry><refsect1><refsect2><para>
4053 #: apt_preferences.5.xml:183
4055 "The APT preferences file allows the system administrator to control the "
4056 "assignment of priorities. The file consists of one or more multi-line "
4057 "records separated by blank lines. Records can have one of two forms, a "
4058 "specific form and a general form."
4061 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4062 #: apt_preferences.5.xml:189
4064 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4065 "specified packages with a specified version or version range. For example, "
4066 "the following record assigns a high priority to all versions of the "
4067 "<filename>perl</filename> package whose version number begins with "
4068 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4072 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4073 #: apt_preferences.5.xml:196
4077 "Pin: version &good-perl;*\n"
4078 "Pin-Priority: 1001\n"
4081 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4082 #: apt_preferences.5.xml:202
4084 "The general form assigns a priority to all of the package versions in a "
4085 "given distribution (that is, to all the versions of packages that are listed "
4086 "in a certain <filename>Release</filename> file) or to all of the package "
4087 "versions coming from a particular Internet site, as identified by the site's "
4088 "fully qualified domain name."
4091 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4092 #: apt_preferences.5.xml:208
4094 "This general-form entry in the APT preferences file applies only to groups "
4095 "of packages. For example, the following record assigns a high priority to "
4096 "all package versions available from the local site."
4099 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4100 #: apt_preferences.5.xml:213
4104 "Pin: origin \"\"\n"
4105 "Pin-Priority: 999\n"
4108 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4109 #: apt_preferences.5.xml:218
4111 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4112 "which can be used to match a hostname. The following record will assign a "
4113 "high priority to all versions available from the server identified by the "
4114 "hostname \"ftp.de.debian.org\""
4117 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4118 #: apt_preferences.5.xml:222
4122 "Pin: origin \"ftp.de.debian.org\"\n"
4123 "Pin-Priority: 999\n"
4126 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4127 #: apt_preferences.5.xml:226
4129 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4130 "distribution as specified in a <filename>Release</filename> file. What "
4131 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4132 "Internet address but an author or vendor name, such as \"Debian\" or "
4136 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4137 #: apt_preferences.5.xml:231
4139 "The following record assigns a low priority to all package versions "
4140 "belonging to any distribution whose Archive name is "
4141 "\"<literal>unstable</literal>\"."
4144 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4145 #: apt_preferences.5.xml:235
4149 "Pin: release a=unstable\n"
4150 "Pin-Priority: 50\n"
4153 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4154 #: apt_preferences.5.xml:240
4156 "The following record assigns a high priority to all package versions "
4157 "belonging to any distribution whose Codename is "
4158 "\"<literal>&testing-codename;</literal>\"."
4161 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4162 #: apt_preferences.5.xml:244
4166 "Pin: release n=&testing-codename;\n"
4167 "Pin-Priority: 900\n"
4170 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4171 #: apt_preferences.5.xml:249
4173 "The following record assigns a high priority to all package versions "
4174 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4175 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4178 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4179 #: apt_preferences.5.xml:254
4183 "Pin: release a=stable, v=&stable-version;\n"
4184 "Pin-Priority: 500\n"
4187 #. type: Content of: <refentry><refsect1><refsect2><title>
4188 #: apt_preferences.5.xml:264
4189 msgid "Regular expressions and &glob; syntax"
4192 #. type: Content of: <refentry><refsect1><refsect2><para>
4193 #: apt_preferences.5.xml:266
4195 "APT also supports pinning by &glob; expressions, and regular expressions "
4196 "surrounded by slashes. For example, the following example assigns the "
4197 "priority 500 to all packages from experimental where the name starts with "
4198 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4199 "extended regular expression surrounded by slashes)."
4202 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4203 #: apt_preferences.5.xml:275
4206 "Package: gnome* /kde/\n"
4207 "Pin: release n=experimental\n"
4208 "Pin-Priority: 500\n"
4211 #. type: Content of: <refentry><refsect1><refsect2><para>
4212 #: apt_preferences.5.xml:281
4214 "The rule for those expressions is that they can occur anywhere where a "
4215 "string can occur. Thus, the following pin assigns the priority 990 to all "
4216 "packages from a release starting with &ubuntu-codename;."
4219 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4220 #: apt_preferences.5.xml:287
4224 "Pin: release n=&ubuntu-codename;*\n"
4225 "Pin-Priority: 990\n"
4228 #. type: Content of: <refentry><refsect1><refsect2><para>
4229 #: apt_preferences.5.xml:293
4231 "If a regular expression occurs in a <literal>Package</literal> field, the "
4232 "behavior is the same as if this regular expression were replaced with a list "
4233 "of all package names it matches. It is undecided whether this will change in "
4234 "the future; thus you should always list wild-card pins first, so later "
4235 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4236 "Package field is not considered a &glob; expression in itself."
4239 #. type: Content of: <refentry><refsect1><refsect2><title>
4240 #: apt_preferences.5.xml:309
4241 msgid "How APT Interprets Priorities"
4244 #. type: Content of: <refentry><refsect1><refsect2><para>
4245 #: apt_preferences.5.xml:312
4247 "Priorities (P) assigned in the APT preferences file must be positive or "
4248 "negative integers. They are interpreted as follows (roughly speaking):"
4251 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4252 #: apt_preferences.5.xml:317
4253 msgid "P >= 1000"
4256 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4257 #: apt_preferences.5.xml:318
4259 "causes a version to be installed even if this constitutes a downgrade of the "
4263 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4264 #: apt_preferences.5.xml:322
4265 msgid "990 <= P < 1000"
4268 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4269 #: apt_preferences.5.xml:323
4271 "causes a version to be installed even if it does not come from the target "
4272 "release, unless the installed version is more recent"
4275 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4276 #: apt_preferences.5.xml:328
4277 msgid "500 <= P < 990"
4280 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4281 #: apt_preferences.5.xml:329
4283 "causes a version to be installed unless there is a version available "
4284 "belonging to the target release or the installed version is more recent"
4287 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4288 #: apt_preferences.5.xml:334
4289 msgid "100 <= P < 500"
4292 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4293 #: apt_preferences.5.xml:335
4295 "causes a version to be installed unless there is a version available "
4296 "belonging to some other distribution or the installed version is more recent"
4299 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4300 #: apt_preferences.5.xml:340
4301 msgid "0 < P < 100"
4304 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4305 #: apt_preferences.5.xml:341
4307 "causes a version to be installed only if there is no installed version of "
4311 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4312 #: apt_preferences.5.xml:345
4316 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4317 #: apt_preferences.5.xml:346
4318 msgid "prevents the version from being installed"
4321 #. type: Content of: <refentry><refsect1><refsect2><para>
4322 #: apt_preferences.5.xml:351
4324 "If any specific-form records match an available package version then the "
4325 "first such record determines the priority of the package version. Failing "
4326 "that, if any general-form records match an available package version then "
4327 "the first such record determines the priority of the package version."
4330 #. type: Content of: <refentry><refsect1><refsect2><para>
4331 #: apt_preferences.5.xml:357
4333 "For example, suppose the APT preferences file contains the three records "
4334 "presented earlier:"
4337 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4338 #: apt_preferences.5.xml:361
4342 "Pin: version &good-perl;*\n"
4343 "Pin-Priority: 1001\n"
4346 "Pin: origin \"\"\n"
4347 "Pin-Priority: 999\n"
4350 "Pin: release unstable\n"
4351 "Pin-Priority: 50\n"
4354 #. type: Content of: <refentry><refsect1><refsect2><para>
4355 #: apt_preferences.5.xml:374
4359 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4360 #: apt_preferences.5.xml:376
4362 "The most recent available version of the <literal>perl</literal> package "
4363 "will be installed, so long as that version's version number begins with "
4364 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4365 "&good-perl;* version of <literal>perl</literal> is available and the "
4366 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4370 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4371 #: apt_preferences.5.xml:381
4373 "A version of any package other than <literal>perl</literal> that is "
4374 "available from the local system has priority over other versions, even "
4375 "versions belonging to the target release."
4378 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4379 #: apt_preferences.5.xml:385
4381 "A version of a package whose origin is not the local system but some other "
4382 "site listed in &sources-list; and which belongs to an "
4383 "<literal>unstable</literal> distribution is only installed if it is selected "
4384 "for installation and no version of the package is already installed."
4387 #. type: Content of: <refentry><refsect1><refsect2><title>
4388 #: apt_preferences.5.xml:395
4389 msgid "Determination of Package Version and Distribution Properties"
4392 #. type: Content of: <refentry><refsect1><refsect2><para>
4393 #: apt_preferences.5.xml:397
4395 "The locations listed in the &sources-list; file should provide "
4396 "<filename>Packages</filename> and <filename>Release</filename> files to "
4397 "describe the packages available at that location."
4400 #. type: Content of: <refentry><refsect1><refsect2><para>
4401 #: apt_preferences.5.xml:401
4403 "The <filename>Packages</filename> file is normally found in the directory "
4404 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4406 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4407 "consists of a series of multi-line records, one for each package available "
4408 "in that directory. Only two lines in each record are relevant for setting "
4412 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4413 #: apt_preferences.5.xml:409
4414 msgid "the <literal>Package:</literal> line"
4417 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4418 #: apt_preferences.5.xml:410
4419 msgid "gives the package name"
4422 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4423 #: apt_preferences.5.xml:413 apt_preferences.5.xml:463
4424 msgid "the <literal>Version:</literal> line"
4427 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4428 #: apt_preferences.5.xml:414
4429 msgid "gives the version number for the named package"
4432 #. type: Content of: <refentry><refsect1><refsect2><para>
4433 #: apt_preferences.5.xml:419
4435 "The <filename>Release</filename> file is normally found in the directory "
4436 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4437 "example, <filename>.../dists/stable/Release</filename>, or "
4438 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4439 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4440 "packages in the directory tree below its parent. Unlike the "
4441 "<filename>Packages</filename> file, nearly all of the lines in a "
4442 "<filename>Release</filename> file are relevant for setting APT priorities:"
4445 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4446 #: apt_preferences.5.xml:430
4447 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4450 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4451 #: apt_preferences.5.xml:431
4453 "names the archive to which all the packages in the directory tree belong. "
4454 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4455 "that all of the packages in the directory tree below the parent of the "
4456 "<filename>Release</filename> file are in a <literal>stable</literal> "
4457 "archive. Specifying this value in the APT preferences file would require "
4461 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4462 #: apt_preferences.5.xml:441
4464 msgid "Pin: release a=stable\n"
4467 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4468 #: apt_preferences.5.xml:447
4469 msgid "the <literal>Codename:</literal> line"
4472 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4473 #: apt_preferences.5.xml:448
4475 "names the codename to which all the packages in the directory tree belong. "
4476 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4477 "the packages in the directory tree below the parent of the "
4478 "<filename>Release</filename> file belong to a version named "
4479 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4480 "preferences file would require the line:"
4483 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4484 #: apt_preferences.5.xml:457
4486 msgid "Pin: release n=&testing-codename;\n"
4489 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4490 #: apt_preferences.5.xml:464
4492 "names the release version. For example, the packages in the tree might "
4493 "belong to Debian release version &stable-version;. Note that there is "
4494 "normally no version number for the <literal>testing</literal> and "
4495 "<literal>unstable</literal> distributions because they have not been "
4496 "released yet. Specifying this in the APT preferences file would require one "
4497 "of the following lines."
4500 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4501 #: apt_preferences.5.xml:473
4504 "Pin: release v=&stable-version;\n"
4505 "Pin: release a=stable, v=&stable-version;\n"
4506 "Pin: release &stable-version;\n"
4509 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4510 #: apt_preferences.5.xml:482
4511 msgid "the <literal>Component:</literal> line"
4514 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4515 #: apt_preferences.5.xml:483
4517 "names the licensing component associated with the packages in the directory "
4518 "tree of the <filename>Release</filename> file. For example, the line "
4519 "\"Component: main\" specifies that all the packages in the directory tree "
4520 "are from the <literal>main</literal> component, which entails that they are "
4521 "licensed under terms listed in the Debian Free Software Guidelines. "
4522 "Specifying this component in the APT preferences file would require the "
4526 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4527 #: apt_preferences.5.xml:492
4529 msgid "Pin: release c=main\n"
4532 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4533 #: apt_preferences.5.xml:498
4534 msgid "the <literal>Origin:</literal> line"
4537 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4538 #: apt_preferences.5.xml:499
4540 "names the originator of the packages in the directory tree of the "
4541 "<filename>Release</filename> file. Most commonly, this is "
4542 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4543 "file would require the line:"
4546 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4547 #: apt_preferences.5.xml:505
4549 msgid "Pin: release o=Debian\n"
4552 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4553 #: apt_preferences.5.xml:511
4554 msgid "the <literal>Label:</literal> line"
4557 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4558 #: apt_preferences.5.xml:512
4560 "names the label of the packages in the directory tree of the "
4561 "<filename>Release</filename> file. Most commonly, this is "
4562 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4563 "file would require the line:"
4566 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4567 #: apt_preferences.5.xml:518
4569 msgid "Pin: release l=Debian\n"
4572 #. type: Content of: <refentry><refsect1><refsect2><para>
4573 #: apt_preferences.5.xml:525
4575 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4576 "files retrieved from locations listed in the &sources-list; file are stored "
4577 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4578 "named by the variable <literal>Dir::State::Lists</literal> in the "
4579 "<filename>apt.conf</filename> file. For example, the file "
4580 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4581 "contains the <filename>Release</filename> file retrieved from the site "
4582 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4583 "architecture files from the <literal>contrib</literal> component of the "
4584 "<literal>unstable</literal> distribution."
4587 #. type: Content of: <refentry><refsect1><refsect2><title>
4588 #: apt_preferences.5.xml:538
4589 msgid "Optional Lines in an APT Preferences Record"
4592 #. type: Content of: <refentry><refsect1><refsect2><para>
4593 #: apt_preferences.5.xml:540
4595 "Each record in the APT preferences file can optionally begin with one or "
4596 "more lines beginning with the word <literal>Explanation:</literal>. This "
4597 "provides a place for comments."
4600 #. type: Content of: <refentry><refsect1><refsect2><title>
4601 #: apt_preferences.5.xml:549
4602 msgid "Tracking Stable"
4605 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4606 #: apt_preferences.5.xml:557
4609 "Explanation: Uninstall or do not install any Debian-originated\n"
4610 "Explanation: package versions other than those in the stable distro\n"
4612 "Pin: release a=stable\n"
4613 "Pin-Priority: 900\n"
4616 "Pin: release o=Debian\n"
4617 "Pin-Priority: -10\n"
4620 #. type: Content of: <refentry><refsect1><refsect2><para>
4621 #: apt_preferences.5.xml:551
4623 "The following APT preferences file will cause APT to assign a priority "
4624 "higher than the default (500) to all package versions belonging to a "
4625 "<literal>stable</literal> distribution and a prohibitively low priority to "
4626 "package versions belonging to other <literal>Debian</literal> "
4627 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4630 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4631 #: apt_preferences.5.xml:574 apt_preferences.5.xml:620 apt_preferences.5.xml:678
4634 "apt-get install <replaceable>package-name</replaceable>\n"
4636 "apt-get dist-upgrade\n"
4639 #. type: Content of: <refentry><refsect1><refsect2><para>
4640 #: apt_preferences.5.xml:569
4642 "With a suitable &sources-list; file and the above preferences file, any of "
4643 "the following commands will cause APT to upgrade to the latest "
4644 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4648 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4649 #: apt_preferences.5.xml:586
4651 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4654 #. type: Content of: <refentry><refsect1><refsect2><para>
4655 #: apt_preferences.5.xml:580
4657 "The following command will cause APT to upgrade the specified package to the "
4658 "latest version from the <literal>testing</literal> distribution; the package "
4659 "will not be upgraded again unless this command is given again. <placeholder "
4660 "type=\"programlisting\" id=\"0\"/>"
4663 #. type: Content of: <refentry><refsect1><refsect2><title>
4664 #: apt_preferences.5.xml:592
4665 msgid "Tracking Testing or Unstable"
4668 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4669 #: apt_preferences.5.xml:601
4673 "Pin: release a=testing\n"
4674 "Pin-Priority: 900\n"
4677 "Pin: release a=unstable\n"
4678 "Pin-Priority: 800\n"
4681 "Pin: release o=Debian\n"
4682 "Pin-Priority: -10\n"
4685 #. type: Content of: <refentry><refsect1><refsect2><para>
4686 #: apt_preferences.5.xml:594
4688 "The following APT preferences file will cause APT to assign a high priority "
4689 "to package versions from the <literal>testing</literal> distribution, a "
4690 "lower priority to package versions from the <literal>unstable</literal> "
4691 "distribution, and a prohibitively low priority to package versions from "
4692 "other <literal>Debian</literal> distributions. <placeholder "
4693 "type=\"programlisting\" id=\"0\"/>"
4696 #. type: Content of: <refentry><refsect1><refsect2><para>
4697 #: apt_preferences.5.xml:615
4699 "With a suitable &sources-list; file and the above preferences file, any of "
4700 "the following commands will cause APT to upgrade to the latest "
4701 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4705 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4706 #: apt_preferences.5.xml:635
4708 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4711 #. type: Content of: <refentry><refsect1><refsect2><para>
4712 #: apt_preferences.5.xml:626
4714 "The following command will cause APT to upgrade the specified package to the "
4715 "latest version from the <literal>unstable</literal> distribution. "
4716 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4717 "the most recent <literal>testing</literal> version if that is more recent "
4718 "than the installed version, otherwise, to the most recent "
4719 "<literal>unstable</literal> version if that is more recent than the "
4720 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4723 #. type: Content of: <refentry><refsect1><refsect2><title>
4724 #: apt_preferences.5.xml:642
4725 msgid "Tracking the evolution of a codename release"
4728 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4729 #: apt_preferences.5.xml:656
4732 "Explanation: Uninstall or do not install any Debian-originated package "
4734 "Explanation: other than those in the distribution codenamed with "
4735 "&testing-codename; or sid\n"
4737 "Pin: release n=&testing-codename;\n"
4738 "Pin-Priority: 900\n"
4740 "Explanation: Debian unstable is always codenamed with sid\n"
4742 "Pin: release n=sid\n"
4743 "Pin-Priority: 800\n"
4746 "Pin: release o=Debian\n"
4747 "Pin-Priority: -10\n"
4750 #. type: Content of: <refentry><refsect1><refsect2><para>
4751 #: apt_preferences.5.xml:644
4753 "The following APT preferences file will cause APT to assign a priority "
4754 "higher than the default (500) to all package versions belonging to a "
4755 "specified codename of a distribution and a prohibitively low priority to "
4756 "package versions belonging to other <literal>Debian</literal> distributions, "
4757 "codenames and archives. Note that with this APT preference APT will follow "
4758 "the migration of a release from the archive <literal>testing</literal> to "
4759 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
4760 "want to follow for example the progress in <literal>testing</literal> "
4761 "notwithstanding the codename changes you should use the example "
4762 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
4765 #. type: Content of: <refentry><refsect1><refsect2><para>
4766 #: apt_preferences.5.xml:673
4768 "With a suitable &sources-list; file and the above preferences file, any of "
4769 "the following commands will cause APT to upgrade to the latest version(s) in "
4770 "the release codenamed with <literal>&testing-codename;</literal>. "
4771 "<placeholder type=\"programlisting\" id=\"0\"/>"
4774 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4775 #: apt_preferences.5.xml:693
4777 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
4780 #. type: Content of: <refentry><refsect1><refsect2><para>
4781 #: apt_preferences.5.xml:684
4783 "The following command will cause APT to upgrade the specified package to the "
4784 "latest version from the <literal>sid</literal> distribution. Thereafter, "
4785 "<command>apt-get upgrade</command> will upgrade the package to the most "
4786 "recent <literal>&testing-codename;</literal> version if that is more recent "
4787 "than the installed version, otherwise, to the most recent "
4788 "<literal>sid</literal> version if that is more recent than the installed "
4789 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
4792 #. type: Content of: <refentry><refsect1><para>
4793 #: apt_preferences.5.xml:708
4794 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
4797 #. type: Content of: <refentry><refnamediv><refpurpose>
4798 #: sources.list.5.xml:35
4799 msgid "List of configured APT data sources"
4802 #. type: Content of: <refentry><refsect1><para>
4803 #: sources.list.5.xml:40
4805 "The source list <filename>/etc/apt/sources.list</filename> is designed to "
4806 "support any number of active sources and a variety of source media. The file "
4807 "lists one source per line, with the most preferred source listed first. The "
4808 "information available from the configured sources is acquired by "
4809 "<command>apt-get update</command> (or by an equivalent command from another "
4813 #. type: Content of: <refentry><refsect1><para>
4814 #: sources.list.5.xml:47
4816 "Each line specifying a source starts with type "
4817 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
4818 "this type. Individual entries cannot be continued onto a following "
4819 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
4820 "on a line marks the remainder of that line as a comment."
4823 #. type: Content of: <refentry><refsect1><title>
4824 #: sources.list.5.xml:55
4825 msgid "sources.list.d"
4828 #. type: Content of: <refentry><refsect1><para>
4829 #: sources.list.5.xml:56
4831 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
4832 "add sources.list entries in separate files. The format is the same as for "
4833 "the regular <filename>sources.list</filename> file. File names need to end "
4834 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
4835 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
4836 "Otherwise APT will print a notice that it has ignored a file, unless that "
4837 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4838 "configuration list - in which case it will be silently ignored."
4841 #. type: Content of: <refentry><refsect1><title>
4842 #: sources.list.5.xml:67
4843 msgid "The deb and deb-src types"
4846 #. type: Content of: <refentry><refsect1><para>
4847 #: sources.list.5.xml:68
4849 "The <literal>deb</literal> type references a typical two-level Debian "
4850 "archive, <filename>distribution/component</filename>. The "
4851 "<literal>distribution</literal> is generally an archive name like "
4852 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
4853 "<literal>&stable-codename;</literal> or "
4854 "<literal>&testing-codename;</literal> while component is one of "
4855 "<literal>main</literal>, <literal>contrib</literal> or "
4856 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
4857 "a Debian distribution's source code in the same form as the "
4858 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
4859 "to fetch source indexes."
4862 #. type: Content of: <refentry><refsect1><para>
4863 #: sources.list.5.xml:79
4865 "The format for a <filename>sources.list</filename> entry using the "
4866 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
4869 #. type: Content of: <refentry><refsect1><literallayout>
4870 #: sources.list.5.xml:82
4872 msgid "deb [ options ] uri suite [component1] [component2] [...]"
4875 #. type: Content of: <refentry><refsect1><para><literallayout>
4876 #: sources.list.5.xml:86
4879 " Types: deb deb-src\n"
4880 " URIs: http://example.com\n"
4881 " Suites: stable testing\n"
4882 " Sections: component1 component2\n"
4883 " Description: short\n"
4885 " [option1]: [option1-value]\n"
4888 " URIs: http://another.example.com\n"
4889 " Suites: experimental\n"
4890 " Sections: component1 component2\n"
4892 " Description: short\n"
4894 " [option1]: [option1-value]\n"
4898 #. type: Content of: <refentry><refsect1><para>
4899 #: sources.list.5.xml:84
4901 "Alternatively a rfc822 style format is also supported: <placeholder "
4902 "type=\"literallayout\" id=\"0\"/>"
4905 #. type: Content of: <refentry><refsect1><para>
4906 #: sources.list.5.xml:105
4908 "The URI for the <literal>deb</literal> type must specify the base of the "
4909 "Debian distribution, from which APT will find the information it needs. "
4910 "<literal>suite</literal> can specify an exact path, in which case the "
4911 "components must be omitted and <literal>suite</literal> must end with a "
4912 "slash (<literal>/</literal>). This is useful for the case when only a "
4913 "particular sub-section of the archive denoted by the URI is of interest. If "
4914 "<literal>suite</literal> does not specify an exact path, at least one "
4915 "<literal>component</literal> must be present."
4918 #. type: Content of: <refentry><refsect1><para>
4919 #: sources.list.5.xml:114
4921 "<literal>suite</literal> may also contain a variable, "
4922 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
4923 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
4924 "system. This permits architecture-independent "
4925 "<filename>sources.list</filename> files to be used. In general this is only "
4926 "of interest when specifying an exact path, <literal>APT</literal> will "
4927 "automatically generate a URI with the current architecture otherwise."
4930 #. type: Content of: <refentry><refsect1><para>
4931 #: sources.list.5.xml:122
4933 "In the traditional style sources.list format since only one distribution can "
4934 "be specified per line it may be necessary to have multiple lines for the "
4935 "same URI, if a subset of all available distributions or components at that "
4936 "location is desired. APT will sort the URI list after it has generated a "
4937 "complete set internally, and will collapse multiple references to the same "
4938 "Internet host, for instance, into a single connection, so that it does not "
4939 "inefficiently establish an FTP connection, close it, do something else, and "
4940 "then re-establish a connection to that same host. This feature is useful for "
4941 "accessing busy FTP sites with limits on the number of simultaneous anonymous "
4942 "users. APT also parallelizes connections to different hosts to more "
4943 "effectively deal with sites with low bandwidth."
4946 #. type: Content of: <refentry><refsect1><para>
4947 #: sources.list.5.xml:136
4949 "<literal>options</literal> is always optional and needs to be surrounded by "
4950 "square brackets. It can consist of multiple settings in the form "
4951 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
4952 "Multiple settings are separated by spaces. The following settings are "
4953 "supported by APT (note however that unsupported settings will be ignored "
4957 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4958 #: sources.list.5.xml:142
4960 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4961 "can be used to specify for which architectures information should be "
4962 "downloaded. If this option is not set all architectures defined by the "
4963 "<literal>APT::Architectures</literal> option will be downloaded."
4966 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4967 #: sources.list.5.xml:146
4969 "<literal>arch+=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4971 "<literal>arch-=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4972 "which can be used to add/remove architectures from the set which will be "
4976 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4977 #: sources.list.5.xml:149
4979 "<literal>trusted=yes</literal> can be set to indicate that packages from "
4980 "this source are always authenticated even if the "
4981 "<filename>Release</filename> file is not signed or the signature can't be "
4982 "checked. This disables parts of &apt-secure; and should therefore only be "
4983 "used in a local and trusted context. <literal>trusted=no</literal> is the "
4984 "opposite which handles even correctly authenticated sources as not "
4988 #. type: Content of: <refentry><refsect1><para>
4989 #: sources.list.5.xml:156
4991 "It is important to list sources in order of preference, with the most "
4992 "preferred source listed first. Typically this will result in sorting by "
4993 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
4994 "followed by distant Internet hosts, for example)."
4997 #. type: Content of: <refentry><refsect1><para>
4998 #: sources.list.5.xml:161
4999 msgid "Some examples:"
5002 #. type: Content of: <refentry><refsect1><literallayout>
5003 #: sources.list.5.xml:163
5006 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5007 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5012 #. type: Content of: <refentry><refsect1><title>
5013 #: sources.list.5.xml:169
5014 msgid "URI specification"
5017 #. type: Content of: <refentry><refsect1><para>
5018 #: sources.list.5.xml:171
5019 msgid "The currently recognized URI types are:"
5022 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5023 #: sources.list.5.xml:175
5025 "The file scheme allows an arbitrary directory in the file system to be "
5026 "considered an archive. This is useful for NFS mounts and local mirrors or "
5030 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5031 #: sources.list.5.xml:182
5033 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5034 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5038 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5039 #: sources.list.5.xml:189
5041 "The http scheme specifies an HTTP server for the archive. If an environment "
5042 "variable <envar>http_proxy</envar> is set with the format "
5043 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5044 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5045 "the format http://user:pass@server:port/. Note that this is an insecure "
5046 "method of authentication."
5049 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5050 #: sources.list.5.xml:200
5052 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5053 "is highly configurable; for more information see the &apt-conf; manual "
5054 "page. Please note that an FTP proxy can be specified by using the "
5055 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5056 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5057 "environment variable and <emphasis>only</emphasis> this environment "
5058 "variable. Proxies using HTTP specified in the configuration file will be "
5062 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5063 #: sources.list.5.xml:212
5065 "The copy scheme is identical to the file scheme except that packages are "
5066 "copied into the cache directory instead of used directly at their location. "
5067 "This is useful for people using removable media to copy files around with "
5071 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5072 #: sources.list.5.xml:219
5074 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5075 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5076 "recommended. The standard <command>find</command> and <command>dd</command> "
5077 "commands are used to perform the file transfers from the remote host."
5080 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5081 #: sources.list.5.xml:226
5082 msgid "adding more recognizable URI types"
5085 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5086 #: sources.list.5.xml:228
5088 "APT can be extended with more methods shipped in other optional packages, "
5089 "which should follow the naming scheme "
5090 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5091 "instance, the APT team also maintains the package "
5092 "<package>apt-transport-https</package>, which provides access methods for "
5093 "HTTPS URIs with features similar to the http method. Methods for using "
5094 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5097 #. type: Content of: <refentry><refsect1><para>
5098 #: sources.list.5.xml:240
5100 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5101 "stable/main, stable/contrib, and stable/non-free."
5104 #. type: Content of: <refentry><refsect1><literallayout>
5105 #: sources.list.5.xml:242
5107 msgid "deb file:/home/jason/debian stable main contrib non-free"
5110 #. type: Content of: <refentry><refsect1><para>
5111 #: sources.list.5.xml:244
5112 msgid "As above, except this uses the unstable (development) distribution."
5115 #. type: Content of: <refentry><refsect1><literallayout>
5116 #: sources.list.5.xml:245
5118 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5121 #. type: Content of: <refentry><refsect1><para>
5122 #: sources.list.5.xml:247
5123 msgid "Source line for the above"
5126 #. type: Content of: <refentry><refsect1><literallayout>
5127 #: sources.list.5.xml:248
5129 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5132 #. type: Content of: <refentry><refsect1><para>
5133 #: sources.list.5.xml:250
5135 "The first line gets package information for the architectures in "
5136 "<literal>APT::Architectures</literal> while the second always retrieves "
5137 "<literal>amd64</literal> and <literal>armel</literal>."
5140 #. type: Content of: <refentry><refsect1><literallayout>
5141 #: sources.list.5.xml:252
5144 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5145 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5148 #. type: Content of: <refentry><refsect1><para>
5149 #: sources.list.5.xml:255
5151 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5155 #. type: Content of: <refentry><refsect1><literallayout>
5156 #: sources.list.5.xml:257
5158 msgid "deb http://archive.debian.org/debian-archive hamm main"
5161 #. type: Content of: <refentry><refsect1><para>
5162 #: sources.list.5.xml:259
5164 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5165 "directory, and uses only the &stable-codename;/contrib area."
5168 #. type: Content of: <refentry><refsect1><literallayout>
5169 #: sources.list.5.xml:261
5171 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5174 #. type: Content of: <refentry><refsect1><para>
5175 #: sources.list.5.xml:263
5177 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5178 "directory, and uses only the unstable/contrib area. If this line appears as "
5179 "well as the one in the previous example in <filename>sources.list</filename> "
5180 "a single FTP session will be used for both resource lines."
5183 #. type: Content of: <refentry><refsect1><literallayout>
5184 #: sources.list.5.xml:267
5186 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5189 #. type: Content of: <refentry><refsect1><para><literallayout>
5190 #: sources.list.5.xml:276
5192 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5195 #. type: Content of: <refentry><refsect1><para>
5196 #: sources.list.5.xml:269
5198 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5199 "directory, and uses only files found under "
5200 "<filename>unstable/binary-i386</filename> on i386 machines, "
5201 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5202 "supported architectures. [Note this example only illustrates how to use the "
5203 "substitution variable; official debian archives are not structured like "
5204 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5207 #. type: Content of: <refentry><refsect1><para>
5208 #: sources.list.5.xml:281
5209 msgid "&apt-cache; &apt-conf;"
5212 #. type: Content of: <refentry><refmeta><manvolnum>
5213 #: apt-extracttemplates.1.xml:28 apt-sortpkgs.1.xml:28 apt-ftparchive.1.xml:28
5217 #. type: Content of: <refentry><refnamediv><refpurpose>
5218 #: apt-extracttemplates.1.xml:35
5220 "Utility to extract <command>debconf</command> config and templates from "
5224 #. type: Content of: <refentry><refsect1><para>
5225 #: apt-extracttemplates.1.xml:41
5227 "<command>apt-extracttemplates</command> will take one or more Debian package "
5228 "files as input and write out (to a temporary directory) all associated "
5229 "config scripts and template files. For each passed in package that contains "
5230 "config scripts and templates, one line of output will be generated in the "
5234 #. type: Content of: <refentry><refsect1><para>
5235 #: apt-extracttemplates.1.xml:46
5236 msgid "package version template-file config-script"
5239 #. type: Content of: <refentry><refsect1><para>
5240 #: apt-extracttemplates.1.xml:47
5242 "template-file and config-script are written to the temporary directory "
5243 "specified by the <option>-t</option> or <option>--tempdir</option> "
5244 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5245 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5246 "<filename>package.config.XXXXXX</filename>"
5249 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5250 #: apt-extracttemplates.1.xml:60
5252 "Temporary directory in which to write extracted <command>debconf</command> "
5253 "template files and config scripts. Configuration Item: "
5254 "<literal>APT::ExtractTemplates::TempDir</literal>"
5257 #. type: Content of: <refentry><refsect1><para>
5258 #: apt-extracttemplates.1.xml:77
5260 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5261 "decimal 100 on error."
5264 #. type: Content of: <refentry><refnamediv><refpurpose>
5265 #: apt-sortpkgs.1.xml:35
5266 msgid "Utility to sort package index files"
5269 #. type: Content of: <refentry><refsect1><para>
5270 #: apt-sortpkgs.1.xml:41
5272 "<command>apt-sortpkgs</command> will take an index file (source index or "
5273 "package index) and sort the records so that they are ordered by the package "
5274 "name. It will also sort the internal fields of each record according to the "
5275 "internal sorting rules."
5278 #. type: Content of: <refentry><refsect1><para>
5279 #: apt-sortpkgs.1.xml:47
5280 msgid "All output is sent to standard output; the input must be a seekable file."
5283 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5284 #: apt-sortpkgs.1.xml:56
5286 "Use source index field ordering. Configuration Item: "
5287 "<literal>APT::SortPkgs::Source</literal>."
5290 #. type: Content of: <refentry><refsect1><para>
5291 #: apt-sortpkgs.1.xml:70
5293 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5297 #. type: Content of: <refentry><refnamediv><refpurpose>
5298 #: apt-ftparchive.1.xml:35
5299 msgid "Utility to generate index files"
5302 #. type: Content of: <refentry><refsect1><para>
5303 #: apt-ftparchive.1.xml:41
5305 "<command>apt-ftparchive</command> is the command line tool that generates "
5306 "the index files that APT uses to access a distribution source. The index "
5307 "files should be generated on the origin site based on the content of that "
5311 #. type: Content of: <refentry><refsect1><para>
5312 #: apt-ftparchive.1.xml:45
5314 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5315 "program, incorporating its entire functionality via the "
5316 "<literal>packages</literal> command. It also contains a contents file "
5317 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5318 "the generation process for a complete archive."
5321 #. type: Content of: <refentry><refsect1><para>
5322 #: apt-ftparchive.1.xml:51
5324 "Internally <command>apt-ftparchive</command> can make use of binary "
5325 "databases to cache the contents of a .deb file and it does not rely on any "
5326 "external programs aside from &gzip;. When doing a full generate it "
5327 "automatically performs file-change checks and builds the desired compressed "
5331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5332 #: apt-ftparchive.1.xml:62
5334 "The packages command generates a package file from a directory tree. It "
5335 "takes the given directory and recursively searches it for .deb files, "
5336 "emitting a package record to stdout for each. This command is approximately "
5337 "equivalent to &dpkg-scanpackages;."
5340 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5341 #: apt-ftparchive.1.xml:67 apt-ftparchive.1.xml:91
5342 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5345 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5346 #: apt-ftparchive.1.xml:72
5348 "The <literal>sources</literal> command generates a source index file from a "
5349 "directory tree. It takes the given directory and recursively searches it "
5350 "for .dsc files, emitting a source record to stdout for each. This command is "
5351 "approximately equivalent to &dpkg-scansources;."
5354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5355 #: apt-ftparchive.1.xml:77
5357 "If an override file is specified then a source override file will be looked "
5358 "for with an extension of .src. The --source-override option can be used to "
5359 "change the source override file that will be used."
5362 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5363 #: apt-ftparchive.1.xml:84
5365 "The <literal>contents</literal> command generates a contents file from a "
5366 "directory tree. It takes the given directory and recursively searches it for "
5367 ".deb files, and reads the file list from each file. It then sorts and writes "
5368 "to stdout the list of files matched to packages. Directories are not written "
5369 "to the output. If multiple packages own the same file then each package is "
5370 "separated by a comma in the output."
5373 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5374 #: apt-ftparchive.1.xml:96
5376 "The <literal>release</literal> command generates a Release file from a "
5377 "directory tree. It recursively searches the given directory for uncompressed "
5378 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5379 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5380 "<command>lzma</command> as well as <filename>Release</filename> and "
5381 "<filename>md5sum.txt</filename> files by default "
5382 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5383 "filename patterns can be added by listing them in "
5384 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5385 "stdout a <filename>Release</filename> file containing an MD5, SHA1 and "
5386 "SHA256 digest for each file."
5389 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5390 #: apt-ftparchive.1.xml:106
5392 "Values for the additional metadata fields in the Release file are taken from "
5393 "the corresponding variables under "
5394 "<literal>APT::FTPArchive::Release</literal>, "
5395 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5396 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5397 "<literal>Suite</literal>, <literal>Version</literal>, "
5398 "<literal>Codename</literal>, <literal>Date</literal>, "
5399 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5400 "<literal>Components</literal>, <literal>Description</literal>."
5403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5404 #: apt-ftparchive.1.xml:119
5406 "The <literal>generate</literal> command is designed to be runnable from a "
5407 "cron script and builds indexes according to the given config file. The "
5408 "config language provides a flexible means of specifying which index files "
5409 "are built from which directories, as well as providing a simple means of "
5410 "maintaining the required settings."
5413 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5414 #: apt-ftparchive.1.xml:128
5416 "The <literal>clean</literal> command tidies the databases used by the given "
5417 "configuration file by removing any records that are no longer necessary."
5420 #. type: Content of: <refentry><refsect1><title>
5421 #: apt-ftparchive.1.xml:134
5422 msgid "The Generate Configuration"
5425 #. type: Content of: <refentry><refsect1><para>
5426 #: apt-ftparchive.1.xml:136
5428 "The <literal>generate</literal> command uses a configuration file to "
5429 "describe the archives that are going to be generated. It follows the typical "
5430 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5431 "&apt-conf; contains a description of the syntax. Note that the generate "
5432 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5433 "tree manner. This only effects how the scope tag is handled."
5436 #. type: Content of: <refentry><refsect1><para>
5437 #: apt-ftparchive.1.xml:144
5438 msgid "The generate configuration has four separate sections, each described below."
5441 #. type: Content of: <refentry><refsect1><refsect2><title>
5442 #: apt-ftparchive.1.xml:146
5443 msgid "<literal>Dir</literal> Section"
5446 #. type: Content of: <refentry><refsect1><refsect2><para>
5447 #: apt-ftparchive.1.xml:148
5449 "The <literal>Dir</literal> section defines the standard directories needed "
5450 "to locate the files required during the generation process. These "
5451 "directories are prepended certain relative paths defined in later sections "
5452 "to produce a complete an absolute path."
5455 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5456 #: apt-ftparchive.1.xml:155
5458 "Specifies the root of the FTP archive, in a standard Debian configuration "
5459 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5463 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5464 #: apt-ftparchive.1.xml:162
5465 msgid "Specifies the location of the override files."
5468 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5469 #: apt-ftparchive.1.xml:167
5470 msgid "Specifies the location of the cache files."
5473 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5474 #: apt-ftparchive.1.xml:172
5476 "Specifies the location of the file list files, if the "
5477 "<literal>FileList</literal> setting is used below."
5480 #. type: Content of: <refentry><refsect1><refsect2><title>
5481 #: apt-ftparchive.1.xml:178
5482 msgid "<literal>Default</literal> Section"
5485 #. type: Content of: <refentry><refsect1><refsect2><para>
5486 #: apt-ftparchive.1.xml:180
5488 "The <literal>Default</literal> section specifies default values, and "
5489 "settings that control the operation of the generator. Other sections may "
5490 "override these defaults with a per-section setting."
5493 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5494 #: apt-ftparchive.1.xml:186
5496 "Sets the default compression schemes to use for the package index files. It "
5497 "is a string that contains a space separated list of at least one of: '.' (no "
5498 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
5502 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5503 #: apt-ftparchive.1.xml:194
5505 "Sets the default list of file extensions that are package files. This "
5506 "defaults to '.deb'."
5509 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5510 #: apt-ftparchive.1.xml:200
5512 "This is similar to <literal>Packages::Compress</literal> except that it "
5513 "controls the compression for the Sources files."
5516 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5517 #: apt-ftparchive.1.xml:206
5519 "Sets the default list of file extensions that are source files. This "
5520 "defaults to '.dsc'."
5523 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5524 #: apt-ftparchive.1.xml:212
5526 "This is similar to <literal>Packages::Compress</literal> except that it "
5527 "controls the compression for the Contents files."
5530 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5531 #: apt-ftparchive.1.xml:218
5533 "This is similar to <literal>Packages::Compress</literal> except that it "
5534 "controls the compression for the Translation-en master file."
5537 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5538 #: apt-ftparchive.1.xml:224
5540 "Specifies the number of kilobytes to delink (and replace with hard links) "
5541 "per run. This is used in conjunction with the per-section "
5542 "<literal>External-Links</literal> setting."
5545 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5546 #: apt-ftparchive.1.xml:231
5548 "Specifies the mode of all created index files. It defaults to 0644. All "
5549 "index files are set to this mode with no regard to the umask."
5552 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5553 #: apt-ftparchive.1.xml:238 apt-ftparchive.1.xml:384
5555 "Specifies whether long descriptions should be included in the "
5556 "<filename>Packages</filename> file or split out into a master "
5557 "<filename>Translation-en</filename> file."
5560 #. type: Content of: <refentry><refsect1><refsect2><title>
5561 #: apt-ftparchive.1.xml:244
5562 msgid "<literal>TreeDefault</literal> Section"
5565 #. type: Content of: <refentry><refsect1><refsect2><para>
5566 #: apt-ftparchive.1.xml:246
5568 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
5569 "variables are substitution variables and have the strings $(DIST), "
5570 "$(SECTION) and $(ARCH) replaced with their respective values."
5573 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5574 #: apt-ftparchive.1.xml:253
5576 "Sets the number of kilobytes of contents files that are generated each "
5577 "day. The contents files are round-robined so that over several days they "
5578 "will all be rebuilt."
5581 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5582 #: apt-ftparchive.1.xml:260
5584 "Controls the number of days a contents file is allowed to be checked without "
5585 "changing. If this limit is passed the mtime of the contents file is "
5586 "updated. This case can occur if the package file is changed in such a way "
5587 "that does not result in a new contents file [override edit for instance]. A "
5588 "hold off is allowed in hopes that new .debs will be installed, requiring a "
5589 "new file anyhow. The default is 10, the units are in days."
5592 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5593 #: apt-ftparchive.1.xml:271
5595 "Sets the top of the .deb directory tree. Defaults to "
5596 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
5599 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5600 #: apt-ftparchive.1.xml:277
5602 "Sets the top of the source package directory tree. Defaults to "
5603 "<filename>$(DIST)/$(SECTION)/source/</filename>"
5606 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5607 #: apt-ftparchive.1.xml:283
5609 "Sets the output Packages file. Defaults to "
5610 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
5613 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5614 #: apt-ftparchive.1.xml:289
5616 "Sets the output Sources file. Defaults to "
5617 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
5620 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5621 #: apt-ftparchive.1.xml:295
5623 "Sets the output Translation-en master file with the long descriptions if "
5624 "they should be not included in the Packages file. Defaults to "
5625 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
5628 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5629 #: apt-ftparchive.1.xml:302
5631 "Sets the path prefix that causes a symlink to be considered an internal link "
5632 "instead of an external link. Defaults to "
5633 "<filename>$(DIST)/$(SECTION)/</filename>"
5636 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5637 #: apt-ftparchive.1.xml:309
5639 "Sets the output Contents file. Defaults to "
5640 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
5641 "causes multiple Packages files to map onto a single Contents file (as is the "
5642 "default) then <command>apt-ftparchive</command> will integrate those "
5643 "package files together automatically."
5646 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5647 #: apt-ftparchive.1.xml:318
5648 msgid "Sets header file to prepend to the contents output."
5651 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5652 #: apt-ftparchive.1.xml:323
5654 "Sets the binary cache database to use for this section. Multiple sections "
5655 "can share the same database."
5658 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5659 #: apt-ftparchive.1.xml:329
5661 "Specifies that instead of walking the directory tree, "
5662 "<command>apt-ftparchive</command> should read the list of files from the "
5663 "given file. Relative files names are prefixed with the archive directory."
5666 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5667 #: apt-ftparchive.1.xml:336
5669 "Specifies that instead of walking the directory tree, "
5670 "<command>apt-ftparchive</command> should read the list of files from the "
5671 "given file. Relative files names are prefixed with the archive directory. "
5672 "This is used when processing source indexes."
5675 #. type: Content of: <refentry><refsect1><refsect2><title>
5676 #: apt-ftparchive.1.xml:344
5677 msgid "<literal>Tree</literal> Section"
5680 #. type: Content of: <refentry><refsect1><refsect2><para>
5681 #: apt-ftparchive.1.xml:346
5683 "The <literal>Tree</literal> section defines a standard Debian file tree "
5684 "which consists of a base directory, then multiple sections in that base "
5685 "directory and finally multiple Architectures in each section. The exact "
5686 "pathing used is defined by the <literal>Directory</literal> substitution "
5690 #. type: Content of: <refentry><refsect1><refsect2><para>
5691 #: apt-ftparchive.1.xml:351
5693 "The <literal>Tree</literal> section takes a scope tag which sets the "
5694 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
5695 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
5696 "setting such as <filename>dists/&stable-codename;</filename>."
5699 #. type: Content of: <refentry><refsect1><refsect2><para>
5700 #: apt-ftparchive.1.xml:356
5702 "All of the settings defined in the <literal>TreeDefault</literal> section "
5703 "can be used in a <literal>Tree</literal> section as well as three new "
5707 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5708 #: apt-ftparchive.1.xml:362
5711 "for i in Sections do \n"
5712 " for j in Architectures do\n"
5713 " Generate for DIST=scope SECTION=i ARCH=j\n"
5717 #. type: Content of: <refentry><refsect1><refsect2><para>
5718 #: apt-ftparchive.1.xml:359
5720 "When processing a <literal>Tree</literal> section "
5721 "<command>apt-ftparchive</command> performs an operation similar to: "
5722 "<placeholder type=\"programlisting\" id=\"0\"/>"
5725 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5726 #: apt-ftparchive.1.xml:370
5728 "This is a space separated list of sections which appear under the "
5729 "distribution; typically this is something like <literal>main contrib "
5730 "non-free</literal>"
5733 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5734 #: apt-ftparchive.1.xml:377
5736 "This is a space separated list of all the architectures that appear under "
5737 "search section. The special architecture 'source' is used to indicate that "
5738 "this tree has a source archive."
5741 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5742 #: apt-ftparchive.1.xml:390
5744 "Sets the binary override file. The override file contains section, priority "
5745 "and maintainer address information."
5748 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5749 #: apt-ftparchive.1.xml:396
5751 "Sets the source override file. The override file contains section "
5755 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5756 #: apt-ftparchive.1.xml:402 apt-ftparchive.1.xml:448
5757 msgid "Sets the binary extra override file."
5760 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5761 #: apt-ftparchive.1.xml:407 apt-ftparchive.1.xml:453
5762 msgid "Sets the source extra override file."
5765 #. type: Content of: <refentry><refsect1><refsect2><title>
5766 #: apt-ftparchive.1.xml:412
5767 msgid "<literal>BinDirectory</literal> Section"
5770 #. type: Content of: <refentry><refsect1><refsect2><para>
5771 #: apt-ftparchive.1.xml:414
5773 "The <literal>bindirectory</literal> section defines a binary directory tree "
5774 "with no special structure. The scope tag specifies the location of the "
5775 "binary directory and the settings are similar to the <literal>Tree</literal> "
5776 "section with no substitution variables or "
5777 "<literal>Section</literal><literal>Architecture</literal> settings."
5780 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5781 #: apt-ftparchive.1.xml:422
5782 msgid "Sets the Packages file output."
5785 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5786 #: apt-ftparchive.1.xml:427
5788 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
5789 "<literal>Sources</literal> is required."
5792 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5793 #: apt-ftparchive.1.xml:433
5794 msgid "Sets the Contents file output (optional)."
5797 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5798 #: apt-ftparchive.1.xml:438
5799 msgid "Sets the binary override file."
5802 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5803 #: apt-ftparchive.1.xml:443
5804 msgid "Sets the source override file."
5807 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5808 #: apt-ftparchive.1.xml:458
5809 msgid "Sets the cache DB."
5812 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5813 #: apt-ftparchive.1.xml:463
5814 msgid "Appends a path to all the output paths."
5817 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5818 #: apt-ftparchive.1.xml:468
5819 msgid "Specifies the file list file."
5822 #. type: Content of: <refentry><refsect1><title>
5823 #: apt-ftparchive.1.xml:475
5824 msgid "The Binary Override File"
5827 #. type: Content of: <refentry><refsect1><para>
5828 #: apt-ftparchive.1.xml:476
5830 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
5831 "contains four fields separated by spaces. The first field is the package "
5832 "name, the second is the priority to force that package to, the third is the "
5833 "section to force that package to and the final field is the maintainer "
5834 "permutation field."
5837 #. type: Content of: <refentry><refsect1><para><literallayout>
5838 #: apt-ftparchive.1.xml:482
5840 msgid "old [// oldn]* => new"
5843 #. type: Content of: <refentry><refsect1><para><literallayout>
5844 #: apt-ftparchive.1.xml:484
5849 #. type: Content of: <refentry><refsect1><para>
5850 #: apt-ftparchive.1.xml:481
5852 "The general form of the maintainer field is: <placeholder "
5853 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
5854 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
5855 "separated list of old email addresses to be specified. If any of those are "
5856 "found then new is substituted for the maintainer field. The second form "
5857 "unconditionally substitutes the maintainer field."
5860 #. type: Content of: <refentry><refsect1><title>
5861 #: apt-ftparchive.1.xml:492
5862 msgid "The Source Override File"
5865 #. type: Content of: <refentry><refsect1><para>
5866 #: apt-ftparchive.1.xml:494
5868 "The source override file is fully compatible with &dpkg-scansources;. It "
5869 "contains two fields separated by spaces. The first field is the source "
5870 "package name, the second is the section to assign it."
5873 #. type: Content of: <refentry><refsect1><title>
5874 #: apt-ftparchive.1.xml:499
5875 msgid "The Extra Override File"
5878 #. type: Content of: <refentry><refsect1><para>
5879 #: apt-ftparchive.1.xml:501
5881 "The extra override file allows any arbitrary tag to be added or replaced in "
5882 "the output. It has three columns, the first is the package, the second is "
5883 "the tag and the remainder of the line is the new value."
5886 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5887 #: apt-ftparchive.1.xml:512
5889 "Generate the given checksum. These options default to on, when turned off "
5890 "the generated index files will not have the checksum fields where possible. "
5891 "Configuration Items: "
5892 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
5893 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
5894 "where <literal><replaceable>Index</replaceable></literal> can be "
5895 "<literal>Packages</literal>, <literal>Sources</literal> or "
5896 "<literal>Release</literal> and "
5897 "<literal><replaceable>Checksum</replaceable></literal> can be "
5898 "<literal>MD5</literal>, <literal>SHA1</literal> or "
5899 "<literal>SHA256</literal>."
5902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5903 #: apt-ftparchive.1.xml:523
5905 "Use a binary caching DB. This has no effect on the generate command. "
5906 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
5909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5910 #: apt-ftparchive.1.xml:529
5912 "Quiet; produces output suitable for logging, omitting progress indicators. "
5913 "More q's will produce more quiet up to a maximum of 2. You can also use "
5914 "<option>-q=#</option> to set the quiet level, overriding the configuration "
5915 "file. Configuration Item: <literal>quiet</literal>."
5918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5919 #: apt-ftparchive.1.xml:537
5921 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
5922 "then this option actually enables delinking of the files. It defaults to on "
5923 "and can be turned off with <option>--no-delink</option>. Configuration "
5924 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
5927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5928 #: apt-ftparchive.1.xml:545
5930 "Perform contents generation. When this option is set and package indexes are "
5931 "being generated with a cache DB then the file listing will also be extracted "
5932 "and stored in the DB for later use. When using the generate command this "
5933 "option also allows the creation of any Contents files. The default is on. "
5934 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
5937 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5938 #: apt-ftparchive.1.xml:555
5940 "Select the source override file to use with the <literal>sources</literal> "
5941 "command. Configuration Item: "
5942 "<literal>APT::FTPArchive::SourceOverride</literal>."
5945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5946 #: apt-ftparchive.1.xml:561
5948 "Make the caching databases read only. Configuration Item: "
5949 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
5952 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5953 #: apt-ftparchive.1.xml:566
5955 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
5956 "commands only package files matching <literal>*_arch.deb</literal> or "
5957 "<literal>*_all.deb</literal> instead of all package files in the given "
5958 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
5961 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5962 #: apt-ftparchive.1.xml:574
5964 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
5965 "packages are recompiled and/or republished with the same version again, this "
5966 "will lead to problems as the now outdated cached metadata like size and "
5967 "checksums will be used. With this option enabled this will no longer happen "
5968 "as it will be checked if the file was changed. Note that this option is set "
5969 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
5970 "multiply versions/builds of a package with the same versionnumber, so in "
5971 "theory nobody will have these problems and therefore all these extra checks "
5975 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5976 #: apt-ftparchive.1.xml:586
5978 "This configuration option defaults to \"<literal>true</literal>\" and should "
5979 "only be set to <literal>\"false\"</literal> if the Archive generated with "
5980 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
5981 "that the <filename>Translation-en</filename> master file can only be created "
5982 "in the generate command."
5985 #. type: Content of: <refentry><refsect1><para><programlisting>
5986 #: apt-ftparchive.1.xml:604
5989 "<command>apt-ftparchive</command> packages "
5990 "<replaceable>directory</replaceable> | <command>gzip</command> > "
5991 "<filename>Packages.gz</filename>\n"
5994 #. type: Content of: <refentry><refsect1><para>
5995 #: apt-ftparchive.1.xml:600
5997 "To create a compressed Packages file for a directory containing binary "
5998 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6001 #. type: Content of: <refentry><refsect1><para>
6002 #: apt-ftparchive.1.xml:614
6004 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6008 #. type: Attribute 'lang' of: <book>
6009 #: guide.dbk:8 offline.dbk:8
6013 #. type: Content of: <book><title>
6015 msgid "APT User's Guide"
6018 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6019 #: guide.dbk:16 offline.dbk:16
6020 msgid "Jason Gunthorpe"
6023 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6024 #: guide.dbk:16 offline.dbk:16
6025 msgid "jgg@debian.org"
6028 #. type: Content of: <book><bookinfo><releaseinfo>
6029 #: guide.dbk:20 offline.dbk:20
6030 msgid "Version &apt-product-version;"
6033 #. type: Content of: <book><bookinfo><abstract><para>
6036 "This document provides an overview of how to use the the APT package "
6040 #. type: Content of: <book><bookinfo>
6042 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6045 #. type: Content of: <book><bookinfo><legalnotice><title>
6046 #: guide.dbk:31 offline.dbk:32
6047 msgid "License Notice"
6050 #. type: Content of: <book><bookinfo><legalnotice><para>
6051 #: guide.dbk:33 offline.dbk:34
6053 "\"APT\" and this document are free software; you can redistribute them "
6054 "and/or modify them under the terms of the GNU General Public License as "
6055 "published by the Free Software Foundation; either version 2 of the License, "
6056 "or (at your option) any later version."
6059 #. type: Content of: <book><bookinfo><legalnotice><para>
6060 #: guide.dbk:42 offline.dbk:40
6062 "For more details, on Debian systems, see the file "
6063 "/usr/share/common-licenses/GPL for the full license."
6066 #. type: Content of: <book><chapter><title>
6071 #. type: Content of: <book><chapter><para>
6074 "The APT package currently contains two sections, the APT "
6075 "<command>dselect</command> method and the <command>apt-get</command> command "
6076 "line user interface. Both provide a way to install and remove packages as "
6077 "well as download new packages from the Internet."
6080 #. type: Content of: <book><chapter><section><title>
6082 msgid "Anatomy of the Package System"
6085 #. type: Content of: <book><chapter><section><para>
6088 "The Debian packaging system has a large amount of information associated "
6089 "with each package to help assure that it integrates cleanly and easily into "
6090 "the system. The most prominent of its features is the dependency system."
6093 #. type: Content of: <book><chapter><section><para>
6096 "The dependency system allows individual programs to make use of shared "
6097 "elements in the system such as libraries. It simplifies placing infrequently "
6098 "used portions of a program in separate packages to reduce the number of "
6099 "things the average user is required to install. Also, it allows for choices "
6100 "in mail transport agents, X servers and so on."
6103 #. type: Content of: <book><chapter><section><para>
6106 "The first step to understanding the dependency system is to grasp the "
6107 "concept of a simple dependency. The meaning of a simple dependency is that a "
6108 "package requires another package to be installed at the same time to work "
6112 #. type: Content of: <book><chapter><section><para>
6115 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6116 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6117 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6118 "simple dependency on emacs, without emacs it is completely useless."
6121 #. type: Content of: <book><chapter><section><para>
6124 "The other important dependency to understand is a conflicting dependency. It "
6125 "means that a package, when installed with another package, will not work and "
6126 "may possibly be extremely harmful to the system. As an example consider a "
6127 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6128 "have two mail transport agents installed because both need to listen to the "
6129 "network to receive mail. Attempting to install two will seriously damage the "
6130 "system so all mail transport agents have a conflicting dependency with all "
6131 "other mail transport agents."
6134 #. type: Content of: <book><chapter><section><para>
6137 "As an added complication there is the possibility for a package to pretend "
6138 "to be another package. Consider that exim and sendmail for many intents are "
6139 "identical, they both deliver mail and understand a common interface. Hence, "
6140 "the package system has a way for them to declare that they are both "
6141 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6142 "a mail-transport-agent and other packages that need a mail transport agent "
6143 "depend on mail-transport-agent. This can add a great deal of confusion when "
6144 "trying to manually fix packages."
6147 #. type: Content of: <book><chapter><section><para>
6150 "At any given time a single dependency may be met by packages that are "
6151 "already installed or it may not be. APT attempts to help resolve dependency "
6152 "issues by providing a number of automatic algorithms that help in selecting "
6153 "packages for installation."
6156 #. type: Content of: <book><chapter><title>
6161 #. type: Content of: <book><chapter><para>
6164 "<command>apt-get</command> provides a simple way to install packages from "
6165 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6166 "does not understand .deb files, it works with the package's proper name and "
6167 "can only install .deb archives from a <emphasis>Source</emphasis>."
6170 #. type: Content of: <book><chapter><para><footnote><para>
6173 "If you are using an http proxy server you must set the http_proxy "
6174 "environment variable first, see sources.list(5)"
6177 #. type: Content of: <book><chapter><para>
6180 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6181 "done before using <command>apt-get</command> is to fetch the package lists "
6182 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6183 "available. This is done with <literal>apt-get update</literal>. For "
6187 #. type: Content of: <book><chapter><screen>
6191 "# apt-get update\n"
6192 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6193 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6194 "Reading Package Lists... Done\n"
6195 "Building Dependency Tree... Done\n"
6198 #. type: Content of: <book><chapter><para>
6200 msgid "Once updated there are several commands that can be used:"
6203 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6208 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6211 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6212 "install a new package or remove an existing package, nor will it ever "
6213 "upgrade a package that might cause some other package to break. This can be "
6214 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6215 "the packages that it could not upgrade, this usually means that they depend "
6216 "on new packages or conflict with some other "
6217 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6218 "can be used to force these packages to install."
6221 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6226 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6229 "Install is used to install packages by name. The package is automatically "
6230 "fetched and installed. This can be useful if you already know the name of "
6231 "the package to install and do not want to go into a GUI to select it. Any "
6232 "number of packages may be passed to install, they will all be "
6233 "fetched. Install automatically attempts to resolve dependency problems with "
6234 "the listed packages and will print a summary and ask for confirmation if "
6235 "anything other than its arguments are changed."
6238 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6240 msgid "dist-upgrade"
6243 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6246 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6247 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6248 "set of packages to install, upgrade and remove to get as much of the system "
6249 "to the newest release. In some situations it may be desired to use "
6250 "dist-upgrade rather than spend the time manually resolving dependencies in "
6251 "<command>dselect</command>. Once dist-upgrade has completed then "
6252 "<command>dselect</command> can be used to install any packages that may have "
6256 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6259 "It is important to closely look at what dist-upgrade is going to do, its "
6260 "decisions may sometimes be quite surprising."
6263 #. type: Content of: <book><chapter><para>
6266 "<command>apt-get</command> has several command line options that are "
6267 "detailed in its man page, "
6268 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
6269 "The most useful option is <literal>-d</literal> which does not install the "
6270 "fetched files. If the system has to download a large number of package it "
6271 "would be undesired to start installing them in case something goes "
6272 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
6273 "installed by simply running the command that caused them to be downloaded "
6274 "again without <literal>-d</literal>."
6277 #. type: Content of: <book><chapter><title>
6282 #. type: Content of: <book><chapter><para>
6285 "The APT <command>dselect</command> method provides the complete APT system "
6286 "with the <command>dselect</command> package selection "
6287 "GUI. <command>dselect</command> is used to select the packages to be "
6288 "installed or removed and APT actually installs them."
6291 #. type: Content of: <book><chapter><para>
6294 "To enable the APT method you need to select [A]ccess in "
6295 "<command>dselect</command> and then choose the APT method. You will be "
6296 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
6297 "archives from. These can be remote Internet sites, local Debian mirrors or "
6298 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
6299 "will automatically combine them to form a complete set of packages. If you "
6300 "have a CD-ROM then it is a good idea to specify it first and then specify a "
6301 "mirror so that you have access to the latest bug fixes. APT will "
6302 "automatically use packages on your CD-ROM before downloading from the "
6306 #. type: Content of: <book><chapter><screen>
6310 " Set up a list of distribution source locations\n"
6312 " Please give the base URL of the debian distribution.\n"
6313 " The access schemes I know about are: http file\n"
6316 " file:/mnt/debian,\n"
6317 " ftp://ftp.debian.org/debian,\n"
6318 " http://ftp.de.debian.org/debian,\n"
6321 " URL [http://llug.sep.bnl.gov/debian]:\n"
6324 #. type: Content of: <book><chapter><para>
6327 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
6328 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
6329 "distribution to get."
6332 #. type: Content of: <book><chapter><screen>
6336 " Please give the distribution tag to get or a path to the\n"
6337 " package file ending in a /. The distribution\n"
6338 " tags are typically something like: stable unstable testing non-US\n"
6340 " Distribution [stable]:\n"
6343 #. type: Content of: <book><chapter><para>
6346 "The distribution refers to the Debian version in the archive, "
6347 "<emphasis>stable</emphasis> refers to the latest released version and "
6348 "<emphasis>unstable</emphasis> refers to the developmental "
6349 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
6350 "refers to packages that contain encryption technology or other things that "
6351 "cannot be exported from the United States. Importing these packages into the "
6352 "US is legal however."
6355 #. type: Content of: <book><chapter><screen>
6359 " Please give the components to get\n"
6360 " The components are typically something like: main contrib non-free\n"
6362 " Components [main contrib non-free]:\n"
6365 #. type: Content of: <book><chapter><para>
6368 "The components list refers to the list of sub distributions to fetch. The "
6369 "distribution is split up based on software licenses, main being DFSG free "
6370 "packages while contrib and non-free contain things that have various "
6371 "restrictions placed on their use and distribution."
6374 #. type: Content of: <book><chapter><para>
6377 "Any number of sources can be added, the setup script will continue to prompt "
6378 "until you have specified all that you want."
6381 #. type: Content of: <book><chapter><para>
6384 "Before starting to use <command>dselect</command> it is necessary to update "
6385 "the available list by selecting [U]pdate from the menu. This is a superset "
6386 "of <literal>apt-get update</literal> that makes the fetched information "
6387 "available to <command>dselect</command>. [U]pdate must be performed even if "
6388 "<literal>apt-get update</literal> has been run before."
6391 #. type: Content of: <book><chapter><para>
6394 "You can then go on and make your selections using [S]elect and then perform "
6395 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6396 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6400 #. type: Content of: <book><chapter><para>
6403 "By default APT will automatically remove the package (.deb) files once they "
6404 "have been successfully installed. To change this behavior place "
6405 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
6408 #. type: Content of: <book><chapter><title>
6410 msgid "The Interface"
6413 #. type: Content of: <book><chapter><para><footnote><para>
6416 "The <command>dselect</command> method actually is a set of wrapper scripts "
6417 "to <command>apt-get</command>. The method actually provides more "
6418 "functionality than is present in <command>apt-get</command> alone."
6421 #. type: Content of: <book><chapter><para>
6424 "Both that APT <command>dselect</command> method and "
6425 "<command>apt-get</command> share the same interface. It is a simple system "
6426 "that generally tells you what it will do and then goes and does "
6427 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
6428 "of what will happen APT then will print out some informative status messages "
6429 "so that you can estimate how far along it is and how much is left to do."
6432 #. type: Content of: <book><chapter><section><title>
6437 #. type: Content of: <book><chapter><section><para>
6440 "Before all operations except update, APT performs a number of actions to "
6441 "prepare its internal state. It also does some checks of the system's "
6442 "state. At any time these operations can be performed by running "
6443 "<literal>apt-get check</literal>."
6446 #. type: Content of: <book><chapter><section><screen>
6451 "Reading Package Lists... Done\n"
6452 "Building Dependency Tree... Done\n"
6455 #. type: Content of: <book><chapter><section><para>
6458 "The first thing it does is read all the package files into memory. APT uses "
6459 "a caching scheme so this operation will be faster the second time it is "
6460 "run. If some of the package files are not found then they will be ignored "
6461 "and a warning will be printed when apt-get exits."
6464 #. type: Content of: <book><chapter><section><para>
6467 "The final operation performs a detailed analysis of the system's "
6468 "dependencies. It checks every dependency of every installed or unpacked "
6469 "package and considers if it is OK. Should this find a problem then a report "
6470 "will be printed out and <command>apt-get</command> will refuse to run."
6473 #. type: Content of: <book><chapter><section><screen>
6478 "Reading Package Lists... Done\n"
6479 "Building Dependency Tree... Done\n"
6480 "You might want to run apt-get -f install' to correct these.\n"
6481 "Sorry, but the following packages have unmet dependencies:\n"
6482 " 9fonts: Depends: xlib6g but it is not installed\n"
6483 " uucp: Depends: mailx but it is not installed\n"
6484 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6485 " adduser: Depends: perl-base but it is not installed\n"
6486 " aumix: Depends: libgpmg1 but it is not installed\n"
6487 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6488 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6489 " cthugha: Depends: svgalibg1 but it is not installed\n"
6490 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6491 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
6494 #. type: Content of: <book><chapter><section><para>
6497 "In this example the system has many problems, including a serious problem "
6498 "with libreadlineg2. For each package that has unmet dependencies a line is "
6499 "printed out indicating the package with the problem and the dependencies "
6500 "that are unmet. A short explanation of why the package has a dependency "
6501 "problem is also included."
6504 #. type: Content of: <book><chapter><section><para><footnote><para>
6507 "APT however considers all known dependencies and attempts to prevent broken "
6511 #. type: Content of: <book><chapter><section><para>
6514 "There are two ways a system can get into a broken state like this. The first "
6515 "is caused by <command>dpkg</command> missing some subtle relationships "
6516 "between packages when performing upgrades. <placeholder type=\"footnote\" "
6517 "id=\"0\"/>. The second is if a package installation fails during an "
6518 "operation. In this situation a package may have been unpacked without its "
6519 "dependents being installed."
6522 #. type: Content of: <book><chapter><section><para>
6525 "The second situation is much less serious than the first because APT places "
6526 "certain constraints on the order that packages are installed. In both cases "
6527 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
6528 "will cause APT to deduce a possible solution to the problem and then "
6529 "continue on. The APT <command>dselect</command> method always supplies the "
6530 "<literal>-f</literal> option to allow for easy continuation of failed "
6531 "maintainer scripts."
6534 #. type: Content of: <book><chapter><section><para>
6537 "However, if the <literal>-f</literal> option is used to correct a seriously "
6538 "broken system caused by the first case then it is possible that it will "
6539 "either fail immediately or the installation sequence will fail. In either "
6540 "case it is necessary to manually use dpkg (possibly with forcing options) to "
6541 "correct the situation enough to allow APT to proceed."
6544 #. type: Content of: <book><chapter><section><title>
6546 msgid "The Status Report"
6549 #. type: Content of: <book><chapter><section><para>
6552 "Before proceeding <command>apt-get</command> will present a report on what "
6553 "will happen. Generally the report reflects the type of operation being "
6554 "performed but there are several common elements. In all cases the lists "
6555 "reflect the final state of things, taking into account the "
6556 "<literal>-f</literal> option and any other relevant activities to the "
6557 "command being executed."
6560 #. type: Content of: <book><chapter><section><section><title>
6562 msgid "The Extra Package list"
6565 #. type: Content of: <book><chapter><section><section><screen>
6569 "The following extra packages will be installed:\n"
6570 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6571 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6572 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6573 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6577 #. type: Content of: <book><chapter><section><section><para>
6580 "The Extra Package list shows all of the packages that will be installed or "
6581 "upgraded in excess of the ones mentioned on the command line. It is only "
6582 "generated for an <literal>install</literal> command. The listed packages are "
6583 "often the result of an Auto Install."
6586 #. type: Content of: <book><chapter><section><section><title>
6588 msgid "The Packages to Remove"
6591 #. type: Content of: <book><chapter><section><section><screen>
6595 "The following packages will be REMOVED:\n"
6596 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6597 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6598 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6599 " nas xpilot xfig\n"
6602 #. type: Content of: <book><chapter><section><section><para>
6605 "The Packages to Remove list shows all of the packages that will be removed "
6606 "from the system. It can be shown for any of the operations and should be "
6607 "given a careful inspection to ensure nothing important is to be taken "
6608 "off. The <literal>-f</literal> option is especially good at generating "
6609 "packages to remove so extreme care should be used in that case. The list may "
6610 "contain packages that are going to be removed because they are only "
6611 "partially installed, possibly due to an aborted installation."
6614 #. type: Content of: <book><chapter><section><section><title>
6616 msgid "The New Packages list"
6619 #. type: Content of: <book><chapter><section><section><screen>
6623 "The following NEW packages will installed:\n"
6624 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
6627 #. type: Content of: <book><chapter><section><section><para>
6630 "The New Packages list is simply a reminder of what will happen. The packages "
6631 "listed are not presently installed in the system but will be when APT is "
6635 #. type: Content of: <book><chapter><section><section><title>
6637 msgid "The Kept Back list"
6640 #. type: Content of: <book><chapter><section><section><screen>
6644 "The following packages have been kept back\n"
6645 " compface man-db tetex-base msql libpaper svgalib1\n"
6646 " gs snmp arena lynx xpat2 groff xscreensaver\n"
6649 #. type: Content of: <book><chapter><section><section><para>
6652 "Whenever the whole system is being upgraded there is the possibility that "
6653 "new versions of packages cannot be installed because they require new things "
6654 "or conflict with already installed things. In this case the package will "
6655 "appear in the Kept Back list. The best way to convince packages listed there "
6656 "to install is with <literal>apt-get install</literal> or by using "
6657 "<command>dselect</command> to resolve their problems."
6660 #. type: Content of: <book><chapter><section><section><title>
6662 msgid "Held Packages warning"
6665 #. type: Content of: <book><chapter><section><section><screen>
6669 "The following held packages will be changed:\n"
6673 #. type: Content of: <book><chapter><section><section><para>
6676 "Sometimes you can ask APT to install a package that is on hold, in such a "
6677 "case it prints out a warning that the held package is going to be "
6678 "changed. This should only happen during dist-upgrade or install."
6681 #. type: Content of: <book><chapter><section><section><title>
6683 msgid "Final summary"
6686 #. type: Content of: <book><chapter><section><section><para>
6688 msgid "Finally, APT will print out a summary of all the changes that will occur."
6691 #. type: Content of: <book><chapter><section><section><screen>
6695 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6697 "12 packages not fully installed or removed.\n"
6698 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
6701 #. type: Content of: <book><chapter><section><section><para>
6704 "The first line of the summary simply is a reduced version of all of the "
6705 "lists and includes the number of upgrades - that is packages already "
6706 "installed that have new versions available. The second line indicates the "
6707 "number of poorly configured packages, possibly the result of an aborted "
6708 "installation. The final line shows the space requirements that the "
6709 "installation needs. The first pair of numbers refer to the size of the "
6710 "archive files. The first number indicates the number of bytes that must be "
6711 "fetched from remote locations and the second indicates the total size of all "
6712 "the archives required. The next number indicates the size difference between "
6713 "the presently installed packages and the newly installed packages. It is "
6714 "roughly equivalent to the space required in /usr after everything is "
6715 "done. If a large number of packages are being removed then the value may "
6716 "indicate the amount of space that will be freed."
6719 #. type: Content of: <book><chapter><section><section><para>
6722 "Some other reports can be generated by using the -u option to show packages "
6723 "to upgrade, they are similar to the previous examples."
6726 #. type: Content of: <book><chapter><section><title>
6728 msgid "The Status Display"
6731 #. type: Content of: <book><chapter><section><para>
6734 "During the download of archives and package files APT prints out a series of "
6738 #. type: Content of: <book><chapter><section><screen>
6742 "# apt-get update\n"
6743 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6744 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6745 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6746 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6748 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6749 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
6752 #. type: Content of: <book><chapter><section><para>
6755 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
6756 "begins to fetch a file while the last line indicates the progress of the "
6757 "download. The first percent value on the progress line indicates the total "
6758 "percent done of all files. Unfortunately since the size of the Package files "
6759 "is unknown <literal>apt-get update</literal> estimates the percent done "
6760 "which causes some inaccuracies."
6763 #. type: Content of: <book><chapter><section><para>
6766 "The next section of the status line is repeated once for each download "
6767 "thread and indicates the operation being performed and some useful "
6768 "information about what is happening. Sometimes this section will simply read "
6769 "<emphasis>Forking</emphasis> which means the OS is loading the download "
6770 "module. The first word after the [ is the fetch number as shown on the "
6771 "history lines. The next word is the short form name of the object being "
6772 "downloaded. For archives it will contain the name of the package that is "
6776 #. type: Content of: <book><chapter><section><para>
6779 "Inside of the single quote is an informative string indicating the progress "
6780 "of the negotiation phase of the download. Typically it progresses from "
6781 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
6782 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
6783 "value is the number of bytes downloaded from the remote site. Once the "
6784 "download begins this is represented as <literal>102/10.2k</literal> "
6785 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
6786 "expected. The total size is always shown in 4 figure notation to preserve "
6787 "space. After the size display is a percent meter for the file itself. The "
6788 "second last element is the instantaneous average speed. This values is "
6789 "updated every 5 seconds and reflects the rate of data transfer for that "
6790 "period. Finally is shown the estimated transfer time. This is updated "
6791 "regularly and reflects the time to complete everything at the shown transfer "
6795 #. type: Content of: <book><chapter><section><para>
6798 "The status display updates every half second to provide a constant feedback "
6799 "on the download progress while the Get lines scroll back whenever a new file "
6800 "is started. Since the status display is constantly updated it is unsuitable "
6801 "for logging to a file, use the <literal>-q</literal> option to remove the "
6805 #. type: Content of: <book><chapter><section><title>
6810 #. type: Content of: <book><chapter><section><para>
6813 "APT uses <command>dpkg</command> for installing the archives and will switch "
6814 "over to the <command>dpkg</command> interface once downloading is "
6815 "completed. <command>dpkg</command> will also ask a number of questions as it "
6816 "processes the packages and the packages themselves may also ask several "
6817 "questions. Before each question there is usually a description of what it is "
6818 "asking and the questions are too varied to discuss completely here."
6821 #. type: Content of: <book><title>
6823 msgid "Using APT Offline"
6826 #. type: Content of: <book><bookinfo><abstract><para>
6829 "This document describes how to use APT in a non-networked environment, "
6830 "specifically a 'sneaker-net' approach for performing upgrades."
6833 #. type: Content of: <book><bookinfo>
6835 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
6838 #. type: Content of: <book><chapter><title>
6840 msgid "Introduction"
6843 #. type: Content of: <book><chapter><section><title>
6844 #: offline.dbk:49 offline.dbk:79 offline.dbk:191
6848 #. type: Content of: <book><chapter><section><para>
6851 "Normally APT requires direct access to a Debian archive, either from a local "
6852 "media or through a network. Another common complaint is that a Debian "
6853 "machine is on a slow link, such as a modem and another machine has a very "
6854 "fast connection but they are physically distant."
6857 #. type: Content of: <book><chapter><section><para>
6860 "The solution to this is to use large removable media such as a Zip disc or a "
6861 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6862 "archive but can easily fit a subset large enough for most users. The idea is "
6863 "to use APT to generate a list of packages that are required and then fetch "
6864 "them onto the disc using another machine with good connectivity. It is even "
6865 "possible to use another Debian machine with APT or to use a completely "
6866 "different OS and a download tool like wget. Let <emphasis>remote "
6867 "host</emphasis> mean the machine downloading the packages, and "
6868 "<emphasis>target host</emphasis> the one with bad or no connection."
6871 #. type: Content of: <book><chapter><section><para>
6874 "This is achieved by creatively manipulating the APT configuration file. The "
6875 "essential premise to tell APT to look on a disc for it's archive files. Note "
6876 "that the disc should be formated with a filesystem that can handle long file "
6877 "names such as ext2, fat32 or vfat."
6880 #. type: Content of: <book><chapter><title>
6882 msgid "Using APT on both machines"
6885 #. type: Content of: <book><chapter><section><para>
6888 "APT being available on both machines gives the simplest configuration. The "
6889 "basic idea is to place a copy of the status file on the disc and use the "
6890 "remote machine to fetch the latest package files and decide which packages "
6891 "to download. The disk directory structure should look like:"
6894 #. type: Content of: <book><chapter><section><screen>
6908 #. type: Content of: <book><chapter><section><title>
6910 msgid "The configuration file"
6913 #. type: Content of: <book><chapter><section><para>
6916 "The configuration file should tell APT to store its files on the disc and to "
6917 "use the configuration files on the disc as well. The sources.list should "
6918 "contain the proper sites that you wish to use from the remote machine, and "
6919 "the status file should be a copy of "
6920 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
6921 "host</emphasis>. Please note, if you are using a local archive you must use "
6922 "copy URIs, the syntax is identical to file URIs."
6925 #. type: Content of: <book><chapter><section><para>
6928 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
6932 #. type: Content of: <book><chapter><section><screen>
6938 " /* This is not necessary if the two machines are the same arch, it "
6940 " the remote APT what architecture the target machine is */\n"
6941 " Architecture \"i386\";\n"
6943 " Get::Download-Only \"true\";\n"
6948 " /* Use the disc for state information and redirect the status file from\n"
6949 " the /var/lib/dpkg default */\n"
6950 " State \"/disc/\";\n"
6951 " State::status \"status\";\n"
6953 " // Binary caches will be stored locally\n"
6954 " Cache::archives \"/disc/archives/\";\n"
6955 " Cache \"/tmp/\";\n"
6957 " // Location of the source list.\n"
6958 " Etc \"/disc/\";\n"
6962 #. type: Content of: <book><chapter><section><para>
6965 "More details can be seen by examining the apt.conf man page and the sample "
6966 "configuration file in "
6967 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
6970 #. type: Content of: <book><chapter><section><para>
6973 "On the target machine the first thing to do is mount the disc and copy "
6974 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
6975 "create the directories outlined in the Overview, "
6976 "<emphasis>archives/partial/</emphasis> and "
6977 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
6978 "machine and configure the sources.list. On the remote machine execute the "
6982 #. type: Content of: <book><chapter><section><screen>
6986 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6987 " # apt-get update\n"
6988 " [ APT fetches the package files ]\n"
6989 " # apt-get dist-upgrade\n"
6990 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
6993 #. type: Content of: <book><chapter><section><para>
6996 "The dist-upgrade command can be replaced with any other standard APT "
6997 "commands, particularly dselect-upgrade. You can even use an APT front end "
6998 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
6999 "communicating your selections back to the local computer."
7002 #. type: Content of: <book><chapter><section><para>
7005 "Now the disc contains all of the index files and archives needed to upgrade "
7006 "the target machine. Take the disc back and run:"
7009 #. type: Content of: <book><chapter><section><screen>
7013 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7014 " # apt-get check\n"
7015 " [ APT generates a local copy of the cache files ]\n"
7016 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7017 " [ Or any other APT command ]\n"
7020 #. type: Content of: <book><chapter><section><para>
7023 "It is necessary for proper function to re-specify the status file to be the "
7024 "local one. This is very important!"
7027 #. type: Content of: <book><chapter><section><para>
7030 "If you are using dselect you can do the very risky operation of copying "
7031 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7032 "remote machine are updated. I highly recommend that people only make "
7033 "selections on the local machine - but this may not always be possible. DO "
7034 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7037 #. type: Content of: <book><chapter><title>
7039 msgid "Using APT and wget"
7042 #. type: Content of: <book><chapter><section><para>
7045 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7046 "run on nearly any machine. Unlike the method above this requires that the "
7047 "Debian machine already has a list of available packages."
7050 #. type: Content of: <book><chapter><section><para>
7053 "The basic idea is to create a disc that has only the archive files "
7054 "downloaded from the remote site. This is done by using the --print-uris "
7055 "option to apt-get and then preparing a wget script to actually fetch the "
7059 #. type: Content of: <book><chapter><section><title>
7064 #. type: Content of: <book><chapter><section><para>
7067 "Unlike the previous technique no special configuration files are "
7068 "required. We merely use the standard APT commands to generate the file list."
7071 #. type: Content of: <book><chapter><section><screen>
7075 " # apt-get dist-upgrade\n"
7076 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7077 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7078 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7081 #. type: Content of: <book><chapter><section><para>
7084 "Any command other than dist-upgrade could be used here, including "
7088 #. type: Content of: <book><chapter><section><para>
7091 "The /disc/wget-script file will now contain a list of wget commands to "
7092 "execute in order to fetch the necessary archives. This script should be run "
7093 "with the current directory as the disc's mount point so as to save the "
7094 "output on the disc."
7097 #. type: Content of: <book><chapter><section><para>
7099 msgid "The remote machine would do something like"
7102 #. type: Content of: <book><chapter><section><screen>
7107 " # sh -x ./wget-script\n"
7111 #. type: Content of: <book><chapter><section><para>
7114 "Once the archives are downloaded and the disc returned to the Debian machine "
7115 "installation can proceed using,"
7118 #. type: Content of: <book><chapter><section><screen>
7121 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7124 #. type: Content of: <book><chapter><section><para>
7126 msgid "Which will use the already fetched archives on the disc."