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.14.2\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2014-01-05 10:10+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 &dselect;, "
525 "&aptitude;, &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>. When APT is used as a "
757 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
758 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
759 "from time to time to free up disk space."
762 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
765 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
766 "local repository of retrieved package files. The difference is that it only "
767 "removes package files that can no longer be downloaded, and are largely "
768 "useless. This allows a cache to be maintained over a long period without it "
769 "growing out of control. The configuration option "
770 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
771 "being erased if it is set to off."
774 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
777 "<literal>autoremove</literal> is used to remove packages that were "
778 "automatically installed to satisfy dependencies for other packages and are "
779 "now no longer needed."
782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
785 "<literal>changelog</literal> downloads a package changelog and displays it "
786 "through <command>sensible-pager</command>. The server name and base "
787 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
788 "variable (e.g. <ulink "
789 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
790 "for Debian or <ulink "
791 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
792 "for Ubuntu). By default it displays the changelog for the version that is "
793 "installed. However, you can specify the same options as for the "
794 "<option>install</option> command."
797 #. type: Content of: <refentry><refsect1><title>
798 #: apt-get.8.xml:260 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
802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
805 "Do not consider recommended packages as a dependency for installing. "
806 "Configuration Item: <literal>APT::Install-Recommends</literal>."
809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
812 "Consider suggested packages as a dependency for installing. Configuration "
813 "Item: <literal>APT::Install-Suggests</literal>."
816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
819 "Download only; package files are only retrieved, not unpacked or installed. "
820 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
823 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
826 "Fix; attempt to correct a system with broken dependencies in place. This "
827 "option, when used with install/remove, can omit any packages to permit APT "
828 "to deduce a likely solution. If packages are specified, these have to "
829 "completely correct the problem. The option is sometimes necessary when "
830 "running APT for the first time; APT itself does not allow broken package "
831 "dependencies to exist on a system. It is possible that a system's dependency "
832 "structure can be so corrupt as to require manual intervention (which usually "
833 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
834 "of the offending packages). Use of this option together with "
835 "<option>-m</option> may produce an error in some situations. Configuration "
836 "Item: <literal>APT::Get::Fix-Broken</literal>."
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
842 "Ignore missing packages; if packages cannot be retrieved or fail the "
843 "integrity check after retrieval (corrupted package files), hold back those "
844 "packages and handle the result. Use of this option together with "
845 "<option>-f</option> may produce an error in some situations. If a package is "
846 "selected for installation (particularly if it is mentioned on the command "
847 "line) and it could not be downloaded then it will be silently held back. "
848 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
854 "Disables downloading of packages. This is best used with "
855 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
856 "already downloaded. Configuration Item: "
857 "<literal>APT::Get::Download</literal>."
860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
863 "Quiet; produces output suitable for logging, omitting progress indicators. "
864 "More q's will produce more quiet up to a maximum of 2. You can also use "
865 "<option>-q=#</option> to set the quiet level, overriding the configuration "
866 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
867 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
868 "may decide to do something you did not expect. Configuration Item: "
869 "<literal>quiet</literal>."
872 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
875 "No action; perform a simulation of events that would occur but do not "
876 "actually change the system. Configuration Item: "
877 "<literal>APT::Get::Simulate</literal>."
880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
883 "Simulated runs performed as a user will automatically deactivate locking "
884 "(<literal>Debug::NoLocking</literal>), and if the option "
885 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (as it is by "
886 "default) a notice will also be displayed indicating that this is only a "
887 "simulation. Runs performed as root do not trigger either NoLocking or the "
888 "notice - superusers should know what they are doing without further warnings "
889 "from <literal>apt-get</literal>."
892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
895 "Simulated runs print out a series of lines, each representing a "
896 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
897 "remove (<literal>Remv</literal>) or unpack "
898 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
899 "empty square brackets indicate breaks that are of no consequence (rare)."
902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
905 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
906 "non-interactively. If an undesirable situation, such as changing a held "
907 "package, trying to install a unauthenticated package or removing an "
908 "essential package occurs then <literal>apt-get</literal> will abort. "
909 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
915 "Automatic \"no\" to all prompts. Configuration Item: "
916 "<literal>APT::Get::Assume-No</literal>."
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
922 "Show upgraded packages; print out a list of all packages that are to be "
923 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
929 "Show full versions for upgraded and installed packages. Configuration Item: "
930 "<literal>APT::Get::Show-Versions</literal>."
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
936 "This option controls the architecture packages are built for by "
937 "<command>apt-get source --compile</command> and how cross-builddependencies "
938 "are satisfied. By default is it not set which means that the host "
939 "architecture is the same as the build architecture (which is defined by "
940 "<literal>APT::Architecture</literal>). Configuration Item: "
941 "<literal>APT::Get::Host-Architecture</literal>"
944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
947 "Compile source packages after downloading them. Configuration Item: "
948 "<literal>APT::Get::Compile</literal>."
951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
954 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
955 "hold placed on a package. This may be useful in conjunction with "
956 "<literal>dist-upgrade</literal> to override a large number of undesired "
957 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
963 "Allow installing new packages when used in conjunction with "
964 "<literal>upgrade</literal>. This is useful if the update of a installed "
965 "package requires new dependencies to be installed. Instead of holding the "
966 "package back <literal>upgrade</literal> will upgrade the package and install "
967 "the new dependencies. Note that <literal>upgrade</literal> with this option "
968 "will never remove packages, only allow adding new ones. Configuration Item: "
969 "<literal>APT::Get::Upgrade-Allow-New</literal>."
972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
975 "Do not upgrade packages; when used in conjunction with "
976 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
977 "packages on the command line from being upgraded if they are already "
978 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
981 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
984 "Do not install new packages; when used in conjunction with "
985 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
986 "upgrades for already installed packages only and ignore requests to install "
987 "new packages. Configuration Item: "
988 "<literal>APT::Get::Only-Upgrade</literal>."
991 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
994 "Force yes; this is a dangerous option that will cause apt to continue "
995 "without prompting if it is doing something potentially harmful. It should "
996 "not be used except in very special situations. Using "
997 "<literal>force-yes</literal> can potentially destroy your system! "
998 "Configuration Item: <literal>APT::Get::force-yes</literal>."
1001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1002 #: apt-get.8.xml:430
1004 "Instead of fetching the files to install their URIs are printed. Each URI "
1005 "will have the path, the destination file name, the size and the expected MD5 "
1006 "hash. Note that the file name to write to will not always match the file "
1007 "name on the remote site! This also works with the <literal>source</literal> "
1008 "and <literal>update</literal> commands. When used with the "
1009 "<literal>update</literal> command the MD5 and size are not included, and it "
1010 "is up to the user to decompress any compressed files. Configuration Item: "
1011 "<literal>APT::Get::Print-URIs</literal>."
1014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1015 #: apt-get.8.xml:441
1017 "Use purge instead of remove for anything that would be removed. An asterisk "
1018 "(\"*\") will be displayed next to packages which are scheduled to be "
1019 "purged. <option>remove --purge</option> is equivalent to the "
1020 "<option>purge</option> command. Configuration Item: "
1021 "<literal>APT::Get::Purge</literal>."
1024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1025 #: apt-get.8.xml:449
1027 "Re-install packages that are already installed and at the newest version. "
1028 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1031 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1032 #: apt-get.8.xml:454
1034 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1035 "turn it off. When it is on, <command>apt-get</command> will automatically "
1036 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1037 "obsolete files are erased. The only reason to turn it off is if you "
1038 "frequently change your sources list. Configuration Item: "
1039 "<literal>APT::Get::List-Cleanup</literal>."
1042 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1043 #: apt-get.8.xml:464
1045 "This option controls the default input to the policy engine; it creates a "
1046 "default pin at priority 990 using the specified release string. This "
1047 "overrides the general settings in "
1048 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1049 "not affected by the value of this option. In short, this option lets you "
1050 "have simple control over which distribution packages will be retrieved "
1051 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1052 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1053 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1057 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1058 #: apt-get.8.xml:479
1060 "Only perform operations that are 'trivial'. Logically this can be considered "
1061 "related to <option>--assume-yes</option>; where "
1062 "<option>--assume-yes</option> will answer yes to any prompt, "
1063 "<option>--trivial-only</option> will answer no. Configuration Item: "
1064 "<literal>APT::Get::Trivial-Only</literal>."
1067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1068 #: apt-get.8.xml:486
1070 "If any packages are to be removed apt-get immediately aborts without "
1071 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1075 #: apt-get.8.xml:492
1077 "If the command is either <literal>install</literal> or "
1078 "<literal>remove</literal>, then this option acts like running the "
1079 "<literal>autoremove</literal> command, removing unused dependency "
1080 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1083 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1084 #: apt-get.8.xml:499
1086 "Only has meaning for the <literal>source</literal> and "
1087 "<literal>build-dep</literal> commands. Indicates that the given source "
1088 "names are not to be mapped through the binary table. This means that if "
1089 "this option is specified, these commands will only accept source package "
1090 "names as arguments, rather than accepting binary package names and looking "
1091 "up the corresponding source package. Configuration Item: "
1092 "<literal>APT::Get::Only-Source</literal>."
1095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1096 #: apt-get.8.xml:510
1098 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1099 "Item: <literal>APT::Get::Diff-Only</literal>, "
1100 "<literal>APT::Get::Dsc-Only</literal>, and "
1101 "<literal>APT::Get::Tar-Only</literal>."
1104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1105 #: apt-get.8.xml:516
1107 "Only process architecture-dependent build-dependencies. Configuration Item: "
1108 "<literal>APT::Get::Arch-Only</literal>."
1111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1112 #: apt-get.8.xml:521
1114 "Ignore if packages can't be authenticated and don't prompt about it. This "
1115 "is useful for tools like pbuilder. Configuration Item: "
1116 "<literal>APT::Get::AllowUnauthenticated</literal>."
1119 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1120 #: apt-get.8.xml:527
1122 "Show user friendly progress information in the terminal window when packages "
1123 "are installed, upgraded or removed. For a machine parsable version of this "
1124 "data see README.progress-reporting in the apt doc directory. Configuration "
1125 "Item: <literal>DpkgPM::Progress</literal> and "
1126 "<literal>Dpkg::Progress-Fancy</literal>."
1129 #. type: Content of: <refentry><refsect1><title>
1130 #: apt-get.8.xml:540 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
1134 #. type: Content of: <refentry><refsect1><title>
1135 #: apt-get.8.xml:550 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:258 apt-extracttemplates.1.xml:72 apt-sortpkgs.1.xml:65 apt-ftparchive.1.xml:609
1139 #. type: Content of: <refentry><refsect1><para>
1140 #: apt-get.8.xml:551
1142 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
1143 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
1144 "&apt-preferences;, the APT Howto."
1147 #. type: Content of: <refentry><refsect1><title>
1148 #: apt-get.8.xml:556 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
1152 #. type: Content of: <refentry><refsect1><para>
1153 #: apt-get.8.xml:557
1155 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1159 #. type: Content of: <refentry><refnamediv><refpurpose>
1160 #: apt-cache.8.xml:35
1161 msgid "query the APT cache"
1164 #. type: Content of: <refentry><refsect1><para>
1165 #: apt-cache.8.xml:41
1167 "<command>apt-cache</command> performs a variety of operations on APT's "
1168 "package cache. <command>apt-cache</command> does not manipulate the state of "
1169 "the system but does provide operations to search and generate interesting "
1170 "output from the package metadata."
1173 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1174 #: apt-cache.8.xml:51
1176 "<literal>gencaches</literal> creates APT's package cache. This is done "
1177 "implicitly by all commands needing this cache if it is missing or outdated."
1180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1181 #: 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
1182 msgid "&synopsis-pkg;"
1185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1186 #: apt-cache.8.xml:56
1188 "<literal>showpkg</literal> displays information about the packages listed on "
1189 "the command line. Remaining arguments are package names. The available "
1190 "versions and reverse dependencies of each package listed are listed, as well "
1191 "as forward dependencies for each version. Forward (normal) dependencies are "
1192 "those packages upon which the package in question depends; reverse "
1193 "dependencies are those packages that depend upon the package in "
1194 "question. Thus, forward dependencies must be satisfied for a package, but "
1195 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1196 "libreadline2</command> would produce output similar to the following:"
1199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1200 #: apt-cache.8.xml:68
1203 "Package: libreadline2\n"
1204 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1205 "Reverse Depends: \n"
1206 " libreadlineg2,libreadline2\n"
1207 " libreadline2-altdev,libreadline2\n"
1209 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1212 "Reverse Provides: \n"
1215 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1216 #: apt-cache.8.xml:80
1218 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1219 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1220 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1221 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1222 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1223 "installed. For the specific meaning of the remainder of the output it is "
1224 "best to consult the apt source code."
1227 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1228 #: apt-cache.8.xml:89
1230 "<literal>stats</literal> displays some statistics about the cache. No "
1231 "further arguments are expected. Statistics reported are:"
1234 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1235 #: apt-cache.8.xml:92
1237 "<literal>Total package names</literal> is the number of package names found "
1241 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1242 #: apt-cache.8.xml:96
1244 "<literal>Normal packages</literal> is the number of regular, ordinary "
1245 "package names; these are packages that bear a one-to-one correspondence "
1246 "between their names and the names used by other packages for them in "
1247 "dependencies. The majority of packages fall into this category."
1250 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1251 #: apt-cache.8.xml:102
1253 "<literal>Pure virtual packages</literal> is the number of packages that "
1254 "exist only as a virtual package name; that is, packages only \"provide\" the "
1255 "virtual package name, and no package actually uses the name. For instance, "
1256 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1257 "several packages provide \"mail-transport-agent\", but there is no package "
1258 "named \"mail-transport-agent\"."
1261 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1262 #: apt-cache.8.xml:110
1264 "<literal>Single virtual packages</literal> is the number of packages with "
1265 "only one package providing a particular virtual package. For example, in the "
1266 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1267 "package, xless, provides \"X11-text-viewer\"."
1270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1271 #: apt-cache.8.xml:116
1273 "<literal>Mixed virtual packages</literal> is the number of packages that "
1274 "either provide a particular virtual package or have the virtual package name "
1275 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1276 "an actual package, and provided by the debconf-tiny package."
1279 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1280 #: apt-cache.8.xml:123
1282 "<literal>Missing</literal> is the number of package names that were "
1283 "referenced in a dependency but were not provided by any package. Missing "
1284 "packages may be an evidence if a full distribution is not accessed, or if a "
1285 "package (real or virtual) has been dropped from the distribution. Usually "
1286 "they are referenced from Conflicts or Breaks statements."
1289 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1290 #: apt-cache.8.xml:130
1292 "<literal>Total distinct</literal> versions is the number of package versions "
1293 "found in the cache; this value is therefore at least equal to the number of "
1294 "total package names. If more than one distribution is being accessed (for "
1295 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1296 "larger than the number of total package names."
1299 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1300 #: apt-cache.8.xml:137
1302 "<literal>Total dependencies</literal> is the number of dependency "
1303 "relationships claimed by all of the packages in the cache."
1306 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1307 #: apt-cache.8.xml:145
1309 "<literal>showsrc</literal> displays all the source package records that "
1310 "match the given package names. All versions are shown, as well as all "
1311 "records that declare the name to be a binary package."
1314 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1315 #: apt-cache.8.xml:151
1317 "<literal>dump</literal> shows a short listing of every package in the "
1318 "cache. It is primarily for debugging."
1321 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1322 #: apt-cache.8.xml:156
1324 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1325 "suitable for use with &dpkg; and is used by the &dselect; method."
1328 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1329 #: apt-cache.8.xml:161
1331 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1335 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1336 #: apt-cache.8.xml:166
1338 "<literal>show</literal> performs a function similar to <command>dpkg "
1339 "--print-avail</command>; it displays the package records for the named "
1343 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1344 #: apt-cache.8.xml:171
1345 msgid "&synopsis-regex;"
1348 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1349 #: apt-cache.8.xml:172
1351 "<literal>search</literal> performs a full text search on all available "
1352 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1353 "the package names and the descriptions for an occurrence of the regular "
1354 "expression and prints out the package name and the short description, "
1355 "including virtual package names. If <option>--full</option> is given then "
1356 "output identical to <literal>show</literal> is produced for each matched "
1357 "package, and if <option>--names-only</option> is given then the long "
1358 "description is not searched, only the package name is."
1361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1362 #: apt-cache.8.xml:183
1364 "Separate arguments can be used to specify multiple search patterns that are "
1368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1369 #: apt-cache.8.xml:188
1371 "<literal>depends</literal> shows a listing of each dependency a package has "
1372 "and all the possible other packages that can fulfill that dependency."
1375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1376 #: apt-cache.8.xml:193
1378 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1383 #: apt-cache.8.xml:197
1384 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1387 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1388 #: apt-cache.8.xml:198
1390 "This command prints the name of each package APT knows. The optional "
1391 "argument is a prefix match to filter the name list. The output is suitable "
1392 "for use in a shell tab complete function and the output is generated "
1393 "extremely quickly. This command is best used with the "
1394 "<option>--generate</option> option."
1397 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1398 #: apt-cache.8.xml:203
1400 "Note that a package which APT knows of is not necessarily available to "
1401 "download, installable or installed, e.g. virtual packages are also listed in "
1402 "the generated list."
1405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1406 #: apt-cache.8.xml:209
1408 "<literal>dotty</literal> takes a list of packages on the command line and "
1409 "generates output suitable for use by dotty from the <ulink "
1410 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1411 "package. The result will be a set of nodes and edges representing the "
1412 "relationships between the packages. By default the given packages will trace "
1413 "out all dependent packages; this can produce a very large graph. To limit "
1414 "the output to only the packages listed on the command line, set the "
1415 "<literal>APT::Cache::GivenOnly</literal> option."
1418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1419 #: apt-cache.8.xml:218
1421 "The resulting nodes will have several shapes; normal packages are boxes, "
1422 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1423 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1424 "packages), blue lines are pre-depends, green lines are conflicts."
1427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1428 #: apt-cache.8.xml:223
1429 msgid "Caution, dotty cannot graph larger sets of packages."
1432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1433 #: apt-cache.8.xml:227
1435 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1436 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1441 #: apt-cache.8.xml:231
1442 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1446 #: apt-cache.8.xml:232
1448 "<literal>policy</literal> is meant to help debug issues relating to the "
1449 "preferences file. With no arguments it will print out the priorities of each "
1450 "source. Otherwise it prints out detailed information about the priority "
1451 "selection of the named package."
1454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1455 #: apt-cache.8.xml:239
1457 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1458 "to mimic the output format and a subset of the functionality of the Debian "
1459 "archive management tool, <literal>madison</literal>. It displays available "
1460 "versions of a package in a tabular format. Unlike the original "
1461 "<literal>madison</literal>, it can only display information for the "
1462 "architecture for which APT has retrieved package lists "
1463 "(<literal>APT::Architecture</literal>)."
1466 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1467 #: apt-cache.8.xml:255
1469 "Select the file to store the package cache. The package cache is the primary "
1470 "cache used by all operations. Configuration Item: "
1471 "<literal>Dir::Cache::pkgcache</literal>."
1474 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1475 #: apt-cache.8.xml:261
1477 "Select the file to store the source cache. The source is used only by "
1478 "<literal>gencaches</literal> and it stores a parsed version of the package "
1479 "information from remote sources. When building the package cache the source "
1480 "cache is used to avoid reparsing all of the package files. Configuration "
1481 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1484 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1485 #: apt-cache.8.xml:269
1487 "Quiet; produces output suitable for logging, omitting progress indicators. "
1488 "More q's will produce more quietness up to a maximum of 2. You can also use "
1489 "<option>-q=#</option> to set the quietness level, overriding the "
1490 "configuration file. Configuration Item: <literal>quiet</literal>."
1493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1494 #: apt-cache.8.xml:276
1496 "Print only important dependencies; for use with <literal>unmet</literal> and "
1497 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1498 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1502 #: apt-cache.8.xml:290
1504 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1505 "print all dependencies. This can be tweaked with these flags which will omit "
1506 "the specified dependency type. Configuration Item: "
1507 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1508 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1511 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1512 #: apt-cache.8.xml:297
1514 "Print full package records when searching. Configuration Item: "
1515 "<literal>APT::Cache::ShowFull</literal>."
1518 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1519 #: apt-cache.8.xml:302
1521 "Print full records for all available versions. This is the default; to turn "
1522 "it off, use <option>--no-all-versions</option>. If "
1523 "<option>--no-all-versions</option> is specified, only the candidate version "
1524 "will be displayed (the one which would be selected for installation). This "
1525 "option is only applicable to the <literal>show</literal> command. "
1526 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1530 #: apt-cache.8.xml:311
1532 "Perform automatic package cache regeneration, rather than use the cache as "
1533 "it is. This is the default; to turn it off, use "
1534 "<option>--no-generate</option>. Configuration Item: "
1535 "<literal>APT::Cache::Generate</literal>."
1538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1539 #: apt-cache.8.xml:317
1541 "Only search on the package names, not the long descriptions. Configuration "
1542 "Item: <literal>APT::Cache::NamesOnly</literal>."
1545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1546 #: apt-cache.8.xml:322
1548 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1549 "and missing dependencies. Configuration Item: "
1550 "<literal>APT::Cache::AllNames</literal>."
1553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1554 #: apt-cache.8.xml:328
1556 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1557 "that all packages mentioned are printed once. Configuration Item: "
1558 "<literal>APT::Cache::RecurseDepends</literal>."
1561 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1562 #: apt-cache.8.xml:335
1564 "Limit the output of <literal>depends</literal> and "
1565 "<literal>rdepends</literal> to packages which are currently installed. "
1566 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1569 #. type: Content of: <refentry><refsect1><para>
1570 #: apt-cache.8.xml:353
1571 msgid "&apt-conf;, &sources-list;, &apt-get;"
1574 #. type: Content of: <refentry><refsect1><para>
1575 #: apt-cache.8.xml:358
1577 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1581 #. type: Content of: <refentry><refnamediv><refpurpose>
1583 msgid "APT key management utility"
1586 #. type: Content of: <refentry><refsect1><para>
1589 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1590 "authenticate packages. Packages which have been authenticated using these "
1591 "keys will be considered trusted."
1594 #. type: Content of: <refentry><refsect1><title>
1599 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1602 "Add a new key to the list of trusted keys. The key is read from the "
1603 "filename given with the parameter &synopsis-param-filename; or if the "
1604 "filename is <literal>-</literal> from standard input."
1607 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1609 msgid "Remove a key from the list of trusted keys."
1612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1614 msgid "Output the key &synopsis-param-keyid; to standard output."
1617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1619 msgid "Output all trusted keys to standard output."
1622 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1624 msgid "List trusted keys."
1627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1628 #: apt-key.8.xml:109
1629 msgid "List fingerprints of trusted keys."
1632 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1633 #: apt-key.8.xml:120
1635 "Pass advanced options to gpg. With adv --recv-key you can download the "
1639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1640 #: apt-key.8.xml:132
1642 "Update the local keyring with the archive keyring and remove from the local "
1643 "keyring the archive keys which are no longer valid. The archive keyring is "
1644 "shipped in the <literal>archive-keyring</literal> package of your "
1645 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1649 #: apt-key.8.xml:146
1651 "Perform an update working similarly to the <command>update</command> command "
1652 "above, but get the archive keyring from a URI instead and validate it "
1653 "against a master key. This requires an installed &wget; and an APT build "
1654 "configured to have a server to fetch from and a master keyring to validate. "
1655 "APT in Debian does not support this command, relying on "
1656 "<command>update</command> instead, but Ubuntu's APT does."
1659 #. type: Content of: <refentry><refsect1><title>
1660 #: apt-key.8.xml:162 apt-cdrom.8.xml:82
1664 #. type: Content of: <refentry><refsect1><para>
1665 #: apt-key.8.xml:163
1667 "Note that options need to be defined before the commands described in the "
1671 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1672 #: apt-key.8.xml:166
1674 "With this option it is possible to specify a particular keyring file the "
1675 "command should operate on. The default is that a command is executed on the "
1676 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1677 "<filename>trusted.gpg.d</filename> directory, though "
1678 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1679 "e.g. new keys are added to this one."
1682 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1683 #: apt-key.8.xml:181
1684 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1687 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1688 #: apt-key.8.xml:182
1689 msgid "Local trust database of archive keys."
1692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1693 #: apt-key.8.xml:185
1694 msgid "&keyring-filename;"
1697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1698 #: apt-key.8.xml:186
1699 msgid "Keyring of &keyring-distro; archive trusted keys."
1702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1703 #: apt-key.8.xml:189
1704 msgid "&keyring-removed-filename;"
1707 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1708 #: apt-key.8.xml:190
1709 msgid "Keyring of &keyring-distro; archive removed trusted keys."
1712 #. type: Content of: <refentry><refsect1><para>
1713 #: apt-key.8.xml:199
1714 msgid "&apt-get;, &apt-secure;"
1717 #. type: Content of: <refentry><refnamediv><refpurpose>
1718 #: apt-mark.8.xml:35
1719 msgid "mark/unmark a package as being automatically-installed"
1722 #. type: Content of: <refentry><refsect1><para>
1723 #: apt-mark.8.xml:41
1725 "<command>apt-mark</command> will change whether a package has been marked as "
1726 "being automatically installed."
1729 #. type: Content of: <refentry><refsect1><para>
1730 #: apt-mark.8.xml:45
1732 "When you request that a package is installed, and as a result other packages "
1733 "are installed to satisfy its dependencies, the dependencies are marked as "
1734 "being automatically installed. Once these automatically installed packages "
1735 "are no longer depended on by any manually installed packages, they will be "
1736 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
1739 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1740 #: apt-mark.8.xml:54
1742 "<literal>auto</literal> is used to mark a package as being automatically "
1743 "installed, which will cause the package to be removed when no more manually "
1744 "installed packages depend on this package."
1747 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1748 #: apt-mark.8.xml:62
1750 "<literal>manual</literal> is used to mark a package as being manually "
1751 "installed, which will prevent the package from being automatically removed "
1752 "if no other packages depend on it."
1755 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1756 #: apt-mark.8.xml:70
1758 "<literal>hold</literal> is used to mark a package as held back, which will "
1759 "prevent the package from being automatically installed, upgraded or "
1760 "removed. The command is only a wrapper around <command>dpkg "
1761 "--set-selections</command> and the state is therefore maintained by &dpkg; "
1762 "and not affected by the <option>--file</option> option."
1765 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1766 #: apt-mark.8.xml:80
1768 "<literal>unhold</literal> is used to cancel a previously set hold on a "
1769 "package to allow all actions again."
1772 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1773 #: apt-mark.8.xml:86
1775 "<literal>showauto</literal> is used to print a list of automatically "
1776 "installed packages with each package on a new line. All automatically "
1777 "installed packages will be listed if no package is given. If packages are "
1778 "given only those which are automatically installed will be shown."
1781 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1782 #: apt-mark.8.xml:94
1784 "<literal>showmanual</literal> can be used in the same way as "
1785 "<literal>showauto</literal> except that it will print a list of manually "
1786 "installed packages instead."
1789 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1790 #: apt-mark.8.xml:101
1792 "<literal>showhold</literal> is used to print a list of packages on hold in "
1793 "the same way as for the other show commands."
1796 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1797 #: apt-mark.8.xml:117
1799 "Read/Write package stats from the filename given with the parameter "
1800 "&synopsis-param-filename; instead of from the default location, which is "
1801 "<filename>extended_status</filename> in the directory defined by the "
1802 "Configuration Item: <literal>Dir::State</literal>."
1805 #. type: Content of: <refentry><refsect1><para>
1806 #: apt-mark.8.xml:138
1808 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
1812 #. type: Content of: <refentry><refnamediv><refpurpose>
1813 #: apt-secure.8.xml:49
1814 msgid "Archive authentication support for APT"
1817 #. type: Content of: <refentry><refsect1><para>
1818 #: apt-secure.8.xml:54
1820 "Starting with version 0.6, <command>apt</command> contains code that does "
1821 "signature checking of the Release file for all archives. This ensures that "
1822 "packages in the archive can't be modified by people who have no access to "
1823 "the Release file signing key."
1826 #. type: Content of: <refentry><refsect1><para>
1827 #: apt-secure.8.xml:62
1829 "If a package comes from a archive without a signature, or with a signature "
1830 "that apt does not have a key for, that package is considered untrusted, and "
1831 "installing it will result in a big warning. <command>apt-get</command> will "
1832 "currently only warn for unsigned archives; future releases might force all "
1833 "sources to be verified before downloading packages from them."
1836 #. type: Content of: <refentry><refsect1><para>
1837 #: apt-secure.8.xml:71
1839 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
1840 "authentication feature."
1843 #. type: Content of: <refentry><refsect1><title>
1844 #: apt-secure.8.xml:76
1845 msgid "Trusted archives"
1848 #. type: Content of: <refentry><refsect1><para>
1849 #: apt-secure.8.xml:79
1851 "The chain of trust from an apt archive to the end user is made up of several "
1852 "steps. <command>apt-secure</command> is the last step in this chain; "
1853 "trusting an archive does not mean that you trust its packages not to contain "
1854 "malicious code, but means that you trust the archive maintainer. It's the "
1855 "archive maintainer's responsibility to ensure that the archive's integrity "
1859 #. type: Content of: <refentry><refsect1><para>
1860 #: apt-secure.8.xml:87
1862 "apt-secure does not review signatures at a package level. If you require "
1863 "tools to do this you should look at <command>debsig-verify</command> and "
1864 "<command>debsign</command> (provided in the debsig-verify and devscripts "
1865 "packages respectively)."
1868 #. type: Content of: <refentry><refsect1><para>
1869 #: apt-secure.8.xml:94
1871 "The chain of trust in Debian starts when a maintainer uploads a new package "
1872 "or a new version of a package to the Debian archive. In order to become "
1873 "effective, this upload needs to be signed by a key contained in the Debian "
1874 "Maintainers keyring (available in the debian-keyring package). Maintainers' "
1875 "keys are signed by other maintainers following pre-established procedures to "
1876 "ensure the identity of the key holder."
1879 #. type: Content of: <refentry><refsect1><para>
1880 #: apt-secure.8.xml:104
1882 "Once the uploaded package is verified and included in the archive, the "
1883 "maintainer signature is stripped off, and checksums of the package are "
1884 "computed and put in the Packages file. The checksums of all of the Packages "
1885 "files are then computed and put into the Release file. The Release file is "
1886 "then signed by the archive key for this &keyring-distro; release, and "
1887 "distributed alongside the packages and the Packages files on "
1888 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
1889 "keyring available in the &keyring-package; package."
1892 #. type: Content of: <refentry><refsect1><para>
1893 #: apt-secure.8.xml:115
1895 "End users can check the signature of the Release file, extract a checksum of "
1896 "a package from it and compare it with the checksum of the package they "
1897 "downloaded by hand - or rely on APT doing this automatically."
1900 #. type: Content of: <refentry><refsect1><para>
1901 #: apt-secure.8.xml:120
1903 "Notice that this is distinct from checking signatures on a per package "
1904 "basis. It is designed to prevent two possible attacks:"
1907 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1908 #: apt-secure.8.xml:125
1910 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
1911 "checking, malicious agents can introduce themselves into the package "
1912 "download process and provide malicious software either by controlling a "
1913 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
1914 "server (through ARP or DNS spoofing attacks)."
1917 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1918 #: apt-secure.8.xml:133
1920 "<literal>Mirror network compromise</literal>. Without signature checking, a "
1921 "malicious agent can compromise a mirror host and modify the files in it to "
1922 "propagate malicious software to all users downloading packages from that "
1926 #. type: Content of: <refentry><refsect1><para>
1927 #: apt-secure.8.xml:140
1929 "However, it does not defend against a compromise of the Debian master server "
1930 "itself (which signs the packages) or against a compromise of the key used to "
1931 "sign the Release files. In any case, this mechanism can complement a "
1932 "per-package signature."
1935 #. type: Content of: <refentry><refsect1><title>
1936 #: apt-secure.8.xml:146
1937 msgid "User configuration"
1940 #. type: Content of: <refentry><refsect1><para>
1941 #: apt-secure.8.xml:148
1943 "<command>apt-key</command> is the program that manages the list of keys used "
1944 "by apt. It can be used to add or remove keys, although an installation of "
1945 "this release will automatically contain the default Debian archive signing "
1946 "keys used in the Debian package repositories."
1949 #. type: Content of: <refentry><refsect1><para>
1950 #: apt-secure.8.xml:155
1952 "In order to add a new key you need to first download it (you should make "
1953 "sure you are using a trusted communication channel when retrieving it), add "
1954 "it with <command>apt-key</command> and then run <command>apt-get "
1955 "update</command> so that apt can download and verify the "
1956 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
1957 "from the archives you have configured."
1960 #. type: Content of: <refentry><refsect1><title>
1961 #: apt-secure.8.xml:164
1962 msgid "Archive configuration"
1965 #. type: Content of: <refentry><refsect1><para>
1966 #: apt-secure.8.xml:166
1968 "If you want to provide archive signatures in an archive under your "
1969 "maintenance you have to:"
1972 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1973 #: apt-secure.8.xml:171
1975 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
1976 "already. You can do this by running <command>apt-ftparchive "
1977 "release</command> (provided in apt-utils)."
1980 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1981 #: apt-secure.8.xml:176
1983 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
1984 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
1985 "Release.gpg Release</command>."
1988 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
1989 #: apt-secure.8.xml:180
1991 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
1992 "know what key they need to import in order to authenticate the files in the "
1996 #. type: Content of: <refentry><refsect1><para>
1997 #: apt-secure.8.xml:187
1999 "Whenever the contents of the archive change (new packages are added or "
2000 "removed) the archive maintainer has to follow the first two steps outlined "
2004 #. type: Content of: <refentry><refsect1><para>
2005 #: apt-secure.8.xml:195
2007 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2008 "&debsign; &debsig-verify;, &gpg;"
2011 #. type: Content of: <refentry><refsect1><para>
2012 #: apt-secure.8.xml:199
2014 "For more background information you might want to review the <ulink "
2015 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2016 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2017 "(available also in the harden-doc package) and the <ulink "
2018 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2019 "Distribution HOWTO</ulink> by V. Alex Brennen."
2022 #. type: Content of: <refentry><refsect1><title>
2023 #: apt-secure.8.xml:212
2024 msgid "Manpage Authors"
2027 #. type: Content of: <refentry><refsect1><para>
2028 #: apt-secure.8.xml:214
2030 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2031 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2034 #. type: Content of: <refentry><refnamediv><refpurpose>
2035 #: apt-cdrom.8.xml:34
2036 msgid "APT CD-ROM management utility"
2039 #. type: Content of: <refentry><refsect1><para>
2040 #: apt-cdrom.8.xml:40
2042 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2043 "available sources. <command>apt-cdrom</command> takes care of determining "
2044 "the structure of the disc as well as correcting for several possible "
2045 "mis-burns and verifying the index files."
2048 #. type: Content of: <refentry><refsect1><para>
2049 #: apt-cdrom.8.xml:47
2051 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2052 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2053 "must be inserted and scanned separately to account for possible mis-burns."
2056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2057 #: apt-cdrom.8.xml:58
2059 "<literal>add</literal> is used to add a new disc to the source list. It will "
2060 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2061 "to scan it and copy the index files. If the disc does not have a proper "
2062 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2066 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2067 #: apt-cdrom.8.xml:66
2069 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2070 "maintains a database of these IDs in "
2071 "<filename>&statedir;/cdroms.list</filename>"
2074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2075 #: apt-cdrom.8.xml:74
2077 "A debugging tool to report the identity of the current disc as well as the "
2081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2082 #: apt-cdrom.8.xml:87
2084 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2085 "<option>--cdrom</option> option. Configuration Item: "
2086 "<literal>Acquire::cdrom::AutoDetect</literal>."
2089 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2090 #: apt-cdrom.8.xml:95
2092 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2093 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2094 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2098 #: apt-cdrom.8.xml:104
2100 "Rename a disc; change the label of a disc or override the disc's given "
2101 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2102 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2105 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2106 #: apt-cdrom.8.xml:113
2108 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2109 "unmounting the mount point. Configuration Item: "
2110 "<literal>APT::CDROM::NoMount</literal>."
2113 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2114 #: apt-cdrom.8.xml:121
2116 "Fast Copy; Assume the package files are valid and do not check every "
2117 "package. This option should be used only if <command>apt-cdrom</command> has "
2118 "been run on this disc before and did not detect any errors. Configuration "
2119 "Item: <literal>APT::CDROM::Fast</literal>."
2122 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2123 #: apt-cdrom.8.xml:131
2125 "Thorough Package Scan; This option may be needed with some old Debian "
2126 "1.1/1.2 discs that have Package files in strange places. It takes much "
2127 "longer to scan the CD but will pick them all up."
2130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2131 #: apt-cdrom.8.xml:142
2133 "No Changes; Do not change the &sources-list; file and do not write index "
2134 "files. Everything is still checked however. Configuration Item: "
2135 "<literal>APT::CDROM::NoAct</literal>."
2138 #. type: Content of: <refentry><refsect1><para>
2139 #: apt-cdrom.8.xml:155
2140 msgid "&apt-conf;, &apt-get;, &sources-list;"
2143 #. type: Content of: <refentry><refsect1><para>
2144 #: apt-cdrom.8.xml:160
2146 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2150 #. type: Content of: <refentry><refnamediv><refpurpose>
2151 #: apt-config.8.xml:35
2152 msgid "APT Configuration Query program"
2155 #. type: Content of: <refentry><refsect1><para>
2156 #: apt-config.8.xml:41
2158 "<command>apt-config</command> is an internal program used by various "
2159 "portions of the APT suite to provide consistent configurability. It accesses "
2160 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2161 "manner that is easy to use for scripted applications."
2164 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2165 #: apt-config.8.xml:53
2167 "shell is used to access the configuration information from a shell "
2168 "script. It is given pairs of arguments, the first being a shell variable and "
2169 "the second the configuration value to query. As output it lists shell "
2170 "assignment commands for each value present. In a shell script it should be "
2174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2175 #: apt-config.8.xml:61
2179 "RES=`apt-config shell OPTS MyApp::options`\n"
2183 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2184 #: apt-config.8.xml:66
2186 "This will set the shell environment variable $OPTS to the value of "
2187 "MyApp::options with a default of <option>-f</option>."
2190 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2191 #: apt-config.8.xml:70
2193 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2194 "names, d returns directories, b returns true or false and i returns an "
2195 "integer. Each of the returns is normalized and verified internally."
2198 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2199 #: apt-config.8.xml:79
2200 msgid "Just show the contents of the configuration space."
2203 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2204 #: apt-config.8.xml:92
2206 "Include options which have an empty value. This is the default, so use "
2207 "--no-empty to remove them from the output."
2210 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2211 #: apt-config.8.xml:97
2212 msgid "%f "%v";%n"
2215 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2216 #: apt-config.8.xml:98
2218 "Defines the output of each config option. %t will be replaced with "
2219 "its individual name, %f with its full hierarchical name and %v "
2220 "with its value. Use uppercase letters and special characters in the value "
2221 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2222 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2223 "and %N by a tab. A % can be printed by using %%."
2226 #. type: Content of: <refentry><refsect1><para>
2227 #: apt-config.8.xml:112 apt-extracttemplates.1.xml:73 apt-sortpkgs.1.xml:66 apt-ftparchive.1.xml:610
2231 #. type: Content of: <refentry><refsect1><para>
2232 #: apt-config.8.xml:117
2234 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2238 #. type: Content of: <refentry><refentryinfo><author><contrib>
2239 #: apt.conf.5.xml:22
2240 msgid "Initial documentation of Debug::*."
2243 #. type: Content of: <refentry><refentryinfo><author><email>
2244 #: apt.conf.5.xml:23
2245 msgid "dburrows@debian.org"
2248 #. type: Content of: <refentry><refmeta><manvolnum>
2249 #: apt.conf.5.xml:33 apt_preferences.5.xml:27 sources.list.5.xml:28
2253 #. type: Content of: <refentry><refnamediv><refpurpose>
2254 #: apt.conf.5.xml:40
2255 msgid "Configuration file for APT"
2258 #. type: Content of: <refentry><refsect1><para>
2259 #: apt.conf.5.xml:44
2261 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2262 "by all the tools in the APT suite of tools, though it is by no means the "
2263 "only place options can be set. The suite also shares a common command line "
2264 "parser to provide a uniform environment."
2267 #. type: Content of: <refentry><refsect1><orderedlist><para>
2268 #: apt.conf.5.xml:50
2270 "When an APT tool starts up it will read the configuration files in the "
2274 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2275 #: apt.conf.5.xml:52
2277 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2281 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2282 #: apt.conf.5.xml:54
2284 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2285 "order which have either no or \"<literal>conf</literal>\" as filename "
2286 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2287 "and period (.) characters. Otherwise APT will print a notice that it has "
2288 "ignored a file, unless that file matches a pattern in the "
2289 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2290 "case it will be silently ignored."
2293 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2294 #: apt.conf.5.xml:61
2295 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2298 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2299 #: apt.conf.5.xml:63
2301 "the command line options are applied to override the configuration "
2302 "directives or to load even more configuration files."
2305 #. type: Content of: <refentry><refsect1><title>
2306 #: apt.conf.5.xml:67
2310 #. type: Content of: <refentry><refsect1><para>
2311 #: apt.conf.5.xml:68
2313 "The configuration file is organized in a tree with options organized into "
2314 "functional groups. Option specification is given with a double colon "
2315 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2316 "within the APT tool group, for the Get tool. Options do not inherit from "
2317 "their parent groups."
2320 #. type: Content of: <refentry><refsect1><para>
2321 #: apt.conf.5.xml:74
2323 "Syntactically the configuration language is modeled after what the ISC tools "
2324 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2325 "treated as comments (ignored), as well as all text between "
2326 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2327 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2328 "The quotation marks and trailing semicolon are required. The value must be "
2329 "on one line, and there is no kind of string concatenation. Values must not "
2330 "include backslashes or extra quotation marks. Option names are made up of "
2331 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2332 "opened with curly braces, like this:"
2335 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2336 #: apt.conf.5.xml:87
2341 " Assume-Yes \"true\";\n"
2342 " Fix-Broken \"true\";\n"
2347 #. type: Content of: <refentry><refsect1><para>
2348 #: apt.conf.5.xml:95
2350 "with newlines placed to make it more readable. Lists can be created by "
2351 "opening a scope and including a single string enclosed in quotes followed by "
2352 "a semicolon. Multiple entries can be included, separated by a semicolon."
2355 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2356 #: apt.conf.5.xml:100
2358 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2361 #. type: Content of: <refentry><refsect1><para>
2362 #: apt.conf.5.xml:103
2364 "In general the sample configuration file &configureindex; is a good guide "
2365 "for how it should look."
2368 #. type: Content of: <refentry><refsect1><para>
2369 #: apt.conf.5.xml:106
2371 "Case is not significant in names of configuration items, so in the previous "
2372 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2375 #. type: Content of: <refentry><refsect1><para>
2376 #: apt.conf.5.xml:109
2378 "Names for the configuration items are optional if a list is defined as can "
2379 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2380 "you don't specify a name a new entry will simply add a new option to the "
2381 "list. If you specify a name you can override the option in the same way as "
2382 "any other option by reassigning a new value to the option."
2385 #. type: Content of: <refentry><refsect1><para>
2386 #: apt.conf.5.xml:114
2388 "Two special commands are defined: <literal>#include</literal> (which is "
2389 "deprecated and not supported by alternative implementations) and "
2390 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2391 "given file, unless the filename ends in a slash, in which case the whole "
2392 "directory is included. <literal>#clear</literal> is used to erase a part of "
2393 "the configuration tree. The specified element and all its descendants are "
2394 "erased. (Note that these lines also need to end with a semicolon.)"
2397 #. type: Content of: <refentry><refsect1><para>
2398 #: apt.conf.5.xml:124
2400 "The <literal>#clear</literal> command is the only way to delete a list or a "
2401 "complete scope. Reopening a scope (or using the syntax described below with "
2402 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2403 "previously written entries. Options can only be overridden by addressing a "
2404 "new value to them - lists and scopes can't be overridden, only cleared."
2407 #. type: Content of: <refentry><refsect1><para>
2408 #: apt.conf.5.xml:132
2410 "All of the APT tools take an -o option which allows an arbitrary "
2411 "configuration directive to be specified on the command line. The syntax is a "
2412 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2413 "followed by an equals sign then the new value of the option. To append a new "
2414 "element to a list, add a trailing <literal>::</literal> to the name of the "
2415 "list. (As you might suspect, the scope syntax can't be used on the command "
2419 #. type: Content of: <refentry><refsect1><para>
2420 #: apt.conf.5.xml:140
2422 "Note that appending items to a list using <literal>::</literal> only works "
2423 "for one item per line, and that you should not use it in combination with "
2424 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2425 "syntaxes together will trigger a bug which some users unfortunately depend "
2426 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2427 "like every other option with a name. This introduces many problems; for one "
2428 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2429 "syntax in the hope of appending to a list will achieve the opposite, as only "
2430 "the last assignment for this option \"<literal>::</literal>\" will be "
2431 "used. Future versions of APT will raise errors and stop working if they "
2432 "encounter this misuse, so please correct such statements now while APT "
2433 "doesn't explicitly complain about them."
2436 #. type: Content of: <refentry><refsect1><title>
2437 #: apt.conf.5.xml:155
2438 msgid "The APT Group"
2441 #. type: Content of: <refentry><refsect1><para>
2442 #: apt.conf.5.xml:156
2444 "This group of options controls general APT behavior as well as holding the "
2445 "options for all of the tools."
2448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2449 #: apt.conf.5.xml:161
2451 "System Architecture; sets the architecture to use when fetching files and "
2452 "parsing package lists. The internal default is the architecture apt was "
2456 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2457 #: apt.conf.5.xml:168
2459 "All Architectures the system supports. For instance, CPUs implementing the "
2460 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2461 "instruction set are also able to execute binaries compiled for the "
2462 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2463 "is used when fetching files and parsing package lists. The initial default "
2464 "is always the system's native architecture "
2465 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2466 "to the default list when they are registered via <command>dpkg "
2467 "--add-architecture</command>."
2470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2471 #: apt.conf.5.xml:181
2473 "Default release to install packages from if more than one version is "
2474 "available. Contains release name, codename or release version. Examples: "
2475 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2476 "'4.0', '5.0*'. See also &apt-preferences;."
2479 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2480 #: apt.conf.5.xml:187
2482 "Ignore held packages; this global option causes the problem resolver to "
2483 "ignore held packages in its decision making."
2486 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2487 #: apt.conf.5.xml:192
2489 "Defaults to on. When turned on the autoclean feature will remove any "
2490 "packages which can no longer be downloaded from the cache. If turned off "
2491 "then packages that are locally installed are also excluded from cleaning - "
2492 "but note that APT provides no direct means to reinstall them."
2495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2496 #: apt.conf.5.xml:200
2498 "Defaults to on, which will cause APT to install essential and important "
2499 "packages as soon as possible in an install/upgrade operation, in order to "
2500 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2501 "treats an important package in the same way as an extra package: between the "
2502 "unpacking of the package A and its configuration there can be many other "
2503 "unpack or configuration calls for other unrelated packages B, C etc. If "
2504 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2505 "scripts generate an error), this results in a system state in which package "
2506 "A is unpacked but unconfigured - so any package depending on A is now no "
2507 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2510 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2511 #: apt.conf.5.xml:212
2513 "The immediate configuration marker is also applied in the potentially "
2514 "problematic case of circular dependencies, since a dependency with the "
2515 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2516 "to recognise a situation in which it is unable to perform immediate "
2517 "configuration, abort, and suggest to the user that the option should be "
2518 "temporarily deactivated in order to allow the operation to proceed. Note "
2519 "the use of the word \"theory\" here; in the real world this problem has "
2520 "rarely been encountered, in non-stable distribution versions, and was caused "
2521 "by wrong dependencies of the package in question or by a system in an "
2522 "already broken state; so you should not blindly disable this option, as the "
2523 "scenario mentioned above is not the only problem it can help to prevent in "
2527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2528 #: apt.conf.5.xml:225
2530 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2531 "option disabled you should try to explicitly <literal>install</literal> the "
2532 "package APT is unable to configure immediately; but please make sure you "
2533 "also report your problem to your distribution and to the APT team with the "
2534 "buglink below, so they can work on improving or correcting the upgrade "
2538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2539 #: apt.conf.5.xml:236
2541 "Never enable this option unless you <emphasis>really</emphasis> know what "
2542 "you are doing. It permits APT to temporarily remove an essential package to "
2543 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2544 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2545 "bug</emphasis>. This option will work if the essential packages are not "
2546 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2547 "<command>dpkg</command>, <command>dash</command> or anything that those "
2548 "packages depend on."
2551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2552 #: apt.conf.5.xml:248
2554 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2555 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2556 "the size the cache will grow to, and is therefore the amount of memory APT "
2557 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2558 "that this amount of space needs to be available for APT; otherwise it will "
2559 "likely fail ungracefully, so for memory restricted devices this value should "
2560 "be lowered while on systems with a lot of configured sources it should be "
2561 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2562 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2563 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2564 "value will be applied again and again until either the cache is big enough "
2565 "to store all information or the size of the cache reaches the "
2566 "<literal>Cache-Limit</literal>. The default of "
2567 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2568 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2572 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2573 #: apt.conf.5.xml:264
2574 msgid "Defines which packages are considered essential build dependencies."
2577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2578 #: apt.conf.5.xml:268
2580 "The Get subsection controls the &apt-get; tool; please see its documentation "
2581 "for more information about the options here."
2584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2585 #: apt.conf.5.xml:273
2587 "The Cache subsection controls the &apt-cache; tool; please see its "
2588 "documentation for more information about the options here."
2591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2592 #: apt.conf.5.xml:278
2594 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2595 "documentation for more information about the options here."
2598 #. type: Content of: <refentry><refsect1><title>
2599 #: apt.conf.5.xml:284
2600 msgid "The Acquire Group"
2603 #. type: Content of: <refentry><refsect1><para>
2604 #: apt.conf.5.xml:285
2606 "The <literal>Acquire</literal> group of options controls the download of "
2607 "packages as well as the various \"acquire methods\" responsible for the "
2608 "download itself (see also &sources-list;)."
2611 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2612 #: apt.conf.5.xml:292
2614 "Security related option defaulting to true, as giving a Release file's "
2615 "validation an expiration date prevents replay attacks over a long timescale, "
2616 "and can also for example help users to identify mirrors that are no longer "
2617 "updated - but the feature depends on the correctness of the clock on the "
2618 "user system. Archive maintainers are encouraged to create Release files with "
2619 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
2620 "value is desired the <literal>Max-ValidTime</literal> option below can be "
2624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2625 #: apt.conf.5.xml:305
2627 "Maximum time (in seconds) after its creation (as indicated by the "
2628 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2629 "should be considered valid. If the Release file itself includes a "
2630 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
2631 "the expiration date. The default value is <literal>0</literal> which stands "
2632 "for \"valid forever\". Archive specific settings can be made by appending "
2633 "the label of the archive to the option name."
2636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2637 #: apt.conf.5.xml:317
2639 "Minimum time (in seconds) after its creation (as indicated by the "
2640 "<literal>Date</literal> header) that the <filename>Release</filename> file "
2641 "should be considered valid. Use this if you need to use a seldom updated "
2642 "(local) mirror of a more frequently updated archive with a "
2643 "<literal>Valid-Until</literal> header instead of completely disabling the "
2644 "expiration date checking. Archive specific settings can and should be used "
2645 "by appending the label of the archive to the option name."
2648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2649 #: apt.conf.5.xml:329
2651 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
2652 "<filename>Packages</filename> files) instead of downloading whole ones. True "
2656 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2657 #: apt.conf.5.xml:332
2659 "Two sub-options to limit the use of PDiffs are also available: "
2660 "<literal>FileLimit</literal> can be used to specify a maximum number of "
2661 "PDiff files should be downloaded to update a "
2662 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
2663 "percentage of the size of all patches compared to the size of the targeted "
2664 "file. If one of these limits is exceeded the complete file is downloaded "
2665 "instead of the patches."
2668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2669 #: apt.conf.5.xml:342
2671 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
2672 "<literal>host</literal> or <literal>access</literal> which determines how "
2673 "APT parallelizes outgoing connections. <literal>host</literal> means that "
2674 "one connection per target host will be opened, <literal>access</literal> "
2675 "means that one connection per URI type will be opened."
2678 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2679 #: apt.conf.5.xml:350
2681 "Number of retries to perform. If this is non-zero APT will retry failed "
2682 "files the given number of times."
2685 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2686 #: apt.conf.5.xml:355
2688 "Use symlinks for source archives. If set to true then source archives will "
2689 "be symlinked when possible instead of copying. True is the default."
2692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2693 #: apt.conf.5.xml:360
2695 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
2696 "URIs. It is in the standard form of "
2697 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
2698 "can also be specified by using the form "
2699 "<literal>http::Proxy::<host></literal> with the special keyword "
2700 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2701 "settings is specified, <envar>http_proxy</envar> environment variable will "
2705 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2706 #: apt.conf.5.xml:368
2708 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
2709 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
2710 "response under any circumstances. <literal>Max-Age</literal> sets the "
2711 "allowed maximum age (in seconds) of an index file in the cache of the "
2712 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
2713 "store the requested archive files in its cache, which can be used to prevent "
2714 "the proxy from polluting its cache with (big) .deb files."
2717 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2718 #: apt.conf.5.xml:378 apt.conf.5.xml:466
2720 "The option <literal>timeout</literal> sets the timeout timer used by the "
2721 "method; this value applies to the connection as well as the data timeout."
2724 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2725 #: apt.conf.5.xml:381
2727 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
2728 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
2729 "e.g. on high-latency connections. It specifies how many requests are sent in "
2730 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
2731 "the default value is now 0 (= disabled) to avoid problems with the "
2732 "ever-growing amount of webservers and proxies which choose to not conform to "
2733 "the HTTP/1.1 specification."
2736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2737 #: apt.conf.5.xml:388
2739 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
2740 "follow redirects, which is enabled by default."
2743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2744 #: apt.conf.5.xml:391
2746 "The used bandwidth can be limited with "
2747 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
2748 "kilobytes per second. The default value is 0 which deactivates the limit and "
2749 "tries to use all available bandwidth. Note that this option implicitly "
2750 "disables downloading from multiple servers at the same time."
2753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2754 #: apt.conf.5.xml:398
2756 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
2757 "User-Agent for the http download method as some proxies allow access for "
2758 "clients only if the client uses a known identifier."
2761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2762 #: apt.conf.5.xml:402
2764 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
2765 "an external command to discover the http proxy to use. Apt expects the "
2766 "command to output the proxy on stdout in the style "
2767 "<literal>http://proxy:port/</literal>. This will override the generic "
2768 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
2769 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
2770 "the &squid-deb-proxy-client; package for an example implementation that uses "
2771 "avahi. This option takes precedence over the legacy option name "
2772 "<literal>ProxyAutoDetect</literal>."
2775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2776 #: apt.conf.5.xml:420
2778 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
2779 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
2780 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
2781 "the <literal>http</literal> method, and default to the same values if they "
2782 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
2786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2787 #: apt.conf.5.xml:428
2789 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
2790 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
2791 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
2792 "suboption determines whether or not the server's host certificate should be "
2793 "verified against trusted certificates. "
2794 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
2795 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
2796 "or not the server's hostname should be verified. "
2797 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
2798 "option. <literal>SslCert</literal> determines what certificate to use for "
2799 "client authentication. <literal><host>::SslCert</literal> is the "
2800 "corresponding per-host option. <literal>SslKey</literal> determines what "
2801 "private key to use for client "
2802 "authentication. <literal><host>::SslKey</literal> is the corresponding "
2803 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
2804 "version to use. It can contain either of the strings "
2805 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
2806 "<literal><host>::SslForceVersion</literal> is the corresponding "
2810 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2811 #: apt.conf.5.xml:449
2813 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
2814 "It is in the standard form of "
2815 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
2816 "also be specified by using the form "
2817 "<literal>ftp::Proxy::<host></literal> with the special keyword "
2818 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
2819 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
2820 "used. To use an FTP proxy you will have to set the "
2821 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
2822 "entry specifies the commands to send to tell the proxy server what to "
2823 "connect to. Please see &configureindex; for an example of how to do "
2824 "this. The substitution variables representing the corresponding URI "
2825 "component are <literal>$(PROXY_USER)</literal>, "
2826 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
2827 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
2828 "<literal>$(SITE_PORT)</literal>."
2831 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2832 #: apt.conf.5.xml:469
2834 "Several settings are provided to control passive mode. Generally it is safe "
2835 "to leave passive mode on; it works in nearly every environment. However, "
2836 "some situations require that passive mode be disabled and port mode FTP used "
2837 "instead. This can be done globally or for connections that go through a "
2838 "proxy or for a specific host (see the sample config file for examples)."
2841 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2842 #: apt.conf.5.xml:476
2844 "It is possible to proxy FTP over HTTP by setting the "
2845 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
2846 "discussion of the http method above for syntax. You cannot set this in the "
2847 "configuration file and it is not recommended to use FTP over HTTP due to its "
2851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2852 #: apt.conf.5.xml:481
2854 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
2855 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
2856 "false, which means these commands are only used if the control connection is "
2857 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
2858 "that most FTP servers do not support RFC2428."
2861 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2862 #: apt.conf.5.xml:495
2864 msgid "/cdrom/::Mount \"foo\";"
2867 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2868 #: apt.conf.5.xml:490
2870 "For URIs using the <literal>cdrom</literal> method, the only configurable "
2871 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
2872 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
2873 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
2874 "and unmount commands if your mount point cannot be listed in the fstab. The "
2875 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
2876 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
2877 "Unmount commands can be specified using UMount."
2880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2881 #: apt.conf.5.xml:503
2883 "For GPGV URIs the only configurable option is "
2884 "<literal>gpgv::Options</literal>, which passes additional parameters to "
2888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2889 #: apt.conf.5.xml:514
2892 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
2893 "\"<replaceable>Methodname</replaceable>\";"
2896 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2897 #: apt.conf.5.xml:509
2899 "List of compression types which are understood by the acquire methods. "
2900 "Files like <filename>Packages</filename> can be available in various "
2901 "compression formats. By default the acquire methods can decompress "
2902 "<command>bzip2</command>, <command>lzma</command> and "
2903 "<command>gzip</command> compressed files; with this setting more formats can "
2904 "be added on the fly or the used method can be changed. The syntax for this "
2905 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
2908 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2909 #: apt.conf.5.xml:519
2911 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
2914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
2915 #: apt.conf.5.xml:522
2917 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
2920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2921 #: apt.conf.5.xml:515
2923 "Also, the <literal>Order</literal> subgroup can be used to define in which "
2924 "order the acquire system will try to download the compressed files. The "
2925 "acquire system will try the first and proceed with the next compression type "
2926 "in this list on error, so to prefer one over the other type simply add the "
2927 "preferred type first - default types not already added will be implicitly "
2928 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
2929 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
2930 "over <command>bzip2</command> and <command>lzma</command>. If "
2931 "<command>lzma</command> should be preferred over <command>gzip</command> and "
2932 "<command>bzip2</command> the configure setting should look like this: "
2933 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
2934 "<literal>bz2</literal> to the list explicitly as it will be added "
2938 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
2939 #: apt.conf.5.xml:529
2941 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
2944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2945 #: apt.conf.5.xml:524
2948 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
2949 "checked at run time. If this option has been set, the method will only be "
2950 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
2951 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
2952 "also that list entries specified on the command line will be added at the "
2953 "end of the list specified in the configuration files, but before the default "
2954 "entries. To prefer a type in this case over the ones specified in the "
2955 "configuration files you can set the option direct - not in list style. This "
2956 "will not override the defined list; it will only prefix the list with this "
2960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2961 #: apt.conf.5.xml:534
2963 "The special type <literal>uncompressed</literal> can be used to give "
2964 "uncompressed files a preference, but note that most archives don't provide "
2965 "uncompressed files so this is mostly only useable for local mirrors."
2968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2969 #: apt.conf.5.xml:541
2971 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
2972 "Sources, or Translations), keep them gzip compressed locally instead of "
2973 "unpacking them. This saves quite a lot of disk space at the expense of more "
2974 "CPU requirements when building the local package caches. False by default."
2977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2978 #: apt.conf.5.xml:549
2980 "The Languages subsection controls which <filename>Translation</filename> "
2981 "files are downloaded and in which order APT tries to display the "
2982 "description-translations. APT will try to display the first available "
2983 "description in the language which is listed first. Languages can be defined "
2984 "with their short or long language codes. Note that not all archives provide "
2985 "<filename>Translation</filename> files for every language - the long "
2986 "language codes are especially rare."
2989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
2990 #: apt.conf.5.xml:566
2992 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
2995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2996 #: apt.conf.5.xml:554
2998 "The default list includes \"environment\" and "
2999 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3000 "will be replaced at runtime with the language codes extracted from the "
3001 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3002 "that these codes are not included twice in the list. If "
3003 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3004 "<filename>Translation-en</filename> file (if available) will be used. To "
3005 "force APT to use no Translation file use the setting "
3006 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3007 "another special meaning code which will stop the search for a suitable "
3008 "<filename>Translation</filename> file. This tells APT to download these "
3009 "translations too, without actually using them unless the environment "
3010 "specifies the languages. So the following example configuration will result "
3011 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3012 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3013 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3014 "type=\"programlisting\" id=\"0\"/>"
3017 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3018 #: apt.conf.5.xml:567
3020 "Note: To prevent problems resulting from APT being executed in different "
3021 "environments (e.g. by different users or by other programs) all Translation "
3022 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3023 "added to the end of the list (after an implicit "
3024 "\"<literal>none</literal>\")."
3027 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3028 #: apt.conf.5.xml:576
3029 msgid "When downloading, force to use only the IPv4 protocol."
3032 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3033 #: apt.conf.5.xml:582
3034 msgid "When downloading, force to use only the IPv6 protocol."
3037 #. type: Content of: <refentry><refsect1><title>
3038 #: apt.conf.5.xml:589
3042 #. type: Content of: <refentry><refsect1><para>
3043 #: apt.conf.5.xml:591
3045 "The <literal>Dir::State</literal> section has directories that pertain to "
3046 "local state information. <literal>lists</literal> is the directory to place "
3047 "downloaded package lists in and <literal>status</literal> is the name of the "
3048 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3049 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3050 "contains the default directory to prefix on all sub-items if they do not "
3051 "start with <filename>/</filename> or <filename>./</filename>."
3054 #. type: Content of: <refentry><refsect1><para>
3055 #: apt.conf.5.xml:598
3057 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3058 "information, such as the two package caches <literal>srcpkgcache</literal> "
3059 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3060 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3061 "be turned off by setting their names to the empty string. This will slow "
3062 "down startup but save disk space. It is probably preferable to turn off the "
3063 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3064 "default directory is contained in <literal>Dir::Cache</literal>"
3067 #. type: Content of: <refentry><refsect1><para>
3068 #: apt.conf.5.xml:607
3070 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3071 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3072 "<literal>main</literal> is the default configuration file (setting has no "
3073 "effect, unless it is done from the config file specified by "
3074 "<envar>APT_CONFIG</envar>)."
3077 #. type: Content of: <refentry><refsect1><para>
3078 #: apt.conf.5.xml:613
3080 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3081 "in lexical order from the directory specified. After this is done then the "
3082 "main config file is loaded."
3085 #. type: Content of: <refentry><refsect1><para>
3086 #: apt.conf.5.xml:617
3088 "Binary programs are pointed to by "
3089 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3090 "the location of the method handlers and <literal>gzip</literal>, "
3091 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3092 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3093 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3094 "specify the location of the respective programs."
3097 #. type: Content of: <refentry><refsect1><para>
3098 #: apt.conf.5.xml:625
3100 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3101 "set, all paths in <literal>Dir::</literal> will be relative to "
3102 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3103 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3104 "set to <filename>/tmp/staging</filename> and "
3105 "<literal>Dir::State::status</literal> is set to "
3106 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3107 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
3110 #. type: Content of: <refentry><refsect1><para>
3111 #: apt.conf.5.xml:638
3113 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3114 "which files APT should silently ignore while parsing the files in the "
3115 "fragment directories. Per default a file which end with "
3116 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3117 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3118 "default value these patterns can use regular expression syntax."
3121 #. type: Content of: <refentry><refsect1><title>
3122 #: apt.conf.5.xml:647
3123 msgid "APT in DSelect"
3126 #. type: Content of: <refentry><refsect1><para>
3127 #: apt.conf.5.xml:649
3129 "When APT is used as a &dselect; method several configuration directives "
3130 "control the default behavior. These are in the <literal>DSelect</literal> "
3134 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3135 #: apt.conf.5.xml:654
3137 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3138 "<literal>prompt</literal>, <literal>auto</literal>, "
3139 "<literal>pre-auto</literal> and <literal>never</literal>. "
3140 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3141 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3142 "default) does so conditionally. <literal>auto</literal> removes only those "
3143 "packages which are no longer downloadable (replaced with a new version for "
3144 "instance). <literal>pre-auto</literal> performs this action before "
3145 "downloading new packages."
3148 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3149 #: apt.conf.5.xml:668
3151 "The contents of this variable are passed to &apt-get; as command line "
3152 "options when it is run for the install phase."
3155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3156 #: apt.conf.5.xml:673
3158 "The contents of this variable are passed to &apt-get; as command line "
3159 "options when it is run for the update phase."
3162 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3163 #: apt.conf.5.xml:678
3165 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3166 "The default is to prompt only on error."
3169 #. type: Content of: <refentry><refsect1><title>
3170 #: apt.conf.5.xml:684
3171 msgid "How APT calls &dpkg;"
3174 #. type: Content of: <refentry><refsect1><para>
3175 #: apt.conf.5.xml:685
3177 "Several configuration directives control how APT invokes &dpkg;. These are "
3178 "in the <literal>DPkg</literal> section."
3181 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3182 #: apt.conf.5.xml:690
3184 "This is a list of options to pass to &dpkg;. The options must be specified "
3185 "using the list notation and each list item is passed as a single argument to "
3189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3190 #: apt.conf.5.xml:696
3192 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3193 "<literal>options</literal> this must be specified in list notation. The "
3194 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3195 "fail APT will abort."
3198 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3199 #: apt.conf.5.xml:703
3201 "This is a list of shell commands to run before invoking &dpkg;. Like "
3202 "<literal>options</literal> this must be specified in list notation. The "
3203 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3204 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3205 "going to install to the commands, one per line on the requested file "
3206 "descriptor, defaulting to standard input."
3209 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3210 #: apt.conf.5.xml:710
3212 "Version 2 of this protocol dumps more information, including the protocol "
3213 "version, the APT configuration space and the packages, files and versions "
3214 "being changed. Version 3 adds the architecture and "
3215 "<literal>MultiArch</literal> flag to each version being dumped."
3218 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3219 #: apt.conf.5.xml:715
3221 "The version of the protocol to be used for the command "
3222 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3223 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3224 "accordingly, the default being version 1. If APT isn't supporting the "
3225 "requested version it will send the information in the highest version it has "
3226 "support for instead."
3229 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3230 #: apt.conf.5.xml:722
3232 "The file descriptor to be used to send the information can be requested with "
3233 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3234 "which defaults to <literal>0</literal> for standard input and is available "
3235 "since version 0.9.11. Support for the option can be detected by looking for "
3236 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3237 "number of the used file descriptor as a confirmation."
3240 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3241 #: apt.conf.5.xml:732
3243 "APT chdirs to this directory before invoking &dpkg;, the default is "
3244 "<filename>/</filename>."
3247 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3248 #: apt.conf.5.xml:737
3250 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3251 "default is to disable signing and produce all binaries."
3254 #. type: Content of: <refentry><refsect1><refsect2><title>
3255 #: apt.conf.5.xml:742
3256 msgid "dpkg trigger usage (and related options)"
3259 #. type: Content of: <refentry><refsect1><refsect2><para>
3260 #: apt.conf.5.xml:743
3262 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3263 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3264 "use triggers once each time it runs. Activating these options can therefore "
3265 "decrease the time needed to perform the install or upgrade. Note that it is "
3266 "intended to activate these options per default in the future, but as it "
3267 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3268 "<emphasis>These options are therefore currently experimental and should not "
3269 "be used in production environments.</emphasis> It also breaks progress "
3270 "reporting such that all front-ends will currently stay around half (or more) "
3271 "of the time in the 100% state while it actually configures all packages."
3274 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3275 #: apt.conf.5.xml:758
3278 "DPkg::NoTriggers \"true\";\n"
3279 "PackageManager::Configure \"smart\";\n"
3280 "DPkg::ConfigurePending \"true\";\n"
3281 "DPkg::TriggersPending \"true\";"
3284 #. type: Content of: <refentry><refsect1><refsect2><para>
3285 #: apt.conf.5.xml:752
3287 "Note that it is not guaranteed that APT will support these options or that "
3288 "these options will not cause (big) trouble in the future. If you have "
3289 "understand the current risks and problems with these options, but are brave "
3290 "enough to help testing them, create a new configuration file and test a "
3291 "combination of options. Please report any bugs, problems and improvements "
3292 "you encounter and make sure to note which options you have used in your "
3293 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3294 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3295 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3298 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3299 #: apt.conf.5.xml:765
3301 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3302 "call). See &dpkg; if you are interested in what this actually means. In "
3303 "short: &dpkg; will not run the triggers when this flag is present unless it "
3304 "is explicitly called to do so in an extra call. Note that this option "
3305 "exists (undocumented) also in older APT versions with a slightly different "
3306 "meaning: Previously these option only append --no-triggers to the configure "
3307 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3311 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3312 #: apt.conf.5.xml:773
3314 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3315 "and \"<literal>no</literal>\". The default value is "
3316 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3317 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3318 "be configured before another package can be unpacked (Pre-Depends), and let "
3319 "the rest be configured by &dpkg; with a call generated by the "
3320 "ConfigurePending option (see below). On the other hand, "
3321 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3322 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3323 "encountered). Setting this option to any value other than "
3324 "<literal>all</literal> will implicitly also activate the next option by "
3325 "default, as otherwise the system could end in an unconfigured and "
3326 "potentially unbootable state."
3329 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3330 #: apt.conf.5.xml:788
3332 "If this option is set APT will call <command>dpkg --configure "
3333 "--pending</command> to let &dpkg; handle all required configurations and "
3334 "triggers. This option is activated automatically per default if the previous "
3335 "option is not set to <literal>all</literal>, but deactivating it could be "
3336 "useful if you want to run APT multiple times in a row - e.g. in an "
3337 "installer. In these sceneries you could deactivate this option in all but "
3341 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3342 #: apt.conf.5.xml:795
3344 "Useful for the <literal>smart</literal> configuration as a package which has "
3345 "pending triggers is not considered as <literal>installed</literal>, and "
3346 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3347 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3348 "process all triggers, not only the triggers needed to configure this "
3352 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3353 #: apt.conf.5.xml:808
3356 "OrderList::Score {\n"
3358 "\tEssential 200;\n"
3360 "\tPreDepends 50;\n"
3364 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3365 #: apt.conf.5.xml:801
3367 "Essential packages (and their dependencies) should be configured immediately "
3368 "after unpacking. It is a good idea to do this quite early in the upgrade "
3369 "process as these configure calls also currently require "
3370 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3371 "(which may not be needed). Essentials get per default a high score but the "
3372 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3373 "higher). These option and the others in the same group can be used to "
3374 "change the scoring. The following example shows the settings with their "
3375 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3378 #. type: Content of: <refentry><refsect1><title>
3379 #: apt.conf.5.xml:821
3380 msgid "Periodic and Archives options"
3383 #. type: Content of: <refentry><refsect1><para>
3384 #: apt.conf.5.xml:822
3386 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3387 "of options configure behavior of apt periodic updates, which is done by the "
3388 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3389 "for the brief documentation of these options."
3392 #. type: Content of: <refentry><refsect1><title>
3393 #: apt.conf.5.xml:830
3394 msgid "Debug options"
3397 #. type: Content of: <refentry><refsect1><para>
3398 #: apt.conf.5.xml:832
3400 "Enabling options in the <literal>Debug::</literal> section will cause "
3401 "debugging information to be sent to the standard error stream of the program "
3402 "utilizing the <literal>apt</literal> libraries, or enable special program "
3403 "modes that are primarily useful for debugging the behavior of "
3404 "<literal>apt</literal>. Most of these options are not interesting to a "
3405 "normal user, but a few may be:"
3408 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3409 #: apt.conf.5.xml:843
3411 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3412 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3416 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3417 #: apt.conf.5.xml:851
3419 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3420 "used to run some operations (for instance, <literal>apt-get -s "
3421 "install</literal>) as a non-root user."
3424 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3425 #: apt.conf.5.xml:860
3427 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3428 "time that <literal>apt</literal> invokes &dpkg;."
3432 #. motivating example, except I haven't a clue why you'd want
3434 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3435 #: apt.conf.5.xml:868
3437 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3441 #. type: Content of: <refentry><refsect1><para>
3442 #: apt.conf.5.xml:878
3443 msgid "A full list of debugging options to apt follows."
3446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3447 #: apt.conf.5.xml:887
3448 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3452 #: apt.conf.5.xml:898
3453 msgid "Print information related to downloading packages using FTP."
3456 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3457 #: apt.conf.5.xml:909
3458 msgid "Print information related to downloading packages using HTTP."
3461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3462 #: apt.conf.5.xml:920
3463 msgid "Print information related to downloading packages using HTTPS."
3466 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3467 #: apt.conf.5.xml:931
3469 "Print information related to verifying cryptographic signatures using "
3470 "<literal>gpg</literal>."
3473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3474 #: apt.conf.5.xml:942
3476 "Output information about the process of accessing collections of packages "
3477 "stored on CD-ROMs."
3480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3481 #: apt.conf.5.xml:952
3482 msgid "Describes the process of resolving build-dependencies in &apt-get;."
3485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3486 #: apt.conf.5.xml:962
3488 "Output each cryptographic hash that is generated by the "
3489 "<literal>apt</literal> libraries."
3492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3493 #: apt.conf.5.xml:972
3495 "Do not include information from <literal>statfs</literal>, namely the number "
3496 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
3500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3501 #: apt.conf.5.xml:983
3503 "Disable all file locking. For instance, this will allow two instances of "
3504 "<quote><literal>apt-get update</literal></quote> to run at the same time."
3507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3508 #: apt.conf.5.xml:995
3509 msgid "Log when items are added to or removed from the global download queue."
3512 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3513 #: apt.conf.5.xml:1005
3515 "Output status messages and errors related to verifying checksums and "
3516 "cryptographic signatures of downloaded files."
3519 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3520 #: apt.conf.5.xml:1015
3522 "Output information about downloading and applying package index list diffs, "
3523 "and errors relating to package index list diffs."
3526 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3527 #: apt.conf.5.xml:1027
3529 "Output information related to patching apt package lists when downloading "
3530 "index diffs instead of full indices."
3533 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3534 #: apt.conf.5.xml:1038
3535 msgid "Log all interactions with the sub-processes that actually perform downloads."
3538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3539 #: apt.conf.5.xml:1049
3541 "Log events related to the automatically-installed status of packages and to "
3542 "the removal of unused packages."
3545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3546 #: apt.conf.5.xml:1059
3548 "Generate debug messages describing which packages are being automatically "
3549 "installed to resolve dependencies. This corresponds to the initial "
3550 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
3551 "and not to the full <literal>apt</literal> dependency resolver; see "
3552 "<literal>Debug::pkgProblemResolver</literal> for that."
3555 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3556 #: apt.conf.5.xml:1073
3558 "Generate debug messages describing which packages are marked as "
3559 "keep/install/remove while the ProblemResolver does his work. Each addition "
3560 "or deletion may trigger additional actions; they are shown indented two "
3561 "additional spaces under the original entry. The format for each line is "
3562 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
3563 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
3564 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
3565 "is the current version of the package, <literal>d.e.f</literal> is the "
3566 "version considered for installation and <literal>x.y.z</literal> is a newer "
3567 "version, but not considered for installation (because of a low pin "
3568 "score). The later two can be omitted if there is none or if it is the same "
3569 "as the installed version. <literal>section</literal> is the name of the "
3570 "section the package appears in."
3573 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3574 #: apt.conf.5.xml:1094
3576 "When invoking &dpkg;, output the precise command line with which it is being "
3577 "invoked, with arguments separated by a single space character."
3580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3581 #: apt.conf.5.xml:1105
3583 "Output all the data received from &dpkg; on the status file descriptor and "
3584 "any errors encountered while parsing it."
3587 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3588 #: apt.conf.5.xml:1116
3590 "Generate a trace of the algorithm that decides the order in which "
3591 "<literal>apt</literal> should pass packages to &dpkg;."
3594 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3595 #: apt.conf.5.xml:1128
3596 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
3599 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3600 #: apt.conf.5.xml:1139
3601 msgid "Output the priority of each package list on startup."
3604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3605 #: apt.conf.5.xml:1149
3607 "Trace the execution of the dependency resolver (this applies only to what "
3608 "happens when a complex dependency problem is encountered)."
3611 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3612 #: apt.conf.5.xml:1160
3614 "Display a list of all installed packages with their calculated score used by "
3615 "the pkgProblemResolver. The description of the package is the same as "
3616 "described in <literal>Debug::pkgDepCache::Marker</literal>"
3619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3620 #: apt.conf.5.xml:1172
3622 "Print information about the vendors read from "
3623 "<filename>/etc/apt/vendors.list</filename>."
3626 #. type: Content of: <refentry><refsect1><title>
3627 #: apt.conf.5.xml:1194 apt_preferences.5.xml:547 sources.list.5.xml:217 apt-ftparchive.1.xml:598
3631 #. type: Content of: <refentry><refsect1><para>
3632 #: apt.conf.5.xml:1195
3634 "&configureindex; is a configuration file showing example values for all "
3638 #. ? reading apt.conf
3639 #. type: Content of: <refentry><refsect1><para>
3640 #: apt.conf.5.xml:1207
3641 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
3644 #. type: Content of: <refentry><refnamediv><refpurpose>
3645 #: apt_preferences.5.xml:34
3646 msgid "Preference control file for APT"
3649 #. type: Content of: <refentry><refsect1><para>
3650 #: apt_preferences.5.xml:39
3652 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
3653 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
3654 "can be used to control which versions of packages will be selected for "
3658 #. type: Content of: <refentry><refsect1><para>
3659 #: apt_preferences.5.xml:44
3661 "Several versions of a package may be available for installation when the "
3662 "&sources-list; file contains references to more than one distribution (for "
3663 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
3664 "assigns a priority to each version that is available. Subject to dependency "
3665 "constraints, <command>apt-get</command> selects the version with the highest "
3666 "priority for installation. The APT preferences override the priorities that "
3667 "APT assigns to package versions by default, thus giving the user control "
3668 "over which one is selected for installation."
3671 #. type: Content of: <refentry><refsect1><para>
3672 #: apt_preferences.5.xml:54
3674 "Several instances of the same version of a package may be available when the "
3675 "&sources-list; file contains references to more than one source. In this "
3676 "case <command>apt-get</command> downloads the instance listed earliest in "
3677 "the &sources-list; file. The APT preferences do not affect the choice of "
3678 "instance, only the choice of version."
3681 #. type: Content of: <refentry><refsect1><para>
3682 #: apt_preferences.5.xml:61
3684 "Preferences are a strong power in the hands of a system administrator but "
3685 "they can become also their biggest nightmare if used without care! APT will "
3686 "not question the preferences, so wrong settings can lead to uninstallable "
3687 "packages or wrong decisions while upgrading packages. Even more problems "
3688 "will arise if multiple distribution releases are mixed without a good "
3689 "understanding of the following paragraphs. Packages included in a specific "
3690 "release aren't tested in (and therefore don't always work as expected in) "
3691 "older or newer releases, or together with other packages from different "
3692 "releases. You have been warned."
3695 #. type: Content of: <refentry><refsect1><para>
3696 #: apt_preferences.5.xml:72
3698 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
3699 "directory are parsed in alphanumeric ascending order and need to obey the "
3700 "following naming convention: The files have either no or "
3701 "\"<literal>pref</literal>\" as filename extension and only contain "
3702 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
3703 "Otherwise APT will print a notice that it has ignored a file, unless that "
3704 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
3705 "configuration list - in which case it will be silently ignored."
3708 #. type: Content of: <refentry><refsect1><refsect2><title>
3709 #: apt_preferences.5.xml:81
3710 msgid "APT's Default Priority Assignments"
3713 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3714 #: apt_preferences.5.xml:96
3717 "<command>apt-get install -t testing "
3718 "<replaceable>some-package</replaceable></command>\n"
3721 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
3722 #: apt_preferences.5.xml:99
3724 msgid "APT::Default-Release \"stable\";\n"
3727 #. type: Content of: <refentry><refsect1><refsect2><para>
3728 #: apt_preferences.5.xml:83
3730 "If there is no preferences file or if there is no entry in the file that "
3731 "applies to a particular version then the priority assigned to that version "
3732 "is the priority of the distribution to which that version belongs. It is "
3733 "possible to single out a distribution, \"the target release\", which "
3734 "receives a higher priority than other distributions do by default. The "
3735 "target release can be set on the <command>apt-get</command> command line or "
3736 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
3737 "that this has precedence over any general priority you set in the "
3738 "<filename>/etc/apt/preferences</filename> file described later, but not over "
3739 "specifically pinned packages. For example, <placeholder "
3740 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
3744 #. type: Content of: <refentry><refsect1><refsect2><para>
3745 #: apt_preferences.5.xml:103
3747 "If the target release has been specified then APT uses the following "
3748 "algorithm to set the priorities of the versions of a package. Assign:"
3751 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3752 #: apt_preferences.5.xml:108
3756 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3757 #: apt_preferences.5.xml:109
3759 "to the versions coming from archives which in their "
3760 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
3761 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
3762 "<literal>experimental</literal> archive."
3765 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3766 #: apt_preferences.5.xml:115
3767 msgid "priority 100"
3770 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3771 #: apt_preferences.5.xml:116
3773 "to the version that is already installed (if any) and to the versions coming "
3774 "from archives which in their <filename>Release</filename> files are marked "
3775 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
3776 "backports archive since <literal>squeeze-backports</literal>."
3779 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3780 #: apt_preferences.5.xml:123
3781 msgid "priority 500"
3784 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3785 #: apt_preferences.5.xml:124
3787 "to the versions that are not installed and do not belong to the target "
3791 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
3792 #: apt_preferences.5.xml:128
3793 msgid "priority 990"
3796 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
3797 #: apt_preferences.5.xml:129
3798 msgid "to the versions that are not installed and belong to the target release."
3801 #. type: Content of: <refentry><refsect1><refsect2><para>
3802 #: apt_preferences.5.xml:134
3804 "If the target release has not been specified then APT simply assigns "
3805 "priority 100 to all installed package versions and priority 500 to all "
3806 "uninstalled package versions, except versions coming from archives which in "
3807 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
3808 "- these versions get the priority 1 or priority 100 if it is additionally "
3809 "marked as \"ButAutomaticUpgrades: yes\"."
3812 #. type: Content of: <refentry><refsect1><refsect2><para>
3813 #: apt_preferences.5.xml:141
3815 "APT then applies the following rules, listed in order of precedence, to "
3816 "determine which version of a package to install."
3819 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3820 #: apt_preferences.5.xml:144
3822 "Never downgrade unless the priority of an available version exceeds 1000. "
3823 "(\"Downgrading\" is installing a less recent version of a package in place "
3824 "of a more recent version. Note that none of APT's default priorities "
3825 "exceeds 1000; such high priorities can only be set in the preferences file. "
3826 "Note also that downgrading a package can be risky.)"
3829 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3830 #: apt_preferences.5.xml:150
3831 msgid "Install the highest priority version."
3834 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3835 #: apt_preferences.5.xml:151
3837 "If two or more versions have the same priority, install the most recent one "
3838 "(that is, the one with the higher version number)."
3841 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3842 #: apt_preferences.5.xml:154
3844 "If two or more versions have the same priority and version number but either "
3845 "the packages differ in some of their metadata or the "
3846 "<literal>--reinstall</literal> option is given, install the uninstalled one."
3849 #. type: Content of: <refentry><refsect1><refsect2><para>
3850 #: apt_preferences.5.xml:160
3852 "In a typical situation, the installed version of a package (priority 100) "
3853 "is not as recent as one of the versions available from the sources listed in "
3854 "the &sources-list; file (priority 500 or 990). Then the package will be "
3855 "upgraded when <command>apt-get install "
3856 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3857 "upgrade</command> is executed."
3860 #. type: Content of: <refentry><refsect1><refsect2><para>
3861 #: apt_preferences.5.xml:167
3863 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
3864 "recent than any of the other available versions. The package will not be "
3865 "downgraded when <command>apt-get install "
3866 "<replaceable>some-package</replaceable></command> or <command>apt-get "
3867 "upgrade</command> is executed."
3870 #. type: Content of: <refentry><refsect1><refsect2><para>
3871 #: apt_preferences.5.xml:172
3873 "Sometimes the installed version of a package is more recent than the version "
3874 "belonging to the target release, but not as recent as a version belonging to "
3875 "some other distribution. Such a package will indeed be upgraded when "
3876 "<command>apt-get install <replaceable>some-package</replaceable></command> "
3877 "or <command>apt-get upgrade</command> is executed, because at least "
3878 "<emphasis>one</emphasis> of the available versions has a higher priority "
3879 "than the installed version."
3882 #. type: Content of: <refentry><refsect1><refsect2><title>
3883 #: apt_preferences.5.xml:181
3884 msgid "The Effect of APT Preferences"
3887 #. type: Content of: <refentry><refsect1><refsect2><para>
3888 #: apt_preferences.5.xml:183
3890 "The APT preferences file allows the system administrator to control the "
3891 "assignment of priorities. The file consists of one or more multi-line "
3892 "records separated by blank lines. Records can have one of two forms, a "
3893 "specific form and a general form."
3896 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3897 #: apt_preferences.5.xml:189
3899 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
3900 "specified packages with a specified version or version range. For example, "
3901 "the following record assigns a high priority to all versions of the "
3902 "<filename>perl</filename> package whose version number begins with "
3903 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
3907 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3908 #: apt_preferences.5.xml:196
3912 "Pin: version &good-perl;*\n"
3913 "Pin-Priority: 1001\n"
3916 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3917 #: apt_preferences.5.xml:202
3919 "The general form assigns a priority to all of the package versions in a "
3920 "given distribution (that is, to all the versions of packages that are listed "
3921 "in a certain <filename>Release</filename> file) or to all of the package "
3922 "versions coming from a particular Internet site, as identified by the site's "
3923 "fully qualified domain name."
3926 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3927 #: apt_preferences.5.xml:208
3929 "This general-form entry in the APT preferences file applies only to groups "
3930 "of packages. For example, the following record assigns a high priority to "
3931 "all package versions available from the local site."
3934 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3935 #: apt_preferences.5.xml:213
3939 "Pin: origin \"\"\n"
3940 "Pin-Priority: 999\n"
3943 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3944 #: apt_preferences.5.xml:218
3946 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
3947 "which can be used to match a hostname. The following record will assign a "
3948 "high priority to all versions available from the server identified by the "
3949 "hostname \"ftp.de.debian.org\""
3952 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3953 #: apt_preferences.5.xml:222
3957 "Pin: origin \"ftp.de.debian.org\"\n"
3958 "Pin-Priority: 999\n"
3961 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3962 #: apt_preferences.5.xml:226
3964 "This should <emphasis>not</emphasis> be confused with the Origin of a "
3965 "distribution as specified in a <filename>Release</filename> file. What "
3966 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
3967 "Internet address but an author or vendor name, such as \"Debian\" or "
3971 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3972 #: apt_preferences.5.xml:231
3974 "The following record assigns a low priority to all package versions "
3975 "belonging to any distribution whose Archive name is "
3976 "\"<literal>unstable</literal>\"."
3979 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3980 #: apt_preferences.5.xml:235
3984 "Pin: release a=unstable\n"
3985 "Pin-Priority: 50\n"
3988 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
3989 #: apt_preferences.5.xml:240
3991 "The following record assigns a high priority to all package versions "
3992 "belonging to any distribution whose Codename is "
3993 "\"<literal>&testing-codename;</literal>\"."
3996 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
3997 #: apt_preferences.5.xml:244
4001 "Pin: release n=&testing-codename;\n"
4002 "Pin-Priority: 900\n"
4005 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4006 #: apt_preferences.5.xml:249
4008 "The following record assigns a high priority to all package versions "
4009 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4010 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4013 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4014 #: apt_preferences.5.xml:254
4018 "Pin: release a=stable, v=&stable-version;\n"
4019 "Pin-Priority: 500\n"
4022 #. type: Content of: <refentry><refsect1><refsect2><title>
4023 #: apt_preferences.5.xml:264
4024 msgid "Regular expressions and &glob; syntax"
4027 #. type: Content of: <refentry><refsect1><refsect2><para>
4028 #: apt_preferences.5.xml:266
4030 "APT also supports pinning by &glob; expressions, and regular expressions "
4031 "surrounded by slashes. For example, the following example assigns the "
4032 "priority 500 to all packages from experimental where the name starts with "
4033 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4034 "extended regular expression surrounded by slashes)."
4037 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4038 #: apt_preferences.5.xml:275
4041 "Package: gnome* /kde/\n"
4042 "Pin: release n=experimental\n"
4043 "Pin-Priority: 500\n"
4046 #. type: Content of: <refentry><refsect1><refsect2><para>
4047 #: apt_preferences.5.xml:281
4049 "The rule for those expressions is that they can occur anywhere where a "
4050 "string can occur. Thus, the following pin assigns the priority 990 to all "
4051 "packages from a release starting with &ubuntu-codename;."
4054 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4055 #: apt_preferences.5.xml:287
4059 "Pin: release n=&ubuntu-codename;*\n"
4060 "Pin-Priority: 990\n"
4063 #. type: Content of: <refentry><refsect1><refsect2><para>
4064 #: apt_preferences.5.xml:293
4066 "If a regular expression occurs in a <literal>Package</literal> field, the "
4067 "behavior is the same as if this regular expression were replaced with a list "
4068 "of all package names it matches. It is undecided whether this will change in "
4069 "the future; thus you should always list wild-card pins first, so later "
4070 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4071 "Package field is not considered a &glob; expression in itself."
4074 #. type: Content of: <refentry><refsect1><refsect2><title>
4075 #: apt_preferences.5.xml:309
4076 msgid "How APT Interprets Priorities"
4079 #. type: Content of: <refentry><refsect1><refsect2><para>
4080 #: apt_preferences.5.xml:312
4082 "Priorities (P) assigned in the APT preferences file must be positive or "
4083 "negative integers. They are interpreted as follows (roughly speaking):"
4086 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4087 #: apt_preferences.5.xml:317
4088 msgid "P >= 1000"
4091 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4092 #: apt_preferences.5.xml:318
4094 "causes a version to be installed even if this constitutes a downgrade of the "
4098 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4099 #: apt_preferences.5.xml:322
4100 msgid "990 <= P < 1000"
4103 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4104 #: apt_preferences.5.xml:323
4106 "causes a version to be installed even if it does not come from the target "
4107 "release, unless the installed version is more recent"
4110 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4111 #: apt_preferences.5.xml:328
4112 msgid "500 <= P < 990"
4115 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4116 #: apt_preferences.5.xml:329
4118 "causes a version to be installed unless there is a version available "
4119 "belonging to the target release or the installed version is more recent"
4122 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4123 #: apt_preferences.5.xml:334
4124 msgid "100 <= P < 500"
4127 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4128 #: apt_preferences.5.xml:335
4130 "causes a version to be installed unless there is a version available "
4131 "belonging to some other distribution or the installed version is more recent"
4134 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4135 #: apt_preferences.5.xml:340
4136 msgid "0 < P < 100"
4139 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4140 #: apt_preferences.5.xml:341
4142 "causes a version to be installed only if there is no installed version of "
4146 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4147 #: apt_preferences.5.xml:345
4151 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4152 #: apt_preferences.5.xml:346
4153 msgid "prevents the version from being installed"
4156 #. type: Content of: <refentry><refsect1><refsect2><para>
4157 #: apt_preferences.5.xml:351
4159 "If any specific-form records match an available package version then the "
4160 "first such record determines the priority of the package version. Failing "
4161 "that, if any general-form records match an available package version then "
4162 "the first such record determines the priority of the package version."
4165 #. type: Content of: <refentry><refsect1><refsect2><para>
4166 #: apt_preferences.5.xml:357
4168 "For example, suppose the APT preferences file contains the three records "
4169 "presented earlier:"
4172 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4173 #: apt_preferences.5.xml:361
4177 "Pin: version &good-perl;*\n"
4178 "Pin-Priority: 1001\n"
4181 "Pin: origin \"\"\n"
4182 "Pin-Priority: 999\n"
4185 "Pin: release unstable\n"
4186 "Pin-Priority: 50\n"
4189 #. type: Content of: <refentry><refsect1><refsect2><para>
4190 #: apt_preferences.5.xml:374
4194 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4195 #: apt_preferences.5.xml:376
4197 "The most recent available version of the <literal>perl</literal> package "
4198 "will be installed, so long as that version's version number begins with "
4199 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4200 "&good-perl;* version of <literal>perl</literal> is available and the "
4201 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4205 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4206 #: apt_preferences.5.xml:381
4208 "A version of any package other than <literal>perl</literal> that is "
4209 "available from the local system has priority over other versions, even "
4210 "versions belonging to the target release."
4213 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4214 #: apt_preferences.5.xml:385
4216 "A version of a package whose origin is not the local system but some other "
4217 "site listed in &sources-list; and which belongs to an "
4218 "<literal>unstable</literal> distribution is only installed if it is selected "
4219 "for installation and no version of the package is already installed."
4222 #. type: Content of: <refentry><refsect1><refsect2><title>
4223 #: apt_preferences.5.xml:395
4224 msgid "Determination of Package Version and Distribution Properties"
4227 #. type: Content of: <refentry><refsect1><refsect2><para>
4228 #: apt_preferences.5.xml:397
4230 "The locations listed in the &sources-list; file should provide "
4231 "<filename>Packages</filename> and <filename>Release</filename> files to "
4232 "describe the packages available at that location."
4235 #. type: Content of: <refentry><refsect1><refsect2><para>
4236 #: apt_preferences.5.xml:401
4238 "The <filename>Packages</filename> file is normally found in the directory "
4239 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4241 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4242 "consists of a series of multi-line records, one for each package available "
4243 "in that directory. Only two lines in each record are relevant for setting "
4247 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4248 #: apt_preferences.5.xml:409
4249 msgid "the <literal>Package:</literal> line"
4252 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4253 #: apt_preferences.5.xml:410
4254 msgid "gives the package name"
4257 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4258 #: apt_preferences.5.xml:413 apt_preferences.5.xml:463
4259 msgid "the <literal>Version:</literal> line"
4262 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4263 #: apt_preferences.5.xml:414
4264 msgid "gives the version number for the named package"
4267 #. type: Content of: <refentry><refsect1><refsect2><para>
4268 #: apt_preferences.5.xml:419
4270 "The <filename>Release</filename> file is normally found in the directory "
4271 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4272 "example, <filename>.../dists/stable/Release</filename>, or "
4273 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4274 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4275 "packages in the directory tree below its parent. Unlike the "
4276 "<filename>Packages</filename> file, nearly all of the lines in a "
4277 "<filename>Release</filename> file are relevant for setting APT priorities:"
4280 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4281 #: apt_preferences.5.xml:430
4282 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4285 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4286 #: apt_preferences.5.xml:431
4288 "names the archive to which all the packages in the directory tree belong. "
4289 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4290 "that all of the packages in the directory tree below the parent of the "
4291 "<filename>Release</filename> file are in a <literal>stable</literal> "
4292 "archive. Specifying this value in the APT preferences file would require "
4296 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4297 #: apt_preferences.5.xml:441
4299 msgid "Pin: release a=stable\n"
4302 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4303 #: apt_preferences.5.xml:447
4304 msgid "the <literal>Codename:</literal> line"
4307 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4308 #: apt_preferences.5.xml:448
4310 "names the codename to which all the packages in the directory tree belong. "
4311 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4312 "the packages in the directory tree below the parent of the "
4313 "<filename>Release</filename> file belong to a version named "
4314 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4315 "preferences file would require the line:"
4318 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4319 #: apt_preferences.5.xml:457
4321 msgid "Pin: release n=&testing-codename;\n"
4324 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4325 #: apt_preferences.5.xml:464
4327 "names the release version. For example, the packages in the tree might "
4328 "belong to Debian release version &stable-version;. Note that there is "
4329 "normally no version number for the <literal>testing</literal> and "
4330 "<literal>unstable</literal> distributions because they have not been "
4331 "released yet. Specifying this in the APT preferences file would require one "
4332 "of the following lines."
4335 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4336 #: apt_preferences.5.xml:473
4339 "Pin: release v=&stable-version;\n"
4340 "Pin: release a=stable, v=&stable-version;\n"
4341 "Pin: release &stable-version;\n"
4344 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4345 #: apt_preferences.5.xml:482
4346 msgid "the <literal>Component:</literal> line"
4349 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4350 #: apt_preferences.5.xml:483
4352 "names the licensing component associated with the packages in the directory "
4353 "tree of the <filename>Release</filename> file. For example, the line "
4354 "\"Component: main\" specifies that all the packages in the directory tree "
4355 "are from the <literal>main</literal> component, which entails that they are "
4356 "licensed under terms listed in the Debian Free Software Guidelines. "
4357 "Specifying this component in the APT preferences file would require the "
4361 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4362 #: apt_preferences.5.xml:492
4364 msgid "Pin: release c=main\n"
4367 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4368 #: apt_preferences.5.xml:498
4369 msgid "the <literal>Origin:</literal> line"
4372 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4373 #: apt_preferences.5.xml:499
4375 "names the originator of the packages in the directory tree of the "
4376 "<filename>Release</filename> file. Most commonly, this is "
4377 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4378 "file would require the line:"
4381 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4382 #: apt_preferences.5.xml:505
4384 msgid "Pin: release o=Debian\n"
4387 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4388 #: apt_preferences.5.xml:511
4389 msgid "the <literal>Label:</literal> line"
4392 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4393 #: apt_preferences.5.xml:512
4395 "names the label of the packages in the directory tree of the "
4396 "<filename>Release</filename> file. Most commonly, this is "
4397 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4398 "file would require the line:"
4401 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4402 #: apt_preferences.5.xml:518
4404 msgid "Pin: release l=Debian\n"
4407 #. type: Content of: <refentry><refsect1><refsect2><para>
4408 #: apt_preferences.5.xml:525
4410 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4411 "files retrieved from locations listed in the &sources-list; file are stored "
4412 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4413 "named by the variable <literal>Dir::State::Lists</literal> in the "
4414 "<filename>apt.conf</filename> file. For example, the file "
4415 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4416 "contains the <filename>Release</filename> file retrieved from the site "
4417 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4418 "architecture files from the <literal>contrib</literal> component of the "
4419 "<literal>unstable</literal> distribution."
4422 #. type: Content of: <refentry><refsect1><refsect2><title>
4423 #: apt_preferences.5.xml:538
4424 msgid "Optional Lines in an APT Preferences Record"
4427 #. type: Content of: <refentry><refsect1><refsect2><para>
4428 #: apt_preferences.5.xml:540
4430 "Each record in the APT preferences file can optionally begin with one or "
4431 "more lines beginning with the word <literal>Explanation:</literal>. This "
4432 "provides a place for comments."
4435 #. type: Content of: <refentry><refsect1><refsect2><title>
4436 #: apt_preferences.5.xml:549
4437 msgid "Tracking Stable"
4440 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4441 #: apt_preferences.5.xml:557
4444 "Explanation: Uninstall or do not install any Debian-originated\n"
4445 "Explanation: package versions other than those in the stable distro\n"
4447 "Pin: release a=stable\n"
4448 "Pin-Priority: 900\n"
4451 "Pin: release o=Debian\n"
4452 "Pin-Priority: -10\n"
4455 #. type: Content of: <refentry><refsect1><refsect2><para>
4456 #: apt_preferences.5.xml:551
4458 "The following APT preferences file will cause APT to assign a priority "
4459 "higher than the default (500) to all package versions belonging to a "
4460 "<literal>stable</literal> distribution and a prohibitively low priority to "
4461 "package versions belonging to other <literal>Debian</literal> "
4462 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
4465 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4466 #: apt_preferences.5.xml:574 apt_preferences.5.xml:620 apt_preferences.5.xml:678
4469 "apt-get install <replaceable>package-name</replaceable>\n"
4471 "apt-get dist-upgrade\n"
4474 #. type: Content of: <refentry><refsect1><refsect2><para>
4475 #: apt_preferences.5.xml:569
4477 "With a suitable &sources-list; file and the above preferences file, any of "
4478 "the following commands will cause APT to upgrade to the latest "
4479 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
4483 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4484 #: apt_preferences.5.xml:586
4486 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
4489 #. type: Content of: <refentry><refsect1><refsect2><para>
4490 #: apt_preferences.5.xml:580
4492 "The following command will cause APT to upgrade the specified package to the "
4493 "latest version from the <literal>testing</literal> distribution; the package "
4494 "will not be upgraded again unless this command is given again. <placeholder "
4495 "type=\"programlisting\" id=\"0\"/>"
4498 #. type: Content of: <refentry><refsect1><refsect2><title>
4499 #: apt_preferences.5.xml:592
4500 msgid "Tracking Testing or Unstable"
4503 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4504 #: apt_preferences.5.xml:601
4508 "Pin: release a=testing\n"
4509 "Pin-Priority: 900\n"
4512 "Pin: release a=unstable\n"
4513 "Pin-Priority: 800\n"
4516 "Pin: release o=Debian\n"
4517 "Pin-Priority: -10\n"
4520 #. type: Content of: <refentry><refsect1><refsect2><para>
4521 #: apt_preferences.5.xml:594
4523 "The following APT preferences file will cause APT to assign a high priority "
4524 "to package versions from the <literal>testing</literal> distribution, a "
4525 "lower priority to package versions from the <literal>unstable</literal> "
4526 "distribution, and a prohibitively low priority to package versions from "
4527 "other <literal>Debian</literal> distributions. <placeholder "
4528 "type=\"programlisting\" id=\"0\"/>"
4531 #. type: Content of: <refentry><refsect1><refsect2><para>
4532 #: apt_preferences.5.xml:615
4534 "With a suitable &sources-list; file and the above preferences file, any of "
4535 "the following commands will cause APT to upgrade to the latest "
4536 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
4540 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4541 #: apt_preferences.5.xml:635
4543 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
4546 #. type: Content of: <refentry><refsect1><refsect2><para>
4547 #: apt_preferences.5.xml:626
4549 "The following command will cause APT to upgrade the specified package to the "
4550 "latest version from the <literal>unstable</literal> distribution. "
4551 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
4552 "the most recent <literal>testing</literal> version if that is more recent "
4553 "than the installed version, otherwise, to the most recent "
4554 "<literal>unstable</literal> version if that is more recent than the "
4555 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
4558 #. type: Content of: <refentry><refsect1><refsect2><title>
4559 #: apt_preferences.5.xml:642
4560 msgid "Tracking the evolution of a codename release"
4563 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4564 #: apt_preferences.5.xml:656
4567 "Explanation: Uninstall or do not install any Debian-originated package "
4569 "Explanation: other than those in the distribution codenamed with "
4570 "&testing-codename; or sid\n"
4572 "Pin: release n=&testing-codename;\n"
4573 "Pin-Priority: 900\n"
4575 "Explanation: Debian unstable is always codenamed with sid\n"
4577 "Pin: release n=sid\n"
4578 "Pin-Priority: 800\n"
4581 "Pin: release o=Debian\n"
4582 "Pin-Priority: -10\n"
4585 #. type: Content of: <refentry><refsect1><refsect2><para>
4586 #: apt_preferences.5.xml:644
4588 "The following APT preferences file will cause APT to assign a priority "
4589 "higher than the default (500) to all package versions belonging to a "
4590 "specified codename of a distribution and a prohibitively low priority to "
4591 "package versions belonging to other <literal>Debian</literal> distributions, "
4592 "codenames and archives. Note that with this APT preference APT will follow "
4593 "the migration of a release from the archive <literal>testing</literal> to "
4594 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
4595 "want to follow for example the progress in <literal>testing</literal> "
4596 "notwithstanding the codename changes you should use the example "
4597 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
4600 #. type: Content of: <refentry><refsect1><refsect2><para>
4601 #: apt_preferences.5.xml:673
4603 "With a suitable &sources-list; file and the above preferences file, any of "
4604 "the following commands will cause APT to upgrade to the latest version(s) in "
4605 "the release codenamed with <literal>&testing-codename;</literal>. "
4606 "<placeholder type=\"programlisting\" id=\"0\"/>"
4609 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4610 #: apt_preferences.5.xml:693
4612 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
4615 #. type: Content of: <refentry><refsect1><refsect2><para>
4616 #: apt_preferences.5.xml:684
4618 "The following command will cause APT to upgrade the specified package to the "
4619 "latest version from the <literal>sid</literal> distribution. Thereafter, "
4620 "<command>apt-get upgrade</command> will upgrade the package to the most "
4621 "recent <literal>&testing-codename;</literal> version if that is more recent "
4622 "than the installed version, otherwise, to the most recent "
4623 "<literal>sid</literal> version if that is more recent than the installed "
4624 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
4627 #. type: Content of: <refentry><refsect1><para>
4628 #: apt_preferences.5.xml:708
4629 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
4632 #. type: Content of: <refentry><refnamediv><refpurpose>
4633 #: sources.list.5.xml:35
4634 msgid "List of configured APT data sources"
4637 #. type: Content of: <refentry><refsect1><para>
4638 #: sources.list.5.xml:40
4640 "The source list <filename>/etc/apt/sources.list</filename> is designed to "
4641 "support any number of active sources and a variety of source media. The file "
4642 "lists one source per line, with the most preferred source listed first. The "
4643 "information available from the configured sources is acquired by "
4644 "<command>apt-get update</command> (or by an equivalent command from another "
4648 #. type: Content of: <refentry><refsect1><para>
4649 #: sources.list.5.xml:47
4651 "Each line specifying a source starts with type "
4652 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
4653 "this type. Individual entries cannot be continued onto a following "
4654 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
4655 "on a line marks the remainder of that line as a comment."
4658 #. type: Content of: <refentry><refsect1><title>
4659 #: sources.list.5.xml:55
4660 msgid "sources.list.d"
4663 #. type: Content of: <refentry><refsect1><para>
4664 #: sources.list.5.xml:56
4666 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
4667 "add sources.list entries in separate files. The format is the same as for "
4668 "the regular <filename>sources.list</filename> file. File names need to end "
4669 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
4670 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
4671 "Otherwise APT will print a notice that it has ignored a file, unless that "
4672 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4673 "configuration list - in which case it will be silently ignored."
4676 #. type: Content of: <refentry><refsect1><title>
4677 #: sources.list.5.xml:67
4678 msgid "The deb and deb-src types"
4681 #. type: Content of: <refentry><refsect1><para>
4682 #: sources.list.5.xml:68
4684 "The <literal>deb</literal> type references a typical two-level Debian "
4685 "archive, <filename>distribution/component</filename>. The "
4686 "<literal>distribution</literal> is generally an archive name like "
4687 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
4688 "<literal>&stable-codename;</literal> or "
4689 "<literal>&testing-codename;</literal> while component is one of "
4690 "<literal>main</literal>, <literal>contrib</literal> or "
4691 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
4692 "a Debian distribution's source code in the same form as the "
4693 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
4694 "to fetch source indexes."
4697 #. type: Content of: <refentry><refsect1><para>
4698 #: sources.list.5.xml:80
4700 "The format for a <filename>sources.list</filename> entry using the "
4701 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
4704 #. type: Content of: <refentry><refsect1><literallayout>
4705 #: sources.list.5.xml:83
4707 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
4710 #. type: Content of: <refentry><refsect1><para>
4711 #: sources.list.5.xml:85
4713 "The URI for the <literal>deb</literal> type must specify the base of the "
4714 "Debian distribution, from which APT will find the information it needs. "
4715 "<literal>distribution</literal> can specify an exact path, in which case the "
4716 "components must be omitted and <literal>distribution</literal> must end with "
4717 "a slash (<literal>/</literal>). This is useful for the case when only a "
4718 "particular sub-section of the archive denoted by the URI is of interest. If "
4719 "<literal>distribution</literal> does not specify an exact path, at least one "
4720 "<literal>component</literal> must be present."
4723 #. type: Content of: <refentry><refsect1><para>
4724 #: sources.list.5.xml:94
4726 "<literal>distribution</literal> may also contain a variable, "
4727 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
4728 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
4729 "system. This permits architecture-independent "
4730 "<filename>sources.list</filename> files to be used. In general this is only "
4731 "of interest when specifying an exact path, <literal>APT</literal> will "
4732 "automatically generate a URI with the current architecture otherwise."
4735 #. type: Content of: <refentry><refsect1><para>
4736 #: sources.list.5.xml:102
4738 "Since only one distribution can be specified per line it may be necessary to "
4739 "have multiple lines for the same URI, if a subset of all available "
4740 "distributions or components at that location is desired. APT will sort the "
4741 "URI list after it has generated a complete set internally, and will collapse "
4742 "multiple references to the same Internet host, for instance, into a single "
4743 "connection, so that it does not inefficiently establish an FTP connection, "
4744 "close it, do something else, and then re-establish a connection to that same "
4745 "host. This feature is useful for accessing busy FTP sites with limits on the "
4746 "number of simultaneous anonymous users. APT also parallelizes connections to "
4747 "different hosts to more effectively deal with sites with low bandwidth."
4750 #. type: Content of: <refentry><refsect1><para>
4751 #: sources.list.5.xml:114
4753 "<literal>options</literal> is always optional and needs to be surrounded by "
4754 "square brackets. It can consist of multiple settings in the form "
4755 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
4756 "Multiple settings are separated by spaces. The following settings are "
4757 "supported by APT (note however that unsupported settings will be ignored "
4761 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4762 #: sources.list.5.xml:120
4764 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4765 "can be used to specify for which architectures information should be "
4766 "downloaded. If this option is not set all architectures defined by the "
4767 "<literal>APT::Architectures</literal> option will be downloaded."
4770 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4771 #: sources.list.5.xml:124
4773 "<literal>arch+=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4775 "<literal>arch-=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
4776 "which can be used to add/remove architectures from the set which will be "
4780 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4781 #: sources.list.5.xml:127
4783 "<literal>trusted=yes</literal> can be set to indicate that packages from "
4784 "this source are always authenticated even if the "
4785 "<filename>Release</filename> file is not signed or the signature can't be "
4786 "checked. This disables parts of &apt-secure; and should therefore only be "
4787 "used in a local and trusted context. <literal>trusted=no</literal> is the "
4788 "opposite which handles even correctly authenticated sources as not "
4792 #. type: Content of: <refentry><refsect1><para>
4793 #: sources.list.5.xml:134
4795 "It is important to list sources in order of preference, with the most "
4796 "preferred source listed first. Typically this will result in sorting by "
4797 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
4798 "followed by distant Internet hosts, for example)."
4801 #. type: Content of: <refentry><refsect1><para>
4802 #: sources.list.5.xml:139
4803 msgid "Some examples:"
4806 #. type: Content of: <refentry><refsect1><literallayout>
4807 #: sources.list.5.xml:141
4810 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
4811 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
4816 #. type: Content of: <refentry><refsect1><title>
4817 #: sources.list.5.xml:147
4818 msgid "URI specification"
4821 #. type: Content of: <refentry><refsect1><para>
4822 #: sources.list.5.xml:149
4823 msgid "The currently recognized URI types are:"
4826 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4827 #: sources.list.5.xml:153
4829 "The file scheme allows an arbitrary directory in the file system to be "
4830 "considered an archive. This is useful for NFS mounts and local mirrors or "
4834 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4835 #: sources.list.5.xml:160
4837 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
4838 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
4842 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4843 #: sources.list.5.xml:167
4845 "The http scheme specifies an HTTP server for the archive. If an environment "
4846 "variable <envar>http_proxy</envar> is set with the format "
4847 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
4848 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
4849 "the format http://user:pass@server:port/. Note that this is an insecure "
4850 "method of authentication."
4853 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4854 #: sources.list.5.xml:178
4856 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
4857 "is highly configurable; for more information see the &apt-conf; manual "
4858 "page. Please note that an FTP proxy can be specified by using the "
4859 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
4860 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
4861 "environment variable and <emphasis>only</emphasis> this environment "
4862 "variable. Proxies using HTTP specified in the configuration file will be "
4866 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4867 #: sources.list.5.xml:190
4869 "The copy scheme is identical to the file scheme except that packages are "
4870 "copied into the cache directory instead of used directly at their location. "
4871 "This is useful for people using removable media to copy files around with "
4875 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4876 #: sources.list.5.xml:197
4878 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
4879 "the files as a given user. Prior configuration of rhosts or RSA keys is "
4880 "recommended. The standard <command>find</command> and <command>dd</command> "
4881 "commands are used to perform the file transfers from the remote host."
4884 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4885 #: sources.list.5.xml:204
4886 msgid "adding more recognizable URI types"
4889 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4890 #: sources.list.5.xml:206
4892 "APT can be extended with more methods shipped in other optional packages, "
4893 "which should follow the naming scheme "
4894 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
4895 "instance, the APT team also maintains the package "
4896 "<package>apt-transport-https</package>, which provides access methods for "
4897 "HTTPS URIs with features similar to the http method. Methods for using "
4898 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
4901 #. type: Content of: <refentry><refsect1><para>
4902 #: sources.list.5.xml:218
4904 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
4905 "stable/main, stable/contrib, and stable/non-free."
4908 #. type: Content of: <refentry><refsect1><literallayout>
4909 #: sources.list.5.xml:220
4911 msgid "deb file:/home/jason/debian stable main contrib non-free"
4914 #. type: Content of: <refentry><refsect1><para>
4915 #: sources.list.5.xml:222
4916 msgid "As above, except this uses the unstable (development) distribution."
4919 #. type: Content of: <refentry><refsect1><literallayout>
4920 #: sources.list.5.xml:223
4922 msgid "deb file:/home/jason/debian unstable main contrib non-free"
4925 #. type: Content of: <refentry><refsect1><para>
4926 #: sources.list.5.xml:225
4927 msgid "Source line for the above"
4930 #. type: Content of: <refentry><refsect1><literallayout>
4931 #: sources.list.5.xml:226
4933 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
4936 #. type: Content of: <refentry><refsect1><para>
4937 #: sources.list.5.xml:228
4939 "The first line gets package information for the architectures in "
4940 "<literal>APT::Architectures</literal> while the second always retrieves "
4941 "<literal>amd64</literal> and <literal>armel</literal>."
4944 #. type: Content of: <refentry><refsect1><literallayout>
4945 #: sources.list.5.xml:230
4948 "deb http://ftp.debian.org/debian &stable-codename; main\n"
4949 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
4952 #. type: Content of: <refentry><refsect1><para>
4953 #: sources.list.5.xml:233
4955 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
4959 #. type: Content of: <refentry><refsect1><literallayout>
4960 #: sources.list.5.xml:235
4962 msgid "deb http://archive.debian.org/debian-archive hamm main"
4965 #. type: Content of: <refentry><refsect1><para>
4966 #: sources.list.5.xml:237
4968 "Uses FTP to access the archive at ftp.debian.org, under the debian "
4969 "directory, and uses only the &stable-codename;/contrib area."
4972 #. type: Content of: <refentry><refsect1><literallayout>
4973 #: sources.list.5.xml:239
4975 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
4978 #. type: Content of: <refentry><refsect1><para>
4979 #: sources.list.5.xml:241
4981 "Uses FTP to access the archive at ftp.debian.org, under the debian "
4982 "directory, and uses only the unstable/contrib area. If this line appears as "
4983 "well as the one in the previous example in <filename>sources.list</filename> "
4984 "a single FTP session will be used for both resource lines."
4987 #. type: Content of: <refentry><refsect1><literallayout>
4988 #: sources.list.5.xml:245
4990 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
4993 #. type: Content of: <refentry><refsect1><para><literallayout>
4994 #: sources.list.5.xml:254
4996 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
4999 #. type: Content of: <refentry><refsect1><para>
5000 #: sources.list.5.xml:247
5002 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5003 "directory, and uses only files found under "
5004 "<filename>unstable/binary-i386</filename> on i386 machines, "
5005 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5006 "supported architectures. [Note this example only illustrates how to use the "
5007 "substitution variable; official debian archives are not structured like "
5008 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5011 #. type: Content of: <refentry><refsect1><para>
5012 #: sources.list.5.xml:259
5013 msgid "&apt-cache; &apt-conf;"
5016 #. type: Content of: <refentry><refmeta><manvolnum>
5017 #: apt-extracttemplates.1.xml:28 apt-sortpkgs.1.xml:28 apt-ftparchive.1.xml:28
5021 #. type: Content of: <refentry><refnamediv><refpurpose>
5022 #: apt-extracttemplates.1.xml:35
5024 "Utility to extract <command>debconf</command> config and templates from "
5028 #. type: Content of: <refentry><refsect1><para>
5029 #: apt-extracttemplates.1.xml:41
5031 "<command>apt-extracttemplates</command> will take one or more Debian package "
5032 "files as input and write out (to a temporary directory) all associated "
5033 "config scripts and template files. For each passed in package that contains "
5034 "config scripts and templates, one line of output will be generated in the "
5038 #. type: Content of: <refentry><refsect1><para>
5039 #: apt-extracttemplates.1.xml:46
5040 msgid "package version template-file config-script"
5043 #. type: Content of: <refentry><refsect1><para>
5044 #: apt-extracttemplates.1.xml:47
5046 "template-file and config-script are written to the temporary directory "
5047 "specified by the <option>-t</option> or <option>--tempdir</option> "
5048 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5049 "filenames of the form <filename>package.template.XXXX</filename> and "
5050 "<filename>package.config.XXXX</filename>"
5053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5054 #: apt-extracttemplates.1.xml:60
5056 "Temporary directory in which to write extracted <command>debconf</command> "
5057 "template files and config scripts. Configuration Item: "
5058 "<literal>APT::ExtractTemplates::TempDir</literal>"
5061 #. type: Content of: <refentry><refsect1><para>
5062 #: apt-extracttemplates.1.xml:77
5064 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5065 "decimal 100 on error."
5068 #. type: Content of: <refentry><refnamediv><refpurpose>
5069 #: apt-sortpkgs.1.xml:35
5070 msgid "Utility to sort package index files"
5073 #. type: Content of: <refentry><refsect1><para>
5074 #: apt-sortpkgs.1.xml:41
5076 "<command>apt-sortpkgs</command> will take an index file (source index or "
5077 "package index) and sort the records so that they are ordered by the package "
5078 "name. It will also sort the internal fields of each record according to the "
5079 "internal sorting rules."
5082 #. type: Content of: <refentry><refsect1><para>
5083 #: apt-sortpkgs.1.xml:47
5084 msgid "All output is sent to standard output; the input must be a seekable file."
5087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5088 #: apt-sortpkgs.1.xml:56
5090 "Use source index field ordering. Configuration Item: "
5091 "<literal>APT::SortPkgs::Source</literal>."
5094 #. type: Content of: <refentry><refsect1><para>
5095 #: apt-sortpkgs.1.xml:70
5097 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
5101 #. type: Content of: <refentry><refnamediv><refpurpose>
5102 #: apt-ftparchive.1.xml:35
5103 msgid "Utility to generate index files"
5106 #. type: Content of: <refentry><refsect1><para>
5107 #: apt-ftparchive.1.xml:41
5109 "<command>apt-ftparchive</command> is the command line tool that generates "
5110 "the index files that APT uses to access a distribution source. The index "
5111 "files should be generated on the origin site based on the content of that "
5115 #. type: Content of: <refentry><refsect1><para>
5116 #: apt-ftparchive.1.xml:45
5118 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
5119 "program, incorporating its entire functionality via the "
5120 "<literal>packages</literal> command. It also contains a contents file "
5121 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
5122 "the generation process for a complete archive."
5125 #. type: Content of: <refentry><refsect1><para>
5126 #: apt-ftparchive.1.xml:51
5128 "Internally <command>apt-ftparchive</command> can make use of binary "
5129 "databases to cache the contents of a .deb file and it does not rely on any "
5130 "external programs aside from &gzip;. When doing a full generate it "
5131 "automatically performs file-change checks and builds the desired compressed "
5135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5136 #: apt-ftparchive.1.xml:62
5138 "The packages command generates a package file from a directory tree. It "
5139 "takes the given directory and recursively searches it for .deb files, "
5140 "emitting a package record to stdout for each. This command is approximately "
5141 "equivalent to &dpkg-scanpackages;."
5144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5145 #: apt-ftparchive.1.xml:67 apt-ftparchive.1.xml:91
5146 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
5149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5150 #: apt-ftparchive.1.xml:72
5152 "The <literal>sources</literal> command generates a source index file from a "
5153 "directory tree. It takes the given directory and recursively searches it "
5154 "for .dsc files, emitting a source record to stdout for each. This command is "
5155 "approximately equivalent to &dpkg-scansources;."
5158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5159 #: apt-ftparchive.1.xml:77
5161 "If an override file is specified then a source override file will be looked "
5162 "for with an extension of .src. The --source-override option can be used to "
5163 "change the source override file that will be used."
5166 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5167 #: apt-ftparchive.1.xml:84
5169 "The <literal>contents</literal> command generates a contents file from a "
5170 "directory tree. It takes the given directory and recursively searches it for "
5171 ".deb files, and reads the file list from each file. It then sorts and writes "
5172 "to stdout the list of files matched to packages. Directories are not written "
5173 "to the output. If multiple packages own the same file then each package is "
5174 "separated by a comma in the output."
5177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5178 #: apt-ftparchive.1.xml:96
5180 "The <literal>release</literal> command generates a Release file from a "
5181 "directory tree. It recursively searches the given directory for uncompressed "
5182 "<filename>Packages</filename> and <filename>Sources</filename> files and "
5183 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
5184 "<command>lzma</command> as well as <filename>Release</filename> and "
5185 "<filename>md5sum.txt</filename> files by default "
5186 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
5187 "filename patterns can be added by listing them in "
5188 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
5189 "stdout a <filename>Release</filename> file containing an MD5, SHA1 and "
5190 "SHA256 digest for each file."
5193 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5194 #: apt-ftparchive.1.xml:106
5196 "Values for the additional metadata fields in the Release file are taken from "
5197 "the corresponding variables under "
5198 "<literal>APT::FTPArchive::Release</literal>, "
5199 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
5200 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
5201 "<literal>Suite</literal>, <literal>Version</literal>, "
5202 "<literal>Codename</literal>, <literal>Date</literal>, "
5203 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
5204 "<literal>Components</literal>, <literal>Description</literal>."
5207 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5208 #: apt-ftparchive.1.xml:119
5210 "The <literal>generate</literal> command is designed to be runnable from a "
5211 "cron script and builds indexes according to the given config file. The "
5212 "config language provides a flexible means of specifying which index files "
5213 "are built from which directories, as well as providing a simple means of "
5214 "maintaining the required settings."
5217 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5218 #: apt-ftparchive.1.xml:128
5220 "The <literal>clean</literal> command tidies the databases used by the given "
5221 "configuration file by removing any records that are no longer necessary."
5224 #. type: Content of: <refentry><refsect1><title>
5225 #: apt-ftparchive.1.xml:134
5226 msgid "The Generate Configuration"
5229 #. type: Content of: <refentry><refsect1><para>
5230 #: apt-ftparchive.1.xml:136
5232 "The <literal>generate</literal> command uses a configuration file to "
5233 "describe the archives that are going to be generated. It follows the typical "
5234 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
5235 "&apt-conf; contains a description of the syntax. Note that the generate "
5236 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
5237 "tree manner. This only effects how the scope tag is handled."
5240 #. type: Content of: <refentry><refsect1><para>
5241 #: apt-ftparchive.1.xml:144
5242 msgid "The generate configuration has four separate sections, each described below."
5245 #. type: Content of: <refentry><refsect1><refsect2><title>
5246 #: apt-ftparchive.1.xml:146
5247 msgid "<literal>Dir</literal> Section"
5250 #. type: Content of: <refentry><refsect1><refsect2><para>
5251 #: apt-ftparchive.1.xml:148
5253 "The <literal>Dir</literal> section defines the standard directories needed "
5254 "to locate the files required during the generation process. These "
5255 "directories are prepended certain relative paths defined in later sections "
5256 "to produce a complete an absolute path."
5259 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5260 #: apt-ftparchive.1.xml:155
5262 "Specifies the root of the FTP archive, in a standard Debian configuration "
5263 "this is the directory that contains the <filename>ls-LR</filename> and dist "
5267 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5268 #: apt-ftparchive.1.xml:162
5269 msgid "Specifies the location of the override files."
5272 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5273 #: apt-ftparchive.1.xml:167
5274 msgid "Specifies the location of the cache files."
5277 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5278 #: apt-ftparchive.1.xml:172
5280 "Specifies the location of the file list files, if the "
5281 "<literal>FileList</literal> setting is used below."
5284 #. type: Content of: <refentry><refsect1><refsect2><title>
5285 #: apt-ftparchive.1.xml:178
5286 msgid "<literal>Default</literal> Section"
5289 #. type: Content of: <refentry><refsect1><refsect2><para>
5290 #: apt-ftparchive.1.xml:180
5292 "The <literal>Default</literal> section specifies default values, and "
5293 "settings that control the operation of the generator. Other sections may "
5294 "override these defaults with a per-section setting."
5297 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5298 #: apt-ftparchive.1.xml:186
5300 "Sets the default compression schemes to use for the package index files. It "
5301 "is a string that contains a space separated list of at least one of: '.' (no "
5302 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
5306 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5307 #: apt-ftparchive.1.xml:194
5309 "Sets the default list of file extensions that are package files. This "
5310 "defaults to '.deb'."
5313 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5314 #: apt-ftparchive.1.xml:200
5316 "This is similar to <literal>Packages::Compress</literal> except that it "
5317 "controls the compression for the Sources files."
5320 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5321 #: apt-ftparchive.1.xml:206
5323 "Sets the default list of file extensions that are source files. This "
5324 "defaults to '.dsc'."
5327 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5328 #: apt-ftparchive.1.xml:212
5330 "This is similar to <literal>Packages::Compress</literal> except that it "
5331 "controls the compression for the Contents files."
5334 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5335 #: apt-ftparchive.1.xml:218
5337 "This is similar to <literal>Packages::Compress</literal> except that it "
5338 "controls the compression for the Translation-en master file."
5341 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5342 #: apt-ftparchive.1.xml:224
5344 "Specifies the number of kilobytes to delink (and replace with hard links) "
5345 "per run. This is used in conjunction with the per-section "
5346 "<literal>External-Links</literal> setting."
5349 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5350 #: apt-ftparchive.1.xml:231
5352 "Specifies the mode of all created index files. It defaults to 0644. All "
5353 "index files are set to this mode with no regard to the umask."
5356 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5357 #: apt-ftparchive.1.xml:238 apt-ftparchive.1.xml:384
5359 "Specifies whether long descriptions should be included in the "
5360 "<filename>Packages</filename> file or split out into a master "
5361 "<filename>Translation-en</filename> file."
5364 #. type: Content of: <refentry><refsect1><refsect2><title>
5365 #: apt-ftparchive.1.xml:244
5366 msgid "<literal>TreeDefault</literal> Section"
5369 #. type: Content of: <refentry><refsect1><refsect2><para>
5370 #: apt-ftparchive.1.xml:246
5372 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
5373 "variables are substitution variables and have the strings $(DIST), "
5374 "$(SECTION) and $(ARCH) replaced with their respective values."
5377 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5378 #: apt-ftparchive.1.xml:253
5380 "Sets the number of kilobytes of contents files that are generated each "
5381 "day. The contents files are round-robined so that over several days they "
5382 "will all be rebuilt."
5385 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5386 #: apt-ftparchive.1.xml:260
5388 "Controls the number of days a contents file is allowed to be checked without "
5389 "changing. If this limit is passed the mtime of the contents file is "
5390 "updated. This case can occur if the package file is changed in such a way "
5391 "that does not result in a new contents file [override edit for instance]. A "
5392 "hold off is allowed in hopes that new .debs will be installed, requiring a "
5393 "new file anyhow. The default is 10, the units are in days."
5396 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5397 #: apt-ftparchive.1.xml:271
5399 "Sets the top of the .deb directory tree. Defaults to "
5400 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
5403 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5404 #: apt-ftparchive.1.xml:277
5406 "Sets the top of the source package directory tree. Defaults to "
5407 "<filename>$(DIST)/$(SECTION)/source/</filename>"
5410 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5411 #: apt-ftparchive.1.xml:283
5413 "Sets the output Packages file. Defaults to "
5414 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
5417 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5418 #: apt-ftparchive.1.xml:289
5420 "Sets the output Sources file. Defaults to "
5421 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
5424 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5425 #: apt-ftparchive.1.xml:295
5427 "Sets the output Translation-en master file with the long descriptions if "
5428 "they should be not included in the Packages file. Defaults to "
5429 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
5432 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5433 #: apt-ftparchive.1.xml:302
5435 "Sets the path prefix that causes a symlink to be considered an internal link "
5436 "instead of an external link. Defaults to "
5437 "<filename>$(DIST)/$(SECTION)/</filename>"
5440 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5441 #: apt-ftparchive.1.xml:309
5443 "Sets the output Contents file. Defaults to "
5444 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
5445 "causes multiple Packages files to map onto a single Contents file (as is the "
5446 "default) then <command>apt-ftparchive</command> will integrate those "
5447 "package files together automatically."
5450 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5451 #: apt-ftparchive.1.xml:318
5452 msgid "Sets header file to prepend to the contents output."
5455 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5456 #: apt-ftparchive.1.xml:323
5458 "Sets the binary cache database to use for this section. Multiple sections "
5459 "can share the same database."
5462 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5463 #: apt-ftparchive.1.xml:329
5465 "Specifies that instead of walking the directory tree, "
5466 "<command>apt-ftparchive</command> should read the list of files from the "
5467 "given file. Relative files names are prefixed with the archive directory."
5470 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5471 #: apt-ftparchive.1.xml:336
5473 "Specifies that instead of walking the directory tree, "
5474 "<command>apt-ftparchive</command> should read the list of files from the "
5475 "given file. Relative files names are prefixed with the archive directory. "
5476 "This is used when processing source indexes."
5479 #. type: Content of: <refentry><refsect1><refsect2><title>
5480 #: apt-ftparchive.1.xml:344
5481 msgid "<literal>Tree</literal> Section"
5484 #. type: Content of: <refentry><refsect1><refsect2><para>
5485 #: apt-ftparchive.1.xml:346
5487 "The <literal>Tree</literal> section defines a standard Debian file tree "
5488 "which consists of a base directory, then multiple sections in that base "
5489 "directory and finally multiple Architectures in each section. The exact "
5490 "pathing used is defined by the <literal>Directory</literal> substitution "
5494 #. type: Content of: <refentry><refsect1><refsect2><para>
5495 #: apt-ftparchive.1.xml:351
5497 "The <literal>Tree</literal> section takes a scope tag which sets the "
5498 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
5499 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
5500 "setting such as <filename>dists/&stable-codename;</filename>."
5503 #. type: Content of: <refentry><refsect1><refsect2><para>
5504 #: apt-ftparchive.1.xml:356
5506 "All of the settings defined in the <literal>TreeDefault</literal> section "
5507 "can be used in a <literal>Tree</literal> section as well as three new "
5511 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5512 #: apt-ftparchive.1.xml:362
5515 "for i in Sections do \n"
5516 " for j in Architectures do\n"
5517 " Generate for DIST=scope SECTION=i ARCH=j\n"
5521 #. type: Content of: <refentry><refsect1><refsect2><para>
5522 #: apt-ftparchive.1.xml:359
5524 "When processing a <literal>Tree</literal> section "
5525 "<command>apt-ftparchive</command> performs an operation similar to: "
5526 "<placeholder type=\"programlisting\" id=\"0\"/>"
5529 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5530 #: apt-ftparchive.1.xml:370
5532 "This is a space separated list of sections which appear under the "
5533 "distribution; typically this is something like <literal>main contrib "
5534 "non-free</literal>"
5537 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5538 #: apt-ftparchive.1.xml:377
5540 "This is a space separated list of all the architectures that appear under "
5541 "search section. The special architecture 'source' is used to indicate that "
5542 "this tree has a source archive."
5545 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5546 #: apt-ftparchive.1.xml:390
5548 "Sets the binary override file. The override file contains section, priority "
5549 "and maintainer address information."
5552 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5553 #: apt-ftparchive.1.xml:396
5555 "Sets the source override file. The override file contains section "
5559 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5560 #: apt-ftparchive.1.xml:402 apt-ftparchive.1.xml:448
5561 msgid "Sets the binary extra override file."
5564 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5565 #: apt-ftparchive.1.xml:407 apt-ftparchive.1.xml:453
5566 msgid "Sets the source extra override file."
5569 #. type: Content of: <refentry><refsect1><refsect2><title>
5570 #: apt-ftparchive.1.xml:412
5571 msgid "<literal>BinDirectory</literal> Section"
5574 #. type: Content of: <refentry><refsect1><refsect2><para>
5575 #: apt-ftparchive.1.xml:414
5577 "The <literal>bindirectory</literal> section defines a binary directory tree "
5578 "with no special structure. The scope tag specifies the location of the "
5579 "binary directory and the settings are similar to the <literal>Tree</literal> "
5580 "section with no substitution variables or "
5581 "<literal>Section</literal><literal>Architecture</literal> settings."
5584 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5585 #: apt-ftparchive.1.xml:422
5586 msgid "Sets the Packages file output."
5589 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5590 #: apt-ftparchive.1.xml:427
5592 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
5593 "<literal>Sources</literal> is required."
5596 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5597 #: apt-ftparchive.1.xml:433
5598 msgid "Sets the Contents file output (optional)."
5601 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5602 #: apt-ftparchive.1.xml:438
5603 msgid "Sets the binary override file."
5606 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5607 #: apt-ftparchive.1.xml:443
5608 msgid "Sets the source override file."
5611 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5612 #: apt-ftparchive.1.xml:458
5613 msgid "Sets the cache DB."
5616 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5617 #: apt-ftparchive.1.xml:463
5618 msgid "Appends a path to all the output paths."
5621 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5622 #: apt-ftparchive.1.xml:468
5623 msgid "Specifies the file list file."
5626 #. type: Content of: <refentry><refsect1><title>
5627 #: apt-ftparchive.1.xml:475
5628 msgid "The Binary Override File"
5631 #. type: Content of: <refentry><refsect1><para>
5632 #: apt-ftparchive.1.xml:476
5634 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
5635 "contains four fields separated by spaces. The first field is the package "
5636 "name, the second is the priority to force that package to, the third is the "
5637 "section to force that package to and the final field is the maintainer "
5638 "permutation field."
5641 #. type: Content of: <refentry><refsect1><para><literallayout>
5642 #: apt-ftparchive.1.xml:482
5644 msgid "old [// oldn]* => new"
5647 #. type: Content of: <refentry><refsect1><para><literallayout>
5648 #: apt-ftparchive.1.xml:484
5653 #. type: Content of: <refentry><refsect1><para>
5654 #: apt-ftparchive.1.xml:481
5656 "The general form of the maintainer field is: <placeholder "
5657 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
5658 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
5659 "separated list of old email addresses to be specified. If any of those are "
5660 "found then new is substituted for the maintainer field. The second form "
5661 "unconditionally substitutes the maintainer field."
5664 #. type: Content of: <refentry><refsect1><title>
5665 #: apt-ftparchive.1.xml:492
5666 msgid "The Source Override File"
5669 #. type: Content of: <refentry><refsect1><para>
5670 #: apt-ftparchive.1.xml:494
5672 "The source override file is fully compatible with &dpkg-scansources;. It "
5673 "contains two fields separated by spaces. The first field is the source "
5674 "package name, the second is the section to assign it."
5677 #. type: Content of: <refentry><refsect1><title>
5678 #: apt-ftparchive.1.xml:499
5679 msgid "The Extra Override File"
5682 #. type: Content of: <refentry><refsect1><para>
5683 #: apt-ftparchive.1.xml:501
5685 "The extra override file allows any arbitrary tag to be added or replaced in "
5686 "the output. It has three columns, the first is the package, the second is "
5687 "the tag and the remainder of the line is the new value."
5690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5691 #: apt-ftparchive.1.xml:512
5693 "Generate the given checksum. These options default to on, when turned off "
5694 "the generated index files will not have the checksum fields where possible. "
5695 "Configuration Items: "
5696 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
5697 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
5698 "where <literal><replaceable>Index</replaceable></literal> can be "
5699 "<literal>Packages</literal>, <literal>Sources</literal> or "
5700 "<literal>Release</literal> and "
5701 "<literal><replaceable>Checksum</replaceable></literal> can be "
5702 "<literal>MD5</literal>, <literal>SHA1</literal> or "
5703 "<literal>SHA256</literal>."
5706 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5707 #: apt-ftparchive.1.xml:523
5709 "Use a binary caching DB. This has no effect on the generate command. "
5710 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
5713 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5714 #: apt-ftparchive.1.xml:529
5716 "Quiet; produces output suitable for logging, omitting progress indicators. "
5717 "More q's will produce more quiet up to a maximum of 2. You can also use "
5718 "<option>-q=#</option> to set the quiet level, overriding the configuration "
5719 "file. Configuration Item: <literal>quiet</literal>."
5722 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5723 #: apt-ftparchive.1.xml:537
5725 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
5726 "then this option actually enables delinking of the files. It defaults to on "
5727 "and can be turned off with <option>--no-delink</option>. Configuration "
5728 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
5731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5732 #: apt-ftparchive.1.xml:545
5734 "Perform contents generation. When this option is set and package indexes are "
5735 "being generated with a cache DB then the file listing will also be extracted "
5736 "and stored in the DB for later use. When using the generate command this "
5737 "option also allows the creation of any Contents files. The default is on. "
5738 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
5741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5742 #: apt-ftparchive.1.xml:555
5744 "Select the source override file to use with the <literal>sources</literal> "
5745 "command. Configuration Item: "
5746 "<literal>APT::FTPArchive::SourceOverride</literal>."
5749 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5750 #: apt-ftparchive.1.xml:561
5752 "Make the caching databases read only. Configuration Item: "
5753 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
5756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5757 #: apt-ftparchive.1.xml:566
5759 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
5760 "commands only package files matching <literal>*_arch.deb</literal> or "
5761 "<literal>*_all.deb</literal> instead of all package files in the given "
5762 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
5765 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5766 #: apt-ftparchive.1.xml:574
5768 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
5769 "packages are recompiled and/or republished with the same version again, this "
5770 "will lead to problems as the now outdated cached metadata like size and "
5771 "checksums will be used. With this option enabled this will no longer happen "
5772 "as it will be checked if the file was changed. Note that this option is set "
5773 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
5774 "multiply versions/builds of a package with the same versionnumber, so in "
5775 "theory nobody will have these problems and therefore all these extra checks "
5779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5780 #: apt-ftparchive.1.xml:586
5782 "This configuration option defaults to \"<literal>true</literal>\" and should "
5783 "only be set to <literal>\"false\"</literal> if the Archive generated with "
5784 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
5785 "that the <filename>Translation-en</filename> master file can only be created "
5786 "in the generate command."
5789 #. type: Content of: <refentry><refsect1><para><programlisting>
5790 #: apt-ftparchive.1.xml:604
5793 "<command>apt-ftparchive</command> packages "
5794 "<replaceable>directory</replaceable> | <command>gzip</command> > "
5795 "<filename>Packages.gz</filename>\n"
5798 #. type: Content of: <refentry><refsect1><para>
5799 #: apt-ftparchive.1.xml:600
5801 "To create a compressed Packages file for a directory containing binary "
5802 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
5805 #. type: Content of: <refentry><refsect1><para>
5806 #: apt-ftparchive.1.xml:614
5808 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
5821 msgid "16 June 1998"
5838 msgid "apt - Advanced Package Tool"
5861 "APT is a management system for software packages. For normal day to day "
5862 "package management there are several frontends available, such as "
5863 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
5864 "System. Some options are only implemented in B<apt-get>(8) though."
5876 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
5877 "B<apt_preferences>(5), B<apt-secure>(8)"
5888 msgid "apt returns zero on normal operation, decimal 100 on error."
5899 msgid "This manpage isn't even started."
5905 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
5906 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
5907 "B<reportbug>(1) command."
5918 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
5921 #. type: <title></title>
5923 msgid "APT User's Guide"
5926 #. type: <author></author>
5927 #: guide.sgml:6 offline.sgml:6
5928 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5931 #. type: <version></version>
5933 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5936 #. type: <abstract></abstract>
5939 "This document provides an overview of how to use the the APT package "
5943 #. type: <copyrightsummary></copyrightsummary>
5945 msgid "Copyright © Jason Gunthorpe, 1998."
5949 #: guide.sgml:21 offline.sgml:22
5951 "\"APT\" and this document are free software; you can redistribute them "
5952 "and/or modify them under the terms of the GNU General Public License as "
5953 "published by the Free Software Foundation; either version 2 of the License, "
5954 "or (at your option) any later version."
5958 #: guide.sgml:24 offline.sgml:25
5960 "For more details, on Debian systems, see the file "
5961 "/usr/share/common-licenses/GPL for the full license."
5964 #. type: <heading></heading>
5972 "The APT package currently contains two sections, the APT "
5973 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
5974 "interface. Both provide a way to install and remove packages as well as "
5975 "download new packages from the Internet."
5978 #. type: <heading></heading>
5980 msgid "Anatomy of the Package System"
5986 "The Debian packaging system has a large amount of information associated "
5987 "with each package to help assure that it integrates cleanly and easily into "
5988 "the system. The most prominent of its features is the dependency system."
5994 "The dependency system allows individual programs to make use of shared "
5995 "elements in the system such as libraries. It simplifies placing infrequently "
5996 "used portions of a program in separate packages to reduce the number of "
5997 "things the average user is required to install. Also, it allows for choices "
5998 "in mail transport agents, X servers and so on."
6004 "The first step to understanding the dependency system is to grasp the "
6005 "concept of a simple dependency. The meaning of a simple dependency is that a "
6006 "package requires another package to be installed at the same time to work "
6013 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6014 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6015 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6016 "simple dependency on emacs, without emacs it is completely useless."
6022 "The other important dependency to understand is a conflicting dependency. It "
6023 "means that a package, when installed with another package, will not work and "
6024 "may possibly be extremely harmful to the system. As an example consider a "
6025 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6026 "have two mail transport agents installed because both need to listen to the "
6027 "network to receive mail. Attempting to install two will seriously damage the "
6028 "system so all mail transport agents have a conflicting dependency with all "
6029 "other mail transport agents."
6035 "As an added complication there is the possibility for a package to pretend "
6036 "to be another package. Consider that exim and sendmail for many intents are "
6037 "identical, they both deliver mail and understand a common interface. Hence, "
6038 "the package system has a way for them to declare that they are both "
6039 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6040 "a mail-transport-agent and other packages that need a mail transport agent "
6041 "depend on mail-transport-agent. This can add a great deal of confusion when "
6042 "trying to manually fix packages."
6048 "At any given time a single dependency may be met by packages that are "
6049 "already installed or it may not be. APT attempts to help resolve dependency "
6050 "issues by providing a number of automatic algorithms that help in selecting "
6051 "packages for installation."
6054 #. type: <heading></heading>
6062 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6063 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6064 "understand .deb files, it works with the package's proper name and can only "
6065 "install .deb archives from a <em>Source</em>."
6071 "The first <footnote><p>If you are using an http proxy server you must set "
6072 "the http_proxy environment variable first, see "
6073 "sources.list(5)</p></footnote> thing that should be done before using "
6074 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6075 "so that it knows what packages are available. This is done with <tt>apt-get "
6076 "update</tt>. For instance,"
6079 #. type: <example></example>
6083 "# apt-get update\n"
6084 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6085 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6086 "Reading Package Lists... Done\n"
6087 "Building Dependency Tree... Done"
6090 #. type: <p><taglist>
6092 msgid "Once updated there are several commands that can be used:"
6095 #. type: <tag></tag>
6103 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6104 "install a new package or remove an existing package, nor will it ever "
6105 "upgrade a package that might cause some other package to break. This can be "
6106 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6107 "the packages that it could not upgrade, this usually means that they depend "
6108 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6109 "<tt>apt-get install</tt> can be used to force these packages to install."
6112 #. type: <tag></tag>
6120 "Install is used to install packages by name. The package is automatically "
6121 "fetched and installed. This can be useful if you already know the name of "
6122 "the package to install and do not want to go into a GUI to select it. Any "
6123 "number of packages may be passed to install, they will all be "
6124 "fetched. Install automatically attempts to resolve dependency problems with "
6125 "the listed packages and will print a summary and ask for confirmation if "
6126 "anything other than its arguments are changed."
6129 #. type: <tag></tag>
6131 msgid "dist-upgrade"
6137 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6138 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6139 "set of packages to install, upgrade and remove to get as much of the system "
6140 "to the newest release. In some situations it may be desired to use "
6141 "dist-upgrade rather than spend the time manually resolving dependencies in "
6142 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6143 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6150 "It is important to closely look at what dist-upgrade is going to do, its "
6151 "decisions may sometimes be quite surprising."
6157 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6158 "its man page, <manref name=\"apt-get\" section=\"8\">. The most useful "
6159 "option is <tt>-d</tt> which does not install the fetched files. If the "
6160 "system has to download a large number of package it would be undesired to "
6161 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6162 "the downloaded archives can be installed by simply running the command that "
6163 "caused them to be downloaded again without <tt>-d</tt>."
6166 #. type: <heading></heading>
6174 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6175 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6176 "to select the packages to be installed or removed and APT actually installs "
6183 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6184 "and then choose the APT method. You will be prompted for a set of "
6185 "<em>Sources</em> which are places to fetch archives from. These can be "
6186 "remote Internet sites, local Debian mirrors or CD-ROMs. Each source can "
6187 "provide a fragment of the total Debian archive, APT will automatically "
6188 "combine them to form a complete set of packages. If you have a CD-ROM then "
6189 "it is a good idea to specify it first and then specify a mirror so that you "
6190 "have access to the latest bug fixes. APT will automatically use packages on "
6191 "your CD-ROM before downloading from the Internet."
6194 #. type: <example></example>
6198 " Set up a list of distribution source locations\n"
6200 " Please give the base URL of the debian distribution.\n"
6201 " The access schemes I know about are: http file\n"
6204 " file:/mnt/debian,\n"
6205 " ftp://ftp.debian.org/debian,\n"
6206 " http://ftp.de.debian.org/debian,\n"
6209 " URL [http://llug.sep.bnl.gov/debian]:"
6215 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6216 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6220 #. type: <example></example>
6224 " Please give the distribution tag to get or a path to the\n"
6225 " package file ending in a /. The distribution\n"
6226 " tags are typically something like: stable unstable testing non-US\n"
6228 " Distribution [stable]:"
6234 "The distribution refers to the Debian version in the archive, "
6235 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6236 "refers to the developmental version. <em>non-US</em> is only available on "
6237 "some mirrors and refers to packages that contain encryption technology or "
6238 "other things that cannot be exported from the United States. Importing these "
6239 "packages into the US is legal however."
6242 #. type: <example></example>
6246 " Please give the components to get\n"
6247 " The components are typically something like: main contrib non-free\n"
6249 " Components [main contrib non-free]:"
6255 "The components list refers to the list of sub distributions to fetch. The "
6256 "distribution is split up based on software licenses, main being DFSG free "
6257 "packages while contrib and non-free contain things that have various "
6258 "restrictions placed on their use and distribution."
6264 "Any number of sources can be added, the setup script will continue to prompt "
6265 "until you have specified all that you want."
6271 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6272 "available list by selecting [U]pdate from the menu. This is a superset of "
6273 "<tt>apt-get update</tt> that makes the fetched information available to "
6274 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6275 "update</tt> has been run before."
6281 "You can then go on and make your selections using [S]elect and then perform "
6282 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6283 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6290 "By default APT will automatically remove the package (.deb) files once they "
6291 "have been successfully installed. To change this behavior place "
6292 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6295 #. type: <heading></heading>
6297 msgid "The Interface"
6303 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6304 "same interface. It is a simple system that generally tells you what it will "
6305 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6306 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6307 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6308 "alone.</p></footnote> After printing out a summary of what will happen APT "
6309 "then will print out some informative status messages so that you can "
6310 "estimate how far along it is and how much is left to do."
6313 #. type: <heading></heading>
6321 "Before all operations except update, APT performs a number of actions to "
6322 "prepare its internal state. It also does some checks of the system's "
6323 "state. At any time these operations can be performed by running <tt>apt-get "
6327 #. type: <example></example>
6332 "Reading Package Lists... Done\n"
6333 "Building Dependency Tree... Done"
6339 "The first thing it does is read all the package files into memory. APT uses "
6340 "a caching scheme so this operation will be faster the second time it is "
6341 "run. If some of the package files are not found then they will be ignored "
6342 "and a warning will be printed when apt-get exits."
6348 "The final operation performs a detailed analysis of the system's "
6349 "dependencies. It checks every dependency of every installed or unpacked "
6350 "package and considers if it is OK. Should this find a problem then a report "
6351 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6354 #. type: <example></example>
6359 "Reading Package Lists... Done\n"
6360 "Building Dependency Tree... Done\n"
6361 "You might want to run apt-get -f install' to correct these.\n"
6362 "Sorry, but the following packages have unmet dependencies:\n"
6363 " 9fonts: Depends: xlib6g but it is not installed\n"
6364 " uucp: Depends: mailx but it is not installed\n"
6365 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6366 " adduser: Depends: perl-base but it is not installed\n"
6367 " aumix: Depends: libgpmg1 but it is not installed\n"
6368 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6369 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6370 " cthugha: Depends: svgalibg1 but it is not installed\n"
6371 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6372 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6378 "In this example the system has many problems, including a serious problem "
6379 "with libreadlineg2. For each package that has unmet dependencies a line is "
6380 "printed out indicating the package with the problem and the dependencies "
6381 "that are unmet. A short explanation of why the package has a dependency "
6382 "problem is also included."
6388 "There are two ways a system can get into a broken state like this. The first "
6389 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6390 "packages when performing upgrades. <footnote><p>APT however considers all "
6391 "known dependencies and attempts to prevent broken "
6392 "packages</p></footnote>. The second is if a package installation fails "
6393 "during an operation. In this situation a package may have been unpacked "
6394 "without its dependents being installed."
6400 "The second situation is much less serious than the first because APT places "
6401 "certain constraints on the order that packages are installed. In both cases "
6402 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6403 "deduce a possible solution to the problem and then continue on. The APT "
6404 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6405 "for easy continuation of failed maintainer scripts."
6411 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6412 "system caused by the first case then it is possible that it will either fail "
6413 "immediately or the installation sequence will fail. In either case it is "
6414 "necessary to manually use dpkg (possibly with forcing options) to correct "
6415 "the situation enough to allow APT to proceed."
6418 #. type: <heading></heading>
6420 msgid "The Status Report"
6426 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6427 "happen. Generally the report reflects the type of operation being performed "
6428 "but there are several common elements. In all cases the lists reflect the "
6429 "final state of things, taking into account the <tt>-f</tt> option and any "
6430 "other relevant activities to the command being executed."
6433 #. type: <heading></heading>
6435 msgid "The Extra Package list"
6438 #. type: <example></example>
6442 "The following extra packages will be installed:\n"
6443 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6444 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6445 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6446 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6453 "The Extra Package list shows all of the packages that will be installed or "
6454 "upgraded in excess of the ones mentioned on the command line. It is only "
6455 "generated for an <tt>install</tt> command. The listed packages are often the "
6456 "result of an Auto Install."
6459 #. type: <heading></heading>
6461 msgid "The Packages to Remove"
6464 #. type: <example></example>
6468 "The following packages will be REMOVED:\n"
6469 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6470 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6471 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6478 "The Packages to Remove list shows all of the packages that will be removed "
6479 "from the system. It can be shown for any of the operations and should be "
6480 "given a careful inspection to ensure nothing important is to be taken "
6481 "off. The <tt>-f</tt> option is especially good at generating packages to "
6482 "remove so extreme care should be used in that case. The list may contain "
6483 "packages that are going to be removed because they are only partially "
6484 "installed, possibly due to an aborted installation."
6487 #. type: <heading></heading>
6489 msgid "The New Packages list"
6492 #. type: <example></example>
6496 "The following NEW packages will installed:\n"
6497 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6503 "The New Packages list is simply a reminder of what will happen. The packages "
6504 "listed are not presently installed in the system but will be when APT is "
6508 #. type: <heading></heading>
6510 msgid "The Kept Back list"
6513 #. type: <example></example>
6517 "The following packages have been kept back\n"
6518 " compface man-db tetex-base msql libpaper svgalib1\n"
6519 " gs snmp arena lynx xpat2 groff xscreensaver"
6525 "Whenever the whole system is being upgraded there is the possibility that "
6526 "new versions of packages cannot be installed because they require new things "
6527 "or conflict with already installed things. In this case the package will "
6528 "appear in the Kept Back list. The best way to convince packages listed there "
6529 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6530 "to resolve their problems."
6533 #. type: <heading></heading>
6535 msgid "Held Packages warning"
6538 #. type: <example></example>
6542 "The following held packages will be changed:\n"
6549 "Sometimes you can ask APT to install a package that is on hold, in such a "
6550 "case it prints out a warning that the held package is going to be "
6551 "changed. This should only happen during dist-upgrade or install."
6554 #. type: <heading></heading>
6556 msgid "Final summary"
6561 msgid "Finally, APT will print out a summary of all the changes that will occur."
6564 #. type: <example></example>
6568 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6570 "12 packages not fully installed or removed.\n"
6571 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6577 "The first line of the summary simply is a reduced version of all of the "
6578 "lists and includes the number of upgrades - that is packages already "
6579 "installed that have new versions available. The second line indicates the "
6580 "number of poorly configured packages, possibly the result of an aborted "
6581 "installation. The final line shows the space requirements that the "
6582 "installation needs. The first pair of numbers refer to the size of the "
6583 "archive files. The first number indicates the number of bytes that must be "
6584 "fetched from remote locations and the second indicates the total size of all "
6585 "the archives required. The next number indicates the size difference between "
6586 "the presently installed packages and the newly installed packages. It is "
6587 "roughly equivalent to the space required in /usr after everything is "
6588 "done. If a large number of packages are being removed then the value may "
6589 "indicate the amount of space that will be freed."
6595 "Some other reports can be generated by using the -u option to show packages "
6596 "to upgrade, they are similar to the previous examples."
6599 #. type: <heading></heading>
6601 msgid "The Status Display"
6607 "During the download of archives and package files APT prints out a series of "
6611 #. type: <example></example>
6615 "# apt-get update\n"
6616 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6617 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6618 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6619 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6621 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6622 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6628 "The lines starting with <em>Get</em> are printed out when APT begins to "
6629 "fetch a file while the last line indicates the progress of the download. The "
6630 "first percent value on the progress line indicates the total percent done of "
6631 "all files. Unfortunately since the size of the Package files is unknown "
6632 "<tt>apt-get update</tt> estimates the percent done which causes some "
6639 "The next section of the status line is repeated once for each download "
6640 "thread and indicates the operation being performed and some useful "
6641 "information about what is happening. Sometimes this section will simply read "
6642 "<em>Forking</em> which means the OS is loading the download module. The "
6643 "first word after the [ is the fetch number as shown on the history "
6644 "lines. The next word is the short form name of the object being "
6645 "downloaded. For archives it will contain the name of the package that is "
6652 "Inside of the single quote is an informative string indicating the progress "
6653 "of the negotiation phase of the download. Typically it progresses from "
6654 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6655 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6656 "the remote site. Once the download begins this is represented as "
6657 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6658 "kilobytes is expected. The total size is always shown in 4 figure notation "
6659 "to preserve space. After the size display is a percent meter for the file "
6660 "itself. The second last element is the instantaneous average speed. This "
6661 "values is updated every 5 seconds and reflects the rate of data transfer for "
6662 "that period. Finally is shown the estimated transfer time. This is updated "
6663 "regularly and reflects the time to complete everything at the shown transfer "
6670 "The status display updates every half second to provide a constant feedback "
6671 "on the download progress while the Get lines scroll back whenever a new file "
6672 "is started. Since the status display is constantly updated it is unsuitable "
6673 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6677 #. type: <heading></heading>
6685 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6686 "to the <prgn>dpkg</prgn> interface once downloading is "
6687 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6688 "processes the packages and the packages themselves may also ask several "
6689 "questions. Before each question there is usually a description of what it is "
6690 "asking and the questions are too varied to discuss completely here."
6693 #. type: <title></title>
6695 msgid "Using APT Offline"
6698 #. type: <version></version>
6700 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6703 #. type: <abstract></abstract>
6706 "This document describes how to use APT in a non-networked environment, "
6707 "specifically a 'sneaker-net' approach for performing upgrades."
6710 #. type: <copyrightsummary></copyrightsummary>
6712 msgid "Copyright © Jason Gunthorpe, 1999."
6715 #. type: <heading></heading>
6717 msgid "Introduction"
6720 #. type: <heading></heading>
6721 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6728 "Normally APT requires direct access to a Debian archive, either from a local "
6729 "media or through a network. Another common complaint is that a Debian "
6730 "machine is on a slow link, such as a modem and another machine has a very "
6731 "fast connection but they are physically distant."
6737 "The solution to this is to use large removable media such as a Zip disc or a "
6738 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6739 "archive but can easily fit a subset large enough for most users. The idea is "
6740 "to use APT to generate a list of packages that are required and then fetch "
6741 "them onto the disc using another machine with good connectivity. It is even "
6742 "possible to use another Debian machine with APT or to use a completely "
6743 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6744 "the machine downloading the packages, and <em>target host</em> the one with "
6745 "bad or no connection."
6751 "This is achieved by creatively manipulating the APT configuration file. The "
6752 "essential premise to tell APT to look on a disc for it's archive files. Note "
6753 "that the disc should be formated with a filesystem that can handle long file "
6754 "names such as ext2, fat32 or vfat."
6757 #. type: <heading></heading>
6759 msgid "Using APT on both machines"
6762 #. type: <p><example>
6765 "APT being available on both machines gives the simplest configuration. The "
6766 "basic idea is to place a copy of the status file on the disc and use the "
6767 "remote machine to fetch the latest package files and decide which packages "
6768 "to download. The disk directory structure should look like:"
6771 #. type: <example></example>
6785 #. type: <heading></heading>
6787 msgid "The configuration file"
6793 "The configuration file should tell APT to store its files on the disc and to "
6794 "use the configuration files on the disc as well. The sources.list should "
6795 "contain the proper sites that you wish to use from the remote machine, and "
6796 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6797 "<em>target host</em>. Please note, if you are using a local archive you must "
6798 "use copy URIs, the syntax is identical to file URIs."
6801 #. type: <p><example>
6804 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6808 #. type: <example></example>
6814 " /* This is not necessary if the two machines are the same arch, it "
6816 " the remote APT what architecture the target machine is */\n"
6817 " Architecture \"i386\";\n"
6819 " Get::Download-Only \"true\";\n"
6824 " /* Use the disc for state information and redirect the status file from\n"
6825 " the /var/lib/dpkg default */\n"
6826 " State \"/disc/\";\n"
6827 " State::status \"status\";\n"
6829 " // Binary caches will be stored locally\n"
6830 " Cache::archives \"/disc/archives/\";\n"
6831 " Cache \"/tmp/\";\n"
6833 " // Location of the source list.\n"
6834 " Etc \"/disc/\";\n"
6838 #. type: </example></p>
6841 "More details can be seen by examining the apt.conf man page and the sample "
6842 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6845 #. type: <p><example>
6848 "On the target machine the first thing to do is mount the disc and copy "
6849 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6850 "directories outlined in the Overview, <em>archives/partial/</em> and "
6851 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6852 "configure the sources.list. On the remote machine execute the following:"
6855 #. type: <example></example>
6859 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6860 " # apt-get update\n"
6861 " [ APT fetches the package files ]\n"
6862 " # apt-get dist-upgrade\n"
6863 " [ APT fetches all the packages needed to upgrade the target machine ]"
6866 #. type: </example></p>
6869 "The dist-upgrade command can be replaced with any other standard APT "
6870 "commands, particularly dselect-upgrade. You can even use an APT front end "
6871 "such as <em>dselect</em>. However this presents a problem in communicating "
6872 "your selections back to the local computer."
6875 #. type: <p><example>
6878 "Now the disc contains all of the index files and archives needed to upgrade "
6879 "the target machine. Take the disc back and run:"
6882 #. type: <example></example>
6886 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6887 " # apt-get check\n"
6888 " [ APT generates a local copy of the cache files ]\n"
6889 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6890 " [ Or any other APT command ]"
6896 "It is necessary for proper function to re-specify the status file to be the "
6897 "local one. This is very important!"
6903 "If you are using dselect you can do the very risky operation of copying "
6904 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6905 "remote machine are updated. I highly recommend that people only make "
6906 "selections on the local machine - but this may not always be possible. DO "
6907 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6910 #. type: <heading></heading>
6912 msgid "Using APT and wget"
6918 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6919 "any machine. Unlike the method above this requires that the Debian machine "
6920 "already has a list of available packages."
6926 "The basic idea is to create a disc that has only the archive files "
6927 "downloaded from the remote site. This is done by using the --print-uris "
6928 "option to apt-get and then preparing a wget script to actually fetch the "
6932 #. type: <heading></heading>
6937 #. type: <p><example>
6940 "Unlike the previous technique no special configuration files are "
6941 "required. We merely use the standard APT commands to generate the file list."
6944 #. type: <example></example>
6948 " # apt-get dist-upgrade \n"
6949 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6950 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6951 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6954 #. type: </example></p>
6957 "Any command other than dist-upgrade could be used here, including "
6964 "The /disc/wget-script file will now contain a list of wget commands to "
6965 "execute in order to fetch the necessary archives. This script should be run "
6966 "with the current directory as the disc's mount point so as to save the "
6967 "output on the disc."
6970 #. type: <p><example>
6972 msgid "The remote machine would do something like"
6975 #. type: <example></example>
6980 " # sh -x ./wget-script\n"
6984 #. type: </example><example>
6987 "Once the archives are downloaded and the disc returned to the Debian machine "
6988 "installation can proceed using,"
6991 #. type: <example></example>
6994 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
6997 #. type: </example></p>
6999 msgid "Which will use the already fetched archives on the disc."