1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the apt-doc package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: apt-doc 0.9.15.5\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2014-02-28 10:56+0100\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
24 "<!ENTITY apt-author.team \"\n"
26 " <othername>APT team</othername>\n"
27 " <contrib></contrib>\n"
36 "<!ENTITY apt-qapage \"\n"
38 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
47 "<!-- Boiler plate Bug reporting section -->\n"
48 "<!ENTITY manbugs \"\n"
49 " <refsect1><title>Bugs</title>\n"
50 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
51 " If you wish to report a bug in APT, please see\n"
52 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
53 " &reportbug; command.\n"
63 "<!-- Boiler plate Author section -->\n"
64 "<!ENTITY manauthor \"\n"
65 " <refsect1><title>Author</title>\n"
66 " <para>APT was written by the APT team "
67 "<email>apt@packages.debian.org</email>.\n"
77 "<!-- Should be used within the option section of the text to\n"
78 " put in the blurb about -h, -v, -c and -o -->\n"
79 "<!ENTITY apt-commonoptions \"\n"
80 " <varlistentry><term><option>-h</option></term>\n"
81 " <term><option>--help</option></term>\n"
82 " <listitem><para>Show a short usage summary.\n"
93 " <term><option>-v</option></term>\n"
94 " <term><option>--version</option></term>\n"
95 " <listitem><para>Show the program version.\n"
106 " <term><option>-c</option></term>\n"
107 " <term><option>--config-file</option></term>\n"
108 " <listitem><para>Configuration File; Specify a configuration file to "
110 " The program will read the default configuration file and then this \n"
111 " configuration file. If configuration settings need to be set before "
113 " default configuration files are parsed specify a file with the "
114 "<envar>APT_CONFIG</envar>\n"
115 " environment variable. See &apt-conf; for syntax information.\n"
126 " <term><option>-o</option></term>\n"
127 " <term><option>--option</option></term>\n"
128 " <listitem><para>Set a Configuration Option; This will set an "
130 " configuration option. The syntax is <option>-o "
131 "Foo::Bar=bar</option>.\n"
132 " <option>-o</option> and <option>--option</option> can be used "
134 " times to set different options.\n"
145 "<!-- Should be used within the option section of the text to\n"
146 " put in the blurb about -h, -v, -c and -o -->\n"
147 "<!ENTITY apt-cmdblurb \"\n"
148 " <para>All command line options may be set using the configuration file, "
150 " descriptions indicate the configuration option to set. For boolean\n"
151 " options you can override the config file by using something like \n"
152 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
153 " or several other variations.\n"
162 "<!ENTITY file-aptconf \"\n"
163 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
164 " <listitem><para>APT configuration file.\n"
165 " Configuration Item: "
166 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
174 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
175 " <listitem><para>APT configuration file fragments.\n"
176 " Configuration Item: "
177 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
186 "<!ENTITY file-cachearchives \"\n"
187 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
188 " <listitem><para>Storage area for retrieved package files.\n"
189 " Configuration Item: "
190 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
199 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
200 " <listitem><para>Storage area for package files in transit.\n"
201 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
202 "(<filename>partial</filename> will be implicitly "
203 "appended)</para></listitem>\n"
212 "<!ENTITY file-preferences \"\n"
213 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
214 " <listitem><para>Version preferences file.\n"
215 " This is where you would specify "pinning",\n"
216 " i.e. a preference to get certain packages\n"
217 " from a separate source\n"
218 " or from a different version of a distribution.\n"
219 " Configuration Item: "
220 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
229 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
230 " <listitem><para>File fragments for the version preferences.\n"
231 " Configuration Item: "
232 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
241 "<!ENTITY file-sourceslist \"\n"
242 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
243 " <listitem><para>Locations to fetch packages from.\n"
244 " Configuration Item: "
245 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
254 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
255 " <listitem><para>File fragments for locations to fetch packages from.\n"
256 " Configuration Item: "
257 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
266 "<!ENTITY file-statelists \"\n"
267 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
268 " <listitem><para>Storage area for state information for each package "
269 "resource specified in\n"
271 " Configuration Item: "
272 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
281 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
282 " <listitem><para>Storage area for state information in transit.\n"
283 " Configuration Item: <literal>Dir::State::Lists</literal> "
284 "(<filename>partial</filename> will be implicitly "
285 "appended)</para></listitem>\n"
294 "<!ENTITY file-trustedgpg \"\n"
295 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
296 " <listitem><para>Keyring of local trusted keys, new keys will be added "
298 " Configuration Item: "
299 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
308 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
309 " <listitem><para>File fragments for the trusted keys, additional "
311 " be stored here (by other packages or the administrator).\n"
312 " Configuration Item "
313 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
322 "<!ENTITY file-extended_states \"\n"
324 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
325 " <listitem><para>Status list of auto-installed packages.\n"
326 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
327 " </para></listitem>\n"
336 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
338 " to the other headers like NAME and DESCRIPTION and should therefore be "
340 "<!ENTITY translation-title \"TRANSLATION\">\n"
347 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
349 " to the translation in the past, who is responsible now and maybe "
350 "further information\n"
351 " specially related to your translation. -->\n"
352 "<!ENTITY translation-holder \"\n"
353 " The english translation was done by John Doe "
354 "<email>john@doe.org</email> in 2009,\n"
355 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
357 " Debian Dummy l10n Team "
358 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
366 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
367 "untranslated/fuzzy strings\n"
368 " in a shipped manpage newer/modified paragraphs will maybe appear in "
370 " the generated manpage. This sentence is therefore here to tell the "
372 " is not a mistake by the translator - obviously the target is that at "
374 " releases this sentence is not needed. :) -->\n"
375 "<!ENTITY translation-english \"\n"
376 " Note that this translated document may contain untranslated parts.\n"
377 " This is done on purpose, to avoid losing content when the\n"
378 " translation is lagging behind the original content.\n"
385 "<!-- TRANSLATOR: used as in -o=config_string "
386 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
393 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
394 "synopsis-config-file \"config_file\">"
400 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
401 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
402 "\"target_release\">"
408 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
409 "synopsis-architecture \"architecture\">"
415 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
416 "--> <!ENTITY synopsis-pkg \"pkg\">"
422 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
423 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
429 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
430 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
436 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
437 "awesome --> <!ENTITY synopsis-regex \"regex\">"
443 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
444 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
450 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
451 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
452 "\"temporary_directory\">"
458 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
459 "synopsis-filename \"filename\">"
465 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
466 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
472 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
473 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
480 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
481 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
488 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
489 "generate section --> <!ENTITY synopsis-section \"section\">"
495 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
496 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
499 #. type: Content of: <refentry><refmeta><manvolnum>
500 #: apt-get.8.xml: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-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 "APT package handling utility -- command-line interface"
514 #. type: Content of: <refentry><refsect1><title>
515 #: 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-get</command> is the command-line tool for handling packages, "
523 "and may be considered the user's \"back-end\" to other tools using the APT "
524 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
525 "&synaptic; and &wajig;."
528 #. type: Content of: <refentry><refsect1><para>
529 #: 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
531 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
532 "one of the commands below must be present."
535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
538 "<literal>update</literal> is used to resynchronize the package index files "
539 "from their sources. The indexes of available packages are fetched from the "
540 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
541 "example, when using a Debian archive, this command retrieves and scans the "
542 "<filename>Packages.gz</filename> files, so that information about new and "
543 "updated packages is available. An <literal>update</literal> should always be "
544 "performed before an <literal>upgrade</literal> or "
545 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
546 "meter will be incorrect as the size of the package files cannot be known in "
550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
553 "<literal>upgrade</literal> is used to install the newest versions of all "
554 "packages currently installed on the system from the sources enumerated in "
555 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
556 "with new versions available are retrieved and upgraded; under no "
557 "circumstances are currently installed packages removed, or packages not "
558 "already installed retrieved and installed. New versions of currently "
559 "installed packages that cannot be upgraded without changing the install "
560 "status of another package will be left at their current version. An "
561 "<literal>update</literal> must be performed first so that "
562 "<command>apt-get</command> knows that new versions of packages are "
566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
569 "<literal>dist-upgrade</literal> in addition to performing the function of "
570 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
571 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
572 "conflict resolution system, and it will attempt to upgrade the most "
573 "important packages at the expense of less important ones if necessary. The "
574 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
575 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
576 "locations from which to retrieve desired package files. See also "
577 "&apt-preferences; for a mechanism for overriding the general settings for "
578 "individual packages."
581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
584 "<literal>dselect-upgrade</literal> is used in conjunction with the "
585 "traditional Debian packaging front-end, "
586 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
587 "&dselect; to the <literal>Status</literal> field of available packages, and "
588 "performs the actions necessary to realize that state (for instance, the "
589 "removal of old and the installation of new packages)."
592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
595 "<literal>install</literal> is followed by one or more packages desired for "
596 "installation or upgrading. Each package is a package name, not a fully "
597 "qualified filename (for instance, in a Debian system, "
598 "<package>apt-utils</package> would be the argument provided, not "
599 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
600 "packages required by the package(s) specified for installation will also be "
601 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
602 "file is used to locate the desired packages. If a hyphen is appended to the "
603 "package name (with no intervening space), the identified package will be "
604 "removed if it is installed. Similarly a plus sign can be used to designate "
605 "a package to install. These latter features may be used to override "
606 "decisions made by apt-get's conflict resolution system."
609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
612 "A specific version of a package can be selected for installation by "
613 "following the package name with an equals and the version of the package to "
614 "select. This will cause that version to be located and selected for "
615 "install. Alternatively a specific distribution can be selected by following "
616 "the package name with a slash and the version of the distribution or the "
617 "Archive name (stable, testing, unstable)."
620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
623 "Both of the version selection mechanisms can downgrade packages and must be "
627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
630 "This is also the target to use if you want to upgrade one or more "
631 "already-installed packages without upgrading every package you have on your "
632 "system. Unlike the \"upgrade\" target, which installs the newest version of "
633 "all currently installed packages, \"install\" will install the newest "
634 "version of only the package(s) specified. Simply provide the name of the "
635 "package(s) you wish to upgrade, and if a newer version is available, it (and "
636 "its dependencies, as described above) will be downloaded and installed."
639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
642 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
643 "installation policy for individual packages."
646 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
649 "If no package matches the given expression and the expression contains one "
650 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
651 "it is applied to all package names in the database. Any matches are then "
652 "installed (or removed). Note that matching is done by substring so 'lo.*' "
653 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
654 "expression with a '^' or '$' character, or create a more specific regular "
658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
661 "<literal>remove</literal> is identical to <literal>install</literal> except "
662 "that packages are removed instead of installed. Note that removing a package "
663 "leaves its configuration files on the system. If a plus sign is appended to "
664 "the package name (with no intervening space), the identified package will be "
665 "installed instead of removed."
668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
671 "<literal>purge</literal> is identical to <literal>remove</literal> except "
672 "that packages are removed and purged (any configuration files are deleted "
676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
679 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
680 "packages. APT will examine the available packages to decide which source "
681 "package to fetch. It will then find and download into the current directory "
682 "the newest available version of that source package while respecting the "
683 "default release, set with the option "
684 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
685 "per package with the <literal>pkg/release</literal> syntax, if possible."
688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
691 "Source packages are tracked separately from binary packages via "
692 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
693 "you will need to add such a line for each repository you want to get sources "
694 "from; otherwise you will probably get either the wrong (too old/too new) "
695 "source versions or none at all."
698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
701 "If the <option>--compile</option> option is specified then the package will "
702 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
703 "the architecture as defined by the <command>--host-architecture</command> "
704 "option. If <option>--download-only</option> is specified then the source "
705 "package will not be unpacked."
708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
711 "A specific source version can be retrieved by postfixing the source name "
712 "with an equals and then the version to fetch, similar to the mechanism used "
713 "for the package files. This enables exact matching of the source package "
714 "name and version, implicitly enabling the "
715 "<literal>APT::Get::Only-Source</literal> option."
718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
721 "Note that source packages are not installed and tracked in the "
722 "<command>dpkg</command> database like binary packages; they are simply "
723 "downloaded to the current directory, like source tarballs."
726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
729 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
730 "attempt to satisfy the build dependencies for a source package. By default "
731 "the dependencies are satisfied to build the package natively. If desired a "
732 "host-architecture can be specified with the "
733 "<option>--host-architecture</option> option instead."
736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
739 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
740 "and checks for broken dependencies."
743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
746 "<literal>download</literal> will download the given binary package into the "
750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
753 "<literal>clean</literal> clears out the local repository of retrieved "
754 "package files. It removes everything but the lock file from "
755 "<filename>&cachedir;/archives/</filename> and "
756 "<filename>&cachedir;/archives/partial/</filename>."
759 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
762 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
763 "local repository of retrieved package files. The difference is that it only "
764 "removes package files that can no longer be downloaded, and are largely "
765 "useless. This allows a cache to be maintained over a long period without it "
766 "growing out of control. The configuration option "
767 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
768 "being erased if it is set to off."
771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
774 "<literal>autoremove</literal> is used to remove packages that were "
775 "automatically installed to satisfy dependencies for other packages and are "
776 "now no longer needed."
779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
782 "<literal>changelog</literal> downloads a package changelog and displays it "
783 "through <command>sensible-pager</command>. The server name and base "
784 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
785 "variable (e.g. <ulink "
786 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
787 "for Debian or <ulink "
788 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
789 "for Ubuntu). By default it displays the changelog for the version that is "
790 "installed. However, you can specify the same options as for the "
791 "<option>install</option> command."
794 #. type: Content of: <refentry><refsect1><title>
795 #: 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
799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
802 "Do not consider recommended packages as a dependency for installing. "
803 "Configuration Item: <literal>APT::Install-Recommends</literal>."
806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
809 "Consider suggested packages as a dependency for installing. Configuration "
810 "Item: <literal>APT::Install-Suggests</literal>."
813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
816 "Download only; package files are only retrieved, not unpacked or installed. "
817 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
823 "Fix; attempt to correct a system with broken dependencies in place. This "
824 "option, when used with install/remove, can omit any packages to permit APT "
825 "to deduce a likely solution. If packages are specified, these have to "
826 "completely correct the problem. The option is sometimes necessary when "
827 "running APT for the first time; APT itself does not allow broken package "
828 "dependencies to exist on a system. It is possible that a system's dependency "
829 "structure can be so corrupt as to require manual intervention (which usually "
830 "means using <command>dpkg --remove</command> to eliminate some of the "
831 "offending packages). Use of this option together with <option>-m</option> "
832 "may produce an error in some situations. Configuration Item: "
833 "<literal>APT::Get::Fix-Broken</literal>."
836 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
839 "Ignore missing packages; if packages cannot be retrieved or fail the "
840 "integrity check after retrieval (corrupted package files), hold back those "
841 "packages and handle the result. Use of this option together with "
842 "<option>-f</option> may produce an error in some situations. If a package is "
843 "selected for installation (particularly if it is mentioned on the command "
844 "line) and it could not be downloaded then it will be silently held back. "
845 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
848 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
851 "Disables downloading of packages. This is best used with "
852 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
853 "already downloaded. Configuration Item: "
854 "<literal>APT::Get::Download</literal>."
857 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
860 "Quiet; produces output suitable for logging, omitting progress indicators. "
861 "More q's will produce more quiet up to a maximum of 2. You can also use "
862 "<option>-q=#</option> to set the quiet level, overriding the configuration "
863 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
864 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
865 "may decide to do something you did not expect. Configuration Item: "
866 "<literal>quiet</literal>."
869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
872 "No action; perform a simulation of events that would occur but do not "
873 "actually change the system. Configuration Item: "
874 "<literal>APT::Get::Simulate</literal>."
877 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
880 "Simulated runs performed as a user will automatically deactivate locking "
881 "(<literal>Debug::NoLocking</literal>), and if the option "
882 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (as it is by "
883 "default) a notice will also be displayed indicating that this is only a "
884 "simulation. Runs performed as root do not trigger either NoLocking or the "
885 "notice - superusers should know what they are doing without further warnings "
886 "from <literal>apt-get</literal>."
889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
892 "Simulated runs print out a series of lines, each representing a "
893 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
894 "remove (<literal>Remv</literal>) or unpack "
895 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
896 "empty square brackets indicate breaks that are of no consequence (rare)."
899 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
902 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
903 "non-interactively. If an undesirable situation, such as changing a held "
904 "package, trying to install a unauthenticated package or removing an "
905 "essential package occurs then <literal>apt-get</literal> will abort. "
906 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
912 "Automatic \"no\" to all prompts. Configuration Item: "
913 "<literal>APT::Get::Assume-No</literal>."
916 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
919 "Show upgraded packages; print out a list of all packages that are to be "
920 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
923 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
926 "Show full versions for upgraded and installed packages. Configuration Item: "
927 "<literal>APT::Get::Show-Versions</literal>."
930 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
933 "This option controls the architecture packages are built for by "
934 "<command>apt-get source --compile</command> and how cross-builddependencies "
935 "are satisfied. By default is it not set which means that the host "
936 "architecture is the same as the build architecture (which is defined by "
937 "<literal>APT::Architecture</literal>). Configuration Item: "
938 "<literal>APT::Get::Host-Architecture</literal>"
941 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
944 "Compile source packages after downloading them. Configuration Item: "
945 "<literal>APT::Get::Compile</literal>."
948 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
951 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
952 "hold placed on a package. This may be useful in conjunction with "
953 "<literal>dist-upgrade</literal> to override a large number of undesired "
954 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
960 "Allow installing new packages when used in conjunction with "
961 "<literal>upgrade</literal>. This is useful if the update of a installed "
962 "package requires new dependencies to be installed. Instead of holding the "
963 "package back <literal>upgrade</literal> will upgrade the package and install "
964 "the new dependencies. Note that <literal>upgrade</literal> with this option "
965 "will never remove packages, only allow adding new ones. Configuration Item: "
966 "<literal>APT::Get::Upgrade-Allow-New</literal>."
969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
972 "Do not upgrade packages; when used in conjunction with "
973 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
974 "packages on the command line from being upgraded if they are already "
975 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
978 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
981 "Do not install new packages; when used in conjunction with "
982 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
983 "upgrades for already installed packages only and ignore requests to install "
984 "new packages. Configuration Item: "
985 "<literal>APT::Get::Only-Upgrade</literal>."
988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
991 "Force yes; this is a dangerous option that will cause apt to continue "
992 "without prompting if it is doing something potentially harmful. It should "
993 "not be used except in very special situations. Using "
994 "<literal>force-yes</literal> can potentially destroy your system! "
995 "Configuration Item: <literal>APT::Get::force-yes</literal>."
998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1001 "Instead of fetching the files to install their URIs are printed. Each URI "
1002 "will have the path, the destination file name, the size and the expected MD5 "
1003 "hash. Note that the file name to write to will not always match the file "
1004 "name on the remote site! This also works with the <literal>source</literal> "
1005 "and <literal>update</literal> commands. When used with the "
1006 "<literal>update</literal> command the MD5 and size are not included, and it "
1007 "is up to the user to decompress any compressed files. Configuration Item: "
1008 "<literal>APT::Get::Print-URIs</literal>."
1011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1012 #: apt-get.8.xml:438
1014 "Use purge instead of remove for anything that would be removed. An asterisk "
1015 "(\"*\") will be displayed next to packages which are scheduled to be "
1016 "purged. <option>remove --purge</option> is equivalent to the "
1017 "<option>purge</option> command. Configuration Item: "
1018 "<literal>APT::Get::Purge</literal>."
1021 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1022 #: apt-get.8.xml:446
1024 "Re-install packages that are already installed and at the newest version. "
1025 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1029 #: apt-get.8.xml:451
1031 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1032 "turn it off. When it is on, <command>apt-get</command> will automatically "
1033 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1034 "obsolete files are erased. The only reason to turn it off is if you "
1035 "frequently change your sources list. Configuration Item: "
1036 "<literal>APT::Get::List-Cleanup</literal>."
1039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1040 #: apt-get.8.xml:461
1042 "This option controls the default input to the policy engine; it creates a "
1043 "default pin at priority 990 using the specified release string. This "
1044 "overrides the general settings in "
1045 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1046 "not affected by the value of this option. In short, this option lets you "
1047 "have simple control over which distribution packages will be retrieved "
1048 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1049 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1050 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1055 #: apt-get.8.xml:476
1057 "Only perform operations that are 'trivial'. Logically this can be considered "
1058 "related to <option>--assume-yes</option>; where "
1059 "<option>--assume-yes</option> will answer yes to any prompt, "
1060 "<option>--trivial-only</option> will answer no. Configuration Item: "
1061 "<literal>APT::Get::Trivial-Only</literal>."
1064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1065 #: apt-get.8.xml:483
1067 "If any packages are to be removed apt-get immediately aborts without "
1068 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1072 #: apt-get.8.xml:489
1074 "If the command is either <literal>install</literal> or "
1075 "<literal>remove</literal>, then this option acts like running the "
1076 "<literal>autoremove</literal> command, removing unused dependency "
1077 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1080 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1081 #: apt-get.8.xml:496
1083 "Only has meaning for the <literal>source</literal> and "
1084 "<literal>build-dep</literal> commands. Indicates that the given source "
1085 "names are not to be mapped through the binary table. This means that if "
1086 "this option is specified, these commands will only accept source package "
1087 "names as arguments, rather than accepting binary package names and looking "
1088 "up the corresponding source package. Configuration Item: "
1089 "<literal>APT::Get::Only-Source</literal>."
1092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1093 #: apt-get.8.xml:507
1095 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1096 "Item: <literal>APT::Get::Diff-Only</literal>, "
1097 "<literal>APT::Get::Dsc-Only</literal>, and "
1098 "<literal>APT::Get::Tar-Only</literal>."
1101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1102 #: apt-get.8.xml:513
1104 "Only process architecture-dependent build-dependencies. Configuration Item: "
1105 "<literal>APT::Get::Arch-Only</literal>."
1108 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1109 #: apt-get.8.xml:518
1111 "Ignore if packages can't be authenticated and don't prompt about it. This "
1112 "is useful for tools like pbuilder. Configuration Item: "
1113 "<literal>APT::Get::AllowUnauthenticated</literal>."
1116 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1117 #: apt-get.8.xml:524
1119 "Show user friendly progress information in the terminal window when packages "
1120 "are installed, upgraded or removed. For a machine parsable version of this "
1121 "data see README.progress-reporting in the apt doc directory. Configuration "
1122 "Item: <literal>DpkgPM::Progress</literal> and "
1123 "<literal>Dpkg::Progress-Fancy</literal>."
1126 #. type: Content of: <refentry><refsect1><title>
1127 #: apt-get.8.xml:537 apt-cache.8.xml:345 apt-key.8.xml:176 apt-mark.8.xml:127 apt.conf.5.xml:1200 apt_preferences.5.xml:700
1131 #. type: Content of: <refentry><refsect1><title>
1132 #: apt-get.8.xml:547 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:1206 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
1136 #. type: Content of: <refentry><refsect1><para>
1137 #: apt-get.8.xml:548
1139 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1140 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1144 #. type: Content of: <refentry><refsect1><title>
1145 #: apt-get.8.xml:553 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
1149 #. type: Content of: <refentry><refsect1><para>
1150 #: apt-get.8.xml:554
1152 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1156 #. type: Content of: <refentry><refnamediv><refpurpose>
1157 #: apt-cache.8.xml:35
1158 msgid "query the APT cache"
1161 #. type: Content of: <refentry><refsect1><para>
1162 #: apt-cache.8.xml:41
1164 "<command>apt-cache</command> performs a variety of operations on APT's "
1165 "package cache. <command>apt-cache</command> does not manipulate the state of "
1166 "the system but does provide operations to search and generate interesting "
1167 "output from the package metadata."
1170 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1171 #: apt-cache.8.xml:51
1173 "<literal>gencaches</literal> creates APT's package cache. This is done "
1174 "implicitly by all commands needing this cache if it is missing or outdated."
1177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1178 #: 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
1179 msgid "&synopsis-pkg;"
1182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1183 #: apt-cache.8.xml:56
1185 "<literal>showpkg</literal> displays information about the packages listed on "
1186 "the command line. Remaining arguments are package names. The available "
1187 "versions and reverse dependencies of each package listed are listed, as well "
1188 "as forward dependencies for each version. Forward (normal) dependencies are "
1189 "those packages upon which the package in question depends; reverse "
1190 "dependencies are those packages that depend upon the package in "
1191 "question. Thus, forward dependencies must be satisfied for a package, but "
1192 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1193 "libreadline2</command> would produce output similar to the following:"
1196 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1197 #: apt-cache.8.xml:68
1200 "Package: libreadline2\n"
1201 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1202 "Reverse Depends: \n"
1203 " libreadlineg2,libreadline2\n"
1204 " libreadline2-altdev,libreadline2\n"
1206 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1209 "Reverse Provides: \n"
1212 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1213 #: apt-cache.8.xml:80
1215 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1216 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1217 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1218 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1219 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1220 "installed. For the specific meaning of the remainder of the output it is "
1221 "best to consult the apt source code."
1224 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1225 #: apt-cache.8.xml:89
1227 "<literal>stats</literal> displays some statistics about the cache. No "
1228 "further arguments are expected. Statistics reported are:"
1231 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1232 #: apt-cache.8.xml:92
1234 "<literal>Total package names</literal> is the number of package names found "
1238 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1239 #: apt-cache.8.xml:96
1241 "<literal>Normal packages</literal> is the number of regular, ordinary "
1242 "package names; these are packages that bear a one-to-one correspondence "
1243 "between their names and the names used by other packages for them in "
1244 "dependencies. The majority of packages fall into this category."
1247 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1248 #: apt-cache.8.xml:102
1250 "<literal>Pure virtual packages</literal> is the number of packages that "
1251 "exist only as a virtual package name; that is, packages only \"provide\" the "
1252 "virtual package name, and no package actually uses the name. For instance, "
1253 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1254 "several packages provide \"mail-transport-agent\", but there is no package "
1255 "named \"mail-transport-agent\"."
1258 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1259 #: apt-cache.8.xml:110
1261 "<literal>Single virtual packages</literal> is the number of packages with "
1262 "only one package providing a particular virtual package. For example, in the "
1263 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1264 "package, xless, provides \"X11-text-viewer\"."
1267 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1268 #: apt-cache.8.xml:116
1270 "<literal>Mixed virtual packages</literal> is the number of packages that "
1271 "either provide a particular virtual package or have the virtual package name "
1272 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1273 "an actual package, and provided by the debconf-tiny package."
1276 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1277 #: apt-cache.8.xml:123
1279 "<literal>Missing</literal> is the number of package names that were "
1280 "referenced in a dependency but were not provided by any package. Missing "
1281 "packages may be an evidence if a full distribution is not accessed, or if a "
1282 "package (real or virtual) has been dropped from the distribution. Usually "
1283 "they are referenced from Conflicts or Breaks statements."
1286 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1287 #: apt-cache.8.xml:130
1289 "<literal>Total distinct</literal> versions is the number of package versions "
1290 "found in the cache; this value is therefore at least equal to the number of "
1291 "total package names. If more than one distribution is being accessed (for "
1292 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1293 "larger than the number of total package names."
1296 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1297 #: apt-cache.8.xml:137
1299 "<literal>Total dependencies</literal> is the number of dependency "
1300 "relationships claimed by all of the packages in the cache."
1303 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1304 #: apt-cache.8.xml:145
1306 "<literal>showsrc</literal> displays all the source package records that "
1307 "match the given package names. All versions are shown, as well as all "
1308 "records that declare the name to be a binary package."
1311 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1312 #: apt-cache.8.xml:151
1314 "<literal>dump</literal> shows a short listing of every package in the "
1315 "cache. It is primarily for debugging."
1318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1319 #: apt-cache.8.xml:156
1321 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1322 "suitable for use with &dpkg; and is used by the &dselect; method."
1325 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1326 #: apt-cache.8.xml:161
1328 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1333 #: apt-cache.8.xml:166
1335 "<literal>show</literal> performs a function similar to <command>dpkg "
1336 "--print-avail</command>; it displays the package records for the named "
1340 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1341 #: apt-cache.8.xml:171
1342 msgid "&synopsis-regex;"
1345 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1346 #: apt-cache.8.xml:172
1348 "<literal>search</literal> performs a full text search on all available "
1349 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1350 "the package names and the descriptions for an occurrence of the regular "
1351 "expression and prints out the package name and the short description, "
1352 "including virtual package names. If <option>--full</option> is given then "
1353 "output identical to <literal>show</literal> is produced for each matched "
1354 "package, and if <option>--names-only</option> is given then the long "
1355 "description is not searched, only the package name is."
1358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1359 #: apt-cache.8.xml:183
1361 "Separate arguments can be used to specify multiple search patterns that are "
1365 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1366 #: apt-cache.8.xml:188
1368 "<literal>depends</literal> shows a listing of each dependency a package has "
1369 "and all the possible other packages that can fulfill that dependency."
1372 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1373 #: apt-cache.8.xml:193
1375 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1379 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1380 #: apt-cache.8.xml:197
1381 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1384 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1385 #: apt-cache.8.xml:198
1387 "This command prints the name of each package APT knows. The optional "
1388 "argument is a prefix match to filter the name list. The output is suitable "
1389 "for use in a shell tab complete function and the output is generated "
1390 "extremely quickly. This command is best used with the "
1391 "<option>--generate</option> option."
1394 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1395 #: apt-cache.8.xml:203
1397 "Note that a package which APT knows of is not necessarily available to "
1398 "download, installable or installed, e.g. virtual packages are also listed in "
1399 "the generated list."
1402 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1403 #: apt-cache.8.xml:209
1405 "<literal>dotty</literal> takes a list of packages on the command line and "
1406 "generates output suitable for use by dotty from the <ulink "
1407 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1408 "package. The result will be a set of nodes and edges representing the "
1409 "relationships between the packages. By default the given packages will trace "
1410 "out all dependent packages; this can produce a very large graph. To limit "
1411 "the output to only the packages listed on the command line, set the "
1412 "<literal>APT::Cache::GivenOnly</literal> option."
1415 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1416 #: apt-cache.8.xml:218
1418 "The resulting nodes will have several shapes; normal packages are boxes, "
1419 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1420 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1421 "packages), blue lines are pre-depends, green lines are conflicts."
1424 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1425 #: apt-cache.8.xml:223
1426 msgid "Caution, dotty cannot graph larger sets of packages."
1429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1430 #: apt-cache.8.xml:227
1432 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1433 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1438 #: apt-cache.8.xml:231
1439 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1442 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1443 #: apt-cache.8.xml:232
1445 "<literal>policy</literal> is meant to help debug issues relating to the "
1446 "preferences file. With no arguments it will print out the priorities of each "
1447 "source. Otherwise it prints out detailed information about the priority "
1448 "selection of the named package."
1451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1452 #: apt-cache.8.xml:239
1454 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1455 "to mimic the output format and a subset of the functionality of the Debian "
1456 "archive management tool, <literal>madison</literal>. It displays available "
1457 "versions of a package in a tabular format. Unlike the original "
1458 "<literal>madison</literal>, it can only display information for the "
1459 "architecture for which APT has retrieved package lists "
1460 "(<literal>APT::Architecture</literal>)."
1463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1464 #: apt-cache.8.xml:255
1466 "Select the file to store the package cache. The package cache is the primary "
1467 "cache used by all operations. Configuration Item: "
1468 "<literal>Dir::Cache::pkgcache</literal>."
1471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1472 #: apt-cache.8.xml:261
1474 "Select the file to store the source cache. The source is used only by "
1475 "<literal>gencaches</literal> and it stores a parsed version of the package "
1476 "information from remote sources. When building the package cache the source "
1477 "cache is used to avoid reparsing all of the package files. Configuration "
1478 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1482 #: apt-cache.8.xml:269
1484 "Quiet; produces output suitable for logging, omitting progress indicators. "
1485 "More q's will produce more quietness up to a maximum of 2. You can also use "
1486 "<option>-q=#</option> to set the quietness level, overriding the "
1487 "configuration file. Configuration Item: <literal>quiet</literal>."
1490 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1491 #: apt-cache.8.xml:276
1493 "Print only important dependencies; for use with <literal>unmet</literal> and "
1494 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1495 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1499 #: apt-cache.8.xml:290
1501 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1502 "print all dependencies. This can be tweaked with these flags which will omit "
1503 "the specified dependency type. Configuration Item: "
1504 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1505 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1509 #: apt-cache.8.xml:297
1511 "Print full package records when searching. Configuration Item: "
1512 "<literal>APT::Cache::ShowFull</literal>."
1515 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1516 #: apt-cache.8.xml:302
1518 "Print full records for all available versions. This is the default; to turn "
1519 "it off, use <option>--no-all-versions</option>. If "
1520 "<option>--no-all-versions</option> is specified, only the candidate version "
1521 "will be displayed (the one which would be selected for installation). This "
1522 "option is only applicable to the <literal>show</literal> command. "
1523 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1526 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1527 #: apt-cache.8.xml:311
1529 "Perform automatic package cache regeneration, rather than use the cache as "
1530 "it is. This is the default; to turn it off, use "
1531 "<option>--no-generate</option>. Configuration Item: "
1532 "<literal>APT::Cache::Generate</literal>."
1535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1536 #: apt-cache.8.xml:317
1538 "Only search on the package names, not the long descriptions. Configuration "
1539 "Item: <literal>APT::Cache::NamesOnly</literal>."
1542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1543 #: apt-cache.8.xml:322
1545 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1546 "and missing dependencies. Configuration Item: "
1547 "<literal>APT::Cache::AllNames</literal>."
1550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1551 #: apt-cache.8.xml:328
1553 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1554 "that all packages mentioned are printed once. Configuration Item: "
1555 "<literal>APT::Cache::RecurseDepends</literal>."
1558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1559 #: apt-cache.8.xml:335
1561 "Limit the output of <literal>depends</literal> and "
1562 "<literal>rdepends</literal> to packages which are currently installed. "
1563 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1566 #. type: Content of: <refentry><refsect1><para>
1567 #: apt-cache.8.xml:353
1568 msgid "&apt-conf;, &sources-list;, &apt-get;"
1571 #. type: Content of: <refentry><refsect1><para>
1572 #: apt-cache.8.xml:358
1574 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1578 #. type: Content of: <refentry><refnamediv><refpurpose>
1580 msgid "APT key management utility"
1583 #. type: Content of: <refentry><refsect1><para>
1586 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1587 "authenticate packages. Packages which have been authenticated using these "
1588 "keys will be considered trusted."
1591 #. type: Content of: <refentry><refsect1><title>
1596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1599 "Add a new key to the list of trusted keys. The key is read from the "
1600 "filename given with the parameter &synopsis-param-filename; or if the "
1601 "filename is <literal>-</literal> from standard input."
1604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1606 msgid "Remove a key from the list of trusted keys."
1609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1611 msgid "Output the key &synopsis-param-keyid; to standard output."
1614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1616 msgid "Output all trusted keys to standard output."
1619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1621 msgid "List trusted keys."
1624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1625 #: apt-key.8.xml:109
1626 msgid "List fingerprints of trusted keys."
1629 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1630 #: apt-key.8.xml:120
1632 "Pass advanced options to gpg. With adv --recv-key you can download the "
1636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1637 #: apt-key.8.xml:132
1639 "Update the local keyring with the archive keyring and remove from the local "
1640 "keyring the archive keys which are no longer valid. The archive keyring is "
1641 "shipped in the <literal>archive-keyring</literal> package of your "
1642 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1645 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1646 #: apt-key.8.xml:146
1648 "Perform an update working similarly to the <command>update</command> command "
1649 "above, but get the archive keyring from a URI instead and validate it "
1650 "against a master key. This requires an installed &wget; and an APT build "
1651 "configured to have a server to fetch from and a master keyring to validate. "
1652 "APT in Debian does not support this command, relying on "
1653 "<command>update</command> instead, but Ubuntu's APT does."
1656 #. type: Content of: <refentry><refsect1><title>
1657 #: apt-key.8.xml:162 apt-cdrom.8.xml:82
1661 #. type: Content of: <refentry><refsect1><para>
1662 #: apt-key.8.xml:163
1664 "Note that options need to be defined before the commands described in the "
1668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1669 #: apt-key.8.xml:166
1671 "With this option it is possible to specify a particular keyring file the "
1672 "command should operate on. The default is that a command is executed on the "
1673 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1674 "<filename>trusted.gpg.d</filename> directory, though "
1675 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1676 "e.g. new keys are added to this one."
1679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1680 #: apt-key.8.xml:181
1681 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1684 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1685 #: apt-key.8.xml:182
1686 msgid "Local trust database of archive keys."
1689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1690 #: apt-key.8.xml:185
1691 msgid "&keyring-filename;"
1694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1695 #: apt-key.8.xml:186
1696 msgid "Keyring of &keyring-distro; archive trusted keys."
1699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1700 #: apt-key.8.xml:189
1701 msgid "&keyring-removed-filename;"
1704 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1705 #: apt-key.8.xml:190
1706 msgid "Keyring of &keyring-distro; archive removed trusted keys."
1709 #. type: Content of: <refentry><refsect1><para>
1710 #: apt-key.8.xml:199
1711 msgid "&apt-get;, &apt-secure;"
1714 #. type: Content of: <refentry><refnamediv><refpurpose>
1715 #: apt-mark.8.xml:35
1716 msgid "mark/unmark a package as being automatically-installed"
1719 #. type: Content of: <refentry><refsect1><para>
1720 #: apt-mark.8.xml:41
1722 "<command>apt-mark</command> will change whether a package has been marked as "
1723 "being automatically installed."
1726 #. type: Content of: <refentry><refsect1><para>
1727 #: apt-mark.8.xml:45
1729 "When you request that a package is installed, and as a result other packages "
1730 "are installed to satisfy its dependencies, the dependencies are marked as "
1731 "being automatically installed. Once these automatically installed packages "
1732 "are no longer depended on by any manually installed packages, they will be "
1733 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1737 #: apt-mark.8.xml:54
1739 "<literal>auto</literal> is used to mark a package as being automatically "
1740 "installed, which will cause the package to be removed when no more manually "
1741 "installed packages depend on this package."
1744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1745 #: apt-mark.8.xml:62
1747 "<literal>manual</literal> is used to mark a package as being manually "
1748 "installed, which will prevent the package from being automatically removed "
1749 "if no other packages depend on it."
1752 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1753 #: apt-mark.8.xml:70
1755 "<literal>hold</literal> is used to mark a package as held back, which will "
1756 "prevent the package from being automatically installed, upgraded or "
1757 "removed. The command is only a wrapper around <command>dpkg "
1758 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1759 "and not affected by the <option>--file</option> option."
1762 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1763 #: apt-mark.8.xml:80
1765 "<literal>unhold</literal> is used to cancel a previously set hold on a "
1766 "package to allow all actions again."
1769 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1770 #: apt-mark.8.xml:86
1772 "<literal>showauto</literal> is used to print a list of automatically "
1773 "installed packages with each package on a new line. All automatically "
1774 "installed packages will be listed if no package is given. If packages are "
1775 "given only those which are automatically installed will be shown."
1778 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1779 #: apt-mark.8.xml:94
1781 "<literal>showmanual</literal> can be used in the same way as "
1782 "<literal>showauto</literal> except that it will print a list of manually "
1783 "installed packages instead."
1786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1787 #: apt-mark.8.xml:101
1789 "<literal>showhold</literal> is used to print a list of packages on hold in "
1790 "the same way as for the other show commands."
1793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1794 #: apt-mark.8.xml:117
1796 "Read/Write package stats from the filename given with the parameter "
1797 "&synopsis-param-filename; instead of from the default location, which is "
1798 "<filename>extended_status</filename> in the directory defined by the "
1799 "Configuration Item: <literal>Dir::State</literal>."
1802 #. type: Content of: <refentry><refsect1><para>
1803 #: apt-mark.8.xml:138
1805 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
1809 #. type: Content of: <refentry><refnamediv><refpurpose>
1810 #: apt-secure.8.xml:49
1811 msgid "Archive authentication support for APT"
1814 #. type: Content of: <refentry><refsect1><para>
1815 #: apt-secure.8.xml:54
1817 "Starting with version 0.6, <command>apt</command> contains code that does "
1818 "signature checking of the Release file for all archives. This ensures that "
1819 "packages in the archive can't be modified by people who have no access to "
1820 "the Release file signing key."
1823 #. type: Content of: <refentry><refsect1><para>
1824 #: apt-secure.8.xml:62
1826 "If a package comes from a archive without a signature, or with a signature "
1827 "that apt does not have a key for, that package is considered untrusted, and "
1828 "installing it will result in a big warning. <command>apt-get</command> will "
1829 "currently only warn for unsigned archives; future releases might force all "
1830 "sources to be verified before downloading packages from them."
1833 #. type: Content of: <refentry><refsect1><para>
1834 #: apt-secure.8.xml:71
1836 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
1837 "authentication feature."
1840 #. type: Content of: <refentry><refsect1><title>
1841 #: apt-secure.8.xml:76
1842 msgid "Trusted archives"
1845 #. type: Content of: <refentry><refsect1><para>
1846 #: apt-secure.8.xml:79
1848 "The chain of trust from an apt archive to the end user is made up of several "
1849 "steps. <command>apt-secure</command> is the last step in this chain; "
1850 "trusting an archive does not mean that you trust its packages not to contain "
1851 "malicious code, but means that you trust the archive maintainer. It's the "
1852 "archive maintainer's responsibility to ensure that the archive's integrity "
1856 #. type: Content of: <refentry><refsect1><para>
1857 #: apt-secure.8.xml:87
1859 "apt-secure does not review signatures at a package level. If you require "
1860 "tools to do this you should look at <command>debsig-verify</command> and "
1861 "<command>debsign</command> (provided in the debsig-verify and devscripts "
1862 "packages respectively)."
1865 #. type: Content of: <refentry><refsect1><para>
1866 #: apt-secure.8.xml:94
1868 "The chain of trust in Debian starts when a maintainer uploads a new package "
1869 "or a new version of a package to the Debian archive. In order to become "
1870 "effective, this upload needs to be signed by a key contained in the Debian "
1871 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
1872 "keys are signed by other maintainers following pre-established procedures to "
1873 "ensure the identity of the key holder."
1876 #. type: Content of: <refentry><refsect1><para>
1877 #: apt-secure.8.xml:104
1879 "Once the uploaded package is verified and included in the archive, the "
1880 "maintainer signature is stripped off, and checksums of the package are "
1881 "computed and put in the Packages file. The checksums of all of the Packages "
1882 "files are then computed and put into the Release file. The Release file is "
1883 "then signed by the archive key for this &keyring-distro; release, and "
1884 "distributed alongside the packages and the Packages files on "
1885 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
1886 "keyring available in the &keyring-package; package."
1889 #. type: Content of: <refentry><refsect1><para>
1890 #: apt-secure.8.xml:115
1892 "End users can check the signature of the Release file, extract a checksum of "
1893 "a package from it and compare it with the checksum of the package they "
1894 "downloaded by hand - or rely on APT doing this automatically."
1897 #. type: Content of: <refentry><refsect1><para>
1898 #: apt-secure.8.xml:120
1900 "Notice that this is distinct from checking signatures on a per package "
1901 "basis. It is designed to prevent two possible attacks:"
1904 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1905 #: apt-secure.8.xml:125
1907 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
1908 "checking, malicious agents can introduce themselves into the package "
1909 "download process and provide malicious software either by controlling a "
1910 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
1911 "server (through ARP or DNS spoofing attacks)."
1914 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1915 #: apt-secure.8.xml:133
1917 "<literal>Mirror network compromise</literal>. Without signature checking, a "
1918 "malicious agent can compromise a mirror host and modify the files in it to "
1919 "propagate malicious software to all users downloading packages from that "
1923 #. type: Content of: <refentry><refsect1><para>
1924 #: apt-secure.8.xml:140
1926 "However, it does not defend against a compromise of the Debian master server "
1927 "itself (which signs the packages) or against a compromise of the key used to "
1928 "sign the Release files. In any case, this mechanism can complement a "
1929 "per-package signature."
1932 #. type: Content of: <refentry><refsect1><title>
1933 #: apt-secure.8.xml:146
1934 msgid "User configuration"
1937 #. type: Content of: <refentry><refsect1><para>
1938 #: apt-secure.8.xml:148
1940 "<command>apt-key</command> is the program that manages the list of keys used "
1941 "by apt. It can be used to add or remove keys, although an installation of "
1942 "this release will automatically contain the default Debian archive signing "
1943 "keys used in the Debian package repositories."
1946 #. type: Content of: <refentry><refsect1><para>
1947 #: apt-secure.8.xml:155
1949 "In order to add a new key you need to first download it (you should make "
1950 "sure you are using a trusted communication channel when retrieving it), add "
1951 "it with <command>apt-key</command> and then run <command>apt-get "
1952 "update</command> so that apt can download and verify the "
1953 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
1954 "from the archives you have configured."
1957 #. type: Content of: <refentry><refsect1><title>
1958 #: apt-secure.8.xml:164
1959 msgid "Archive configuration"
1962 #. type: Content of: <refentry><refsect1><para>
1963 #: apt-secure.8.xml:166
1965 "If you want to provide archive signatures in an archive under your "
1966 "maintenance you have to:"
1969 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1970 #: apt-secure.8.xml:171
1972 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
1973 "already. You can do this by running <command>apt-ftparchive "
1974 "release</command> (provided in apt-utils)."
1977 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1978 #: apt-secure.8.xml:176
1980 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
1981 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
1982 "Release.gpg Release</command>."
1985 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1986 #: apt-secure.8.xml:180
1988 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
1989 "know what key they need to import in order to authenticate the files in the "
1993 #. type: Content of: <refentry><refsect1><para>
1994 #: apt-secure.8.xml:187
1996 "Whenever the contents of the archive change (new packages are added or "
1997 "removed) the archive maintainer has to follow the first two steps outlined "
2001 #. type: Content of: <refentry><refsect1><para>
2002 #: apt-secure.8.xml:195
2004 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2005 "&debsign; &debsig-verify;, &gpg;"
2008 #. type: Content of: <refentry><refsect1><para>
2009 #: apt-secure.8.xml:199
2011 "For more background information you might want to review the <ulink "
2012 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2013 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2014 "(available also in the harden-doc package) and the <ulink "
2015 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2016 "Distribution HOWTO</ulink> by V. Alex Brennen."
2019 #. type: Content of: <refentry><refsect1><title>
2020 #: apt-secure.8.xml:212
2021 msgid "Manpage Authors"
2024 #. type: Content of: <refentry><refsect1><para>
2025 #: apt-secure.8.xml:214
2027 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2028 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2031 #. type: Content of: <refentry><refnamediv><refpurpose>
2032 #: apt-cdrom.8.xml:34
2033 msgid "APT CD-ROM management utility"
2036 #. type: Content of: <refentry><refsect1><para>
2037 #: apt-cdrom.8.xml:40
2039 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2040 "available sources. <command>apt-cdrom</command> takes care of determining "
2041 "the structure of the disc as well as correcting for several possible "
2042 "mis-burns and verifying the index files."
2045 #. type: Content of: <refentry><refsect1><para>
2046 #: apt-cdrom.8.xml:47
2048 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2049 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2050 "must be inserted and scanned separately to account for possible mis-burns."
2053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2054 #: apt-cdrom.8.xml:58
2056 "<literal>add</literal> is used to add a new disc to the source list. It will "
2057 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2058 "to scan it and copy the index files. If the disc does not have a proper "
2059 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2064 #: apt-cdrom.8.xml:66
2066 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2067 "maintains a database of these IDs in "
2068 "<filename>&statedir;/cdroms.list</filename>"
2071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2072 #: apt-cdrom.8.xml:74
2074 "A debugging tool to report the identity of the current disc as well as the "
2078 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2079 #: apt-cdrom.8.xml:87
2081 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2082 "<option>--cdrom</option> option. Configuration Item: "
2083 "<literal>Acquire::cdrom::AutoDetect</literal>."
2086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2087 #: apt-cdrom.8.xml:95
2089 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2090 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2091 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2094 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2095 #: apt-cdrom.8.xml:104
2097 "Rename a disc; change the label of a disc or override the disc's given "
2098 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2099 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2102 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2103 #: apt-cdrom.8.xml:113
2105 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2106 "unmounting the mount point. Configuration Item: "
2107 "<literal>APT::CDROM::NoMount</literal>."
2110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2111 #: apt-cdrom.8.xml:121
2113 "Fast Copy; Assume the package files are valid and do not check every "
2114 "package. This option should be used only if <command>apt-cdrom</command> has "
2115 "been run on this disc before and did not detect any errors. Configuration "
2116 "Item: <literal>APT::CDROM::Fast</literal>."
2119 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2120 #: apt-cdrom.8.xml:131
2122 "Thorough Package Scan; This option may be needed with some old Debian "
2123 "1.1/1.2 discs that have Package files in strange places. It takes much "
2124 "longer to scan the CD but will pick them all up."
2127 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2128 #: apt-cdrom.8.xml:142
2130 "No Changes; Do not change the &sources-list; file and do not write index "
2131 "files. Everything is still checked however. Configuration Item: "
2132 "<literal>APT::CDROM::NoAct</literal>."
2135 #. type: Content of: <refentry><refsect1><para>
2136 #: apt-cdrom.8.xml:155
2137 msgid "&apt-conf;, &apt-get;, &sources-list;"
2140 #. type: Content of: <refentry><refsect1><para>
2141 #: apt-cdrom.8.xml:160
2143 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2147 #. type: Content of: <refentry><refnamediv><refpurpose>
2148 #: apt-config.8.xml:35
2149 msgid "APT Configuration Query program"
2152 #. type: Content of: <refentry><refsect1><para>
2153 #: apt-config.8.xml:41
2155 "<command>apt-config</command> is an internal program used by various "
2156 "portions of the APT suite to provide consistent configurability. It accesses "
2157 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2158 "manner that is easy to use for scripted applications."
2161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2162 #: apt-config.8.xml:53
2164 "shell is used to access the configuration information from a shell "
2165 "script. It is given pairs of arguments, the first being a shell variable and "
2166 "the second the configuration value to query. As output it lists shell "
2167 "assignment commands for each value present. In a shell script it should be "
2171 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2172 #: apt-config.8.xml:61
2176 "RES=`apt-config shell OPTS MyApp::options`\n"
2180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2181 #: apt-config.8.xml:66
2183 "This will set the shell environment variable $OPTS to the value of "
2184 "MyApp::options with a default of <option>-f</option>."
2187 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2188 #: apt-config.8.xml:70
2190 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2191 "names, d returns directories, b returns true or false and i returns an "
2192 "integer. Each of the returns is normalized and verified internally."
2195 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2196 #: apt-config.8.xml:79
2197 msgid "Just show the contents of the configuration space."
2200 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2201 #: apt-config.8.xml:92
2203 "Include options which have an empty value. This is the default, so use "
2204 "--no-empty to remove them from the output."
2207 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2208 #: apt-config.8.xml:97
2209 msgid "%f "%v";%n"
2212 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2213 #: apt-config.8.xml:98
2215 "Defines the output of each config option. %t will be replaced with "
2216 "its individual name, %f with its full hierarchical name and %v "
2217 "with its value. Use uppercase letters and special characters in the value "
2218 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2219 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2220 "and %N by a tab. A % can be printed by using %%."
2223 #. type: Content of: <refentry><refsect1><para>
2224 #: apt-config.8.xml:112 apt-extracttemplates.1.xml:73 apt-sortpkgs.1.xml:66 apt-ftparchive.1.xml:610
2228 #. type: Content of: <refentry><refsect1><para>
2229 #: apt-config.8.xml:117
2231 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2235 #. type: Content of: <refentry><refentryinfo><author><contrib>
2236 #: apt.conf.5.xml:22
2237 msgid "Initial documentation of Debug::*."
2240 #. type: Content of: <refentry><refentryinfo><author><email>
2241 #: apt.conf.5.xml:23
2242 msgid "dburrows@debian.org"
2245 #. type: Content of: <refentry><refmeta><manvolnum>
2246 #: apt.conf.5.xml:33 apt_preferences.5.xml:27 sources.list.5.xml:28
2250 #. type: Content of: <refentry><refnamediv><refpurpose>
2251 #: apt.conf.5.xml:40
2252 msgid "Configuration file for APT"
2255 #. type: Content of: <refentry><refsect1><para>
2256 #: apt.conf.5.xml:44
2258 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2259 "by all the tools in the APT suite of tools, though it is by no means the "
2260 "only place options can be set. The suite also shares a common command line "
2261 "parser to provide a uniform environment."
2264 #. type: Content of: <refentry><refsect1><orderedlist><para>
2265 #: apt.conf.5.xml:50
2267 "When an APT tool starts up it will read the configuration files in the "
2271 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2272 #: apt.conf.5.xml:52
2274 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2278 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2279 #: apt.conf.5.xml:54
2281 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2282 "order which have either no or \"<literal>conf</literal>\" as filename "
2283 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2284 "and period (.) characters. Otherwise APT will print a notice that it has "
2285 "ignored a file, unless that file matches a pattern in the "
2286 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2287 "case it will be silently ignored."
2290 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2291 #: apt.conf.5.xml:61
2292 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2295 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2296 #: apt.conf.5.xml:63
2298 "the command line options are applied to override the configuration "
2299 "directives or to load even more configuration files."
2302 #. type: Content of: <refentry><refsect1><title>
2303 #: apt.conf.5.xml:67
2307 #. type: Content of: <refentry><refsect1><para>
2308 #: apt.conf.5.xml:68
2310 "The configuration file is organized in a tree with options organized into "
2311 "functional groups. Option specification is given with a double colon "
2312 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2313 "within the APT tool group, for the Get tool. Options do not inherit from "
2314 "their parent groups."
2317 #. type: Content of: <refentry><refsect1><para>
2318 #: apt.conf.5.xml:74
2320 "Syntactically the configuration language is modeled after what the ISC tools "
2321 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2322 "treated as comments (ignored), as well as all text between "
2323 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2324 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2325 "The quotation marks and trailing semicolon are required. The value must be "
2326 "on one line, and there is no kind of string concatenation. Values must not "
2327 "include backslashes or extra quotation marks. Option names are made up of "
2328 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2329 "opened with curly braces, like this:"
2332 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2333 #: apt.conf.5.xml:87
2338 " Assume-Yes \"true\";\n"
2339 " Fix-Broken \"true\";\n"
2344 #. type: Content of: <refentry><refsect1><para>
2345 #: apt.conf.5.xml:95
2347 "with newlines placed to make it more readable. Lists can be created by "
2348 "opening a scope and including a single string enclosed in quotes followed by "
2349 "a semicolon. Multiple entries can be included, separated by a semicolon."
2352 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2353 #: apt.conf.5.xml:100
2355 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2358 #. type: Content of: <refentry><refsect1><para>
2359 #: apt.conf.5.xml:103
2361 "In general the sample configuration file &configureindex; is a good guide "
2362 "for how it should look."
2365 #. type: Content of: <refentry><refsect1><para>
2366 #: apt.conf.5.xml:106
2368 "Case is not significant in names of configuration items, so in the previous "
2369 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2372 #. type: Content of: <refentry><refsect1><para>
2373 #: apt.conf.5.xml:109
2375 "Names for the configuration items are optional if a list is defined as can "
2376 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2377 "you don't specify a name a new entry will simply add a new option to the "
2378 "list. If you specify a name you can override the option in the same way as "
2379 "any other option by reassigning a new value to the option."
2382 #. type: Content of: <refentry><refsect1><para>
2383 #: apt.conf.5.xml:114
2385 "Two special commands are defined: <literal>#include</literal> (which is "
2386 "deprecated and not supported by alternative implementations) and "
2387 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2388 "given file, unless the filename ends in a slash, in which case the whole "
2389 "directory is included. <literal>#clear</literal> is used to erase a part of "
2390 "the configuration tree. The specified element and all its descendants are "
2391 "erased. (Note that these lines also need to end with a semicolon.)"
2394 #. type: Content of: <refentry><refsect1><para>
2395 #: apt.conf.5.xml:124
2397 "The <literal>#clear</literal> command is the only way to delete a list or a "
2398 "complete scope. Reopening a scope (or using the syntax described below with "
2399 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2400 "previously written entries. Options can only be overridden by addressing a "
2401 "new value to them - lists and scopes can't be overridden, only cleared."
2404 #. type: Content of: <refentry><refsect1><para>
2405 #: apt.conf.5.xml:132
2407 "All of the APT tools take an -o option which allows an arbitrary "
2408 "configuration directive to be specified on the command line. The syntax is a "
2409 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2410 "followed by an equals sign then the new value of the option. To append a new "
2411 "element to a list, add a trailing <literal>::</literal> to the name of the "
2412 "list. (As you might suspect, the scope syntax can't be used on the command "
2416 #. type: Content of: <refentry><refsect1><para>
2417 #: apt.conf.5.xml:140
2419 "Note that appending items to a list using <literal>::</literal> only works "
2420 "for one item per line, and that you should not use it in combination with "
2421 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2422 "syntaxes together will trigger a bug which some users unfortunately depend "
2423 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2424 "like every other option with a name. This introduces many problems; for one "
2425 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2426 "syntax in the hope of appending to a list will achieve the opposite, as only "
2427 "the last assignment for this option \"<literal>::</literal>\" will be "
2428 "used. Future versions of APT will raise errors and stop working if they "
2429 "encounter this misuse, so please correct such statements now while APT "
2430 "doesn't explicitly complain about them."
2433 #. type: Content of: <refentry><refsect1><title>
2434 #: apt.conf.5.xml:155
2435 msgid "The APT Group"
2438 #. type: Content of: <refentry><refsect1><para>
2439 #: apt.conf.5.xml:156
2441 "This group of options controls general APT behavior as well as holding the "
2442 "options for all of the tools."
2445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2446 #: apt.conf.5.xml:161
2448 "System Architecture; sets the architecture to use when fetching files and "
2449 "parsing package lists. The internal default is the architecture apt was "
2453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2454 #: apt.conf.5.xml:168
2456 "All Architectures the system supports. For instance, CPUs implementing the "
2457 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2458 "instruction set are also able to execute binaries compiled for the "
2459 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2460 "is used when fetching files and parsing package lists. The initial default "
2461 "is always the system's native architecture "
2462 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2463 "to the default list when they are registered via <command>dpkg "
2464 "--add-architecture</command>."
2467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2468 #: apt.conf.5.xml:181
2470 "Default release to install packages from if more than one version is "
2471 "available. Contains release name, codename or release version. Examples: "
2472 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2473 "'4.0', '5.0*'. See also &apt-preferences;."
2476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2477 #: apt.conf.5.xml:187
2479 "Ignore held packages; this global option causes the problem resolver to "
2480 "ignore held packages in its decision making."
2483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2484 #: apt.conf.5.xml:192
2486 "Defaults to on. When turned on the autoclean feature will remove any "
2487 "packages which can no longer be downloaded from the cache. If turned off "
2488 "then packages that are locally installed are also excluded from cleaning - "
2489 "but note that APT provides no direct means to reinstall them."
2492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2493 #: apt.conf.5.xml:200
2495 "Defaults to on, which will cause APT to install essential and important "
2496 "packages as soon as possible in an install/upgrade operation, in order to "
2497 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2498 "treats an important package in the same way as an extra package: between the "
2499 "unpacking of the package A and its configuration there can be many other "
2500 "unpack or configuration calls for other unrelated packages B, C etc. If "
2501 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2502 "scripts generate an error), this results in a system state in which package "
2503 "A is unpacked but unconfigured - so any package depending on A is now no "
2504 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2508 #: apt.conf.5.xml:212
2510 "The immediate configuration marker is also applied in the potentially "
2511 "problematic case of circular dependencies, since a dependency with the "
2512 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2513 "to recognise a situation in which it is unable to perform immediate "
2514 "configuration, abort, and suggest to the user that the option should be "
2515 "temporarily deactivated in order to allow the operation to proceed. Note "
2516 "the use of the word \"theory\" here; in the real world this problem has "
2517 "rarely been encountered, in non-stable distribution versions, and was caused "
2518 "by wrong dependencies of the package in question or by a system in an "
2519 "already broken state; so you should not blindly disable this option, as the "
2520 "scenario mentioned above is not the only problem it can help to prevent in "
2524 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2525 #: apt.conf.5.xml:225
2527 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2528 "option disabled you should try to explicitly <literal>install</literal> the "
2529 "package APT is unable to configure immediately; but please make sure you "
2530 "also report your problem to your distribution and to the APT team with the "
2531 "buglink below, so they can work on improving or correcting the upgrade "
2535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2536 #: apt.conf.5.xml:236
2538 "Never enable this option unless you <emphasis>really</emphasis> know what "
2539 "you are doing. It permits APT to temporarily remove an essential package to "
2540 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2541 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2542 "bug</emphasis>. This option will work if the essential packages are not "
2543 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2544 "<command>dpkg</command>, <command>dash</command> or anything that those "
2545 "packages depend on."
2548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2549 #: apt.conf.5.xml:248
2551 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2552 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2553 "the size the cache will grow to, and is therefore the amount of memory APT "
2554 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2555 "that this amount of space needs to be available for APT; otherwise it will "
2556 "likely fail ungracefully, so for memory restricted devices this value should "
2557 "be lowered while on systems with a lot of configured sources it should be "
2558 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2559 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2560 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2561 "value will be applied again and again until either the cache is big enough "
2562 "to store all information or the size of the cache reaches the "
2563 "<literal>Cache-Limit</literal>. The default of "
2564 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2565 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2570 #: apt.conf.5.xml:264
2571 msgid "Defines which packages are considered essential build dependencies."
2574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2575 #: apt.conf.5.xml:268
2577 "The Get subsection controls the &apt-get; tool; please see its documentation "
2578 "for more information about the options here."
2581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2582 #: apt.conf.5.xml:273
2584 "The Cache subsection controls the &apt-cache; tool; please see its "
2585 "documentation for more information about the options here."
2588 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2589 #: apt.conf.5.xml:278
2591 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2592 "documentation for more information about the options here."
2595 #. type: Content of: <refentry><refsect1><title>
2596 #: apt.conf.5.xml:284
2597 msgid "The Acquire Group"
2600 #. type: Content of: <refentry><refsect1><para>
2601 #: apt.conf.5.xml:285
2603 "The <literal>Acquire</literal> group of options controls the download of "
2604 "packages as well as the various \"acquire methods\" responsible for the "
2605 "download itself (see also &sources-list;)."
2608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2609 #: apt.conf.5.xml:292
2611 "Security related option defaulting to true, as giving a Release file's "
2612 "validation an expiration date prevents replay attacks over a long timescale, "
2613 "and can also for example help users to identify mirrors that are no longer "
2614 "updated - but the feature depends on the correctness of the clock on the "
2615 "user system. Archive maintainers are encouraged to create Release files with "
2616 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2617 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2622 #: apt.conf.5.xml:305
2624 "Maximum time (in seconds) after its creation (as indicated by the "
2625 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2626 "should be considered valid. If the Release file itself includes a "
2627 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2628 "the expiration date. The default value is <literal>0</literal> which stands "
2629 "for \"valid forever\". Archive specific settings can be made by appending "
2630 "the label of the archive to the option name."
2633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2634 #: apt.conf.5.xml:317
2636 "Minimum time (in seconds) after its creation (as indicated by the "
2637 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2638 "should be considered valid. Use this if you need to use a seldom updated "
2639 "(local) mirror of a more frequently updated archive with a "
2640 "<literal>Valid-Until</literal> header instead of completely disabling the "
2641 "expiration date checking. Archive specific settings can and should be used "
2642 "by appending the label of the archive to the option name."
2645 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2646 #: apt.conf.5.xml:329
2648 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2649 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2653 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2654 #: apt.conf.5.xml:332
2656 "Two sub-options to limit the use of PDiffs are also available: "
2657 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2658 "PDiff files should be downloaded to update a "
2659 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2660 "percentage of the size of all patches compared to the size of the targeted "
2661 "file. If one of these limits is exceeded the complete file is downloaded "
2662 "instead of the patches."
2665 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2666 #: apt.conf.5.xml:342
2668 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2669 "<literal>host</literal> or <literal>access</literal> which determines how "
2670 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2671 "one connection per target host will be opened, <literal>access</literal> "
2672 "means that one connection per URI type will be opened."
2675 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2676 #: apt.conf.5.xml:350
2678 "Number of retries to perform. If this is non-zero APT will retry failed "
2679 "files the given number of times."
2682 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2683 #: apt.conf.5.xml:355
2685 "Use symlinks for source archives. If set to true then source archives will "
2686 "be symlinked when possible instead of copying. True is the default."
2689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2690 #: apt.conf.5.xml:360
2692 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2693 "URIs. It is in the standard form of "
2694 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2695 "can also be specified by using the form "
2696 "<literal>http::Proxy::<host></literal> with the special keyword "
2697 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2698 "settings is specified, <envar>http_proxy</envar> environment variable will "
2702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2703 #: apt.conf.5.xml:368
2705 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2706 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2707 "response under any circumstances. <literal>Max-Age</literal> sets the "
2708 "allowed maximum age (in seconds) of an index file in the cache of the "
2709 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2710 "store the requested archive files in its cache, which can be used to prevent "
2711 "the proxy from polluting its cache with (big) .deb files."
2714 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2715 #: apt.conf.5.xml:378 apt.conf.5.xml:466
2717 "The option <literal>timeout</literal> sets the timeout timer used by the "
2718 "method; this value applies to the connection as well as the data timeout."
2721 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2722 #: apt.conf.5.xml:381
2724 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2725 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2726 "e.g. on high-latency connections. It specifies how many requests are sent in "
2727 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
2728 "the default value is now 0 (= disabled) to avoid problems with the "
2729 "ever-growing amount of webservers and proxies which choose to not conform to "
2730 "the HTTP/1.1 specification."
2733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2734 #: apt.conf.5.xml:388
2736 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
2737 "follow redirects, which is enabled by default."
2740 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2741 #: apt.conf.5.xml:391
2743 "The used bandwidth can be limited with "
2744 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
2745 "kilobytes per second. The default value is 0 which deactivates the limit and "
2746 "tries to use all available bandwidth. Note that this option implicitly "
2747 "disables downloading from multiple servers at the same time."
2750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2751 #: apt.conf.5.xml:398
2753 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
2754 "User-Agent for the http download method as some proxies allow access for "
2755 "clients only if the client uses a known identifier."
2758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2759 #: apt.conf.5.xml:402
2761 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
2762 "an external command to discover the http proxy to use. Apt expects the "
2763 "command to output the proxy on stdout in the style "
2764 "<literal>http://proxy:port/</literal>. This will override the generic "
2765 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
2766 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
2767 "the &squid-deb-proxy-client; package for an example implementation that uses "
2768 "avahi. This option takes precedence over the legacy option name "
2769 "<literal>ProxyAutoDetect</literal>."
2772 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2773 #: apt.conf.5.xml:420
2775 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
2776 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
2777 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
2778 "the <literal>http</literal> method, and default to the same values if they "
2779 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
2783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2784 #: apt.conf.5.xml:428
2786 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
2787 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
2788 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
2789 "suboption determines whether or not the server's host certificate should be "
2790 "verified against trusted certificates. "
2791 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
2792 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
2793 "or not the server's hostname should be verified. "
2794 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
2795 "option. <literal>SslCert</literal> determines what certificate to use for "
2796 "client authentication. <literal><host>::SslCert</literal> is the "
2797 "corresponding per-host option. <literal>SslKey</literal> determines what "
2798 "private key to use for client "
2799 "authentication. <literal><host>::SslKey</literal> is the corresponding "
2800 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
2801 "version to use. It can contain either of the strings "
2802 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
2803 "<literal><host>::SslForceVersion</literal> is the corresponding "
2807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2808 #: apt.conf.5.xml:449
2810 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
2811 "It is in the standard form of "
2812 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
2813 "also be specified by using the form "
2814 "<literal>ftp::Proxy::<host></literal> with the special keyword "
2815 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2816 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
2817 "used. To use an FTP proxy you will have to set the "
2818 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
2819 "entry specifies the commands to send to tell the proxy server what to "
2820 "connect to. Please see &configureindex; for an example of how to do "
2821 "this. The substitution variables representing the corresponding URI "
2822 "component are <literal>$(PROXY_USER)</literal>, "
2823 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
2824 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
2825 "<literal>$(SITE_PORT)</literal>."
2828 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2829 #: apt.conf.5.xml:469
2831 "Several settings are provided to control passive mode. Generally it is safe "
2832 "to leave passive mode on; it works in nearly every environment. However, "
2833 "some situations require that passive mode be disabled and port mode FTP used "
2834 "instead. This can be done globally or for connections that go through a "
2835 "proxy or for a specific host (see the sample config file for examples)."
2838 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2839 #: apt.conf.5.xml:476
2841 "It is possible to proxy FTP over HTTP by setting the "
2842 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
2843 "discussion of the http method above for syntax. You cannot set this in the "
2844 "configuration file and it is not recommended to use FTP over HTTP due to its "
2848 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2849 #: apt.conf.5.xml:481
2851 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
2852 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
2853 "false, which means these commands are only used if the control connection is "
2854 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
2855 "that most FTP servers do not support RFC2428."
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2859 #: apt.conf.5.xml:495
2861 msgid "/cdrom/::Mount \"foo\";"
2864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2865 #: apt.conf.5.xml:490
2867 "For URIs using the <literal>cdrom</literal> method, the only configurable "
2868 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
2869 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
2870 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
2871 "and unmount commands if your mount point cannot be listed in the fstab. The "
2872 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
2873 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
2874 "Unmount commands can be specified using UMount."
2877 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2878 #: apt.conf.5.xml:503
2880 "For GPGV URIs the only configurable option is "
2881 "<literal>gpgv::Options</literal>, which passes additional parameters to "
2885 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2886 #: apt.conf.5.xml:514
2889 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
2890 "\"<replaceable>Methodname</replaceable>\";"
2893 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2894 #: apt.conf.5.xml:509
2896 "List of compression types which are understood by the acquire methods. "
2897 "Files like <filename>Packages</filename> can be available in various "
2898 "compression formats. By default the acquire methods can decompress "
2899 "<command>bzip2</command>, <command>lzma</command> and "
2900 "<command>gzip</command> compressed files; with this setting more formats can "
2901 "be added on the fly or the used method can be changed. The syntax for this "
2902 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
2905 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2906 #: apt.conf.5.xml:519
2908 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
2911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2912 #: apt.conf.5.xml:522
2914 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
2917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2918 #: apt.conf.5.xml:515
2920 "Also, the <literal>Order</literal> subgroup can be used to define in which "
2921 "order the acquire system will try to download the compressed files. The "
2922 "acquire system will try the first and proceed with the next compression type "
2923 "in this list on error, so to prefer one over the other type simply add the "
2924 "preferred type first - default types not already added will be implicitly "
2925 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
2926 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
2927 "over <command>bzip2</command> and <command>lzma</command>. If "
2928 "<command>lzma</command> should be preferred over <command>gzip</command> and "
2929 "<command>bzip2</command> the configure setting should look like this: "
2930 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
2931 "<literal>bz2</literal> to the list explicitly as it will be added "
2935 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2936 #: apt.conf.5.xml:529
2938 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
2941 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2942 #: apt.conf.5.xml:524
2945 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
2946 "checked at run time. If this option has been set, the method will only be "
2947 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
2948 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
2949 "also that list entries specified on the command line will be added at the "
2950 "end of the list specified in the configuration files, but before the default "
2951 "entries. To prefer a type in this case over the ones specified in the "
2952 "configuration files you can set the option direct - not in list style. This "
2953 "will not override the defined list; it will only prefix the list with this "
2957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2958 #: apt.conf.5.xml:534
2960 "The special type <literal>uncompressed</literal> can be used to give "
2961 "uncompressed files a preference, but note that most archives don't provide "
2962 "uncompressed files so this is mostly only useable for local mirrors."
2965 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2966 #: apt.conf.5.xml:541
2968 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
2969 "Sources, or Translations), keep them gzip compressed locally instead of "
2970 "unpacking them. This saves quite a lot of disk space at the expense of more "
2971 "CPU requirements when building the local package caches. False by default."
2974 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2975 #: apt.conf.5.xml:549
2977 "The Languages subsection controls which <filename>Translation</filename> "
2978 "files are downloaded and in which order APT tries to display the "
2979 "description-translations. APT will try to display the first available "
2980 "description in the language which is listed first. Languages can be defined "
2981 "with their short or long language codes. Note that not all archives provide "
2982 "<filename>Translation</filename> files for every language - the long "
2983 "language codes are especially rare."
2986 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
2987 #: apt.conf.5.xml:566
2989 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
2992 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2993 #: apt.conf.5.xml:554
2995 "The default list includes \"environment\" and "
2996 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
2997 "will be replaced at runtime with the language codes extracted from the "
2998 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
2999 "that these codes are not included twice in the list. If "
3000 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3001 "<filename>Translation-en</filename> file (if available) will be used. To "
3002 "force APT to use no Translation file use the setting "
3003 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3004 "another special meaning code which will stop the search for a suitable "
3005 "<filename>Translation</filename> file. This tells APT to download these "
3006 "translations too, without actually using them unless the environment "
3007 "specifies the languages. So the following example configuration will result "
3008 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3009 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3010 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3011 "type=\"programlisting\" id=\"0\"/>"
3014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3015 #: apt.conf.5.xml:567
3017 "Note: To prevent problems resulting from APT being executed in different "
3018 "environments (e.g. by different users or by other programs) all Translation "
3019 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3020 "added to the end of the list (after an implicit "
3021 "\"<literal>none</literal>\")."
3024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3025 #: apt.conf.5.xml:576
3026 msgid "When downloading, force to use only the IPv4 protocol."
3029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3030 #: apt.conf.5.xml:582
3031 msgid "When downloading, force to use only the IPv6 protocol."
3034 #. type: Content of: <refentry><refsect1><title>
3035 #: apt.conf.5.xml:589
3039 #. type: Content of: <refentry><refsect1><para>
3040 #: apt.conf.5.xml:591
3042 "The <literal>Dir::State</literal> section has directories that pertain to "
3043 "local state information. <literal>lists</literal> is the directory to place "
3044 "downloaded package lists in and <literal>status</literal> is the name of the "
3045 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3046 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3047 "contains the default directory to prefix on all sub-items if they do not "
3048 "start with <filename>/</filename> or <filename>./</filename>."
3051 #. type: Content of: <refentry><refsect1><para>
3052 #: apt.conf.5.xml:598
3054 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3055 "information, such as the two package caches <literal>srcpkgcache</literal> "
3056 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3057 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3058 "be turned off by setting their names to the empty string. This will slow "
3059 "down startup but save disk space. It is probably preferable to turn off the "
3060 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3061 "default directory is contained in <literal>Dir::Cache</literal>"
3064 #. type: Content of: <refentry><refsect1><para>
3065 #: apt.conf.5.xml:607
3067 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3068 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3069 "<literal>main</literal> is the default configuration file (setting has no "
3070 "effect, unless it is done from the config file specified by "
3071 "<envar>APT_CONFIG</envar>)."
3074 #. type: Content of: <refentry><refsect1><para>
3075 #: apt.conf.5.xml:613
3077 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3078 "in lexical order from the directory specified. After this is done then the "
3079 "main config file is loaded."
3082 #. type: Content of: <refentry><refsect1><para>
3083 #: apt.conf.5.xml:617
3085 "Binary programs are pointed to by "
3086 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3087 "the location of the method handlers and <literal>gzip</literal>, "
3088 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3089 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3090 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3091 "specify the location of the respective programs."
3094 #. type: Content of: <refentry><refsect1><para>
3095 #: apt.conf.5.xml:625
3097 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3098 "set, all paths in <literal>Dir::</literal> will be relative to "
3099 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3100 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3101 "set to <filename>/tmp/staging</filename> and "
3102 "<literal>Dir::State::status</literal> is set to "
3103 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3104 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
3107 #. type: Content of: <refentry><refsect1><para>
3108 #: apt.conf.5.xml:638
3110 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3111 "which files APT should silently ignore while parsing the files in the "
3112 "fragment directories. Per default a file which end with "
3113 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3114 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3115 "default value these patterns can use regular expression syntax."
3118 #. type: Content of: <refentry><refsect1><title>
3119 #: apt.conf.5.xml:647
3120 msgid "APT in DSelect"
3123 #. type: Content of: <refentry><refsect1><para>
3124 #: apt.conf.5.xml:649
3126 "When APT is used as a &dselect; method several configuration directives "
3127 "control the default behavior. These are in the <literal>DSelect</literal> "
3131 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3132 #: apt.conf.5.xml:654
3134 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3135 "<literal>prompt</literal>, <literal>auto</literal>, "
3136 "<literal>pre-auto</literal> and <literal>never</literal>. "
3137 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3138 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3139 "default) does so conditionally. <literal>auto</literal> removes only those "
3140 "packages which are no longer downloadable (replaced with a new version for "
3141 "instance). <literal>pre-auto</literal> performs this action before "
3142 "downloading new packages."
3145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3146 #: apt.conf.5.xml:668
3148 "The contents of this variable are passed to &apt-get; as command line "
3149 "options when it is run for the install phase."
3152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3153 #: apt.conf.5.xml:673
3155 "The contents of this variable are passed to &apt-get; as command line "
3156 "options when it is run for the update phase."
3159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3160 #: apt.conf.5.xml:678
3162 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3163 "The default is to prompt only on error."
3166 #. type: Content of: <refentry><refsect1><title>
3167 #: apt.conf.5.xml:684
3168 msgid "How APT calls &dpkg;"
3171 #. type: Content of: <refentry><refsect1><para>
3172 #: apt.conf.5.xml:685
3174 "Several configuration directives control how APT invokes &dpkg;. These are "
3175 "in the <literal>DPkg</literal> section."
3178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3179 #: apt.conf.5.xml:690
3181 "This is a list of options to pass to &dpkg;. The options must be specified "
3182 "using the list notation and each list item is passed as a single argument to "
3186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3187 #: apt.conf.5.xml:696
3189 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3190 "<literal>options</literal> this must be specified in list notation. The "
3191 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3192 "fail APT will abort."
3195 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3196 #: apt.conf.5.xml:703
3198 "This is a list of shell commands to run before invoking &dpkg;. Like "
3199 "<literal>options</literal> this must be specified in list notation. The "
3200 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3201 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3202 "going to install to the commands, one per line on the requested file "
3203 "descriptor, defaulting to standard input."
3206 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3207 #: apt.conf.5.xml:710
3209 "Version 2 of this protocol dumps more information, including the protocol "
3210 "version, the APT configuration space and the packages, files and versions "
3211 "being changed. Version 3 adds the architecture and "
3212 "<literal>MultiArch</literal> flag to each version being dumped."
3215 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3216 #: apt.conf.5.xml:715
3218 "The version of the protocol to be used for the command "
3219 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3220 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3221 "accordingly, the default being version 1. If APT isn't supporting the "
3222 "requested version it will send the information in the highest version it has "
3223 "support for instead."
3226 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3227 #: apt.conf.5.xml:722
3229 "The file descriptor to be used to send the information can be requested with "
3230 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3231 "which defaults to <literal>0</literal> for standard input and is available "
3232 "since version 0.9.11. Support for the option can be detected by looking for "
3233 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3234 "number of the used file descriptor as a confirmation."
3237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3238 #: apt.conf.5.xml:732
3240 "APT chdirs to this directory before invoking &dpkg;, the default is "
3241 "<filename>/</filename>."
3244 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3245 #: apt.conf.5.xml:737
3247 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3248 "default is to disable signing and produce all binaries."
3251 #. type: Content of: <refentry><refsect1><refsect2><title>
3252 #: apt.conf.5.xml:742
3253 msgid "dpkg trigger usage (and related options)"
3256 #. type: Content of: <refentry><refsect1><refsect2><para>
3257 #: apt.conf.5.xml:743
3259 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3260 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3261 "use triggers once each time it runs. Activating these options can therefore "
3262 "decrease the time needed to perform the install or upgrade. Note that it is "
3263 "intended to activate these options per default in the future, but as it "
3264 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3265 "<emphasis>These options are therefore currently experimental and should not "
3266 "be used in production environments.</emphasis> It also breaks progress "
3267 "reporting such that all front-ends will currently stay around half (or more) "
3268 "of the time in the 100% state while it actually configures all packages."
3271 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3272 #: apt.conf.5.xml:758
3275 "DPkg::NoTriggers \"true\";\n"
3276 "PackageManager::Configure \"smart\";\n"
3277 "DPkg::ConfigurePending \"true\";\n"
3278 "DPkg::TriggersPending \"true\";"
3281 #. type: Content of: <refentry><refsect1><refsect2><para>
3282 #: apt.conf.5.xml:752
3284 "Note that it is not guaranteed that APT will support these options or that "
3285 "these options will not cause (big) trouble in the future. If you have "
3286 "understand the current risks and problems with these options, but are brave "
3287 "enough to help testing them, create a new configuration file and test a "
3288 "combination of options. Please report any bugs, problems and improvements "
3289 "you encounter and make sure to note which options you have used in your "
3290 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3291 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3292 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3295 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3296 #: apt.conf.5.xml:765
3298 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3299 "call). See &dpkg; if you are interested in what this actually means. In "
3300 "short: &dpkg; will not run the triggers when this flag is present unless it "
3301 "is explicitly called to do so in an extra call. Note that this option "
3302 "exists (undocumented) also in older APT versions with a slightly different "
3303 "meaning: Previously these option only append --no-triggers to the configure "
3304 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3308 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3309 #: apt.conf.5.xml:773
3311 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3312 "and \"<literal>no</literal>\". The default value is "
3313 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3314 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3315 "be configured before another package can be unpacked (Pre-Depends), and let "
3316 "the rest be configured by &dpkg; with a call generated by the "
3317 "ConfigurePending option (see below). On the other hand, "
3318 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3319 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3320 "encountered). Setting this option to any value other than "
3321 "<literal>all</literal> will implicitly also activate the next option by "
3322 "default, as otherwise the system could end in an unconfigured and "
3323 "potentially unbootable state."
3326 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3327 #: apt.conf.5.xml:788
3329 "If this option is set APT will call <command>dpkg --configure "
3330 "--pending</command> to let &dpkg; handle all required configurations and "
3331 "triggers. This option is activated automatically per default if the previous "
3332 "option is not set to <literal>all</literal>, but deactivating it could be "
3333 "useful if you want to run APT multiple times in a row - e.g. in an "
3334 "installer. In these sceneries you could deactivate this option in all but "
3338 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3339 #: apt.conf.5.xml:795
3341 "Useful for the <literal>smart</literal> configuration as a package which has "
3342 "pending triggers is not considered as <literal>installed</literal>, and "
3343 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3344 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3345 "process all triggers, not only the triggers needed to configure this "
3349 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3350 #: apt.conf.5.xml:808
3353 "OrderList::Score {\n"
3355 "\tEssential 200;\n"
3357 "\tPreDepends 50;\n"
3361 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3362 #: apt.conf.5.xml:801
3364 "Essential packages (and their dependencies) should be configured immediately "
3365 "after unpacking. It is a good idea to do this quite early in the upgrade "
3366 "process as these configure calls also currently require "
3367 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3368 "(which may not be needed). Essentials get per default a high score but the "
3369 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3370 "higher). These option and the others in the same group can be used to "
3371 "change the scoring. The following example shows the settings with their "
3372 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3375 #. type: Content of: <refentry><refsect1><title>
3376 #: apt.conf.5.xml:821
3377 msgid "Periodic and Archives options"
3380 #. type: Content of: <refentry><refsect1><para>
3381 #: apt.conf.5.xml:822
3383 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3384 "of options configure behavior of apt periodic updates, which is done by the "
3385 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3386 "for the brief documentation of these options."
3389 #. type: Content of: <refentry><refsect1><title>
3390 #: apt.conf.5.xml:830
3391 msgid "Debug options"
3394 #. type: Content of: <refentry><refsect1><para>
3395 #: apt.conf.5.xml:832
3397 "Enabling options in the <literal>Debug::</literal> section will cause "
3398 "debugging information to be sent to the standard error stream of the program "
3399 "utilizing the <literal>apt</literal> libraries, or enable special program "
3400 "modes that are primarily useful for debugging the behavior of "
3401 "<literal>apt</literal>. Most of these options are not interesting to a "
3402 "normal user, but a few may be:"
3405 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3406 #: apt.conf.5.xml:843
3408 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3409 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3413 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3414 #: apt.conf.5.xml:851
3416 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3417 "used to run some operations (for instance, <literal>apt-get -s "
3418 "install</literal>) as a non-root user."
3421 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3422 #: apt.conf.5.xml:860
3424 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3425 "time that <literal>apt</literal> invokes &dpkg;."
3429 #. motivating example, except I haven't a clue why you'd want
3431 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3432 #: apt.conf.5.xml:868
3434 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3438 #. type: Content of: <refentry><refsect1><para>
3439 #: apt.conf.5.xml:878
3440 msgid "A full list of debugging options to apt follows."
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3444 #: apt.conf.5.xml:887
3445 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3449 #: apt.conf.5.xml:898
3450 msgid "Print information related to downloading packages using FTP."
3453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3454 #: apt.conf.5.xml:909
3455 msgid "Print information related to downloading packages using HTTP."
3458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3459 #: apt.conf.5.xml:920
3460 msgid "Print information related to downloading packages using HTTPS."
3463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3464 #: apt.conf.5.xml:931
3466 "Print information related to verifying cryptographic signatures using "
3467 "<literal>gpg</literal>."
3470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3471 #: apt.conf.5.xml:942
3473 "Output information about the process of accessing collections of packages "
3474 "stored on CD-ROMs."
3477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3478 #: apt.conf.5.xml:952
3479 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3483 #: apt.conf.5.xml:962
3485 "Output each cryptographic hash that is generated by the "
3486 "<literal>apt</literal> libraries."
3489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3490 #: apt.conf.5.xml:972
3492 "Do not include information from <literal>statfs</literal>, namely the number "
3493 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3497 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3498 #: apt.conf.5.xml:983
3500 "Disable all file locking. For instance, this will allow two instances of "
3501 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3505 #: apt.conf.5.xml:995
3506 msgid "Log when items are added to or removed from the global download queue."
3509 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3510 #: apt.conf.5.xml:1005
3512 "Output status messages and errors related to verifying checksums and "
3513 "cryptographic signatures of downloaded files."
3516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3517 #: apt.conf.5.xml:1015
3519 "Output information about downloading and applying package index list diffs, "
3520 "and errors relating to package index list diffs."
3523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3524 #: apt.conf.5.xml:1027
3526 "Output information related to patching apt package lists when downloading "
3527 "index diffs instead of full indices."
3530 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3531 #: apt.conf.5.xml:1038
3532 msgid "Log all interactions with the sub-processes that actually perform downloads."
3535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3536 #: apt.conf.5.xml:1049
3538 "Log events related to the automatically-installed status of packages and to "
3539 "the removal of unused packages."
3542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3543 #: apt.conf.5.xml:1059
3545 "Generate debug messages describing which packages are being automatically "
3546 "installed to resolve dependencies. This corresponds to the initial "
3547 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3548 "and not to the full <literal>apt</literal> dependency resolver; see "
3549 "<literal>Debug::pkgProblemResolver</literal> for that."
3552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3553 #: apt.conf.5.xml:1073
3555 "Generate debug messages describing which packages are marked as "
3556 "keep/install/remove while the ProblemResolver does his work. Each addition "
3557 "or deletion may trigger additional actions; they are shown indented two "
3558 "additional spaces under the original entry. The format for each line is "
3559 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3560 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3561 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3562 "is the current version of the package, <literal>d.e.f</literal> is the "
3563 "version considered for installation and <literal>x.y.z</literal> is a newer "
3564 "version, but not considered for installation (because of a low pin "
3565 "score). The later two can be omitted if there is none or if it is the same "
3566 "as the installed version. <literal>section</literal> is the name of the "
3567 "section the package appears in."
3570 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3571 #: apt.conf.5.xml:1094
3573 "When invoking &dpkg;, output the precise command line with which it is being "
3574 "invoked, with arguments separated by a single space character."
3577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3578 #: apt.conf.5.xml:1105
3580 "Output all the data received from &dpkg; on the status file descriptor and "
3581 "any errors encountered while parsing it."
3584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3585 #: apt.conf.5.xml:1116
3587 "Generate a trace of the algorithm that decides the order in which "
3588 "<literal>apt</literal> should pass packages to &dpkg;."
3591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3592 #: apt.conf.5.xml:1128
3593 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3597 #: apt.conf.5.xml:1139
3598 msgid "Output the priority of each package list on startup."
3601 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3602 #: apt.conf.5.xml:1149
3604 "Trace the execution of the dependency resolver (this applies only to what "
3605 "happens when a complex dependency problem is encountered)."
3608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3609 #: apt.conf.5.xml:1160
3611 "Display a list of all installed packages with their calculated score used by "
3612 "the pkgProblemResolver. The description of the package is the same as "
3613 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3616 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3617 #: apt.conf.5.xml:1172
3619 "Print information about the vendors read from "
3620 "<filename>/etc/apt/vendors.list</filename>."
3623 #. type: Content of: <refentry><refsect1><title>
3624 #: apt.conf.5.xml:1194 apt_preferences.5.xml:547 sources.list.5.xml:239 apt-ftparchive.1.xml:598
3628 #. type: Content of: <refentry><refsect1><para>
3629 #: apt.conf.5.xml:1195
3631 "&configureindex; is a configuration file showing example values for all "
3635 #. ? reading apt.conf
3636 #. type: Content of: <refentry><refsect1><para>
3637 #: apt.conf.5.xml:1207
3638 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
3641 #. type: Content of: <refentry><refnamediv><refpurpose>
3642 #: apt_preferences.5.xml:34
3643 msgid "Preference control file for APT"
3646 #. type: Content of: <refentry><refsect1><para>
3647 #: apt_preferences.5.xml:39
3649 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
3650 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
3651 "can be used to control which versions of packages will be selected for "
3655 #. type: Content of: <refentry><refsect1><para>
3656 #: apt_preferences.5.xml:44
3658 "Several versions of a package may be available for installation when the "
3659 "&sources-list; file contains references to more than one distribution (for "
3660 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
3661 "assigns a priority to each version that is available. Subject to dependency "
3662 "constraints, <command>apt-get</command> selects the version with the highest "
3663 "priority for installation. The APT preferences override the priorities that "
3664 "APT assigns to package versions by default, thus giving the user control "
3665 "over which one is selected for installation."
3668 #. type: Content of: <refentry><refsect1><para>
3669 #: apt_preferences.5.xml:54
3671 "Several instances of the same version of a package may be available when the "
3672 "&sources-list; file contains references to more than one source. In this "
3673 "case <command>apt-get</command> downloads the instance listed earliest in "
3674 "the &sources-list; file. The APT preferences do not affect the choice of "
3675 "instance, only the choice of version."
3678 #. type: Content of: <refentry><refsect1><para>
3679 #: apt_preferences.5.xml:61
3681 "Preferences are a strong power in the hands of a system administrator but "
3682 "they can become also their biggest nightmare if used without care! APT will "
3683 "not question the preferences, so wrong settings can lead to uninstallable "
3684 "packages or wrong decisions while upgrading packages. Even more problems "
3685 "will arise if multiple distribution releases are mixed without a good "
3686 "understanding of the following paragraphs. Packages included in a specific "
3687 "release aren't tested in (and therefore don't always work as expected in) "
3688 "older or newer releases, or together with other packages from different "
3689 "releases. You have been warned."
3692 #. type: Content of: <refentry><refsect1><para>
3693 #: apt_preferences.5.xml:72
3695 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
3696 "directory are parsed in alphanumeric ascending order and need to obey the "
3697 "following naming convention: The files have either no or "
3698 "\"<literal>pref</literal>\" as filename extension and only contain "
3699 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
3700 "Otherwise APT will print a notice that it has ignored a file, unless that "
3701 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
3702 "configuration list - in which case it will be silently ignored."
3705 #. type: Content of: <refentry><refsect1><refsect2><title>
3706 #: apt_preferences.5.xml:81
3707 msgid "APT's Default Priority Assignments"
3710 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3711 #: apt_preferences.5.xml:96
3714 "<command>apt-get install -t testing "
3715 "<replaceable>some-package</replaceable></command>\n"
3718 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3719 #: apt_preferences.5.xml:99
3721 msgid "APT::Default-Release \"stable\";\n"
3724 #. type: Content of: <refentry><refsect1><refsect2><para>
3725 #: apt_preferences.5.xml:83
3727 "If there is no preferences file or if there is no entry in the file that "
3728 "applies to a particular version then the priority assigned to that version "
3729 "is the priority of the distribution to which that version belongs. It is "
3730 "possible to single out a distribution, \"the target release\", which "
3731 "receives a higher priority than other distributions do by default. The "
3732 "target release can be set on the <command>apt-get</command> command line or "
3733 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
3734 "that this has precedence over any general priority you set in the "
3735 "<filename>/etc/apt/preferences</filename> file described later, but not over "
3736 "specifically pinned packages. For example, <placeholder "
3737 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
3741 #. type: Content of: <refentry><refsect1><refsect2><para>
3742 #: apt_preferences.5.xml:103
3744 "If the target release has been specified then APT uses the following "
3745 "algorithm to set the priorities of the versions of a package. Assign:"
3748 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3749 #: apt_preferences.5.xml:108
3753 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3754 #: apt_preferences.5.xml:109
3756 "to the versions coming from archives which in their "
3757 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
3758 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
3759 "<literal>experimental</literal> archive."
3762 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3763 #: apt_preferences.5.xml:115
3764 msgid "priority 100"
3767 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3768 #: apt_preferences.5.xml:116
3770 "to the version that is already installed (if any) and to the versions coming "
3771 "from archives which in their <filename>Release</filename> files are marked "
3772 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
3773 "backports archive since <literal>squeeze-backports</literal>."
3776 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3777 #: apt_preferences.5.xml:123
3778 msgid "priority 500"
3781 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3782 #: apt_preferences.5.xml:124
3784 "to the versions that are not installed and do not belong to the target "
3788 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3789 #: apt_preferences.5.xml:128
3790 msgid "priority 990"
3793 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3794 #: apt_preferences.5.xml:129
3795 msgid "to the versions that are not installed and belong to the target release."
3798 #. type: Content of: <refentry><refsect1><refsect2><para>
3799 #: apt_preferences.5.xml:134
3801 "If the target release has not been specified then APT simply assigns "
3802 "priority 100 to all installed package versions and priority 500 to all "
3803 "uninstalled package versions, except versions coming from archives which in "
3804 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
3805 "- these versions get the priority 1 or priority 100 if it is additionally "
3806 "marked as \"ButAutomaticUpgrades: yes\"."
3809 #. type: Content of: <refentry><refsect1><refsect2><para>
3810 #: apt_preferences.5.xml:141
3812 "APT then applies the following rules, listed in order of precedence, to "
3813 "determine which version of a package to install."
3816 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3817 #: apt_preferences.5.xml:144
3819 "Never downgrade unless the priority of an available version exceeds 1000. "
3820 "(\"Downgrading\" is installing a less recent version of a package in place "
3821 "of a more recent version. Note that none of APT's default priorities "
3822 "exceeds 1000; such high priorities can only be set in the preferences file. "
3823 "Note also that downgrading a package can be risky.)"
3826 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3827 #: apt_preferences.5.xml:150
3828 msgid "Install the highest priority version."
3831 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3832 #: apt_preferences.5.xml:151
3834 "If two or more versions have the same priority, install the most recent one "
3835 "(that is, the one with the higher version number)."
3838 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3839 #: apt_preferences.5.xml:154
3841 "If two or more versions have the same priority and version number but either "
3842 "the packages differ in some of their metadata or the "
3843 "<literal>--reinstall</literal> option is given, install the uninstalled one."
3846 #. type: Content of: <refentry><refsect1><refsect2><para>
3847 #: apt_preferences.5.xml:160
3849 "In a typical situation, the installed version of a package (priority 100) "
3850 "is not as recent as one of the versions available from the sources listed in "
3851 "the &sources-list; file (priority 500 or 990). Then the package will be "
3852 "upgraded when <command>apt-get install "
3853 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3854 "upgrade</command> is executed."
3857 #. type: Content of: <refentry><refsect1><refsect2><para>
3858 #: apt_preferences.5.xml:167
3860 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
3861 "recent than any of the other available versions. The package will not be "
3862 "downgraded when <command>apt-get install "
3863 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3864 "upgrade</command> is executed."
3867 #. type: Content of: <refentry><refsect1><refsect2><para>
3868 #: apt_preferences.5.xml:172
3870 "Sometimes the installed version of a package is more recent than the version "
3871 "belonging to the target release, but not as recent as a version belonging to "
3872 "some other distribution. Such a package will indeed be upgraded when "
3873 "<command>apt-get install <replaceable>some-package</replaceable></command> "
3874 "or <command>apt-get upgrade</command> is executed, because at least "
3875 "<emphasis>one</emphasis> of the available versions has a higher priority "
3876 "than the installed version."
3879 #. type: Content of: <refentry><refsect1><refsect2><title>
3880 #: apt_preferences.5.xml:181
3881 msgid "The Effect of APT Preferences"
3884 #. type: Content of: <refentry><refsect1><refsect2><para>
3885 #: apt_preferences.5.xml:183
3887 "The APT preferences file allows the system administrator to control the "
3888 "assignment of priorities. The file consists of one or more multi-line "
3889 "records separated by blank lines. Records can have one of two forms, a "
3890 "specific form and a general form."
3893 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3894 #: apt_preferences.5.xml:189
3896 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
3897 "specified packages with a specified version or version range. For example, "
3898 "the following record assigns a high priority to all versions of the "
3899 "<filename>perl</filename> package whose version number begins with "
3900 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
3904 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3905 #: apt_preferences.5.xml:196
3909 "Pin: version &good-perl;*\n"
3910 "Pin-Priority: 1001\n"
3913 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3914 #: apt_preferences.5.xml:202
3916 "The general form assigns a priority to all of the package versions in a "
3917 "given distribution (that is, to all the versions of packages that are listed "
3918 "in a certain <filename>Release</filename> file) or to all of the package "
3919 "versions coming from a particular Internet site, as identified by the site's "
3920 "fully qualified domain name."
3923 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3924 #: apt_preferences.5.xml:208
3926 "This general-form entry in the APT preferences file applies only to groups "
3927 "of packages. For example, the following record assigns a high priority to "
3928 "all package versions available from the local site."
3931 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3932 #: apt_preferences.5.xml:213
3936 "Pin: origin \"\"\n"
3937 "Pin-Priority: 999\n"
3940 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3941 #: apt_preferences.5.xml:218
3943 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
3944 "which can be used to match a hostname. The following record will assign a "
3945 "high priority to all versions available from the server identified by the "
3946 "hostname \"ftp.de.debian.org\""
3949 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3950 #: apt_preferences.5.xml:222
3954 "Pin: origin \"ftp.de.debian.org\"\n"
3955 "Pin-Priority: 999\n"
3958 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3959 #: apt_preferences.5.xml:226
3961 "This should <emphasis>not</emphasis> be confused with the Origin of a "
3962 "distribution as specified in a <filename>Release</filename> file. What "
3963 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
3964 "Internet address but an author or vendor name, such as \"Debian\" or "
3968 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3969 #: apt_preferences.5.xml:231
3971 "The following record assigns a low priority to all package versions "
3972 "belonging to any distribution whose Archive name is "
3973 "\"<literal>unstable</literal>\"."
3976 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3977 #: apt_preferences.5.xml:235
3981 "Pin: release a=unstable\n"
3982 "Pin-Priority: 50\n"
3985 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3986 #: apt_preferences.5.xml:240
3988 "The following record assigns a high priority to all package versions "
3989 "belonging to any distribution whose Codename is "
3990 "\"<literal>&testing-codename;</literal>\"."
3993 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3994 #: apt_preferences.5.xml:244
3998 "Pin: release n=&testing-codename;\n"
3999 "Pin-Priority: 900\n"
4002 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4003 #: apt_preferences.5.xml:249
4005 "The following record assigns a high priority to all package versions "
4006 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4007 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4010 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4011 #: apt_preferences.5.xml:254
4015 "Pin: release a=stable, v=&stable-version;\n"
4016 "Pin-Priority: 500\n"
4019 #. type: Content of: <refentry><refsect1><refsect2><title>
4020 #: apt_preferences.5.xml:264
4021 msgid "Regular expressions and &glob; syntax"
4024 #. type: Content of: <refentry><refsect1><refsect2><para>
4025 #: apt_preferences.5.xml:266
4027 "APT also supports pinning by &glob; expressions, and regular expressions "
4028 "surrounded by slashes. For example, the following example assigns the "
4029 "priority 500 to all packages from experimental where the name starts with "
4030 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4031 "extended regular expression surrounded by slashes)."
4034 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4035 #: apt_preferences.5.xml:275
4038 "Package: gnome* /kde/\n"
4039 "Pin: release n=experimental\n"
4040 "Pin-Priority: 500\n"
4043 #. type: Content of: <refentry><refsect1><refsect2><para>
4044 #: apt_preferences.5.xml:281
4046 "The rule for those expressions is that they can occur anywhere where a "
4047 "string can occur. Thus, the following pin assigns the priority 990 to all "
4048 "packages from a release starting with &ubuntu-codename;."
4051 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4052 #: apt_preferences.5.xml:287
4056 "Pin: release n=&ubuntu-codename;*\n"
4057 "Pin-Priority: 990\n"
4060 #. type: Content of: <refentry><refsect1><refsect2><para>
4061 #: apt_preferences.5.xml:293
4063 "If a regular expression occurs in a <literal>Package</literal> field, the "
4064 "behavior is the same as if this regular expression were replaced with a list "
4065 "of all package names it matches. It is undecided whether this will change in "
4066 "the future; thus you should always list wild-card pins first, so later "
4067 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4068 "Package field is not considered a &glob; expression in itself."
4071 #. type: Content of: <refentry><refsect1><refsect2><title>
4072 #: apt_preferences.5.xml:309
4073 msgid "How APT Interprets Priorities"
4076 #. type: Content of: <refentry><refsect1><refsect2><para>
4077 #: apt_preferences.5.xml:312
4079 "Priorities (P) assigned in the APT preferences file must be positive or "
4080 "negative integers. They are interpreted as follows (roughly speaking):"
4083 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4084 #: apt_preferences.5.xml:317
4085 msgid "P >= 1000"
4088 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4089 #: apt_preferences.5.xml:318
4091 "causes a version to be installed even if this constitutes a downgrade of the "
4095 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4096 #: apt_preferences.5.xml:322
4097 msgid "990 <= P < 1000"
4100 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4101 #: apt_preferences.5.xml:323
4103 "causes a version to be installed even if it does not come from the target "
4104 "release, unless the installed version is more recent"
4107 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4108 #: apt_preferences.5.xml:328
4109 msgid "500 <= P < 990"
4112 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4113 #: apt_preferences.5.xml:329
4115 "causes a version to be installed unless there is a version available "
4116 "belonging to the target release or the installed version is more recent"
4119 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4120 #: apt_preferences.5.xml:334
4121 msgid "100 <= P < 500"
4124 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4125 #: apt_preferences.5.xml:335
4127 "causes a version to be installed unless there is a version available "
4128 "belonging to some other distribution or the installed version is more recent"
4131 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4132 #: apt_preferences.5.xml:340
4133 msgid "0 < P < 100"
4136 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4137 #: apt_preferences.5.xml:341
4139 "causes a version to be installed only if there is no installed version of "
4143 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4144 #: apt_preferences.5.xml:345
4148 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4149 #: apt_preferences.5.xml:346
4150 msgid "prevents the version from being installed"
4153 #. type: Content of: <refentry><refsect1><refsect2><para>
4154 #: apt_preferences.5.xml:351
4156 "If any specific-form records match an available package version then the "
4157 "first such record determines the priority of the package version. Failing "
4158 "that, if any general-form records match an available package version then "
4159 "the first such record determines the priority of the package version."
4162 #. type: Content of: <refentry><refsect1><refsect2><para>
4163 #: apt_preferences.5.xml:357
4165 "For example, suppose the APT preferences file contains the three records "
4166 "presented earlier:"
4169 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4170 #: apt_preferences.5.xml:361
4174 "Pin: version &good-perl;*\n"
4175 "Pin-Priority: 1001\n"
4178 "Pin: origin \"\"\n"
4179 "Pin-Priority: 999\n"
4182 "Pin: release unstable\n"
4183 "Pin-Priority: 50\n"
4186 #. type: Content of: <refentry><refsect1><refsect2><para>
4187 #: apt_preferences.5.xml:374
4191 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4192 #: apt_preferences.5.xml:376
4194 "The most recent available version of the <literal>perl</literal> package "
4195 "will be installed, so long as that version's version number begins with "
4196 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4197 "&good-perl;* version of <literal>perl</literal> is available and the "
4198 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4202 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4203 #: apt_preferences.5.xml:381
4205 "A version of any package other than <literal>perl</literal> that is "
4206 "available from the local system has priority over other versions, even "
4207 "versions belonging to the target release."
4210 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4211 #: apt_preferences.5.xml:385
4213 "A version of a package whose origin is not the local system but some other "
4214 "site listed in &sources-list; and which belongs to an "
4215 "<literal>unstable</literal> distribution is only installed if it is selected "
4216 "for installation and no version of the package is already installed."
4219 #. type: Content of: <refentry><refsect1><refsect2><title>
4220 #: apt_preferences.5.xml:395
4221 msgid "Determination of Package Version and Distribution Properties"
4224 #. type: Content of: <refentry><refsect1><refsect2><para>
4225 #: apt_preferences.5.xml:397
4227 "The locations listed in the &sources-list; file should provide "
4228 "<filename>Packages</filename> and <filename>Release</filename> files to "
4229 "describe the packages available at that location."
4232 #. type: Content of: <refentry><refsect1><refsect2><para>
4233 #: apt_preferences.5.xml:401
4235 "The <filename>Packages</filename> file is normally found in the directory "
4236 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4238 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4239 "consists of a series of multi-line records, one for each package available "
4240 "in that directory. Only two lines in each record are relevant for setting "
4244 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4245 #: apt_preferences.5.xml:409
4246 msgid "the <literal>Package:</literal> line"
4249 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4250 #: apt_preferences.5.xml:410
4251 msgid "gives the package name"
4254 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4255 #: apt_preferences.5.xml:413 apt_preferences.5.xml:463
4256 msgid "the <literal>Version:</literal> line"
4259 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4260 #: apt_preferences.5.xml:414
4261 msgid "gives the version number for the named package"
4264 #. type: Content of: <refentry><refsect1><refsect2><para>
4265 #: apt_preferences.5.xml:419
4267 "The <filename>Release</filename> file is normally found in the directory "
4268 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4269 "example, <filename>.../dists/stable/Release</filename>, or "
4270 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4271 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4272 "packages in the directory tree below its parent. Unlike the "
4273 "<filename>Packages</filename> file, nearly all of the lines in a "
4274 "<filename>Release</filename> file are relevant for setting APT priorities:"
4277 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4278 #: apt_preferences.5.xml:430
4279 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4282 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4283 #: apt_preferences.5.xml:431
4285 "names the archive to which all the packages in the directory tree belong. "
4286 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4287 "that all of the packages in the directory tree below the parent of the "
4288 "<filename>Release</filename> file are in a <literal>stable</literal> "
4289 "archive. Specifying this value in the APT preferences file would require "
4293 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4294 #: apt_preferences.5.xml:441
4296 msgid "Pin: release a=stable\n"
4299 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4300 #: apt_preferences.5.xml:447
4301 msgid "the <literal>Codename:</literal> line"
4304 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4305 #: apt_preferences.5.xml:448
4307 "names the codename to which all the packages in the directory tree belong. "
4308 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4309 "the packages in the directory tree below the parent of the "
4310 "<filename>Release</filename> file belong to a version named "
4311 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4312 "preferences file would require the line:"
4315 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4316 #: apt_preferences.5.xml:457
4318 msgid "Pin: release n=&testing-codename;\n"
4321 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4322 #: apt_preferences.5.xml:464
4324 "names the release version. For example, the packages in the tree might "
4325 "belong to Debian release version &stable-version;. Note that there is "
4326 "normally no version number for the <literal>testing</literal> and "
4327 "<literal>unstable</literal> distributions because they have not been "
4328 "released yet. Specifying this in the APT preferences file would require one "
4329 "of the following lines."
4332 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4333 #: apt_preferences.5.xml:473
4336 "Pin: release v=&stable-version;\n"
4337 "Pin: release a=stable, v=&stable-version;\n"
4338 "Pin: release &stable-version;\n"
4341 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4342 #: apt_preferences.5.xml:482
4343 msgid "the <literal>Component:</literal> line"
4346 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4347 #: apt_preferences.5.xml:483
4349 "names the licensing component associated with the packages in the directory "
4350 "tree of the <filename>Release</filename> file. For example, the line "
4351 "\"Component: main\" specifies that all the packages in the directory tree "
4352 "are from the <literal>main</literal> component, which entails that they are "
4353 "licensed under terms listed in the Debian Free Software Guidelines. "
4354 "Specifying this component in the APT preferences file would require the "
4358 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4359 #: apt_preferences.5.xml:492
4361 msgid "Pin: release c=main\n"
4364 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4365 #: apt_preferences.5.xml:498
4366 msgid "the <literal>Origin:</literal> line"
4369 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4370 #: apt_preferences.5.xml:499
4372 "names the originator of the packages in the directory tree of the "
4373 "<filename>Release</filename> file. Most commonly, this is "
4374 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4375 "file would require the line:"
4378 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4379 #: apt_preferences.5.xml:505
4381 msgid "Pin: release o=Debian\n"
4384 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4385 #: apt_preferences.5.xml:511
4386 msgid "the <literal>Label:</literal> line"
4389 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4390 #: apt_preferences.5.xml:512
4392 "names the label of the packages in the directory tree of the "
4393 "<filename>Release</filename> file. Most commonly, this is "
4394 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4395 "file would require the line:"
4398 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4399 #: apt_preferences.5.xml:518
4401 msgid "Pin: release l=Debian\n"
4404 #. type: Content of: <refentry><refsect1><refsect2><para>
4405 #: apt_preferences.5.xml:525
4407 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4408 "files retrieved from locations listed in the &sources-list; file are stored "
4409 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4410 "named by the variable <literal>Dir::State::Lists</literal> in the "
4411 "<filename>apt.conf</filename> file. For example, the file "
4412 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4413 "contains the <filename>Release</filename> file retrieved from the site "
4414 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4415 "architecture files from the <literal>contrib</literal> component of the "
4416 "<literal>unstable</literal> distribution."
4419 #. type: Content of: <refentry><refsect1><refsect2><title>
4420 #: apt_preferences.5.xml:538
4421 msgid "Optional Lines in an APT Preferences Record"
4424 #. type: Content of: <refentry><refsect1><refsect2><para>
4425 #: apt_preferences.5.xml:540
4427 "Each record in the APT preferences file can optionally begin with one or "
4428 "more lines beginning with the word <literal>Explanation:</literal>. This "
4429 "provides a place for comments."
4432 #. type: Content of: <refentry><refsect1><refsect2><title>
4433 #: apt_preferences.5.xml:549
4434 msgid "Tracking Stable"
4437 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4438 #: apt_preferences.5.xml:557
4441 "Explanation: Uninstall or do not install any Debian-originated\n"
4442 "Explanation: package versions other than those in the stable distro\n"
4444 "Pin: release a=stable\n"
4445 "Pin-Priority: 900\n"
4448 "Pin: release o=Debian\n"
4449 "Pin-Priority: -10\n"
4452 #. type: Content of: <refentry><refsect1><refsect2><para>
4453 #: apt_preferences.5.xml:551
4455 "The following APT preferences file will cause APT to assign a priority "
4456 "higher than the default (500) to all package versions belonging to a "
4457 "<literal>stable</literal> distribution and a prohibitively low priority to "
4458 "package versions belonging to other <literal>Debian</literal> "
4459 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4462 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4463 #: apt_preferences.5.xml:574 apt_preferences.5.xml:620 apt_preferences.5.xml:678
4466 "apt-get install <replaceable>package-name</replaceable>\n"
4468 "apt-get dist-upgrade\n"
4471 #. type: Content of: <refentry><refsect1><refsect2><para>
4472 #: apt_preferences.5.xml:569
4474 "With a suitable &sources-list; file and the above preferences file, any of "
4475 "the following commands will cause APT to upgrade to the latest "
4476 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4480 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4481 #: apt_preferences.5.xml:586
4483 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4486 #. type: Content of: <refentry><refsect1><refsect2><para>
4487 #: apt_preferences.5.xml:580
4489 "The following command will cause APT to upgrade the specified package to the "
4490 "latest version from the <literal>testing</literal> distribution; the package "
4491 "will not be upgraded again unless this command is given again. <placeholder "
4492 "type=\"programlisting\" id=\"0\"/>"
4495 #. type: Content of: <refentry><refsect1><refsect2><title>
4496 #: apt_preferences.5.xml:592
4497 msgid "Tracking Testing or Unstable"
4500 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4501 #: apt_preferences.5.xml:601
4505 "Pin: release a=testing\n"
4506 "Pin-Priority: 900\n"
4509 "Pin: release a=unstable\n"
4510 "Pin-Priority: 800\n"
4513 "Pin: release o=Debian\n"
4514 "Pin-Priority: -10\n"
4517 #. type: Content of: <refentry><refsect1><refsect2><para>
4518 #: apt_preferences.5.xml:594
4520 "The following APT preferences file will cause APT to assign a high priority "
4521 "to package versions from the <literal>testing</literal> distribution, a "
4522 "lower priority to package versions from the <literal>unstable</literal> "
4523 "distribution, and a prohibitively low priority to package versions from "
4524 "other <literal>Debian</literal> distributions. <placeholder "
4525 "type=\"programlisting\" id=\"0\"/>"
4528 #. type: Content of: <refentry><refsect1><refsect2><para>
4529 #: apt_preferences.5.xml:615
4531 "With a suitable &sources-list; file and the above preferences file, any of "
4532 "the following commands will cause APT to upgrade to the latest "
4533 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4537 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4538 #: apt_preferences.5.xml:635
4540 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4543 #. type: Content of: <refentry><refsect1><refsect2><para>
4544 #: apt_preferences.5.xml:626
4546 "The following command will cause APT to upgrade the specified package to the "
4547 "latest version from the <literal>unstable</literal> distribution. "
4548 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4549 "the most recent <literal>testing</literal> version if that is more recent "
4550 "than the installed version, otherwise, to the most recent "
4551 "<literal>unstable</literal> version if that is more recent than the "
4552 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4555 #. type: Content of: <refentry><refsect1><refsect2><title>
4556 #: apt_preferences.5.xml:642
4557 msgid "Tracking the evolution of a codename release"
4560 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4561 #: apt_preferences.5.xml:656
4564 "Explanation: Uninstall or do not install any Debian-originated package "
4566 "Explanation: other than those in the distribution codenamed with "
4567 "&testing-codename; or sid\n"
4569 "Pin: release n=&testing-codename;\n"
4570 "Pin-Priority: 900\n"
4572 "Explanation: Debian unstable is always codenamed with sid\n"
4574 "Pin: release n=sid\n"
4575 "Pin-Priority: 800\n"
4578 "Pin: release o=Debian\n"
4579 "Pin-Priority: -10\n"
4582 #. type: Content of: <refentry><refsect1><refsect2><para>
4583 #: apt_preferences.5.xml:644
4585 "The following APT preferences file will cause APT to assign a priority "
4586 "higher than the default (500) to all package versions belonging to a "
4587 "specified codename of a distribution and a prohibitively low priority to "
4588 "package versions belonging to other <literal>Debian</literal> distributions, "
4589 "codenames and archives. Note that with this APT preference APT will follow "
4590 "the migration of a release from the archive <literal>testing</literal> to "
4591 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
4592 "want to follow for example the progress in <literal>testing</literal> "
4593 "notwithstanding the codename changes you should use the example "
4594 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
4597 #. type: Content of: <refentry><refsect1><refsect2><para>
4598 #: apt_preferences.5.xml:673
4600 "With a suitable &sources-list; file and the above preferences file, any of "
4601 "the following commands will cause APT to upgrade to the latest version(s) in "
4602 "the release codenamed with <literal>&testing-codename;</literal>. "
4603 "<placeholder type=\"programlisting\" id=\"0\"/>"
4606 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4607 #: apt_preferences.5.xml:693
4609 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
4612 #. type: Content of: <refentry><refsect1><refsect2><para>
4613 #: apt_preferences.5.xml:684
4615 "The following command will cause APT to upgrade the specified package to the "
4616 "latest version from the <literal>sid</literal> distribution. Thereafter, "
4617 "<command>apt-get upgrade</command> will upgrade the package to the most "
4618 "recent <literal>&testing-codename;</literal> version if that is more recent "
4619 "than the installed version, otherwise, to the most recent "
4620 "<literal>sid</literal> version if that is more recent than the installed "
4621 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
4624 #. type: Content of: <refentry><refsect1><para>
4625 #: apt_preferences.5.xml:708
4626 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
4629 #. type: Content of: <refentry><refnamediv><refpurpose>
4630 #: sources.list.5.xml:35
4631 msgid "List of configured APT data sources"
4634 #. type: Content of: <refentry><refsect1><para>
4635 #: sources.list.5.xml:40
4637 "The source list <filename>/etc/apt/sources.list</filename> is designed to "
4638 "support any number of active sources and a variety of source media. The file "
4639 "lists one source per line, with the most preferred source listed first. The "
4640 "information available from the configured sources is acquired by "
4641 "<command>apt-get update</command> (or by an equivalent command from another "
4645 #. type: Content of: <refentry><refsect1><para>
4646 #: sources.list.5.xml:47
4648 "Each line specifying a source starts with type "
4649 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
4650 "this type. Individual entries cannot be continued onto a following "
4651 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
4652 "on a line marks the remainder of that line as a comment."
4655 #. type: Content of: <refentry><refsect1><title>
4656 #: sources.list.5.xml:55
4657 msgid "sources.list.d"
4660 #. type: Content of: <refentry><refsect1><para>
4661 #: sources.list.5.xml:56
4663 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
4664 "add sources.list entries in separate files. The format is the same as for "
4665 "the regular <filename>sources.list</filename> file. File names need to end "
4666 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
4667 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
4668 "Otherwise APT will print a notice that it has ignored a file, unless that "
4669 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4670 "configuration list - in which case it will be silently ignored."
4673 #. type: Content of: <refentry><refsect1><title>
4674 #: sources.list.5.xml:67
4675 msgid "The deb and deb-src types"
4678 #. type: Content of: <refentry><refsect1><para>
4679 #: sources.list.5.xml:68
4681 "The <literal>deb</literal> type references a typical two-level Debian "
4682 "archive, <filename>distribution/component</filename>. The "
4683 "<literal>distribution</literal> is generally an archive name like "
4684 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
4685 "<literal>&stable-codename;</literal> or "
4686 "<literal>&testing-codename;</literal> while component is one of "
4687 "<literal>main</literal>, <literal>contrib</literal> or "
4688 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
4689 "a Debian distribution's source code in the same form as the "
4690 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
4691 "to fetch source indexes."
4694 #. type: Content of: <refentry><refsect1><para>
4695 #: sources.list.5.xml:79
4697 "The format for a <filename>sources.list</filename> entry using the "
4698 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
4701 #. type: Content of: <refentry><refsect1><literallayout>
4702 #: sources.list.5.xml:82
4704 msgid "deb [ options ] uri suite [component1] [component2] [...]"
4707 #. type: Content of: <refentry><refsect1><para><literallayout>
4708 #: sources.list.5.xml:86
4711 " Types: deb deb-src\n"
4712 " URIs: http://example.com\n"
4713 " Suites: stable testing\n"
4714 " Sections: component1 component2\n"
4715 " Description: short\n"
4717 " [option1]: [option1-value]\n"
4720 " URIs: http://another.example.com\n"
4721 " Suites: experimental\n"
4722 " Sections: component1 component2\n"
4724 " Description: short\n"
4726 " [option1]: [option1-value]\n"
4730 #. type: Content of: <refentry><refsect1><para>
4731 #: sources.list.5.xml:84
4733 "Alternatively a rfc822 style format is also supported: <placeholder "
4734 "type=\"literallayout\" id=\"0\"/>"
4737 #. type: Content of: <refentry><refsect1><para>
4738 #: sources.list.5.xml:105
4740 "The URI for the <literal>deb</literal> type must specify the base of the "
4741 "Debian distribution, from which APT will find the information it needs. "
4742 "<literal>suite</literal> can specify an exact path, in which case the "
4743 "components must be omitted and <literal>suite</literal> must end with a "
4744 "slash (<literal>/</literal>). This is useful for the case when only a "
4745 "particular sub-section of the archive denoted by the URI is of interest. If "
4746 "<literal>suite</literal> does not specify an exact path, at least one "
4747 "<literal>component</literal> must be present."
4750 #. type: Content of: <refentry><refsect1><para>
4751 #: sources.list.5.xml:114
4753 "<literal>suite</literal> may also contain a variable, "
4754 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
4755 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
4756 "system. This permits architecture-independent "
4757 "<filename>sources.list</filename> files to be used. In general this is only "
4758 "of interest when specifying an exact path, <literal>APT</literal> will "
4759 "automatically generate a URI with the current architecture otherwise."
4762 #. type: Content of: <refentry><refsect1><para>
4763 #: sources.list.5.xml:122
4765 "In the traditional style sources.list format since only one distribution can "
4766 "be specified per line it may be necessary to have multiple lines for the "
4767 "same URI, if a subset of all available distributions or components at that "
4768 "location is desired. APT will sort the URI list after it has generated a "
4769 "complete set internally, and will collapse multiple references to the same "
4770 "Internet host, for instance, into a single connection, so that it does not "
4771 "inefficiently establish an FTP connection, close it, do something else, and "
4772 "then re-establish a connection to that same host. This feature is useful for "
4773 "accessing busy FTP sites with limits on the number of simultaneous anonymous "
4774 "users. APT also parallelizes connections to different hosts to more "
4775 "effectively deal with sites with low bandwidth."
4778 #. type: Content of: <refentry><refsect1><para>
4779 #: sources.list.5.xml:136
4781 "<literal>options</literal> is always optional and needs to be surrounded by "
4782 "square brackets. It can consist of multiple settings in the form "
4783 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
4784 "Multiple settings are separated by spaces. The following settings are "
4785 "supported by APT (note however that unsupported settings will be ignored "
4789 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4790 #: sources.list.5.xml:142
4792 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4793 "can be used to specify for which architectures information should be "
4794 "downloaded. If this option is not set all architectures defined by the "
4795 "<literal>APT::Architectures</literal> option will be downloaded."
4798 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4799 #: sources.list.5.xml:146
4801 "<literal>arch+=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4803 "<literal>arch-=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4804 "which can be used to add/remove architectures from the set which will be "
4808 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4809 #: sources.list.5.xml:149
4811 "<literal>trusted=yes</literal> can be set to indicate that packages from "
4812 "this source are always authenticated even if the "
4813 "<filename>Release</filename> file is not signed or the signature can't be "
4814 "checked. This disables parts of &apt-secure; and should therefore only be "
4815 "used in a local and trusted context. <literal>trusted=no</literal> is the "
4816 "opposite which handles even correctly authenticated sources as not "
4820 #. type: Content of: <refentry><refsect1><para>
4821 #: sources.list.5.xml:156
4823 "It is important to list sources in order of preference, with the most "
4824 "preferred source listed first. Typically this will result in sorting by "
4825 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
4826 "followed by distant Internet hosts, for example)."
4829 #. type: Content of: <refentry><refsect1><para>
4830 #: sources.list.5.xml:161
4831 msgid "Some examples:"
4834 #. type: Content of: <refentry><refsect1><literallayout>
4835 #: sources.list.5.xml:163
4838 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
4839 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
4844 #. type: Content of: <refentry><refsect1><title>
4845 #: sources.list.5.xml:169
4846 msgid "URI specification"
4849 #. type: Content of: <refentry><refsect1><para>
4850 #: sources.list.5.xml:171
4851 msgid "The currently recognized URI types are:"
4854 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4855 #: sources.list.5.xml:175
4857 "The file scheme allows an arbitrary directory in the file system to be "
4858 "considered an archive. This is useful for NFS mounts and local mirrors or "
4862 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4863 #: sources.list.5.xml:182
4865 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
4866 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
4870 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4871 #: sources.list.5.xml:189
4873 "The http scheme specifies an HTTP server for the archive. If an environment "
4874 "variable <envar>http_proxy</envar> is set with the format "
4875 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
4876 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
4877 "the format http://user:pass@server:port/. Note that this is an insecure "
4878 "method of authentication."
4881 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4882 #: sources.list.5.xml:200
4884 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
4885 "is highly configurable; for more information see the &apt-conf; manual "
4886 "page. Please note that an FTP proxy can be specified by using the "
4887 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
4888 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
4889 "environment variable and <emphasis>only</emphasis> this environment "
4890 "variable. Proxies using HTTP specified in the configuration file will be "
4894 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4895 #: sources.list.5.xml:212
4897 "The copy scheme is identical to the file scheme except that packages are "
4898 "copied into the cache directory instead of used directly at their location. "
4899 "This is useful for people using removable media to copy files around with "
4903 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4904 #: sources.list.5.xml:219
4906 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
4907 "the files as a given user. Prior configuration of rhosts or RSA keys is "
4908 "recommended. The standard <command>find</command> and <command>dd</command> "
4909 "commands are used to perform the file transfers from the remote host."
4912 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4913 #: sources.list.5.xml:226
4914 msgid "adding more recognizable URI types"
4917 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4918 #: sources.list.5.xml:228
4920 "APT can be extended with more methods shipped in other optional packages, "
4921 "which should follow the naming scheme "
4922 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
4923 "instance, the APT team also maintains the package "
4924 "<package>apt-transport-https</package>, which provides access methods for "
4925 "HTTPS URIs with features similar to the http method. Methods for using "
4926 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
4929 #. type: Content of: <refentry><refsect1><para>
4930 #: sources.list.5.xml:240
4932 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
4933 "stable/main, stable/contrib, and stable/non-free."
4936 #. type: Content of: <refentry><refsect1><literallayout>
4937 #: sources.list.5.xml:242
4939 msgid "deb file:/home/jason/debian stable main contrib non-free"
4942 #. type: Content of: <refentry><refsect1><para>
4943 #: sources.list.5.xml:244
4944 msgid "As above, except this uses the unstable (development) distribution."
4947 #. type: Content of: <refentry><refsect1><literallayout>
4948 #: sources.list.5.xml:245
4950 msgid "deb file:/home/jason/debian unstable main contrib non-free"
4953 #. type: Content of: <refentry><refsect1><para>
4954 #: sources.list.5.xml:247
4955 msgid "Source line for the above"
4958 #. type: Content of: <refentry><refsect1><literallayout>
4959 #: sources.list.5.xml:248
4961 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
4964 #. type: Content of: <refentry><refsect1><para>
4965 #: sources.list.5.xml:250
4967 "The first line gets package information for the architectures in "
4968 "<literal>APT::Architectures</literal> while the second always retrieves "
4969 "<literal>amd64</literal> and <literal>armel</literal>."
4972 #. type: Content of: <refentry><refsect1><literallayout>
4973 #: sources.list.5.xml:252
4976 "deb http://ftp.debian.org/debian &stable-codename; main\n"
4977 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
4980 #. type: Content of: <refentry><refsect1><para>
4981 #: sources.list.5.xml:255
4983 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
4987 #. type: Content of: <refentry><refsect1><literallayout>
4988 #: sources.list.5.xml:257
4990 msgid "deb http://archive.debian.org/debian-archive hamm main"
4993 #. type: Content of: <refentry><refsect1><para>
4994 #: sources.list.5.xml:259
4996 "Uses FTP to access the archive at ftp.debian.org, under the debian "
4997 "directory, and uses only the &stable-codename;/contrib area."
5000 #. type: Content of: <refentry><refsect1><literallayout>
5001 #: sources.list.5.xml:261
5003 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5006 #. type: Content of: <refentry><refsect1><para>
5007 #: sources.list.5.xml:263
5009 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5010 "directory, and uses only the unstable/contrib area. If this line appears as "
5011 "well as the one in the previous example in <filename>sources.list</filename> "
5012 "a single FTP session will be used for both resource lines."
5015 #. type: Content of: <refentry><refsect1><literallayout>
5016 #: sources.list.5.xml:267
5018 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5021 #. type: Content of: <refentry><refsect1><para><literallayout>
5022 #: sources.list.5.xml:276
5024 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5027 #. type: Content of: <refentry><refsect1><para>
5028 #: sources.list.5.xml:269
5030 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5031 "directory, and uses only files found under "
5032 "<filename>unstable/binary-i386</filename> on i386 machines, "
5033 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5034 "supported architectures. [Note this example only illustrates how to use the "
5035 "substitution variable; official debian archives are not structured like "
5036 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5039 #. type: Content of: <refentry><refsect1><para>
5040 #: sources.list.5.xml:281
5041 msgid "&apt-cache; &apt-conf;"
5044 #. type: Content of: <refentry><refmeta><manvolnum>
5045 #: apt-extracttemplates.1.xml:28 apt-sortpkgs.1.xml:28 apt-ftparchive.1.xml:28
5049 #. type: Content of: <refentry><refnamediv><refpurpose>
5050 #: apt-extracttemplates.1.xml:35
5052 "Utility to extract <command>debconf</command> config and templates from "
5056 #. type: Content of: <refentry><refsect1><para>
5057 #: apt-extracttemplates.1.xml:41
5059 "<command>apt-extracttemplates</command> will take one or more Debian package "
5060 "files as input and write out (to a temporary directory) all associated "
5061 "config scripts and template files. For each passed in package that contains "
5062 "config scripts and templates, one line of output will be generated in the "
5066 #. type: Content of: <refentry><refsect1><para>
5067 #: apt-extracttemplates.1.xml:46
5068 msgid "package version template-file config-script"
5071 #. type: Content of: <refentry><refsect1><para>
5072 #: apt-extracttemplates.1.xml:47
5074 "template-file and config-script are written to the temporary directory "
5075 "specified by the <option>-t</option> or <option>--tempdir</option> "
5076 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5077 "filenames of the form <filename>package.template.XXXX</filename> and "
5078 "<filename>package.config.XXXX</filename>"
5081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5082 #: apt-extracttemplates.1.xml:60
5084 "Temporary directory in which to write extracted <command>debconf</command> "
5085 "template files and config scripts. Configuration Item: "
5086 "<literal>APT::ExtractTemplates::TempDir</literal>"
5089 #. type: Content of: <refentry><refsect1><para>
5090 #: apt-extracttemplates.1.xml:77
5092 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5093 "decimal 100 on error."
5096 #. type: Content of: <refentry><refnamediv><refpurpose>
5097 #: apt-sortpkgs.1.xml:35
5098 msgid "Utility to sort package index files"
5101 #. type: Content of: <refentry><refsect1><para>
5102 #: apt-sortpkgs.1.xml:41
5104 "<command>apt-sortpkgs</command> will take an index file (source index or "
5105 "package index) and sort the records so that they are ordered by the package "
5106 "name. It will also sort the internal fields of each record according to the "
5107 "internal sorting rules."
5110 #. type: Content of: <refentry><refsect1><para>
5111 #: apt-sortpkgs.1.xml:47
5112 msgid "All output is sent to standard output; the input must be a seekable file."
5115 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5116 #: apt-sortpkgs.1.xml:56
5118 "Use source index field ordering. Configuration Item: "
5119 "<literal>APT::SortPkgs::Source</literal>."
5122 #. type: Content of: <refentry><refsect1><para>
5123 #: apt-sortpkgs.1.xml:70
5125 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5129 #. type: Content of: <refentry><refnamediv><refpurpose>
5130 #: apt-ftparchive.1.xml:35
5131 msgid "Utility to generate index files"
5134 #. type: Content of: <refentry><refsect1><para>
5135 #: apt-ftparchive.1.xml:41
5137 "<command>apt-ftparchive</command> is the command line tool that generates "
5138 "the index files that APT uses to access a distribution source. The index "
5139 "files should be generated on the origin site based on the content of that "
5143 #. type: Content of: <refentry><refsect1><para>
5144 #: apt-ftparchive.1.xml:45
5146 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5147 "program, incorporating its entire functionality via the "
5148 "<literal>packages</literal> command. It also contains a contents file "
5149 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5150 "the generation process for a complete archive."
5153 #. type: Content of: <refentry><refsect1><para>
5154 #: apt-ftparchive.1.xml:51
5156 "Internally <command>apt-ftparchive</command> can make use of binary "
5157 "databases to cache the contents of a .deb file and it does not rely on any "
5158 "external programs aside from &gzip;. When doing a full generate it "
5159 "automatically performs file-change checks and builds the desired compressed "
5163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5164 #: apt-ftparchive.1.xml:62
5166 "The packages command generates a package file from a directory tree. It "
5167 "takes the given directory and recursively searches it for .deb files, "
5168 "emitting a package record to stdout for each. This command is approximately "
5169 "equivalent to &dpkg-scanpackages;."
5172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5173 #: apt-ftparchive.1.xml:67 apt-ftparchive.1.xml:91
5174 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5178 #: apt-ftparchive.1.xml:72
5180 "The <literal>sources</literal> command generates a source index file from a "
5181 "directory tree. It takes the given directory and recursively searches it "
5182 "for .dsc files, emitting a source record to stdout for each. This command is "
5183 "approximately equivalent to &dpkg-scansources;."
5186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5187 #: apt-ftparchive.1.xml:77
5189 "If an override file is specified then a source override file will be looked "
5190 "for with an extension of .src. The --source-override option can be used to "
5191 "change the source override file that will be used."
5194 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5195 #: apt-ftparchive.1.xml:84
5197 "The <literal>contents</literal> command generates a contents file from a "
5198 "directory tree. It takes the given directory and recursively searches it for "
5199 ".deb files, and reads the file list from each file. It then sorts and writes "
5200 "to stdout the list of files matched to packages. Directories are not written "
5201 "to the output. If multiple packages own the same file then each package is "
5202 "separated by a comma in the output."
5205 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5206 #: apt-ftparchive.1.xml:96
5208 "The <literal>release</literal> command generates a Release file from a "
5209 "directory tree. It recursively searches the given directory for uncompressed "
5210 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5211 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5212 "<command>lzma</command> as well as <filename>Release</filename> and "
5213 "<filename>md5sum.txt</filename> files by default "
5214 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5215 "filename patterns can be added by listing them in "
5216 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5217 "stdout a <filename>Release</filename> file containing an MD5, SHA1 and "
5218 "SHA256 digest for each file."
5221 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5222 #: apt-ftparchive.1.xml:106
5224 "Values for the additional metadata fields in the Release file are taken from "
5225 "the corresponding variables under "
5226 "<literal>APT::FTPArchive::Release</literal>, "
5227 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5228 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5229 "<literal>Suite</literal>, <literal>Version</literal>, "
5230 "<literal>Codename</literal>, <literal>Date</literal>, "
5231 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5232 "<literal>Components</literal>, <literal>Description</literal>."
5235 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5236 #: apt-ftparchive.1.xml:119
5238 "The <literal>generate</literal> command is designed to be runnable from a "
5239 "cron script and builds indexes according to the given config file. The "
5240 "config language provides a flexible means of specifying which index files "
5241 "are built from which directories, as well as providing a simple means of "
5242 "maintaining the required settings."
5245 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5246 #: apt-ftparchive.1.xml:128
5248 "The <literal>clean</literal> command tidies the databases used by the given "
5249 "configuration file by removing any records that are no longer necessary."
5252 #. type: Content of: <refentry><refsect1><title>
5253 #: apt-ftparchive.1.xml:134
5254 msgid "The Generate Configuration"
5257 #. type: Content of: <refentry><refsect1><para>
5258 #: apt-ftparchive.1.xml:136
5260 "The <literal>generate</literal> command uses a configuration file to "
5261 "describe the archives that are going to be generated. It follows the typical "
5262 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5263 "&apt-conf; contains a description of the syntax. Note that the generate "
5264 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5265 "tree manner. This only effects how the scope tag is handled."
5268 #. type: Content of: <refentry><refsect1><para>
5269 #: apt-ftparchive.1.xml:144
5270 msgid "The generate configuration has four separate sections, each described below."
5273 #. type: Content of: <refentry><refsect1><refsect2><title>
5274 #: apt-ftparchive.1.xml:146
5275 msgid "<literal>Dir</literal> Section"
5278 #. type: Content of: <refentry><refsect1><refsect2><para>
5279 #: apt-ftparchive.1.xml:148
5281 "The <literal>Dir</literal> section defines the standard directories needed "
5282 "to locate the files required during the generation process. These "
5283 "directories are prepended certain relative paths defined in later sections "
5284 "to produce a complete an absolute path."
5287 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5288 #: apt-ftparchive.1.xml:155
5290 "Specifies the root of the FTP archive, in a standard Debian configuration "
5291 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5295 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5296 #: apt-ftparchive.1.xml:162
5297 msgid "Specifies the location of the override files."
5300 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5301 #: apt-ftparchive.1.xml:167
5302 msgid "Specifies the location of the cache files."
5305 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5306 #: apt-ftparchive.1.xml:172
5308 "Specifies the location of the file list files, if the "
5309 "<literal>FileList</literal> setting is used below."
5312 #. type: Content of: <refentry><refsect1><refsect2><title>
5313 #: apt-ftparchive.1.xml:178
5314 msgid "<literal>Default</literal> Section"
5317 #. type: Content of: <refentry><refsect1><refsect2><para>
5318 #: apt-ftparchive.1.xml:180
5320 "The <literal>Default</literal> section specifies default values, and "
5321 "settings that control the operation of the generator. Other sections may "
5322 "override these defaults with a per-section setting."
5325 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5326 #: apt-ftparchive.1.xml:186
5328 "Sets the default compression schemes to use for the package index files. It "
5329 "is a string that contains a space separated list of at least one of: '.' (no "
5330 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
5334 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5335 #: apt-ftparchive.1.xml:194
5337 "Sets the default list of file extensions that are package files. This "
5338 "defaults to '.deb'."
5341 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5342 #: apt-ftparchive.1.xml:200
5344 "This is similar to <literal>Packages::Compress</literal> except that it "
5345 "controls the compression for the Sources files."
5348 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5349 #: apt-ftparchive.1.xml:206
5351 "Sets the default list of file extensions that are source files. This "
5352 "defaults to '.dsc'."
5355 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5356 #: apt-ftparchive.1.xml:212
5358 "This is similar to <literal>Packages::Compress</literal> except that it "
5359 "controls the compression for the Contents files."
5362 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5363 #: apt-ftparchive.1.xml:218
5365 "This is similar to <literal>Packages::Compress</literal> except that it "
5366 "controls the compression for the Translation-en master file."
5369 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5370 #: apt-ftparchive.1.xml:224
5372 "Specifies the number of kilobytes to delink (and replace with hard links) "
5373 "per run. This is used in conjunction with the per-section "
5374 "<literal>External-Links</literal> setting."
5377 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5378 #: apt-ftparchive.1.xml:231
5380 "Specifies the mode of all created index files. It defaults to 0644. All "
5381 "index files are set to this mode with no regard to the umask."
5384 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5385 #: apt-ftparchive.1.xml:238 apt-ftparchive.1.xml:384
5387 "Specifies whether long descriptions should be included in the "
5388 "<filename>Packages</filename> file or split out into a master "
5389 "<filename>Translation-en</filename> file."
5392 #. type: Content of: <refentry><refsect1><refsect2><title>
5393 #: apt-ftparchive.1.xml:244
5394 msgid "<literal>TreeDefault</literal> Section"
5397 #. type: Content of: <refentry><refsect1><refsect2><para>
5398 #: apt-ftparchive.1.xml:246
5400 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
5401 "variables are substitution variables and have the strings $(DIST), "
5402 "$(SECTION) and $(ARCH) replaced with their respective values."
5405 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5406 #: apt-ftparchive.1.xml:253
5408 "Sets the number of kilobytes of contents files that are generated each "
5409 "day. The contents files are round-robined so that over several days they "
5410 "will all be rebuilt."
5413 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5414 #: apt-ftparchive.1.xml:260
5416 "Controls the number of days a contents file is allowed to be checked without "
5417 "changing. If this limit is passed the mtime of the contents file is "
5418 "updated. This case can occur if the package file is changed in such a way "
5419 "that does not result in a new contents file [override edit for instance]. A "
5420 "hold off is allowed in hopes that new .debs will be installed, requiring a "
5421 "new file anyhow. The default is 10, the units are in days."
5424 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5425 #: apt-ftparchive.1.xml:271
5427 "Sets the top of the .deb directory tree. Defaults to "
5428 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
5431 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5432 #: apt-ftparchive.1.xml:277
5434 "Sets the top of the source package directory tree. Defaults to "
5435 "<filename>$(DIST)/$(SECTION)/source/</filename>"
5438 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5439 #: apt-ftparchive.1.xml:283
5441 "Sets the output Packages file. Defaults to "
5442 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
5445 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5446 #: apt-ftparchive.1.xml:289
5448 "Sets the output Sources file. Defaults to "
5449 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
5452 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5453 #: apt-ftparchive.1.xml:295
5455 "Sets the output Translation-en master file with the long descriptions if "
5456 "they should be not included in the Packages file. Defaults to "
5457 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
5460 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5461 #: apt-ftparchive.1.xml:302
5463 "Sets the path prefix that causes a symlink to be considered an internal link "
5464 "instead of an external link. Defaults to "
5465 "<filename>$(DIST)/$(SECTION)/</filename>"
5468 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5469 #: apt-ftparchive.1.xml:309
5471 "Sets the output Contents file. Defaults to "
5472 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
5473 "causes multiple Packages files to map onto a single Contents file (as is the "
5474 "default) then <command>apt-ftparchive</command> will integrate those "
5475 "package files together automatically."
5478 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5479 #: apt-ftparchive.1.xml:318
5480 msgid "Sets header file to prepend to the contents output."
5483 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5484 #: apt-ftparchive.1.xml:323
5486 "Sets the binary cache database to use for this section. Multiple sections "
5487 "can share the same database."
5490 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5491 #: apt-ftparchive.1.xml:329
5493 "Specifies that instead of walking the directory tree, "
5494 "<command>apt-ftparchive</command> should read the list of files from the "
5495 "given file. Relative files names are prefixed with the archive directory."
5498 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5499 #: apt-ftparchive.1.xml:336
5501 "Specifies that instead of walking the directory tree, "
5502 "<command>apt-ftparchive</command> should read the list of files from the "
5503 "given file. Relative files names are prefixed with the archive directory. "
5504 "This is used when processing source indexes."
5507 #. type: Content of: <refentry><refsect1><refsect2><title>
5508 #: apt-ftparchive.1.xml:344
5509 msgid "<literal>Tree</literal> Section"
5512 #. type: Content of: <refentry><refsect1><refsect2><para>
5513 #: apt-ftparchive.1.xml:346
5515 "The <literal>Tree</literal> section defines a standard Debian file tree "
5516 "which consists of a base directory, then multiple sections in that base "
5517 "directory and finally multiple Architectures in each section. The exact "
5518 "pathing used is defined by the <literal>Directory</literal> substitution "
5522 #. type: Content of: <refentry><refsect1><refsect2><para>
5523 #: apt-ftparchive.1.xml:351
5525 "The <literal>Tree</literal> section takes a scope tag which sets the "
5526 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
5527 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
5528 "setting such as <filename>dists/&stable-codename;</filename>."
5531 #. type: Content of: <refentry><refsect1><refsect2><para>
5532 #: apt-ftparchive.1.xml:356
5534 "All of the settings defined in the <literal>TreeDefault</literal> section "
5535 "can be used in a <literal>Tree</literal> section as well as three new "
5539 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5540 #: apt-ftparchive.1.xml:362
5543 "for i in Sections do \n"
5544 " for j in Architectures do\n"
5545 " Generate for DIST=scope SECTION=i ARCH=j\n"
5549 #. type: Content of: <refentry><refsect1><refsect2><para>
5550 #: apt-ftparchive.1.xml:359
5552 "When processing a <literal>Tree</literal> section "
5553 "<command>apt-ftparchive</command> performs an operation similar to: "
5554 "<placeholder type=\"programlisting\" id=\"0\"/>"
5557 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5558 #: apt-ftparchive.1.xml:370
5560 "This is a space separated list of sections which appear under the "
5561 "distribution; typically this is something like <literal>main contrib "
5562 "non-free</literal>"
5565 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5566 #: apt-ftparchive.1.xml:377
5568 "This is a space separated list of all the architectures that appear under "
5569 "search section. The special architecture 'source' is used to indicate that "
5570 "this tree has a source archive."
5573 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5574 #: apt-ftparchive.1.xml:390
5576 "Sets the binary override file. The override file contains section, priority "
5577 "and maintainer address information."
5580 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5581 #: apt-ftparchive.1.xml:396
5583 "Sets the source override file. The override file contains section "
5587 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5588 #: apt-ftparchive.1.xml:402 apt-ftparchive.1.xml:448
5589 msgid "Sets the binary extra override file."
5592 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5593 #: apt-ftparchive.1.xml:407 apt-ftparchive.1.xml:453
5594 msgid "Sets the source extra override file."
5597 #. type: Content of: <refentry><refsect1><refsect2><title>
5598 #: apt-ftparchive.1.xml:412
5599 msgid "<literal>BinDirectory</literal> Section"
5602 #. type: Content of: <refentry><refsect1><refsect2><para>
5603 #: apt-ftparchive.1.xml:414
5605 "The <literal>bindirectory</literal> section defines a binary directory tree "
5606 "with no special structure. The scope tag specifies the location of the "
5607 "binary directory and the settings are similar to the <literal>Tree</literal> "
5608 "section with no substitution variables or "
5609 "<literal>Section</literal><literal>Architecture</literal> settings."
5612 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5613 #: apt-ftparchive.1.xml:422
5614 msgid "Sets the Packages file output."
5617 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5618 #: apt-ftparchive.1.xml:427
5620 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
5621 "<literal>Sources</literal> is required."
5624 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5625 #: apt-ftparchive.1.xml:433
5626 msgid "Sets the Contents file output (optional)."
5629 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5630 #: apt-ftparchive.1.xml:438
5631 msgid "Sets the binary override file."
5634 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5635 #: apt-ftparchive.1.xml:443
5636 msgid "Sets the source override file."
5639 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5640 #: apt-ftparchive.1.xml:458
5641 msgid "Sets the cache DB."
5644 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5645 #: apt-ftparchive.1.xml:463
5646 msgid "Appends a path to all the output paths."
5649 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5650 #: apt-ftparchive.1.xml:468
5651 msgid "Specifies the file list file."
5654 #. type: Content of: <refentry><refsect1><title>
5655 #: apt-ftparchive.1.xml:475
5656 msgid "The Binary Override File"
5659 #. type: Content of: <refentry><refsect1><para>
5660 #: apt-ftparchive.1.xml:476
5662 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
5663 "contains four fields separated by spaces. The first field is the package "
5664 "name, the second is the priority to force that package to, the third is the "
5665 "section to force that package to and the final field is the maintainer "
5666 "permutation field."
5669 #. type: Content of: <refentry><refsect1><para><literallayout>
5670 #: apt-ftparchive.1.xml:482
5672 msgid "old [// oldn]* => new"
5675 #. type: Content of: <refentry><refsect1><para><literallayout>
5676 #: apt-ftparchive.1.xml:484
5681 #. type: Content of: <refentry><refsect1><para>
5682 #: apt-ftparchive.1.xml:481
5684 "The general form of the maintainer field is: <placeholder "
5685 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
5686 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
5687 "separated list of old email addresses to be specified. If any of those are "
5688 "found then new is substituted for the maintainer field. The second form "
5689 "unconditionally substitutes the maintainer field."
5692 #. type: Content of: <refentry><refsect1><title>
5693 #: apt-ftparchive.1.xml:492
5694 msgid "The Source Override File"
5697 #. type: Content of: <refentry><refsect1><para>
5698 #: apt-ftparchive.1.xml:494
5700 "The source override file is fully compatible with &dpkg-scansources;. It "
5701 "contains two fields separated by spaces. The first field is the source "
5702 "package name, the second is the section to assign it."
5705 #. type: Content of: <refentry><refsect1><title>
5706 #: apt-ftparchive.1.xml:499
5707 msgid "The Extra Override File"
5710 #. type: Content of: <refentry><refsect1><para>
5711 #: apt-ftparchive.1.xml:501
5713 "The extra override file allows any arbitrary tag to be added or replaced in "
5714 "the output. It has three columns, the first is the package, the second is "
5715 "the tag and the remainder of the line is the new value."
5718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5719 #: apt-ftparchive.1.xml:512
5721 "Generate the given checksum. These options default to on, when turned off "
5722 "the generated index files will not have the checksum fields where possible. "
5723 "Configuration Items: "
5724 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
5725 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
5726 "where <literal><replaceable>Index</replaceable></literal> can be "
5727 "<literal>Packages</literal>, <literal>Sources</literal> or "
5728 "<literal>Release</literal> and "
5729 "<literal><replaceable>Checksum</replaceable></literal> can be "
5730 "<literal>MD5</literal>, <literal>SHA1</literal> or "
5731 "<literal>SHA256</literal>."
5734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5735 #: apt-ftparchive.1.xml:523
5737 "Use a binary caching DB. This has no effect on the generate command. "
5738 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
5741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5742 #: apt-ftparchive.1.xml:529
5744 "Quiet; produces output suitable for logging, omitting progress indicators. "
5745 "More q's will produce more quiet up to a maximum of 2. You can also use "
5746 "<option>-q=#</option> to set the quiet level, overriding the configuration "
5747 "file. Configuration Item: <literal>quiet</literal>."
5750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5751 #: apt-ftparchive.1.xml:537
5753 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
5754 "then this option actually enables delinking of the files. It defaults to on "
5755 "and can be turned off with <option>--no-delink</option>. Configuration "
5756 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
5759 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5760 #: apt-ftparchive.1.xml:545
5762 "Perform contents generation. When this option is set and package indexes are "
5763 "being generated with a cache DB then the file listing will also be extracted "
5764 "and stored in the DB for later use. When using the generate command this "
5765 "option also allows the creation of any Contents files. The default is on. "
5766 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
5769 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5770 #: apt-ftparchive.1.xml:555
5772 "Select the source override file to use with the <literal>sources</literal> "
5773 "command. Configuration Item: "
5774 "<literal>APT::FTPArchive::SourceOverride</literal>."
5777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5778 #: apt-ftparchive.1.xml:561
5780 "Make the caching databases read only. Configuration Item: "
5781 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
5784 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5785 #: apt-ftparchive.1.xml:566
5787 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
5788 "commands only package files matching <literal>*_arch.deb</literal> or "
5789 "<literal>*_all.deb</literal> instead of all package files in the given "
5790 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
5793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5794 #: apt-ftparchive.1.xml:574
5796 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
5797 "packages are recompiled and/or republished with the same version again, this "
5798 "will lead to problems as the now outdated cached metadata like size and "
5799 "checksums will be used. With this option enabled this will no longer happen "
5800 "as it will be checked if the file was changed. Note that this option is set "
5801 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
5802 "multiply versions/builds of a package with the same versionnumber, so in "
5803 "theory nobody will have these problems and therefore all these extra checks "
5807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5808 #: apt-ftparchive.1.xml:586
5810 "This configuration option defaults to \"<literal>true</literal>\" and should "
5811 "only be set to <literal>\"false\"</literal> if the Archive generated with "
5812 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
5813 "that the <filename>Translation-en</filename> master file can only be created "
5814 "in the generate command."
5817 #. type: Content of: <refentry><refsect1><para><programlisting>
5818 #: apt-ftparchive.1.xml:604
5821 "<command>apt-ftparchive</command> packages "
5822 "<replaceable>directory</replaceable> | <command>gzip</command> > "
5823 "<filename>Packages.gz</filename>\n"
5826 #. type: Content of: <refentry><refsect1><para>
5827 #: apt-ftparchive.1.xml:600
5829 "To create a compressed Packages file for a directory containing binary "
5830 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
5833 #. type: Content of: <refentry><refsect1><para>
5834 #: apt-ftparchive.1.xml:614
5836 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
5849 msgid "16 June 1998"
5866 msgid "apt - Advanced Package Tool"
5889 "APT is a management system for software packages. For normal day to day "
5890 "package management there are several frontends available, such as "
5891 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
5892 "System. Some options are only implemented in B<apt-get>(8) though."
5904 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
5905 "B<apt_preferences>(5), B<apt-secure>(8)"
5916 msgid "apt returns zero on normal operation, decimal 100 on error."
5927 msgid "This manpage isn't even started."
5933 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
5934 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
5935 "B<reportbug>(1) command."
5946 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
5949 #. type: <title></title>
5951 msgid "APT User's Guide"
5954 #. type: <author></author>
5955 #: guide.sgml:6 offline.sgml:6
5956 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5959 #. type: <version></version>
5961 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5964 #. type: <abstract></abstract>
5967 "This document provides an overview of how to use the the APT package "
5971 #. type: <copyrightsummary></copyrightsummary>
5973 msgid "Copyright © Jason Gunthorpe, 1998."
5977 #: guide.sgml:21 offline.sgml:22
5979 "\"APT\" and this document are free software; you can redistribute them "
5980 "and/or modify them under the terms of the GNU General Public License as "
5981 "published by the Free Software Foundation; either version 2 of the License, "
5982 "or (at your option) any later version."
5986 #: guide.sgml:24 offline.sgml:25
5988 "For more details, on Debian systems, see the file "
5989 "/usr/share/common-licenses/GPL for the full license."
5992 #. type: <heading></heading>
6000 "The APT package currently contains two sections, the APT "
6001 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
6002 "interface. Both provide a way to install and remove packages as well as "
6003 "download new packages from the Internet."
6006 #. type: <heading></heading>
6008 msgid "Anatomy of the Package System"
6014 "The Debian packaging system has a large amount of information associated "
6015 "with each package to help assure that it integrates cleanly and easily into "
6016 "the system. The most prominent of its features is the dependency system."
6022 "The dependency system allows individual programs to make use of shared "
6023 "elements in the system such as libraries. It simplifies placing infrequently "
6024 "used portions of a program in separate packages to reduce the number of "
6025 "things the average user is required to install. Also, it allows for choices "
6026 "in mail transport agents, X servers and so on."
6032 "The first step to understanding the dependency system is to grasp the "
6033 "concept of a simple dependency. The meaning of a simple dependency is that a "
6034 "package requires another package to be installed at the same time to work "
6041 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6042 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6043 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6044 "simple dependency on emacs, without emacs it is completely useless."
6050 "The other important dependency to understand is a conflicting dependency. It "
6051 "means that a package, when installed with another package, will not work and "
6052 "may possibly be extremely harmful to the system. As an example consider a "
6053 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6054 "have two mail transport agents installed because both need to listen to the "
6055 "network to receive mail. Attempting to install two will seriously damage the "
6056 "system so all mail transport agents have a conflicting dependency with all "
6057 "other mail transport agents."
6063 "As an added complication there is the possibility for a package to pretend "
6064 "to be another package. Consider that exim and sendmail for many intents are "
6065 "identical, they both deliver mail and understand a common interface. Hence, "
6066 "the package system has a way for them to declare that they are both "
6067 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6068 "a mail-transport-agent and other packages that need a mail transport agent "
6069 "depend on mail-transport-agent. This can add a great deal of confusion when "
6070 "trying to manually fix packages."
6076 "At any given time a single dependency may be met by packages that are "
6077 "already installed or it may not be. APT attempts to help resolve dependency "
6078 "issues by providing a number of automatic algorithms that help in selecting "
6079 "packages for installation."
6082 #. type: <heading></heading>
6090 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6091 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6092 "understand .deb files, it works with the package's proper name and can only "
6093 "install .deb archives from a <em>Source</em>."
6099 "The first <footnote><p>If you are using an http proxy server you must set "
6100 "the http_proxy environment variable first, see "
6101 "sources.list(5)</p></footnote> thing that should be done before using "
6102 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6103 "so that it knows what packages are available. This is done with <tt>apt-get "
6104 "update</tt>. For instance,"
6107 #. type: <example></example>
6111 "# apt-get update\n"
6112 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6113 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6114 "Reading Package Lists... Done\n"
6115 "Building Dependency Tree... Done"
6118 #. type: <p><taglist>
6120 msgid "Once updated there are several commands that can be used:"
6123 #. type: <tag></tag>
6131 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6132 "install a new package or remove an existing package, nor will it ever "
6133 "upgrade a package that might cause some other package to break. This can be "
6134 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6135 "the packages that it could not upgrade, this usually means that they depend "
6136 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6137 "<tt>apt-get install</tt> can be used to force these packages to install."
6140 #. type: <tag></tag>
6148 "Install is used to install packages by name. The package is automatically "
6149 "fetched and installed. This can be useful if you already know the name of "
6150 "the package to install and do not want to go into a GUI to select it. Any "
6151 "number of packages may be passed to install, they will all be "
6152 "fetched. Install automatically attempts to resolve dependency problems with "
6153 "the listed packages and will print a summary and ask for confirmation if "
6154 "anything other than its arguments are changed."
6157 #. type: <tag></tag>
6159 msgid "dist-upgrade"
6165 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6166 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6167 "set of packages to install, upgrade and remove to get as much of the system "
6168 "to the newest release. In some situations it may be desired to use "
6169 "dist-upgrade rather than spend the time manually resolving dependencies in "
6170 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6171 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6178 "It is important to closely look at what dist-upgrade is going to do, its "
6179 "decisions may sometimes be quite surprising."
6185 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6186 "its man page, <manref name=\"apt-get\" section=\"8\">. The most useful "
6187 "option is <tt>-d</tt> which does not install the fetched files. If the "
6188 "system has to download a large number of package it would be undesired to "
6189 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6190 "the downloaded archives can be installed by simply running the command that "
6191 "caused them to be downloaded again without <tt>-d</tt>."
6194 #. type: <heading></heading>
6202 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6203 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6204 "to select the packages to be installed or removed and APT actually installs "
6211 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6212 "and then choose the APT method. You will be prompted for a set of "
6213 "<em>Sources</em> which are places to fetch archives from. These can be "
6214 "remote Internet sites, local Debian mirrors or CD-ROMs. Each source can "
6215 "provide a fragment of the total Debian archive, APT will automatically "
6216 "combine them to form a complete set of packages. If you have a CD-ROM then "
6217 "it is a good idea to specify it first and then specify a mirror so that you "
6218 "have access to the latest bug fixes. APT will automatically use packages on "
6219 "your CD-ROM before downloading from the Internet."
6222 #. type: <example></example>
6226 " Set up a list of distribution source locations\n"
6228 " Please give the base URL of the debian distribution.\n"
6229 " The access schemes I know about are: http file\n"
6232 " file:/mnt/debian,\n"
6233 " ftp://ftp.debian.org/debian,\n"
6234 " http://ftp.de.debian.org/debian,\n"
6237 " URL [http://llug.sep.bnl.gov/debian]:"
6243 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6244 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6248 #. type: <example></example>
6252 " Please give the distribution tag to get or a path to the\n"
6253 " package file ending in a /. The distribution\n"
6254 " tags are typically something like: stable unstable testing non-US\n"
6256 " Distribution [stable]:"
6262 "The distribution refers to the Debian version in the archive, "
6263 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6264 "refers to the developmental version. <em>non-US</em> is only available on "
6265 "some mirrors and refers to packages that contain encryption technology or "
6266 "other things that cannot be exported from the United States. Importing these "
6267 "packages into the US is legal however."
6270 #. type: <example></example>
6274 " Please give the components to get\n"
6275 " The components are typically something like: main contrib non-free\n"
6277 " Components [main contrib non-free]:"
6283 "The components list refers to the list of sub distributions to fetch. The "
6284 "distribution is split up based on software licenses, main being DFSG free "
6285 "packages while contrib and non-free contain things that have various "
6286 "restrictions placed on their use and distribution."
6292 "Any number of sources can be added, the setup script will continue to prompt "
6293 "until you have specified all that you want."
6299 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6300 "available list by selecting [U]pdate from the menu. This is a superset of "
6301 "<tt>apt-get update</tt> that makes the fetched information available to "
6302 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6303 "update</tt> has been run before."
6309 "You can then go on and make your selections using [S]elect and then perform "
6310 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6311 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6318 "By default APT will automatically remove the package (.deb) files once they "
6319 "have been successfully installed. To change this behavior place "
6320 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6323 #. type: <heading></heading>
6325 msgid "The Interface"
6331 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6332 "same interface. It is a simple system that generally tells you what it will "
6333 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6334 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6335 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6336 "alone.</p></footnote> After printing out a summary of what will happen APT "
6337 "then will print out some informative status messages so that you can "
6338 "estimate how far along it is and how much is left to do."
6341 #. type: <heading></heading>
6349 "Before all operations except update, APT performs a number of actions to "
6350 "prepare its internal state. It also does some checks of the system's "
6351 "state. At any time these operations can be performed by running <tt>apt-get "
6355 #. type: <example></example>
6360 "Reading Package Lists... Done\n"
6361 "Building Dependency Tree... Done"
6367 "The first thing it does is read all the package files into memory. APT uses "
6368 "a caching scheme so this operation will be faster the second time it is "
6369 "run. If some of the package files are not found then they will be ignored "
6370 "and a warning will be printed when apt-get exits."
6376 "The final operation performs a detailed analysis of the system's "
6377 "dependencies. It checks every dependency of every installed or unpacked "
6378 "package and considers if it is OK. Should this find a problem then a report "
6379 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6382 #. type: <example></example>
6387 "Reading Package Lists... Done\n"
6388 "Building Dependency Tree... Done\n"
6389 "You might want to run apt-get -f install' to correct these.\n"
6390 "Sorry, but the following packages have unmet dependencies:\n"
6391 " 9fonts: Depends: xlib6g but it is not installed\n"
6392 " uucp: Depends: mailx but it is not installed\n"
6393 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6394 " adduser: Depends: perl-base but it is not installed\n"
6395 " aumix: Depends: libgpmg1 but it is not installed\n"
6396 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6397 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6398 " cthugha: Depends: svgalibg1 but it is not installed\n"
6399 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6400 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6406 "In this example the system has many problems, including a serious problem "
6407 "with libreadlineg2. For each package that has unmet dependencies a line is "
6408 "printed out indicating the package with the problem and the dependencies "
6409 "that are unmet. A short explanation of why the package has a dependency "
6410 "problem is also included."
6416 "There are two ways a system can get into a broken state like this. The first "
6417 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6418 "packages when performing upgrades. <footnote><p>APT however considers all "
6419 "known dependencies and attempts to prevent broken "
6420 "packages</p></footnote>. The second is if a package installation fails "
6421 "during an operation. In this situation a package may have been unpacked "
6422 "without its dependents being installed."
6428 "The second situation is much less serious than the first because APT places "
6429 "certain constraints on the order that packages are installed. In both cases "
6430 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6431 "deduce a possible solution to the problem and then continue on. The APT "
6432 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6433 "for easy continuation of failed maintainer scripts."
6439 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6440 "system caused by the first case then it is possible that it will either fail "
6441 "immediately or the installation sequence will fail. In either case it is "
6442 "necessary to manually use dpkg (possibly with forcing options) to correct "
6443 "the situation enough to allow APT to proceed."
6446 #. type: <heading></heading>
6448 msgid "The Status Report"
6454 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6455 "happen. Generally the report reflects the type of operation being performed "
6456 "but there are several common elements. In all cases the lists reflect the "
6457 "final state of things, taking into account the <tt>-f</tt> option and any "
6458 "other relevant activities to the command being executed."
6461 #. type: <heading></heading>
6463 msgid "The Extra Package list"
6466 #. type: <example></example>
6470 "The following extra packages will be installed:\n"
6471 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6472 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6473 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6474 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6481 "The Extra Package list shows all of the packages that will be installed or "
6482 "upgraded in excess of the ones mentioned on the command line. It is only "
6483 "generated for an <tt>install</tt> command. The listed packages are often the "
6484 "result of an Auto Install."
6487 #. type: <heading></heading>
6489 msgid "The Packages to Remove"
6492 #. type: <example></example>
6496 "The following packages will be REMOVED:\n"
6497 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6498 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6499 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6506 "The Packages to Remove list shows all of the packages that will be removed "
6507 "from the system. It can be shown for any of the operations and should be "
6508 "given a careful inspection to ensure nothing important is to be taken "
6509 "off. The <tt>-f</tt> option is especially good at generating packages to "
6510 "remove so extreme care should be used in that case. The list may contain "
6511 "packages that are going to be removed because they are only partially "
6512 "installed, possibly due to an aborted installation."
6515 #. type: <heading></heading>
6517 msgid "The New Packages list"
6520 #. type: <example></example>
6524 "The following NEW packages will installed:\n"
6525 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6531 "The New Packages list is simply a reminder of what will happen. The packages "
6532 "listed are not presently installed in the system but will be when APT is "
6536 #. type: <heading></heading>
6538 msgid "The Kept Back list"
6541 #. type: <example></example>
6545 "The following packages have been kept back\n"
6546 " compface man-db tetex-base msql libpaper svgalib1\n"
6547 " gs snmp arena lynx xpat2 groff xscreensaver"
6553 "Whenever the whole system is being upgraded there is the possibility that "
6554 "new versions of packages cannot be installed because they require new things "
6555 "or conflict with already installed things. In this case the package will "
6556 "appear in the Kept Back list. The best way to convince packages listed there "
6557 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6558 "to resolve their problems."
6561 #. type: <heading></heading>
6563 msgid "Held Packages warning"
6566 #. type: <example></example>
6570 "The following held packages will be changed:\n"
6577 "Sometimes you can ask APT to install a package that is on hold, in such a "
6578 "case it prints out a warning that the held package is going to be "
6579 "changed. This should only happen during dist-upgrade or install."
6582 #. type: <heading></heading>
6584 msgid "Final summary"
6589 msgid "Finally, APT will print out a summary of all the changes that will occur."
6592 #. type: <example></example>
6596 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6598 "12 packages not fully installed or removed.\n"
6599 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6605 "The first line of the summary simply is a reduced version of all of the "
6606 "lists and includes the number of upgrades - that is packages already "
6607 "installed that have new versions available. The second line indicates the "
6608 "number of poorly configured packages, possibly the result of an aborted "
6609 "installation. The final line shows the space requirements that the "
6610 "installation needs. The first pair of numbers refer to the size of the "
6611 "archive files. The first number indicates the number of bytes that must be "
6612 "fetched from remote locations and the second indicates the total size of all "
6613 "the archives required. The next number indicates the size difference between "
6614 "the presently installed packages and the newly installed packages. It is "
6615 "roughly equivalent to the space required in /usr after everything is "
6616 "done. If a large number of packages are being removed then the value may "
6617 "indicate the amount of space that will be freed."
6623 "Some other reports can be generated by using the -u option to show packages "
6624 "to upgrade, they are similar to the previous examples."
6627 #. type: <heading></heading>
6629 msgid "The Status Display"
6635 "During the download of archives and package files APT prints out a series of "
6639 #. type: <example></example>
6643 "# apt-get update\n"
6644 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6645 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6646 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6647 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6649 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6650 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6656 "The lines starting with <em>Get</em> are printed out when APT begins to "
6657 "fetch a file while the last line indicates the progress of the download. The "
6658 "first percent value on the progress line indicates the total percent done of "
6659 "all files. Unfortunately since the size of the Package files is unknown "
6660 "<tt>apt-get update</tt> estimates the percent done which causes some "
6667 "The next section of the status line is repeated once for each download "
6668 "thread and indicates the operation being performed and some useful "
6669 "information about what is happening. Sometimes this section will simply read "
6670 "<em>Forking</em> which means the OS is loading the download module. The "
6671 "first word after the [ is the fetch number as shown on the history "
6672 "lines. The next word is the short form name of the object being "
6673 "downloaded. For archives it will contain the name of the package that is "
6680 "Inside of the single quote is an informative string indicating the progress "
6681 "of the negotiation phase of the download. Typically it progresses from "
6682 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6683 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6684 "the remote site. Once the download begins this is represented as "
6685 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6686 "kilobytes is expected. The total size is always shown in 4 figure notation "
6687 "to preserve space. After the size display is a percent meter for the file "
6688 "itself. The second last element is the instantaneous average speed. This "
6689 "values is updated every 5 seconds and reflects the rate of data transfer for "
6690 "that period. Finally is shown the estimated transfer time. This is updated "
6691 "regularly and reflects the time to complete everything at the shown transfer "
6698 "The status display updates every half second to provide a constant feedback "
6699 "on the download progress while the Get lines scroll back whenever a new file "
6700 "is started. Since the status display is constantly updated it is unsuitable "
6701 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6705 #. type: <heading></heading>
6713 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6714 "to the <prgn>dpkg</prgn> interface once downloading is "
6715 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6716 "processes the packages and the packages themselves may also ask several "
6717 "questions. Before each question there is usually a description of what it is "
6718 "asking and the questions are too varied to discuss completely here."
6721 #. type: <title></title>
6723 msgid "Using APT Offline"
6726 #. type: <version></version>
6728 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6731 #. type: <abstract></abstract>
6734 "This document describes how to use APT in a non-networked environment, "
6735 "specifically a 'sneaker-net' approach for performing upgrades."
6738 #. type: <copyrightsummary></copyrightsummary>
6740 msgid "Copyright © Jason Gunthorpe, 1999."
6743 #. type: <heading></heading>
6745 msgid "Introduction"
6748 #. type: <heading></heading>
6749 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6756 "Normally APT requires direct access to a Debian archive, either from a local "
6757 "media or through a network. Another common complaint is that a Debian "
6758 "machine is on a slow link, such as a modem and another machine has a very "
6759 "fast connection but they are physically distant."
6765 "The solution to this is to use large removable media such as a Zip disc or a "
6766 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6767 "archive but can easily fit a subset large enough for most users. The idea is "
6768 "to use APT to generate a list of packages that are required and then fetch "
6769 "them onto the disc using another machine with good connectivity. It is even "
6770 "possible to use another Debian machine with APT or to use a completely "
6771 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6772 "the machine downloading the packages, and <em>target host</em> the one with "
6773 "bad or no connection."
6779 "This is achieved by creatively manipulating the APT configuration file. The "
6780 "essential premise to tell APT to look on a disc for it's archive files. Note "
6781 "that the disc should be formated with a filesystem that can handle long file "
6782 "names such as ext2, fat32 or vfat."
6785 #. type: <heading></heading>
6787 msgid "Using APT on both machines"
6790 #. type: <p><example>
6793 "APT being available on both machines gives the simplest configuration. The "
6794 "basic idea is to place a copy of the status file on the disc and use the "
6795 "remote machine to fetch the latest package files and decide which packages "
6796 "to download. The disk directory structure should look like:"
6799 #. type: <example></example>
6813 #. type: <heading></heading>
6815 msgid "The configuration file"
6821 "The configuration file should tell APT to store its files on the disc and to "
6822 "use the configuration files on the disc as well. The sources.list should "
6823 "contain the proper sites that you wish to use from the remote machine, and "
6824 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6825 "<em>target host</em>. Please note, if you are using a local archive you must "
6826 "use copy URIs, the syntax is identical to file URIs."
6829 #. type: <p><example>
6832 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6836 #. type: <example></example>
6842 " /* This is not necessary if the two machines are the same arch, it "
6844 " the remote APT what architecture the target machine is */\n"
6845 " Architecture \"i386\";\n"
6847 " Get::Download-Only \"true\";\n"
6852 " /* Use the disc for state information and redirect the status file from\n"
6853 " the /var/lib/dpkg default */\n"
6854 " State \"/disc/\";\n"
6855 " State::status \"status\";\n"
6857 " // Binary caches will be stored locally\n"
6858 " Cache::archives \"/disc/archives/\";\n"
6859 " Cache \"/tmp/\";\n"
6861 " // Location of the source list.\n"
6862 " Etc \"/disc/\";\n"
6866 #. type: </example></p>
6869 "More details can be seen by examining the apt.conf man page and the sample "
6870 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6873 #. type: <p><example>
6876 "On the target machine the first thing to do is mount the disc and copy "
6877 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6878 "directories outlined in the Overview, <em>archives/partial/</em> and "
6879 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6880 "configure the sources.list. On the remote machine execute the following:"
6883 #. type: <example></example>
6887 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6888 " # apt-get update\n"
6889 " [ APT fetches the package files ]\n"
6890 " # apt-get dist-upgrade\n"
6891 " [ APT fetches all the packages needed to upgrade the target machine ]"
6894 #. type: </example></p>
6897 "The dist-upgrade command can be replaced with any other standard APT "
6898 "commands, particularly dselect-upgrade. You can even use an APT front end "
6899 "such as <em>dselect</em>. However this presents a problem in communicating "
6900 "your selections back to the local computer."
6903 #. type: <p><example>
6906 "Now the disc contains all of the index files and archives needed to upgrade "
6907 "the target machine. Take the disc back and run:"
6910 #. type: <example></example>
6914 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6915 " # apt-get check\n"
6916 " [ APT generates a local copy of the cache files ]\n"
6917 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6918 " [ Or any other APT command ]"
6924 "It is necessary for proper function to re-specify the status file to be the "
6925 "local one. This is very important!"
6931 "If you are using dselect you can do the very risky operation of copying "
6932 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6933 "remote machine are updated. I highly recommend that people only make "
6934 "selections on the local machine - but this may not always be possible. DO "
6935 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6938 #. type: <heading></heading>
6940 msgid "Using APT and wget"
6946 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6947 "any machine. Unlike the method above this requires that the Debian machine "
6948 "already has a list of available packages."
6954 "The basic idea is to create a disc that has only the archive files "
6955 "downloaded from the remote site. This is done by using the --print-uris "
6956 "option to apt-get and then preparing a wget script to actually fetch the "
6960 #. type: <heading></heading>
6965 #. type: <p><example>
6968 "Unlike the previous technique no special configuration files are "
6969 "required. We merely use the standard APT commands to generate the file list."
6972 #. type: <example></example>
6976 " # apt-get dist-upgrade \n"
6977 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6978 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6979 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6982 #. type: </example></p>
6985 "Any command other than dist-upgrade could be used here, including "
6992 "The /disc/wget-script file will now contain a list of wget commands to "
6993 "execute in order to fetch the necessary archives. This script should be run "
6994 "with the current directory as the disc's mount point so as to save the "
6995 "output on the disc."
6998 #. type: <p><example>
7000 msgid "The remote machine would do something like"
7003 #. type: <example></example>
7008 " # sh -x ./wget-script\n"
7012 #. type: </example><example>
7015 "Once the archives are downloaded and the disc returned to the Debian machine "
7016 "installation can proceed using,"
7019 #. type: <example></example>
7022 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
7025 #. type: </example></p>
7027 msgid "Which will use the already fetched archives on the disc."