1 # Translation of apt manpages and documentation to LANGUAGE
2 # This file is distributed under the same license as the apt-doc package.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: apt-doc 1.1~exp14\n"
9 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
10 "POT-Creation-Date: 2015-10-27 10:30+0100\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
23 "<!ENTITY apt-author.team \"\n"
25 " <othername>APT team</othername>\n"
26 " <contrib></contrib>\n"
35 "<!ENTITY apt-qapage \"\n"
37 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
46 "<!-- Boiler plate Bug reporting section -->\n"
47 "<!ENTITY manbugs \"\n"
48 " <refsect1><title>Bugs</title>\n"
49 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
50 " If you wish to report a bug in APT, please see\n"
51 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
52 " &reportbug; command.\n"
62 "<!-- Boiler plate Author section -->\n"
63 "<!ENTITY manauthor \"\n"
64 " <refsect1><title>Author</title>\n"
65 " <para>APT was written by the APT team "
66 "<email>apt@packages.debian.org</email>.\n"
76 "<!-- Should be used within the option section of the text to\n"
77 " put in the blurb about -h, -v, -c and -o -->\n"
78 "<!ENTITY apt-commonoptions \"\n"
79 " <varlistentry><term><option>-h</option></term>\n"
80 " <term><option>--help</option></term>\n"
81 " <listitem><para>Show a short usage summary.\n"
92 " <term><option>-v</option></term>\n"
93 " <term><option>--version</option></term>\n"
94 " <listitem><para>Show the program version.\n"
105 " <term><option>-c</option></term>\n"
106 " <term><option>--config-file</option></term>\n"
107 " <listitem><para>Configuration File; Specify a configuration file to "
109 " The program will read the default configuration file and then this \n"
110 " configuration file. If configuration settings need to be set before "
112 " default configuration files are parsed specify a file with the "
113 "<envar>APT_CONFIG</envar>\n"
114 " environment variable. See &apt-conf; for syntax information.\n"
125 " <term><option>-o</option></term>\n"
126 " <term><option>--option</option></term>\n"
127 " <listitem><para>Set a Configuration Option; This will set an "
129 " configuration option. The syntax is <option>-o "
130 "Foo::Bar=bar</option>.\n"
131 " <option>-o</option> and <option>--option</option> can be used "
133 " times to set different options.\n"
144 "<!-- Should be used within the option section of the text to\n"
145 " put in the blurb about -h, -v, -c and -o -->\n"
146 "<!ENTITY apt-cmdblurb \"\n"
147 " <para>All command line options may be set using the configuration file, "
149 " descriptions indicate the configuration option to set. For boolean\n"
150 " options you can override the config file by using something like \n"
151 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
152 " or several other variations.\n"
161 "<!ENTITY file-aptconf \"\n"
162 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
163 " <listitem><para>APT configuration file.\n"
164 " Configuration Item: "
165 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
173 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
174 " <listitem><para>APT configuration file fragments.\n"
175 " Configuration Item: "
176 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
185 "<!ENTITY file-cachearchives \"\n"
186 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
187 " <listitem><para>Storage area for retrieved package files.\n"
188 " Configuration Item: "
189 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
198 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
199 " <listitem><para>Storage area for package files in transit.\n"
200 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
201 "(<filename>partial</filename> will be implicitly "
202 "appended)</para></listitem>\n"
211 "<!ENTITY file-preferences \"\n"
212 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
213 " <listitem><para>Version preferences file.\n"
214 " This is where you would specify "pinning",\n"
215 " i.e. a preference to get certain packages\n"
216 " from a separate source\n"
217 " or from a different version of a distribution.\n"
218 " Configuration Item: "
219 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
228 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
229 " <listitem><para>File fragments for the version preferences.\n"
230 " Configuration Item: "
231 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
240 "<!ENTITY file-sourceslist \"\n"
241 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
242 " <listitem><para>Locations to fetch packages from.\n"
243 " Configuration Item: "
244 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
253 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
254 " <listitem><para>File fragments for locations to fetch packages from.\n"
255 " Configuration Item: "
256 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
265 "<!ENTITY file-statelists \"\n"
266 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
267 " <listitem><para>Storage area for state information for each package "
268 "resource specified in\n"
270 " Configuration Item: "
271 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
280 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
281 " <listitem><para>Storage area for state information in transit.\n"
282 " Configuration Item: <literal>Dir::State::Lists</literal> "
283 "(<filename>partial</filename> will be implicitly "
284 "appended)</para></listitem>\n"
293 "<!ENTITY file-trustedgpg \"\n"
294 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
295 " <listitem><para>Keyring of local trusted keys, new keys will be added "
297 " Configuration Item: "
298 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
307 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
308 " <listitem><para>File fragments for the trusted keys, additional "
310 " be stored here (by other packages or the administrator).\n"
311 " Configuration Item "
312 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
321 "<!ENTITY file-extended_states \"\n"
323 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
324 " <listitem><para>Status list of auto-installed packages.\n"
325 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
326 " </para></listitem>\n"
335 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
337 " to the other headers like NAME and DESCRIPTION and should therefore be "
339 "<!ENTITY translation-title \"TRANSLATION\">\n"
346 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
348 " to the translation in the past, who is responsible now and maybe "
349 "further information\n"
350 " specially related to your translation. -->\n"
351 "<!ENTITY translation-holder \"\n"
352 " The english translation was done by John Doe "
353 "<email>john@doe.org</email> in 2009,\n"
354 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
356 " Debian Dummy l10n Team "
357 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
365 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
366 "untranslated/fuzzy strings\n"
367 " in a shipped manpage newer/modified paragraphs will maybe appear in "
369 " the generated manpage. This sentence is therefore here to tell the "
371 " is not a mistake by the translator - obviously the target is that at "
373 " releases this sentence is not needed. :) -->\n"
374 "<!ENTITY translation-english \"\n"
375 " Note that this translated document may contain untranslated parts.\n"
376 " This is done on purpose, to avoid losing content when the\n"
377 " translation is lagging behind the original content.\n"
384 "<!-- TRANSLATOR: used as in -o=config_string "
385 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
392 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
393 "synopsis-config-file \"config_file\">"
399 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
400 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
401 "\"target_release\">"
407 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
408 "synopsis-architecture \"architecture\">"
414 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
415 "--> <!ENTITY synopsis-pkg \"pkg\">"
421 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
422 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
428 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
429 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
435 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
436 "awesome --> <!ENTITY synopsis-regex \"regex\">"
442 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
443 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
449 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
450 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
451 "\"temporary_directory\">"
457 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
458 "synopsis-filename \"filename\">"
464 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
465 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
471 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
472 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
479 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
480 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
487 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
488 "generate section --> <!ENTITY synopsis-section \"section\">"
494 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
495 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
498 #. type: Content of: <refentry><refmeta><manvolnum>
499 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
500 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
504 #. type: Content of: <refentry><refmeta><refmiscinfo>
505 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
506 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
507 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
508 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
512 #. type: Content of: <refentry><refnamediv><refpurpose>
514 msgid "command-line interface"
517 #. type: Content of: <refentry><refsect1><title>
518 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
519 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
520 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
521 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
525 #. type: Content of: <refentry><refsect1><para>
528 "<command>apt</command> provides a high-level commandline interface for the "
529 "package management system. It is intended as an end user interface and "
530 "enables some options better suited for interactive usage by default compared "
531 "to more specialized APT tools like &apt-get; and &apt-cache;."
534 #. type: Content of: <refentry><refsect1><para>
537 "Much like <command>apt</command> itself, its manpage is intended as an end "
538 "user interface and as such only mentions the most used commands and options "
539 "partly to not duplicate information in multiple places and partly to avoid "
540 "overwhelming readers with a cornucopia of options and details."
543 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
544 #: apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1
548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
551 "<option>update</option> is used to download package information from all "
552 "configured sources. Other commands operate on this data to e.g. perform "
553 "package upgrades or search in and display details about all packages "
554 "available for installation."
557 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
560 "<option>upgrade</option> is used to install available upgrades of all "
561 "packages currently installed on the system from the sources configured via "
562 "&sources-list;. New packages will be installed if required to statisfy "
563 "dependencies, but existing packages will never be removed. If an upgrade for "
564 "a package requires the remove of an installed package the upgrade for this "
565 "package isn't performed."
568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
571 "<literal>full-upgrade</literal> performs the function of upgrade but will "
572 "remove currently installed packages if this is needed to upgrade the system "
576 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
577 #: apt.8.xml:1 apt.8.xml:1
581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
584 "Performs the requested action on one or more packages specified via ®ex;, "
585 "&glob; or exact match. The requested action can be overidden for specific "
586 "packages by append a plus (+) to the package name to install this package or "
587 "a minus (-) to remove it."
590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
593 "A specific version of a package can be selected for installation by "
594 "following the package name with an equals (=) and the version of the package "
595 "to select. Alternatively the version from a specific release can be selected "
596 "by following the package name with a forward slash (/) and codename "
597 "(&stable-codename;, &testing-codename;, sid …) or suite name (stable, "
598 "testing, unstable). This will also select versions from this release for "
599 "dependencies of this package if needed to satisfy the request."
602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
605 "Removing a package removes all packaged data, but leaves usually small "
606 "(modified) user configuration files behind, in case the remove was an "
607 "accident. Just issuing an installtion request for the accidentally removed "
608 "package will restore it funcation as before in that case. On the other hand "
609 "you can get right of these leftovers via calling <command>purge</command> "
610 "even on already removed packages. Note that this does not effect any data "
611 "or configuration stored in your home directory."
614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
617 "<literal>autoremove</literal> is used to remove packages that were "
618 "automatically installed to satisfy dependencies for other packages and are "
619 "now no longer needed as dependencies changed or the package(s) needing them "
620 "were removed in the meantime."
623 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
626 "Try to ensure that the list does not include applications you have grown to "
627 "like even through they there once installed just as a dependency of another "
628 "package. You can mark such a package as manually installed by using "
629 "&apt-mark;. Packages which you have installed explicitly via "
630 "<command>install</command> are never proposed for automatic removal as well."
633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
634 #: apt.8.xml:1 apt.8.xml:1
635 msgid "(&apt-cache;)"
638 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
641 "<option>search</option> can be used to search for the given ®ex; term(s) "
642 "in the list of the available packages and display matches. This can e.g. be "
643 "useful if you are looking for packages having a specific feature. If you "
644 "are looking for a package including a specific file try &apt-file;."
647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
650 "Show information about the given package(s) including its dependencies, "
651 "installation and download size, sources the package is available from, the "
652 "description of the packages content and many more. It can e.g. be helpful to "
653 "look at this information before allowing &apt; to remove a package or while "
654 "searching for new packages to install."
657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
658 #: apt.8.xml:1 apt.8.xml:1
659 msgid "(work-in-progress)"
662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
665 "<option>list</option> is somewhat similar to <command>dpkg-query "
666 "--list</command> in that it can display a list of packages satisfying "
667 "certain criteria. It supports &glob; patterns for matching package names as "
668 "well as options to list installed (<option>--installed</option>), "
669 "upgradeable (<option>--upgradeable</option>) or all available "
670 "(<option>--all-versions</option>) versions."
673 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
676 "<literal>edit-sources</literal> lets you edit your &sources-list; files in "
677 "your preferred texteditor while also providing basic sanity checks."
680 #. type: Content of: <refentry><refsect1><title>
682 msgid "Script usage and Differences to other APT tools"
685 #. type: Content of: <refentry><refsect1><para>
688 "The &apt; commandline is designed as a end-user tool and it may change "
689 "behaviour between versions. While it tries to not break backward "
690 "compatibility there is no guarantee for it either if it seems benefitial for "
694 #. type: Content of: <refentry><refsect1><para>
697 "All features of &apt; are available in dedicated APT tools like &apt-get; "
698 "and &apt-cache; as well. &apt; just changes the default value of some "
699 "options (see &apt-conf; and specifically the Binary scope). So prefer using "
700 "these commands (potentially with some additional options enabled) in your "
701 "scripts as they keep backward compatibility as much as possible."
704 #. type: Content of: <refentry><refsect1><title>
705 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
706 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
707 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
708 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
712 #. type: Content of: <refentry><refsect1><para>
715 "&apt-get;, &apt-cache;, &sources-list;, &apt-conf;, &apt-config;, The APT "
716 "User's guide in &guidesdir;, &apt-preferences;, the APT Howto."
719 #. type: Content of: <refentry><refsect1><title>
720 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-mark.8.xml:1
721 #: apt-cdrom.8.xml:1 apt-config.8.xml:1 apt-extracttemplates.1.xml:1
722 #: apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
726 #. type: Content of: <refentry><refsect1><para>
729 "<command>apt</command> returns zero on normal operation, decimal 100 on "
733 #. type: Content of: <refentry><refnamediv><refpurpose>
735 msgid "APT package handling utility -- command-line interface"
738 #. type: Content of: <refentry><refsect1><para>
741 "<command>apt-get</command> is the command-line tool for handling packages, "
742 "and may be considered the user's \"back-end\" to other tools using the APT "
743 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
744 "&synaptic; and &wajig;."
747 #. type: Content of: <refentry><refsect1><para>
748 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
749 #: apt-ftparchive.1.xml:1
751 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
752 "one of the commands below must be present."
755 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
758 "<literal>update</literal> is used to resynchronize the package index files "
759 "from their sources. The indexes of available packages are fetched from the "
760 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
761 "example, when using a Debian archive, this command retrieves and scans the "
762 "<filename>Packages.gz</filename> files, so that information about new and "
763 "updated packages is available. An <literal>update</literal> should always be "
764 "performed before an <literal>upgrade</literal> or "
765 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
766 "meter will be incorrect as the size of the package files cannot be known in "
770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
773 "<literal>upgrade</literal> is used to install the newest versions of all "
774 "packages currently installed on the system from the sources enumerated in "
775 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
776 "with new versions available are retrieved and upgraded; under no "
777 "circumstances are currently installed packages removed, or packages not "
778 "already installed retrieved and installed. New versions of currently "
779 "installed packages that cannot be upgraded without changing the install "
780 "status of another package will be left at their current version. An "
781 "<literal>update</literal> must be performed first so that "
782 "<command>apt-get</command> knows that new versions of packages are "
786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
789 "<literal>dist-upgrade</literal> in addition to performing the function of "
790 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
791 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
792 "conflict resolution system, and it will attempt to upgrade the most "
793 "important packages at the expense of less important ones if necessary. The "
794 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
795 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
796 "locations from which to retrieve desired package files. See also "
797 "&apt-preferences; for a mechanism for overriding the general settings for "
798 "individual packages."
801 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
804 "<literal>dselect-upgrade</literal> is used in conjunction with the "
805 "traditional Debian packaging front-end, "
806 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
807 "&dselect; to the <literal>Status</literal> field of available packages, and "
808 "performs the actions necessary to realize that state (for instance, the "
809 "removal of old and the installation of new packages)."
812 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
815 "<literal>install</literal> is followed by one or more packages desired for "
816 "installation or upgrading. Each package is a package name, not a fully "
817 "qualified filename (for instance, in a Debian system, "
818 "<package>apt-utils</package> would be the argument provided, not "
819 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
820 "packages required by the package(s) specified for installation will also be "
821 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
822 "file is used to locate the desired packages. If a hyphen is appended to the "
823 "package name (with no intervening space), the identified package will be "
824 "removed if it is installed. Similarly a plus sign can be used to designate "
825 "a package to install. These latter features may be used to override "
826 "decisions made by apt-get's conflict resolution system."
829 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
832 "A specific version of a package can be selected for installation by "
833 "following the package name with an equals and the version of the package to "
834 "select. This will cause that version to be located and selected for "
835 "install. Alternatively a specific distribution can be selected by following "
836 "the package name with a slash and the version of the distribution or the "
837 "Archive name (stable, testing, unstable)."
840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
843 "Both of the version selection mechanisms can downgrade packages and must be "
847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
850 "This is also the target to use if you want to upgrade one or more "
851 "already-installed packages without upgrading every package you have on your "
852 "system. Unlike the \"upgrade\" target, which installs the newest version of "
853 "all currently installed packages, \"install\" will install the newest "
854 "version of only the package(s) specified. Simply provide the name of the "
855 "package(s) you wish to upgrade, and if a newer version is available, it (and "
856 "its dependencies, as described above) will be downloaded and installed."
859 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
862 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
863 "installation policy for individual packages."
866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
869 "If no package matches the given expression and the expression contains one "
870 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
871 "it is applied to all package names in the database. Any matches are then "
872 "installed (or removed). Note that matching is done by substring so 'lo.*' "
873 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
874 "expression with a '^' or '$' character, or create a more specific regular "
878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
881 "<literal>remove</literal> is identical to <literal>install</literal> except "
882 "that packages are removed instead of installed. Note that removing a package "
883 "leaves its configuration files on the system. If a plus sign is appended to "
884 "the package name (with no intervening space), the identified package will be "
885 "installed instead of removed."
888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
891 "<literal>purge</literal> is identical to <literal>remove</literal> except "
892 "that packages are removed and purged (any configuration files are deleted "
896 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
899 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
900 "packages. APT will examine the available packages to decide which source "
901 "package to fetch. It will then find and download into the current directory "
902 "the newest available version of that source package while respecting the "
903 "default release, set with the option "
904 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
905 "per package with the <literal>pkg/release</literal> syntax, if possible."
908 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
911 "Source packages are tracked separately from binary packages via "
912 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
913 "you will need to add such a line for each repository you want to get sources "
914 "from; otherwise you will probably get either the wrong (too old/too new) "
915 "source versions or none at all."
918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
921 "If the <option>--compile</option> option is specified then the package will "
922 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
923 "the architecture as defined by the <command>--host-architecture</command> "
924 "option. If <option>--download-only</option> is specified then the source "
925 "package will not be unpacked."
928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
931 "A specific source version can be retrieved by postfixing the source name "
932 "with an equals and then the version to fetch, similar to the mechanism used "
933 "for the package files. This enables exact matching of the source package "
934 "name and version, implicitly enabling the "
935 "<literal>APT::Get::Only-Source</literal> option."
938 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
941 "Note that source packages are not installed and tracked in the "
942 "<command>dpkg</command> database like binary packages; they are simply "
943 "downloaded to the current directory, like source tarballs."
946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
949 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
950 "attempt to satisfy the build dependencies for a source package. By default "
951 "the dependencies are satisfied to build the package natively. If desired a "
952 "host-architecture can be specified with the "
953 "<option>--host-architecture</option> option instead."
956 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
959 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
960 "and checks for broken dependencies."
963 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
966 "<literal>download</literal> will download the given binary package into the "
970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
973 "<literal>clean</literal> clears out the local repository of retrieved "
974 "package files. It removes everything but the lock file from "
975 "<filename>&cachedir;/archives/</filename> and "
976 "<filename>&cachedir;/archives/partial/</filename>."
979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
980 #: apt-get.8.xml:1 apt-get.8.xml:1
984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
985 #: apt-get.8.xml:1 apt-get.8.xml:1
986 msgid "alias since 1.1)"
989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
992 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
993 "local repository of retrieved package files. The difference is that it only "
994 "removes package files that can no longer be downloaded, and are largely "
995 "useless. This allows a cache to be maintained over a long period without it "
996 "growing out of control. The configuration option "
997 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
998 "being erased if it is set to off."
1001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1004 "<literal>autoremove</literal> is used to remove packages that were "
1005 "automatically installed to satisfy dependencies for other packages and are "
1006 "now no longer needed."
1009 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1012 "<literal>changelog</literal> tries to download the changelog of a package "
1013 "and displays it through <command>sensible-pager</command>. By default it "
1014 "displays the changelog for the version that is installed. However, you can "
1015 "specify the same options as for the <option>install</option> command."
1018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1021 "Displays by default a deb822 formatted listing of information about all data "
1022 "files (aka index targets) <command>apt-get update</command> would "
1023 "download. Supports a <option>--format</option> option to modify the output "
1024 "format as well as accepts lines of the default output to filter the records "
1025 "by. The command is mainly used as an interface for external tools working "
1026 "with APT to get information as well as filenames for downloaded files so "
1027 "they can use them as well instead of downloading them again on their "
1028 "own. Detailed documentation is omitted here and can instead be found in the "
1030 "<literal><filename>doc/acquire-additional-files.txt</filename></literal>."
1033 #. type: Content of: <refentry><refsect1><title>
1034 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-config.8.xml:1
1035 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
1039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1042 "Do not consider recommended packages as a dependency for installing. "
1043 "Configuration Item: <literal>APT::Install-Recommends</literal>."
1046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1049 "Consider suggested packages as a dependency for installing. Configuration "
1050 "Item: <literal>APT::Install-Suggests</literal>."
1053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1056 "Download only; package files are only retrieved, not unpacked or installed. "
1057 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
1060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1063 "Fix; attempt to correct a system with broken dependencies in place. This "
1064 "option, when used with install/remove, can omit any packages to permit APT "
1065 "to deduce a likely solution. If packages are specified, these have to "
1066 "completely correct the problem. The option is sometimes necessary when "
1067 "running APT for the first time; APT itself does not allow broken package "
1068 "dependencies to exist on a system. It is possible that a system's dependency "
1069 "structure can be so corrupt as to require manual intervention (which usually "
1070 "means using <command>dpkg --remove</command> to eliminate some of the "
1071 "offending packages). Use of this option together with <option>-m</option> "
1072 "may produce an error in some situations. Configuration Item: "
1073 "<literal>APT::Get::Fix-Broken</literal>."
1076 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1079 "Ignore missing packages; if packages cannot be retrieved or fail the "
1080 "integrity check after retrieval (corrupted package files), hold back those "
1081 "packages and handle the result. Use of this option together with "
1082 "<option>-f</option> may produce an error in some situations. If a package is "
1083 "selected for installation (particularly if it is mentioned on the command "
1084 "line) and it could not be downloaded then it will be silently held back. "
1085 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
1088 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1091 "Disables downloading of packages. This is best used with "
1092 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
1093 "already downloaded. Configuration Item: "
1094 "<literal>APT::Get::Download</literal>."
1097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1100 "Quiet; produces output suitable for logging, omitting progress indicators. "
1101 "More q's will produce more quiet up to a maximum of 2. You can also use "
1102 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1103 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
1104 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
1105 "may decide to do something you did not expect. Configuration Item: "
1106 "<literal>quiet</literal>."
1109 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1112 "No action; perform a simulation of events that would occur based on the "
1113 "current system state but do not actually change the system. Locking will be "
1114 "disabled (<option>Debug::NoLocking</option>) so the system state could "
1115 "change while <command>apt-get</command> is running. Simulations can also be "
1116 "executed by non-root users which might not have read access to all apt "
1117 "configuration distorting the simulation. A notice expressing this warning "
1118 "is also shown by default for non-root users "
1119 "(<option>APT::Get::Show-User-Simulation-Note</option>). Configuration Item: "
1120 "<literal>APT::Get::Simulate</literal>."
1123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1126 "Simulated runs print out a series of lines, each representing a "
1127 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
1128 "remove (<literal>Remv</literal>) or unpack "
1129 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
1130 "empty square brackets indicate breaks that are of no consequence (rare)."
1133 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1136 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
1137 "non-interactively. If an undesirable situation, such as changing a held "
1138 "package, trying to install a unauthenticated package or removing an "
1139 "essential package occurs then <literal>apt-get</literal> will abort. "
1140 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
1143 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1146 "Automatic \"no\" to all prompts. Configuration Item: "
1147 "<literal>APT::Get::Assume-No</literal>."
1150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1153 "Show upgraded packages; print out a list of all packages that are to be "
1154 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
1157 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1160 "Show full versions for upgraded and installed packages. Configuration Item: "
1161 "<literal>APT::Get::Show-Versions</literal>."
1164 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1167 "This option controls the architecture packages are built for by "
1168 "<command>apt-get source --compile</command> and how cross-builddependencies "
1169 "are satisfied. By default is it not set which means that the host "
1170 "architecture is the same as the build architecture (which is defined by "
1171 "<literal>APT::Architecture</literal>). Configuration Item: "
1172 "<literal>APT::Get::Host-Architecture</literal>."
1175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1178 "This option controls the activated build profiles for which a source package "
1179 "is built by <command>apt-get source --compile</command> and how build "
1180 "dependencies are satisfied. By default no build profile is active. More "
1181 "than one build profile can be activated at a time by concatenating them with "
1182 "a comma. Configuration Item: <literal>APT::Build-Profiles</literal>."
1185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1188 "Compile source packages after downloading them. Configuration Item: "
1189 "<literal>APT::Get::Compile</literal>."
1192 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1195 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
1196 "hold placed on a package. This may be useful in conjunction with "
1197 "<literal>dist-upgrade</literal> to override a large number of undesired "
1198 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
1201 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1204 "Allow installing new packages when used in conjunction with "
1205 "<literal>upgrade</literal>. This is useful if the update of a installed "
1206 "package requires new dependencies to be installed. Instead of holding the "
1207 "package back <literal>upgrade</literal> will upgrade the package and install "
1208 "the new dependencies. Note that <literal>upgrade</literal> with this option "
1209 "will never remove packages, only allow adding new ones. Configuration Item: "
1210 "<literal>APT::Get::Upgrade-Allow-New</literal>."
1213 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1216 "Do not upgrade packages; when used in conjunction with "
1217 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
1218 "packages on the command line from being upgraded if they are already "
1219 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
1222 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1225 "Do not install new packages; when used in conjunction with "
1226 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
1227 "upgrades for already installed packages only and ignore requests to install "
1228 "new packages. Configuration Item: "
1229 "<literal>APT::Get::Only-Upgrade</literal>."
1232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1235 "This is a dangerous option that will cause apt to continue without prompting "
1236 "if it is doing downgrades. It should not be used except in very special "
1237 "situations. Using it can potentially destroy your system! Configuration "
1238 "Item: <literal>APT::Get::allow-downgrades</literal>. Introduced in APT 1.1."
1241 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1244 "Force yes; this is a dangerous option that will cause apt to continue "
1245 "without prompting if it is removing essentials. It should not be used except "
1246 "in very special situations. Using it can potentially destroy your system! "
1247 "Configuration Item: "
1248 "<literal>APT::Get::allow-remove-essential</literal>. Introduced in APT 1.1."
1251 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1254 "Force yes; this is a dangerous option that will cause apt to continue "
1255 "without prompting if it is changing held packages. It should not be used "
1256 "except in very special situations. Using it can potentially destroy your "
1257 "system! Configuration Item: "
1258 "<literal>APT::Get::allow-change-held-packages</literal>. Introduced in APT "
1262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1265 "Force yes; this is a dangerous option that will cause apt to continue "
1266 "without prompting if it is doing something potentially harmful. It should "
1267 "not be used except in very special situations. Using "
1268 "<literal>force-yes</literal> can potentially destroy your system! "
1269 "Configuration Item: <literal>APT::Get::force-yes</literal>. This is "
1270 "deprecated and replaced by <option>--allow-downgrades</option>, "
1271 "<option>--allow-remove-essential</option>, "
1272 "<option>--allow-change-held-packages</option> in 1.1."
1275 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1278 "Instead of fetching the files to install their URIs are printed. Each URI "
1279 "will have the path, the destination file name, the size and the expected MD5 "
1280 "hash. Note that the file name to write to will not always match the file "
1281 "name on the remote site! This also works with the <literal>source</literal> "
1282 "and <literal>update</literal> commands. When used with the "
1283 "<literal>update</literal> command the MD5 and size are not included, and it "
1284 "is up to the user to decompress any compressed files. Configuration Item: "
1285 "<literal>APT::Get::Print-URIs</literal>."
1288 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1291 "Use purge instead of remove for anything that would be removed. An asterisk "
1292 "(\"*\") will be displayed next to packages which are scheduled to be "
1293 "purged. <option>remove --purge</option> is equivalent to the "
1294 "<option>purge</option> command. Configuration Item: "
1295 "<literal>APT::Get::Purge</literal>."
1298 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1301 "Re-install packages that are already installed and at the newest version. "
1302 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1305 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1308 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1309 "turn it off. When it is on, <command>apt-get</command> will automatically "
1310 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1311 "obsolete files are erased. The only reason to turn it off is if you "
1312 "frequently change your sources list. Configuration Item: "
1313 "<literal>APT::Get::List-Cleanup</literal>."
1316 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1319 "This option controls the default input to the policy engine; it creates a "
1320 "default pin at priority 990 using the specified release string. This "
1321 "overrides the general settings in "
1322 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1323 "not affected by the value of this option. In short, this option lets you "
1324 "have simple control over which distribution packages will be retrieved "
1325 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1326 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1327 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1334 "Only perform operations that are 'trivial'. Logically this can be considered "
1335 "related to <option>--assume-yes</option>; where "
1336 "<option>--assume-yes</option> will answer yes to any prompt, "
1337 "<option>--trivial-only</option> will answer no. Configuration Item: "
1338 "<literal>APT::Get::Trivial-Only</literal>."
1341 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1344 "If any packages are to be removed apt-get immediately aborts without "
1345 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1348 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1351 "If the command is either <literal>install</literal> or "
1352 "<literal>remove</literal>, then this option acts like running the "
1353 "<literal>autoremove</literal> command, removing unused dependency "
1354 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1357 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1360 "Only has meaning for the <literal>source</literal> and "
1361 "<literal>build-dep</literal> commands. Indicates that the given source "
1362 "names are not to be mapped through the binary table. This means that if "
1363 "this option is specified, these commands will only accept source package "
1364 "names as arguments, rather than accepting binary package names and looking "
1365 "up the corresponding source package. Configuration Item: "
1366 "<literal>APT::Get::Only-Source</literal>."
1369 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1372 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1373 "Item: <literal>APT::Get::Diff-Only</literal>, "
1374 "<literal>APT::Get::Dsc-Only</literal>, and "
1375 "<literal>APT::Get::Tar-Only</literal>."
1378 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1381 "Only process architecture-dependent build-dependencies. Configuration Item: "
1382 "<literal>APT::Get::Arch-Only</literal>."
1385 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1388 "Ignore if packages can't be authenticated and don't prompt about it. This "
1389 "can be useful while working with local repositories, but is a huge security "
1390 "risk if data authenticity isn't ensured in another way by the user itself. "
1391 "The usage of the <option>Trusted</option> option for &sources-list; entries "
1392 "should usually be preferred over this global override. Configuration Item: "
1393 "<literal>APT::Get::AllowUnauthenticated</literal>."
1396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1399 "Forbid the update command to acquire unverifiable data from configured "
1400 "sources. Apt will fail at the update command for repositories without valid "
1401 "cryptographically signatures. Configuration Item: "
1402 "<literal>Acquire::AllowInsecureRepositories</literal>."
1405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1408 "Show user friendly progress information in the terminal window when packages "
1409 "are installed, upgraded or removed. For a machine parsable version of this "
1410 "data see README.progress-reporting in the apt doc directory. Configuration "
1411 "Item: <literal>Dpkg::Progress</literal> and "
1412 "<literal>Dpkg::Progress-Fancy</literal>."
1415 #. type: Content of: <refentry><refsect1><title>
1416 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1 apt-mark.8.xml:1
1417 #: apt.conf.5.xml:1 apt_preferences.5.xml:1
1421 #. type: Content of: <refentry><refsect1><para>
1424 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1425 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1429 #. type: Content of: <refentry><refsect1><para>
1432 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1436 #. type: Content of: <refentry><refnamediv><refpurpose>
1437 #: apt-cache.8.xml:1
1438 msgid "query the APT cache"
1441 #. type: Content of: <refentry><refsect1><para>
1442 #: apt-cache.8.xml:1
1444 "<command>apt-cache</command> performs a variety of operations on APT's "
1445 "package cache. <command>apt-cache</command> does not manipulate the state of "
1446 "the system but does provide operations to search and generate interesting "
1447 "output from the package metadata. The metadata is acquired and updated via "
1448 "the 'update' command of e.g. <command>apt-get</command>, so that it can be "
1449 "outdated if the last update is too long ago, but in exchange "
1450 "<command>apt-cache</command> works independently of the availability of the "
1451 "configured sources (e.g. offline)."
1454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1455 #: apt-cache.8.xml:1
1457 "<literal>gencaches</literal> creates APT's package cache. This is done "
1458 "implicitly by all commands needing this cache if it is missing or outdated."
1461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1462 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1463 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1464 msgid "&synopsis-pkg;"
1467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1468 #: apt-cache.8.xml:1
1470 "<literal>showpkg</literal> displays information about the packages listed on "
1471 "the command line. Remaining arguments are package names. The available "
1472 "versions and reverse dependencies of each package listed are listed, as well "
1473 "as forward dependencies for each version. Forward (normal) dependencies are "
1474 "those packages upon which the package in question depends; reverse "
1475 "dependencies are those packages that depend upon the package in "
1476 "question. Thus, forward dependencies must be satisfied for a package, but "
1477 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1478 "libreadline2</command> would produce output similar to the following:"
1481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1482 #: apt-cache.8.xml:1
1485 "Package: libreadline2\n"
1486 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1487 "Reverse Depends: \n"
1488 " libreadlineg2,libreadline2\n"
1489 " libreadline2-altdev,libreadline2\n"
1491 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1494 "Reverse Provides: \n"
1497 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1498 #: apt-cache.8.xml:1
1500 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1501 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1502 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1503 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1504 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1505 "installed. For the specific meaning of the remainder of the output it is "
1506 "best to consult the apt source code."
1509 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1510 #: apt-cache.8.xml:1
1512 "<literal>stats</literal> displays some statistics about the cache. No "
1513 "further arguments are expected. Statistics reported are:"
1516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1517 #: apt-cache.8.xml:1
1519 "<literal>Total package names</literal> is the number of package names found "
1523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1524 #: apt-cache.8.xml:1
1526 "<literal>Normal packages</literal> is the number of regular, ordinary "
1527 "package names; these are packages that bear a one-to-one correspondence "
1528 "between their names and the names used by other packages for them in "
1529 "dependencies. The majority of packages fall into this category."
1532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1533 #: apt-cache.8.xml:1
1535 "<literal>Pure virtual packages</literal> is the number of packages that "
1536 "exist only as a virtual package name; that is, packages only \"provide\" the "
1537 "virtual package name, and no package actually uses the name. For instance, "
1538 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1539 "several packages provide \"mail-transport-agent\", but there is no package "
1540 "named \"mail-transport-agent\"."
1543 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1544 #: apt-cache.8.xml:1
1546 "<literal>Single virtual packages</literal> is the number of packages with "
1547 "only one package providing a particular virtual package. For example, in the "
1548 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1549 "package, xless, provides \"X11-text-viewer\"."
1552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1553 #: apt-cache.8.xml:1
1555 "<literal>Mixed virtual packages</literal> is the number of packages that "
1556 "either provide a particular virtual package or have the virtual package name "
1557 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1558 "an actual package, and provided by the debconf-tiny package."
1561 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1562 #: apt-cache.8.xml:1
1564 "<literal>Missing</literal> is the number of package names that were "
1565 "referenced in a dependency but were not provided by any package. Missing "
1566 "packages may be an evidence if a full distribution is not accessed, or if a "
1567 "package (real or virtual) has been dropped from the distribution. Usually "
1568 "they are referenced from Conflicts or Breaks statements."
1571 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1572 #: apt-cache.8.xml:1
1574 "<literal>Total distinct</literal> versions is the number of package versions "
1575 "found in the cache. If more than one distribution is being accessed (for "
1576 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1577 "larger than the number of total package names."
1580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1581 #: apt-cache.8.xml:1
1583 "<literal>Total dependencies</literal> is the number of dependency "
1584 "relationships claimed by all of the packages in the cache."
1587 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1588 #: apt-cache.8.xml:1
1590 "<literal>showsrc</literal> displays all the source package records that "
1591 "match the given package names. All versions are shown, as well as all "
1592 "records that declare the name to be a binary package. Use "
1593 "<option>--only-source</option> to display only source package names."
1596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1597 #: apt-cache.8.xml:1
1599 "<literal>dump</literal> shows a short listing of every package in the "
1600 "cache. It is primarily for debugging."
1603 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1604 #: apt-cache.8.xml:1
1606 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1607 "suitable for use with &dpkg; and is used by the &dselect; method."
1610 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1611 #: apt-cache.8.xml:1
1613 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1618 #: apt-cache.8.xml:1
1620 "<literal>show</literal> performs a function similar to <command>dpkg "
1621 "--print-avail</command>; it displays the package records for the named "
1625 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1626 #: apt-cache.8.xml:1
1627 msgid "&synopsis-regex;"
1630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1631 #: apt-cache.8.xml:1
1633 "<literal>search</literal> performs a full text search on all available "
1634 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1635 "the package names and the descriptions for an occurrence of the regular "
1636 "expression and prints out the package name and the short description, "
1637 "including virtual package names. If <option>--full</option> is given then "
1638 "output identical to <literal>show</literal> is produced for each matched "
1639 "package, and if <option>--names-only</option> is given then the long "
1640 "description is not searched, only the package name and provided packages "
1644 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1645 #: apt-cache.8.xml:1
1647 "Separate arguments can be used to specify multiple search patterns that are "
1651 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1652 #: apt-cache.8.xml:1
1654 "<literal>depends</literal> shows a listing of each dependency a package has "
1655 "and all the possible other packages that can fulfill that dependency."
1658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1659 #: apt-cache.8.xml:1
1661 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1665 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1666 #: apt-cache.8.xml:1
1667 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1670 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1671 #: apt-cache.8.xml:1
1673 "This command prints the name of each package APT knows. The optional "
1674 "argument is a prefix match to filter the name list. The output is suitable "
1675 "for use in a shell tab complete function and the output is generated "
1676 "extremely quickly. This command is best used with the "
1677 "<option>--generate</option> option."
1680 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1681 #: apt-cache.8.xml:1
1683 "Note that a package which APT knows of is not necessarily available to "
1684 "download, installable or installed, e.g. virtual packages are also listed in "
1685 "the generated list."
1688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1689 #: apt-cache.8.xml:1
1691 "<literal>dotty</literal> takes a list of packages on the command line and "
1692 "generates output suitable for use by dotty from the <ulink "
1693 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1694 "package. The result will be a set of nodes and edges representing the "
1695 "relationships between the packages. By default the given packages will trace "
1696 "out all dependent packages; this can produce a very large graph. To limit "
1697 "the output to only the packages listed on the command line, set the "
1698 "<literal>APT::Cache::GivenOnly</literal> option."
1701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1702 #: apt-cache.8.xml:1
1704 "The resulting nodes will have several shapes; normal packages are boxes, "
1705 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1706 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1707 "packages), blue lines are pre-depends, green lines are conflicts."
1710 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1711 #: apt-cache.8.xml:1
1712 msgid "Caution, dotty cannot graph larger sets of packages."
1715 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1716 #: apt-cache.8.xml:1
1718 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1719 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1723 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1724 #: apt-cache.8.xml:1
1725 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1728 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1729 #: apt-cache.8.xml:1
1731 "<literal>policy</literal> is meant to help debug issues relating to the "
1732 "preferences file. With no arguments it will print out the priorities of each "
1733 "source. Otherwise it prints out detailed information about the priority "
1734 "selection of the named package."
1737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1738 #: apt-cache.8.xml:1
1740 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1741 "to mimic the output format and a subset of the functionality of the Debian "
1742 "archive management tool, <literal>madison</literal>. It displays available "
1743 "versions of a package in a tabular format. Unlike the original "
1744 "<literal>madison</literal>, it can only display information for the "
1745 "architecture for which APT has retrieved package lists "
1746 "(<literal>APT::Architecture</literal>)."
1749 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1750 #: apt-cache.8.xml:1
1752 "Select the file to store the package cache. The package cache is the primary "
1753 "cache used by all operations. Configuration Item: "
1754 "<literal>Dir::Cache::pkgcache</literal>."
1757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1758 #: apt-cache.8.xml:1
1760 "Select the file to store the source cache. The source is used only by "
1761 "<literal>gencaches</literal> and it stores a parsed version of the package "
1762 "information from remote sources. When building the package cache the source "
1763 "cache is used to avoid reparsing all of the package files. Configuration "
1764 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1767 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1768 #: apt-cache.8.xml:1
1770 "Quiet; produces output suitable for logging, omitting progress indicators. "
1771 "More q's will produce more quietness up to a maximum of 2. You can also use "
1772 "<option>-q=#</option> to set the quietness level, overriding the "
1773 "configuration file. Configuration Item: <literal>quiet</literal>."
1776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1777 #: apt-cache.8.xml:1
1779 "Print only important dependencies; for use with <literal>unmet</literal> and "
1780 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1781 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1784 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1785 #: apt-cache.8.xml:1
1787 "Per default the <command>depends</command> and <command>rdepends</command> "
1788 "print all dependencies. This can be tweaked with these flags which will omit "
1789 "the specified dependency type. Configuration Item: "
1790 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1791 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1795 #: apt-cache.8.xml:1
1797 "Per default <command>depends</command> and <command>rdepends</command> print "
1798 "only dependencies explicitly expressed in the metadata. With this flag it "
1799 "will also show dependencies implicitely added based on the encountered "
1800 "data. A <literal>Conflicts: foo</literal> e.g. expresses implicitely that "
1801 "this package also conflicts with the package foo from any other "
1802 "architecture. Configuration Item: "
1803 "<literal>APT::Cache::ShowImplicit</literal>."
1806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1807 #: apt-cache.8.xml:1
1809 "Print full package records when searching. Configuration Item: "
1810 "<literal>APT::Cache::ShowFull</literal>."
1813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1814 #: apt-cache.8.xml:1
1816 "Print full records for all available versions. This is the default; to turn "
1817 "it off, use <option>--no-all-versions</option>. If "
1818 "<option>--no-all-versions</option> is specified, only the candidate version "
1819 "will be displayed (the one which would be selected for installation). This "
1820 "option is only applicable to the <literal>show</literal> command. "
1821 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1825 #: apt-cache.8.xml:1
1827 "Perform automatic package cache regeneration, rather than use the cache as "
1828 "it is. This is the default; to turn it off, use "
1829 "<option>--no-generate</option>. Configuration Item: "
1830 "<literal>APT::Cache::Generate</literal>."
1833 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1834 #: apt-cache.8.xml:1
1836 "Only search on the package and provided package names, not the long "
1837 "descriptions. Configuration Item: <literal>APT::Cache::NamesOnly</literal>."
1840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1841 #: apt-cache.8.xml:1
1843 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1844 "and missing dependencies. Configuration Item: "
1845 "<literal>APT::Cache::AllNames</literal>."
1848 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1849 #: apt-cache.8.xml:1
1851 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1852 "that all packages mentioned are printed once. Configuration Item: "
1853 "<literal>APT::Cache::RecurseDepends</literal>."
1856 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1857 #: apt-cache.8.xml:1
1859 "Limit the output of <literal>depends</literal> and "
1860 "<literal>rdepends</literal> to packages which are currently installed. "
1861 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1864 #. type: Content of: <refentry><refsect1><para>
1865 #: apt-cache.8.xml:1
1866 msgid "&apt-conf;, &sources-list;, &apt-get;"
1869 #. type: Content of: <refentry><refsect1><para>
1870 #: apt-cache.8.xml:1
1872 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1876 #. type: Content of: <refentry><refnamediv><refpurpose>
1878 msgid "APT key management utility"
1881 #. type: Content of: <refentry><refsect1><para>
1884 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1885 "authenticate packages. Packages which have been authenticated using these "
1886 "keys will be considered trusted."
1889 #. type: Content of: <refentry><refsect1><title>
1894 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1897 "Add a new key to the list of trusted keys. The key is read from the "
1898 "filename given with the parameter &synopsis-param-filename; or if the "
1899 "filename is <literal>-</literal> from standard input."
1902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1905 "It is critical that keys added manually via <command>apt-key</command> are "
1906 "verified to belong to the owner of the repositories they claim to be for "
1907 "otherwise the &apt-secure; infrastructure is completely undermined."
1910 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1912 msgid "Remove a key from the list of trusted keys."
1915 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1917 msgid "Output the key &synopsis-param-keyid; to standard output."
1920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1922 msgid "Output all trusted keys to standard output."
1925 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1927 msgid "List trusted keys."
1930 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1932 msgid "List fingerprints of trusted keys."
1935 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1938 "Pass advanced options to gpg. With <command>adv --recv-key</command> you can "
1939 "e.g. download key from keyservers directly into the the trusted set of "
1940 "keys. Note that there are <emphasis>no</emphasis> checks performed, so it is "
1941 "easy to completely undermine the &apt-secure; infrastructure if used without "
1945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1948 "Update the local keyring with the archive keyring and remove from the local "
1949 "keyring the archive keys which are no longer valid. The archive keyring is "
1950 "shipped in the <literal>archive-keyring</literal> package of your "
1951 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1954 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1957 "Perform an update working similarly to the <command>update</command> command "
1958 "above, but get the archive keyring from a URI instead and validate it "
1959 "against a master key. This requires an installed &wget; and an APT build "
1960 "configured to have a server to fetch from and a master keyring to validate. "
1961 "APT in Debian does not support this command, relying on "
1962 "<command>update</command> instead, but Ubuntu's APT does."
1965 #. type: Content of: <refentry><refsect1><title>
1966 #: apt-key.8.xml:1 apt-mark.8.xml:1 apt-mark.8.xml:1 apt-cdrom.8.xml:1
1970 #. type: Content of: <refentry><refsect1><para>
1973 "Note that options need to be defined before the commands described in the "
1977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1980 "With this option it is possible to specify a particular keyring file the "
1981 "command should operate on. The default is that a command is executed on the "
1982 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1983 "<filename>trusted.gpg.d</filename> directory, though "
1984 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1985 "e.g. new keys are added to this one."
1988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1990 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1993 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1995 msgid "Local trust database of archive keys."
1998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2000 msgid "&keyring-filename;"
2003 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2005 msgid "Keyring of &keyring-distro; archive trusted keys."
2008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2010 msgid "&keyring-removed-filename;"
2013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2015 msgid "Keyring of &keyring-distro; archive removed trusted keys."
2018 #. type: Content of: <refentry><refsect1><para>
2020 msgid "&apt-get;, &apt-secure;"
2023 #. type: Content of: <refentry><refnamediv><refpurpose>
2025 msgid "show, set and unset various settings for a package"
2028 #. type: Content of: <refentry><refsect1><para>
2031 "<command>apt-mark</command> can be used as a unified frontend to set various "
2032 "settings for a package like marking a package as being "
2033 "automatically/manually installed or changing <command>dpkg</command> "
2034 "selections such as hold, install, deinstall and purge which are respected "
2035 "e.g. by <command>apt-get dselect-upgrade</command> or "
2036 "<command>aptitude</command>."
2039 #. type: Content of: <refentry><refsect1><title>
2041 msgid "Automatically and manually installed packages"
2044 #. type: Content of: <refentry><refsect1><para>
2047 "When you request that a package is installed, and as a result other packages "
2048 "are installed to satisfy its dependencies, the dependencies are marked as "
2049 "being automatically installed, while package you installed explicitely is "
2050 "marked as manually installed. Once a automatically installed package is no "
2051 "longer depended on by any manually installed package it is considered no "
2052 "longer needed and e.g. <command>apt-get</command> or "
2053 "<command>aptitude</command> will at least suggest removing them."
2056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2059 "<literal>auto</literal> is used to mark a package as being automatically "
2060 "installed, which will cause the package to be removed when no more manually "
2061 "installed packages depend on this package."
2064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2067 "<literal>manual</literal> is used to mark a package as being manually "
2068 "installed, which will prevent the package from being automatically removed "
2069 "if no other packages depend on it."
2072 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2075 "<literal>showauto</literal> is used to print a list of automatically "
2076 "installed packages with each package on a new line. All automatically "
2077 "installed packages will be listed if no package is given. If packages are "
2078 "given only those which are automatically installed will be shown."
2081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2084 "<literal>showmanual</literal> can be used in the same way as "
2085 "<literal>showauto</literal> except that it will print a list of manually "
2086 "installed packages instead."
2089 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2092 "Read/Write package stats from the filename given with the parameter "
2093 "&synopsis-param-filename; instead of from the default location, which is "
2094 "<filename>extended_status</filename> in the directory defined by the "
2095 "Configuration Item: <literal>Dir::State</literal>."
2098 #. type: Content of: <refentry><refsect1><title>
2100 msgid "Prevent changes for a package"
2103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2106 "<literal>hold</literal> is used to mark a package as held back, which will "
2107 "prevent the package from being automatically installed, upgraded or removed."
2110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2113 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2114 "package to allow all actions again."
2117 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2120 "<literal>showhold</literal> is used to print a list of packages on hold in "
2121 "the same way as for the other show commands."
2124 #. type: Content of: <refentry><refsect1><title>
2126 msgid "Shedule packages for install, remove and purge"
2129 #. type: Content of: <refentry><refsect1><para>
2132 "Some frontends like <command>apt-get dselect-upgrade</command> can be used "
2133 "to apply previously sheduled changes to the install state of packages. Such "
2134 "changes can be sheduled with the <option>install</option>, "
2135 "<option>remove</option> (also known as <option>deinstall</option>) and "
2136 "<option>purge</option> commands. Packages with a specific selection can be "
2137 "displayed with <option>showinstall</option>, <option>showremove</option> and "
2138 "<option>showpurge</option> respectively. More information about these so "
2139 "called dpkg selections can be found in &dpkg;."
2142 #. type: Content of: <refentry><refsect1><para>
2145 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2149 #. type: Content of: <refentry><refnamediv><refpurpose>
2150 #: apt-secure.8.xml:1
2151 msgid "Archive authentication support for APT"
2154 #. type: Content of: <refentry><refsect1><para>
2155 #: apt-secure.8.xml:1
2157 "Starting with version 0.6, <command>APT</command> contains code that does "
2158 "signature checking of the Release file for all repositories. This ensures "
2159 "that data like packages in the archive can't be modified by people who have "
2160 "no access to the Release file signing key."
2163 #. type: Content of: <refentry><refsect1><para>
2164 #: apt-secure.8.xml:1
2166 "If an archive doesn't have a signed Release file or no Release file at all "
2167 "current APT versions will raise a warning in <command>update</command> "
2168 "operations and frontends like <command>apt-get</command> will require "
2169 "explicit confirmation if an installation request includes a package from "
2170 "such an unauthenticated archive."
2173 #. type: Content of: <refentry><refsect1><para>
2174 #: apt-secure.8.xml:1
2176 "In the future APT will refuse to work with unauthenticated repositories by "
2177 "default until support for them is removed entirely. Users have the option to "
2178 "opt-in to this behavior already by setting the configuration option "
2179 "<option>Acquire::AllowInsecureRepositories</option> to "
2180 "<literal>false</literal>."
2183 #. type: Content of: <refentry><refsect1><para>
2184 #: apt-secure.8.xml:1
2186 "Note: All APT-based package management frontends like &apt-get;, &aptitude; "
2187 "and &synaptic; support this authentication feature, so this manpage uses "
2188 "<literal>APT</literal> to refer to them all for simplicity only."
2191 #. type: Content of: <refentry><refsect1><title>
2192 #: apt-secure.8.xml:1
2193 msgid "Trusted repositories"
2196 #. type: Content of: <refentry><refsect1><para>
2197 #: apt-secure.8.xml:1
2199 "The chain of trust from an APT archive to the end user is made up of several "
2200 "steps. <command>apt-secure</command> is the last step in this chain; "
2201 "trusting an archive does not mean that you trust its packages not to contain "
2202 "malicious code, but means that you trust the archive maintainer. It's the "
2203 "archive maintainer's responsibility to ensure that the archive's integrity "
2207 #. type: Content of: <refentry><refsect1><para>
2208 #: apt-secure.8.xml:1
2210 "apt-secure does not review signatures at a package level. If you require "
2211 "tools to do this you should look at <command>debsig-verify</command> and "
2212 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2213 "packages respectively)."
2216 #. type: Content of: <refentry><refsect1><para>
2217 #: apt-secure.8.xml:1
2219 "The chain of trust in Debian e.g. starts when a maintainer uploads a new "
2220 "package or a new version of a package to the Debian archive. In order to "
2221 "become effective, this upload needs to be signed by a key contained in one "
2222 "of the Debian package maintainers keyrings (available in the debian-keyring "
2223 "package). Maintainers' keys are signed by other maintainers following "
2224 "pre-established procedures to ensure the identity of the key holder. Similar "
2225 "procedures exist in all Debian-based distributions."
2228 #. type: Content of: <refentry><refsect1><para>
2229 #: apt-secure.8.xml:1
2231 "Once the uploaded package is verified and included in the archive, the "
2232 "maintainer signature is stripped off, and checksums of the package are "
2233 "computed and put in the Packages file. The checksums of all of the Packages "
2234 "files are then computed and put into the Release file. The Release file is "
2235 "then signed by the archive key for this &keyring-distro; release, and "
2236 "distributed alongside the packages and the Packages files on "
2237 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2238 "keyring available in the &keyring-package; package."
2241 #. type: Content of: <refentry><refsect1><para>
2242 #: apt-secure.8.xml:1
2244 "End users can check the signature of the Release file, extract a checksum of "
2245 "a package from it and compare it with the checksum of the package they "
2246 "downloaded by hand - or rely on APT doing this automatically."
2249 #. type: Content of: <refentry><refsect1><para>
2250 #: apt-secure.8.xml:1
2252 "Notice that this is distinct from checking signatures on a per package "
2253 "basis. It is designed to prevent two possible attacks:"
2256 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2257 #: apt-secure.8.xml:1
2259 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2260 "checking, malicious agents can introduce themselves into the package "
2261 "download process and provide malicious software either by controlling a "
2262 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2263 "server (through ARP or DNS spoofing attacks)."
2266 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2267 #: apt-secure.8.xml:1
2269 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2270 "malicious agent can compromise a mirror host and modify the files in it to "
2271 "propagate malicious software to all users downloading packages from that "
2275 #. type: Content of: <refentry><refsect1><para>
2276 #: apt-secure.8.xml:1
2278 "However, it does not defend against a compromise of the master server itself "
2279 "(which signs the packages) or against a compromise of the key used to sign "
2280 "the Release files. In any case, this mechanism can complement a per-package "
2284 #. type: Content of: <refentry><refsect1><title>
2285 #: apt-secure.8.xml:1
2286 msgid "User configuration"
2289 #. type: Content of: <refentry><refsect1><para>
2290 #: apt-secure.8.xml:1
2292 "<command>apt-key</command> is the program that manages the list of keys used "
2293 "by APT to trust repositories. It can be used to add or remove keys as well "
2294 "as list the trusted keys. Limiting which key(s) are able to sign which "
2295 "archive is possible via the <option>Signed-By</option> in &sources-list;."
2298 #. type: Content of: <refentry><refsect1><para>
2299 #: apt-secure.8.xml:1
2301 "Note that a default installation already contains all keys to securily "
2302 "acquire packages from the default repositories, so fiddling with "
2303 "<command>apt-key</command> is only needed if third-party repositories are "
2307 #. type: Content of: <refentry><refsect1><para>
2308 #: apt-secure.8.xml:1
2310 "In order to add a new key you need to first download it (you should make "
2311 "sure you are using a trusted communication channel when retrieving it), add "
2312 "it with <command>apt-key</command> and then run <command>apt-get "
2313 "update</command> so that apt can download and verify the "
2314 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2315 "from the archives you have configured."
2318 #. type: Content of: <refentry><refsect1><title>
2319 #: apt-secure.8.xml:1
2320 msgid "Archive configuration"
2323 #. type: Content of: <refentry><refsect1><para>
2324 #: apt-secure.8.xml:1
2326 "If you want to provide archive signatures in an archive under your "
2327 "maintenance you have to:"
2330 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2331 #: apt-secure.8.xml:1
2333 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2334 "already. You can do this by running <command>apt-ftparchive "
2335 "release</command> (provided in apt-utils)."
2338 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2339 #: apt-secure.8.xml:1
2341 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2342 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2343 "Release.gpg Release</command>."
2346 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2347 #: apt-secure.8.xml:1
2349 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
2350 "know what key they need to import in order to authenticate the files in the "
2351 "archive. It is best to ship your key in its own keyring package like "
2352 "&keyring-distro; does with &keyring-package; to be able to distribute "
2353 "updates and key transitions automatically later."
2356 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2357 #: apt-secure.8.xml:1
2359 "<emphasis>Provide instructions on how to add your archive and "
2360 "key</emphasis>. If your users can't acquire your key securily the chain of "
2361 "trust described above is broken. How you can help users add your key "
2362 "depends on your archive and target audience ranging from having your keyring "
2363 "package included in another archive users already have configured (like the "
2364 "default repositories of their distribution) to leverage the web of trust."
2367 #. type: Content of: <refentry><refsect1><para>
2368 #: apt-secure.8.xml:1
2370 "Whenever the contents of the archive change (new packages are added or "
2371 "removed) the archive maintainer has to follow the first two steps outlined "
2375 #. type: Content of: <refentry><refsect1><para>
2376 #: apt-secure.8.xml:1
2378 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2379 "&debsign;, &debsig-verify;, &gpg;"
2382 #. type: Content of: <refentry><refsect1><para>
2383 #: apt-secure.8.xml:1
2385 "For more background information you might want to review the <ulink "
2386 "url=\"https://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2387 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2388 "(available also in the harden-doc package) and the <ulink "
2389 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2390 "Distribution HOWTO</ulink> by V. Alex Brennen."
2393 #. type: Content of: <refentry><refsect1><title>
2394 #: apt-secure.8.xml:1
2395 msgid "Manpage Authors"
2398 #. type: Content of: <refentry><refsect1><para>
2399 #: apt-secure.8.xml:1
2401 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2402 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2405 #. type: Content of: <refentry><refnamediv><refpurpose>
2406 #: apt-cdrom.8.xml:1
2407 msgid "APT CD-ROM management utility"
2410 #. type: Content of: <refentry><refsect1><para>
2411 #: apt-cdrom.8.xml:1
2413 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2414 "available sources. <command>apt-cdrom</command> takes care of determining "
2415 "the structure of the disc as well as correcting for several possible "
2416 "mis-burns and verifying the index files."
2419 #. type: Content of: <refentry><refsect1><para>
2420 #: apt-cdrom.8.xml:1
2422 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2423 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2424 "must be inserted and scanned separately to account for possible mis-burns."
2427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2428 #: apt-cdrom.8.xml:1
2430 "<literal>add</literal> is used to add a new disc to the source list. It will "
2431 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2432 "to scan it and copy the index files. If the disc does not have a proper "
2433 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2438 #: apt-cdrom.8.xml:1
2440 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2441 "maintains a database of these IDs in "
2442 "<filename>&statedir;/cdroms.list</filename>"
2445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2446 #: apt-cdrom.8.xml:1
2448 "A debugging tool to report the identity of the current disc as well as the "
2452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2453 #: apt-cdrom.8.xml:1
2455 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2456 "<option>--cdrom</option> option. Configuration Item: "
2457 "<literal>Acquire::cdrom::AutoDetect</literal>."
2460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2461 #: apt-cdrom.8.xml:1
2463 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2464 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2465 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2469 #: apt-cdrom.8.xml:1
2471 "Rename a disc; change the label of a disc or override the disc's given "
2472 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2473 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2477 #: apt-cdrom.8.xml:1
2479 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2480 "unmounting the mount point. Configuration Item: "
2481 "<literal>APT::CDROM::NoMount</literal>."
2484 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2485 #: apt-cdrom.8.xml:1
2487 "Fast Copy; Assume the package files are valid and do not check every "
2488 "package. This option should be used only if <command>apt-cdrom</command> has "
2489 "been run on this disc before and did not detect any errors. Configuration "
2490 "Item: <literal>APT::CDROM::Fast</literal>."
2493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2494 #: apt-cdrom.8.xml:1
2496 "Thorough Package Scan; This option may be needed with some old Debian "
2497 "1.1/1.2 discs that have Package files in strange places. It takes much "
2498 "longer to scan the CD but will pick them all up."
2501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2502 #: apt-cdrom.8.xml:1
2504 "No Changes; Do not change the &sources-list; file and do not write index "
2505 "files. Everything is still checked however. Configuration Item: "
2506 "<literal>APT::CDROM::NoAct</literal>."
2509 #. type: Content of: <refentry><refsect1><para>
2510 #: apt-cdrom.8.xml:1
2511 msgid "&apt-conf;, &apt-get;, &sources-list;"
2514 #. type: Content of: <refentry><refsect1><para>
2515 #: apt-cdrom.8.xml:1
2517 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2521 #. type: Content of: <refentry><refnamediv><refpurpose>
2522 #: apt-config.8.xml:1
2523 msgid "APT Configuration Query program"
2526 #. type: Content of: <refentry><refsect1><para>
2527 #: apt-config.8.xml:1
2529 "<command>apt-config</command> is an internal program used by various "
2530 "portions of the APT suite to provide consistent configurability. It accesses "
2531 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2532 "manner that is easy to use for scripted applications."
2535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2536 #: apt-config.8.xml:1
2538 "shell is used to access the configuration information from a shell "
2539 "script. It is given pairs of arguments, the first being a shell variable and "
2540 "the second the configuration value to query. As output it lists shell "
2541 "assignment commands for each value present. In a shell script it should be "
2545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2546 #: apt-config.8.xml:1
2550 "RES=`apt-config shell OPTS MyApp::options`\n"
2554 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2555 #: apt-config.8.xml:1
2557 "This will set the shell environment variable $OPTS to the value of "
2558 "MyApp::options with a default of <option>-f</option>."
2561 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2562 #: apt-config.8.xml:1
2564 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2565 "names, d returns directories, b returns true or false and i returns an "
2566 "integer. Each of the returns is normalized and verified internally."
2569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2570 #: apt-config.8.xml:1
2571 msgid "Just show the contents of the configuration space."
2574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2575 #: apt-config.8.xml:1
2577 "Include options which have an empty value. This is the default, so use "
2578 "--no-empty to remove them from the output."
2581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2582 #: apt-config.8.xml:1
2583 msgid "%f "%v";%n"
2586 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2587 #: apt-config.8.xml:1
2589 "Defines the output of each config option. %t will be replaced with "
2590 "its individual name, %f with its full hierarchical name and %v "
2591 "with its value. Use uppercase letters and special characters in the value "
2592 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2593 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2594 "and %N by a tab. A % can be printed by using %%."
2597 #. type: Content of: <refentry><refsect1><para>
2598 #: apt-config.8.xml:1 apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1
2599 #: apt-ftparchive.1.xml:1
2603 #. type: Content of: <refentry><refsect1><para>
2604 #: apt-config.8.xml:1
2606 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2610 #. type: Content of: <refentry><refentryinfo><author><contrib>
2612 msgid "Initial documentation of Debug::*."
2615 #. type: Content of: <refentry><refentryinfo><author><email>
2617 msgid "dburrows@debian.org"
2620 #. type: Content of: <refentry><refmeta><manvolnum>
2621 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
2625 #. type: Content of: <refentry><refnamediv><refpurpose>
2627 msgid "Configuration file for APT"
2630 #. type: Content of: <refentry><refsect1><para>
2633 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2634 "by all the tools in the APT suite of tools, though it is by no means the "
2635 "only place options can be set. The suite also shares a common command line "
2636 "parser to provide a uniform environment."
2639 #. type: Content of: <refentry><refsect1><orderedlist><para>
2642 "When an APT tool starts up it will read the configuration files in the "
2646 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2649 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2653 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2656 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2657 "order which have either no or \"<literal>conf</literal>\" as filename "
2658 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2659 "and period (.) characters. Otherwise APT will print a notice that it has "
2660 "ignored a file, unless that file matches a pattern in the "
2661 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2662 "case it will be silently ignored."
2665 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2667 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2670 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2673 "all options set in the binary specific configuration subtree are moved into "
2674 "the root of the tree."
2677 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2680 "the command line options are applied to override the configuration "
2681 "directives or to load even more configuration files."
2684 #. type: Content of: <refentry><refsect1><title>
2689 #. type: Content of: <refentry><refsect1><para>
2692 "The configuration file is organized in a tree with options organized into "
2693 "functional groups. Option specification is given with a double colon "
2694 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2695 "within the APT tool group, for the Get tool. Options do not inherit from "
2696 "their parent groups."
2699 #. type: Content of: <refentry><refsect1><para>
2702 "Syntactically the configuration language is modeled after what the ISC tools "
2703 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2704 "treated as comments (ignored), as well as all text between "
2705 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2706 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2707 "The quotation marks and trailing semicolon are required. The value must be "
2708 "on one line, and there is no kind of string concatenation. Values must not "
2709 "include backslashes or extra quotation marks. Option names are made up of "
2710 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2711 "opened with curly braces, like this:"
2714 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2720 " Assume-Yes \"true\";\n"
2721 " Fix-Broken \"true\";\n"
2726 #. type: Content of: <refentry><refsect1><para>
2729 "with newlines placed to make it more readable. Lists can be created by "
2730 "opening a scope and including a single string enclosed in quotes followed by "
2731 "a semicolon. Multiple entries can be included, separated by a semicolon."
2734 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2737 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2740 #. type: Content of: <refentry><refsect1><para>
2743 "In general the sample configuration file &configureindex; is a good guide "
2744 "for how it should look."
2747 #. type: Content of: <refentry><refsect1><para>
2750 "Case is not significant in names of configuration items, so in the previous "
2751 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2754 #. type: Content of: <refentry><refsect1><para>
2757 "Names for the configuration items are optional if a list is defined as can "
2758 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2759 "you don't specify a name a new entry will simply add a new option to the "
2760 "list. If you specify a name you can override the option in the same way as "
2761 "any other option by reassigning a new value to the option."
2764 #. type: Content of: <refentry><refsect1><para>
2767 "Two special commands are defined: <literal>#include</literal> (which is "
2768 "deprecated and not supported by alternative implementations) and "
2769 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2770 "given file, unless the filename ends in a slash, in which case the whole "
2771 "directory is included. <literal>#clear</literal> is used to erase a part of "
2772 "the configuration tree. The specified element and all its descendants are "
2773 "erased. (Note that these lines also need to end with a semicolon.)"
2776 #. type: Content of: <refentry><refsect1><para>
2779 "The <literal>#clear</literal> command is the only way to delete a list or a "
2780 "complete scope. Reopening a scope (or using the syntax described below with "
2781 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2782 "previously written entries. Options can only be overridden by addressing a "
2783 "new value to them - lists and scopes can't be overridden, only cleared."
2786 #. type: Content of: <refentry><refsect1><para>
2789 "All of the APT tools take an -o option which allows an arbitrary "
2790 "configuration directive to be specified on the command line. The syntax is a "
2791 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2792 "followed by an equals sign then the new value of the option. To append a new "
2793 "element to a list, add a trailing <literal>::</literal> to the name of the "
2794 "list. (As you might suspect, the scope syntax can't be used on the command "
2798 #. type: Content of: <refentry><refsect1><para>
2801 "Note that appending items to a list using <literal>::</literal> only works "
2802 "for one item per line, and that you should not use it in combination with "
2803 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2804 "syntaxes together will trigger a bug which some users unfortunately depend "
2805 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2806 "like every other option with a name. This introduces many problems; for one "
2807 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2808 "syntax in the hope of appending to a list will achieve the opposite, as only "
2809 "the last assignment for this option \"<literal>::</literal>\" will be "
2810 "used. Future versions of APT will raise errors and stop working if they "
2811 "encounter this misuse, so please correct such statements now while APT "
2812 "doesn't explicitly complain about them."
2815 #. type: Content of: <refentry><refsect1><title>
2817 msgid "The APT Group"
2820 #. type: Content of: <refentry><refsect1><para>
2823 "This group of options controls general APT behavior as well as holding the "
2824 "options for all of the tools."
2827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2830 "System Architecture; sets the architecture to use when fetching files and "
2831 "parsing package lists. The internal default is the architecture apt was "
2835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2838 "All Architectures the system supports. For instance, CPUs implementing the "
2839 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2840 "instruction set are also able to execute binaries compiled for the "
2841 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2842 "is used when fetching files and parsing package lists. The initial default "
2843 "is always the system's native architecture "
2844 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2845 "to the default list when they are registered via <command>dpkg "
2846 "--add-architecture</command>."
2849 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2852 "List of all build profiles enabled for build-dependency resolution, without "
2853 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2854 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2855 "&dpkg-buildpackage; overrides the list notation."
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2861 "Default release to install packages from if more than one version is "
2862 "available. Contains release name, codename or release version. Examples: "
2863 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2864 "'4.0', '5.0*'. See also &apt-preferences;."
2867 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2870 "Ignore held packages; this global option causes the problem resolver to "
2871 "ignore held packages in its decision making."
2874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2877 "Defaults to on. When turned on the autoclean feature will remove any "
2878 "packages which can no longer be downloaded from the cache. If turned off "
2879 "then packages that are locally installed are also excluded from cleaning - "
2880 "but note that APT provides no direct means to reinstall them."
2883 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2886 "Defaults to on, which will cause APT to install essential and important "
2887 "packages as soon as possible in an install/upgrade operation, in order to "
2888 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2889 "treats an important package in the same way as an extra package: between the "
2890 "unpacking of the package A and its configuration there can be many other "
2891 "unpack or configuration calls for other unrelated packages B, C etc. If "
2892 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2893 "scripts generate an error), this results in a system state in which package "
2894 "A is unpacked but unconfigured - so any package depending on A is now no "
2895 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2898 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2901 "The immediate configuration marker is also applied in the potentially "
2902 "problematic case of circular dependencies, since a dependency with the "
2903 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2904 "to recognise a situation in which it is unable to perform immediate "
2905 "configuration, abort, and suggest to the user that the option should be "
2906 "temporarily deactivated in order to allow the operation to proceed. Note "
2907 "the use of the word \"theory\" here; in the real world this problem has "
2908 "rarely been encountered, in non-stable distribution versions, and was caused "
2909 "by wrong dependencies of the package in question or by a system in an "
2910 "already broken state; so you should not blindly disable this option, as the "
2911 "scenario mentioned above is not the only problem it can help to prevent in "
2915 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2918 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2919 "option disabled you should try to explicitly <literal>install</literal> the "
2920 "package APT is unable to configure immediately; but please make sure you "
2921 "also report your problem to your distribution and to the APT team with the "
2922 "buglink below, so they can work on improving or correcting the upgrade "
2926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2929 "Never enable this option unless you <emphasis>really</emphasis> know what "
2930 "you are doing. It permits APT to temporarily remove an essential package to "
2931 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2932 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2933 "bug</emphasis>. This option will work if the essential packages are not "
2934 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2935 "<command>dpkg</command>, <command>dash</command> or anything that those "
2936 "packages depend on."
2939 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2942 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2943 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2944 "the size the cache will grow to, and is therefore the amount of memory APT "
2945 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2946 "that this amount of space needs to be available for APT; otherwise it will "
2947 "likely fail ungracefully, so for memory restricted devices this value should "
2948 "be lowered while on systems with a lot of configured sources it should be "
2949 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2950 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2951 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2952 "value will be applied again and again until either the cache is big enough "
2953 "to store all information or the size of the cache reaches the "
2954 "<literal>Cache-Limit</literal>. The default of "
2955 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2956 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2962 msgid "Defines which packages are considered essential build dependencies."
2965 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2968 "The Get subsection controls the &apt-get; tool; please see its documentation "
2969 "for more information about the options here."
2972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2975 "The Cache subsection controls the &apt-cache; tool; please see its "
2976 "documentation for more information about the options here."
2979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2982 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2983 "documentation for more information about the options here."
2986 #. type: Content of: <refentry><refsect1><title>
2988 msgid "The Acquire Group"
2991 #. type: Content of: <refentry><refsect1><para>
2994 "The <literal>Acquire</literal> group of options controls the download of "
2995 "packages as well as the various \"acquire methods\" responsible for the "
2996 "download itself (see also &sources-list;)."
2999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3002 "Security related option defaulting to true, as giving a Release file's "
3003 "validation an expiration date prevents replay attacks over a long timescale, "
3004 "and can also for example help users to identify mirrors that are no longer "
3005 "updated - but the feature depends on the correctness of the clock on the "
3006 "user system. Archive maintainers are encouraged to create Release files with "
3007 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
3008 "value is desired the <literal>Max-ValidTime</literal> option below can be "
3009 "used. The <option>Check-Valid-Until</option> option of &sources-list; "
3010 "entries should be preferred to disable the check selectively instead of "
3011 "using this global override."
3014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3017 "Maximum time (in seconds) after its creation (as indicated by the "
3018 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3019 "should be considered valid. If the Release file itself includes a "
3020 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
3021 "the expiration date. The default value is <literal>0</literal> which stands "
3022 "for \"valid forever\". Archive specific settings can be made by appending "
3023 "the label of the archive to the option name. Preferably, the same can be "
3024 "achieved for specific &sources-list; entries by using the "
3025 "<option>Valid-Until-Max</option> option there."
3028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3031 "Minimum time (in seconds) after its creation (as indicated by the "
3032 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3033 "should be considered valid. Use this if you need to use a seldom updated "
3034 "(local) mirror of a more frequently updated archive with a "
3035 "<literal>Valid-Until</literal> header instead of completely disabling the "
3036 "expiration date checking. Archive specific settings can and should be used "
3037 "by appending the label of the archive to the option name. Preferably, the "
3038 "same can be achieved for specific &sources-list; entries by using the "
3039 "<option>Valid-Until-Min</option> option there."
3042 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3045 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
3046 "<filename>Packages</filename> files) instead of downloading whole ones. True "
3047 "by default. Preferably, this can be set for specific &sources-list; entries "
3048 "or index files by using the <option>PDiffs</option> option there."
3051 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3054 "Two sub-options to limit the use of PDiffs are also available: "
3055 "<literal>FileLimit</literal> can be used to specify a maximum number of "
3056 "PDiff files should be downloaded to update a "
3057 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
3058 "percentage of the size of all patches compared to the size of the targeted "
3059 "file. If one of these limits is exceeded the complete file is downloaded "
3060 "instead of the patches."
3063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3066 "Try to download indexes via an URI constructed from a hashsum of the "
3067 "expected file rather than downloaded via a well-known stable filename. True "
3068 "by default, but automatically disabled if the source indicates no support "
3069 "for it. Usage can be forced with the special value \"force\". Preferably, "
3070 "this can be set for specific &sources-list; entries or index files by using "
3071 "the <option>By-Hash</option> option there."
3074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3077 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3078 "<literal>host</literal> or <literal>access</literal> which determines how "
3079 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3080 "one connection per target host will be opened, <literal>access</literal> "
3081 "means that one connection per URI type will be opened."
3084 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3087 "Number of retries to perform. If this is non-zero APT will retry failed "
3088 "files the given number of times."
3091 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3094 "Use symlinks for source archives. If set to true then source archives will "
3095 "be symlinked when possible instead of copying. True is the default."
3098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3101 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
3102 "URIs. It is in the standard form of "
3103 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
3104 "can also be specified by using the form "
3105 "<literal>http::Proxy::<host></literal> with the special keyword "
3106 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3107 "settings is specified, <envar>http_proxy</envar> environment variable will "
3111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3114 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3115 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
3116 "response under any circumstances. <literal>Max-Age</literal> sets the "
3117 "allowed maximum age (in seconds) of an index file in the cache of the "
3118 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
3119 "store the requested archive files in its cache, which can be used to prevent "
3120 "the proxy from polluting its cache with (big) .deb files."
3123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3124 #: apt.conf.5.xml:1 apt.conf.5.xml:1
3126 "The option <literal>timeout</literal> sets the timeout timer used by the "
3127 "method; this value applies to the connection as well as the data timeout."
3130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3133 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3134 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
3135 "e.g. on high-latency connections. It specifies how many requests are sent in "
3136 "a pipeline. APT tries to detect and workaround misbehaving webservers and "
3137 "proxies at runtime, but if you know that yours does not conform to the "
3138 "HTTP/1.1 specification pipelining can be disabled by setting the value to "
3139 "0. It is enabled by default with the value 10."
3142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3145 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
3146 "follow redirects, which is enabled by default."
3149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3152 "The used bandwidth can be limited with "
3153 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3154 "kilobytes per second. The default value is 0 which deactivates the limit and "
3155 "tries to use all available bandwidth. Note that this option implicitly "
3156 "disables downloading from multiple servers at the same time."
3159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3162 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3163 "User-Agent for the http download method as some proxies allow access for "
3164 "clients only if the client uses a known identifier."
3167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3170 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
3171 "an external command to discover the http proxy to use. Apt expects the "
3172 "command to output the proxy on stdout in the style "
3173 "<literal>http://proxy:port/</literal>. This will override the generic "
3174 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
3175 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
3176 "the &squid-deb-proxy-client; package for an example implementation that uses "
3177 "avahi. This option takes precedence over the legacy option name "
3178 "<literal>ProxyAutoDetect</literal>."
3181 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3184 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
3185 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
3186 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
3187 "the <literal>http</literal> method, and default to the same values if they "
3188 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
3192 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3195 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3196 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
3197 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3198 "suboption determines whether or not the server's host certificate should be "
3199 "verified against trusted certificates. "
3200 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
3201 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
3202 "or not the server's hostname should be verified. "
3203 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
3204 "option. <literal>SslCert</literal> determines what certificate to use for "
3205 "client authentication. <literal><host>::SslCert</literal> is the "
3206 "corresponding per-host option. <literal>SslKey</literal> determines what "
3207 "private key to use for client "
3208 "authentication. <literal><host>::SslKey</literal> is the corresponding "
3209 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3210 "version to use. It can contain either of the strings "
3211 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
3212 "<literal><host>::SslForceVersion</literal> is the corresponding "
3216 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3219 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
3220 "It is in the standard form of "
3221 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
3222 "also be specified by using the form "
3223 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3224 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3225 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3226 "used. To use an FTP proxy you will have to set the "
3227 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3228 "entry specifies the commands to send to tell the proxy server what to "
3229 "connect to. Please see &configureindex; for an example of how to do "
3230 "this. The substitution variables representing the corresponding URI "
3231 "component are <literal>$(PROXY_USER)</literal>, "
3232 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
3233 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
3234 "<literal>$(SITE_PORT)</literal>."
3237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3240 "Several settings are provided to control passive mode. Generally it is safe "
3241 "to leave passive mode on; it works in nearly every environment. However, "
3242 "some situations require that passive mode be disabled and port mode FTP used "
3243 "instead. This can be done globally or for connections that go through a "
3244 "proxy or for a specific host (see the sample config file for examples)."
3247 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3250 "It is possible to proxy FTP over HTTP by setting the "
3251 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3252 "discussion of the http method above for syntax. You cannot set this in the "
3253 "configuration file and it is not recommended to use FTP over HTTP due to its "
3257 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3260 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3261 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3262 "false, which means these commands are only used if the control connection is "
3263 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3264 "that most FTP servers do not support RFC2428."
3267 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3270 msgid "/cdrom/::Mount \"foo\";"
3273 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3276 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3277 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3278 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3279 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3280 "and unmount commands if your mount point cannot be listed in the fstab. The "
3281 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3282 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3283 "Unmount commands can be specified using UMount."
3286 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3289 "For GPGV URIs the only configurable option is "
3290 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3298 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3299 "\"<replaceable>Methodname</replaceable>\";"
3302 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3305 "List of compression types which are understood by the acquire methods. "
3306 "Files like <filename>Packages</filename> can be available in various "
3307 "compression formats. By default the acquire methods can decompress "
3308 "<command>bzip2</command>, <command>lzma</command> and "
3309 "<command>gzip</command> compressed files; with this setting more formats can "
3310 "be added on the fly or the used method can be changed. The syntax for this "
3311 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3314 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3317 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3320 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3323 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3329 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3330 "order the acquire system will try to download the compressed files. The "
3331 "acquire system will try the first and proceed with the next compression type "
3332 "in this list on error, so to prefer one over the other type simply add the "
3333 "preferred type first - default types not already added will be implicitly "
3334 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3335 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3336 "over <command>bzip2</command> and <command>lzma</command>. If "
3337 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3338 "<command>bzip2</command> the configure setting should look like this: "
3339 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3340 "<literal>bz2</literal> to the list explicitly as it will be added "
3344 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3347 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3350 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3354 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3355 "checked at run time. If this option has been set, the method will only be "
3356 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
3357 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
3358 "also that list entries specified on the command line will be added at the "
3359 "end of the list specified in the configuration files, but before the default "
3360 "entries. To prefer a type in this case over the ones specified in the "
3361 "configuration files you can set the option direct - not in list style. This "
3362 "will not override the defined list; it will only prefix the list with this "
3366 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3369 "The special type <literal>uncompressed</literal> can be used to give "
3370 "uncompressed files a preference, but note that most archives don't provide "
3371 "uncompressed files so this is mostly only useable for local mirrors."
3374 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3377 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3378 "Sources, or Translations), keep them gzip compressed locally instead of "
3379 "unpacking them. This saves quite a lot of disk space at the expense of more "
3380 "CPU requirements when building the local package caches. False by default."
3383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3386 "The Languages subsection controls which <filename>Translation</filename> "
3387 "files are downloaded and in which order APT tries to display the "
3388 "description-translations. APT will try to display the first available "
3389 "description in the language which is listed first. Languages can be defined "
3390 "with their short or long language codes. Note that not all archives provide "
3391 "<filename>Translation</filename> files for every language - the long "
3392 "language codes are especially rare."
3395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3398 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3401 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3404 "The default list includes \"environment\" and "
3405 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3406 "will be replaced at runtime with the language codes extracted from the "
3407 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3408 "that these codes are not included twice in the list. If "
3409 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3410 "<filename>Translation-en</filename> file (if available) will be used. To "
3411 "force APT to use no Translation file use the setting "
3412 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3413 "another special meaning code which will stop the search for a suitable "
3414 "<filename>Translation</filename> file. This tells APT to download these "
3415 "translations too, without actually using them unless the environment "
3416 "specifies the languages. So the following example configuration will result "
3417 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3418 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3419 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3420 "type=\"programlisting\" id=\"0\"/>"
3423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3426 "Note: To prevent problems resulting from APT being executed in different "
3427 "environments (e.g. by different users or by other programs) all Translation "
3428 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3429 "added to the end of the list (after an implicit "
3430 "\"<literal>none</literal>\")."
3433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3435 msgid "When downloading, force to use only the IPv4 protocol."
3438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3440 msgid "When downloading, force to use only the IPv6 protocol."
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3446 "The maximum file size of Release/Release.gpg/InRelease files. The default "
3450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3453 "This option controls if apt will use the DNS SRV server record as specified "
3454 "in RFC 2782 to select an alternative server to connect to. The default is "
3458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3461 "Allow the update operation to load data files from a repository without a "
3462 "trusted signature. If enabled this option no data files will be loaded and "
3463 "the update operation fails with a error for this source. The default is "
3464 "false for backward compatibility. This will be changed in the future."
3467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3470 "Allow that a repository that was previously gpg signed to become unsigned "
3471 "durign a update operation. When there is no valid signature of a perviously "
3472 "trusted repository apt will refuse the update. This option can be used to "
3473 "override this protection. You almost certainly never want to enable "
3474 "this. The default is false. Note that apt will still consider packages from "
3475 "this source untrusted and warn about them if you try to install them."
3478 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3486 "Acquiring changelogs can only be done if an URI is known from where to get "
3487 "them. Preferable the Release file indicates this in a 'Changelogs' "
3488 "field. If this isn't available the Label/Origin field of the Release file is "
3489 "used to check if a "
3490 "<literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> "
3492 "<literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> "
3493 "option exists and if so this value is taken. The value in the Release file "
3494 "can be overridden with "
3495 "<literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal> "
3497 "<literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>. "
3498 "The value should be a normal URI to a text file, expect that package "
3499 "specific data is replaced with the placeholder "
3500 "<literal>CHANGEPATH</literal>. The value for it is: 1. if the package is "
3501 "from a component (e.g. <literal>main</literal>) this is the first part "
3502 "otherwise it is omitted, 2. the first letter of source package name, expect "
3503 "if the source package name starts with '<literal>lib</literal>' in which "
3504 "case it will be the first four letters. 3. The complete source package "
3505 "name. 4. the complete name again and 5. the source version. The first (if "
3506 "present), second, third and fourth part are separated by a slash "
3507 "('<literal>/</literal>') and between the fourth and fifth part is an "
3508 "underscore ('<literal>_</literal>'). The special value "
3509 "'<literal>no</literal>' is available for this option indicating that this "
3510 "source can't be used to acquire changelog files from. Another source will be "
3511 "tried if available in this case."
3514 #. type: Content of: <refentry><refsect1><title>
3516 msgid "Binary specific configuration"
3519 #. type: Content of: <refentry><refsect1><para>
3522 "Especially with the introduction of the <command>apt</command> binary it can "
3523 "be useful to set certain options only for a specific binary as even options "
3524 "which look like they would effect only a certain binary like "
3525 "<option>APT::Get::Show-Versions</option> effect <command>apt-get</command> "
3526 "as well as <command>apt</command>."
3529 #. type: Content of: <refentry><refsect1><para>
3532 "Setting an option for a specific binary only can be achieved by setting the "
3533 "option inside the "
3534 "<option>Binary::<replaceable>specific-binary</replaceable></option> "
3535 "scope. Setting the option <option>APT::Get::Show-Versions</option> for the "
3536 "<command>apt</command> only can e.g. by done by setting "
3537 "<option>Binary::apt::APT::Get::Show-Versions</option> instead."
3540 #. type: Content of: <refentry><refsect1><para>
3543 "Note that as seen in the DESCRIPTION section further above you can't set "
3544 "binary-specific options on the commandline itself nor in configuration files "
3545 "loaded via the commandline."
3548 #. type: Content of: <refentry><refsect1><title>
3553 #. type: Content of: <refentry><refsect1><para>
3556 "The <literal>Dir::State</literal> section has directories that pertain to "
3557 "local state information. <literal>lists</literal> is the directory to place "
3558 "downloaded package lists in and <literal>status</literal> is the name of the "
3559 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3560 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3561 "contains the default directory to prefix on all sub-items if they do not "
3562 "start with <filename>/</filename> or <filename>./</filename>."
3565 #. type: Content of: <refentry><refsect1><para>
3568 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3569 "information, such as the two package caches <literal>srcpkgcache</literal> "
3570 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3571 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3572 "be turned off by setting <literal>pkgcache</literal> or "
3573 "<literal>srcpkgcache</literal> to <literal>\"\"</literal>. This will slow "
3574 "down startup but save disk space. It is probably preferable to turn off the "
3575 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> "
3576 "the default directory is contained in <literal>Dir::Cache</literal>"
3579 #. type: Content of: <refentry><refsect1><para>
3582 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3583 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3584 "<literal>main</literal> is the default configuration file (setting has no "
3585 "effect, unless it is done from the config file specified by "
3586 "<envar>APT_CONFIG</envar>)."
3589 #. type: Content of: <refentry><refsect1><para>
3592 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3593 "in lexical order from the directory specified. After this is done then the "
3594 "main config file is loaded."
3597 #. type: Content of: <refentry><refsect1><para>
3600 "Binary programs are pointed to by "
3601 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3602 "the location of the method handlers and <literal>gzip</literal>, "
3603 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3604 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3605 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3606 "specify the location of the respective programs."
3609 #. type: Content of: <refentry><refsect1><para>
3612 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3613 "set, all paths will be relative to <literal>RootDir</literal>, "
3614 "<emphasis>even paths that are specified absolutely</emphasis>. So, for "
3615 "instance, if <literal>RootDir</literal> is set to "
3616 "<filename>/tmp/staging</filename> and <literal>Dir::State::status</literal> "
3617 "is set to <filename>/var/lib/dpkg/status</filename>, then the status file "
3618 "will be looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>. "
3619 "If you want to prefix only relative paths, set <literal>Dir</literal> "
3623 #. type: Content of: <refentry><refsect1><para>
3626 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3627 "which files APT should silently ignore while parsing the files in the "
3628 "fragment directories. Per default a file which end with "
3629 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3630 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3631 "default value these patterns can use regular expression syntax."
3634 #. type: Content of: <refentry><refsect1><title>
3636 msgid "APT in DSelect"
3639 #. type: Content of: <refentry><refsect1><para>
3642 "When APT is used as a &dselect; method several configuration directives "
3643 "control the default behavior. These are in the <literal>DSelect</literal> "
3647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3650 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3651 "<literal>prompt</literal>, <literal>auto</literal>, "
3652 "<literal>pre-auto</literal> and <literal>never</literal>. "
3653 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3654 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3655 "default) does so conditionally. <literal>auto</literal> removes only those "
3656 "packages which are no longer downloadable (replaced with a new version for "
3657 "instance). <literal>pre-auto</literal> performs this action before "
3658 "downloading new packages."
3661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3664 "The contents of this variable are passed to &apt-get; as command line "
3665 "options when it is run for the install phase."
3668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3671 "The contents of this variable are passed to &apt-get; as command line "
3672 "options when it is run for the update phase."
3675 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3678 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3679 "The default is to prompt only on error."
3682 #. type: Content of: <refentry><refsect1><title>
3684 msgid "How APT calls &dpkg;"
3687 #. type: Content of: <refentry><refsect1><para>
3690 "Several configuration directives control how APT invokes &dpkg;. These are "
3691 "in the <literal>DPkg</literal> section."
3694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3697 "This is a list of options to pass to &dpkg;. The options must be specified "
3698 "using the list notation and each list item is passed as a single argument to "
3702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3705 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3706 "<literal>options</literal> this must be specified in list notation. The "
3707 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3708 "fail APT will abort."
3711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3714 "This is a list of shell commands to run before invoking &dpkg;. Like "
3715 "<literal>options</literal> this must be specified in list notation. The "
3716 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3717 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3718 "going to install to the commands, one per line on the requested file "
3719 "descriptor, defaulting to standard input."
3722 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3725 "Version 2 of this protocol sends more information through the requested file "
3726 "descriptor: a line with the text <literal>VERSION 2</literal>, the APT "
3727 "configuration space, and a list of package actions with filename and version "
3731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3734 "Each configuration directive line has the form "
3735 "<literal>key=value</literal>. Special characters (equal signs, newlines, "
3736 "nonprintable characters, quotation marks, and percent signs in "
3737 "<literal>key</literal> and newlines, nonprintable characters, and percent "
3738 "signs in <literal>value</literal>) are %-encoded. Lists are represented by "
3739 "multiple <literal>key::=value</literal> lines with the same key. The "
3740 "configuration section ends with a blank line."
3743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3746 "Package action lines consist of five fields in Version 2: old version, "
3747 "direction of version change (< for upgrades, > for downgrades, = for "
3748 "no change), new version, action. The version fields are \"-\" for no version "
3749 "at all (for example when installing a package for the first time; no version "
3750 "is treated as earlier than any real version, so that is an upgrade, "
3751 "indicated as <literal>- < 1.23.4</literal>). The action field is "
3752 "\"**CONFIGURE**\" if the package is being configured, \"**REMOVE**\" if it "
3753 "is being removed, or the filename of a .deb file if it is being unpacked."
3756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3759 "In Version 3 after each version field follows the architecture of this "
3760 "version, which is \"-\" if there is no version, and a field showing the "
3761 "MultiArch type \"same\", foreign\", \"allowed\" or \"none\". Note that "
3762 "\"none\" is an incorrect typename which is just kept to remain compatible, "
3763 "it should be read as \"no\" and users are encouraged to support both."
3766 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3769 "The version of the protocol to be used for the command "
3770 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3771 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3772 "accordingly, the default being version 1. If APT isn't supporting the "
3773 "requested version it will send the information in the highest version it has "
3774 "support for instead."
3777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3780 "The file descriptor to be used to send the information can be requested with "
3781 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3782 "which defaults to <literal>0</literal> for standard input and is available "
3783 "since version 0.9.11. Support for the option can be detected by looking for "
3784 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3785 "number of the used file descriptor as a confirmation."
3788 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3791 "APT chdirs to this directory before invoking &dpkg;, the default is "
3792 "<filename>/</filename>."
3795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3798 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3799 "default is to disable signing and produce all binaries."
3802 #. type: Content of: <refentry><refsect1><refsect2><title>
3804 msgid "dpkg trigger usage (and related options)"
3807 #. type: Content of: <refentry><refsect1><refsect2><para>
3810 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3811 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3812 "use triggers once each time it runs. Activating these options can therefore "
3813 "decrease the time needed to perform the install or upgrade. Note that it is "
3814 "intended to activate these options per default in the future, but as it "
3815 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3816 "<emphasis>These options are therefore currently experimental and should not "
3817 "be used in production environments.</emphasis> It also breaks progress "
3818 "reporting such that all front-ends will currently stay around half (or more) "
3819 "of the time in the 100% state while it actually configures all packages."
3822 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3826 "DPkg::NoTriggers \"true\";\n"
3827 "PackageManager::Configure \"smart\";\n"
3828 "DPkg::ConfigurePending \"true\";\n"
3829 "DPkg::TriggersPending \"true\";"
3832 #. type: Content of: <refentry><refsect1><refsect2><para>
3835 "Note that it is not guaranteed that APT will support these options or that "
3836 "these options will not cause (big) trouble in the future. If you have "
3837 "understand the current risks and problems with these options, but are brave "
3838 "enough to help testing them, create a new configuration file and test a "
3839 "combination of options. Please report any bugs, problems and improvements "
3840 "you encounter and make sure to note which options you have used in your "
3841 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3842 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3843 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3846 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3849 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3850 "call). See &dpkg; if you are interested in what this actually means. In "
3851 "short: &dpkg; will not run the triggers when this flag is present unless it "
3852 "is explicitly called to do so in an extra call. Note that this option "
3853 "exists (undocumented) also in older APT versions with a slightly different "
3854 "meaning: Previously these option only append --no-triggers to the configure "
3855 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3859 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3862 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3863 "and \"<literal>no</literal>\". The default value is "
3864 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3865 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3866 "be configured before another package can be unpacked (Pre-Depends), and let "
3867 "the rest be configured by &dpkg; with a call generated by the "
3868 "ConfigurePending option (see below). On the other hand, "
3869 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3870 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3871 "encountered). Setting this option to any value other than "
3872 "<literal>all</literal> will implicitly also activate the next option by "
3873 "default, as otherwise the system could end in an unconfigured and "
3874 "potentially unbootable state."
3877 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3880 "If this option is set APT will call <command>dpkg --configure "
3881 "--pending</command> to let &dpkg; handle all required configurations and "
3882 "triggers. This option is activated automatically per default if the previous "
3883 "option is not set to <literal>all</literal>, but deactivating it could be "
3884 "useful if you want to run APT multiple times in a row - e.g. in an "
3885 "installer. In these sceneries you could deactivate this option in all but "
3889 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3892 "Useful for the <literal>smart</literal> configuration as a package which has "
3893 "pending triggers is not considered as <literal>installed</literal>, and "
3894 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3895 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3896 "process all triggers, not only the triggers needed to configure this "
3900 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3904 "OrderList::Score {\n"
3906 "\tEssential 200;\n"
3908 "\tPreDepends 50;\n"
3912 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3915 "Essential packages (and their dependencies) should be configured immediately "
3916 "after unpacking. It is a good idea to do this quite early in the upgrade "
3917 "process as these configure calls also currently require "
3918 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3919 "(which may not be needed). Essentials get per default a high score but the "
3920 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3921 "higher). These option and the others in the same group can be used to "
3922 "change the scoring. The following example shows the settings with their "
3923 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3926 #. type: Content of: <refentry><refsect1><title>
3928 msgid "Periodic and Archives options"
3931 #. type: Content of: <refentry><refsect1><para>
3934 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3935 "of options configure behavior of apt periodic updates, which is done by the "
3936 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3937 "for the brief documentation of these options."
3940 #. type: Content of: <refentry><refsect1><title>
3942 msgid "Debug options"
3945 #. type: Content of: <refentry><refsect1><para>
3948 "Enabling options in the <literal>Debug::</literal> section will cause "
3949 "debugging information to be sent to the standard error stream of the program "
3950 "utilizing the <literal>apt</literal> libraries, or enable special program "
3951 "modes that are primarily useful for debugging the behavior of "
3952 "<literal>apt</literal>. Most of these options are not interesting to a "
3953 "normal user, but a few may be:"
3956 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3959 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3960 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3964 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3967 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3968 "used to run some operations (for instance, <literal>apt-get -s "
3969 "install</literal>) as a non-root user."
3972 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3975 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3976 "time that <literal>apt</literal> invokes &dpkg;."
3980 #. motivating example, except I haven't a clue why you'd want
3982 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3985 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3989 #. type: Content of: <refentry><refsect1><para>
3991 msgid "A full list of debugging options to apt follows."
3994 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3996 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4001 msgid "Print information related to downloading packages using FTP."
4004 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4006 msgid "Print information related to downloading packages using HTTP."
4009 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4011 msgid "Print information related to downloading packages using HTTPS."
4014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4017 "Print information related to verifying cryptographic signatures using "
4018 "<literal>gpg</literal>."
4021 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4024 "Output information about the process of accessing collections of packages "
4025 "stored on CD-ROMs."
4028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4030 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4033 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4036 "Output each cryptographic hash that is generated by the "
4037 "<literal>apt</literal> libraries."
4040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4043 "Do not include information from <literal>statfs</literal>, namely the number "
4044 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4048 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4051 "Disable all file locking. For instance, this will allow two instances of "
4052 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4057 msgid "Log when items are added to or removed from the global download queue."
4060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4063 "Output status messages and errors related to verifying checksums and "
4064 "cryptographic signatures of downloaded files."
4067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4070 "Output information about downloading and applying package index list diffs, "
4071 "and errors relating to package index list diffs."
4074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4077 "Output information related to patching apt package lists when downloading "
4078 "index diffs instead of full indices."
4081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4083 msgid "Log all interactions with the sub-processes that actually perform downloads."
4086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4089 "Log events related to the automatically-installed status of packages and to "
4090 "the removal of unused packages."
4093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4096 "Generate debug messages describing which packages are being automatically "
4097 "installed to resolve dependencies. This corresponds to the initial "
4098 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4099 "and not to the full <literal>apt</literal> dependency resolver; see "
4100 "<literal>Debug::pkgProblemResolver</literal> for that."
4103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4106 "Generate debug messages describing which packages are marked as "
4107 "keep/install/remove while the ProblemResolver does his work. Each addition "
4108 "or deletion may trigger additional actions; they are shown indented two "
4109 "additional spaces under the original entry. The format for each line is "
4110 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4111 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4112 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4113 "is the current version of the package, <literal>d.e.f</literal> is the "
4114 "version considered for installation and <literal>x.y.z</literal> is a newer "
4115 "version, but not considered for installation (because of a low pin "
4116 "score). The later two can be omitted if there is none or if it is the same "
4117 "as the installed version. <literal>section</literal> is the name of the "
4118 "section the package appears in."
4121 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4124 "When invoking &dpkg;, output the precise command line with which it is being "
4125 "invoked, with arguments separated by a single space character."
4128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4131 "Output all the data received from &dpkg; on the status file descriptor and "
4132 "any errors encountered while parsing it."
4135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4138 "Generate a trace of the algorithm that decides the order in which "
4139 "<literal>apt</literal> should pass packages to &dpkg;."
4142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4144 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4147 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4149 msgid "Output the priority of each package list on startup."
4152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4155 "Trace the execution of the dependency resolver (this applies only to what "
4156 "happens when a complex dependency problem is encountered)."
4159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4162 "Display a list of all installed packages with their calculated score used by "
4163 "the pkgProblemResolver. The description of the package is the same as "
4164 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4170 "Print information about the vendors read from "
4171 "<filename>/etc/apt/vendors.list</filename>."
4174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4177 "Display the external commands that are called by apt hooks. This includes "
4178 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
4179 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
4182 #. type: Content of: <refentry><refsect1><title>
4183 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
4184 #: apt-ftparchive.1.xml:1
4188 #. type: Content of: <refentry><refsect1><para>
4191 "&configureindex; is a configuration file showing example values for all "
4195 #. ? reading apt.conf
4196 #. type: Content of: <refentry><refsect1><para>
4198 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4201 #. type: Content of: <refentry><refnamediv><refpurpose>
4202 #: apt_preferences.5.xml:1
4203 msgid "Preference control file for APT"
4206 #. type: Content of: <refentry><refsect1><para>
4207 #: apt_preferences.5.xml:1
4209 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4210 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4211 "can be used to control which versions of packages will be selected for "
4215 #. type: Content of: <refentry><refsect1><para>
4216 #: apt_preferences.5.xml:1
4218 "Several versions of a package may be available for installation when the "
4219 "&sources-list; file contains references to more than one distribution (for "
4220 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4221 "assigns a priority to each version that is available. Subject to dependency "
4222 "constraints, <command>apt-get</command> selects the version with the highest "
4223 "priority for installation. The APT preferences override the priorities that "
4224 "APT assigns to package versions by default, thus giving the user control "
4225 "over which one is selected for installation."
4228 #. type: Content of: <refentry><refsect1><para>
4229 #: apt_preferences.5.xml:1
4231 "Several instances of the same version of a package may be available when the "
4232 "&sources-list; file contains references to more than one source. In this "
4233 "case <command>apt-get</command> downloads the instance listed earliest in "
4234 "the &sources-list; file. The APT preferences do not affect the choice of "
4235 "instance, only the choice of version."
4238 #. type: Content of: <refentry><refsect1><para>
4239 #: apt_preferences.5.xml:1
4241 "Preferences are a strong power in the hands of a system administrator but "
4242 "they can become also their biggest nightmare if used without care! APT will "
4243 "not question the preferences, so wrong settings can lead to uninstallable "
4244 "packages or wrong decisions while upgrading packages. Even more problems "
4245 "will arise if multiple distribution releases are mixed without a good "
4246 "understanding of the following paragraphs. Packages included in a specific "
4247 "release aren't tested in (and therefore don't always work as expected in) "
4248 "older or newer releases, or together with other packages from different "
4249 "releases. You have been warned."
4252 #. type: Content of: <refentry><refsect1><para>
4253 #: apt_preferences.5.xml:1
4255 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4256 "directory are parsed in alphanumeric ascending order and need to obey the "
4257 "following naming convention: The files have either no or "
4258 "\"<literal>pref</literal>\" as filename extension and only contain "
4259 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4260 "Otherwise APT will print a notice that it has ignored a file, unless that "
4261 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4262 "configuration list - in which case it will be silently ignored."
4265 #. type: Content of: <refentry><refsect1><refsect2><title>
4266 #: apt_preferences.5.xml:1
4267 msgid "APT's Default Priority Assignments"
4270 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4271 #: apt_preferences.5.xml:1
4274 "<command>apt-get install -t testing "
4275 "<replaceable>some-package</replaceable></command>\n"
4278 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4279 #: apt_preferences.5.xml:1
4281 msgid "APT::Default-Release \"stable\";\n"
4284 #. type: Content of: <refentry><refsect1><refsect2><para>
4285 #: apt_preferences.5.xml:1
4287 "If there is no preferences file or if there is no entry in the file that "
4288 "applies to a particular version then the priority assigned to that version "
4289 "is the priority of the distribution to which that version belongs. It is "
4290 "possible to single out a distribution, \"the target release\", which "
4291 "receives a higher priority than other distributions do by default. The "
4292 "target release can be set on the <command>apt-get</command> command line or "
4293 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4294 "that this has precedence over any general priority you set in the "
4295 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4296 "specifically pinned packages. For example, <placeholder "
4297 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4301 #. type: Content of: <refentry><refsect1><refsect2><para>
4302 #: apt_preferences.5.xml:1
4304 "If the target release has been specified then APT uses the following "
4305 "algorithm to set the priorities of the versions of a package. Assign:"
4308 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4309 #: apt_preferences.5.xml:1
4313 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4314 #: apt_preferences.5.xml:1
4316 "to the versions coming from archives which in their "
4317 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4318 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
4319 "<literal>experimental</literal> archive."
4322 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4323 #: apt_preferences.5.xml:1
4324 msgid "priority 100"
4327 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4328 #: apt_preferences.5.xml:1
4330 "to the version that is already installed (if any) and to the versions coming "
4331 "from archives which in their <filename>Release</filename> files are marked "
4332 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
4333 "backports archive since <literal>squeeze-backports</literal>."
4336 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4337 #: apt_preferences.5.xml:1
4338 msgid "priority 500"
4341 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4342 #: apt_preferences.5.xml:1
4343 msgid "to the versions that do not belong to the target release."
4346 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4347 #: apt_preferences.5.xml:1
4348 msgid "priority 990"
4351 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4352 #: apt_preferences.5.xml:1
4353 msgid "to the versions that belong to the target release."
4356 #. type: Content of: <refentry><refsect1><refsect2><para>
4357 #: apt_preferences.5.xml:1
4359 "The highest of those priorities whose description matches the version is "
4360 "assigned to the version."
4363 #. type: Content of: <refentry><refsect1><refsect2><para>
4364 #: apt_preferences.5.xml:1
4366 "If the target release has not been specified then APT simply assigns "
4367 "priority 100 to all installed package versions and priority 500 to all "
4368 "uninstalled package versions, except versions coming from archives which in "
4369 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4370 "- these versions get the priority 1 or priority 100 if it is additionally "
4371 "marked as \"ButAutomaticUpgrades: yes\"."
4374 #. type: Content of: <refentry><refsect1><refsect2><para>
4375 #: apt_preferences.5.xml:1
4377 "APT then applies the following rules, listed in order of precedence, to "
4378 "determine which version of a package to install."
4381 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4382 #: apt_preferences.5.xml:1
4384 "Never downgrade unless the priority of an available version exceeds 1000. "
4385 "(\"Downgrading\" is installing a less recent version of a package in place "
4386 "of a more recent version. Note that none of APT's default priorities "
4387 "exceeds 1000; such high priorities can only be set in the preferences file. "
4388 "Note also that downgrading a package can be risky.)"
4391 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4392 #: apt_preferences.5.xml:1
4393 msgid "Install the highest priority version."
4396 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4397 #: apt_preferences.5.xml:1
4399 "If two or more versions have the same priority, install the most recent one "
4400 "(that is, the one with the higher version number)."
4403 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4404 #: apt_preferences.5.xml:1
4406 "If two or more versions have the same priority and version number but either "
4407 "the packages differ in some of their metadata or the "
4408 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4411 #. type: Content of: <refentry><refsect1><refsect2><para>
4412 #: apt_preferences.5.xml:1
4414 "In a typical situation, the installed version of a package (priority 100) "
4415 "is not as recent as one of the versions available from the sources listed in "
4416 "the &sources-list; file (priority 500 or 990). Then the package will be "
4417 "upgraded when <command>apt-get install "
4418 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4419 "upgrade</command> is executed."
4422 #. type: Content of: <refentry><refsect1><refsect2><para>
4423 #: apt_preferences.5.xml:1
4425 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4426 "recent than any of the other available versions. The package will not be "
4427 "downgraded when <command>apt-get install "
4428 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4429 "upgrade</command> is executed."
4432 #. type: Content of: <refentry><refsect1><refsect2><para>
4433 #: apt_preferences.5.xml:1
4435 "Sometimes the installed version of a package is more recent than the version "
4436 "belonging to the target release, but not as recent as a version belonging to "
4437 "some other distribution. Such a package will indeed be upgraded when "
4438 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4439 "or <command>apt-get upgrade</command> is executed, because at least "
4440 "<emphasis>one</emphasis> of the available versions has a higher priority "
4441 "than the installed version."
4444 #. type: Content of: <refentry><refsect1><refsect2><title>
4445 #: apt_preferences.5.xml:1
4446 msgid "The Effect of APT Preferences"
4449 #. type: Content of: <refentry><refsect1><refsect2><para>
4450 #: apt_preferences.5.xml:1
4452 "The APT preferences file allows the system administrator to control the "
4453 "assignment of priorities. The file consists of one or more multi-line "
4454 "records separated by blank lines. Records can have one of two forms, a "
4455 "specific form and a general form."
4458 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4459 #: apt_preferences.5.xml:1
4461 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4462 "specified packages with a specified version or version range. For example, "
4463 "the following record assigns a high priority to all versions of the "
4464 "<filename>perl</filename> package whose version number begins with "
4465 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4469 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4470 #: apt_preferences.5.xml:1
4474 "Pin: version &good-perl;*\n"
4475 "Pin-Priority: 1001\n"
4478 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4479 #: apt_preferences.5.xml:1
4481 "The general form assigns a priority to all of the package versions in a "
4482 "given distribution (that is, to all the versions of packages that are listed "
4483 "in a certain <filename>Release</filename> file) or to all of the package "
4484 "versions coming from a particular Internet site, as identified by the site's "
4485 "fully qualified domain name."
4488 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4489 #: apt_preferences.5.xml:1
4491 "This general-form entry in the APT preferences file applies only to groups "
4492 "of packages. For example, the following record assigns a high priority to "
4493 "all package versions available from the local site."
4496 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4497 #: apt_preferences.5.xml:1
4501 "Pin: origin \"\"\n"
4502 "Pin-Priority: 999\n"
4505 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4506 #: apt_preferences.5.xml:1
4508 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4509 "which can be used to match a hostname. The following record will assign a "
4510 "high priority to all versions available from the server identified by the "
4511 "hostname \"ftp.de.debian.org\""
4514 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4515 #: apt_preferences.5.xml:1
4519 "Pin: origin \"ftp.de.debian.org\"\n"
4520 "Pin-Priority: 999\n"
4523 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4524 #: apt_preferences.5.xml:1
4526 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4527 "distribution as specified in a <filename>Release</filename> file. What "
4528 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4529 "Internet address but an author or vendor name, such as \"Debian\" or "
4533 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4534 #: apt_preferences.5.xml:1
4536 "The following record assigns a low priority to all package versions "
4537 "belonging to any distribution whose Archive name is "
4538 "\"<literal>unstable</literal>\"."
4541 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4542 #: apt_preferences.5.xml:1
4546 "Pin: release a=unstable\n"
4547 "Pin-Priority: 50\n"
4550 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4551 #: apt_preferences.5.xml:1
4553 "The following record assigns a high priority to all package versions "
4554 "belonging to any distribution whose Codename is "
4555 "\"<literal>&testing-codename;</literal>\"."
4558 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4559 #: apt_preferences.5.xml:1
4563 "Pin: release n=&testing-codename;\n"
4564 "Pin-Priority: 900\n"
4567 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4568 #: apt_preferences.5.xml:1
4570 "The following record assigns a high priority to all package versions "
4571 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4572 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4575 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4576 #: apt_preferences.5.xml:1
4580 "Pin: release a=stable, v=&stable-version;\n"
4581 "Pin-Priority: 500\n"
4584 #. type: Content of: <refentry><refsect1><refsect2><para>
4585 #: apt_preferences.5.xml:1
4587 "The effect of the comma operator is similar to an \"and\" in logic: All "
4588 "conditions must be satisfied for the pin to match. There is one exception: "
4589 "For any type of condition (such as two \"a\" conditions), only the last such "
4590 "condition is checked."
4593 #. type: Content of: <refentry><refsect1><refsect2><title>
4594 #: apt_preferences.5.xml:1
4595 msgid "Regular expressions and &glob; syntax"
4598 #. type: Content of: <refentry><refsect1><refsect2><para>
4599 #: apt_preferences.5.xml:1
4601 "APT also supports pinning by &glob; expressions, and regular expressions "
4602 "surrounded by slashes. For example, the following example assigns the "
4603 "priority 500 to all packages from experimental where the name starts with "
4604 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4605 "extended regular expression surrounded by slashes)."
4608 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4609 #: apt_preferences.5.xml:1
4612 "Package: gnome* /kde/\n"
4613 "Pin: release a=experimental\n"
4614 "Pin-Priority: 500\n"
4617 #. type: Content of: <refentry><refsect1><refsect2><para>
4618 #: apt_preferences.5.xml:1
4620 "The rule for those expressions is that they can occur anywhere where a "
4621 "string can occur. Thus, the following pin assigns the priority 990 to all "
4622 "packages from a release starting with &ubuntu-codename;."
4625 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4626 #: apt_preferences.5.xml:1
4630 "Pin: release n=&ubuntu-codename;*\n"
4631 "Pin-Priority: 990\n"
4634 #. type: Content of: <refentry><refsect1><refsect2><para>
4635 #: apt_preferences.5.xml:1
4637 "If a regular expression occurs in a <literal>Package</literal> field, the "
4638 "behavior is the same as if this regular expression were replaced with a list "
4639 "of all package names it matches. It is undecided whether this will change in "
4640 "the future; thus you should always list wild-card pins first, so later "
4641 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4642 "Package field is not considered a &glob; expression in itself."
4645 #. type: Content of: <refentry><refsect1><refsect2><title>
4646 #: apt_preferences.5.xml:1
4647 msgid "How APT Interprets Priorities"
4650 #. type: Content of: <refentry><refsect1><refsect2><para>
4651 #: apt_preferences.5.xml:1
4653 "Priorities (P) assigned in the APT preferences file must be positive or "
4654 "negative integers. They are interpreted as follows (roughly speaking):"
4657 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4658 #: apt_preferences.5.xml:1
4659 msgid "P >= 1000"
4662 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4663 #: apt_preferences.5.xml:1
4665 "causes a version to be installed even if this constitutes a downgrade of the "
4669 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4670 #: apt_preferences.5.xml:1
4671 msgid "990 <= P < 1000"
4674 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4675 #: apt_preferences.5.xml:1
4677 "causes a version to be installed even if it does not come from the target "
4678 "release, unless the installed version is more recent"
4681 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4682 #: apt_preferences.5.xml:1
4683 msgid "500 <= P < 990"
4686 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4687 #: apt_preferences.5.xml:1
4689 "causes a version to be installed unless there is a version available "
4690 "belonging to the target release or the installed version is more recent"
4693 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4694 #: apt_preferences.5.xml:1
4695 msgid "100 <= P < 500"
4698 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4699 #: apt_preferences.5.xml:1
4701 "causes a version to be installed unless there is a version available "
4702 "belonging to some other distribution or the installed version is more recent"
4705 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4706 #: apt_preferences.5.xml:1
4707 msgid "0 < P < 100"
4710 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4711 #: apt_preferences.5.xml:1
4713 "causes a version to be installed only if there is no installed version of "
4717 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4718 #: apt_preferences.5.xml:1
4722 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4723 #: apt_preferences.5.xml:1
4724 msgid "prevents the version from being installed"
4727 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4728 #: apt_preferences.5.xml:1
4732 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4733 #: apt_preferences.5.xml:1
4734 msgid "has undefined behaviour, do not use it."
4737 #. type: Content of: <refentry><refsect1><refsect2><para>
4738 #: apt_preferences.5.xml:1
4740 "The first specific-form record matching an available package version "
4741 "determines the priority of the package version. Failing that, the priority "
4742 "of the package is defined as the maximum of all priorities defined by "
4743 "generic-form records matching the version. Records defined using patterns "
4744 "in the Pin field other than \"*\" are treated like specific-form records."
4747 #. type: Content of: <refentry><refsect1><refsect2><para>
4748 #: apt_preferences.5.xml:1
4750 "For example, suppose the APT preferences file contains the three records "
4751 "presented earlier:"
4754 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4755 #: apt_preferences.5.xml:1
4759 "Pin: version &good-perl;*\n"
4760 "Pin-Priority: 1001\n"
4763 "Pin: origin \"\"\n"
4764 "Pin-Priority: 999\n"
4767 "Pin: release unstable\n"
4768 "Pin-Priority: 50\n"
4771 #. type: Content of: <refentry><refsect1><refsect2><para>
4772 #: apt_preferences.5.xml:1
4776 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4777 #: apt_preferences.5.xml:1
4779 "The most recent available version of the <literal>perl</literal> package "
4780 "will be installed, so long as that version's version number begins with "
4781 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4782 "&good-perl;* version of <literal>perl</literal> is available and the "
4783 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4787 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4788 #: apt_preferences.5.xml:1
4790 "A version of any package other than <literal>perl</literal> that is "
4791 "available from the local system has priority over other versions, even "
4792 "versions belonging to the target release."
4795 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4796 #: apt_preferences.5.xml:1
4798 "A version of a package whose origin is not the local system but some other "
4799 "site listed in &sources-list; and which belongs to an "
4800 "<literal>unstable</literal> distribution is only installed if it is selected "
4801 "for installation and no version of the package is already installed."
4804 #. type: Content of: <refentry><refsect1><refsect2><title>
4805 #: apt_preferences.5.xml:1
4806 msgid "Determination of Package Version and Distribution Properties"
4809 #. type: Content of: <refentry><refsect1><refsect2><para>
4810 #: apt_preferences.5.xml:1
4812 "The locations listed in the &sources-list; file should provide "
4813 "<filename>Packages</filename> and <filename>Release</filename> files to "
4814 "describe the packages available at that location."
4817 #. type: Content of: <refentry><refsect1><refsect2><para>
4818 #: apt_preferences.5.xml:1
4820 "The <filename>Packages</filename> file is normally found in the directory "
4821 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4823 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4824 "consists of a series of multi-line records, one for each package available "
4825 "in that directory. Only two lines in each record are relevant for setting "
4829 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4830 #: apt_preferences.5.xml:1
4831 msgid "the <literal>Package:</literal> line"
4834 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4835 #: apt_preferences.5.xml:1
4836 msgid "gives the package name"
4839 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4840 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1
4841 msgid "the <literal>Version:</literal> line"
4844 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4845 #: apt_preferences.5.xml:1
4846 msgid "gives the version number for the named package"
4849 #. type: Content of: <refentry><refsect1><refsect2><para>
4850 #: apt_preferences.5.xml:1
4852 "The <filename>Release</filename> file is normally found in the directory "
4853 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4854 "example, <filename>.../dists/stable/Release</filename>, or "
4855 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4856 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4857 "packages in the directory tree below its parent. Unlike the "
4858 "<filename>Packages</filename> file, nearly all of the lines in a "
4859 "<filename>Release</filename> file are relevant for setting APT priorities:"
4862 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4863 #: apt_preferences.5.xml:1
4864 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4867 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4868 #: apt_preferences.5.xml:1
4870 "names the archive to which all the packages in the directory tree belong. "
4871 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4872 "that all of the packages in the directory tree below the parent of the "
4873 "<filename>Release</filename> file are in a <literal>stable</literal> "
4874 "archive. Specifying this value in the APT preferences file would require "
4878 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4879 #: apt_preferences.5.xml:1
4881 msgid "Pin: release a=stable\n"
4884 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4885 #: apt_preferences.5.xml:1
4886 msgid "the <literal>Codename:</literal> line"
4889 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4890 #: apt_preferences.5.xml:1
4892 "names the codename to which all the packages in the directory tree belong. "
4893 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4894 "the packages in the directory tree below the parent of the "
4895 "<filename>Release</filename> file belong to a version named "
4896 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4897 "preferences file would require the line:"
4900 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4901 #: apt_preferences.5.xml:1
4903 msgid "Pin: release n=&testing-codename;\n"
4906 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4907 #: apt_preferences.5.xml:1
4909 "names the release version. For example, the packages in the tree might "
4910 "belong to Debian release version &stable-version;. Note that there is "
4911 "normally no version number for the <literal>testing</literal> and "
4912 "<literal>unstable</literal> distributions because they have not been "
4913 "released yet. Specifying this in the APT preferences file would require one "
4914 "of the following lines."
4917 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4918 #: apt_preferences.5.xml:1
4921 "Pin: release v=&stable-version;\n"
4922 "Pin: release a=stable, v=&stable-version;\n"
4923 "Pin: release &stable-version;\n"
4926 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4927 #: apt_preferences.5.xml:1
4928 msgid "the <literal>Component:</literal> line"
4931 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4932 #: apt_preferences.5.xml:1
4934 "names the licensing component associated with the packages in the directory "
4935 "tree of the <filename>Release</filename> file. For example, the line "
4936 "\"Component: main\" specifies that all the packages in the directory tree "
4937 "are from the <literal>main</literal> component, which entails that they are "
4938 "licensed under terms listed in the Debian Free Software Guidelines. "
4939 "Specifying this component in the APT preferences file would require the "
4943 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4944 #: apt_preferences.5.xml:1
4946 msgid "Pin: release c=main\n"
4949 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4950 #: apt_preferences.5.xml:1
4951 msgid "the <literal>Origin:</literal> line"
4954 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4955 #: apt_preferences.5.xml:1
4957 "names the originator of the packages in the directory tree of the "
4958 "<filename>Release</filename> file. Most commonly, this is "
4959 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4960 "file would require the line:"
4963 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4964 #: apt_preferences.5.xml:1
4966 msgid "Pin: release o=Debian\n"
4969 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4970 #: apt_preferences.5.xml:1
4971 msgid "the <literal>Label:</literal> line"
4974 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4975 #: apt_preferences.5.xml:1
4977 "names the label of the packages in the directory tree of the "
4978 "<filename>Release</filename> file. Most commonly, this is "
4979 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4980 "file would require the line:"
4983 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4984 #: apt_preferences.5.xml:1
4986 msgid "Pin: release l=Debian\n"
4989 #. type: Content of: <refentry><refsect1><refsect2><para>
4990 #: apt_preferences.5.xml:1
4992 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4993 "files retrieved from locations listed in the &sources-list; file are stored "
4994 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4995 "named by the variable <literal>Dir::State::Lists</literal> in the "
4996 "<filename>apt.conf</filename> file. For example, the file "
4997 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4998 "contains the <filename>Release</filename> file retrieved from the site "
4999 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5000 "architecture files from the <literal>contrib</literal> component of the "
5001 "<literal>unstable</literal> distribution."
5004 #. type: Content of: <refentry><refsect1><refsect2><title>
5005 #: apt_preferences.5.xml:1
5006 msgid "Optional Lines in an APT Preferences Record"
5009 #. type: Content of: <refentry><refsect1><refsect2><para>
5010 #: apt_preferences.5.xml:1
5012 "Each record in the APT preferences file can optionally begin with one or "
5013 "more lines beginning with the word <literal>Explanation:</literal>. This "
5014 "provides a place for comments."
5017 #. type: Content of: <refentry><refsect1><refsect2><title>
5018 #: apt_preferences.5.xml:1
5019 msgid "Tracking Stable"
5022 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5023 #: apt_preferences.5.xml:1
5026 "Explanation: Uninstall or do not install any Debian-originated\n"
5027 "Explanation: package versions other than those in the stable distro\n"
5029 "Pin: release a=stable\n"
5030 "Pin-Priority: 900\n"
5033 "Pin: release o=Debian\n"
5034 "Pin-Priority: -10\n"
5037 #. type: Content of: <refentry><refsect1><refsect2><para>
5038 #: apt_preferences.5.xml:1
5040 "The following APT preferences file will cause APT to assign a priority "
5041 "higher than the default (500) to all package versions belonging to a "
5042 "<literal>stable</literal> distribution and a prohibitively low priority to "
5043 "package versions belonging to other <literal>Debian</literal> "
5044 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5047 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5048 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1 apt_preferences.5.xml:1
5051 "apt-get install <replaceable>package-name</replaceable>\n"
5053 "apt-get dist-upgrade\n"
5056 #. type: Content of: <refentry><refsect1><refsect2><para>
5057 #: apt_preferences.5.xml:1
5059 "With a suitable &sources-list; file and the above preferences file, any of "
5060 "the following commands will cause APT to upgrade to the latest "
5061 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5065 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5066 #: apt_preferences.5.xml:1
5068 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5071 #. type: Content of: <refentry><refsect1><refsect2><para>
5072 #: apt_preferences.5.xml:1
5074 "The following command will cause APT to upgrade the specified package to the "
5075 "latest version from the <literal>testing</literal> distribution; the package "
5076 "will not be upgraded again unless this command is given again. <placeholder "
5077 "type=\"programlisting\" id=\"0\"/>"
5080 #. type: Content of: <refentry><refsect1><refsect2><title>
5081 #: apt_preferences.5.xml:1
5082 msgid "Tracking Testing or Unstable"
5085 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5086 #: apt_preferences.5.xml:1
5090 "Pin: release a=testing\n"
5091 "Pin-Priority: 900\n"
5094 "Pin: release a=unstable\n"
5095 "Pin-Priority: 800\n"
5098 "Pin: release o=Debian\n"
5099 "Pin-Priority: -10\n"
5102 #. type: Content of: <refentry><refsect1><refsect2><para>
5103 #: apt_preferences.5.xml:1
5105 "The following APT preferences file will cause APT to assign a high priority "
5106 "to package versions from the <literal>testing</literal> distribution, a "
5107 "lower priority to package versions from the <literal>unstable</literal> "
5108 "distribution, and a prohibitively low priority to package versions from "
5109 "other <literal>Debian</literal> distributions. <placeholder "
5110 "type=\"programlisting\" id=\"0\"/>"
5113 #. type: Content of: <refentry><refsect1><refsect2><para>
5114 #: apt_preferences.5.xml:1
5116 "With a suitable &sources-list; file and the above preferences file, any of "
5117 "the following commands will cause APT to upgrade to the latest "
5118 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5122 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5123 #: apt_preferences.5.xml:1
5125 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5128 #. type: Content of: <refentry><refsect1><refsect2><para>
5129 #: apt_preferences.5.xml:1
5131 "The following command will cause APT to upgrade the specified package to the "
5132 "latest version from the <literal>unstable</literal> distribution. "
5133 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5134 "the most recent <literal>testing</literal> version if that is more recent "
5135 "than the installed version, otherwise, to the most recent "
5136 "<literal>unstable</literal> version if that is more recent than the "
5137 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5140 #. type: Content of: <refentry><refsect1><refsect2><title>
5141 #: apt_preferences.5.xml:1
5142 msgid "Tracking the evolution of a codename release"
5145 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5146 #: apt_preferences.5.xml:1
5149 "Explanation: Uninstall or do not install any Debian-originated package "
5151 "Explanation: other than those in the distribution codenamed with "
5152 "&testing-codename; or sid\n"
5154 "Pin: release n=&testing-codename;\n"
5155 "Pin-Priority: 900\n"
5157 "Explanation: Debian unstable is always codenamed with sid\n"
5159 "Pin: release n=sid\n"
5160 "Pin-Priority: 800\n"
5163 "Pin: release o=Debian\n"
5164 "Pin-Priority: -10\n"
5167 #. type: Content of: <refentry><refsect1><refsect2><para>
5168 #: apt_preferences.5.xml:1
5170 "The following APT preferences file will cause APT to assign a priority "
5171 "higher than the default (500) to all package versions belonging to a "
5172 "specified codename of a distribution and a prohibitively low priority to "
5173 "package versions belonging to other <literal>Debian</literal> distributions, "
5174 "codenames and archives. Note that with this APT preference APT will follow "
5175 "the migration of a release from the archive <literal>testing</literal> to "
5176 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5177 "want to follow for example the progress in <literal>testing</literal> "
5178 "notwithstanding the codename changes you should use the example "
5179 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5182 #. type: Content of: <refentry><refsect1><refsect2><para>
5183 #: apt_preferences.5.xml:1
5185 "With a suitable &sources-list; file and the above preferences file, any of "
5186 "the following commands will cause APT to upgrade to the latest version(s) in "
5187 "the release codenamed with <literal>&testing-codename;</literal>. "
5188 "<placeholder type=\"programlisting\" id=\"0\"/>"
5191 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5192 #: apt_preferences.5.xml:1
5194 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5197 #. type: Content of: <refentry><refsect1><refsect2><para>
5198 #: apt_preferences.5.xml:1
5200 "The following command will cause APT to upgrade the specified package to the "
5201 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5202 "<command>apt-get upgrade</command> will upgrade the package to the most "
5203 "recent <literal>&testing-codename;</literal> version if that is more recent "
5204 "than the installed version, otherwise, to the most recent "
5205 "<literal>sid</literal> version if that is more recent than the installed "
5206 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5209 #. type: Content of: <refentry><refsect1><para>
5210 #: apt_preferences.5.xml:1
5211 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5214 #. type: Content of: <refentry><refnamediv><refpurpose>
5215 #: sources.list.5.xml:1
5216 msgid "List of configured APT data sources"
5219 #. type: Content of: <refentry><refsect1><para>
5220 #: sources.list.5.xml:1
5222 "The source list <filename>/etc/apt/sources.list</filename> and the the files "
5223 "contained in <filename>/etc/apt/sources.list.d/</filename> are designed to "
5224 "support any number of active sources and a variety of source media. The "
5225 "files list one source per line (one line style) or contain multiline stanzas "
5226 "defining one or more sources per stanza (deb822 style), with the most "
5227 "preferred source listed first (in case a single version is available from "
5228 "more than one source). The information available from the configured sources "
5229 "is acquired by <command>apt-get update</command> (or by an equivalent "
5230 "command from another APT front-end)."
5233 #. type: Content of: <refentry><refsect1><title>
5234 #: sources.list.5.xml:1
5235 msgid "sources.list.d"
5238 #. type: Content of: <refentry><refsect1><para>
5239 #: sources.list.5.xml:1
5241 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5242 "add sources.list entries in separate files. Two different file formats are "
5243 "allowed as described in the next two sections. Filenames need to have "
5244 "either the extension <filename>.list</filename> or "
5245 "<filename>.sources</filename> depending on the contained format. The "
5246 "filenames may only contain letters (a-z and A-Z), digits (0-9), underscore "
5247 "(_), hyphen (-) and period (.) characters. Otherwise APT will print a "
5248 "notice that it has ignored a file, unless that file matches a pattern in the "
5249 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
5250 "case it will be silently ignored."
5253 #. type: Content of: <refentry><refsect1><title>
5254 #: sources.list.5.xml:1
5255 msgid "one line style format"
5258 #. type: Content of: <refentry><refsect1><para>
5259 #: sources.list.5.xml:1
5261 "Files in this format have the extension <filename>.list</filename>. Each "
5262 "line specifying a source starts with a type "
5263 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
5264 "this type. Individual entries cannot be continued onto a following "
5265 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
5266 "on a line marks the remainder of that line as a comment. Consequently an "
5267 "entry can be disabled by commenting out the entire line. If options should "
5268 "be provided they are separated by spaces and all of them together are "
5269 "enclosed by square brackets (<literal>[]</literal>) included in the line "
5270 "after the type separated from it with a space. If an option allows multiple "
5271 "values these are separated from each other with a comma "
5272 "(<literal>,</literal>). An option name is separated from its value(s) by a "
5273 "equal sign (<literal>=</literal>). Multivalue options have also "
5274 "<literal>-=</literal> and <literal>+=</literal> as separator which instead "
5275 "of replacing the default with the given value(s) modify the default value(s) "
5276 "to remove or include the given values."
5279 #. type: Content of: <refentry><refsect1><para>
5280 #: sources.list.5.xml:1
5282 "This is the traditional format and supported by all apt versions. Note that "
5283 "not all options as described below are supported by all apt versions. Note "
5284 "also that some older applications parsing this format on its own might not "
5285 "expect to encounter options as they were uncommon before the introduction of "
5286 "multi-architecture support."
5289 #. type: Content of: <refentry><refsect1><title>
5290 #: sources.list.5.xml:1
5291 msgid "deb822 style format"
5294 #. type: Content of: <refentry><refsect1><para>
5295 #: sources.list.5.xml:1
5297 "Files in this format have the extension <filename>.sources</filename>. The "
5298 "format is similar in syntax to other files used by Debian and its "
5299 "derivatives, like the metadata itself apt will download from the configured "
5300 "sources or the <filename>debian/control</filename> file in a Debian source "
5301 "package. Individual entries are separated by an empty line, additional "
5302 "empty lines are ignored, and a <literal>#</literal> character at the start "
5303 "of the line marks the entire line as a comment. An entry can hence be "
5304 "disabled by commenting out each line belonging to the stanza, but it is "
5305 "usually easier to add the field \"Enabled: no\" to the stanza to disable the "
5306 "entry. Removing the field or setting it to yes reenables it. Options have "
5307 "the same syntax as every other field: A fieldname separated by a colon "
5308 "(<literal>:</literal>) and optionally spaces from its value(s). Note "
5309 "especially that multiple values are separated by spaces, not by commas as in "
5310 "the one line format. Multivalue fields like <literal>Architectures</literal> "
5311 "also have <literal>Architectures-Add</literal> and "
5312 "<literal>Architectures-Remove</literal> to modify the default value rather "
5313 "than replacing it."
5316 #. type: Content of: <refentry><refsect1><para>
5317 #: sources.list.5.xml:1
5319 "This is a new format supported by apt itself since version 1.1. Previous "
5320 "versions ignore such files with a notice message as described earlier. It "
5321 "is intended to make this format gradually the default format and deprecating "
5322 "the previously described one line style format as it is easier to create, "
5323 "extend and modify by humans and machines alike especially if a lot of "
5324 "sources and/or options are involved. Developers who are working with and/or "
5325 "parsing apt sources are highly encouraged to add support for this format and "
5326 "to contact the APT team to coordinate and share this work. Users can freely "
5327 "adopt this format already, but could encounter problems with software not "
5328 "supporting the format yet."
5331 #. type: Content of: <refentry><refsect1><title>
5332 #: sources.list.5.xml:1
5333 msgid "The deb and deb-src types: General Format"
5336 #. type: Content of: <refentry><refsect1><para>
5337 #: sources.list.5.xml:1
5339 "The <literal>deb</literal> type references a typical two-level Debian "
5340 "archive, <filename>distribution/component</filename>. The "
5341 "<literal>distribution</literal> is generally a suite name like "
5342 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5343 "<literal>&stable-codename;</literal> or "
5344 "<literal>&testing-codename;</literal> while component is one of "
5345 "<literal>main</literal>, <literal>contrib</literal> or "
5346 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
5347 "a Debian distribution's source code in the same form as the "
5348 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5349 "to fetch source indexes."
5352 #. type: Content of: <refentry><refsect1><para>
5353 #: sources.list.5.xml:1
5355 "The format for two one line style entries using the <literal>deb</literal> "
5356 "and <literal>deb-src</literal> types is:"
5359 #. type: Content of: <refentry><refsect1><literallayout>
5360 #: sources.list.5.xml:1
5363 "deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] "
5365 "deb-src [ option1=value1 option2=value2 ] uri suite [component1] "
5366 "[component2] [...]"
5369 #. type: Content of: <refentry><refsect1><para><literallayout>
5370 #: sources.list.5.xml:1
5373 " Types: deb deb-src\n"
5376 " Components: [component1] [component2] [...]\n"
5377 " option1: value1\n"
5378 " option2: value2\n"
5382 #. type: Content of: <refentry><refsect1><para>
5383 #: sources.list.5.xml:1
5385 "Alternatively the equivalent entry in deb822 style looks like this: "
5386 "<placeholder type=\"literallayout\" id=\"0\"/>"
5389 #. type: Content of: <refentry><refsect1><para>
5390 #: sources.list.5.xml:1
5392 "The URI for the <literal>deb</literal> type must specify the base of the "
5393 "Debian distribution, from which APT will find the information it needs. "
5394 "<literal>suite</literal> can specify an exact path, in which case the "
5395 "components must be omitted and <literal>suite</literal> must end with a "
5396 "slash (<literal>/</literal>). This is useful for the case when only a "
5397 "particular sub-directory of the archive denoted by the URI is of interest. "
5398 "If <literal>suite</literal> does not specify an exact path, at least one "
5399 "<literal>component</literal> must be present."
5402 #. type: Content of: <refentry><refsect1><para>
5403 #: sources.list.5.xml:1
5405 "<literal>suite</literal> may also contain a variable, "
5406 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
5407 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
5408 "system. This permits architecture-independent "
5409 "<filename>sources.list</filename> files to be used. In general this is only "
5410 "of interest when specifying an exact path, <literal>APT</literal> will "
5411 "automatically generate a URI with the current architecture otherwise."
5414 #. type: Content of: <refentry><refsect1><para>
5415 #: sources.list.5.xml:1
5417 "Especially in the one line style format since only one distribution can be "
5418 "specified per line it may be necessary to have multiple lines for the same "
5419 "URI, if a subset of all available distributions or components at that "
5420 "location is desired. APT will sort the URI list after it has generated a "
5421 "complete set internally, and will collapse multiple references to the same "
5422 "Internet host, for instance, into a single connection, so that it does not "
5423 "inefficiently establish a connection, close it, do something else, and then "
5424 "re-establish a connection to that same host. APT also parallelizes "
5425 "connections to different hosts to more effectively deal with sites with low "
5429 #. type: Content of: <refentry><refsect1><para>
5430 #: sources.list.5.xml:1
5432 "It is important to list sources in order of preference, with the most "
5433 "preferred source listed first. Typically this will result in sorting by "
5434 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5435 "followed by distant Internet hosts, for example)."
5438 #. type: Content of: <refentry><refsect1><para><literallayout>
5439 #: sources.list.5.xml:1
5441 msgid "&sourceslist-list-format;"
5444 #. type: Content of: <refentry><refsect1><para><literallayout>
5445 #: sources.list.5.xml:1
5447 msgid "&sourceslist-sources-format;"
5450 #. type: Content of: <refentry><refsect1><para>
5451 #: sources.list.5.xml:1
5453 "As an example, the sources for your distribution could look like this in one "
5454 "line style format: <placeholder type=\"literallayout\" id=\"0\"/> or like "
5455 "this in deb822 style format: <placeholder type=\"literallayout\" id=\"1\"/>"
5458 #. type: Content of: <refentry><refsect1><title>
5459 #: sources.list.5.xml:1
5460 msgid "The deb and deb-src types: Options"
5463 #. type: Content of: <refentry><refsect1><para>
5464 #: sources.list.5.xml:1
5466 "Each source entry can have options specified modifying which and how the "
5467 "source is accessed and data acquired from it. Format, syntax and names of "
5468 "the options varies between the two formats one line and deb822 style as "
5469 "described, but they have both the same options available. For simplicity we "
5470 "list the deb822 fieldname and provide the one line name in brackets. "
5471 "Remember that beside setting multivalue options explicitly, there is also "
5472 "the option to modify them based on the default, but we aren't listing those "
5473 "names explicitly here. Unsupported options are silently ignored by all APT "
5477 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5478 #: sources.list.5.xml:1
5480 "<option>Architectures</option> (<option>arch</option>) is a multivalue "
5481 "option defining for which architectures information should be downloaded. If "
5482 "this option isn't set the default is all architectures as defined by the "
5483 "<option>APT::Architectures</option> config option."
5486 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5487 #: sources.list.5.xml:1
5489 "<option>Languages</option> (<option>lang</option>) is a multivalue option "
5490 "defining for which languages information like translated package "
5491 "descriptions should be downloaded. If this option isn't set the default is "
5492 "all languages as defined by the <option>Acquire::Languages</option> config "
5496 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5497 #: sources.list.5.xml:1
5499 "<option>Targets</option> (<option>target</option>) is a multivalue option "
5500 "defining which download targets apt will try to acquire from this source. If "
5501 "not specified, the default set is defined by the "
5502 "<option>Acquire::IndexTargets</option> configuration scope. Aditionally, "
5503 "specific targets can be enabled or disabled by using the identifier as field "
5504 "name instead of using this multivalue option."
5507 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5508 #: sources.list.5.xml:1
5510 "<option>PDiffs</option> (<option>pdiffs</option>) is a yes/no value which "
5511 "controls if APT should try to use PDiffs to update old indexes instead of "
5512 "downloading the new indexes entirely. The value of this option is ignored if "
5513 "the repository doesn't announce the availability of PDiffs. Defaults to the "
5514 "value of the option with the same name for a specific index file defined in "
5515 "the <option>Acquire::IndexTargets</option> scope, which itself default to "
5516 "the value of configuration option <option>Acquire::PDiffs</option> which "
5517 "defaults to <literal>yes</literal>."
5520 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5521 #: sources.list.5.xml:1
5523 "<option>By-Hash</option> (<option>by-hash</option>) can have the value "
5524 "\"yes\", \"no\" or \"force\" and controls if APT should try to acquire "
5525 "indexes via an URI constructed from a hashsum of the expected file instead "
5526 "of using the well-known stable filename of the index. Using this can avoid "
5527 "hashsum mismatches, but requires a supporting mirror. The value "
5528 "\"yes\"/\"no\" activates/disables the use of this feature if this source "
5529 "indicates support for it, while \"force\" will enable the feature regardless "
5530 "of what the source indicates. Defaults to the value of the option of the "
5531 "same name for a specific index file defined in the "
5532 "<option>Acquire::IndexTargets</option> scope, which itself defaults to the "
5533 "value of configuration option <option>Acquire::By-Hash</option> which "
5534 "defaults to <literal>yes</literal>."
5537 #. type: Content of: <refentry><refsect1><para>
5538 #: sources.list.5.xml:1
5540 "Further more, there are options which if set effect <emphasis>all</emphasis> "
5541 "sources with the same URI and Suite, so they have to be set on all such "
5542 "entries and can not be varied between different components. APT will try to "
5543 "detect and error out on such anomalies."
5546 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5547 #: sources.list.5.xml:1
5549 "<option>Trusted</option> (<option>trusted</option>) is a tri-state value "
5550 "which defaults to APT deciding if a source is considered trusted or if "
5551 "warnings should be raised before e.g. packages are installed from this "
5552 "source. This option can be used to override this decision either with the "
5553 "value <literal>yes</literal>, which lets APT consider this source always as "
5554 "a trusted source even if it has no or fails authentication checks by "
5555 "disabling parts of &apt-secure; and should therefore only be used in a local "
5556 "and trusted context (if at all) as otherwise security is breached. The "
5557 "opposite can be achieved with the value no, which causes the source to be "
5558 "handled as untrusted even if the authentication checks passed successfully. "
5559 "The default value can't be set explicitly."
5562 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5563 #: sources.list.5.xml:1
5565 "<option>Signed-By</option> (<option>signed-by</option>) is either an "
5566 "absolute path to a keyring file (has to be accessible and readable for the "
5567 "<literal>_apt</literal> user, so ensure everyone has read-permissions on the "
5568 "file) or a fingerprint of a key in either the "
5569 "<filename>trusted.gpg</filename> keyring or in one of the keyrings in the "
5570 "<filename>trusted.gpg.d/</filename> directory (see <command>apt-key "
5571 "fingerprint</command>). If the option is set only the key(s) in this keyring "
5572 "or only the key with this fingerprint is used for the &apt-secure; "
5573 "verification of this repository. Otherwise all keys in the trusted keyrings "
5574 "are considered valid signers for this repository."
5577 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5578 #: sources.list.5.xml:1
5580 "<option>Check-Valid-Until</option> (<option>check-valid-until</option>) is "
5581 "a yes/no value which controls if APT should try to detect replay attacks. A "
5582 "repository creator can declare until then the data provided in the "
5583 "repository should be considered valid and if this time is reached, but no "
5584 "new data is provided the data is considered expired and an error is raised. "
5585 "Beside increasing security as a malicious attacker can't sent old data "
5586 "forever denying a user to be able to upgrade to a new version, this also "
5587 "helps users identify mirrors which are no longer updated. Some repositories "
5588 "like historic archives aren't updated anymore by design through, so this "
5589 "check can be disabled by setting this option to <literal>no</literal>. "
5590 "Defaults to the value of configuration option "
5591 "<option>Acquire::Check-Valid-Until</option> which itself defaults to "
5592 "<literal>yes</literal>."
5595 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5596 #: sources.list.5.xml:1
5598 "<option>Valid-Until-Min</option> (<option>valid-until-min</option>) and "
5599 "<option>Valid-Until-Max</option> (<option>valid-until-max</option>) can be "
5600 "used to raise or lower the time period in seconds in which the data from "
5601 "this repository is considered valid. -Max can be especially useful if the "
5602 "repository provides no Valid-Until field on its Release file to set your own "
5603 "value, while -Min can be used to increase the valid time on seldom updated "
5604 "(local) mirrors of a more frequently updated but less accessible archive "
5605 "(which is in the sources.list as well) instead of disabling the check "
5606 "entirely. Default to the value of the configuration options "
5607 "<option>Acquire::Min-ValidTime</option> and "
5608 "<option>Acquire::Max-ValidTime</option> which are both unset by default."
5611 #. type: Content of: <refentry><refsect1><title>
5612 #: sources.list.5.xml:1
5613 msgid "URI specification"
5616 #. type: Content of: <refentry><refsect1><para>
5617 #: sources.list.5.xml:1
5618 msgid "The currently recognized URI types are:"
5621 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5622 #: sources.list.5.xml:1
5624 "The file scheme allows an arbitrary directory in the file system to be "
5625 "considered an archive. This is useful for NFS mounts and local mirrors or "
5629 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5630 #: sources.list.5.xml:1
5632 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5633 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5637 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5638 #: sources.list.5.xml:1
5640 "The http scheme specifies an HTTP server for the archive. If an environment "
5641 "variable <envar>http_proxy</envar> is set with the format "
5642 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5643 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5644 "the format http://user:pass@server:port/. Note that this is an insecure "
5645 "method of authentication."
5648 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5649 #: sources.list.5.xml:1
5651 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5652 "is highly configurable; for more information see the &apt-conf; manual "
5653 "page. Please note that an FTP proxy can be specified by using the "
5654 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5655 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5656 "environment variable and <emphasis>only</emphasis> this environment "
5657 "variable. Proxies using HTTP specified in the configuration file will be "
5661 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5662 #: sources.list.5.xml:1
5664 "The copy scheme is identical to the file scheme except that packages are "
5665 "copied into the cache directory instead of used directly at their location. "
5666 "This is useful for people using removable media to copy files around with "
5670 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5671 #: sources.list.5.xml:1
5673 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5674 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5675 "recommended. The standard <command>find</command> and <command>dd</command> "
5676 "commands are used to perform the file transfers from the remote host."
5679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5680 #: sources.list.5.xml:1
5681 msgid "adding more recognizable URI types"
5684 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5685 #: sources.list.5.xml:1
5687 "APT can be extended with more methods shipped in other optional packages, "
5688 "which should follow the naming scheme "
5689 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5690 "instance, the APT team also maintains the package "
5691 "<package>apt-transport-https</package>, which provides access methods for "
5692 "HTTPS URIs with features similar to the http method. Methods for using "
5693 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5696 #. type: Content of: <refentry><refsect1><para>
5697 #: sources.list.5.xml:1
5699 "Uses the archive stored locally (or NFS mounted) at /home/apt/debian for "
5700 "stable/main, stable/contrib, and stable/non-free."
5703 #. type: Content of: <refentry><refsect1><literallayout>
5704 #: sources.list.5.xml:1
5706 msgid "deb file:/home/apt/debian stable main contrib non-free"
5709 #. type: Content of: <refentry><refsect1><literallayout>
5710 #: sources.list.5.xml:1
5714 "URIs: file:/home/apt/debian\n"
5716 "Components: main contrib non-free"
5719 #. type: Content of: <refentry><refsect1><para>
5720 #: sources.list.5.xml:1
5721 msgid "As above, except this uses the unstable (development) distribution."
5724 #. type: Content of: <refentry><refsect1><literallayout>
5725 #: sources.list.5.xml:1
5727 msgid "deb file:/home/apt/debian unstable main contrib non-free"
5730 #. type: Content of: <refentry><refsect1><literallayout>
5731 #: sources.list.5.xml:1
5735 "URIs: file:/home/apt/debian\n"
5736 "Suites: unstable\n"
5737 "Components: main contrib non-free"
5740 #. type: Content of: <refentry><refsect1><para>
5741 #: sources.list.5.xml:1
5742 msgid "Source line for the above"
5745 #. type: Content of: <refentry><refsect1><literallayout>
5746 #: sources.list.5.xml:1
5748 msgid "deb-src file:/home/apt/debian unstable main contrib non-free"
5751 #. type: Content of: <refentry><refsect1><literallayout>
5752 #: sources.list.5.xml:1
5756 "URIs: file:/home/apt/debian\n"
5757 "Suites: unstable\n"
5758 "Components: main contrib non-free"
5761 #. type: Content of: <refentry><refsect1><para>
5762 #: sources.list.5.xml:1
5764 "The first line gets package information for the architectures in "
5765 "<literal>APT::Architectures</literal> while the second always retrieves "
5766 "<literal>amd64</literal> and <literal>armel</literal>."
5769 #. type: Content of: <refentry><refsect1><literallayout>
5770 #: sources.list.5.xml:1
5773 "deb http://httpredir.debian.org/debian &stable-codename; main\n"
5774 "deb [ arch=amd64,armel ] http://httpredir.debian.org/debian "
5775 "&stable-codename; main"
5778 #. type: Content of: <refentry><refsect1><literallayout>
5779 #: sources.list.5.xml:1
5783 "URIs: http://httpredir.debian.org/debian\n"
5784 "Suites: &stable-codename;\n"
5785 "Components: main\n"
5788 "URIs: http://httpredir.debian.org/debian\n"
5789 "Suites: &stable-codename;\n"
5790 "Components: main\n"
5791 "Architectures: amd64 armel\n"
5794 #. type: Content of: <refentry><refsect1><para>
5795 #: sources.list.5.xml:1
5797 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5801 #. type: Content of: <refentry><refsect1><literallayout>
5802 #: sources.list.5.xml:1
5804 msgid "deb http://archive.debian.org/debian-archive hamm main"
5807 #. type: Content of: <refentry><refsect1><literallayout>
5808 #: sources.list.5.xml:1
5812 "URIs: http://archive.debian.org/debian-archive\n"
5817 #. type: Content of: <refentry><refsect1><para>
5818 #: sources.list.5.xml:1
5820 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5821 "directory, and uses only the &stable-codename;/contrib area."
5824 #. type: Content of: <refentry><refsect1><literallayout>
5825 #: sources.list.5.xml:1
5827 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5830 #. type: Content of: <refentry><refsect1><literallayout>
5831 #: sources.list.5.xml:1
5835 "URIs: ftp://ftp.debian.org/debian\n"
5836 "Suites: &stable-codename;\n"
5837 "Components: contrib"
5840 #. type: Content of: <refentry><refsect1><para>
5841 #: sources.list.5.xml:1
5843 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5844 "directory, and uses only the unstable/contrib area. If this line appears as "
5845 "well as the one in the previous example in <filename>sources.list</filename> "
5846 "a single FTP session will be used for both resource lines."
5849 #. type: Content of: <refentry><refsect1><literallayout>
5850 #: sources.list.5.xml:1
5852 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5855 #. type: Content of: <refentry><refsect1><literallayout>
5856 #: sources.list.5.xml:1
5860 "URIs: ftp://ftp.debian.org/debian\n"
5861 "Suites: unstable\n"
5862 "Components: contrib"
5865 #. type: Content of: <refentry><refsect1><para><literallayout>
5866 #: sources.list.5.xml:1
5868 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5871 #. type: Content of: <refentry><refsect1><para><literallayout>
5872 #: sources.list.5.xml:1
5876 "URIs: http://ftp.tlh.debian.org/universe\n"
5877 "Suites: unstable/binary-$(ARCH)/"
5880 #. type: Content of: <refentry><refsect1><para>
5881 #: sources.list.5.xml:1
5883 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5884 "directory, and uses only files found under "
5885 "<filename>unstable/binary-i386</filename> on i386 machines, "
5886 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5887 "supported architectures. [Note this example only illustrates how to use the "
5888 "substitution variable; official debian archives are not structured like "
5889 "this] <placeholder type=\"literallayout\" id=\"0\"/> <placeholder "
5890 "type=\"literallayout\" id=\"1\"/>"
5893 #. type: Content of: <refentry><refsect1><para>
5894 #: sources.list.5.xml:1
5896 "Uses HTTP to get binary packages as well as sources from the stable, testing "
5897 "and unstable suites and the components main and contrib."
5900 #. type: Content of: <refentry><refsect1><literallayout>
5901 #: sources.list.5.xml:1
5904 "deb http://httpredir.debian.org/debian stable main contrib\n"
5905 "deb-src http://httpredir.debian.org/debian stable main contrib\n"
5906 "deb http://httpredir.debian.org/debian testing main contrib\n"
5907 "deb-src http://httpredir.debian.org/debian testing main contrib\n"
5908 "deb http://httpredir.debian.org/debian unstable main contrib\n"
5909 "deb-src http://httpredir.debian.org/debian unstable main contrib"
5912 #. type: Content of: <refentry><refsect1><literallayout>
5913 #: sources.list.5.xml:1
5916 "Types: deb deb-src\n"
5917 "URIs: http://httpredir.debian.org/debian\n"
5918 "Suites: stable testing unstable\n"
5919 "Components: main contrib\n"
5922 #. type: Content of: <refentry><refsect1><para>
5923 #: sources.list.5.xml:1
5924 msgid "&apt-get;, &apt-conf;"
5927 #. type: Content of: <refentry><refmeta><manvolnum>
5928 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
5932 #. type: Content of: <refentry><refnamediv><refpurpose>
5933 #: apt-extracttemplates.1.xml:1
5935 "Utility to extract <command>debconf</command> config and templates from "
5939 #. type: Content of: <refentry><refsect1><para>
5940 #: apt-extracttemplates.1.xml:1
5942 "<command>apt-extracttemplates</command> will take one or more Debian package "
5943 "files as input and write out (to a temporary directory) all associated "
5944 "config scripts and template files. For each passed in package that contains "
5945 "config scripts and templates, one line of output will be generated in the "
5949 #. type: Content of: <refentry><refsect1><para>
5950 #: apt-extracttemplates.1.xml:1
5951 msgid "package version template-file config-script"
5954 #. type: Content of: <refentry><refsect1><para>
5955 #: apt-extracttemplates.1.xml:1
5957 "template-file and config-script are written to the temporary directory "
5958 "specified by the <option>-t</option> or <option>--tempdir</option> "
5959 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5960 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5961 "<filename>package.config.XXXXXX</filename>"
5964 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5965 #: apt-extracttemplates.1.xml:1
5967 "Temporary directory in which to write extracted <command>debconf</command> "
5968 "template files and config scripts. Configuration Item: "
5969 "<literal>APT::ExtractTemplates::TempDir</literal>"
5972 #. type: Content of: <refentry><refsect1><para>
5973 #: apt-extracttemplates.1.xml:1
5975 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5976 "decimal 100 on error."
5979 #. type: Content of: <refentry><refnamediv><refpurpose>
5980 #: apt-sortpkgs.1.xml:1
5981 msgid "Utility to sort package index files"
5984 #. type: Content of: <refentry><refsect1><para>
5985 #: apt-sortpkgs.1.xml:1
5987 "<command>apt-sortpkgs</command> will take an index file (source index or "
5988 "package index) and sort the records so that they are ordered by the package "
5989 "name. It will also sort the internal fields of each record according to the "
5990 "internal sorting rules."
5993 #. type: Content of: <refentry><refsect1><para>
5994 #: apt-sortpkgs.1.xml:1
5995 msgid "All output is sent to standard output; the input must be a seekable file."
5998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5999 #: apt-sortpkgs.1.xml:1
6001 "Use source index field ordering. Configuration Item: "
6002 "<literal>APT::SortPkgs::Source</literal>."
6005 #. type: Content of: <refentry><refsect1><para>
6006 #: apt-sortpkgs.1.xml:1
6008 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
6012 #. type: Content of: <refentry><refnamediv><refpurpose>
6013 #: apt-ftparchive.1.xml:1
6014 msgid "Utility to generate index files"
6017 #. type: Content of: <refentry><refsect1><para>
6018 #: apt-ftparchive.1.xml:1
6020 "<command>apt-ftparchive</command> is the command line tool that generates "
6021 "the index files that APT uses to access a distribution source. The index "
6022 "files should be generated on the origin site based on the content of that "
6026 #. type: Content of: <refentry><refsect1><para>
6027 #: apt-ftparchive.1.xml:1
6029 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
6030 "program, incorporating its entire functionality via the "
6031 "<literal>packages</literal> command. It also contains a contents file "
6032 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
6033 "the generation process for a complete archive."
6036 #. type: Content of: <refentry><refsect1><para>
6037 #: apt-ftparchive.1.xml:1
6039 "Internally <command>apt-ftparchive</command> can make use of binary "
6040 "databases to cache the contents of a .deb file and it does not rely on any "
6041 "external programs aside from &gzip;. When doing a full generate it "
6042 "automatically performs file-change checks and builds the desired compressed "
6046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6047 #: apt-ftparchive.1.xml:1
6049 "The packages command generates a package file from a directory tree. It "
6050 "takes the given directory and recursively searches it for .deb files, "
6051 "emitting a package record to stdout for each. This command is approximately "
6052 "equivalent to &dpkg-scanpackages;."
6055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6056 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6057 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
6060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6061 #: apt-ftparchive.1.xml:1
6063 "The <literal>sources</literal> command generates a source index file from a "
6064 "directory tree. It takes the given directory and recursively searches it "
6065 "for .dsc files, emitting a source record to stdout for each. This command is "
6066 "approximately equivalent to &dpkg-scansources;."
6069 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6070 #: apt-ftparchive.1.xml:1
6072 "If an override file is specified then a source override file will be looked "
6073 "for with an extension of .src. The --source-override option can be used to "
6074 "change the source override file that will be used."
6077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6078 #: apt-ftparchive.1.xml:1
6080 "The <literal>contents</literal> command generates a contents file from a "
6081 "directory tree. It takes the given directory and recursively searches it for "
6082 ".deb files, and reads the file list from each file. It then sorts and writes "
6083 "to stdout the list of files matched to packages. Directories are not written "
6084 "to the output. If multiple packages own the same file then each package is "
6085 "separated by a comma in the output."
6088 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6089 #: apt-ftparchive.1.xml:1
6091 "The <literal>release</literal> command generates a Release file from a "
6092 "directory tree. It recursively searches the given directory for uncompressed "
6093 "<filename>Packages</filename> and <filename>Sources</filename> files and "
6094 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
6095 "<command>lzma</command> as well as <filename>Release</filename> and "
6096 "<filename>md5sum.txt</filename> files by default "
6097 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
6098 "filename patterns can be added by listing them in "
6099 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
6100 "stdout a <filename>Release</filename> file containing (by default) an MD5, "
6101 "SHA1, SHA256 and SHA512 digest for each file."
6104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6105 #: apt-ftparchive.1.xml:1
6107 "Values for the additional metadata fields in the Release file are taken from "
6108 "the corresponding variables under "
6109 "<literal>APT::FTPArchive::Release</literal>, "
6110 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
6111 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
6112 "<literal>Suite</literal>, <literal>Version</literal>, "
6113 "<literal>Codename</literal>, <literal>Date</literal>, "
6114 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
6115 "<literal>Components</literal>, <literal>Description</literal>."
6118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6119 #: apt-ftparchive.1.xml:1
6121 "The <literal>generate</literal> command is designed to be runnable from a "
6122 "cron script and builds indexes according to the given config file. The "
6123 "config language provides a flexible means of specifying which index files "
6124 "are built from which directories, as well as providing a simple means of "
6125 "maintaining the required settings."
6128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6129 #: apt-ftparchive.1.xml:1
6131 "The <literal>clean</literal> command tidies the databases used by the given "
6132 "configuration file by removing any records that are no longer necessary."
6135 #. type: Content of: <refentry><refsect1><title>
6136 #: apt-ftparchive.1.xml:1
6137 msgid "The Generate Configuration"
6140 #. type: Content of: <refentry><refsect1><para>
6141 #: apt-ftparchive.1.xml:1
6143 "The <literal>generate</literal> command uses a configuration file to "
6144 "describe the archives that are going to be generated. It follows the typical "
6145 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
6146 "&apt-conf; contains a description of the syntax. Note that the generate "
6147 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
6148 "tree manner. This only effects how the scope tag is handled."
6151 #. type: Content of: <refentry><refsect1><para>
6152 #: apt-ftparchive.1.xml:1
6153 msgid "The generate configuration has four separate sections, each described below."
6156 #. type: Content of: <refentry><refsect1><refsect2><title>
6157 #: apt-ftparchive.1.xml:1
6158 msgid "<literal>Dir</literal> Section"
6161 #. type: Content of: <refentry><refsect1><refsect2><para>
6162 #: apt-ftparchive.1.xml:1
6164 "The <literal>Dir</literal> section defines the standard directories needed "
6165 "to locate the files required during the generation process. These "
6166 "directories are prepended certain relative paths defined in later sections "
6167 "to produce a complete an absolute path."
6170 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6171 #: apt-ftparchive.1.xml:1
6173 "Specifies the root of the FTP archive, in a standard Debian configuration "
6174 "this is the directory that contains the <filename>ls-LR</filename> and dist "
6178 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6179 #: apt-ftparchive.1.xml:1
6180 msgid "Specifies the location of the override files."
6183 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6184 #: apt-ftparchive.1.xml:1
6185 msgid "Specifies the location of the cache files."
6188 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6189 #: apt-ftparchive.1.xml:1
6191 "Specifies the location of the file list files, if the "
6192 "<literal>FileList</literal> setting is used below."
6195 #. type: Content of: <refentry><refsect1><refsect2><title>
6196 #: apt-ftparchive.1.xml:1
6197 msgid "<literal>Default</literal> Section"
6200 #. type: Content of: <refentry><refsect1><refsect2><para>
6201 #: apt-ftparchive.1.xml:1
6203 "The <literal>Default</literal> section specifies default values, and "
6204 "settings that control the operation of the generator. Other sections may "
6205 "override these defaults with a per-section setting."
6208 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6209 #: apt-ftparchive.1.xml:1
6211 "Sets the default compression schemes to use for the package index files. It "
6212 "is a string that contains a space separated list of at least one of: '.' (no "
6213 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
6217 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6218 #: apt-ftparchive.1.xml:1
6220 "Sets the default list of file extensions that are package files. This "
6221 "defaults to '.deb'."
6224 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6225 #: apt-ftparchive.1.xml:1
6227 "This is similar to <literal>Packages::Compress</literal> except that it "
6228 "controls the compression for the Sources files."
6231 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6232 #: apt-ftparchive.1.xml:1
6234 "Sets the default list of file extensions that are source files. This "
6235 "defaults to '.dsc'."
6238 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6239 #: apt-ftparchive.1.xml:1
6241 "This is similar to <literal>Packages::Compress</literal> except that it "
6242 "controls the compression for the Contents files."
6245 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6246 #: apt-ftparchive.1.xml:1
6248 "This is similar to <literal>Packages::Compress</literal> except that it "
6249 "controls the compression for the Translation-en master file."
6252 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6253 #: apt-ftparchive.1.xml:1
6255 "Specifies the number of kilobytes to delink (and replace with hard links) "
6256 "per run. This is used in conjunction with the per-section "
6257 "<literal>External-Links</literal> setting."
6260 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6261 #: apt-ftparchive.1.xml:1
6263 "Specifies the mode of all created index files. It defaults to 0644. All "
6264 "index files are set to this mode with no regard to the umask."
6267 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6268 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6270 "Specifies whether long descriptions should be included in the "
6271 "<filename>Packages</filename> file or split out into a master "
6272 "<filename>Translation-en</filename> file."
6275 #. type: Content of: <refentry><refsect1><refsect2><title>
6276 #: apt-ftparchive.1.xml:1
6277 msgid "<literal>TreeDefault</literal> Section"
6280 #. type: Content of: <refentry><refsect1><refsect2><para>
6281 #: apt-ftparchive.1.xml:1
6283 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
6284 "variables are substitution variables and have the strings $(DIST), "
6285 "$(SECTION) and $(ARCH) replaced with their respective values."
6288 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6289 #: apt-ftparchive.1.xml:1
6291 "Sets the number of kilobytes of contents files that are generated each "
6292 "day. The contents files are round-robined so that over several days they "
6293 "will all be rebuilt."
6296 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6297 #: apt-ftparchive.1.xml:1
6299 "Controls the number of days a contents file is allowed to be checked without "
6300 "changing. If this limit is passed the mtime of the contents file is "
6301 "updated. This case can occur if the package file is changed in such a way "
6302 "that does not result in a new contents file [override edit for instance]. A "
6303 "hold off is allowed in hopes that new .debs will be installed, requiring a "
6304 "new file anyhow. The default is 10, the units are in days."
6307 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6308 #: apt-ftparchive.1.xml:1
6310 "Sets the top of the .deb directory tree. Defaults to "
6311 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
6314 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6315 #: apt-ftparchive.1.xml:1
6317 "Sets the top of the source package directory tree. Defaults to "
6318 "<filename>$(DIST)/$(SECTION)/source/</filename>"
6321 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6322 #: apt-ftparchive.1.xml:1
6324 "Sets the output Packages file. Defaults to "
6325 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
6328 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6329 #: apt-ftparchive.1.xml:1
6331 "Sets the output Sources file. Defaults to "
6332 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
6335 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6336 #: apt-ftparchive.1.xml:1
6338 "Sets the output Translation-en master file with the long descriptions if "
6339 "they should be not included in the Packages file. Defaults to "
6340 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
6343 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6344 #: apt-ftparchive.1.xml:1
6346 "Sets the path prefix that causes a symlink to be considered an internal link "
6347 "instead of an external link. Defaults to "
6348 "<filename>$(DIST)/$(SECTION)/</filename>"
6351 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6352 #: apt-ftparchive.1.xml:1
6354 "Sets the output Contents file. Defaults to "
6355 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
6356 "causes multiple Packages files to map onto a single Contents file (as is the "
6357 "default) then <command>apt-ftparchive</command> will integrate those "
6358 "package files together automatically."
6361 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6362 #: apt-ftparchive.1.xml:1
6363 msgid "Sets header file to prepend to the contents output."
6366 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6367 #: apt-ftparchive.1.xml:1
6369 "Sets the binary cache database to use for this section. Multiple sections "
6370 "can share the same database."
6373 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6374 #: apt-ftparchive.1.xml:1
6376 "Specifies that instead of walking the directory tree, "
6377 "<command>apt-ftparchive</command> should read the list of files from the "
6378 "given file. Relative files names are prefixed with the archive directory."
6381 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6382 #: apt-ftparchive.1.xml:1
6384 "Specifies that instead of walking the directory tree, "
6385 "<command>apt-ftparchive</command> should read the list of files from the "
6386 "given file. Relative files names are prefixed with the archive directory. "
6387 "This is used when processing source indexes."
6390 #. type: Content of: <refentry><refsect1><refsect2><title>
6391 #: apt-ftparchive.1.xml:1
6392 msgid "<literal>Tree</literal> Section"
6395 #. type: Content of: <refentry><refsect1><refsect2><para>
6396 #: apt-ftparchive.1.xml:1
6398 "The <literal>Tree</literal> section defines a standard Debian file tree "
6399 "which consists of a base directory, then multiple sections in that base "
6400 "directory and finally multiple Architectures in each section. The exact "
6401 "pathing used is defined by the <literal>Directory</literal> substitution "
6405 #. type: Content of: <refentry><refsect1><refsect2><para>
6406 #: apt-ftparchive.1.xml:1
6408 "The <literal>Tree</literal> section takes a scope tag which sets the "
6409 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
6410 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
6411 "setting such as <filename>dists/&stable-codename;</filename>."
6414 #. type: Content of: <refentry><refsect1><refsect2><para>
6415 #: apt-ftparchive.1.xml:1
6417 "All of the settings defined in the <literal>TreeDefault</literal> section "
6418 "can be used in a <literal>Tree</literal> section as well as three new "
6422 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6423 #: apt-ftparchive.1.xml:1
6426 "for i in Sections do \n"
6427 " for j in Architectures do\n"
6428 " Generate for DIST=scope SECTION=i ARCH=j\n"
6432 #. type: Content of: <refentry><refsect1><refsect2><para>
6433 #: apt-ftparchive.1.xml:1
6435 "When processing a <literal>Tree</literal> section "
6436 "<command>apt-ftparchive</command> performs an operation similar to: "
6437 "<placeholder type=\"programlisting\" id=\"0\"/>"
6440 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6441 #: apt-ftparchive.1.xml:1
6443 "This is a space separated list of sections which appear under the "
6444 "distribution; typically this is something like <literal>main contrib "
6445 "non-free</literal>"
6448 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6449 #: apt-ftparchive.1.xml:1
6451 "This is a space separated list of all the architectures that appear under "
6452 "search section. The special architecture 'source' is used to indicate that "
6453 "this tree has a source archive."
6456 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6457 #: apt-ftparchive.1.xml:1
6459 "Sets the binary override file. The override file contains section, priority "
6460 "and maintainer address information."
6463 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6464 #: apt-ftparchive.1.xml:1
6466 "Sets the source override file. The override file contains section "
6470 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6471 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6472 msgid "Sets the binary extra override file."
6475 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6476 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6477 msgid "Sets the source extra override file."
6480 #. type: Content of: <refentry><refsect1><refsect2><title>
6481 #: apt-ftparchive.1.xml:1
6482 msgid "<literal>BinDirectory</literal> Section"
6485 #. type: Content of: <refentry><refsect1><refsect2><para>
6486 #: apt-ftparchive.1.xml:1
6488 "The <literal>bindirectory</literal> section defines a binary directory tree "
6489 "with no special structure. The scope tag specifies the location of the "
6490 "binary directory and the settings are similar to the <literal>Tree</literal> "
6491 "section with no substitution variables or "
6492 "<literal>Section</literal><literal>Architecture</literal> settings."
6495 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6496 #: apt-ftparchive.1.xml:1
6497 msgid "Sets the Packages file output."
6500 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6501 #: apt-ftparchive.1.xml:1
6503 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
6504 "<literal>Sources</literal> is required."
6507 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6508 #: apt-ftparchive.1.xml:1
6509 msgid "Sets the Contents file output (optional)."
6512 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6513 #: apt-ftparchive.1.xml:1
6514 msgid "Sets the binary override file."
6517 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6518 #: apt-ftparchive.1.xml:1
6519 msgid "Sets the source override file."
6522 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6523 #: apt-ftparchive.1.xml:1
6524 msgid "Sets the cache DB."
6527 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6528 #: apt-ftparchive.1.xml:1
6529 msgid "Appends a path to all the output paths."
6532 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6533 #: apt-ftparchive.1.xml:1
6534 msgid "Specifies the file list file."
6537 #. type: Content of: <refentry><refsect1><title>
6538 #: apt-ftparchive.1.xml:1
6539 msgid "The Binary Override File"
6542 #. type: Content of: <refentry><refsect1><para>
6543 #: apt-ftparchive.1.xml:1
6545 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
6546 "contains four fields separated by spaces. The first field is the package "
6547 "name, the second is the priority to force that package to, the third is the "
6548 "section to force that package to and the final field is the maintainer "
6549 "permutation field."
6552 #. type: Content of: <refentry><refsect1><para><literallayout>
6553 #: apt-ftparchive.1.xml:1
6555 msgid "old [// oldn]* => new"
6558 #. type: Content of: <refentry><refsect1><para><literallayout>
6559 #: apt-ftparchive.1.xml:1
6564 #. type: Content of: <refentry><refsect1><para>
6565 #: apt-ftparchive.1.xml:1
6567 "The general form of the maintainer field is: <placeholder "
6568 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
6569 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
6570 "separated list of old email addresses to be specified. If any of those are "
6571 "found then new is substituted for the maintainer field. The second form "
6572 "unconditionally substitutes the maintainer field."
6575 #. type: Content of: <refentry><refsect1><title>
6576 #: apt-ftparchive.1.xml:1
6577 msgid "The Source Override File"
6580 #. type: Content of: <refentry><refsect1><para>
6581 #: apt-ftparchive.1.xml:1
6583 "The source override file is fully compatible with &dpkg-scansources;. It "
6584 "contains two fields separated by spaces. The first field is the source "
6585 "package name, the second is the section to assign it."
6588 #. type: Content of: <refentry><refsect1><title>
6589 #: apt-ftparchive.1.xml:1
6590 msgid "The Extra Override File"
6593 #. type: Content of: <refentry><refsect1><para>
6594 #: apt-ftparchive.1.xml:1
6596 "The extra override file allows any arbitrary tag to be added or replaced in "
6597 "the output. It has three columns, the first is the package, the second is "
6598 "the tag and the remainder of the line is the new value."
6601 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6602 #: apt-ftparchive.1.xml:1
6604 "Generate the given checksum. These options default to on, when turned off "
6605 "the generated index files will not have the checksum fields where possible. "
6606 "Configuration Items: "
6607 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
6608 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
6609 "where <literal><replaceable>Index</replaceable></literal> can be "
6610 "<literal>Packages</literal>, <literal>Sources</literal> or "
6611 "<literal>Release</literal> and "
6612 "<literal><replaceable>Checksum</replaceable></literal> can be "
6613 "<literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA256</literal> "
6614 "or <literal>SHA512</literal>."
6617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6618 #: apt-ftparchive.1.xml:1
6620 "Use a binary caching DB. This has no effect on the generate command. "
6621 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
6624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6625 #: apt-ftparchive.1.xml:1
6627 "Quiet; produces output suitable for logging, omitting progress indicators. "
6628 "More q's will produce more quiet up to a maximum of 2. You can also use "
6629 "<option>-q=#</option> to set the quiet level, overriding the configuration "
6630 "file. Configuration Item: <literal>quiet</literal>."
6633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6634 #: apt-ftparchive.1.xml:1
6636 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
6637 "then this option actually enables delinking of the files. It defaults to on "
6638 "and can be turned off with <option>--no-delink</option>. Configuration "
6639 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
6642 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6643 #: apt-ftparchive.1.xml:1
6645 "Perform contents generation. When this option is set and package indexes are "
6646 "being generated with a cache DB then the file listing will also be extracted "
6647 "and stored in the DB for later use. When using the generate command this "
6648 "option also allows the creation of any Contents files. The default is on. "
6649 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
6652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6653 #: apt-ftparchive.1.xml:1
6655 "Select the source override file to use with the <literal>sources</literal> "
6656 "command. Configuration Item: "
6657 "<literal>APT::FTPArchive::SourceOverride</literal>."
6660 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6661 #: apt-ftparchive.1.xml:1
6663 "Make the caching databases read only. Configuration Item: "
6664 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
6667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6668 #: apt-ftparchive.1.xml:1
6670 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
6671 "commands only package files matching <literal>*_arch.deb</literal> or "
6672 "<literal>*_all.deb</literal> instead of all package files in the given "
6673 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
6676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6677 #: apt-ftparchive.1.xml:1
6679 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
6680 "packages are recompiled and/or republished with the same version again, this "
6681 "will lead to problems as the now outdated cached metadata like size and "
6682 "checksums will be used. With this option enabled this will no longer happen "
6683 "as it will be checked if the file was changed. Note that this option is set "
6684 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
6685 "multiply versions/builds of a package with the same versionnumber, so in "
6686 "theory nobody will have these problems and therefore all these extra checks "
6690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6691 #: apt-ftparchive.1.xml:1
6693 "This configuration option defaults to \"<literal>true</literal>\" and should "
6694 "only be set to <literal>\"false\"</literal> if the Archive generated with "
6695 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
6696 "that the <filename>Translation-en</filename> master file can only be created "
6697 "in the generate command."
6700 #. type: Content of: <refentry><refsect1><para><programlisting>
6701 #: apt-ftparchive.1.xml:1
6704 "<command>apt-ftparchive</command> packages "
6705 "<replaceable>directory</replaceable> | <command>gzip</command> > "
6706 "<filename>Packages.gz</filename>\n"
6709 #. type: Content of: <refentry><refsect1><para>
6710 #: apt-ftparchive.1.xml:1
6712 "To create a compressed Packages file for a directory containing binary "
6713 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6716 #. type: Content of: <refentry><refsect1><para>
6717 #: apt-ftparchive.1.xml:1
6719 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6723 #. type: Attribute 'lang' of: <book>
6724 #: guide.dbk:1 offline.dbk:1
6728 #. type: Content of: <book><title>
6730 msgid "APT User's Guide"
6733 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6734 #: guide.dbk:1 offline.dbk:1
6735 msgid "Jason Gunthorpe"
6738 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6739 #: guide.dbk:1 offline.dbk:1
6740 msgid "jgg@debian.org"
6743 #. type: Content of: <book><bookinfo><releaseinfo>
6744 #: guide.dbk:1 offline.dbk:1
6745 msgid "Version &apt-product-version;"
6748 #. type: Content of: <book><bookinfo><abstract><para>
6751 "This document provides an overview of how to use the the APT package "
6755 #. type: Content of: <book><bookinfo>
6757 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6760 #. type: Content of: <book><bookinfo><legalnotice><title>
6761 #: guide.dbk:1 offline.dbk:1
6762 msgid "License Notice"
6765 #. type: Content of: <book><bookinfo><legalnotice><para>
6766 #: guide.dbk:1 offline.dbk:1
6768 "\"APT\" and this document are free software; you can redistribute them "
6769 "and/or modify them under the terms of the GNU General Public License as "
6770 "published by the Free Software Foundation; either version 2 of the License, "
6771 "or (at your option) any later version."
6774 #. type: Content of: <book><bookinfo><legalnotice><para>
6775 #: guide.dbk:1 offline.dbk:1
6777 "For more details, on Debian systems, see the file "
6778 "/usr/share/common-licenses/GPL for the full license."
6781 #. type: Content of: <book><chapter><title>
6786 #. type: Content of: <book><chapter><para>
6789 "The APT package currently contains two sections, the APT "
6790 "<command>dselect</command> method and the <command>apt-get</command> command "
6791 "line user interface. Both provide a way to install and remove packages as "
6792 "well as download new packages from the Internet."
6795 #. type: Content of: <book><chapter><section><title>
6797 msgid "Anatomy of the Package System"
6800 #. type: Content of: <book><chapter><section><para>
6803 "The Debian packaging system has a large amount of information associated "
6804 "with each package to help assure that it integrates cleanly and easily into "
6805 "the system. The most prominent of its features is the dependency system."
6808 #. type: Content of: <book><chapter><section><para>
6811 "The dependency system allows individual programs to make use of shared "
6812 "elements in the system such as libraries. It simplifies placing infrequently "
6813 "used portions of a program in separate packages to reduce the number of "
6814 "things the average user is required to install. Also, it allows for choices "
6815 "in mail transport agents, X servers and so on."
6818 #. type: Content of: <book><chapter><section><para>
6821 "The first step to understanding the dependency system is to grasp the "
6822 "concept of a simple dependency. The meaning of a simple dependency is that a "
6823 "package requires another package to be installed at the same time to work "
6827 #. type: Content of: <book><chapter><section><para>
6830 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6831 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6832 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6833 "simple dependency on emacs, without emacs it is completely useless."
6836 #. type: Content of: <book><chapter><section><para>
6839 "The other important dependency to understand is a conflicting dependency. It "
6840 "means that a package, when installed with another package, will not work and "
6841 "may possibly be extremely harmful to the system. As an example consider a "
6842 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6843 "have two mail transport agents installed because both need to listen to the "
6844 "network to receive mail. Attempting to install two will seriously damage the "
6845 "system so all mail transport agents have a conflicting dependency with all "
6846 "other mail transport agents."
6849 #. type: Content of: <book><chapter><section><para>
6852 "As an added complication there is the possibility for a package to pretend "
6853 "to be another package. Consider that exim and sendmail for many intents are "
6854 "identical, they both deliver mail and understand a common interface. Hence, "
6855 "the package system has a way for them to declare that they are both "
6856 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6857 "a mail-transport-agent and other packages that need a mail transport agent "
6858 "depend on mail-transport-agent. This can add a great deal of confusion when "
6859 "trying to manually fix packages."
6862 #. type: Content of: <book><chapter><section><para>
6865 "At any given time a single dependency may be met by packages that are "
6866 "already installed or it may not be. APT attempts to help resolve dependency "
6867 "issues by providing a number of automatic algorithms that help in selecting "
6868 "packages for installation."
6871 #. type: Content of: <book><chapter><title>
6876 #. type: Content of: <book><chapter><para>
6879 "<command>apt-get</command> provides a simple way to install packages from "
6880 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6881 "does not understand .deb files, it works with the package's proper name and "
6882 "can only install .deb archives from a <emphasis>Source</emphasis>."
6885 #. type: Content of: <book><chapter><para><footnote><para>
6888 "If you are using an http proxy server you must set the http_proxy "
6889 "environment variable first, see sources.list(5)"
6892 #. type: Content of: <book><chapter><para>
6895 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6896 "done before using <command>apt-get</command> is to fetch the package lists "
6897 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6898 "available. This is done with <literal>apt-get update</literal>. For "
6902 #. type: Content of: <book><chapter><screen>
6906 "# apt-get update\n"
6907 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6908 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6909 "Reading Package Lists... Done\n"
6910 "Building Dependency Tree... Done\n"
6913 #. type: Content of: <book><chapter><para>
6915 msgid "Once updated there are several commands that can be used:"
6918 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6923 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6926 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6927 "install a new package or remove an existing package, nor will it ever "
6928 "upgrade a package that might cause some other package to break. This can be "
6929 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6930 "the packages that it could not upgrade, this usually means that they depend "
6931 "on new packages or conflict with some other "
6932 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6933 "can be used to force these packages to install."
6936 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6941 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6944 "Install is used to install packages by name. The package is automatically "
6945 "fetched and installed. This can be useful if you already know the name of "
6946 "the package to install and do not want to go into a GUI to select it. Any "
6947 "number of packages may be passed to install, they will all be "
6948 "fetched. Install automatically attempts to resolve dependency problems with "
6949 "the listed packages and will print a summary and ask for confirmation if "
6950 "anything other than its arguments are changed."
6953 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6955 msgid "dist-upgrade"
6958 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6961 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6962 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6963 "set of packages to install, upgrade and remove to get as much of the system "
6964 "to the newest release. In some situations it may be desired to use "
6965 "dist-upgrade rather than spend the time manually resolving dependencies in "
6966 "<command>dselect</command>. Once dist-upgrade has completed then "
6967 "<command>dselect</command> can be used to install any packages that may have "
6971 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6974 "It is important to closely look at what dist-upgrade is going to do, its "
6975 "decisions may sometimes be quite surprising."
6978 #. type: Content of: <book><chapter><para>
6981 "<command>apt-get</command> has several command line options that are "
6982 "detailed in its man page, "
6983 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
6984 "The most useful option is <literal>-d</literal> which does not install the "
6985 "fetched files. If the system has to download a large number of package it "
6986 "would be undesired to start installing them in case something goes "
6987 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
6988 "installed by simply running the command that caused them to be downloaded "
6989 "again without <literal>-d</literal>."
6992 #. type: Content of: <book><chapter><title>
6997 #. type: Content of: <book><chapter><para>
7000 "The APT <command>dselect</command> method provides the complete APT system "
7001 "with the <command>dselect</command> package selection "
7002 "GUI. <command>dselect</command> is used to select the packages to be "
7003 "installed or removed and APT actually installs them."
7006 #. type: Content of: <book><chapter><para>
7009 "To enable the APT method you need to select [A]ccess in "
7010 "<command>dselect</command> and then choose the APT method. You will be "
7011 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
7012 "archives from. These can be remote Internet sites, local Debian mirrors or "
7013 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
7014 "will automatically combine them to form a complete set of packages. If you "
7015 "have a CD-ROM then it is a good idea to specify it first and then specify a "
7016 "mirror so that you have access to the latest bug fixes. APT will "
7017 "automatically use packages on your CD-ROM before downloading from the "
7021 #. type: Content of: <book><chapter><screen>
7025 " Set up a list of distribution source locations\n"
7027 " Please give the base URL of the debian distribution.\n"
7028 " The access schemes I know about are: http file\n"
7031 " file:/mnt/debian,\n"
7032 " ftp://ftp.debian.org/debian,\n"
7033 " http://ftp.de.debian.org/debian,\n"
7036 " URL [http://llug.sep.bnl.gov/debian]:\n"
7039 #. type: Content of: <book><chapter><para>
7042 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
7043 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
7044 "distribution to get."
7047 #. type: Content of: <book><chapter><screen>
7051 " Please give the distribution tag to get or a path to the\n"
7052 " package file ending in a /. The distribution\n"
7053 " tags are typically something like: stable unstable testing non-US\n"
7055 " Distribution [stable]:\n"
7058 #. type: Content of: <book><chapter><para>
7061 "The distribution refers to the Debian version in the archive, "
7062 "<emphasis>stable</emphasis> refers to the latest released version and "
7063 "<emphasis>unstable</emphasis> refers to the developmental "
7064 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
7065 "refers to packages that contain encryption technology or other things that "
7066 "cannot be exported from the United States. Importing these packages into the "
7067 "US is legal however."
7070 #. type: Content of: <book><chapter><screen>
7074 " Please give the components to get\n"
7075 " The components are typically something like: main contrib non-free\n"
7077 " Components [main contrib non-free]:\n"
7080 #. type: Content of: <book><chapter><para>
7083 "The components list refers to the list of sub distributions to fetch. The "
7084 "distribution is split up based on software licenses, main being DFSG free "
7085 "packages while contrib and non-free contain things that have various "
7086 "restrictions placed on their use and distribution."
7089 #. type: Content of: <book><chapter><para>
7092 "Any number of sources can be added, the setup script will continue to prompt "
7093 "until you have specified all that you want."
7096 #. type: Content of: <book><chapter><para>
7099 "Before starting to use <command>dselect</command> it is necessary to update "
7100 "the available list by selecting [U]pdate from the menu. This is a superset "
7101 "of <literal>apt-get update</literal> that makes the fetched information "
7102 "available to <command>dselect</command>. [U]pdate must be performed even if "
7103 "<literal>apt-get update</literal> has been run before."
7106 #. type: Content of: <book><chapter><para>
7109 "You can then go on and make your selections using [S]elect and then perform "
7110 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7111 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7115 #. type: Content of: <book><chapter><para>
7118 "By default APT will automatically remove the package (.deb) files once they "
7119 "have been successfully installed. To change this behavior place "
7120 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
7123 #. type: Content of: <book><chapter><title>
7125 msgid "The Interface"
7128 #. type: Content of: <book><chapter><para><footnote><para>
7131 "The <command>dselect</command> method actually is a set of wrapper scripts "
7132 "to <command>apt-get</command>. The method actually provides more "
7133 "functionality than is present in <command>apt-get</command> alone."
7136 #. type: Content of: <book><chapter><para>
7139 "Both that APT <command>dselect</command> method and "
7140 "<command>apt-get</command> share the same interface. It is a simple system "
7141 "that generally tells you what it will do and then goes and does "
7142 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
7143 "of what will happen APT then will print out some informative status messages "
7144 "so that you can estimate how far along it is and how much is left to do."
7147 #. type: Content of: <book><chapter><section><title>
7152 #. type: Content of: <book><chapter><section><para>
7155 "Before all operations except update, APT performs a number of actions to "
7156 "prepare its internal state. It also does some checks of the system's "
7157 "state. At any time these operations can be performed by running "
7158 "<literal>apt-get check</literal>."
7161 #. type: Content of: <book><chapter><section><screen>
7166 "Reading Package Lists... Done\n"
7167 "Building Dependency Tree... Done\n"
7170 #. type: Content of: <book><chapter><section><para>
7173 "The first thing it does is read all the package files into memory. APT uses "
7174 "a caching scheme so this operation will be faster the second time it is "
7175 "run. If some of the package files are not found then they will be ignored "
7176 "and a warning will be printed when apt-get exits."
7179 #. type: Content of: <book><chapter><section><para>
7182 "The final operation performs a detailed analysis of the system's "
7183 "dependencies. It checks every dependency of every installed or unpacked "
7184 "package and considers if it is OK. Should this find a problem then a report "
7185 "will be printed out and <command>apt-get</command> will refuse to run."
7188 #. type: Content of: <book><chapter><section><screen>
7193 "Reading Package Lists... Done\n"
7194 "Building Dependency Tree... Done\n"
7195 "You might want to run apt-get -f install' to correct these.\n"
7196 "Sorry, but the following packages have unmet dependencies:\n"
7197 " 9fonts: Depends: xlib6g but it is not installed\n"
7198 " uucp: Depends: mailx but it is not installed\n"
7199 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7200 " adduser: Depends: perl-base but it is not installed\n"
7201 " aumix: Depends: libgpmg1 but it is not installed\n"
7202 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7203 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7204 " cthugha: Depends: svgalibg1 but it is not installed\n"
7205 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7206 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
7209 #. type: Content of: <book><chapter><section><para>
7212 "In this example the system has many problems, including a serious problem "
7213 "with libreadlineg2. For each package that has unmet dependencies a line is "
7214 "printed out indicating the package with the problem and the dependencies "
7215 "that are unmet. A short explanation of why the package has a dependency "
7216 "problem is also included."
7219 #. type: Content of: <book><chapter><section><para><footnote><para>
7222 "APT however considers all known dependencies and attempts to prevent broken "
7226 #. type: Content of: <book><chapter><section><para>
7229 "There are two ways a system can get into a broken state like this. The first "
7230 "is caused by <command>dpkg</command> missing some subtle relationships "
7231 "between packages when performing upgrades. <placeholder type=\"footnote\" "
7232 "id=\"0\"/>. The second is if a package installation fails during an "
7233 "operation. In this situation a package may have been unpacked without its "
7234 "dependents being installed."
7237 #. type: Content of: <book><chapter><section><para>
7240 "The second situation is much less serious than the first because APT places "
7241 "certain constraints on the order that packages are installed. In both cases "
7242 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
7243 "will cause APT to deduce a possible solution to the problem and then "
7244 "continue on. The APT <command>dselect</command> method always supplies the "
7245 "<literal>-f</literal> option to allow for easy continuation of failed "
7246 "maintainer scripts."
7249 #. type: Content of: <book><chapter><section><para>
7252 "However, if the <literal>-f</literal> option is used to correct a seriously "
7253 "broken system caused by the first case then it is possible that it will "
7254 "either fail immediately or the installation sequence will fail. In either "
7255 "case it is necessary to manually use dpkg (possibly with forcing options) to "
7256 "correct the situation enough to allow APT to proceed."
7259 #. type: Content of: <book><chapter><section><title>
7261 msgid "The Status Report"
7264 #. type: Content of: <book><chapter><section><para>
7267 "Before proceeding <command>apt-get</command> will present a report on what "
7268 "will happen. Generally the report reflects the type of operation being "
7269 "performed but there are several common elements. In all cases the lists "
7270 "reflect the final state of things, taking into account the "
7271 "<literal>-f</literal> option and any other relevant activities to the "
7272 "command being executed."
7275 #. type: Content of: <book><chapter><section><section><title>
7277 msgid "The Extra Package list"
7280 #. type: Content of: <book><chapter><section><section><screen>
7284 "The following extra packages will be installed:\n"
7285 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7286 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7287 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7288 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7292 #. type: Content of: <book><chapter><section><section><para>
7295 "The Extra Package list shows all of the packages that will be installed or "
7296 "upgraded in excess of the ones mentioned on the command line. It is only "
7297 "generated for an <literal>install</literal> command. The listed packages are "
7298 "often the result of an Auto Install."
7301 #. type: Content of: <book><chapter><section><section><title>
7303 msgid "The Packages to Remove"
7306 #. type: Content of: <book><chapter><section><section><screen>
7310 "The following packages will be REMOVED:\n"
7311 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7312 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7313 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7314 " nas xpilot xfig\n"
7317 #. type: Content of: <book><chapter><section><section><para>
7320 "The Packages to Remove list shows all of the packages that will be removed "
7321 "from the system. It can be shown for any of the operations and should be "
7322 "given a careful inspection to ensure nothing important is to be taken "
7323 "off. The <literal>-f</literal> option is especially good at generating "
7324 "packages to remove so extreme care should be used in that case. The list may "
7325 "contain packages that are going to be removed because they are only "
7326 "partially installed, possibly due to an aborted installation."
7329 #. type: Content of: <book><chapter><section><section><title>
7331 msgid "The New Packages list"
7334 #. type: Content of: <book><chapter><section><section><screen>
7338 "The following NEW packages will installed:\n"
7339 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
7342 #. type: Content of: <book><chapter><section><section><para>
7345 "The New Packages list is simply a reminder of what will happen. The packages "
7346 "listed are not presently installed in the system but will be when APT is "
7350 #. type: Content of: <book><chapter><section><section><title>
7352 msgid "The Kept Back list"
7355 #. type: Content of: <book><chapter><section><section><screen>
7359 "The following packages have been kept back\n"
7360 " compface man-db tetex-base msql libpaper svgalib1\n"
7361 " gs snmp arena lynx xpat2 groff xscreensaver\n"
7364 #. type: Content of: <book><chapter><section><section><para>
7367 "Whenever the whole system is being upgraded there is the possibility that "
7368 "new versions of packages cannot be installed because they require new things "
7369 "or conflict with already installed things. In this case the package will "
7370 "appear in the Kept Back list. The best way to convince packages listed there "
7371 "to install is with <literal>apt-get install</literal> or by using "
7372 "<command>dselect</command> to resolve their problems."
7375 #. type: Content of: <book><chapter><section><section><title>
7377 msgid "Held Packages warning"
7380 #. type: Content of: <book><chapter><section><section><screen>
7384 "The following held packages will be changed:\n"
7388 #. type: Content of: <book><chapter><section><section><para>
7391 "Sometimes you can ask APT to install a package that is on hold, in such a "
7392 "case it prints out a warning that the held package is going to be "
7393 "changed. This should only happen during dist-upgrade or install."
7396 #. type: Content of: <book><chapter><section><section><title>
7398 msgid "Final summary"
7401 #. type: Content of: <book><chapter><section><section><para>
7403 msgid "Finally, APT will print out a summary of all the changes that will occur."
7406 #. type: Content of: <book><chapter><section><section><screen>
7410 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7412 "12 packages not fully installed or removed.\n"
7413 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
7416 #. type: Content of: <book><chapter><section><section><para>
7419 "The first line of the summary simply is a reduced version of all of the "
7420 "lists and includes the number of upgrades - that is packages already "
7421 "installed that have new versions available. The second line indicates the "
7422 "number of poorly configured packages, possibly the result of an aborted "
7423 "installation. The final line shows the space requirements that the "
7424 "installation needs. The first pair of numbers refer to the size of the "
7425 "archive files. The first number indicates the number of bytes that must be "
7426 "fetched from remote locations and the second indicates the total size of all "
7427 "the archives required. The next number indicates the size difference between "
7428 "the presently installed packages and the newly installed packages. It is "
7429 "roughly equivalent to the space required in /usr after everything is "
7430 "done. If a large number of packages are being removed then the value may "
7431 "indicate the amount of space that will be freed."
7434 #. type: Content of: <book><chapter><section><section><para>
7437 "Some other reports can be generated by using the -u option to show packages "
7438 "to upgrade, they are similar to the previous examples."
7441 #. type: Content of: <book><chapter><section><title>
7443 msgid "The Status Display"
7446 #. type: Content of: <book><chapter><section><para>
7449 "During the download of archives and package files APT prints out a series of "
7453 #. type: Content of: <book><chapter><section><screen>
7457 "# apt-get update\n"
7458 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7459 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7460 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7461 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7463 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7464 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
7467 #. type: Content of: <book><chapter><section><para>
7470 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
7471 "begins to fetch a file while the last line indicates the progress of the "
7472 "download. The first percent value on the progress line indicates the total "
7473 "percent done of all files. Unfortunately since the size of the Package files "
7474 "is unknown <literal>apt-get update</literal> estimates the percent done "
7475 "which causes some inaccuracies."
7478 #. type: Content of: <book><chapter><section><para>
7481 "The next section of the status line is repeated once for each download "
7482 "thread and indicates the operation being performed and some useful "
7483 "information about what is happening. Sometimes this section will simply read "
7484 "<emphasis>Forking</emphasis> which means the OS is loading the download "
7485 "module. The first word after the [ is the fetch number as shown on the "
7486 "history lines. The next word is the short form name of the object being "
7487 "downloaded. For archives it will contain the name of the package that is "
7491 #. type: Content of: <book><chapter><section><para>
7494 "Inside of the single quote is an informative string indicating the progress "
7495 "of the negotiation phase of the download. Typically it progresses from "
7496 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
7497 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
7498 "value is the number of bytes downloaded from the remote site. Once the "
7499 "download begins this is represented as <literal>102/10.2k</literal> "
7500 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
7501 "expected. The total size is always shown in 4 figure notation to preserve "
7502 "space. After the size display is a percent meter for the file itself. The "
7503 "second last element is the instantaneous average speed. This values is "
7504 "updated every 5 seconds and reflects the rate of data transfer for that "
7505 "period. Finally is shown the estimated transfer time. This is updated "
7506 "regularly and reflects the time to complete everything at the shown transfer "
7510 #. type: Content of: <book><chapter><section><para>
7513 "The status display updates every half second to provide a constant feedback "
7514 "on the download progress while the Get lines scroll back whenever a new file "
7515 "is started. Since the status display is constantly updated it is unsuitable "
7516 "for logging to a file, use the <literal>-q</literal> option to remove the "
7520 #. type: Content of: <book><chapter><section><title>
7525 #. type: Content of: <book><chapter><section><para>
7528 "APT uses <command>dpkg</command> for installing the archives and will switch "
7529 "over to the <command>dpkg</command> interface once downloading is "
7530 "completed. <command>dpkg</command> will also ask a number of questions as it "
7531 "processes the packages and the packages themselves may also ask several "
7532 "questions. Before each question there is usually a description of what it is "
7533 "asking and the questions are too varied to discuss completely here."
7536 #. type: Content of: <book><title>
7538 msgid "Using APT Offline"
7541 #. type: Content of: <book><bookinfo><abstract><para>
7544 "This document describes how to use APT in a non-networked environment, "
7545 "specifically a 'sneaker-net' approach for performing upgrades."
7548 #. type: Content of: <book><bookinfo>
7550 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
7553 #. type: Content of: <book><chapter><title>
7555 msgid "Introduction"
7558 #. type: Content of: <book><chapter><section><title>
7559 #: offline.dbk:1 offline.dbk:1 offline.dbk:1
7563 #. type: Content of: <book><chapter><section><para>
7566 "Normally APT requires direct access to a Debian archive, either from a local "
7567 "media or through a network. Another common complaint is that a Debian "
7568 "machine is on a slow link, such as a modem and another machine has a very "
7569 "fast connection but they are physically distant."
7572 #. type: Content of: <book><chapter><section><para>
7575 "The solution to this is to use large removable media such as a Zip disc or a "
7576 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7577 "archive but can easily fit a subset large enough for most users. The idea is "
7578 "to use APT to generate a list of packages that are required and then fetch "
7579 "them onto the disc using another machine with good connectivity. It is even "
7580 "possible to use another Debian machine with APT or to use a completely "
7581 "different OS and a download tool like wget. Let <emphasis>remote "
7582 "host</emphasis> mean the machine downloading the packages, and "
7583 "<emphasis>target host</emphasis> the one with bad or no connection."
7586 #. type: Content of: <book><chapter><section><para>
7589 "This is achieved by creatively manipulating the APT configuration file. The "
7590 "essential premise to tell APT to look on a disc for it's archive files. Note "
7591 "that the disc should be formatted with a filesystem that can handle long "
7592 "file names such as ext2, fat32 or vfat."
7595 #. type: Content of: <book><chapter><title>
7597 msgid "Using APT on both machines"
7600 #. type: Content of: <book><chapter><section><para>
7603 "APT being available on both machines gives the simplest configuration. The "
7604 "basic idea is to place a copy of the status file on the disc and use the "
7605 "remote machine to fetch the latest package files and decide which packages "
7606 "to download. The disk directory structure should look like:"
7609 #. type: Content of: <book><chapter><section><screen>
7623 #. type: Content of: <book><chapter><section><title>
7625 msgid "The configuration file"
7628 #. type: Content of: <book><chapter><section><para>
7631 "The configuration file should tell APT to store its files on the disc and to "
7632 "use the configuration files on the disc as well. The sources.list should "
7633 "contain the proper sites that you wish to use from the remote machine, and "
7634 "the status file should be a copy of "
7635 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
7636 "host</emphasis>. Please note, if you are using a local archive you must use "
7637 "copy URIs, the syntax is identical to file URIs."
7640 #. type: Content of: <book><chapter><section><para>
7643 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
7647 #. type: Content of: <book><chapter><section><screen>
7653 " /* This is not necessary if the two machines are the same arch, it "
7655 " the remote APT what architecture the target machine is */\n"
7656 " Architecture \"i386\";\n"
7658 " Get::Download-Only \"true\";\n"
7663 " /* Use the disc for state information and redirect the status file from\n"
7664 " the /var/lib/dpkg default */\n"
7665 " State \"/disc/\";\n"
7666 " State::status \"status\";\n"
7668 " // Binary caches will be stored locally\n"
7669 " Cache::archives \"/disc/archives/\";\n"
7670 " Cache \"/tmp/\";\n"
7672 " // Location of the source list.\n"
7673 " Etc \"/disc/\";\n"
7677 #. type: Content of: <book><chapter><section><para>
7680 "More details can be seen by examining the apt.conf man page and the sample "
7681 "configuration file in "
7682 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
7685 #. type: Content of: <book><chapter><section><para>
7688 "On the target machine the first thing to do is mount the disc and copy "
7689 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
7690 "create the directories outlined in the Overview, "
7691 "<emphasis>archives/partial/</emphasis> and "
7692 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
7693 "machine and configure the sources.list. On the remote machine execute the "
7697 #. type: Content of: <book><chapter><section><screen>
7701 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7702 " # apt-get update\n"
7703 " [ APT fetches the package files ]\n"
7704 " # apt-get dist-upgrade\n"
7705 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
7708 #. type: Content of: <book><chapter><section><para>
7711 "The dist-upgrade command can be replaced with any other standard APT "
7712 "commands, particularly dselect-upgrade. You can even use an APT front end "
7713 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
7714 "communicating your selections back to the local computer."
7717 #. type: Content of: <book><chapter><section><para>
7720 "Now the disc contains all of the index files and archives needed to upgrade "
7721 "the target machine. Take the disc back and run:"
7724 #. type: Content of: <book><chapter><section><screen>
7728 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7729 " # apt-get check\n"
7730 " [ APT generates a local copy of the cache files ]\n"
7731 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7732 " [ Or any other APT command ]\n"
7735 #. type: Content of: <book><chapter><section><para>
7738 "It is necessary for proper function to re-specify the status file to be the "
7739 "local one. This is very important!"
7742 #. type: Content of: <book><chapter><section><para>
7745 "If you are using dselect you can do the very risky operation of copying "
7746 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7747 "remote machine are updated. I highly recommend that people only make "
7748 "selections on the local machine - but this may not always be possible. DO "
7749 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7752 #. type: Content of: <book><chapter><title>
7754 msgid "Using APT and wget"
7757 #. type: Content of: <book><chapter><section><para>
7760 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7761 "run on nearly any machine. Unlike the method above this requires that the "
7762 "Debian machine already has a list of available packages."
7765 #. type: Content of: <book><chapter><section><para>
7768 "The basic idea is to create a disc that has only the archive files "
7769 "downloaded from the remote site. This is done by using the --print-uris "
7770 "option to apt-get and then preparing a wget script to actually fetch the "
7774 #. type: Content of: <book><chapter><section><title>
7779 #. type: Content of: <book><chapter><section><para>
7782 "Unlike the previous technique no special configuration files are "
7783 "required. We merely use the standard APT commands to generate the file list."
7786 #. type: Content of: <book><chapter><section><screen>
7790 " # apt-get dist-upgrade\n"
7791 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7792 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7793 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7796 #. type: Content of: <book><chapter><section><para>
7799 "Any command other than dist-upgrade could be used here, including "
7803 #. type: Content of: <book><chapter><section><para>
7806 "The /disc/wget-script file will now contain a list of wget commands to "
7807 "execute in order to fetch the necessary archives. This script should be run "
7808 "with the current directory as the disc's mount point so as to save the "
7809 "output on the disc."
7812 #. type: Content of: <book><chapter><section><para>
7814 msgid "The remote machine would do something like"
7817 #. type: Content of: <book><chapter><section><screen>
7822 " # sh -x ./wget-script\n"
7826 #. type: Content of: <book><chapter><section><para>
7829 "Once the archives are downloaded and the disc returned to the Debian machine "
7830 "installation can proceed using,"
7833 #. type: Content of: <book><chapter><section><screen>
7836 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7839 #. type: Content of: <book><chapter><section><para>
7841 msgid "Which will use the already fetched archives on the disc."