1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the apt-doc package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: apt-doc 1.1~exp14\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2015-10-22 16:34+0200\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
24 "<!ENTITY apt-author.team \"\n"
26 " <othername>APT team</othername>\n"
27 " <contrib></contrib>\n"
36 "<!ENTITY apt-qapage \"\n"
38 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
47 "<!-- Boiler plate Bug reporting section -->\n"
48 "<!ENTITY manbugs \"\n"
49 " <refsect1><title>Bugs</title>\n"
50 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
51 " If you wish to report a bug in APT, please see\n"
52 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
53 " &reportbug; command.\n"
63 "<!-- Boiler plate Author section -->\n"
64 "<!ENTITY manauthor \"\n"
65 " <refsect1><title>Author</title>\n"
66 " <para>APT was written by the APT team "
67 "<email>apt@packages.debian.org</email>.\n"
77 "<!-- Should be used within the option section of the text to\n"
78 " put in the blurb about -h, -v, -c and -o -->\n"
79 "<!ENTITY apt-commonoptions \"\n"
80 " <varlistentry><term><option>-h</option></term>\n"
81 " <term><option>--help</option></term>\n"
82 " <listitem><para>Show a short usage summary.\n"
93 " <term><option>-v</option></term>\n"
94 " <term><option>--version</option></term>\n"
95 " <listitem><para>Show the program version.\n"
106 " <term><option>-c</option></term>\n"
107 " <term><option>--config-file</option></term>\n"
108 " <listitem><para>Configuration File; Specify a configuration file to "
110 " The program will read the default configuration file and then this \n"
111 " configuration file. If configuration settings need to be set before "
113 " default configuration files are parsed specify a file with the "
114 "<envar>APT_CONFIG</envar>\n"
115 " environment variable. See &apt-conf; for syntax information.\n"
126 " <term><option>-o</option></term>\n"
127 " <term><option>--option</option></term>\n"
128 " <listitem><para>Set a Configuration Option; This will set an "
130 " configuration option. The syntax is <option>-o "
131 "Foo::Bar=bar</option>.\n"
132 " <option>-o</option> and <option>--option</option> can be used "
134 " times to set different options.\n"
145 "<!-- Should be used within the option section of the text to\n"
146 " put in the blurb about -h, -v, -c and -o -->\n"
147 "<!ENTITY apt-cmdblurb \"\n"
148 " <para>All command line options may be set using the configuration file, "
150 " descriptions indicate the configuration option to set. For boolean\n"
151 " options you can override the config file by using something like \n"
152 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
153 " or several other variations.\n"
162 "<!ENTITY file-aptconf \"\n"
163 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
164 " <listitem><para>APT configuration file.\n"
165 " Configuration Item: "
166 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
174 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
175 " <listitem><para>APT configuration file fragments.\n"
176 " Configuration Item: "
177 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
186 "<!ENTITY file-cachearchives \"\n"
187 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
188 " <listitem><para>Storage area for retrieved package files.\n"
189 " Configuration Item: "
190 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
199 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
200 " <listitem><para>Storage area for package files in transit.\n"
201 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
202 "(<filename>partial</filename> will be implicitly "
203 "appended)</para></listitem>\n"
212 "<!ENTITY file-preferences \"\n"
213 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
214 " <listitem><para>Version preferences file.\n"
215 " This is where you would specify "pinning",\n"
216 " i.e. a preference to get certain packages\n"
217 " from a separate source\n"
218 " or from a different version of a distribution.\n"
219 " Configuration Item: "
220 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
229 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
230 " <listitem><para>File fragments for the version preferences.\n"
231 " Configuration Item: "
232 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
241 "<!ENTITY file-sourceslist \"\n"
242 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
243 " <listitem><para>Locations to fetch packages from.\n"
244 " Configuration Item: "
245 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
254 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
255 " <listitem><para>File fragments for locations to fetch packages from.\n"
256 " Configuration Item: "
257 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
266 "<!ENTITY file-statelists \"\n"
267 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
268 " <listitem><para>Storage area for state information for each package "
269 "resource specified in\n"
271 " Configuration Item: "
272 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
281 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
282 " <listitem><para>Storage area for state information in transit.\n"
283 " Configuration Item: <literal>Dir::State::Lists</literal> "
284 "(<filename>partial</filename> will be implicitly "
285 "appended)</para></listitem>\n"
294 "<!ENTITY file-trustedgpg \"\n"
295 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
296 " <listitem><para>Keyring of local trusted keys, new keys will be added "
298 " Configuration Item: "
299 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
308 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
309 " <listitem><para>File fragments for the trusted keys, additional "
311 " be stored here (by other packages or the administrator).\n"
312 " Configuration Item "
313 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
322 "<!ENTITY file-extended_states \"\n"
324 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
325 " <listitem><para>Status list of auto-installed packages.\n"
326 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
327 " </para></listitem>\n"
336 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
338 " to the other headers like NAME and DESCRIPTION and should therefore be "
340 "<!ENTITY translation-title \"TRANSLATION\">\n"
347 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
349 " to the translation in the past, who is responsible now and maybe "
350 "further information\n"
351 " specially related to your translation. -->\n"
352 "<!ENTITY translation-holder \"\n"
353 " The english translation was done by John Doe "
354 "<email>john@doe.org</email> in 2009,\n"
355 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
357 " Debian Dummy l10n Team "
358 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
366 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
367 "untranslated/fuzzy strings\n"
368 " in a shipped manpage newer/modified paragraphs will maybe appear in "
370 " the generated manpage. This sentence is therefore here to tell the "
372 " is not a mistake by the translator - obviously the target is that at "
374 " releases this sentence is not needed. :) -->\n"
375 "<!ENTITY translation-english \"\n"
376 " Note that this translated document may contain untranslated parts.\n"
377 " This is done on purpose, to avoid losing content when the\n"
378 " translation is lagging behind the original content.\n"
385 "<!-- TRANSLATOR: used as in -o=config_string "
386 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
393 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
394 "synopsis-config-file \"config_file\">"
400 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
401 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
402 "\"target_release\">"
408 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
409 "synopsis-architecture \"architecture\">"
415 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
416 "--> <!ENTITY synopsis-pkg \"pkg\">"
422 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
423 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
429 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
430 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
436 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
437 "awesome --> <!ENTITY synopsis-regex \"regex\">"
443 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
444 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
450 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
451 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
452 "\"temporary_directory\">"
458 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
459 "synopsis-filename \"filename\">"
465 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
466 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
472 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
473 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
480 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
481 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
488 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
489 "generate section --> <!ENTITY synopsis-section \"section\">"
495 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
496 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
499 #. type: Content of: <refentry><refmeta><manvolnum>
500 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
501 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
505 #. type: Content of: <refentry><refmeta><refmiscinfo>
506 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
507 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
508 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
509 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
513 #. type: Content of: <refentry><refnamediv><refpurpose>
515 msgid "command-line interface"
518 #. type: Content of: <refentry><refsect1><title>
519 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
520 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
521 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
522 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
526 #. type: Content of: <refentry><refsect1><para>
529 "<command>apt</command> provides a high-level commandline interface for the "
530 "package management system. It is intended as an end user interface and "
531 "enables some options better suited for interactive usage by default compared "
532 "to more specialized APT tools like &apt-get; and &apt-cache;."
535 #. type: Content of: <refentry><refsect1><para>
538 "Much like <command>apt</command> itself, its manpage is intended as an end "
539 "user interface and as such only mentions the most used commands and options "
540 "partly to not duplicate information in multiple places and partly to avoid "
541 "overwelming readers with a cornucopia of options and details."
544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
545 #: apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1
549 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
552 "<option>update</option> is used to download package information from all "
553 "configured sources. Other commands operate on this data to e.g. perform "
554 "package upgrades or search in and display details about all packages "
555 "available for installation."
558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
561 "<option>upgrade</option> is used to install available upgrades of all "
562 "packages currently installed on the system from the sources configured via "
563 "&sources-list;. New packages will be installed if required to statisfy "
564 "dependencies, but existing packages will never be removed. If an upgrade for "
565 "a package requires the remove of an installed package the upgrade for this "
566 "package isn't performed."
569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
572 "<literal>full-upgrade</literal> performs the function of upgrade but will "
573 "remove currently installed packages if this is needed to upgrade the system "
577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
578 #: apt.8.xml:1 apt.8.xml:1
582 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
585 "Performs the requested action on one or more packages specified via ®ex;, "
586 "&glob; or exact match. The requested action can be overidden for specific "
587 "packages by append a plus (+) to the package name to install this package or "
588 "a minus (-) to remove it."
591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
594 "A specific version of a package can be selected for installation by "
595 "following the package name with an equals (=) and the version of the package "
596 "to select. Alternatively the version from a specific release can be selected "
597 "by following the package name with a forward slash (/) and codename "
598 "(&stable-codename;, &testing-codename;, sid …) or suite name (stable, "
599 "testing, unstable). This will also select versions from this release for "
600 "dependencies of this package if needed to satisfy the request."
603 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
606 "Removing a package removes all packaged data, but leaves usually small "
607 "(modified) user configuration files behind, in case the remove was an "
608 "accident. Just issuing an installtion request for the accidently removed "
609 "package will restore it funcation as before in that case. On the other hand "
610 "you can get right of these leftovers via calling <command>purge</command> "
611 "even on already removed packages. Note that this does not effect any data "
612 "or configuration stored in your home directory."
615 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
618 "<literal>autoremove</literal> is used to remove packages that were "
619 "automatically installed to satisfy dependencies for other packages and are "
620 "now no longer needed as dependencies changed or the package(s) needing them "
621 "were removed in the meantime."
624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
627 "Try to ensure that the list does not include applications you have grown to "
628 "like even through they there once installed just as a dependency of another "
629 "package. You can mark such a package as manually installed by using "
630 "&apt-mark;. Packages which you have installed explicitly via "
631 "<command>install</command> are never proposed for automatic removal as well."
634 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
635 #: apt.8.xml:1 apt.8.xml:1
636 msgid "(&apt-cache;)"
639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
642 "<option>search</option> can be used to search for the given ®ex; term(s) "
643 "in the list of the available packages and display matches. This can e.g. be "
644 "useful if you are looking for packages having a specific feature. If you "
645 "are looking for a package including a specific file try &apt-file;."
648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
651 "Show information about the given package(s) including its dependencies, "
652 "installation and download size, sources the package is available from, the "
653 "description of the packages content and many more. It can e.g. be helpful to "
654 "look at this information before allowing &apt; to remove a package or while "
655 "searching for new packages to install."
658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
659 #: apt.8.xml:1 apt.8.xml:1
660 msgid "(work-in-progress)"
663 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
666 "<option>list</option> is somewhat similar to <command>dpkg-query "
667 "--list</command> in that it can display a list of packages satisfying "
668 "certain criteria. It supports &glob; patterns for matching package names as "
669 "well as options to list installed (<option>--installed</option>), "
670 "upgradeable (<option>--upgradeable</option>) or all available "
671 "(<option>--all-versions</option>) versions."
674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
677 "<literal>edit-sources</literal> lets you edit your &sources-list; files in "
678 "your preferred texteditor while also providing basic sanity checks."
681 #. type: Content of: <refentry><refsect1><title>
683 msgid "Script usage and Differences to other APT tools"
686 #. type: Content of: <refentry><refsect1><para>
689 "The &apt; commandline is designed as a end-user tool and it may change "
690 "behaviour between versions. While it tries to not break backward "
691 "compatibility there is no guarantee for it either if it seems benefitial for "
695 #. type: Content of: <refentry><refsect1><para>
698 "All features of &apt; are available in dedicated APT tools like &apt-get; "
699 "and &apt-cache; as well. &apt; just changes the default value of some "
700 "options (see &apt-conf; and specifically the Binary scope). So prefer using "
701 "these commands (potentially with some additional options enabled) in your "
702 "scripts as they keep backward compatibility as much as possible."
705 #. type: Content of: <refentry><refsect1><title>
706 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
707 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
708 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
709 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
713 #. type: Content of: <refentry><refsect1><para>
716 "&apt-get;, &apt-cache;, &sources-list;, &apt-conf;, &apt-config;, The APT "
717 "User's guide in &guidesdir;, &apt-preferences;, the APT Howto."
720 #. type: Content of: <refentry><refsect1><title>
721 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-mark.8.xml:1
722 #: apt-cdrom.8.xml:1 apt-config.8.xml:1 apt-extracttemplates.1.xml:1
723 #: apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
727 #. type: Content of: <refentry><refsect1><para>
730 "<command>apt</command> returns zero on normal operation, decimal 100 on "
734 #. type: Content of: <refentry><refnamediv><refpurpose>
736 msgid "APT package handling utility -- command-line interface"
739 #. type: Content of: <refentry><refsect1><para>
742 "<command>apt-get</command> is the command-line tool for handling packages, "
743 "and may be considered the user's \"back-end\" to other tools using the APT "
744 "library. Several \"front-end\" interfaces exist, such as &aptitude;, "
745 "&synaptic; and &wajig;."
748 #. type: Content of: <refentry><refsect1><para>
749 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
750 #: apt-ftparchive.1.xml:1
752 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
753 "one of the commands below must be present."
756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
759 "<literal>update</literal> is used to resynchronize the package index files "
760 "from their sources. The indexes of available packages are fetched from the "
761 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
762 "example, when using a Debian archive, this command retrieves and scans the "
763 "<filename>Packages.gz</filename> files, so that information about new and "
764 "updated packages is available. An <literal>update</literal> should always be "
765 "performed before an <literal>upgrade</literal> or "
766 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
767 "meter will be incorrect as the size of the package files cannot be known in "
771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
774 "<literal>upgrade</literal> is used to install the newest versions of all "
775 "packages currently installed on the system from the sources enumerated in "
776 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
777 "with new versions available are retrieved and upgraded; under no "
778 "circumstances are currently installed packages removed, or packages not "
779 "already installed retrieved and installed. New versions of currently "
780 "installed packages that cannot be upgraded without changing the install "
781 "status of another package will be left at their current version. An "
782 "<literal>update</literal> must be performed first so that "
783 "<command>apt-get</command> knows that new versions of packages are "
787 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
790 "<literal>dist-upgrade</literal> in addition to performing the function of "
791 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
792 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
793 "conflict resolution system, and it will attempt to upgrade the most "
794 "important packages at the expense of less important ones if necessary. The "
795 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
796 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
797 "locations from which to retrieve desired package files. See also "
798 "&apt-preferences; for a mechanism for overriding the general settings for "
799 "individual packages."
802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
805 "<literal>dselect-upgrade</literal> is used in conjunction with the "
806 "traditional Debian packaging front-end, "
807 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
808 "&dselect; to the <literal>Status</literal> field of available packages, and "
809 "performs the actions necessary to realize that state (for instance, the "
810 "removal of old and the installation of new packages)."
813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
816 "<literal>install</literal> is followed by one or more packages desired for "
817 "installation or upgrading. Each package is a package name, not a fully "
818 "qualified filename (for instance, in a Debian system, "
819 "<package>apt-utils</package> would be the argument provided, not "
820 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
821 "packages required by the package(s) specified for installation will also be "
822 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
823 "file is used to locate the desired packages. If a hyphen is appended to the "
824 "package name (with no intervening space), the identified package will be "
825 "removed if it is installed. Similarly a plus sign can be used to designate "
826 "a package to install. These latter features may be used to override "
827 "decisions made by apt-get's conflict resolution system."
830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
833 "A specific version of a package can be selected for installation by "
834 "following the package name with an equals and the version of the package to "
835 "select. This will cause that version to be located and selected for "
836 "install. Alternatively a specific distribution can be selected by following "
837 "the package name with a slash and the version of the distribution or the "
838 "Archive name (stable, testing, unstable)."
841 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
844 "Both of the version selection mechanisms can downgrade packages and must be "
848 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
851 "This is also the target to use if you want to upgrade one or more "
852 "already-installed packages without upgrading every package you have on your "
853 "system. Unlike the \"upgrade\" target, which installs the newest version of "
854 "all currently installed packages, \"install\" will install the newest "
855 "version of only the package(s) specified. Simply provide the name of the "
856 "package(s) you wish to upgrade, and if a newer version is available, it (and "
857 "its dependencies, as described above) will be downloaded and installed."
860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
863 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
864 "installation policy for individual packages."
867 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
870 "If no package matches the given expression and the expression contains one "
871 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
872 "it is applied to all package names in the database. Any matches are then "
873 "installed (or removed). Note that matching is done by substring so 'lo.*' "
874 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
875 "expression with a '^' or '$' character, or create a more specific regular "
879 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
882 "<literal>remove</literal> is identical to <literal>install</literal> except "
883 "that packages are removed instead of installed. Note that removing a package "
884 "leaves its configuration files on the system. If a plus sign is appended to "
885 "the package name (with no intervening space), the identified package will be "
886 "installed instead of removed."
889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
892 "<literal>purge</literal> is identical to <literal>remove</literal> except "
893 "that packages are removed and purged (any configuration files are deleted "
897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
900 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
901 "packages. APT will examine the available packages to decide which source "
902 "package to fetch. It will then find and download into the current directory "
903 "the newest available version of that source package while respecting the "
904 "default release, set with the option "
905 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
906 "per package with the <literal>pkg/release</literal> syntax, if possible."
909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
912 "Source packages are tracked separately from binary packages via "
913 "<literal>deb-src</literal> lines in the &sources-list; file. This means that "
914 "you will need to add such a line for each repository you want to get sources "
915 "from; otherwise you will probably get either the wrong (too old/too new) "
916 "source versions or none at all."
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
922 "If the <option>--compile</option> option is specified then the package will "
923 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
924 "the architecture as defined by the <command>--host-architecture</command> "
925 "option. If <option>--download-only</option> is specified then the source "
926 "package will not be unpacked."
929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
932 "A specific source version can be retrieved by postfixing the source name "
933 "with an equals and then the version to fetch, similar to the mechanism used "
934 "for the package files. This enables exact matching of the source package "
935 "name and version, implicitly enabling the "
936 "<literal>APT::Get::Only-Source</literal> option."
939 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
942 "Note that source packages are not installed and tracked in the "
943 "<command>dpkg</command> database like binary packages; they are simply "
944 "downloaded to the current directory, like source tarballs."
947 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
950 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
951 "attempt to satisfy the build dependencies for a source package. By default "
952 "the dependencies are satisfied to build the package natively. If desired a "
953 "host-architecture can be specified with the "
954 "<option>--host-architecture</option> option instead."
957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
960 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
961 "and checks for broken dependencies."
964 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
967 "<literal>download</literal> will download the given binary package into the "
971 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
974 "<literal>clean</literal> clears out the local repository of retrieved "
975 "package files. It removes everything but the lock file from "
976 "<filename>&cachedir;/archives/</filename> and "
977 "<filename>&cachedir;/archives/partial/</filename>."
980 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
981 #: apt-get.8.xml:1 apt-get.8.xml:1
985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
986 #: apt-get.8.xml:1 apt-get.8.xml:1
987 msgid "alias since 1.1)"
990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
993 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
994 "local repository of retrieved package files. The difference is that it only "
995 "removes package files that can no longer be downloaded, and are largely "
996 "useless. This allows a cache to be maintained over a long period without it "
997 "growing out of control. The configuration option "
998 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
999 "being erased if it is set to off."
1002 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1005 "<literal>autoremove</literal> is used to remove packages that were "
1006 "automatically installed to satisfy dependencies for other packages and are "
1007 "now no longer needed."
1010 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1013 "<literal>changelog</literal> tries to download the changelog of a package "
1014 "and displays it through <command>sensible-pager</command>. By default it "
1015 "displays the changelog for the version that is installed. However, you can "
1016 "specify the same options as for the <option>install</option> command."
1019 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1022 "Displays by default a deb822 formatted listing of information about all data "
1023 "files (aka index targets) <command>apt-get update</command> would "
1024 "download. Supports a <option>--format</option> option to modify the output "
1025 "format as well as accepts lines of the default output to filter the records "
1026 "by. The command is mainly used as an interface for external tools working "
1027 "with APT to get information as well as filenames for downloaded files so "
1028 "they can use them as well instead of downloading them again on their "
1029 "own. Detailed documentation is omitted here and can instead be found in the "
1031 "<literal><filename>doc/acquire-additional-files.txt</filename></literal>."
1034 #. type: Content of: <refentry><refsect1><title>
1035 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-config.8.xml:1
1036 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1043 "Do not consider recommended packages as a dependency for installing. "
1044 "Configuration Item: <literal>APT::Install-Recommends</literal>."
1047 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1050 "Consider suggested packages as a dependency for installing. Configuration "
1051 "Item: <literal>APT::Install-Suggests</literal>."
1054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1057 "Download only; package files are only retrieved, not unpacked or installed. "
1058 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
1061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1064 "Fix; attempt to correct a system with broken dependencies in place. This "
1065 "option, when used with install/remove, can omit any packages to permit APT "
1066 "to deduce a likely solution. If packages are specified, these have to "
1067 "completely correct the problem. The option is sometimes necessary when "
1068 "running APT for the first time; APT itself does not allow broken package "
1069 "dependencies to exist on a system. It is possible that a system's dependency "
1070 "structure can be so corrupt as to require manual intervention (which usually "
1071 "means using <command>dpkg --remove</command> to eliminate some of the "
1072 "offending packages). Use of this option together with <option>-m</option> "
1073 "may produce an error in some situations. Configuration Item: "
1074 "<literal>APT::Get::Fix-Broken</literal>."
1077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1080 "Ignore missing packages; if packages cannot be retrieved or fail the "
1081 "integrity check after retrieval (corrupted package files), hold back those "
1082 "packages and handle the result. Use of this option together with "
1083 "<option>-f</option> may produce an error in some situations. If a package is "
1084 "selected for installation (particularly if it is mentioned on the command "
1085 "line) and it could not be downloaded then it will be silently held back. "
1086 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
1089 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1092 "Disables downloading of packages. This is best used with "
1093 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
1094 "already downloaded. Configuration Item: "
1095 "<literal>APT::Get::Download</literal>."
1098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1101 "Quiet; produces output suitable for logging, omitting progress indicators. "
1102 "More q's will produce more quiet up to a maximum of 2. You can also use "
1103 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1104 "file. Note that quiet level 2 implies <option>-y</option>; you should never "
1105 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
1106 "may decide to do something you did not expect. Configuration Item: "
1107 "<literal>quiet</literal>."
1110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1113 "No action; perform a simulation of events that would occur based on the "
1114 "current system state but do not actually change the system. Locking will be "
1115 "disabled (<option>Debug::NoLocking</option>) so the system state could "
1116 "change while <command>apt-get</command> is running. Simulations can also be "
1117 "executed by non-root users which might not have read access to all apt "
1118 "configuration distorting the simulation. A notice expressing this warning "
1119 "is also shown by default for non-root users "
1120 "(<option>APT::Get::Show-User-Simulation-Note</option>). Configuration Item: "
1121 "<literal>APT::Get::Simulate</literal>."
1124 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1127 "Simulated runs print out a series of lines, each representing a "
1128 "<command>dpkg</command> operation: configure (<literal>Conf</literal>), "
1129 "remove (<literal>Remv</literal>) or unpack "
1130 "(<literal>Inst</literal>). Square brackets indicate broken packages, and "
1131 "empty square brackets indicate breaks that are of no consequence (rare)."
1134 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1137 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
1138 "non-interactively. If an undesirable situation, such as changing a held "
1139 "package, trying to install a unauthenticated package or removing an "
1140 "essential package occurs then <literal>apt-get</literal> will abort. "
1141 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
1144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1147 "Automatic \"no\" to all prompts. Configuration Item: "
1148 "<literal>APT::Get::Assume-No</literal>."
1151 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1154 "Show upgraded packages; print out a list of all packages that are to be "
1155 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
1158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1161 "Show full versions for upgraded and installed packages. Configuration Item: "
1162 "<literal>APT::Get::Show-Versions</literal>."
1165 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1168 "This option controls the architecture packages are built for by "
1169 "<command>apt-get source --compile</command> and how cross-builddependencies "
1170 "are satisfied. By default is it not set which means that the host "
1171 "architecture is the same as the build architecture (which is defined by "
1172 "<literal>APT::Architecture</literal>). Configuration Item: "
1173 "<literal>APT::Get::Host-Architecture</literal>."
1176 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1179 "This option controls the activated build profiles for which a source package "
1180 "is built by <command>apt-get source --compile</command> and how build "
1181 "dependencies are satisfied. By default no build profile is active. More "
1182 "than one build profile can be activated at a time by concatenating them with "
1183 "a comma. Configuration Item: <literal>APT::Build-Profiles</literal>."
1186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1189 "Compile source packages after downloading them. Configuration Item: "
1190 "<literal>APT::Get::Compile</literal>."
1193 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1196 "Ignore package holds; this causes <command>apt-get</command> to ignore a "
1197 "hold placed on a package. This may be useful in conjunction with "
1198 "<literal>dist-upgrade</literal> to override a large number of undesired "
1199 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
1202 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1205 "Allow installing new packages when used in conjunction with "
1206 "<literal>upgrade</literal>. This is useful if the update of a installed "
1207 "package requires new dependencies to be installed. Instead of holding the "
1208 "package back <literal>upgrade</literal> will upgrade the package and install "
1209 "the new dependencies. Note that <literal>upgrade</literal> with this option "
1210 "will never remove packages, only allow adding new ones. Configuration Item: "
1211 "<literal>APT::Get::Upgrade-Allow-New</literal>."
1214 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1217 "Do not upgrade packages; when used in conjunction with "
1218 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
1219 "packages on the command line from being upgraded if they are already "
1220 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
1223 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1226 "Do not install new packages; when used in conjunction with "
1227 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
1228 "upgrades for already installed packages only and ignore requests to install "
1229 "new packages. Configuration Item: "
1230 "<literal>APT::Get::Only-Upgrade</literal>."
1233 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1236 "This is a dangerous option that will cause apt to continue without prompting "
1237 "if it is doing downgrades. It should not be used except in very special "
1238 "situations. Using it can potentially destroy your system! Configuration "
1239 "Item: <literal>APT::Get::allow-downgrades</literal>. Introduced in APT 1.1."
1242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1245 "Force yes; this is a dangerous option that will cause apt to continue "
1246 "without prompting if it is removing essentials. It should not be used except "
1247 "in very special situations. Using it can potentially destroy your system! "
1248 "Configuration Item: "
1249 "<literal>APT::Get::allow-remove-essential</literal>. Introduced in APT 1.1."
1252 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1255 "Force yes; this is a dangerous option that will cause apt to continue "
1256 "without prompting if it is changing held packages. It should not be used "
1257 "except in very special situations. Using it can potentially destroy your "
1258 "system! Configuration Item: "
1259 "<literal>APT::Get::allow-change-held-packages</literal>. Introduced in APT "
1263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1266 "Force yes; this is a dangerous option that will cause apt to continue "
1267 "without prompting if it is doing something potentially harmful. It should "
1268 "not be used except in very special situations. Using "
1269 "<literal>force-yes</literal> can potentially destroy your system! "
1270 "Configuration Item: <literal>APT::Get::force-yes</literal>. This is "
1271 "deprecated and replaced by <option>--allow-downgrades</option>, "
1272 "<option>--allow-remove-essential</option>, "
1273 "<option>--allow-change-held-packages</option> in 1.1."
1276 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1279 "Instead of fetching the files to install their URIs are printed. Each URI "
1280 "will have the path, the destination file name, the size and the expected MD5 "
1281 "hash. Note that the file name to write to will not always match the file "
1282 "name on the remote site! This also works with the <literal>source</literal> "
1283 "and <literal>update</literal> commands. When used with the "
1284 "<literal>update</literal> command the MD5 and size are not included, and it "
1285 "is up to the user to decompress any compressed files. Configuration Item: "
1286 "<literal>APT::Get::Print-URIs</literal>."
1289 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1292 "Use purge instead of remove for anything that would be removed. An asterisk "
1293 "(\"*\") will be displayed next to packages which are scheduled to be "
1294 "purged. <option>remove --purge</option> is equivalent to the "
1295 "<option>purge</option> command. Configuration Item: "
1296 "<literal>APT::Get::Purge</literal>."
1299 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1302 "Re-install packages that are already installed and at the newest version. "
1303 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
1306 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1309 "This option is on by default; use <literal>--no-list-cleanup</literal> to "
1310 "turn it off. When it is on, <command>apt-get</command> will automatically "
1311 "manage the contents of <filename>&statedir;/lists</filename> to ensure that "
1312 "obsolete files are erased. The only reason to turn it off is if you "
1313 "frequently change your sources list. Configuration Item: "
1314 "<literal>APT::Get::List-Cleanup</literal>."
1317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1320 "This option controls the default input to the policy engine; it creates a "
1321 "default pin at priority 990 using the specified release string. This "
1322 "overrides the general settings in "
1323 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
1324 "not affected by the value of this option. In short, this option lets you "
1325 "have simple control over which distribution packages will be retrieved "
1326 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
1327 "unstable</option> or <option>-t sid</option>. Configuration Item: "
1328 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
1332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1335 "Only perform operations that are 'trivial'. Logically this can be considered "
1336 "related to <option>--assume-yes</option>; where "
1337 "<option>--assume-yes</option> will answer yes to any prompt, "
1338 "<option>--trivial-only</option> will answer no. Configuration Item: "
1339 "<literal>APT::Get::Trivial-Only</literal>."
1342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1345 "If any packages are to be removed apt-get immediately aborts without "
1346 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
1349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1352 "If the command is either <literal>install</literal> or "
1353 "<literal>remove</literal>, then this option acts like running the "
1354 "<literal>autoremove</literal> command, removing unused dependency "
1355 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
1358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1361 "Only has meaning for the <literal>source</literal> and "
1362 "<literal>build-dep</literal> commands. Indicates that the given source "
1363 "names are not to be mapped through the binary table. This means that if "
1364 "this option is specified, these commands will only accept source package "
1365 "names as arguments, rather than accepting binary package names and looking "
1366 "up the corresponding source package. Configuration Item: "
1367 "<literal>APT::Get::Only-Source</literal>."
1370 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1373 "Download only the diff, dsc, or tar file of a source archive. Configuration "
1374 "Item: <literal>APT::Get::Diff-Only</literal>, "
1375 "<literal>APT::Get::Dsc-Only</literal>, and "
1376 "<literal>APT::Get::Tar-Only</literal>."
1379 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1382 "Only process architecture-dependent build-dependencies. Configuration Item: "
1383 "<literal>APT::Get::Arch-Only</literal>."
1386 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1389 "Ignore if packages can't be authenticated and don't prompt about it. This "
1390 "can be useful while working with local repositories, but is a huge security "
1391 "risk if data authenticity isn't ensured in another way by the user itself. "
1392 "The usage of the <option>Trusted</option> option for &sources-list; entries "
1393 "should usually be preferred over this global override. Configuration Item: "
1394 "<literal>APT::Get::AllowUnauthenticated</literal>."
1397 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1400 "Forbid the update command to acquire unverifiable data from configured "
1401 "sources. Apt will fail at the update command for repositories without valid "
1402 "cryptographically signatures. Configuration Item: "
1403 "<literal>Acquire::AllowInsecureRepositories</literal>."
1406 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1409 "Show user friendly progress information in the terminal window when packages "
1410 "are installed, upgraded or removed. For a machine parsable version of this "
1411 "data see README.progress-reporting in the apt doc directory. Configuration "
1412 "Item: <literal>Dpkg::Progress</literal> and "
1413 "<literal>Dpkg::Progress-Fancy</literal>."
1416 #. type: Content of: <refentry><refsect1><title>
1417 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1 apt-mark.8.xml:1
1418 #: apt.conf.5.xml:1 apt_preferences.5.xml:1
1422 #. type: Content of: <refentry><refsect1><para>
1425 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1426 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1430 #. type: Content of: <refentry><refsect1><para>
1433 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1437 #. type: Content of: <refentry><refnamediv><refpurpose>
1438 #: apt-cache.8.xml:1
1439 msgid "query the APT cache"
1442 #. type: Content of: <refentry><refsect1><para>
1443 #: apt-cache.8.xml:1
1445 "<command>apt-cache</command> performs a variety of operations on APT's "
1446 "package cache. <command>apt-cache</command> does not manipulate the state of "
1447 "the system but does provide operations to search and generate interesting "
1448 "output from the package metadata."
1451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1452 #: apt-cache.8.xml:1
1454 "<literal>gencaches</literal> creates APT's package cache. This is done "
1455 "implicitly by all commands needing this cache if it is missing or outdated."
1458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1459 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1460 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1461 msgid "&synopsis-pkg;"
1464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1465 #: apt-cache.8.xml:1
1467 "<literal>showpkg</literal> displays information about the packages listed on "
1468 "the command line. Remaining arguments are package names. The available "
1469 "versions and reverse dependencies of each package listed are listed, as well "
1470 "as forward dependencies for each version. Forward (normal) dependencies are "
1471 "those packages upon which the package in question depends; reverse "
1472 "dependencies are those packages that depend upon the package in "
1473 "question. Thus, forward dependencies must be satisfied for a package, but "
1474 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1475 "libreadline2</command> would produce output similar to the following:"
1478 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1479 #: apt-cache.8.xml:1
1482 "Package: libreadline2\n"
1483 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1484 "Reverse Depends: \n"
1485 " libreadlineg2,libreadline2\n"
1486 " libreadline2-altdev,libreadline2\n"
1488 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1491 "Reverse Provides: \n"
1494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1495 #: apt-cache.8.xml:1
1497 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1498 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1499 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1500 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1501 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1502 "installed. For the specific meaning of the remainder of the output it is "
1503 "best to consult the apt source code."
1506 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1507 #: apt-cache.8.xml:1
1509 "<literal>stats</literal> displays some statistics about the cache. No "
1510 "further arguments are expected. Statistics reported are:"
1513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1514 #: apt-cache.8.xml:1
1516 "<literal>Total package names</literal> is the number of package names found "
1520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1521 #: apt-cache.8.xml:1
1523 "<literal>Normal packages</literal> is the number of regular, ordinary "
1524 "package names; these are packages that bear a one-to-one correspondence "
1525 "between their names and the names used by other packages for them in "
1526 "dependencies. The majority of packages fall into this category."
1529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1530 #: apt-cache.8.xml:1
1532 "<literal>Pure virtual packages</literal> is the number of packages that "
1533 "exist only as a virtual package name; that is, packages only \"provide\" the "
1534 "virtual package name, and no package actually uses the name. For instance, "
1535 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1536 "several packages provide \"mail-transport-agent\", but there is no package "
1537 "named \"mail-transport-agent\"."
1540 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1541 #: apt-cache.8.xml:1
1543 "<literal>Single virtual packages</literal> is the number of packages with "
1544 "only one package providing a particular virtual package. For example, in the "
1545 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1546 "package, xless, provides \"X11-text-viewer\"."
1549 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1550 #: apt-cache.8.xml:1
1552 "<literal>Mixed virtual packages</literal> is the number of packages that "
1553 "either provide a particular virtual package or have the virtual package name "
1554 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1555 "an actual package, and provided by the debconf-tiny package."
1558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1559 #: apt-cache.8.xml:1
1561 "<literal>Missing</literal> is the number of package names that were "
1562 "referenced in a dependency but were not provided by any package. Missing "
1563 "packages may be an evidence if a full distribution is not accessed, or if a "
1564 "package (real or virtual) has been dropped from the distribution. Usually "
1565 "they are referenced from Conflicts or Breaks statements."
1568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1569 #: apt-cache.8.xml:1
1571 "<literal>Total distinct</literal> versions is the number of package versions "
1572 "found in the cache. If more than one distribution is being accessed (for "
1573 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1574 "larger than the number of total package names."
1577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1578 #: apt-cache.8.xml:1
1580 "<literal>Total dependencies</literal> is the number of dependency "
1581 "relationships claimed by all of the packages in the cache."
1584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1585 #: apt-cache.8.xml:1
1587 "<literal>showsrc</literal> displays all the source package records that "
1588 "match the given package names. All versions are shown, as well as all "
1589 "records that declare the name to be a binary package. Use "
1590 "<option>--only-source</option> to display only source package names."
1593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1594 #: apt-cache.8.xml:1
1596 "<literal>dump</literal> shows a short listing of every package in the "
1597 "cache. It is primarily for debugging."
1600 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1601 #: apt-cache.8.xml:1
1603 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1604 "suitable for use with &dpkg; and is used by the &dselect; method."
1607 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1608 #: apt-cache.8.xml:1
1610 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1615 #: apt-cache.8.xml:1
1617 "<literal>show</literal> performs a function similar to <command>dpkg "
1618 "--print-avail</command>; it displays the package records for the named "
1622 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1623 #: apt-cache.8.xml:1
1624 msgid "&synopsis-regex;"
1627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1628 #: apt-cache.8.xml:1
1630 "<literal>search</literal> performs a full text search on all available "
1631 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1632 "the package names and the descriptions for an occurrence of the regular "
1633 "expression and prints out the package name and the short description, "
1634 "including virtual package names. If <option>--full</option> is given then "
1635 "output identical to <literal>show</literal> is produced for each matched "
1636 "package, and if <option>--names-only</option> is given then the long "
1637 "description is not searched, only the package name and provided packages "
1641 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1642 #: apt-cache.8.xml:1
1644 "Separate arguments can be used to specify multiple search patterns that are "
1648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1649 #: apt-cache.8.xml:1
1651 "<literal>depends</literal> shows a listing of each dependency a package has "
1652 "and all the possible other packages that can fulfill that dependency."
1655 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1656 #: apt-cache.8.xml:1
1658 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1663 #: apt-cache.8.xml:1
1664 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1668 #: apt-cache.8.xml:1
1670 "This command prints the name of each package APT knows. The optional "
1671 "argument is a prefix match to filter the name list. The output is suitable "
1672 "for use in a shell tab complete function and the output is generated "
1673 "extremely quickly. This command is best used with the "
1674 "<option>--generate</option> option."
1677 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1678 #: apt-cache.8.xml:1
1680 "Note that a package which APT knows of is not necessarily available to "
1681 "download, installable or installed, e.g. virtual packages are also listed in "
1682 "the generated list."
1685 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1686 #: apt-cache.8.xml:1
1688 "<literal>dotty</literal> takes a list of packages on the command line and "
1689 "generates output suitable for use by dotty from the <ulink "
1690 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1691 "package. The result will be a set of nodes and edges representing the "
1692 "relationships between the packages. By default the given packages will trace "
1693 "out all dependent packages; this can produce a very large graph. To limit "
1694 "the output to only the packages listed on the command line, set the "
1695 "<literal>APT::Cache::GivenOnly</literal> option."
1698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1699 #: apt-cache.8.xml:1
1701 "The resulting nodes will have several shapes; normal packages are boxes, "
1702 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1703 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1704 "packages), blue lines are pre-depends, green lines are conflicts."
1707 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1708 #: apt-cache.8.xml:1
1709 msgid "Caution, dotty cannot graph larger sets of packages."
1712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1713 #: apt-cache.8.xml:1
1715 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1716 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1720 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1721 #: apt-cache.8.xml:1
1722 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1726 #: apt-cache.8.xml:1
1728 "<literal>policy</literal> is meant to help debug issues relating to the "
1729 "preferences file. With no arguments it will print out the priorities of each "
1730 "source. Otherwise it prints out detailed information about the priority "
1731 "selection of the named package."
1734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1735 #: apt-cache.8.xml:1
1737 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1738 "to mimic the output format and a subset of the functionality of the Debian "
1739 "archive management tool, <literal>madison</literal>. It displays available "
1740 "versions of a package in a tabular format. Unlike the original "
1741 "<literal>madison</literal>, it can only display information for the "
1742 "architecture for which APT has retrieved package lists "
1743 "(<literal>APT::Architecture</literal>)."
1746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1747 #: apt-cache.8.xml:1
1749 "Select the file to store the package cache. The package cache is the primary "
1750 "cache used by all operations. Configuration Item: "
1751 "<literal>Dir::Cache::pkgcache</literal>."
1754 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1755 #: apt-cache.8.xml:1
1757 "Select the file to store the source cache. The source is used only by "
1758 "<literal>gencaches</literal> and it stores a parsed version of the package "
1759 "information from remote sources. When building the package cache the source "
1760 "cache is used to avoid reparsing all of the package files. Configuration "
1761 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1764 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1765 #: apt-cache.8.xml:1
1767 "Quiet; produces output suitable for logging, omitting progress indicators. "
1768 "More q's will produce more quietness up to a maximum of 2. You can also use "
1769 "<option>-q=#</option> to set the quietness level, overriding the "
1770 "configuration file. Configuration Item: <literal>quiet</literal>."
1773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1774 #: apt-cache.8.xml:1
1776 "Print only important dependencies; for use with <literal>unmet</literal> and "
1777 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1778 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1781 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1782 #: apt-cache.8.xml:1
1784 "Per default the <command>depends</command> and <command>rdepends</command> "
1785 "print all dependencies. This can be tweaked with these flags which will omit "
1786 "the specified dependency type. Configuration Item: "
1787 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1788 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1791 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1792 #: apt-cache.8.xml:1
1794 "Per default <command>depends</command> and <command>rdepends</command> print "
1795 "only dependencies explicitly expressed in the metadata. With this flag it "
1796 "will also show dependencies implicitely added based on the encountered "
1797 "data. A <literal>Conflicts: foo</literal> e.g. expresses implicitely that "
1798 "this package also conflicts with the package foo from any other "
1799 "architecture. Configuration Item: "
1800 "<literal>APT::Cache::ShowImplicit</literal>."
1803 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1804 #: apt-cache.8.xml:1
1806 "Print full package records when searching. Configuration Item: "
1807 "<literal>APT::Cache::ShowFull</literal>."
1810 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1811 #: apt-cache.8.xml:1
1813 "Print full records for all available versions. This is the default; to turn "
1814 "it off, use <option>--no-all-versions</option>. If "
1815 "<option>--no-all-versions</option> is specified, only the candidate version "
1816 "will be displayed (the one which would be selected for installation). This "
1817 "option is only applicable to the <literal>show</literal> command. "
1818 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1821 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1822 #: apt-cache.8.xml:1
1824 "Perform automatic package cache regeneration, rather than use the cache as "
1825 "it is. This is the default; to turn it off, use "
1826 "<option>--no-generate</option>. Configuration Item: "
1827 "<literal>APT::Cache::Generate</literal>."
1830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1831 #: apt-cache.8.xml:1
1833 "Only search on the package and provided package names, not the long "
1834 "descriptions. Configuration Item: <literal>APT::Cache::NamesOnly</literal>."
1837 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1838 #: apt-cache.8.xml:1
1840 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1841 "and missing dependencies. Configuration Item: "
1842 "<literal>APT::Cache::AllNames</literal>."
1845 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1846 #: apt-cache.8.xml:1
1848 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1849 "that all packages mentioned are printed once. Configuration Item: "
1850 "<literal>APT::Cache::RecurseDepends</literal>."
1853 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1854 #: apt-cache.8.xml:1
1856 "Limit the output of <literal>depends</literal> and "
1857 "<literal>rdepends</literal> to packages which are currently installed. "
1858 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1861 #. type: Content of: <refentry><refsect1><para>
1862 #: apt-cache.8.xml:1
1863 msgid "&apt-conf;, &sources-list;, &apt-get;"
1866 #. type: Content of: <refentry><refsect1><para>
1867 #: apt-cache.8.xml:1
1869 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1873 #. type: Content of: <refentry><refnamediv><refpurpose>
1875 msgid "APT key management utility"
1878 #. type: Content of: <refentry><refsect1><para>
1881 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1882 "authenticate packages. Packages which have been authenticated using these "
1883 "keys will be considered trusted."
1886 #. type: Content of: <refentry><refsect1><title>
1891 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1894 "Add a new key to the list of trusted keys. The key is read from the "
1895 "filename given with the parameter &synopsis-param-filename; or if the "
1896 "filename is <literal>-</literal> from standard input."
1899 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1902 "It is critical that keys added manually via <command>apt-key</command> are "
1903 "verified to belong to the owner of the repositories they claim to be for "
1904 "otherwise the &apt-secure; infrastructure is completely undermined."
1907 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1909 msgid "Remove a key from the list of trusted keys."
1912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1914 msgid "Output the key &synopsis-param-keyid; to standard output."
1917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1919 msgid "Output all trusted keys to standard output."
1922 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1924 msgid "List trusted keys."
1927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1929 msgid "List fingerprints of trusted keys."
1932 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1935 "Pass advanced options to gpg. With <command>adv --recv-key</command> you can "
1936 "e.g. download key from keyservers directly into the the trusted set of "
1937 "keys. Note that there are <emphasis>no</emphasis> checks performed, so it is "
1938 "easy to completely undermine the &apt-secure; infrastructure if used without "
1942 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1945 "Update the local keyring with the archive keyring and remove from the local "
1946 "keyring the archive keys which are no longer valid. The archive keyring is "
1947 "shipped in the <literal>archive-keyring</literal> package of your "
1948 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
1951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1954 "Perform an update working similarly to the <command>update</command> command "
1955 "above, but get the archive keyring from a URI instead and validate it "
1956 "against a master key. This requires an installed &wget; and an APT build "
1957 "configured to have a server to fetch from and a master keyring to validate. "
1958 "APT in Debian does not support this command, relying on "
1959 "<command>update</command> instead, but Ubuntu's APT does."
1962 #. type: Content of: <refentry><refsect1><title>
1963 #: apt-key.8.xml:1 apt-mark.8.xml:1 apt-mark.8.xml:1 apt-cdrom.8.xml:1
1967 #. type: Content of: <refentry><refsect1><para>
1970 "Note that options need to be defined before the commands described in the "
1974 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1977 "With this option it is possible to specify a particular keyring file the "
1978 "command should operate on. The default is that a command is executed on the "
1979 "<filename>trusted.gpg</filename> file as well as on all parts in the "
1980 "<filename>trusted.gpg.d</filename> directory, though "
1981 "<filename>trusted.gpg</filename> is the primary keyring which means that "
1982 "e.g. new keys are added to this one."
1985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1987 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
1990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1992 msgid "Local trust database of archive keys."
1995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1997 msgid "&keyring-filename;"
2000 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2002 msgid "Keyring of &keyring-distro; archive trusted keys."
2005 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2007 msgid "&keyring-removed-filename;"
2010 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2012 msgid "Keyring of &keyring-distro; archive removed trusted keys."
2015 #. type: Content of: <refentry><refsect1><para>
2017 msgid "&apt-get;, &apt-secure;"
2020 #. type: Content of: <refentry><refnamediv><refpurpose>
2022 msgid "show, set and unset various settings for a package"
2025 #. type: Content of: <refentry><refsect1><para>
2028 "<command>apt-mark</command> can be used as a unified frontend to set various "
2029 "settings for a package like marking a package as being "
2030 "automatically/manually installed or changing <command>dpkg</command> "
2031 "selections such as hold, install, deinstall and purge which are respected "
2032 "e.g. by <command>apt-get dselect-upgrade</command> or "
2033 "<command>aptitude</command>."
2036 #. type: Content of: <refentry><refsect1><title>
2038 msgid "Automatically and manually installed packages"
2041 #. type: Content of: <refentry><refsect1><para>
2044 "When you request that a package is installed, and as a result other packages "
2045 "are installed to satisfy its dependencies, the dependencies are marked as "
2046 "being automatically installed, while package you installed explicitely is "
2047 "marked as manually installed. Once a automatically installed package is no "
2048 "longer depended on by any manually installed package it is considered no "
2049 "longer needed and e.g. <command>apt-get</command> or "
2050 "<command>aptitude</command> will at least suggest removing them."
2053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2056 "<literal>auto</literal> is used to mark a package as being automatically "
2057 "installed, which will cause the package to be removed when no more manually "
2058 "installed packages depend on this package."
2061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2064 "<literal>manual</literal> is used to mark a package as being manually "
2065 "installed, which will prevent the package from being automatically removed "
2066 "if no other packages depend on it."
2069 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2072 "<literal>showauto</literal> is used to print a list of automatically "
2073 "installed packages with each package on a new line. All automatically "
2074 "installed packages will be listed if no package is given. If packages are "
2075 "given only those which are automatically installed will be shown."
2078 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2081 "<literal>showmanual</literal> can be used in the same way as "
2082 "<literal>showauto</literal> except that it will print a list of manually "
2083 "installed packages instead."
2086 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2089 "Read/Write package stats from the filename given with the parameter "
2090 "&synopsis-param-filename; instead of from the default location, which is "
2091 "<filename>extended_status</filename> in the directory defined by the "
2092 "Configuration Item: <literal>Dir::State</literal>."
2095 #. type: Content of: <refentry><refsect1><title>
2097 msgid "Prevent changes for a package"
2100 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2103 "<literal>hold</literal> is used to mark a package as held back, which will "
2104 "prevent the package from being automatically installed, upgraded or removed."
2107 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2110 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2111 "package to allow all actions again."
2114 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2117 "<literal>showhold</literal> is used to print a list of packages on hold in "
2118 "the same way as for the other show commands."
2121 #. type: Content of: <refentry><refsect1><title>
2123 msgid "Shedule packages for install, remove and purge"
2126 #. type: Content of: <refentry><refsect1><para>
2129 "Some frontends like <command>apt-get dselect-upgrade</command> can be used "
2130 "to apply previously sheduled changes to the install state of packages. Such "
2131 "changes can be sheduled with the <option>install</option>, "
2132 "<option>remove</option> (also known as <option>deinstall</option>) and "
2133 "<option>purge</option> commands. Packages with a specific selection can be "
2134 "displayed with <option>showinstall</option>, <option>showremove</option> and "
2135 "<option>showpurge</option> respectively. More information about these so "
2136 "called dpkg selections can be found in &dpkg;."
2139 #. type: Content of: <refentry><refsect1><para>
2142 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2146 #. type: Content of: <refentry><refnamediv><refpurpose>
2147 #: apt-secure.8.xml:1
2148 msgid "Archive authentication support for APT"
2151 #. type: Content of: <refentry><refsect1><para>
2152 #: apt-secure.8.xml:1
2154 "Starting with version 0.6, <command>APT</command> contains code that does "
2155 "signature checking of the Release file for all repositories. This ensures "
2156 "that data like packages in the archive can't be modified by people who have "
2157 "no access to the Release file signing key."
2160 #. type: Content of: <refentry><refsect1><para>
2161 #: apt-secure.8.xml:1
2163 "If an archive doesn't have a signed Release file or no Release file at all "
2164 "current APT versions will raise a warning in <command>update</command> "
2165 "operations and frontends like <command>apt-get</command> will require "
2166 "explicit confirmation if an installation request includes a package from "
2167 "such an unauthenticated archive."
2170 #. type: Content of: <refentry><refsect1><para>
2171 #: apt-secure.8.xml:1
2173 "In the future APT will refuse to work with unauthenticated repositories by "
2174 "default until support for them is removed entirely. Users have the option to "
2175 "opt-in to this behavior already by setting the configuration option "
2176 "<option>Acquire::AllowInsecureRepositories</option> to "
2177 "<literal>false</literal>."
2180 #. type: Content of: <refentry><refsect1><para>
2181 #: apt-secure.8.xml:1
2183 "Note: All APT-based package management frontends like &apt-get;, &aptitude; "
2184 "and &synaptic; support this authentication feature, so this manpage uses "
2185 "<literal>APT</literal> to refer to them all for simplicity only."
2188 #. type: Content of: <refentry><refsect1><title>
2189 #: apt-secure.8.xml:1
2190 msgid "Trusted repositories"
2193 #. type: Content of: <refentry><refsect1><para>
2194 #: apt-secure.8.xml:1
2196 "The chain of trust from an APT archive to the end user is made up of several "
2197 "steps. <command>apt-secure</command> is the last step in this chain; "
2198 "trusting an archive does not mean that you trust its packages not to contain "
2199 "malicious code, but means that you trust the archive maintainer. It's the "
2200 "archive maintainer's responsibility to ensure that the archive's integrity "
2204 #. type: Content of: <refentry><refsect1><para>
2205 #: apt-secure.8.xml:1
2207 "apt-secure does not review signatures at a package level. If you require "
2208 "tools to do this you should look at <command>debsig-verify</command> and "
2209 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2210 "packages respectively)."
2213 #. type: Content of: <refentry><refsect1><para>
2214 #: apt-secure.8.xml:1
2216 "The chain of trust in Debian e.g. starts when a maintainer uploads a new "
2217 "package or a new version of a package to the Debian archive. In order to "
2218 "become effective, this upload needs to be signed by a key contained in one "
2219 "of the Debian package maintainers keyrings (available in the debian-keyring "
2220 "package). Maintainers' keys are signed by other maintainers following "
2221 "pre-established procedures to ensure the identity of the key holder. Similar "
2222 "procedures exist in all Debian-based distributions."
2225 #. type: Content of: <refentry><refsect1><para>
2226 #: apt-secure.8.xml:1
2228 "Once the uploaded package is verified and included in the archive, the "
2229 "maintainer signature is stripped off, and checksums of the package are "
2230 "computed and put in the Packages file. The checksums of all of the Packages "
2231 "files are then computed and put into the Release file. The Release file is "
2232 "then signed by the archive key for this &keyring-distro; release, and "
2233 "distributed alongside the packages and the Packages files on "
2234 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2235 "keyring available in the &keyring-package; package."
2238 #. type: Content of: <refentry><refsect1><para>
2239 #: apt-secure.8.xml:1
2241 "End users can check the signature of the Release file, extract a checksum of "
2242 "a package from it and compare it with the checksum of the package they "
2243 "downloaded by hand - or rely on APT doing this automatically."
2246 #. type: Content of: <refentry><refsect1><para>
2247 #: apt-secure.8.xml:1
2249 "Notice that this is distinct from checking signatures on a per package "
2250 "basis. It is designed to prevent two possible attacks:"
2253 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2254 #: apt-secure.8.xml:1
2256 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2257 "checking, malicious agents can introduce themselves into the package "
2258 "download process and provide malicious software either by controlling a "
2259 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2260 "server (through ARP or DNS spoofing attacks)."
2263 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2264 #: apt-secure.8.xml:1
2266 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2267 "malicious agent can compromise a mirror host and modify the files in it to "
2268 "propagate malicious software to all users downloading packages from that "
2272 #. type: Content of: <refentry><refsect1><para>
2273 #: apt-secure.8.xml:1
2275 "However, it does not defend against a compromise of the master server itself "
2276 "(which signs the packages) or against a compromise of the key used to sign "
2277 "the Release files. In any case, this mechanism can complement a per-package "
2281 #. type: Content of: <refentry><refsect1><title>
2282 #: apt-secure.8.xml:1
2283 msgid "User configuration"
2286 #. type: Content of: <refentry><refsect1><para>
2287 #: apt-secure.8.xml:1
2289 "<command>apt-key</command> is the program that manages the list of keys used "
2290 "by APT to trust repositories. It can be used to add or remove keys as well "
2291 "as list the trusted keys. Limiting which key(s) are able to sign which "
2292 "archive is possible via the <option>Signed-By</option> in &sources-list;."
2295 #. type: Content of: <refentry><refsect1><para>
2296 #: apt-secure.8.xml:1
2298 "Note that a default installation already contains all keys to securily "
2299 "acquire packages from the default repositories, so fiddling with "
2300 "<command>apt-key</command> is only needed if third-party repositories are "
2304 #. type: Content of: <refentry><refsect1><para>
2305 #: apt-secure.8.xml:1
2307 "In order to add a new key you need to first download it (you should make "
2308 "sure you are using a trusted communication channel when retrieving it), add "
2309 "it with <command>apt-key</command> and then run <command>apt-get "
2310 "update</command> so that apt can download and verify the "
2311 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2312 "from the archives you have configured."
2315 #. type: Content of: <refentry><refsect1><title>
2316 #: apt-secure.8.xml:1
2317 msgid "Archive configuration"
2320 #. type: Content of: <refentry><refsect1><para>
2321 #: apt-secure.8.xml:1
2323 "If you want to provide archive signatures in an archive under your "
2324 "maintenance you have to:"
2327 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2328 #: apt-secure.8.xml:1
2330 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2331 "already. You can do this by running <command>apt-ftparchive "
2332 "release</command> (provided in apt-utils)."
2335 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2336 #: apt-secure.8.xml:1
2338 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2339 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2340 "Release.gpg Release</command>."
2343 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2344 #: apt-secure.8.xml:1
2346 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
2347 "know what key they need to import in order to authenticate the files in the "
2348 "archive. It is best to ship your key in its own keyring package like "
2349 "&keyring-distro; does with &keyring-package; to be able to distribute "
2350 "updates and key transitions automatically later."
2353 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2354 #: apt-secure.8.xml:1
2356 "<emphasis>Provide instructions on how to add your archive and "
2357 "key</emphasis>. If your users can't acquire your key securily the chain of "
2358 "trust described above is broken. How you can help users add your key "
2359 "depends on your archive and target audience ranging from having your keyring "
2360 "package included in another archive users already have configured (like the "
2361 "default repositories of their distribution) to leverage the web of trust."
2364 #. type: Content of: <refentry><refsect1><para>
2365 #: apt-secure.8.xml:1
2367 "Whenever the contents of the archive change (new packages are added or "
2368 "removed) the archive maintainer has to follow the first two steps outlined "
2372 #. type: Content of: <refentry><refsect1><para>
2373 #: apt-secure.8.xml:1
2375 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2376 "&debsign;, &debsig-verify;, &gpg;"
2379 #. type: Content of: <refentry><refsect1><para>
2380 #: apt-secure.8.xml:1
2382 "For more background information you might want to review the <ulink "
2383 "url=\"https://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2384 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
2385 "(available also in the harden-doc package) and the <ulink "
2386 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2387 "Distribution HOWTO</ulink> by V. Alex Brennen."
2390 #. type: Content of: <refentry><refsect1><title>
2391 #: apt-secure.8.xml:1
2392 msgid "Manpage Authors"
2395 #. type: Content of: <refentry><refsect1><para>
2396 #: apt-secure.8.xml:1
2398 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2399 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2402 #. type: Content of: <refentry><refnamediv><refpurpose>
2403 #: apt-cdrom.8.xml:1
2404 msgid "APT CD-ROM management utility"
2407 #. type: Content of: <refentry><refsect1><para>
2408 #: apt-cdrom.8.xml:1
2410 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2411 "available sources. <command>apt-cdrom</command> takes care of determining "
2412 "the structure of the disc as well as correcting for several possible "
2413 "mis-burns and verifying the index files."
2416 #. type: Content of: <refentry><refsect1><para>
2417 #: apt-cdrom.8.xml:1
2419 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2420 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2421 "must be inserted and scanned separately to account for possible mis-burns."
2424 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2425 #: apt-cdrom.8.xml:1
2427 "<literal>add</literal> is used to add a new disc to the source list. It will "
2428 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2429 "to scan it and copy the index files. If the disc does not have a proper "
2430 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2435 #: apt-cdrom.8.xml:1
2437 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2438 "maintains a database of these IDs in "
2439 "<filename>&statedir;/cdroms.list</filename>"
2442 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2443 #: apt-cdrom.8.xml:1
2445 "A debugging tool to report the identity of the current disc as well as the "
2449 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2450 #: apt-cdrom.8.xml:1
2452 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2453 "<option>--cdrom</option> option. Configuration Item: "
2454 "<literal>Acquire::cdrom::AutoDetect</literal>."
2457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2458 #: apt-cdrom.8.xml:1
2460 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2461 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2462 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2466 #: apt-cdrom.8.xml:1
2468 "Rename a disc; change the label of a disc or override the disc's given "
2469 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2470 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2474 #: apt-cdrom.8.xml:1
2476 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2477 "unmounting the mount point. Configuration Item: "
2478 "<literal>APT::CDROM::NoMount</literal>."
2481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2482 #: apt-cdrom.8.xml:1
2484 "Fast Copy; Assume the package files are valid and do not check every "
2485 "package. This option should be used only if <command>apt-cdrom</command> has "
2486 "been run on this disc before and did not detect any errors. Configuration "
2487 "Item: <literal>APT::CDROM::Fast</literal>."
2490 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2491 #: apt-cdrom.8.xml:1
2493 "Thorough Package Scan; This option may be needed with some old Debian "
2494 "1.1/1.2 discs that have Package files in strange places. It takes much "
2495 "longer to scan the CD but will pick them all up."
2498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2499 #: apt-cdrom.8.xml:1
2501 "No Changes; Do not change the &sources-list; file and do not write index "
2502 "files. Everything is still checked however. Configuration Item: "
2503 "<literal>APT::CDROM::NoAct</literal>."
2506 #. type: Content of: <refentry><refsect1><para>
2507 #: apt-cdrom.8.xml:1
2508 msgid "&apt-conf;, &apt-get;, &sources-list;"
2511 #. type: Content of: <refentry><refsect1><para>
2512 #: apt-cdrom.8.xml:1
2514 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2518 #. type: Content of: <refentry><refnamediv><refpurpose>
2519 #: apt-config.8.xml:1
2520 msgid "APT Configuration Query program"
2523 #. type: Content of: <refentry><refsect1><para>
2524 #: apt-config.8.xml:1
2526 "<command>apt-config</command> is an internal program used by various "
2527 "portions of the APT suite to provide consistent configurability. It accesses "
2528 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2529 "manner that is easy to use for scripted applications."
2532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2533 #: apt-config.8.xml:1
2535 "shell is used to access the configuration information from a shell "
2536 "script. It is given pairs of arguments, the first being a shell variable and "
2537 "the second the configuration value to query. As output it lists shell "
2538 "assignment commands for each value present. In a shell script it should be "
2542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2543 #: apt-config.8.xml:1
2547 "RES=`apt-config shell OPTS MyApp::options`\n"
2551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2552 #: apt-config.8.xml:1
2554 "This will set the shell environment variable $OPTS to the value of "
2555 "MyApp::options with a default of <option>-f</option>."
2558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2559 #: apt-config.8.xml:1
2561 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2562 "names, d returns directories, b returns true or false and i returns an "
2563 "integer. Each of the returns is normalized and verified internally."
2566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2567 #: apt-config.8.xml:1
2568 msgid "Just show the contents of the configuration space."
2571 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2572 #: apt-config.8.xml:1
2574 "Include options which have an empty value. This is the default, so use "
2575 "--no-empty to remove them from the output."
2578 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2579 #: apt-config.8.xml:1
2580 msgid "%f "%v";%n"
2583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2584 #: apt-config.8.xml:1
2586 "Defines the output of each config option. %t will be replaced with "
2587 "its individual name, %f with its full hierarchical name and %v "
2588 "with its value. Use uppercase letters and special characters in the value "
2589 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2590 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2591 "and %N by a tab. A % can be printed by using %%."
2594 #. type: Content of: <refentry><refsect1><para>
2595 #: apt-config.8.xml:1 apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1
2596 #: apt-ftparchive.1.xml:1
2600 #. type: Content of: <refentry><refsect1><para>
2601 #: apt-config.8.xml:1
2603 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2607 #. type: Content of: <refentry><refentryinfo><author><contrib>
2609 msgid "Initial documentation of Debug::*."
2612 #. type: Content of: <refentry><refentryinfo><author><email>
2614 msgid "dburrows@debian.org"
2617 #. type: Content of: <refentry><refmeta><manvolnum>
2618 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
2622 #. type: Content of: <refentry><refnamediv><refpurpose>
2624 msgid "Configuration file for APT"
2627 #. type: Content of: <refentry><refsect1><para>
2630 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2631 "by all the tools in the APT suite of tools, though it is by no means the "
2632 "only place options can be set. The suite also shares a common command line "
2633 "parser to provide a uniform environment."
2636 #. type: Content of: <refentry><refsect1><orderedlist><para>
2639 "When an APT tool starts up it will read the configuration files in the "
2643 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2646 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2650 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2653 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2654 "order which have either no or \"<literal>conf</literal>\" as filename "
2655 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2656 "and period (.) characters. Otherwise APT will print a notice that it has "
2657 "ignored a file, unless that file matches a pattern in the "
2658 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2659 "case it will be silently ignored."
2662 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2664 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2667 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2670 "all options set in the binary specific configuration subtree are moved into "
2671 "the root of the tree."
2674 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2677 "the command line options are applied to override the configuration "
2678 "directives or to load even more configuration files."
2681 #. type: Content of: <refentry><refsect1><title>
2686 #. type: Content of: <refentry><refsect1><para>
2689 "The configuration file is organized in a tree with options organized into "
2690 "functional groups. Option specification is given with a double colon "
2691 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2692 "within the APT tool group, for the Get tool. Options do not inherit from "
2693 "their parent groups."
2696 #. type: Content of: <refentry><refsect1><para>
2699 "Syntactically the configuration language is modeled after what the ISC tools "
2700 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2701 "treated as comments (ignored), as well as all text between "
2702 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2703 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2704 "The quotation marks and trailing semicolon are required. The value must be "
2705 "on one line, and there is no kind of string concatenation. Values must not "
2706 "include backslashes or extra quotation marks. Option names are made up of "
2707 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2708 "opened with curly braces, like this:"
2711 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2717 " Assume-Yes \"true\";\n"
2718 " Fix-Broken \"true\";\n"
2723 #. type: Content of: <refentry><refsect1><para>
2726 "with newlines placed to make it more readable. Lists can be created by "
2727 "opening a scope and including a single string enclosed in quotes followed by "
2728 "a semicolon. Multiple entries can be included, separated by a semicolon."
2731 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2734 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2737 #. type: Content of: <refentry><refsect1><para>
2740 "In general the sample configuration file &configureindex; is a good guide "
2741 "for how it should look."
2744 #. type: Content of: <refentry><refsect1><para>
2747 "Case is not significant in names of configuration items, so in the previous "
2748 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2751 #. type: Content of: <refentry><refsect1><para>
2754 "Names for the configuration items are optional if a list is defined as can "
2755 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2756 "you don't specify a name a new entry will simply add a new option to the "
2757 "list. If you specify a name you can override the option in the same way as "
2758 "any other option by reassigning a new value to the option."
2761 #. type: Content of: <refentry><refsect1><para>
2764 "Two special commands are defined: <literal>#include</literal> (which is "
2765 "deprecated and not supported by alternative implementations) and "
2766 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2767 "given file, unless the filename ends in a slash, in which case the whole "
2768 "directory is included. <literal>#clear</literal> is used to erase a part of "
2769 "the configuration tree. The specified element and all its descendants are "
2770 "erased. (Note that these lines also need to end with a semicolon.)"
2773 #. type: Content of: <refentry><refsect1><para>
2776 "The <literal>#clear</literal> command is the only way to delete a list or a "
2777 "complete scope. Reopening a scope (or using the syntax described below with "
2778 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2779 "previously written entries. Options can only be overridden by addressing a "
2780 "new value to them - lists and scopes can't be overridden, only cleared."
2783 #. type: Content of: <refentry><refsect1><para>
2786 "All of the APT tools take an -o option which allows an arbitrary "
2787 "configuration directive to be specified on the command line. The syntax is a "
2788 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2789 "followed by an equals sign then the new value of the option. To append a new "
2790 "element to a list, add a trailing <literal>::</literal> to the name of the "
2791 "list. (As you might suspect, the scope syntax can't be used on the command "
2795 #. type: Content of: <refentry><refsect1><para>
2798 "Note that appending items to a list using <literal>::</literal> only works "
2799 "for one item per line, and that you should not use it in combination with "
2800 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2801 "syntaxes together will trigger a bug which some users unfortunately depend "
2802 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2803 "like every other option with a name. This introduces many problems; for one "
2804 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2805 "syntax in the hope of appending to a list will achieve the opposite, as only "
2806 "the last assignment for this option \"<literal>::</literal>\" will be "
2807 "used. Future versions of APT will raise errors and stop working if they "
2808 "encounter this misuse, so please correct such statements now while APT "
2809 "doesn't explicitly complain about them."
2812 #. type: Content of: <refentry><refsect1><title>
2814 msgid "The APT Group"
2817 #. type: Content of: <refentry><refsect1><para>
2820 "This group of options controls general APT behavior as well as holding the "
2821 "options for all of the tools."
2824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2827 "System Architecture; sets the architecture to use when fetching files and "
2828 "parsing package lists. The internal default is the architecture apt was "
2832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2835 "All Architectures the system supports. For instance, CPUs implementing the "
2836 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2837 "instruction set are also able to execute binaries compiled for the "
2838 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2839 "is used when fetching files and parsing package lists. The initial default "
2840 "is always the system's native architecture "
2841 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2842 "to the default list when they are registered via <command>dpkg "
2843 "--add-architecture</command>."
2846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2849 "List of all build profiles enabled for build-dependency resolution, without "
2850 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2851 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2852 "&dpkg-buildpackage; overrides the list notation."
2855 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2858 "Default release to install packages from if more than one version is "
2859 "available. Contains release name, codename or release version. Examples: "
2860 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
2861 "'4.0', '5.0*'. See also &apt-preferences;."
2864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2867 "Ignore held packages; this global option causes the problem resolver to "
2868 "ignore held packages in its decision making."
2871 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2874 "Defaults to on. When turned on the autoclean feature will remove any "
2875 "packages which can no longer be downloaded from the cache. If turned off "
2876 "then packages that are locally installed are also excluded from cleaning - "
2877 "but note that APT provides no direct means to reinstall them."
2880 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2883 "Defaults to on, which will cause APT to install essential and important "
2884 "packages as soon as possible in an install/upgrade operation, in order to "
2885 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2886 "treats an important package in the same way as an extra package: between the "
2887 "unpacking of the package A and its configuration there can be many other "
2888 "unpack or configuration calls for other unrelated packages B, C etc. If "
2889 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2890 "scripts generate an error), this results in a system state in which package "
2891 "A is unpacked but unconfigured - so any package depending on A is now no "
2892 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2895 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2898 "The immediate configuration marker is also applied in the potentially "
2899 "problematic case of circular dependencies, since a dependency with the "
2900 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
2901 "to recognise a situation in which it is unable to perform immediate "
2902 "configuration, abort, and suggest to the user that the option should be "
2903 "temporarily deactivated in order to allow the operation to proceed. Note "
2904 "the use of the word \"theory\" here; in the real world this problem has "
2905 "rarely been encountered, in non-stable distribution versions, and was caused "
2906 "by wrong dependencies of the package in question or by a system in an "
2907 "already broken state; so you should not blindly disable this option, as the "
2908 "scenario mentioned above is not the only problem it can help to prevent in "
2912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2915 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
2916 "option disabled you should try to explicitly <literal>install</literal> the "
2917 "package APT is unable to configure immediately; but please make sure you "
2918 "also report your problem to your distribution and to the APT team with the "
2919 "buglink below, so they can work on improving or correcting the upgrade "
2923 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2926 "Never enable this option unless you <emphasis>really</emphasis> know what "
2927 "you are doing. It permits APT to temporarily remove an essential package to "
2928 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
2929 "essential packages. <emphasis>Such a loop should never exist and is a grave "
2930 "bug</emphasis>. This option will work if the essential packages are not "
2931 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
2932 "<command>dpkg</command>, <command>dash</command> or anything that those "
2933 "packages depend on."
2936 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2939 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
2940 "the available information. <literal>Cache-Start</literal> acts as a hint of "
2941 "the size the cache will grow to, and is therefore the amount of memory APT "
2942 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
2943 "that this amount of space needs to be available for APT; otherwise it will "
2944 "likely fail ungracefully, so for memory restricted devices this value should "
2945 "be lowered while on systems with a lot of configured sources it should be "
2946 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
2947 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
2948 "the space defined by <literal>Cache-Start</literal> is not enough. This "
2949 "value will be applied again and again until either the cache is big enough "
2950 "to store all information or the size of the cache reaches the "
2951 "<literal>Cache-Limit</literal>. The default of "
2952 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
2953 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
2957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2959 msgid "Defines which packages are considered essential build dependencies."
2962 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2965 "The Get subsection controls the &apt-get; tool; please see its documentation "
2966 "for more information about the options here."
2969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2972 "The Cache subsection controls the &apt-cache; tool; please see its "
2973 "documentation for more information about the options here."
2976 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2979 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
2980 "documentation for more information about the options here."
2983 #. type: Content of: <refentry><refsect1><title>
2985 msgid "The Acquire Group"
2988 #. type: Content of: <refentry><refsect1><para>
2991 "The <literal>Acquire</literal> group of options controls the download of "
2992 "packages as well as the various \"acquire methods\" responsible for the "
2993 "download itself (see also &sources-list;)."
2996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2999 "Security related option defaulting to true, as giving a Release file's "
3000 "validation an expiration date prevents replay attacks over a long timescale, "
3001 "and can also for example help users to identify mirrors that are no longer "
3002 "updated - but the feature depends on the correctness of the clock on the "
3003 "user system. Archive maintainers are encouraged to create Release files with "
3004 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
3005 "value is desired the <literal>Max-ValidTime</literal> option below can be "
3006 "used. The <option>Check-Valid-Until</option> option of &sources-list; "
3007 "entries should be preferred to disable the check selectively instead of "
3008 "using this global override."
3011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3014 "Maximum time (in seconds) after its creation (as indicated by the "
3015 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3016 "should be considered valid. If the Release file itself includes a "
3017 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
3018 "the expiration date. The default value is <literal>0</literal> which stands "
3019 "for \"valid forever\". Archive specific settings can be made by appending "
3020 "the label of the archive to the option name. Preferably, the same can be "
3021 "achieved for specific &sources-list; entries by using the "
3022 "<option>Valid-Until-Max</option> option there."
3025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3028 "Minimum time (in seconds) after its creation (as indicated by the "
3029 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3030 "should be considered valid. Use this if you need to use a seldom updated "
3031 "(local) mirror of a more frequently updated archive with a "
3032 "<literal>Valid-Until</literal> header instead of completely disabling the "
3033 "expiration date checking. Archive specific settings can and should be used "
3034 "by appending the label of the archive to the option name. Preferably, the "
3035 "same can be achieved for specific &sources-list; entries by using the "
3036 "<option>Valid-Until-Min</option> option there."
3039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3042 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
3043 "<filename>Packages</filename> files) instead of downloading whole ones. True "
3044 "by default. Preferably, this can be set for specific &sources-list; entries "
3045 "or index files by using the <option>PDiffs</option> option there."
3048 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3051 "Two sub-options to limit the use of PDiffs are also available: "
3052 "<literal>FileLimit</literal> can be used to specify a maximum number of "
3053 "PDiff files should be downloaded to update a "
3054 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
3055 "percentage of the size of all patches compared to the size of the targeted "
3056 "file. If one of these limits is exceeded the complete file is downloaded "
3057 "instead of the patches."
3060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3063 "Try to download indexes via an URI constructed from a hashsum of the "
3064 "expected file rather than downloaded via a well-known stable filename. True "
3065 "by default, but automatically disabled if the source indicates no support "
3066 "for it. Usage can be forced with the special value \"force\". Preferably, "
3067 "this can be set for specific &sources-list; entries or index files by using "
3068 "the <option>By-Hash</option> option there."
3071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3074 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3075 "<literal>host</literal> or <literal>access</literal> which determines how "
3076 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3077 "one connection per target host will be opened, <literal>access</literal> "
3078 "means that one connection per URI type will be opened."
3081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3084 "Number of retries to perform. If this is non-zero APT will retry failed "
3085 "files the given number of times."
3088 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3091 "Use symlinks for source archives. If set to true then source archives will "
3092 "be symlinked when possible instead of copying. True is the default."
3095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3098 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
3099 "URIs. It is in the standard form of "
3100 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
3101 "can also be specified by using the form "
3102 "<literal>http::Proxy::<host></literal> with the special keyword "
3103 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3104 "settings is specified, <envar>http_proxy</envar> environment variable will "
3108 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3111 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3112 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
3113 "response under any circumstances. <literal>Max-Age</literal> sets the "
3114 "allowed maximum age (in seconds) of an index file in the cache of the "
3115 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
3116 "store the requested archive files in its cache, which can be used to prevent "
3117 "the proxy from polluting its cache with (big) .deb files."
3120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3121 #: apt.conf.5.xml:1 apt.conf.5.xml:1
3123 "The option <literal>timeout</literal> sets the timeout timer used by the "
3124 "method; this value applies to the connection as well as the data timeout."
3127 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3130 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3131 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
3132 "e.g. on high-latency connections. It specifies how many requests are sent in "
3133 "a pipeline. APT tries to detect and workaround misbehaving webservers and "
3134 "proxies at runtime, but if you know that yours does not conform to the "
3135 "HTTP/1.1 specification pipelining can be disabled by setting the value to "
3136 "0. It is enabled by default with the value 10."
3139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3142 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
3143 "follow redirects, which is enabled by default."
3146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3149 "The used bandwidth can be limited with "
3150 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3151 "kilobytes per second. The default value is 0 which deactivates the limit and "
3152 "tries to use all available bandwidth. Note that this option implicitly "
3153 "disables downloading from multiple servers at the same time."
3156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3159 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3160 "User-Agent for the http download method as some proxies allow access for "
3161 "clients only if the client uses a known identifier."
3164 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3167 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
3168 "an external command to discover the http proxy to use. Apt expects the "
3169 "command to output the proxy on stdout in the style "
3170 "<literal>http://proxy:port/</literal>. This will override the generic "
3171 "<literal>Acquire::http::Proxy</literal> but not any specific host proxy "
3172 "configuration set via <literal>Acquire::http::Proxy::$HOST</literal>. See "
3173 "the &squid-deb-proxy-client; package for an example implementation that uses "
3174 "avahi. This option takes precedence over the legacy option name "
3175 "<literal>ProxyAutoDetect</literal>."
3178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3181 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
3182 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
3183 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
3184 "the <literal>http</literal> method, and default to the same values if they "
3185 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
3189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3192 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3193 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
3194 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3195 "suboption determines whether or not the server's host certificate should be "
3196 "verified against trusted certificates. "
3197 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
3198 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
3199 "or not the server's hostname should be verified. "
3200 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
3201 "option. <literal>SslCert</literal> determines what certificate to use for "
3202 "client authentication. <literal><host>::SslCert</literal> is the "
3203 "corresponding per-host option. <literal>SslKey</literal> determines what "
3204 "private key to use for client "
3205 "authentication. <literal><host>::SslKey</literal> is the corresponding "
3206 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3207 "version to use. It can contain either of the strings "
3208 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
3209 "<literal><host>::SslForceVersion</literal> is the corresponding "
3213 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3216 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
3217 "It is in the standard form of "
3218 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
3219 "also be specified by using the form "
3220 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3221 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3222 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3223 "used. To use an FTP proxy you will have to set the "
3224 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3225 "entry specifies the commands to send to tell the proxy server what to "
3226 "connect to. Please see &configureindex; for an example of how to do "
3227 "this. The substitution variables representing the corresponding URI "
3228 "component are <literal>$(PROXY_USER)</literal>, "
3229 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
3230 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
3231 "<literal>$(SITE_PORT)</literal>."
3234 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3237 "Several settings are provided to control passive mode. Generally it is safe "
3238 "to leave passive mode on; it works in nearly every environment. However, "
3239 "some situations require that passive mode be disabled and port mode FTP used "
3240 "instead. This can be done globally or for connections that go through a "
3241 "proxy or for a specific host (see the sample config file for examples)."
3244 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3247 "It is possible to proxy FTP over HTTP by setting the "
3248 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3249 "discussion of the http method above for syntax. You cannot set this in the "
3250 "configuration file and it is not recommended to use FTP over HTTP due to its "
3254 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3257 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3258 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3259 "false, which means these commands are only used if the control connection is "
3260 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3261 "that most FTP servers do not support RFC2428."
3264 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3267 msgid "/cdrom/::Mount \"foo\";"
3270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3273 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3274 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3275 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3276 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3277 "and unmount commands if your mount point cannot be listed in the fstab. The "
3278 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3279 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3280 "Unmount commands can be specified using UMount."
3283 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3286 "For GPGV URIs the only configurable option is "
3287 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3291 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3295 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3296 "\"<replaceable>Methodname</replaceable>\";"
3299 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3302 "List of compression types which are understood by the acquire methods. "
3303 "Files like <filename>Packages</filename> can be available in various "
3304 "compression formats. By default the acquire methods can decompress "
3305 "<command>bzip2</command>, <command>lzma</command> and "
3306 "<command>gzip</command> compressed files; with this setting more formats can "
3307 "be added on the fly or the used method can be changed. The syntax for this "
3308 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3311 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3314 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3320 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3323 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3326 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3327 "order the acquire system will try to download the compressed files. The "
3328 "acquire system will try the first and proceed with the next compression type "
3329 "in this list on error, so to prefer one over the other type simply add the "
3330 "preferred type first - default types not already added will be implicitly "
3331 "appended to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3332 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3333 "over <command>bzip2</command> and <command>lzma</command>. If "
3334 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3335 "<command>bzip2</command> the configure setting should look like this: "
3336 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3337 "<literal>bz2</literal> to the list explicitly as it will be added "
3341 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3344 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3347 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3351 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3352 "checked at run time. If this option has been set, the method will only be "
3353 "used if this file exists; e.g. for the <literal>bzip2</literal> method (the "
3354 "inbuilt) setting is: <placeholder type=\"literallayout\" id=\"0\"/> Note "
3355 "also that list entries specified on the command line will be added at the "
3356 "end of the list specified in the configuration files, but before the default "
3357 "entries. To prefer a type in this case over the ones specified in the "
3358 "configuration files you can set the option direct - not in list style. This "
3359 "will not override the defined list; it will only prefix the list with this "
3363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3366 "The special type <literal>uncompressed</literal> can be used to give "
3367 "uncompressed files a preference, but note that most archives don't provide "
3368 "uncompressed files so this is mostly only useable for local mirrors."
3371 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3374 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3375 "Sources, or Translations), keep them gzip compressed locally instead of "
3376 "unpacking them. This saves quite a lot of disk space at the expense of more "
3377 "CPU requirements when building the local package caches. False by default."
3380 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3383 "The Languages subsection controls which <filename>Translation</filename> "
3384 "files are downloaded and in which order APT tries to display the "
3385 "description-translations. APT will try to display the first available "
3386 "description in the language which is listed first. Languages can be defined "
3387 "with their short or long language codes. Note that not all archives provide "
3388 "<filename>Translation</filename> files for every language - the long "
3389 "language codes are especially rare."
3392 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3395 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3398 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3401 "The default list includes \"environment\" and "
3402 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3403 "will be replaced at runtime with the language codes extracted from the "
3404 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3405 "that these codes are not included twice in the list. If "
3406 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3407 "<filename>Translation-en</filename> file (if available) will be used. To "
3408 "force APT to use no Translation file use the setting "
3409 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3410 "another special meaning code which will stop the search for a suitable "
3411 "<filename>Translation</filename> file. This tells APT to download these "
3412 "translations too, without actually using them unless the environment "
3413 "specifies the languages. So the following example configuration will result "
3414 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3415 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3416 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3417 "type=\"programlisting\" id=\"0\"/>"
3420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3423 "Note: To prevent problems resulting from APT being executed in different "
3424 "environments (e.g. by different users or by other programs) all Translation "
3425 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3426 "added to the end of the list (after an implicit "
3427 "\"<literal>none</literal>\")."
3430 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3432 msgid "When downloading, force to use only the IPv4 protocol."
3435 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3437 msgid "When downloading, force to use only the IPv6 protocol."
3440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3443 "The maximum file size of Release/Release.gpg/InRelease files. The default "
3447 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3450 "This option controls if apt will use the DNS SRV server record as specified "
3451 "in RFC 2782 to select an alternative server to connect to. The default is "
3455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3458 "Allow the update operation to load data files from a repository without a "
3459 "trusted signature. If enabled this option no data files will be loaded and "
3460 "the update operation fails with a error for this source. The default is "
3461 "false for backward compatibility. This will be changed in the future."
3464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3467 "Allow that a repository that was previously gpg signed to become unsigned "
3468 "durign a update operation. When there is no valid signature of a perviously "
3469 "trusted repository apt will refuse the update. This option can be used to "
3470 "override this protection. You almost certainly never want to enable "
3471 "this. The default is false. Note that apt will still consider packages from "
3472 "this source untrusted and warn about them if you try to install them."
3475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3483 "Acquiring changelogs can only be done if an URI is known from where to get "
3484 "them. Preferable the Release file indicates this in a 'Changelogs' "
3485 "field. If this isn't available the Label/Origin field of the Release file is "
3486 "used to check if a "
3487 "<literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> "
3489 "<literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> "
3490 "option exists and if so this value is taken. The value in the Release file "
3491 "can be overridden with "
3492 "<literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal> "
3494 "<literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>. "
3495 "The value should be a normal URI to a text file, expect that package "
3496 "specific data is replaced with the placeholder "
3497 "<literal>CHANGEPATH</literal>. The value for it is: 1. if the package is "
3498 "from a component (e.g. <literal>main</literal>) this is the first part "
3499 "otherwise it is omitted, 2. the first letter of source package name, expect "
3500 "if the source package name starts with '<literal>lib</literal>' in which "
3501 "case it will be the first four letters. 3. The complete source package "
3502 "name. 4. the complete name again and 5. the source version. The first (if "
3503 "present), second, third and fourth part are separated by a slash "
3504 "('<literal>/</literal>') and between the fourth and fifth part is an "
3505 "underscore ('<literal>_</literal>'). The special value "
3506 "'<literal>no</literal>' is available for this option indicating that this "
3507 "source can't be used to acquire changelog files from. Another source will be "
3508 "tried if available in this case."
3511 #. type: Content of: <refentry><refsect1><title>
3513 msgid "Binary specific configuration"
3516 #. type: Content of: <refentry><refsect1><para>
3519 "Especially with the introduction of the <command>apt</command> binary it can "
3520 "be useful to set certain options only for a specific binary as even options "
3521 "which look like they would effect only a certain binary like "
3522 "<option>APT::Get::Show-Versions</option> effect <command>apt-get</command> "
3523 "as well as <command>apt</command>."
3526 #. type: Content of: <refentry><refsect1><para>
3529 "Setting an option for a specific binary only can be achieved by setting the "
3530 "option inside the "
3531 "<option>Binary::<replaceable>specific-binary</replaceable></option> "
3532 "scope. Setting the option <option>APT::Get::Show-Versions</option> for the "
3533 "<command>apt</command> only can e.g. by done by setting "
3534 "<option>Binary::apt::APT::Get::Show-Versions</option> instead."
3537 #. type: Content of: <refentry><refsect1><para>
3540 "Note that as seen in the DESCRIPTION section further above you can't set "
3541 "binary-specific options on the commandline itself nor in configuration files "
3542 "loaded via the commandline."
3545 #. type: Content of: <refentry><refsect1><title>
3550 #. type: Content of: <refentry><refsect1><para>
3553 "The <literal>Dir::State</literal> section has directories that pertain to "
3554 "local state information. <literal>lists</literal> is the directory to place "
3555 "downloaded package lists in and <literal>status</literal> is the name of the "
3556 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3557 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3558 "contains the default directory to prefix on all sub-items if they do not "
3559 "start with <filename>/</filename> or <filename>./</filename>."
3562 #. type: Content of: <refentry><refsect1><para>
3565 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3566 "information, such as the two package caches <literal>srcpkgcache</literal> "
3567 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3568 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3569 "be turned off by setting <literal>pkgcache</literal> or "
3570 "<literal>srcpkgcache</literal> to <literal>\"\"</literal>. This will slow "
3571 "down startup but save disk space. It is probably preferable to turn off the "
3572 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> "
3573 "the default directory is contained in <literal>Dir::Cache</literal>"
3576 #. type: Content of: <refentry><refsect1><para>
3579 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3580 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3581 "<literal>main</literal> is the default configuration file (setting has no "
3582 "effect, unless it is done from the config file specified by "
3583 "<envar>APT_CONFIG</envar>)."
3586 #. type: Content of: <refentry><refsect1><para>
3589 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3590 "in lexical order from the directory specified. After this is done then the "
3591 "main config file is loaded."
3594 #. type: Content of: <refentry><refsect1><para>
3597 "Binary programs are pointed to by "
3598 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3599 "the location of the method handlers and <literal>gzip</literal>, "
3600 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3601 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3602 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3603 "specify the location of the respective programs."
3606 #. type: Content of: <refentry><refsect1><para>
3609 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3610 "set, all paths will be relative to <literal>RootDir</literal>, "
3611 "<emphasis>even paths that are specified absolutely</emphasis>. So, for "
3612 "instance, if <literal>RootDir</literal> is set to "
3613 "<filename>/tmp/staging</filename> and <literal>Dir::State::status</literal> "
3614 "is set to <filename>/var/lib/dpkg/status</filename>, then the status file "
3615 "will be looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>. "
3616 "If you want to prefix only relative paths, set <literal>Dir</literal> "
3620 #. type: Content of: <refentry><refsect1><para>
3623 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3624 "which files APT should silently ignore while parsing the files in the "
3625 "fragment directories. Per default a file which end with "
3626 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3627 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3628 "default value these patterns can use regular expression syntax."
3631 #. type: Content of: <refentry><refsect1><title>
3633 msgid "APT in DSelect"
3636 #. type: Content of: <refentry><refsect1><para>
3639 "When APT is used as a &dselect; method several configuration directives "
3640 "control the default behavior. These are in the <literal>DSelect</literal> "
3644 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3647 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3648 "<literal>prompt</literal>, <literal>auto</literal>, "
3649 "<literal>pre-auto</literal> and <literal>never</literal>. "
3650 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3651 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3652 "default) does so conditionally. <literal>auto</literal> removes only those "
3653 "packages which are no longer downloadable (replaced with a new version for "
3654 "instance). <literal>pre-auto</literal> performs this action before "
3655 "downloading new packages."
3658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3661 "The contents of this variable are passed to &apt-get; as command line "
3662 "options when it is run for the install phase."
3665 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3668 "The contents of this variable are passed to &apt-get; as command line "
3669 "options when it is run for the update phase."
3672 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3675 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3676 "The default is to prompt only on error."
3679 #. type: Content of: <refentry><refsect1><title>
3681 msgid "How APT calls &dpkg;"
3684 #. type: Content of: <refentry><refsect1><para>
3687 "Several configuration directives control how APT invokes &dpkg;. These are "
3688 "in the <literal>DPkg</literal> section."
3691 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3694 "This is a list of options to pass to &dpkg;. The options must be specified "
3695 "using the list notation and each list item is passed as a single argument to "
3699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3702 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3703 "<literal>options</literal> this must be specified in list notation. The "
3704 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3705 "fail APT will abort."
3708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3711 "This is a list of shell commands to run before invoking &dpkg;. Like "
3712 "<literal>options</literal> this must be specified in list notation. The "
3713 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3714 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3715 "going to install to the commands, one per line on the requested file "
3716 "descriptor, defaulting to standard input."
3719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3722 "Version 2 of this protocol sends more information through the requested file "
3723 "descriptor: a line with the text <literal>VERSION 2</literal>, the APT "
3724 "configuration space, and a list of package actions with filename and version "
3728 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3731 "Each configuration directive line has the form "
3732 "<literal>key=value</literal>. Special characters (equal signs, newlines, "
3733 "nonprintable characters, quotation marks, and percent signs in "
3734 "<literal>key</literal> and newlines, nonprintable characters, and percent "
3735 "signs in <literal>value</literal>) are %-encoded. Lists are represented by "
3736 "multiple <literal>key::=value</literal> lines with the same key. The "
3737 "configuration section ends with a blank line."
3740 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3743 "Package action lines consist of five fields in Version 2: old version, "
3744 "direction of version change (< for upgrades, > for downgrades, = for "
3745 "no change), new version, action. The version fields are \"-\" for no version "
3746 "at all (for example when installing a package for the first time; no version "
3747 "is treated as earlier than any real version, so that is an upgrade, "
3748 "indicated as <literal>- < 1.23.4</literal>). The action field is "
3749 "\"**CONFIGURE**\" if the package is being configured, \"**REMOVE**\" if it "
3750 "is being removed, or the filename of a .deb file if it is being unpacked."
3753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3756 "In Version 3 after each version field follows the architecture of this "
3757 "version, which is \"-\" if there is no version, and a field showing the "
3758 "MultiArch type \"same\", foreign\", \"allowed\" or \"none\". Note that "
3759 "\"none\" is an incorrect typename which is just kept to remain compatible, "
3760 "it should be read as \"no\" and users are encouraged to support both."
3763 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3766 "The version of the protocol to be used for the command "
3767 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3768 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3769 "accordingly, the default being version 1. If APT isn't supporting the "
3770 "requested version it will send the information in the highest version it has "
3771 "support for instead."
3774 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3777 "The file descriptor to be used to send the information can be requested with "
3778 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3779 "which defaults to <literal>0</literal> for standard input and is available "
3780 "since version 0.9.11. Support for the option can be detected by looking for "
3781 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3782 "number of the used file descriptor as a confirmation."
3785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3788 "APT chdirs to this directory before invoking &dpkg;, the default is "
3789 "<filename>/</filename>."
3792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3795 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3796 "default is to disable signing and produce all binaries."
3799 #. type: Content of: <refentry><refsect1><refsect2><title>
3801 msgid "dpkg trigger usage (and related options)"
3804 #. type: Content of: <refentry><refsect1><refsect2><para>
3807 "APT can call &dpkg; in such a way as to let it make aggressive use of "
3808 "triggers over multiple calls of &dpkg;. Without further options &dpkg; will "
3809 "use triggers once each time it runs. Activating these options can therefore "
3810 "decrease the time needed to perform the install or upgrade. Note that it is "
3811 "intended to activate these options per default in the future, but as it "
3812 "drastically changes the way APT calls &dpkg; it needs a lot more testing. "
3813 "<emphasis>These options are therefore currently experimental and should not "
3814 "be used in production environments.</emphasis> It also breaks progress "
3815 "reporting such that all front-ends will currently stay around half (or more) "
3816 "of the time in the 100% state while it actually configures all packages."
3819 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
3823 "DPkg::NoTriggers \"true\";\n"
3824 "PackageManager::Configure \"smart\";\n"
3825 "DPkg::ConfigurePending \"true\";\n"
3826 "DPkg::TriggersPending \"true\";"
3829 #. type: Content of: <refentry><refsect1><refsect2><para>
3832 "Note that it is not guaranteed that APT will support these options or that "
3833 "these options will not cause (big) trouble in the future. If you have "
3834 "understand the current risks and problems with these options, but are brave "
3835 "enough to help testing them, create a new configuration file and test a "
3836 "combination of options. Please report any bugs, problems and improvements "
3837 "you encounter and make sure to note which options you have used in your "
3838 "reports. Asking &dpkg; for help could also be useful for debugging proposes, "
3839 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
3840 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
3843 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3846 "Add the no triggers flag to all &dpkg; calls (except the ConfigurePending "
3847 "call). See &dpkg; if you are interested in what this actually means. In "
3848 "short: &dpkg; will not run the triggers when this flag is present unless it "
3849 "is explicitly called to do so in an extra call. Note that this option "
3850 "exists (undocumented) also in older APT versions with a slightly different "
3851 "meaning: Previously these option only append --no-triggers to the configure "
3852 "calls to &dpkg; - now APT will also add this flag to the unpack and remove "
3856 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3859 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
3860 "and \"<literal>no</literal>\". The default value is "
3861 "\"<literal>all</literal>\", which causes APT to configure all packages. The "
3862 "\"<literal>smart</literal>\" way is to configure only packages which need to "
3863 "be configured before another package can be unpacked (Pre-Depends), and let "
3864 "the rest be configured by &dpkg; with a call generated by the "
3865 "ConfigurePending option (see below). On the other hand, "
3866 "\"<literal>no</literal>\" will not configure anything, and totally relies on "
3867 "&dpkg; for configuration (which at the moment will fail if a Pre-Depends is "
3868 "encountered). Setting this option to any value other than "
3869 "<literal>all</literal> will implicitly also activate the next option by "
3870 "default, as otherwise the system could end in an unconfigured and "
3871 "potentially unbootable state."
3874 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3877 "If this option is set APT will call <command>dpkg --configure "
3878 "--pending</command> to let &dpkg; handle all required configurations and "
3879 "triggers. This option is activated automatically per default if the previous "
3880 "option is not set to <literal>all</literal>, but deactivating it could be "
3881 "useful if you want to run APT multiple times in a row - e.g. in an "
3882 "installer. In these sceneries you could deactivate this option in all but "
3886 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3889 "Useful for the <literal>smart</literal> configuration as a package which has "
3890 "pending triggers is not considered as <literal>installed</literal>, and "
3891 "&dpkg; treats them as <literal>unpacked</literal> currently which is a "
3892 "showstopper for Pre-Dependencies (see debbugs #526774). Note that this will "
3893 "process all triggers, not only the triggers needed to configure this "
3897 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
3901 "OrderList::Score {\n"
3903 "\tEssential 200;\n"
3905 "\tPreDepends 50;\n"
3909 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
3912 "Essential packages (and their dependencies) should be configured immediately "
3913 "after unpacking. It is a good idea to do this quite early in the upgrade "
3914 "process as these configure calls also currently require "
3915 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
3916 "(which may not be needed). Essentials get per default a high score but the "
3917 "immediate flag is relatively low (a package which has a Pre-Depends is rated "
3918 "higher). These option and the others in the same group can be used to "
3919 "change the scoring. The following example shows the settings with their "
3920 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
3923 #. type: Content of: <refentry><refsect1><title>
3925 msgid "Periodic and Archives options"
3928 #. type: Content of: <refentry><refsect1><para>
3931 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3932 "of options configure behavior of apt periodic updates, which is done by the "
3933 "<literal>/etc/cron.daily/apt</literal> script. See the top of this script "
3934 "for the brief documentation of these options."
3937 #. type: Content of: <refentry><refsect1><title>
3939 msgid "Debug options"
3942 #. type: Content of: <refentry><refsect1><para>
3945 "Enabling options in the <literal>Debug::</literal> section will cause "
3946 "debugging information to be sent to the standard error stream of the program "
3947 "utilizing the <literal>apt</literal> libraries, or enable special program "
3948 "modes that are primarily useful for debugging the behavior of "
3949 "<literal>apt</literal>. Most of these options are not interesting to a "
3950 "normal user, but a few may be:"
3953 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3956 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3957 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3961 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3964 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3965 "used to run some operations (for instance, <literal>apt-get -s "
3966 "install</literal>) as a non-root user."
3969 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3972 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3973 "time that <literal>apt</literal> invokes &dpkg;."
3977 #. motivating example, except I haven't a clue why you'd want
3979 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3982 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3986 #. type: Content of: <refentry><refsect1><para>
3988 msgid "A full list of debugging options to apt follows."
3991 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3993 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3998 msgid "Print information related to downloading packages using FTP."
4001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4003 msgid "Print information related to downloading packages using HTTP."
4006 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4008 msgid "Print information related to downloading packages using HTTPS."
4011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4014 "Print information related to verifying cryptographic signatures using "
4015 "<literal>gpg</literal>."
4018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4021 "Output information about the process of accessing collections of packages "
4022 "stored on CD-ROMs."
4025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4027 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4030 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4033 "Output each cryptographic hash that is generated by the "
4034 "<literal>apt</literal> libraries."
4037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4040 "Do not include information from <literal>statfs</literal>, namely the number "
4041 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4048 "Disable all file locking. For instance, this will allow two instances of "
4049 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4052 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4054 msgid "Log when items are added to or removed from the global download queue."
4057 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4060 "Output status messages and errors related to verifying checksums and "
4061 "cryptographic signatures of downloaded files."
4064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4067 "Output information about downloading and applying package index list diffs, "
4068 "and errors relating to package index list diffs."
4071 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4074 "Output information related to patching apt package lists when downloading "
4075 "index diffs instead of full indices."
4078 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4080 msgid "Log all interactions with the sub-processes that actually perform downloads."
4083 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4086 "Log events related to the automatically-installed status of packages and to "
4087 "the removal of unused packages."
4090 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4093 "Generate debug messages describing which packages are being automatically "
4094 "installed to resolve dependencies. This corresponds to the initial "
4095 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4096 "and not to the full <literal>apt</literal> dependency resolver; see "
4097 "<literal>Debug::pkgProblemResolver</literal> for that."
4100 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4103 "Generate debug messages describing which packages are marked as "
4104 "keep/install/remove while the ProblemResolver does his work. Each addition "
4105 "or deletion may trigger additional actions; they are shown indented two "
4106 "additional spaces under the original entry. The format for each line is "
4107 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4108 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4109 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4110 "is the current version of the package, <literal>d.e.f</literal> is the "
4111 "version considered for installation and <literal>x.y.z</literal> is a newer "
4112 "version, but not considered for installation (because of a low pin "
4113 "score). The later two can be omitted if there is none or if it is the same "
4114 "as the installed version. <literal>section</literal> is the name of the "
4115 "section the package appears in."
4118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4121 "When invoking &dpkg;, output the precise command line with which it is being "
4122 "invoked, with arguments separated by a single space character."
4125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4128 "Output all the data received from &dpkg; on the status file descriptor and "
4129 "any errors encountered while parsing it."
4132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4135 "Generate a trace of the algorithm that decides the order in which "
4136 "<literal>apt</literal> should pass packages to &dpkg;."
4139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4141 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4146 msgid "Output the priority of each package list on startup."
4149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4152 "Trace the execution of the dependency resolver (this applies only to what "
4153 "happens when a complex dependency problem is encountered)."
4156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4159 "Display a list of all installed packages with their calculated score used by "
4160 "the pkgProblemResolver. The description of the package is the same as "
4161 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4164 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4167 "Print information about the vendors read from "
4168 "<filename>/etc/apt/vendors.list</filename>."
4171 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4174 "Display the external commands that are called by apt hooks. This includes "
4175 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
4176 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
4179 #. type: Content of: <refentry><refsect1><title>
4180 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
4181 #: apt-ftparchive.1.xml:1
4185 #. type: Content of: <refentry><refsect1><para>
4188 "&configureindex; is a configuration file showing example values for all "
4192 #. ? reading apt.conf
4193 #. type: Content of: <refentry><refsect1><para>
4195 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4198 #. type: Content of: <refentry><refnamediv><refpurpose>
4199 #: apt_preferences.5.xml:1
4200 msgid "Preference control file for APT"
4203 #. type: Content of: <refentry><refsect1><para>
4204 #: apt_preferences.5.xml:1
4206 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4207 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4208 "can be used to control which versions of packages will be selected for "
4212 #. type: Content of: <refentry><refsect1><para>
4213 #: apt_preferences.5.xml:1
4215 "Several versions of a package may be available for installation when the "
4216 "&sources-list; file contains references to more than one distribution (for "
4217 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4218 "assigns a priority to each version that is available. Subject to dependency "
4219 "constraints, <command>apt-get</command> selects the version with the highest "
4220 "priority for installation. The APT preferences override the priorities that "
4221 "APT assigns to package versions by default, thus giving the user control "
4222 "over which one is selected for installation."
4225 #. type: Content of: <refentry><refsect1><para>
4226 #: apt_preferences.5.xml:1
4228 "Several instances of the same version of a package may be available when the "
4229 "&sources-list; file contains references to more than one source. In this "
4230 "case <command>apt-get</command> downloads the instance listed earliest in "
4231 "the &sources-list; file. The APT preferences do not affect the choice of "
4232 "instance, only the choice of version."
4235 #. type: Content of: <refentry><refsect1><para>
4236 #: apt_preferences.5.xml:1
4238 "Preferences are a strong power in the hands of a system administrator but "
4239 "they can become also their biggest nightmare if used without care! APT will "
4240 "not question the preferences, so wrong settings can lead to uninstallable "
4241 "packages or wrong decisions while upgrading packages. Even more problems "
4242 "will arise if multiple distribution releases are mixed without a good "
4243 "understanding of the following paragraphs. Packages included in a specific "
4244 "release aren't tested in (and therefore don't always work as expected in) "
4245 "older or newer releases, or together with other packages from different "
4246 "releases. You have been warned."
4249 #. type: Content of: <refentry><refsect1><para>
4250 #: apt_preferences.5.xml:1
4252 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4253 "directory are parsed in alphanumeric ascending order and need to obey the "
4254 "following naming convention: The files have either no or "
4255 "\"<literal>pref</literal>\" as filename extension and only contain "
4256 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4257 "Otherwise APT will print a notice that it has ignored a file, unless that "
4258 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4259 "configuration list - in which case it will be silently ignored."
4262 #. type: Content of: <refentry><refsect1><refsect2><title>
4263 #: apt_preferences.5.xml:1
4264 msgid "APT's Default Priority Assignments"
4267 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4268 #: apt_preferences.5.xml:1
4271 "<command>apt-get install -t testing "
4272 "<replaceable>some-package</replaceable></command>\n"
4275 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4276 #: apt_preferences.5.xml:1
4278 msgid "APT::Default-Release \"stable\";\n"
4281 #. type: Content of: <refentry><refsect1><refsect2><para>
4282 #: apt_preferences.5.xml:1
4284 "If there is no preferences file or if there is no entry in the file that "
4285 "applies to a particular version then the priority assigned to that version "
4286 "is the priority of the distribution to which that version belongs. It is "
4287 "possible to single out a distribution, \"the target release\", which "
4288 "receives a higher priority than other distributions do by default. The "
4289 "target release can be set on the <command>apt-get</command> command line or "
4290 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4291 "that this has precedence over any general priority you set in the "
4292 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4293 "specifically pinned packages. For example, <placeholder "
4294 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4298 #. type: Content of: <refentry><refsect1><refsect2><para>
4299 #: apt_preferences.5.xml:1
4301 "If the target release has been specified then APT uses the following "
4302 "algorithm to set the priorities of the versions of a package. Assign:"
4305 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4306 #: apt_preferences.5.xml:1
4310 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4311 #: apt_preferences.5.xml:1
4313 "to the versions coming from archives which in their "
4314 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4315 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
4316 "<literal>experimental</literal> archive."
4319 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4320 #: apt_preferences.5.xml:1
4321 msgid "priority 100"
4324 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4325 #: apt_preferences.5.xml:1
4327 "to the version that is already installed (if any) and to the versions coming "
4328 "from archives which in their <filename>Release</filename> files are marked "
4329 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
4330 "backports archive since <literal>squeeze-backports</literal>."
4333 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4334 #: apt_preferences.5.xml:1
4335 msgid "priority 500"
4338 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4339 #: apt_preferences.5.xml:1
4340 msgid "to the versions that do not belong to the target release."
4343 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4344 #: apt_preferences.5.xml:1
4345 msgid "priority 990"
4348 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4349 #: apt_preferences.5.xml:1
4350 msgid "to the versions that belong to the target release."
4353 #. type: Content of: <refentry><refsect1><refsect2><para>
4354 #: apt_preferences.5.xml:1
4356 "The highest of those priorities whose description matches the version is "
4357 "assigned to the version."
4360 #. type: Content of: <refentry><refsect1><refsect2><para>
4361 #: apt_preferences.5.xml:1
4363 "If the target release has not been specified then APT simply assigns "
4364 "priority 100 to all installed package versions and priority 500 to all "
4365 "uninstalled package versions, except versions coming from archives which in "
4366 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4367 "- these versions get the priority 1 or priority 100 if it is additionally "
4368 "marked as \"ButAutomaticUpgrades: yes\"."
4371 #. type: Content of: <refentry><refsect1><refsect2><para>
4372 #: apt_preferences.5.xml:1
4374 "APT then applies the following rules, listed in order of precedence, to "
4375 "determine which version of a package to install."
4378 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4379 #: apt_preferences.5.xml:1
4381 "Never downgrade unless the priority of an available version exceeds 1000. "
4382 "(\"Downgrading\" is installing a less recent version of a package in place "
4383 "of a more recent version. Note that none of APT's default priorities "
4384 "exceeds 1000; such high priorities can only be set in the preferences file. "
4385 "Note also that downgrading a package can be risky.)"
4388 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4389 #: apt_preferences.5.xml:1
4390 msgid "Install the highest priority version."
4393 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4394 #: apt_preferences.5.xml:1
4396 "If two or more versions have the same priority, install the most recent one "
4397 "(that is, the one with the higher version number)."
4400 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4401 #: apt_preferences.5.xml:1
4403 "If two or more versions have the same priority and version number but either "
4404 "the packages differ in some of their metadata or the "
4405 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4408 #. type: Content of: <refentry><refsect1><refsect2><para>
4409 #: apt_preferences.5.xml:1
4411 "In a typical situation, the installed version of a package (priority 100) "
4412 "is not as recent as one of the versions available from the sources listed in "
4413 "the &sources-list; file (priority 500 or 990). Then the package will be "
4414 "upgraded when <command>apt-get install "
4415 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4416 "upgrade</command> is executed."
4419 #. type: Content of: <refentry><refsect1><refsect2><para>
4420 #: apt_preferences.5.xml:1
4422 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4423 "recent than any of the other available versions. The package will not be "
4424 "downgraded when <command>apt-get install "
4425 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4426 "upgrade</command> is executed."
4429 #. type: Content of: <refentry><refsect1><refsect2><para>
4430 #: apt_preferences.5.xml:1
4432 "Sometimes the installed version of a package is more recent than the version "
4433 "belonging to the target release, but not as recent as a version belonging to "
4434 "some other distribution. Such a package will indeed be upgraded when "
4435 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4436 "or <command>apt-get upgrade</command> is executed, because at least "
4437 "<emphasis>one</emphasis> of the available versions has a higher priority "
4438 "than the installed version."
4441 #. type: Content of: <refentry><refsect1><refsect2><title>
4442 #: apt_preferences.5.xml:1
4443 msgid "The Effect of APT Preferences"
4446 #. type: Content of: <refentry><refsect1><refsect2><para>
4447 #: apt_preferences.5.xml:1
4449 "The APT preferences file allows the system administrator to control the "
4450 "assignment of priorities. The file consists of one or more multi-line "
4451 "records separated by blank lines. Records can have one of two forms, a "
4452 "specific form and a general form."
4455 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4456 #: apt_preferences.5.xml:1
4458 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4459 "specified packages with a specified version or version range. For example, "
4460 "the following record assigns a high priority to all versions of the "
4461 "<filename>perl</filename> package whose version number begins with "
4462 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4466 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4467 #: apt_preferences.5.xml:1
4471 "Pin: version &good-perl;*\n"
4472 "Pin-Priority: 1001\n"
4475 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4476 #: apt_preferences.5.xml:1
4478 "The general form assigns a priority to all of the package versions in a "
4479 "given distribution (that is, to all the versions of packages that are listed "
4480 "in a certain <filename>Release</filename> file) or to all of the package "
4481 "versions coming from a particular Internet site, as identified by the site's "
4482 "fully qualified domain name."
4485 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4486 #: apt_preferences.5.xml:1
4488 "This general-form entry in the APT preferences file applies only to groups "
4489 "of packages. For example, the following record assigns a high priority to "
4490 "all package versions available from the local site."
4493 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4494 #: apt_preferences.5.xml:1
4498 "Pin: origin \"\"\n"
4499 "Pin-Priority: 999\n"
4502 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4503 #: apt_preferences.5.xml:1
4505 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4506 "which can be used to match a hostname. The following record will assign a "
4507 "high priority to all versions available from the server identified by the "
4508 "hostname \"ftp.de.debian.org\""
4511 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4512 #: apt_preferences.5.xml:1
4516 "Pin: origin \"ftp.de.debian.org\"\n"
4517 "Pin-Priority: 999\n"
4520 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4521 #: apt_preferences.5.xml:1
4523 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4524 "distribution as specified in a <filename>Release</filename> file. What "
4525 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4526 "Internet address but an author or vendor name, such as \"Debian\" or "
4530 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4531 #: apt_preferences.5.xml:1
4533 "The following record assigns a low priority to all package versions "
4534 "belonging to any distribution whose Archive name is "
4535 "\"<literal>unstable</literal>\"."
4538 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4539 #: apt_preferences.5.xml:1
4543 "Pin: release a=unstable\n"
4544 "Pin-Priority: 50\n"
4547 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4548 #: apt_preferences.5.xml:1
4550 "The following record assigns a high priority to all package versions "
4551 "belonging to any distribution whose Codename is "
4552 "\"<literal>&testing-codename;</literal>\"."
4555 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4556 #: apt_preferences.5.xml:1
4560 "Pin: release n=&testing-codename;\n"
4561 "Pin-Priority: 900\n"
4564 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4565 #: apt_preferences.5.xml:1
4567 "The following record assigns a high priority to all package versions "
4568 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4569 "and whose release Version number is \"<literal>&stable-version;</literal>\"."
4572 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4573 #: apt_preferences.5.xml:1
4577 "Pin: release a=stable, v=&stable-version;\n"
4578 "Pin-Priority: 500\n"
4581 #. type: Content of: <refentry><refsect1><refsect2><para>
4582 #: apt_preferences.5.xml:1
4584 "The effect of the comma operator is similar to an \"and\" in logic: All "
4585 "conditions must be satisfied for the pin to match. There is one exception: "
4586 "For any type of condition (such as two \"a\" conditions), only the last such "
4587 "condition is checked."
4590 #. type: Content of: <refentry><refsect1><refsect2><title>
4591 #: apt_preferences.5.xml:1
4592 msgid "Regular expressions and &glob; syntax"
4595 #. type: Content of: <refentry><refsect1><refsect2><para>
4596 #: apt_preferences.5.xml:1
4598 "APT also supports pinning by &glob; expressions, and regular expressions "
4599 "surrounded by slashes. For example, the following example assigns the "
4600 "priority 500 to all packages from experimental where the name starts with "
4601 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4602 "extended regular expression surrounded by slashes)."
4605 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4606 #: apt_preferences.5.xml:1
4609 "Package: gnome* /kde/\n"
4610 "Pin: release a=experimental\n"
4611 "Pin-Priority: 500\n"
4614 #. type: Content of: <refentry><refsect1><refsect2><para>
4615 #: apt_preferences.5.xml:1
4617 "The rule for those expressions is that they can occur anywhere where a "
4618 "string can occur. Thus, the following pin assigns the priority 990 to all "
4619 "packages from a release starting with &ubuntu-codename;."
4622 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4623 #: apt_preferences.5.xml:1
4627 "Pin: release n=&ubuntu-codename;*\n"
4628 "Pin-Priority: 990\n"
4631 #. type: Content of: <refentry><refsect1><refsect2><para>
4632 #: apt_preferences.5.xml:1
4634 "If a regular expression occurs in a <literal>Package</literal> field, the "
4635 "behavior is the same as if this regular expression were replaced with a list "
4636 "of all package names it matches. It is undecided whether this will change in "
4637 "the future; thus you should always list wild-card pins first, so later "
4638 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4639 "Package field is not considered a &glob; expression in itself."
4642 #. type: Content of: <refentry><refsect1><refsect2><title>
4643 #: apt_preferences.5.xml:1
4644 msgid "How APT Interprets Priorities"
4647 #. type: Content of: <refentry><refsect1><refsect2><para>
4648 #: apt_preferences.5.xml:1
4650 "Priorities (P) assigned in the APT preferences file must be positive or "
4651 "negative integers. They are interpreted as follows (roughly speaking):"
4654 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4655 #: apt_preferences.5.xml:1
4656 msgid "P >= 1000"
4659 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4660 #: apt_preferences.5.xml:1
4662 "causes a version to be installed even if this constitutes a downgrade of the "
4666 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4667 #: apt_preferences.5.xml:1
4668 msgid "990 <= P < 1000"
4671 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4672 #: apt_preferences.5.xml:1
4674 "causes a version to be installed even if it does not come from the target "
4675 "release, unless the installed version is more recent"
4678 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4679 #: apt_preferences.5.xml:1
4680 msgid "500 <= P < 990"
4683 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4684 #: apt_preferences.5.xml:1
4686 "causes a version to be installed unless there is a version available "
4687 "belonging to the target release or the installed version is more recent"
4690 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4691 #: apt_preferences.5.xml:1
4692 msgid "100 <= P < 500"
4695 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4696 #: apt_preferences.5.xml:1
4698 "causes a version to be installed unless there is a version available "
4699 "belonging to some other distribution or the installed version is more recent"
4702 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4703 #: apt_preferences.5.xml:1
4704 msgid "0 < P < 100"
4707 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4708 #: apt_preferences.5.xml:1
4710 "causes a version to be installed only if there is no installed version of "
4714 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4715 #: apt_preferences.5.xml:1
4719 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4720 #: apt_preferences.5.xml:1
4721 msgid "prevents the version from being installed"
4724 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4725 #: apt_preferences.5.xml:1
4729 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4730 #: apt_preferences.5.xml:1
4731 msgid "has undefined behaviour, do not use it."
4734 #. type: Content of: <refentry><refsect1><refsect2><para>
4735 #: apt_preferences.5.xml:1
4737 "The first specific-form record matching an available package version "
4738 "determines the priority of the package version. Failing that, the priority "
4739 "of the package is defined as the maximum of all priorities defined by "
4740 "generic-form records matching the version. Records defined using patterns "
4741 "in the Pin field other than \"*\" are treated like specific-form records."
4744 #. type: Content of: <refentry><refsect1><refsect2><para>
4745 #: apt_preferences.5.xml:1
4747 "For example, suppose the APT preferences file contains the three records "
4748 "presented earlier:"
4751 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4752 #: apt_preferences.5.xml:1
4756 "Pin: version &good-perl;*\n"
4757 "Pin-Priority: 1001\n"
4760 "Pin: origin \"\"\n"
4761 "Pin-Priority: 999\n"
4764 "Pin: release unstable\n"
4765 "Pin-Priority: 50\n"
4768 #. type: Content of: <refentry><refsect1><refsect2><para>
4769 #: apt_preferences.5.xml:1
4773 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4774 #: apt_preferences.5.xml:1
4776 "The most recent available version of the <literal>perl</literal> package "
4777 "will be installed, so long as that version's version number begins with "
4778 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4779 "&good-perl;* version of <literal>perl</literal> is available and the "
4780 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4784 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4785 #: apt_preferences.5.xml:1
4787 "A version of any package other than <literal>perl</literal> that is "
4788 "available from the local system has priority over other versions, even "
4789 "versions belonging to the target release."
4792 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4793 #: apt_preferences.5.xml:1
4795 "A version of a package whose origin is not the local system but some other "
4796 "site listed in &sources-list; and which belongs to an "
4797 "<literal>unstable</literal> distribution is only installed if it is selected "
4798 "for installation and no version of the package is already installed."
4801 #. type: Content of: <refentry><refsect1><refsect2><title>
4802 #: apt_preferences.5.xml:1
4803 msgid "Determination of Package Version and Distribution Properties"
4806 #. type: Content of: <refentry><refsect1><refsect2><para>
4807 #: apt_preferences.5.xml:1
4809 "The locations listed in the &sources-list; file should provide "
4810 "<filename>Packages</filename> and <filename>Release</filename> files to "
4811 "describe the packages available at that location."
4814 #. type: Content of: <refentry><refsect1><refsect2><para>
4815 #: apt_preferences.5.xml:1
4817 "The <filename>Packages</filename> file is normally found in the directory "
4818 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4820 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4821 "consists of a series of multi-line records, one for each package available "
4822 "in that directory. Only two lines in each record are relevant for setting "
4826 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4827 #: apt_preferences.5.xml:1
4828 msgid "the <literal>Package:</literal> line"
4831 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4832 #: apt_preferences.5.xml:1
4833 msgid "gives the package name"
4836 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4837 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1
4838 msgid "the <literal>Version:</literal> line"
4841 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4842 #: apt_preferences.5.xml:1
4843 msgid "gives the version number for the named package"
4846 #. type: Content of: <refentry><refsect1><refsect2><para>
4847 #: apt_preferences.5.xml:1
4849 "The <filename>Release</filename> file is normally found in the directory "
4850 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4851 "example, <filename>.../dists/stable/Release</filename>, or "
4852 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
4853 "single multi-line record which applies to <emphasis>all</emphasis> of the "
4854 "packages in the directory tree below its parent. Unlike the "
4855 "<filename>Packages</filename> file, nearly all of the lines in a "
4856 "<filename>Release</filename> file are relevant for setting APT priorities:"
4859 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4860 #: apt_preferences.5.xml:1
4861 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4864 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4865 #: apt_preferences.5.xml:1
4867 "names the archive to which all the packages in the directory tree belong. "
4868 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4869 "that all of the packages in the directory tree below the parent of the "
4870 "<filename>Release</filename> file are in a <literal>stable</literal> "
4871 "archive. Specifying this value in the APT preferences file would require "
4875 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4876 #: apt_preferences.5.xml:1
4878 msgid "Pin: release a=stable\n"
4881 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4882 #: apt_preferences.5.xml:1
4883 msgid "the <literal>Codename:</literal> line"
4886 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4887 #: apt_preferences.5.xml:1
4889 "names the codename to which all the packages in the directory tree belong. "
4890 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
4891 "the packages in the directory tree below the parent of the "
4892 "<filename>Release</filename> file belong to a version named "
4893 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
4894 "preferences file would require the line:"
4897 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4898 #: apt_preferences.5.xml:1
4900 msgid "Pin: release n=&testing-codename;\n"
4903 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4904 #: apt_preferences.5.xml:1
4906 "names the release version. For example, the packages in the tree might "
4907 "belong to Debian release version &stable-version;. Note that there is "
4908 "normally no version number for the <literal>testing</literal> and "
4909 "<literal>unstable</literal> distributions because they have not been "
4910 "released yet. Specifying this in the APT preferences file would require one "
4911 "of the following lines."
4914 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4915 #: apt_preferences.5.xml:1
4918 "Pin: release v=&stable-version;\n"
4919 "Pin: release a=stable, v=&stable-version;\n"
4920 "Pin: release &stable-version;\n"
4923 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4924 #: apt_preferences.5.xml:1
4925 msgid "the <literal>Component:</literal> line"
4928 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4929 #: apt_preferences.5.xml:1
4931 "names the licensing component associated with the packages in the directory "
4932 "tree of the <filename>Release</filename> file. For example, the line "
4933 "\"Component: main\" specifies that all the packages in the directory tree "
4934 "are from the <literal>main</literal> component, which entails that they are "
4935 "licensed under terms listed in the Debian Free Software Guidelines. "
4936 "Specifying this component in the APT preferences file would require the "
4940 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4941 #: apt_preferences.5.xml:1
4943 msgid "Pin: release c=main\n"
4946 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4947 #: apt_preferences.5.xml:1
4948 msgid "the <literal>Origin:</literal> line"
4951 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4952 #: apt_preferences.5.xml:1
4954 "names the originator of the packages in the directory tree of the "
4955 "<filename>Release</filename> file. Most commonly, this is "
4956 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4957 "file would require the line:"
4960 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4961 #: apt_preferences.5.xml:1
4963 msgid "Pin: release o=Debian\n"
4966 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4967 #: apt_preferences.5.xml:1
4968 msgid "the <literal>Label:</literal> line"
4971 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4972 #: apt_preferences.5.xml:1
4974 "names the label of the packages in the directory tree of the "
4975 "<filename>Release</filename> file. Most commonly, this is "
4976 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4977 "file would require the line:"
4980 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4981 #: apt_preferences.5.xml:1
4983 msgid "Pin: release l=Debian\n"
4986 #. type: Content of: <refentry><refsect1><refsect2><para>
4987 #: apt_preferences.5.xml:1
4989 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4990 "files retrieved from locations listed in the &sources-list; file are stored "
4991 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4992 "named by the variable <literal>Dir::State::Lists</literal> in the "
4993 "<filename>apt.conf</filename> file. For example, the file "
4994 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4995 "contains the <filename>Release</filename> file retrieved from the site "
4996 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
4997 "architecture files from the <literal>contrib</literal> component of the "
4998 "<literal>unstable</literal> distribution."
5001 #. type: Content of: <refentry><refsect1><refsect2><title>
5002 #: apt_preferences.5.xml:1
5003 msgid "Optional Lines in an APT Preferences Record"
5006 #. type: Content of: <refentry><refsect1><refsect2><para>
5007 #: apt_preferences.5.xml:1
5009 "Each record in the APT preferences file can optionally begin with one or "
5010 "more lines beginning with the word <literal>Explanation:</literal>. This "
5011 "provides a place for comments."
5014 #. type: Content of: <refentry><refsect1><refsect2><title>
5015 #: apt_preferences.5.xml:1
5016 msgid "Tracking Stable"
5019 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5020 #: apt_preferences.5.xml:1
5023 "Explanation: Uninstall or do not install any Debian-originated\n"
5024 "Explanation: package versions other than those in the stable distro\n"
5026 "Pin: release a=stable\n"
5027 "Pin-Priority: 900\n"
5030 "Pin: release o=Debian\n"
5031 "Pin-Priority: -10\n"
5034 #. type: Content of: <refentry><refsect1><refsect2><para>
5035 #: apt_preferences.5.xml:1
5037 "The following APT preferences file will cause APT to assign a priority "
5038 "higher than the default (500) to all package versions belonging to a "
5039 "<literal>stable</literal> distribution and a prohibitively low priority to "
5040 "package versions belonging to other <literal>Debian</literal> "
5041 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5044 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5045 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1 apt_preferences.5.xml:1
5048 "apt-get install <replaceable>package-name</replaceable>\n"
5050 "apt-get dist-upgrade\n"
5053 #. type: Content of: <refentry><refsect1><refsect2><para>
5054 #: apt_preferences.5.xml:1
5056 "With a suitable &sources-list; file and the above preferences file, any of "
5057 "the following commands will cause APT to upgrade to the latest "
5058 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5062 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5063 #: apt_preferences.5.xml:1
5065 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5068 #. type: Content of: <refentry><refsect1><refsect2><para>
5069 #: apt_preferences.5.xml:1
5071 "The following command will cause APT to upgrade the specified package to the "
5072 "latest version from the <literal>testing</literal> distribution; the package "
5073 "will not be upgraded again unless this command is given again. <placeholder "
5074 "type=\"programlisting\" id=\"0\"/>"
5077 #. type: Content of: <refentry><refsect1><refsect2><title>
5078 #: apt_preferences.5.xml:1
5079 msgid "Tracking Testing or Unstable"
5082 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5083 #: apt_preferences.5.xml:1
5087 "Pin: release a=testing\n"
5088 "Pin-Priority: 900\n"
5091 "Pin: release a=unstable\n"
5092 "Pin-Priority: 800\n"
5095 "Pin: release o=Debian\n"
5096 "Pin-Priority: -10\n"
5099 #. type: Content of: <refentry><refsect1><refsect2><para>
5100 #: apt_preferences.5.xml:1
5102 "The following APT preferences file will cause APT to assign a high priority "
5103 "to package versions from the <literal>testing</literal> distribution, a "
5104 "lower priority to package versions from the <literal>unstable</literal> "
5105 "distribution, and a prohibitively low priority to package versions from "
5106 "other <literal>Debian</literal> distributions. <placeholder "
5107 "type=\"programlisting\" id=\"0\"/>"
5110 #. type: Content of: <refentry><refsect1><refsect2><para>
5111 #: apt_preferences.5.xml:1
5113 "With a suitable &sources-list; file and the above preferences file, any of "
5114 "the following commands will cause APT to upgrade to the latest "
5115 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5119 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5120 #: apt_preferences.5.xml:1
5122 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5125 #. type: Content of: <refentry><refsect1><refsect2><para>
5126 #: apt_preferences.5.xml:1
5128 "The following command will cause APT to upgrade the specified package to the "
5129 "latest version from the <literal>unstable</literal> distribution. "
5130 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5131 "the most recent <literal>testing</literal> version if that is more recent "
5132 "than the installed version, otherwise, to the most recent "
5133 "<literal>unstable</literal> version if that is more recent than the "
5134 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5137 #. type: Content of: <refentry><refsect1><refsect2><title>
5138 #: apt_preferences.5.xml:1
5139 msgid "Tracking the evolution of a codename release"
5142 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5143 #: apt_preferences.5.xml:1
5146 "Explanation: Uninstall or do not install any Debian-originated package "
5148 "Explanation: other than those in the distribution codenamed with "
5149 "&testing-codename; or sid\n"
5151 "Pin: release n=&testing-codename;\n"
5152 "Pin-Priority: 900\n"
5154 "Explanation: Debian unstable is always codenamed with sid\n"
5156 "Pin: release n=sid\n"
5157 "Pin-Priority: 800\n"
5160 "Pin: release o=Debian\n"
5161 "Pin-Priority: -10\n"
5164 #. type: Content of: <refentry><refsect1><refsect2><para>
5165 #: apt_preferences.5.xml:1
5167 "The following APT preferences file will cause APT to assign a priority "
5168 "higher than the default (500) to all package versions belonging to a "
5169 "specified codename of a distribution and a prohibitively low priority to "
5170 "package versions belonging to other <literal>Debian</literal> distributions, "
5171 "codenames and archives. Note that with this APT preference APT will follow "
5172 "the migration of a release from the archive <literal>testing</literal> to "
5173 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5174 "want to follow for example the progress in <literal>testing</literal> "
5175 "notwithstanding the codename changes you should use the example "
5176 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5179 #. type: Content of: <refentry><refsect1><refsect2><para>
5180 #: apt_preferences.5.xml:1
5182 "With a suitable &sources-list; file and the above preferences file, any of "
5183 "the following commands will cause APT to upgrade to the latest version(s) in "
5184 "the release codenamed with <literal>&testing-codename;</literal>. "
5185 "<placeholder type=\"programlisting\" id=\"0\"/>"
5188 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5189 #: apt_preferences.5.xml:1
5191 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5194 #. type: Content of: <refentry><refsect1><refsect2><para>
5195 #: apt_preferences.5.xml:1
5197 "The following command will cause APT to upgrade the specified package to the "
5198 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5199 "<command>apt-get upgrade</command> will upgrade the package to the most "
5200 "recent <literal>&testing-codename;</literal> version if that is more recent "
5201 "than the installed version, otherwise, to the most recent "
5202 "<literal>sid</literal> version if that is more recent than the installed "
5203 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5206 #. type: Content of: <refentry><refsect1><para>
5207 #: apt_preferences.5.xml:1
5208 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5211 #. type: Content of: <refentry><refnamediv><refpurpose>
5212 #: sources.list.5.xml:1
5213 msgid "List of configured APT data sources"
5216 #. type: Content of: <refentry><refsect1><para>
5217 #: sources.list.5.xml:1
5219 "The source list <filename>/etc/apt/sources.list</filename> and the the files "
5220 "contained in <filename>/etc/apt/sources.list.d/</filename> are designed to "
5221 "support any number of active sources and a variety of source media. The "
5222 "files list one source per line (one line style) or contain multiline stanzas "
5223 "defining one or more sources per stanza (deb822 style), with the most "
5224 "preferred source listed first (in case a single version is available from "
5225 "more than one source). The information available from the configured sources "
5226 "is acquired by <command>apt-get update</command> (or by an equivalent "
5227 "command from another APT front-end)."
5230 #. type: Content of: <refentry><refsect1><title>
5231 #: sources.list.5.xml:1
5232 msgid "sources.list.d"
5235 #. type: Content of: <refentry><refsect1><para>
5236 #: sources.list.5.xml:1
5238 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5239 "add sources.list entries in separate files. Two different file formats are "
5240 "allowed as described in the next two sections. Filenames need to have "
5241 "either the extension <filename>.list</filename> or "
5242 "<filename>.sources</filename> depending on the contained format. The "
5243 "filenames may only contain letters (a-z and A-Z), digits (0-9), underscore "
5244 "(_), hyphen (-) and period (.) characters. Otherwise APT will print a "
5245 "notice that it has ignored a file, unless that file matches a pattern in the "
5246 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
5247 "case it will be silently ignored."
5250 #. type: Content of: <refentry><refsect1><title>
5251 #: sources.list.5.xml:1
5252 msgid "one line style format"
5255 #. type: Content of: <refentry><refsect1><para>
5256 #: sources.list.5.xml:1
5258 "Files in this format have the extension <filename>.list</filename>. Each "
5259 "line specifying a source starts with a type "
5260 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
5261 "this type. Individual entries cannot be continued onto a following "
5262 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
5263 "on a line marks the remainder of that line as a comment. Consequently an "
5264 "entry can be disabled by commenting out the entire line. If options should "
5265 "be provided they are separated by spaces and all of them together are "
5266 "enclosed by square brackets (<literal>[]</literal>) included in the line "
5267 "after the type separated from it with a space. If an option allows multiple "
5268 "values these are separated from each other with a comma "
5269 "(<literal>,</literal>). An option name is separated from its value(s) by a "
5270 "equal sign (<literal>=</literal>). Multivalue options have also "
5271 "<literal>-=</literal> and <literal>+=</literal> as separator which instead "
5272 "of replacing the default with the given value(s) modify the default value(s) "
5273 "to remove or include the given values."
5276 #. type: Content of: <refentry><refsect1><para>
5277 #: sources.list.5.xml:1
5279 "This is the traditional format and supported by all apt versions. Note that "
5280 "not all options as described below are supported by all apt versions. Note "
5281 "also that some older applications parsing this format on its own might not "
5282 "expect to encounter options as they were uncommon before the introduction of "
5283 "multi-architecture support."
5286 #. type: Content of: <refentry><refsect1><title>
5287 #: sources.list.5.xml:1
5288 msgid "deb822 style format"
5291 #. type: Content of: <refentry><refsect1><para>
5292 #: sources.list.5.xml:1
5294 "Files in this format have the extension <filename>.sources</filename>. The "
5295 "format is similar in syntax to other files used by Debian and its "
5296 "derivatives, like the metadata itself apt will download from the configured "
5297 "sources or the <filename>debian/control</filename> file in a Debian source "
5298 "package. Individual entries are separated by an empty line, additional "
5299 "empty lines are ignored, and a <literal>#</literal> character at the start "
5300 "of the line marks the entire line as a comment. An entry can hence be "
5301 "disabled by commenting out each line belonging to the stanza, but it is "
5302 "usually easier to add the field \"Enabled: no\" to the stanza to disable the "
5303 "entry. Removing the field or setting it to yes reenables it. Options have "
5304 "the same syntax as every other field: A fieldname separated by a colon "
5305 "(<literal>:</literal>) and optionally spaces from its value(s). Note "
5306 "especially that multiple values are separated by spaces, not by commas as in "
5307 "the one line format. Multivalue fields like <literal>Architectures</literal> "
5308 "also have <literal>Architectures-Add</literal> and "
5309 "<literal>Architectures-Remove</literal> to modify the default value rather "
5310 "than replacing it."
5313 #. type: Content of: <refentry><refsect1><para>
5314 #: sources.list.5.xml:1
5316 "This is a new format supported by apt itself since version 1.1. Previous "
5317 "versions ignore such files with a notice message as described earlier. It "
5318 "is intended to make this format gradually the default format and deprecating "
5319 "the previously described one line style format as it is easier to create, "
5320 "extend and modify by humans and machines alike especially if a lot of "
5321 "sources and/or options are involved. Developers who are working with and/or "
5322 "parsing apt sources are highly encouraged to add support for this format and "
5323 "to contact the APT team to coordinate and share this work. Users can freely "
5324 "adopt this format already, but could encounter problems with software not "
5325 "supporting the format yet."
5328 #. type: Content of: <refentry><refsect1><title>
5329 #: sources.list.5.xml:1
5330 msgid "The deb and deb-src types: General Format"
5333 #. type: Content of: <refentry><refsect1><para>
5334 #: sources.list.5.xml:1
5336 "The <literal>deb</literal> type references a typical two-level Debian "
5337 "archive, <filename>distribution/component</filename>. The "
5338 "<literal>distribution</literal> is generally a suite name like "
5339 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5340 "<literal>&stable-codename;</literal> or "
5341 "<literal>&testing-codename;</literal> while component is one of "
5342 "<literal>main</literal>, <literal>contrib</literal> or "
5343 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
5344 "a Debian distribution's source code in the same form as the "
5345 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5346 "to fetch source indexes."
5349 #. type: Content of: <refentry><refsect1><para>
5350 #: sources.list.5.xml:1
5352 "The format for two one line style entries using the <literal>deb</literal> "
5353 "and <literal>deb-src</literal> types is:"
5356 #. type: Content of: <refentry><refsect1><literallayout>
5357 #: sources.list.5.xml:1
5360 "deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] "
5362 "deb-src [ option1=value1 option2=value2 ] uri suite [component1] "
5363 "[component2] [...]"
5366 #. type: Content of: <refentry><refsect1><para><literallayout>
5367 #: sources.list.5.xml:1
5370 " Types: deb deb-src\n"
5373 " Components: [component1] [component2] [...]\n"
5374 " option1: value1\n"
5375 " option2: value2\n"
5379 #. type: Content of: <refentry><refsect1><para>
5380 #: sources.list.5.xml:1
5382 "Alternatively the equivalent entry in deb822 style looks like this: "
5383 "<placeholder type=\"literallayout\" id=\"0\"/>"
5386 #. type: Content of: <refentry><refsect1><para>
5387 #: sources.list.5.xml:1
5389 "The URI for the <literal>deb</literal> type must specify the base of the "
5390 "Debian distribution, from which APT will find the information it needs. "
5391 "<literal>suite</literal> can specify an exact path, in which case the "
5392 "components must be omitted and <literal>suite</literal> must end with a "
5393 "slash (<literal>/</literal>). This is useful for the case when only a "
5394 "particular sub-directory of the archive denoted by the URI is of interest. "
5395 "If <literal>suite</literal> does not specify an exact path, at least one "
5396 "<literal>component</literal> must be present."
5399 #. type: Content of: <refentry><refsect1><para>
5400 #: sources.list.5.xml:1
5402 "<literal>suite</literal> may also contain a variable, "
5403 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
5404 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
5405 "system. This permits architecture-independent "
5406 "<filename>sources.list</filename> files to be used. In general this is only "
5407 "of interest when specifying an exact path, <literal>APT</literal> will "
5408 "automatically generate a URI with the current architecture otherwise."
5411 #. type: Content of: <refentry><refsect1><para>
5412 #: sources.list.5.xml:1
5414 "Especially in the one line style format since only one distribution can be "
5415 "specified per line it may be necessary to have multiple lines for the same "
5416 "URI, if a subset of all available distributions or components at that "
5417 "location is desired. APT will sort the URI list after it has generated a "
5418 "complete set internally, and will collapse multiple references to the same "
5419 "Internet host, for instance, into a single connection, so that it does not "
5420 "inefficiently establish a connection, close it, do something else, and then "
5421 "re-establish a connection to that same host. APT also parallelizes "
5422 "connections to different hosts to more effectively deal with sites with low "
5426 #. type: Content of: <refentry><refsect1><para>
5427 #: sources.list.5.xml:1
5429 "It is important to list sources in order of preference, with the most "
5430 "preferred source listed first. Typically this will result in sorting by "
5431 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5432 "followed by distant Internet hosts, for example)."
5435 #. type: Content of: <refentry><refsect1><para><literallayout>
5436 #: sources.list.5.xml:1
5438 msgid "&sourceslist-list-format;"
5441 #. type: Content of: <refentry><refsect1><para><literallayout>
5442 #: sources.list.5.xml:1
5444 msgid "&sourceslist-sources-format;"
5447 #. type: Content of: <refentry><refsect1><para>
5448 #: sources.list.5.xml:1
5450 "As an example, the sources for your distribution could look like this in one "
5451 "line style format: <placeholder type=\"literallayout\" id=\"0\"/> or like "
5452 "this in deb822 style format: <placeholder type=\"literallayout\" id=\"1\"/>"
5455 #. type: Content of: <refentry><refsect1><title>
5456 #: sources.list.5.xml:1
5457 msgid "The deb and deb-src types: Options"
5460 #. type: Content of: <refentry><refsect1><para>
5461 #: sources.list.5.xml:1
5463 "Each source entry can have options specified modifying which and how the "
5464 "source is accessed and data acquired from it. Format, syntax and names of "
5465 "the options varies between the two formats one line and deb822 style as "
5466 "described, but they have both the same options available. For simplicity we "
5467 "list the deb822 fieldname and provide the one line name in brackets. "
5468 "Remember that beside setting multivalue options explicitly, there is also "
5469 "the option to modify them based on the default, but we aren't listing those "
5470 "names explicitly here. Unsupported options are silently ignored by all APT "
5474 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5475 #: sources.list.5.xml:1
5477 "<option>Architectures</option> (<option>arch</option>) is a multivalue "
5478 "option defining for which architectures information should be downloaded. If "
5479 "this option isn't set the default is all architectures as defined by the "
5480 "<option>APT::Architectures</option> config option."
5483 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5484 #: sources.list.5.xml:1
5486 "<option>Languages</option> (<option>lang</option>) is a multivalue option "
5487 "defining for which languages information like translated package "
5488 "descriptions should be downloaded. If this option isn't set the default is "
5489 "all languages as defined by the <option>Acquire::Languages</option> config "
5493 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5494 #: sources.list.5.xml:1
5496 "<option>Targets</option> (<option>target</option>) is a multivalue option "
5497 "defining which download targets apt will try to acquire from this source. If "
5498 "not specified, the default set is defined by the "
5499 "<option>Acquire::IndexTargets</option> configuration scope. Aditionally, "
5500 "specific targets can be enabled or disabled by using the identifier as field "
5501 "name instead of using this multivalue option."
5504 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5505 #: sources.list.5.xml:1
5507 "<option>PDiffs</option> (<option>pdiffs</option>) is a yes/no value which "
5508 "controls if APT should try to use PDiffs to update old indexes instead of "
5509 "downloading the new indexes entirely. The value of this option is ignored if "
5510 "the repository doesn't announce the availability of PDiffs. Defaults to the "
5511 "value of the option with the same name for a specific index file defined in "
5512 "the <option>Acquire::IndexTargets</option> scope, which itself default to "
5513 "the value of configuration option <option>Acquire::PDiffs</option> which "
5514 "defaults to <literal>yes</literal>."
5517 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5518 #: sources.list.5.xml:1
5520 "<option>By-Hash</option> (<option>by-hash</option>) can have the value "
5521 "\"yes\", \"no\" or \"force\" and controls if APT should try to acquire "
5522 "indexes via an URI constructed from a hashsum of the expected file instead "
5523 "of using the well-known stable filename of the index. Using this can avoid "
5524 "hashsum mismatches, but requires a supporting mirror. The value "
5525 "\"yes\"/\"no\" activates/disables the use of this feature if this source "
5526 "indicates support for it, while \"force\" will enable the feature regardless "
5527 "of what the source indicates. Defaults to the value of the option of the "
5528 "same name for a specific index file defined in the "
5529 "<option>Acquire::IndexTargets</option> scope, which itself defaults to the "
5530 "value of configuration option <option>Acquire::By-Hash</option> which "
5531 "defaults to <literal>yes</literal>."
5534 #. type: Content of: <refentry><refsect1><para>
5535 #: sources.list.5.xml:1
5537 "Further more, there are options which if set effect <emphasis>all</emphasis> "
5538 "sources with the same URI and Suite, so they have to be set on all such "
5539 "entries and can not be varied between different components. APT will try to "
5540 "detect and error out on such anomalies."
5543 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5544 #: sources.list.5.xml:1
5546 "<option>Trusted</option> (<option>trusted</option>) is a tri-state value "
5547 "which defaults to APT deciding if a source is considered trusted or if "
5548 "warnings should be raised before e.g. packages are installed from this "
5549 "source. This option can be used to override this decision either with the "
5550 "value <literal>yes</literal>, which lets APT consider this source always as "
5551 "a trusted source even if it has no or fails authentication checks by "
5552 "disabling parts of &apt-secure; and should therefore only be used in a local "
5553 "and trusted context (if at all) as otherwise security is breached. The "
5554 "opposite can be achieved with the value no, which causes the source to be "
5555 "handled as untrusted even if the authentication checks passed successfully. "
5556 "The default value can't be set explicitly."
5559 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5560 #: sources.list.5.xml:1
5562 "<option>Signed-By</option> (<option>signed-by</option>) is either an "
5563 "absolute path to a keyring file (has to be accessible and readable for the "
5564 "<literal>_apt</literal> user, so ensure everyone has read-permissions on the "
5565 "file) or a fingerprint of a key in either the "
5566 "<filename>trusted.gpg</filename> keyring or in one of the keyrings in the "
5567 "<filename>trusted.gpg.d/</filename> directory (see <command>apt-key "
5568 "fingerprint</command>). If the option is set only the key(s) in this keyring "
5569 "or only the key with this fingerprint is used for the &apt-secure; "
5570 "verification of this repository. Otherwise all keys in the trusted keyrings "
5571 "are considered valid signers for this repository."
5574 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5575 #: sources.list.5.xml:1
5577 "<option>Check-Valid-Until</option> (<option>check-valid-until</option>) is "
5578 "a yes/no value which controls if APT should try to detect replay attacks. A "
5579 "repository creator can declare until then the data provided in the "
5580 "repository should be considered valid and if this time is reached, but no "
5581 "new data is provided the data is considered expired and an error is raised. "
5582 "Beside increasing security as a malicious attacker can't sent old data "
5583 "forever denying a user to be able to upgrade to a new version, this also "
5584 "helps users identify mirrors which are no longer updated. Some repositories "
5585 "like historic archives aren't updated anymore by design through, so this "
5586 "check can be disabled by setting this option to <literal>no</literal>. "
5587 "Defaults to the value of configuration option "
5588 "<option>Acquire::Check-Valid-Until</option> which itself defaults to "
5589 "<literal>yes</literal>."
5592 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5593 #: sources.list.5.xml:1
5595 "<option>Valid-Until-Min</option> (<option>valid-until-min</option>) and "
5596 "<option>Valid-Until-Max</option> (<option>valid-until-max</option>) can be "
5597 "used to raise or lower the time period in seconds in which the data from "
5598 "this repository is considered valid. -Max can be especially useful if the "
5599 "repository provides no Valid-Until field on its Release file to set your own "
5600 "value, while -Min can be used to increase the valid time on seldom updated "
5601 "(local) mirrors of a more frequently updated but less accessible archive "
5602 "(which is in the sources.list as well) instead of disabling the check "
5603 "entirely. Default to the value of the configuration options "
5604 "<option>Acquire::Min-ValidTime</option> and "
5605 "<option>Acquire::Max-ValidTime</option> which are both unset by default."
5608 #. type: Content of: <refentry><refsect1><title>
5609 #: sources.list.5.xml:1
5610 msgid "URI specification"
5613 #. type: Content of: <refentry><refsect1><para>
5614 #: sources.list.5.xml:1
5615 msgid "The currently recognized URI types are:"
5618 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5619 #: sources.list.5.xml:1
5621 "The file scheme allows an arbitrary directory in the file system to be "
5622 "considered an archive. This is useful for NFS mounts and local mirrors or "
5626 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5627 #: sources.list.5.xml:1
5629 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5630 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5634 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5635 #: sources.list.5.xml:1
5637 "The http scheme specifies an HTTP server for the archive. If an environment "
5638 "variable <envar>http_proxy</envar> is set with the format "
5639 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5640 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5641 "the format http://user:pass@server:port/. Note that this is an insecure "
5642 "method of authentication."
5645 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5646 #: sources.list.5.xml:1
5648 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5649 "is highly configurable; for more information see the &apt-conf; manual "
5650 "page. Please note that an FTP proxy can be specified by using the "
5651 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5652 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5653 "environment variable and <emphasis>only</emphasis> this environment "
5654 "variable. Proxies using HTTP specified in the configuration file will be "
5658 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5659 #: sources.list.5.xml:1
5661 "The copy scheme is identical to the file scheme except that packages are "
5662 "copied into the cache directory instead of used directly at their location. "
5663 "This is useful for people using removable media to copy files around with "
5667 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5668 #: sources.list.5.xml:1
5670 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5671 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5672 "recommended. The standard <command>find</command> and <command>dd</command> "
5673 "commands are used to perform the file transfers from the remote host."
5676 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5677 #: sources.list.5.xml:1
5678 msgid "adding more recognizable URI types"
5681 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5682 #: sources.list.5.xml:1
5684 "APT can be extended with more methods shipped in other optional packages, "
5685 "which should follow the naming scheme "
5686 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5687 "instance, the APT team also maintains the package "
5688 "<package>apt-transport-https</package>, which provides access methods for "
5689 "HTTPS URIs with features similar to the http method. Methods for using "
5690 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5693 #. type: Content of: <refentry><refsect1><para>
5694 #: sources.list.5.xml:1
5696 "Uses the archive stored locally (or NFS mounted) at /home/apt/debian for "
5697 "stable/main, stable/contrib, and stable/non-free."
5700 #. type: Content of: <refentry><refsect1><literallayout>
5701 #: sources.list.5.xml:1
5703 msgid "deb file:/home/apt/debian stable main contrib non-free"
5706 #. type: Content of: <refentry><refsect1><literallayout>
5707 #: sources.list.5.xml:1
5711 "URIs: file:/home/apt/debian\n"
5713 "Components: main contrib non-free"
5716 #. type: Content of: <refentry><refsect1><para>
5717 #: sources.list.5.xml:1
5718 msgid "As above, except this uses the unstable (development) distribution."
5721 #. type: Content of: <refentry><refsect1><literallayout>
5722 #: sources.list.5.xml:1
5724 msgid "deb file:/home/apt/debian unstable main contrib non-free"
5727 #. type: Content of: <refentry><refsect1><literallayout>
5728 #: sources.list.5.xml:1
5732 "URIs: file:/home/apt/debian\n"
5733 "Suites: unstable\n"
5734 "Components: main contrib non-free"
5737 #. type: Content of: <refentry><refsect1><para>
5738 #: sources.list.5.xml:1
5739 msgid "Source line for the above"
5742 #. type: Content of: <refentry><refsect1><literallayout>
5743 #: sources.list.5.xml:1
5745 msgid "deb-src file:/home/apt/debian unstable main contrib non-free"
5748 #. type: Content of: <refentry><refsect1><literallayout>
5749 #: sources.list.5.xml:1
5753 "URIs: file:/home/apt/debian\n"
5754 "Suites: unstable\n"
5755 "Components: main contrib non-free"
5758 #. type: Content of: <refentry><refsect1><para>
5759 #: sources.list.5.xml:1
5761 "The first line gets package information for the architectures in "
5762 "<literal>APT::Architectures</literal> while the second always retrieves "
5763 "<literal>amd64</literal> and <literal>armel</literal>."
5766 #. type: Content of: <refentry><refsect1><literallayout>
5767 #: sources.list.5.xml:1
5770 "deb http://httpredir.debian.org/debian &stable-codename; main\n"
5771 "deb [ arch=amd64,armel ] http://httpredir.debian.org/debian "
5772 "&stable-codename; main"
5775 #. type: Content of: <refentry><refsect1><literallayout>
5776 #: sources.list.5.xml:1
5780 "URIs: http://httpredir.debian.org/debian\n"
5781 "Suites: &stable-codename;\n"
5782 "Components: main\n"
5785 "URIs: http://httpredir.debian.org/debian\n"
5786 "Suites: &stable-codename;\n"
5787 "Components: main\n"
5788 "Architectures: amd64 armel\n"
5791 #. type: Content of: <refentry><refsect1><para>
5792 #: sources.list.5.xml:1
5794 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5798 #. type: Content of: <refentry><refsect1><literallayout>
5799 #: sources.list.5.xml:1
5801 msgid "deb http://archive.debian.org/debian-archive hamm main"
5804 #. type: Content of: <refentry><refsect1><literallayout>
5805 #: sources.list.5.xml:1
5809 "URIs: http://archive.debian.org/debian-archive\n"
5814 #. type: Content of: <refentry><refsect1><para>
5815 #: sources.list.5.xml:1
5817 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5818 "directory, and uses only the &stable-codename;/contrib area."
5821 #. type: Content of: <refentry><refsect1><literallayout>
5822 #: sources.list.5.xml:1
5824 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5827 #. type: Content of: <refentry><refsect1><literallayout>
5828 #: sources.list.5.xml:1
5832 "URIs: ftp://ftp.debian.org/debian\n"
5833 "Suites: &stable-codename;\n"
5834 "Components: contrib"
5837 #. type: Content of: <refentry><refsect1><para>
5838 #: sources.list.5.xml:1
5840 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5841 "directory, and uses only the unstable/contrib area. If this line appears as "
5842 "well as the one in the previous example in <filename>sources.list</filename> "
5843 "a single FTP session will be used for both resource lines."
5846 #. type: Content of: <refentry><refsect1><literallayout>
5847 #: sources.list.5.xml:1
5849 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5852 #. type: Content of: <refentry><refsect1><literallayout>
5853 #: sources.list.5.xml:1
5857 "URIs: ftp://ftp.debian.org/debian\n"
5858 "Suites: unstable\n"
5859 "Components: contrib"
5862 #. type: Content of: <refentry><refsect1><para><literallayout>
5863 #: sources.list.5.xml:1
5865 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5868 #. type: Content of: <refentry><refsect1><para><literallayout>
5869 #: sources.list.5.xml:1
5873 "URIs: http://ftp.tlh.debian.org/universe\n"
5874 "Suites: unstable/binary-$(ARCH)/"
5877 #. type: Content of: <refentry><refsect1><para>
5878 #: sources.list.5.xml:1
5880 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5881 "directory, and uses only files found under "
5882 "<filename>unstable/binary-i386</filename> on i386 machines, "
5883 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5884 "supported architectures. [Note this example only illustrates how to use the "
5885 "substitution variable; official debian archives are not structured like "
5886 "this] <placeholder type=\"literallayout\" id=\"0\"/> <placeholder "
5887 "type=\"literallayout\" id=\"1\"/>"
5890 #. type: Content of: <refentry><refsect1><para>
5891 #: sources.list.5.xml:1
5893 "Uses HTTP to get binary packages as well as sources from the stable, testing "
5894 "and unstable suites and the components main and contrib."
5897 #. type: Content of: <refentry><refsect1><literallayout>
5898 #: sources.list.5.xml:1
5901 "deb http://httpredir.debian.org/debian stable main contrib\n"
5902 "deb-src http://httpredir.debian.org/debian stable main contrib\n"
5903 "deb http://httpredir.debian.org/debian testing main contrib\n"
5904 "deb-src http://httpredir.debian.org/debian testing main contrib\n"
5905 "deb http://httpredir.debian.org/debian unstable main contrib\n"
5906 "deb-src http://httpredir.debian.org/debian unstable main contrib"
5909 #. type: Content of: <refentry><refsect1><literallayout>
5910 #: sources.list.5.xml:1
5913 "Types: deb deb-src\n"
5914 "URIs: http://httpredir.debian.org/debian\n"
5915 "Suites: stable testing unstable\n"
5916 "Components: main contrib\n"
5919 #. type: Content of: <refentry><refsect1><para>
5920 #: sources.list.5.xml:1
5921 msgid "&apt-get;, &apt-conf;"
5924 #. type: Content of: <refentry><refmeta><manvolnum>
5925 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
5929 #. type: Content of: <refentry><refnamediv><refpurpose>
5930 #: apt-extracttemplates.1.xml:1
5932 "Utility to extract <command>debconf</command> config and templates from "
5936 #. type: Content of: <refentry><refsect1><para>
5937 #: apt-extracttemplates.1.xml:1
5939 "<command>apt-extracttemplates</command> will take one or more Debian package "
5940 "files as input and write out (to a temporary directory) all associated "
5941 "config scripts and template files. For each passed in package that contains "
5942 "config scripts and templates, one line of output will be generated in the "
5946 #. type: Content of: <refentry><refsect1><para>
5947 #: apt-extracttemplates.1.xml:1
5948 msgid "package version template-file config-script"
5951 #. type: Content of: <refentry><refsect1><para>
5952 #: apt-extracttemplates.1.xml:1
5954 "template-file and config-script are written to the temporary directory "
5955 "specified by the <option>-t</option> or <option>--tempdir</option> "
5956 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5957 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5958 "<filename>package.config.XXXXXX</filename>"
5961 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5962 #: apt-extracttemplates.1.xml:1
5964 "Temporary directory in which to write extracted <command>debconf</command> "
5965 "template files and config scripts. Configuration Item: "
5966 "<literal>APT::ExtractTemplates::TempDir</literal>"
5969 #. type: Content of: <refentry><refsect1><para>
5970 #: apt-extracttemplates.1.xml:1
5972 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5973 "decimal 100 on error."
5976 #. type: Content of: <refentry><refnamediv><refpurpose>
5977 #: apt-sortpkgs.1.xml:1
5978 msgid "Utility to sort package index files"
5981 #. type: Content of: <refentry><refsect1><para>
5982 #: apt-sortpkgs.1.xml:1
5984 "<command>apt-sortpkgs</command> will take an index file (source index or "
5985 "package index) and sort the records so that they are ordered by the package "
5986 "name. It will also sort the internal fields of each record according to the "
5987 "internal sorting rules."
5990 #. type: Content of: <refentry><refsect1><para>
5991 #: apt-sortpkgs.1.xml:1
5992 msgid "All output is sent to standard output; the input must be a seekable file."
5995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5996 #: apt-sortpkgs.1.xml:1
5998 "Use source index field ordering. Configuration Item: "
5999 "<literal>APT::SortPkgs::Source</literal>."
6002 #. type: Content of: <refentry><refsect1><para>
6003 #: apt-sortpkgs.1.xml:1
6005 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
6009 #. type: Content of: <refentry><refnamediv><refpurpose>
6010 #: apt-ftparchive.1.xml:1
6011 msgid "Utility to generate index files"
6014 #. type: Content of: <refentry><refsect1><para>
6015 #: apt-ftparchive.1.xml:1
6017 "<command>apt-ftparchive</command> is the command line tool that generates "
6018 "the index files that APT uses to access a distribution source. The index "
6019 "files should be generated on the origin site based on the content of that "
6023 #. type: Content of: <refentry><refsect1><para>
6024 #: apt-ftparchive.1.xml:1
6026 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
6027 "program, incorporating its entire functionality via the "
6028 "<literal>packages</literal> command. It also contains a contents file "
6029 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
6030 "the generation process for a complete archive."
6033 #. type: Content of: <refentry><refsect1><para>
6034 #: apt-ftparchive.1.xml:1
6036 "Internally <command>apt-ftparchive</command> can make use of binary "
6037 "databases to cache the contents of a .deb file and it does not rely on any "
6038 "external programs aside from &gzip;. When doing a full generate it "
6039 "automatically performs file-change checks and builds the desired compressed "
6043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6044 #: apt-ftparchive.1.xml:1
6046 "The packages command generates a package file from a directory tree. It "
6047 "takes the given directory and recursively searches it for .deb files, "
6048 "emitting a package record to stdout for each. This command is approximately "
6049 "equivalent to &dpkg-scanpackages;."
6052 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6053 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6054 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
6057 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6058 #: apt-ftparchive.1.xml:1
6060 "The <literal>sources</literal> command generates a source index file from a "
6061 "directory tree. It takes the given directory and recursively searches it "
6062 "for .dsc files, emitting a source record to stdout for each. This command is "
6063 "approximately equivalent to &dpkg-scansources;."
6066 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6067 #: apt-ftparchive.1.xml:1
6069 "If an override file is specified then a source override file will be looked "
6070 "for with an extension of .src. The --source-override option can be used to "
6071 "change the source override file that will be used."
6074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6075 #: apt-ftparchive.1.xml:1
6077 "The <literal>contents</literal> command generates a contents file from a "
6078 "directory tree. It takes the given directory and recursively searches it for "
6079 ".deb files, and reads the file list from each file. It then sorts and writes "
6080 "to stdout the list of files matched to packages. Directories are not written "
6081 "to the output. If multiple packages own the same file then each package is "
6082 "separated by a comma in the output."
6085 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6086 #: apt-ftparchive.1.xml:1
6088 "The <literal>release</literal> command generates a Release file from a "
6089 "directory tree. It recursively searches the given directory for uncompressed "
6090 "<filename>Packages</filename> and <filename>Sources</filename> files and "
6091 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
6092 "<command>lzma</command> as well as <filename>Release</filename> and "
6093 "<filename>md5sum.txt</filename> files by default "
6094 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
6095 "filename patterns can be added by listing them in "
6096 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
6097 "stdout a <filename>Release</filename> file containing (by default) an MD5, "
6098 "SHA1, SHA256 and SHA512 digest for each file."
6101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6102 #: apt-ftparchive.1.xml:1
6104 "Values for the additional metadata fields in the Release file are taken from "
6105 "the corresponding variables under "
6106 "<literal>APT::FTPArchive::Release</literal>, "
6107 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
6108 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
6109 "<literal>Suite</literal>, <literal>Version</literal>, "
6110 "<literal>Codename</literal>, <literal>Date</literal>, "
6111 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
6112 "<literal>Components</literal>, <literal>Description</literal>."
6115 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6116 #: apt-ftparchive.1.xml:1
6118 "The <literal>generate</literal> command is designed to be runnable from a "
6119 "cron script and builds indexes according to the given config file. The "
6120 "config language provides a flexible means of specifying which index files "
6121 "are built from which directories, as well as providing a simple means of "
6122 "maintaining the required settings."
6125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6126 #: apt-ftparchive.1.xml:1
6128 "The <literal>clean</literal> command tidies the databases used by the given "
6129 "configuration file by removing any records that are no longer necessary."
6132 #. type: Content of: <refentry><refsect1><title>
6133 #: apt-ftparchive.1.xml:1
6134 msgid "The Generate Configuration"
6137 #. type: Content of: <refentry><refsect1><para>
6138 #: apt-ftparchive.1.xml:1
6140 "The <literal>generate</literal> command uses a configuration file to "
6141 "describe the archives that are going to be generated. It follows the typical "
6142 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
6143 "&apt-conf; contains a description of the syntax. Note that the generate "
6144 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
6145 "tree manner. This only effects how the scope tag is handled."
6148 #. type: Content of: <refentry><refsect1><para>
6149 #: apt-ftparchive.1.xml:1
6150 msgid "The generate configuration has four separate sections, each described below."
6153 #. type: Content of: <refentry><refsect1><refsect2><title>
6154 #: apt-ftparchive.1.xml:1
6155 msgid "<literal>Dir</literal> Section"
6158 #. type: Content of: <refentry><refsect1><refsect2><para>
6159 #: apt-ftparchive.1.xml:1
6161 "The <literal>Dir</literal> section defines the standard directories needed "
6162 "to locate the files required during the generation process. These "
6163 "directories are prepended certain relative paths defined in later sections "
6164 "to produce a complete an absolute path."
6167 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6168 #: apt-ftparchive.1.xml:1
6170 "Specifies the root of the FTP archive, in a standard Debian configuration "
6171 "this is the directory that contains the <filename>ls-LR</filename> and dist "
6175 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6176 #: apt-ftparchive.1.xml:1
6177 msgid "Specifies the location of the override files."
6180 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6181 #: apt-ftparchive.1.xml:1
6182 msgid "Specifies the location of the cache files."
6185 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6186 #: apt-ftparchive.1.xml:1
6188 "Specifies the location of the file list files, if the "
6189 "<literal>FileList</literal> setting is used below."
6192 #. type: Content of: <refentry><refsect1><refsect2><title>
6193 #: apt-ftparchive.1.xml:1
6194 msgid "<literal>Default</literal> Section"
6197 #. type: Content of: <refentry><refsect1><refsect2><para>
6198 #: apt-ftparchive.1.xml:1
6200 "The <literal>Default</literal> section specifies default values, and "
6201 "settings that control the operation of the generator. Other sections may "
6202 "override these defaults with a per-section setting."
6205 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6206 #: apt-ftparchive.1.xml:1
6208 "Sets the default compression schemes to use for the package index files. It "
6209 "is a string that contains a space separated list of at least one of: '.' (no "
6210 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
6214 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6215 #: apt-ftparchive.1.xml:1
6217 "Sets the default list of file extensions that are package files. This "
6218 "defaults to '.deb'."
6221 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6222 #: apt-ftparchive.1.xml:1
6224 "This is similar to <literal>Packages::Compress</literal> except that it "
6225 "controls the compression for the Sources files."
6228 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6229 #: apt-ftparchive.1.xml:1
6231 "Sets the default list of file extensions that are source files. This "
6232 "defaults to '.dsc'."
6235 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6236 #: apt-ftparchive.1.xml:1
6238 "This is similar to <literal>Packages::Compress</literal> except that it "
6239 "controls the compression for the Contents files."
6242 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6243 #: apt-ftparchive.1.xml:1
6245 "This is similar to <literal>Packages::Compress</literal> except that it "
6246 "controls the compression for the Translation-en master file."
6249 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6250 #: apt-ftparchive.1.xml:1
6252 "Specifies the number of kilobytes to delink (and replace with hard links) "
6253 "per run. This is used in conjunction with the per-section "
6254 "<literal>External-Links</literal> setting."
6257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6258 #: apt-ftparchive.1.xml:1
6260 "Specifies the mode of all created index files. It defaults to 0644. All "
6261 "index files are set to this mode with no regard to the umask."
6264 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6265 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6267 "Specifies whether long descriptions should be included in the "
6268 "<filename>Packages</filename> file or split out into a master "
6269 "<filename>Translation-en</filename> file."
6272 #. type: Content of: <refentry><refsect1><refsect2><title>
6273 #: apt-ftparchive.1.xml:1
6274 msgid "<literal>TreeDefault</literal> Section"
6277 #. type: Content of: <refentry><refsect1><refsect2><para>
6278 #: apt-ftparchive.1.xml:1
6280 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
6281 "variables are substitution variables and have the strings $(DIST), "
6282 "$(SECTION) and $(ARCH) replaced with their respective values."
6285 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6286 #: apt-ftparchive.1.xml:1
6288 "Sets the number of kilobytes of contents files that are generated each "
6289 "day. The contents files are round-robined so that over several days they "
6290 "will all be rebuilt."
6293 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6294 #: apt-ftparchive.1.xml:1
6296 "Controls the number of days a contents file is allowed to be checked without "
6297 "changing. If this limit is passed the mtime of the contents file is "
6298 "updated. This case can occur if the package file is changed in such a way "
6299 "that does not result in a new contents file [override edit for instance]. A "
6300 "hold off is allowed in hopes that new .debs will be installed, requiring a "
6301 "new file anyhow. The default is 10, the units are in days."
6304 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6305 #: apt-ftparchive.1.xml:1
6307 "Sets the top of the .deb directory tree. Defaults to "
6308 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
6311 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6312 #: apt-ftparchive.1.xml:1
6314 "Sets the top of the source package directory tree. Defaults to "
6315 "<filename>$(DIST)/$(SECTION)/source/</filename>"
6318 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6319 #: apt-ftparchive.1.xml:1
6321 "Sets the output Packages file. Defaults to "
6322 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
6325 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6326 #: apt-ftparchive.1.xml:1
6328 "Sets the output Sources file. Defaults to "
6329 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
6332 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6333 #: apt-ftparchive.1.xml:1
6335 "Sets the output Translation-en master file with the long descriptions if "
6336 "they should be not included in the Packages file. Defaults to "
6337 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
6340 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6341 #: apt-ftparchive.1.xml:1
6343 "Sets the path prefix that causes a symlink to be considered an internal link "
6344 "instead of an external link. Defaults to "
6345 "<filename>$(DIST)/$(SECTION)/</filename>"
6348 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6349 #: apt-ftparchive.1.xml:1
6351 "Sets the output Contents file. Defaults to "
6352 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
6353 "causes multiple Packages files to map onto a single Contents file (as is the "
6354 "default) then <command>apt-ftparchive</command> will integrate those "
6355 "package files together automatically."
6358 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6359 #: apt-ftparchive.1.xml:1
6360 msgid "Sets header file to prepend to the contents output."
6363 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6364 #: apt-ftparchive.1.xml:1
6366 "Sets the binary cache database to use for this section. Multiple sections "
6367 "can share the same database."
6370 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6371 #: apt-ftparchive.1.xml:1
6373 "Specifies that instead of walking the directory tree, "
6374 "<command>apt-ftparchive</command> should read the list of files from the "
6375 "given file. Relative files names are prefixed with the archive directory."
6378 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6379 #: apt-ftparchive.1.xml:1
6381 "Specifies that instead of walking the directory tree, "
6382 "<command>apt-ftparchive</command> should read the list of files from the "
6383 "given file. Relative files names are prefixed with the archive directory. "
6384 "This is used when processing source indexes."
6387 #. type: Content of: <refentry><refsect1><refsect2><title>
6388 #: apt-ftparchive.1.xml:1
6389 msgid "<literal>Tree</literal> Section"
6392 #. type: Content of: <refentry><refsect1><refsect2><para>
6393 #: apt-ftparchive.1.xml:1
6395 "The <literal>Tree</literal> section defines a standard Debian file tree "
6396 "which consists of a base directory, then multiple sections in that base "
6397 "directory and finally multiple Architectures in each section. The exact "
6398 "pathing used is defined by the <literal>Directory</literal> substitution "
6402 #. type: Content of: <refentry><refsect1><refsect2><para>
6403 #: apt-ftparchive.1.xml:1
6405 "The <literal>Tree</literal> section takes a scope tag which sets the "
6406 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
6407 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
6408 "setting such as <filename>dists/&stable-codename;</filename>."
6411 #. type: Content of: <refentry><refsect1><refsect2><para>
6412 #: apt-ftparchive.1.xml:1
6414 "All of the settings defined in the <literal>TreeDefault</literal> section "
6415 "can be used in a <literal>Tree</literal> section as well as three new "
6419 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6420 #: apt-ftparchive.1.xml:1
6423 "for i in Sections do \n"
6424 " for j in Architectures do\n"
6425 " Generate for DIST=scope SECTION=i ARCH=j\n"
6429 #. type: Content of: <refentry><refsect1><refsect2><para>
6430 #: apt-ftparchive.1.xml:1
6432 "When processing a <literal>Tree</literal> section "
6433 "<command>apt-ftparchive</command> performs an operation similar to: "
6434 "<placeholder type=\"programlisting\" id=\"0\"/>"
6437 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6438 #: apt-ftparchive.1.xml:1
6440 "This is a space separated list of sections which appear under the "
6441 "distribution; typically this is something like <literal>main contrib "
6442 "non-free</literal>"
6445 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6446 #: apt-ftparchive.1.xml:1
6448 "This is a space separated list of all the architectures that appear under "
6449 "search section. The special architecture 'source' is used to indicate that "
6450 "this tree has a source archive."
6453 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6454 #: apt-ftparchive.1.xml:1
6456 "Sets the binary override file. The override file contains section, priority "
6457 "and maintainer address information."
6460 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6461 #: apt-ftparchive.1.xml:1
6463 "Sets the source override file. The override file contains section "
6467 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6468 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6469 msgid "Sets the binary extra override file."
6472 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6473 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6474 msgid "Sets the source extra override file."
6477 #. type: Content of: <refentry><refsect1><refsect2><title>
6478 #: apt-ftparchive.1.xml:1
6479 msgid "<literal>BinDirectory</literal> Section"
6482 #. type: Content of: <refentry><refsect1><refsect2><para>
6483 #: apt-ftparchive.1.xml:1
6485 "The <literal>bindirectory</literal> section defines a binary directory tree "
6486 "with no special structure. The scope tag specifies the location of the "
6487 "binary directory and the settings are similar to the <literal>Tree</literal> "
6488 "section with no substitution variables or "
6489 "<literal>Section</literal><literal>Architecture</literal> settings."
6492 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6493 #: apt-ftparchive.1.xml:1
6494 msgid "Sets the Packages file output."
6497 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6498 #: apt-ftparchive.1.xml:1
6500 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
6501 "<literal>Sources</literal> is required."
6504 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6505 #: apt-ftparchive.1.xml:1
6506 msgid "Sets the Contents file output (optional)."
6509 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6510 #: apt-ftparchive.1.xml:1
6511 msgid "Sets the binary override file."
6514 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6515 #: apt-ftparchive.1.xml:1
6516 msgid "Sets the source override file."
6519 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6520 #: apt-ftparchive.1.xml:1
6521 msgid "Sets the cache DB."
6524 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6525 #: apt-ftparchive.1.xml:1
6526 msgid "Appends a path to all the output paths."
6529 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6530 #: apt-ftparchive.1.xml:1
6531 msgid "Specifies the file list file."
6534 #. type: Content of: <refentry><refsect1><title>
6535 #: apt-ftparchive.1.xml:1
6536 msgid "The Binary Override File"
6539 #. type: Content of: <refentry><refsect1><para>
6540 #: apt-ftparchive.1.xml:1
6542 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
6543 "contains four fields separated by spaces. The first field is the package "
6544 "name, the second is the priority to force that package to, the third is the "
6545 "section to force that package to and the final field is the maintainer "
6546 "permutation field."
6549 #. type: Content of: <refentry><refsect1><para><literallayout>
6550 #: apt-ftparchive.1.xml:1
6552 msgid "old [// oldn]* => new"
6555 #. type: Content of: <refentry><refsect1><para><literallayout>
6556 #: apt-ftparchive.1.xml:1
6561 #. type: Content of: <refentry><refsect1><para>
6562 #: apt-ftparchive.1.xml:1
6564 "The general form of the maintainer field is: <placeholder "
6565 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
6566 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
6567 "separated list of old email addresses to be specified. If any of those are "
6568 "found then new is substituted for the maintainer field. The second form "
6569 "unconditionally substitutes the maintainer field."
6572 #. type: Content of: <refentry><refsect1><title>
6573 #: apt-ftparchive.1.xml:1
6574 msgid "The Source Override File"
6577 #. type: Content of: <refentry><refsect1><para>
6578 #: apt-ftparchive.1.xml:1
6580 "The source override file is fully compatible with &dpkg-scansources;. It "
6581 "contains two fields separated by spaces. The first field is the source "
6582 "package name, the second is the section to assign it."
6585 #. type: Content of: <refentry><refsect1><title>
6586 #: apt-ftparchive.1.xml:1
6587 msgid "The Extra Override File"
6590 #. type: Content of: <refentry><refsect1><para>
6591 #: apt-ftparchive.1.xml:1
6593 "The extra override file allows any arbitrary tag to be added or replaced in "
6594 "the output. It has three columns, the first is the package, the second is "
6595 "the tag and the remainder of the line is the new value."
6598 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6599 #: apt-ftparchive.1.xml:1
6601 "Generate the given checksum. These options default to on, when turned off "
6602 "the generated index files will not have the checksum fields where possible. "
6603 "Configuration Items: "
6604 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
6605 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
6606 "where <literal><replaceable>Index</replaceable></literal> can be "
6607 "<literal>Packages</literal>, <literal>Sources</literal> or "
6608 "<literal>Release</literal> and "
6609 "<literal><replaceable>Checksum</replaceable></literal> can be "
6610 "<literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA256</literal> "
6611 "or <literal>SHA512</literal>."
6614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6615 #: apt-ftparchive.1.xml:1
6617 "Use a binary caching DB. This has no effect on the generate command. "
6618 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
6621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6622 #: apt-ftparchive.1.xml:1
6624 "Quiet; produces output suitable for logging, omitting progress indicators. "
6625 "More q's will produce more quiet up to a maximum of 2. You can also use "
6626 "<option>-q=#</option> to set the quiet level, overriding the configuration "
6627 "file. Configuration Item: <literal>quiet</literal>."
6630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6631 #: apt-ftparchive.1.xml:1
6633 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
6634 "then this option actually enables delinking of the files. It defaults to on "
6635 "and can be turned off with <option>--no-delink</option>. Configuration "
6636 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
6639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6640 #: apt-ftparchive.1.xml:1
6642 "Perform contents generation. When this option is set and package indexes are "
6643 "being generated with a cache DB then the file listing will also be extracted "
6644 "and stored in the DB for later use. When using the generate command this "
6645 "option also allows the creation of any Contents files. The default is on. "
6646 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
6649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6650 #: apt-ftparchive.1.xml:1
6652 "Select the source override file to use with the <literal>sources</literal> "
6653 "command. Configuration Item: "
6654 "<literal>APT::FTPArchive::SourceOverride</literal>."
6657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6658 #: apt-ftparchive.1.xml:1
6660 "Make the caching databases read only. Configuration Item: "
6661 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
6664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6665 #: apt-ftparchive.1.xml:1
6667 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
6668 "commands only package files matching <literal>*_arch.deb</literal> or "
6669 "<literal>*_all.deb</literal> instead of all package files in the given "
6670 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
6673 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6674 #: apt-ftparchive.1.xml:1
6676 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
6677 "packages are recompiled and/or republished with the same version again, this "
6678 "will lead to problems as the now outdated cached metadata like size and "
6679 "checksums will be used. With this option enabled this will no longer happen "
6680 "as it will be checked if the file was changed. Note that this option is set "
6681 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
6682 "multiply versions/builds of a package with the same versionnumber, so in "
6683 "theory nobody will have these problems and therefore all these extra checks "
6687 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6688 #: apt-ftparchive.1.xml:1
6690 "This configuration option defaults to \"<literal>true</literal>\" and should "
6691 "only be set to <literal>\"false\"</literal> if the Archive generated with "
6692 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
6693 "that the <filename>Translation-en</filename> master file can only be created "
6694 "in the generate command."
6697 #. type: Content of: <refentry><refsect1><para><programlisting>
6698 #: apt-ftparchive.1.xml:1
6701 "<command>apt-ftparchive</command> packages "
6702 "<replaceable>directory</replaceable> | <command>gzip</command> > "
6703 "<filename>Packages.gz</filename>\n"
6706 #. type: Content of: <refentry><refsect1><para>
6707 #: apt-ftparchive.1.xml:1
6709 "To create a compressed Packages file for a directory containing binary "
6710 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6713 #. type: Content of: <refentry><refsect1><para>
6714 #: apt-ftparchive.1.xml:1
6716 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6720 #. type: Attribute 'lang' of: <book>
6721 #: guide.dbk:1 offline.dbk:1
6725 #. type: Content of: <book><title>
6727 msgid "APT User's Guide"
6730 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6731 #: guide.dbk:1 offline.dbk:1
6732 msgid "Jason Gunthorpe"
6735 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6736 #: guide.dbk:1 offline.dbk:1
6737 msgid "jgg@debian.org"
6740 #. type: Content of: <book><bookinfo><releaseinfo>
6741 #: guide.dbk:1 offline.dbk:1
6742 msgid "Version &apt-product-version;"
6745 #. type: Content of: <book><bookinfo><abstract><para>
6748 "This document provides an overview of how to use the the APT package "
6752 #. type: Content of: <book><bookinfo>
6754 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6757 #. type: Content of: <book><bookinfo><legalnotice><title>
6758 #: guide.dbk:1 offline.dbk:1
6759 msgid "License Notice"
6762 #. type: Content of: <book><bookinfo><legalnotice><para>
6763 #: guide.dbk:1 offline.dbk:1
6765 "\"APT\" and this document are free software; you can redistribute them "
6766 "and/or modify them under the terms of the GNU General Public License as "
6767 "published by the Free Software Foundation; either version 2 of the License, "
6768 "or (at your option) any later version."
6771 #. type: Content of: <book><bookinfo><legalnotice><para>
6772 #: guide.dbk:1 offline.dbk:1
6774 "For more details, on Debian systems, see the file "
6775 "/usr/share/common-licenses/GPL for the full license."
6778 #. type: Content of: <book><chapter><title>
6783 #. type: Content of: <book><chapter><para>
6786 "The APT package currently contains two sections, the APT "
6787 "<command>dselect</command> method and the <command>apt-get</command> command "
6788 "line user interface. Both provide a way to install and remove packages as "
6789 "well as download new packages from the Internet."
6792 #. type: Content of: <book><chapter><section><title>
6794 msgid "Anatomy of the Package System"
6797 #. type: Content of: <book><chapter><section><para>
6800 "The Debian packaging system has a large amount of information associated "
6801 "with each package to help assure that it integrates cleanly and easily into "
6802 "the system. The most prominent of its features is the dependency system."
6805 #. type: Content of: <book><chapter><section><para>
6808 "The dependency system allows individual programs to make use of shared "
6809 "elements in the system such as libraries. It simplifies placing infrequently "
6810 "used portions of a program in separate packages to reduce the number of "
6811 "things the average user is required to install. Also, it allows for choices "
6812 "in mail transport agents, X servers and so on."
6815 #. type: Content of: <book><chapter><section><para>
6818 "The first step to understanding the dependency system is to grasp the "
6819 "concept of a simple dependency. The meaning of a simple dependency is that a "
6820 "package requires another package to be installed at the same time to work "
6824 #. type: Content of: <book><chapter><section><para>
6827 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6828 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6829 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6830 "simple dependency on emacs, without emacs it is completely useless."
6833 #. type: Content of: <book><chapter><section><para>
6836 "The other important dependency to understand is a conflicting dependency. It "
6837 "means that a package, when installed with another package, will not work and "
6838 "may possibly be extremely harmful to the system. As an example consider a "
6839 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6840 "have two mail transport agents installed because both need to listen to the "
6841 "network to receive mail. Attempting to install two will seriously damage the "
6842 "system so all mail transport agents have a conflicting dependency with all "
6843 "other mail transport agents."
6846 #. type: Content of: <book><chapter><section><para>
6849 "As an added complication there is the possibility for a package to pretend "
6850 "to be another package. Consider that exim and sendmail for many intents are "
6851 "identical, they both deliver mail and understand a common interface. Hence, "
6852 "the package system has a way for them to declare that they are both "
6853 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6854 "a mail-transport-agent and other packages that need a mail transport agent "
6855 "depend on mail-transport-agent. This can add a great deal of confusion when "
6856 "trying to manually fix packages."
6859 #. type: Content of: <book><chapter><section><para>
6862 "At any given time a single dependency may be met by packages that are "
6863 "already installed or it may not be. APT attempts to help resolve dependency "
6864 "issues by providing a number of automatic algorithms that help in selecting "
6865 "packages for installation."
6868 #. type: Content of: <book><chapter><title>
6873 #. type: Content of: <book><chapter><para>
6876 "<command>apt-get</command> provides a simple way to install packages from "
6877 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6878 "does not understand .deb files, it works with the package's proper name and "
6879 "can only install .deb archives from a <emphasis>Source</emphasis>."
6882 #. type: Content of: <book><chapter><para><footnote><para>
6885 "If you are using an http proxy server you must set the http_proxy "
6886 "environment variable first, see sources.list(5)"
6889 #. type: Content of: <book><chapter><para>
6892 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6893 "done before using <command>apt-get</command> is to fetch the package lists "
6894 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6895 "available. This is done with <literal>apt-get update</literal>. For "
6899 #. type: Content of: <book><chapter><screen>
6903 "# apt-get update\n"
6904 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6905 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6906 "Reading Package Lists... Done\n"
6907 "Building Dependency Tree... Done\n"
6910 #. type: Content of: <book><chapter><para>
6912 msgid "Once updated there are several commands that can be used:"
6915 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6920 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6923 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6924 "install a new package or remove an existing package, nor will it ever "
6925 "upgrade a package that might cause some other package to break. This can be "
6926 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6927 "the packages that it could not upgrade, this usually means that they depend "
6928 "on new packages or conflict with some other "
6929 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6930 "can be used to force these packages to install."
6933 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6938 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6941 "Install is used to install packages by name. The package is automatically "
6942 "fetched and installed. This can be useful if you already know the name of "
6943 "the package to install and do not want to go into a GUI to select it. Any "
6944 "number of packages may be passed to install, they will all be "
6945 "fetched. Install automatically attempts to resolve dependency problems with "
6946 "the listed packages and will print a summary and ask for confirmation if "
6947 "anything other than its arguments are changed."
6950 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6952 msgid "dist-upgrade"
6955 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6958 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6959 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6960 "set of packages to install, upgrade and remove to get as much of the system "
6961 "to the newest release. In some situations it may be desired to use "
6962 "dist-upgrade rather than spend the time manually resolving dependencies in "
6963 "<command>dselect</command>. Once dist-upgrade has completed then "
6964 "<command>dselect</command> can be used to install any packages that may have "
6968 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6971 "It is important to closely look at what dist-upgrade is going to do, its "
6972 "decisions may sometimes be quite surprising."
6975 #. type: Content of: <book><chapter><para>
6978 "<command>apt-get</command> has several command line options that are "
6979 "detailed in its man page, "
6980 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
6981 "The most useful option is <literal>-d</literal> which does not install the "
6982 "fetched files. If the system has to download a large number of package it "
6983 "would be undesired to start installing them in case something goes "
6984 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
6985 "installed by simply running the command that caused them to be downloaded "
6986 "again without <literal>-d</literal>."
6989 #. type: Content of: <book><chapter><title>
6994 #. type: Content of: <book><chapter><para>
6997 "The APT <command>dselect</command> method provides the complete APT system "
6998 "with the <command>dselect</command> package selection "
6999 "GUI. <command>dselect</command> is used to select the packages to be "
7000 "installed or removed and APT actually installs them."
7003 #. type: Content of: <book><chapter><para>
7006 "To enable the APT method you need to select [A]ccess in "
7007 "<command>dselect</command> and then choose the APT method. You will be "
7008 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
7009 "archives from. These can be remote Internet sites, local Debian mirrors or "
7010 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
7011 "will automatically combine them to form a complete set of packages. If you "
7012 "have a CD-ROM then it is a good idea to specify it first and then specify a "
7013 "mirror so that you have access to the latest bug fixes. APT will "
7014 "automatically use packages on your CD-ROM before downloading from the "
7018 #. type: Content of: <book><chapter><screen>
7022 " Set up a list of distribution source locations\n"
7024 " Please give the base URL of the debian distribution.\n"
7025 " The access schemes I know about are: http file\n"
7028 " file:/mnt/debian,\n"
7029 " ftp://ftp.debian.org/debian,\n"
7030 " http://ftp.de.debian.org/debian,\n"
7033 " URL [http://llug.sep.bnl.gov/debian]:\n"
7036 #. type: Content of: <book><chapter><para>
7039 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
7040 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
7041 "distribution to get."
7044 #. type: Content of: <book><chapter><screen>
7048 " Please give the distribution tag to get or a path to the\n"
7049 " package file ending in a /. The distribution\n"
7050 " tags are typically something like: stable unstable testing non-US\n"
7052 " Distribution [stable]:\n"
7055 #. type: Content of: <book><chapter><para>
7058 "The distribution refers to the Debian version in the archive, "
7059 "<emphasis>stable</emphasis> refers to the latest released version and "
7060 "<emphasis>unstable</emphasis> refers to the developmental "
7061 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
7062 "refers to packages that contain encryption technology or other things that "
7063 "cannot be exported from the United States. Importing these packages into the "
7064 "US is legal however."
7067 #. type: Content of: <book><chapter><screen>
7071 " Please give the components to get\n"
7072 " The components are typically something like: main contrib non-free\n"
7074 " Components [main contrib non-free]:\n"
7077 #. type: Content of: <book><chapter><para>
7080 "The components list refers to the list of sub distributions to fetch. The "
7081 "distribution is split up based on software licenses, main being DFSG free "
7082 "packages while contrib and non-free contain things that have various "
7083 "restrictions placed on their use and distribution."
7086 #. type: Content of: <book><chapter><para>
7089 "Any number of sources can be added, the setup script will continue to prompt "
7090 "until you have specified all that you want."
7093 #. type: Content of: <book><chapter><para>
7096 "Before starting to use <command>dselect</command> it is necessary to update "
7097 "the available list by selecting [U]pdate from the menu. This is a superset "
7098 "of <literal>apt-get update</literal> that makes the fetched information "
7099 "available to <command>dselect</command>. [U]pdate must be performed even if "
7100 "<literal>apt-get update</literal> has been run before."
7103 #. type: Content of: <book><chapter><para>
7106 "You can then go on and make your selections using [S]elect and then perform "
7107 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7108 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7112 #. type: Content of: <book><chapter><para>
7115 "By default APT will automatically remove the package (.deb) files once they "
7116 "have been successfully installed. To change this behavior place "
7117 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
7120 #. type: Content of: <book><chapter><title>
7122 msgid "The Interface"
7125 #. type: Content of: <book><chapter><para><footnote><para>
7128 "The <command>dselect</command> method actually is a set of wrapper scripts "
7129 "to <command>apt-get</command>. The method actually provides more "
7130 "functionality than is present in <command>apt-get</command> alone."
7133 #. type: Content of: <book><chapter><para>
7136 "Both that APT <command>dselect</command> method and "
7137 "<command>apt-get</command> share the same interface. It is a simple system "
7138 "that generally tells you what it will do and then goes and does "
7139 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
7140 "of what will happen APT then will print out some informative status messages "
7141 "so that you can estimate how far along it is and how much is left to do."
7144 #. type: Content of: <book><chapter><section><title>
7149 #. type: Content of: <book><chapter><section><para>
7152 "Before all operations except update, APT performs a number of actions to "
7153 "prepare its internal state. It also does some checks of the system's "
7154 "state. At any time these operations can be performed by running "
7155 "<literal>apt-get check</literal>."
7158 #. type: Content of: <book><chapter><section><screen>
7163 "Reading Package Lists... Done\n"
7164 "Building Dependency Tree... Done\n"
7167 #. type: Content of: <book><chapter><section><para>
7170 "The first thing it does is read all the package files into memory. APT uses "
7171 "a caching scheme so this operation will be faster the second time it is "
7172 "run. If some of the package files are not found then they will be ignored "
7173 "and a warning will be printed when apt-get exits."
7176 #. type: Content of: <book><chapter><section><para>
7179 "The final operation performs a detailed analysis of the system's "
7180 "dependencies. It checks every dependency of every installed or unpacked "
7181 "package and considers if it is OK. Should this find a problem then a report "
7182 "will be printed out and <command>apt-get</command> will refuse to run."
7185 #. type: Content of: <book><chapter><section><screen>
7190 "Reading Package Lists... Done\n"
7191 "Building Dependency Tree... Done\n"
7192 "You might want to run apt-get -f install' to correct these.\n"
7193 "Sorry, but the following packages have unmet dependencies:\n"
7194 " 9fonts: Depends: xlib6g but it is not installed\n"
7195 " uucp: Depends: mailx but it is not installed\n"
7196 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7197 " adduser: Depends: perl-base but it is not installed\n"
7198 " aumix: Depends: libgpmg1 but it is not installed\n"
7199 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7200 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7201 " cthugha: Depends: svgalibg1 but it is not installed\n"
7202 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7203 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
7206 #. type: Content of: <book><chapter><section><para>
7209 "In this example the system has many problems, including a serious problem "
7210 "with libreadlineg2. For each package that has unmet dependencies a line is "
7211 "printed out indicating the package with the problem and the dependencies "
7212 "that are unmet. A short explanation of why the package has a dependency "
7213 "problem is also included."
7216 #. type: Content of: <book><chapter><section><para><footnote><para>
7219 "APT however considers all known dependencies and attempts to prevent broken "
7223 #. type: Content of: <book><chapter><section><para>
7226 "There are two ways a system can get into a broken state like this. The first "
7227 "is caused by <command>dpkg</command> missing some subtle relationships "
7228 "between packages when performing upgrades. <placeholder type=\"footnote\" "
7229 "id=\"0\"/>. The second is if a package installation fails during an "
7230 "operation. In this situation a package may have been unpacked without its "
7231 "dependents being installed."
7234 #. type: Content of: <book><chapter><section><para>
7237 "The second situation is much less serious than the first because APT places "
7238 "certain constraints on the order that packages are installed. In both cases "
7239 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
7240 "will cause APT to deduce a possible solution to the problem and then "
7241 "continue on. The APT <command>dselect</command> method always supplies the "
7242 "<literal>-f</literal> option to allow for easy continuation of failed "
7243 "maintainer scripts."
7246 #. type: Content of: <book><chapter><section><para>
7249 "However, if the <literal>-f</literal> option is used to correct a seriously "
7250 "broken system caused by the first case then it is possible that it will "
7251 "either fail immediately or the installation sequence will fail. In either "
7252 "case it is necessary to manually use dpkg (possibly with forcing options) to "
7253 "correct the situation enough to allow APT to proceed."
7256 #. type: Content of: <book><chapter><section><title>
7258 msgid "The Status Report"
7261 #. type: Content of: <book><chapter><section><para>
7264 "Before proceeding <command>apt-get</command> will present a report on what "
7265 "will happen. Generally the report reflects the type of operation being "
7266 "performed but there are several common elements. In all cases the lists "
7267 "reflect the final state of things, taking into account the "
7268 "<literal>-f</literal> option and any other relevant activities to the "
7269 "command being executed."
7272 #. type: Content of: <book><chapter><section><section><title>
7274 msgid "The Extra Package list"
7277 #. type: Content of: <book><chapter><section><section><screen>
7281 "The following extra packages will be installed:\n"
7282 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7283 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7284 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7285 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7289 #. type: Content of: <book><chapter><section><section><para>
7292 "The Extra Package list shows all of the packages that will be installed or "
7293 "upgraded in excess of the ones mentioned on the command line. It is only "
7294 "generated for an <literal>install</literal> command. The listed packages are "
7295 "often the result of an Auto Install."
7298 #. type: Content of: <book><chapter><section><section><title>
7300 msgid "The Packages to Remove"
7303 #. type: Content of: <book><chapter><section><section><screen>
7307 "The following packages will be REMOVED:\n"
7308 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7309 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7310 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7311 " nas xpilot xfig\n"
7314 #. type: Content of: <book><chapter><section><section><para>
7317 "The Packages to Remove list shows all of the packages that will be removed "
7318 "from the system. It can be shown for any of the operations and should be "
7319 "given a careful inspection to ensure nothing important is to be taken "
7320 "off. The <literal>-f</literal> option is especially good at generating "
7321 "packages to remove so extreme care should be used in that case. The list may "
7322 "contain packages that are going to be removed because they are only "
7323 "partially installed, possibly due to an aborted installation."
7326 #. type: Content of: <book><chapter><section><section><title>
7328 msgid "The New Packages list"
7331 #. type: Content of: <book><chapter><section><section><screen>
7335 "The following NEW packages will installed:\n"
7336 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
7339 #. type: Content of: <book><chapter><section><section><para>
7342 "The New Packages list is simply a reminder of what will happen. The packages "
7343 "listed are not presently installed in the system but will be when APT is "
7347 #. type: Content of: <book><chapter><section><section><title>
7349 msgid "The Kept Back list"
7352 #. type: Content of: <book><chapter><section><section><screen>
7356 "The following packages have been kept back\n"
7357 " compface man-db tetex-base msql libpaper svgalib1\n"
7358 " gs snmp arena lynx xpat2 groff xscreensaver\n"
7361 #. type: Content of: <book><chapter><section><section><para>
7364 "Whenever the whole system is being upgraded there is the possibility that "
7365 "new versions of packages cannot be installed because they require new things "
7366 "or conflict with already installed things. In this case the package will "
7367 "appear in the Kept Back list. The best way to convince packages listed there "
7368 "to install is with <literal>apt-get install</literal> or by using "
7369 "<command>dselect</command> to resolve their problems."
7372 #. type: Content of: <book><chapter><section><section><title>
7374 msgid "Held Packages warning"
7377 #. type: Content of: <book><chapter><section><section><screen>
7381 "The following held packages will be changed:\n"
7385 #. type: Content of: <book><chapter><section><section><para>
7388 "Sometimes you can ask APT to install a package that is on hold, in such a "
7389 "case it prints out a warning that the held package is going to be "
7390 "changed. This should only happen during dist-upgrade or install."
7393 #. type: Content of: <book><chapter><section><section><title>
7395 msgid "Final summary"
7398 #. type: Content of: <book><chapter><section><section><para>
7400 msgid "Finally, APT will print out a summary of all the changes that will occur."
7403 #. type: Content of: <book><chapter><section><section><screen>
7407 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7409 "12 packages not fully installed or removed.\n"
7410 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
7413 #. type: Content of: <book><chapter><section><section><para>
7416 "The first line of the summary simply is a reduced version of all of the "
7417 "lists and includes the number of upgrades - that is packages already "
7418 "installed that have new versions available. The second line indicates the "
7419 "number of poorly configured packages, possibly the result of an aborted "
7420 "installation. The final line shows the space requirements that the "
7421 "installation needs. The first pair of numbers refer to the size of the "
7422 "archive files. The first number indicates the number of bytes that must be "
7423 "fetched from remote locations and the second indicates the total size of all "
7424 "the archives required. The next number indicates the size difference between "
7425 "the presently installed packages and the newly installed packages. It is "
7426 "roughly equivalent to the space required in /usr after everything is "
7427 "done. If a large number of packages are being removed then the value may "
7428 "indicate the amount of space that will be freed."
7431 #. type: Content of: <book><chapter><section><section><para>
7434 "Some other reports can be generated by using the -u option to show packages "
7435 "to upgrade, they are similar to the previous examples."
7438 #. type: Content of: <book><chapter><section><title>
7440 msgid "The Status Display"
7443 #. type: Content of: <book><chapter><section><para>
7446 "During the download of archives and package files APT prints out a series of "
7450 #. type: Content of: <book><chapter><section><screen>
7454 "# apt-get update\n"
7455 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7456 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7457 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7458 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7460 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7461 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
7464 #. type: Content of: <book><chapter><section><para>
7467 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
7468 "begins to fetch a file while the last line indicates the progress of the "
7469 "download. The first percent value on the progress line indicates the total "
7470 "percent done of all files. Unfortunately since the size of the Package files "
7471 "is unknown <literal>apt-get update</literal> estimates the percent done "
7472 "which causes some inaccuracies."
7475 #. type: Content of: <book><chapter><section><para>
7478 "The next section of the status line is repeated once for each download "
7479 "thread and indicates the operation being performed and some useful "
7480 "information about what is happening. Sometimes this section will simply read "
7481 "<emphasis>Forking</emphasis> which means the OS is loading the download "
7482 "module. The first word after the [ is the fetch number as shown on the "
7483 "history lines. The next word is the short form name of the object being "
7484 "downloaded. For archives it will contain the name of the package that is "
7488 #. type: Content of: <book><chapter><section><para>
7491 "Inside of the single quote is an informative string indicating the progress "
7492 "of the negotiation phase of the download. Typically it progresses from "
7493 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
7494 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
7495 "value is the number of bytes downloaded from the remote site. Once the "
7496 "download begins this is represented as <literal>102/10.2k</literal> "
7497 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
7498 "expected. The total size is always shown in 4 figure notation to preserve "
7499 "space. After the size display is a percent meter for the file itself. The "
7500 "second last element is the instantaneous average speed. This values is "
7501 "updated every 5 seconds and reflects the rate of data transfer for that "
7502 "period. Finally is shown the estimated transfer time. This is updated "
7503 "regularly and reflects the time to complete everything at the shown transfer "
7507 #. type: Content of: <book><chapter><section><para>
7510 "The status display updates every half second to provide a constant feedback "
7511 "on the download progress while the Get lines scroll back whenever a new file "
7512 "is started. Since the status display is constantly updated it is unsuitable "
7513 "for logging to a file, use the <literal>-q</literal> option to remove the "
7517 #. type: Content of: <book><chapter><section><title>
7522 #. type: Content of: <book><chapter><section><para>
7525 "APT uses <command>dpkg</command> for installing the archives and will switch "
7526 "over to the <command>dpkg</command> interface once downloading is "
7527 "completed. <command>dpkg</command> will also ask a number of questions as it "
7528 "processes the packages and the packages themselves may also ask several "
7529 "questions. Before each question there is usually a description of what it is "
7530 "asking and the questions are too varied to discuss completely here."
7533 #. type: Content of: <book><title>
7535 msgid "Using APT Offline"
7538 #. type: Content of: <book><bookinfo><abstract><para>
7541 "This document describes how to use APT in a non-networked environment, "
7542 "specifically a 'sneaker-net' approach for performing upgrades."
7545 #. type: Content of: <book><bookinfo>
7547 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
7550 #. type: Content of: <book><chapter><title>
7552 msgid "Introduction"
7555 #. type: Content of: <book><chapter><section><title>
7556 #: offline.dbk:1 offline.dbk:1 offline.dbk:1
7560 #. type: Content of: <book><chapter><section><para>
7563 "Normally APT requires direct access to a Debian archive, either from a local "
7564 "media or through a network. Another common complaint is that a Debian "
7565 "machine is on a slow link, such as a modem and another machine has a very "
7566 "fast connection but they are physically distant."
7569 #. type: Content of: <book><chapter><section><para>
7572 "The solution to this is to use large removable media such as a Zip disc or a "
7573 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7574 "archive but can easily fit a subset large enough for most users. The idea is "
7575 "to use APT to generate a list of packages that are required and then fetch "
7576 "them onto the disc using another machine with good connectivity. It is even "
7577 "possible to use another Debian machine with APT or to use a completely "
7578 "different OS and a download tool like wget. Let <emphasis>remote "
7579 "host</emphasis> mean the machine downloading the packages, and "
7580 "<emphasis>target host</emphasis> the one with bad or no connection."
7583 #. type: Content of: <book><chapter><section><para>
7586 "This is achieved by creatively manipulating the APT configuration file. The "
7587 "essential premise to tell APT to look on a disc for it's archive files. Note "
7588 "that the disc should be formatted with a filesystem that can handle long "
7589 "file names such as ext2, fat32 or vfat."
7592 #. type: Content of: <book><chapter><title>
7594 msgid "Using APT on both machines"
7597 #. type: Content of: <book><chapter><section><para>
7600 "APT being available on both machines gives the simplest configuration. The "
7601 "basic idea is to place a copy of the status file on the disc and use the "
7602 "remote machine to fetch the latest package files and decide which packages "
7603 "to download. The disk directory structure should look like:"
7606 #. type: Content of: <book><chapter><section><screen>
7620 #. type: Content of: <book><chapter><section><title>
7622 msgid "The configuration file"
7625 #. type: Content of: <book><chapter><section><para>
7628 "The configuration file should tell APT to store its files on the disc and to "
7629 "use the configuration files on the disc as well. The sources.list should "
7630 "contain the proper sites that you wish to use from the remote machine, and "
7631 "the status file should be a copy of "
7632 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
7633 "host</emphasis>. Please note, if you are using a local archive you must use "
7634 "copy URIs, the syntax is identical to file URIs."
7637 #. type: Content of: <book><chapter><section><para>
7640 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
7644 #. type: Content of: <book><chapter><section><screen>
7650 " /* This is not necessary if the two machines are the same arch, it "
7652 " the remote APT what architecture the target machine is */\n"
7653 " Architecture \"i386\";\n"
7655 " Get::Download-Only \"true\";\n"
7660 " /* Use the disc for state information and redirect the status file from\n"
7661 " the /var/lib/dpkg default */\n"
7662 " State \"/disc/\";\n"
7663 " State::status \"status\";\n"
7665 " // Binary caches will be stored locally\n"
7666 " Cache::archives \"/disc/archives/\";\n"
7667 " Cache \"/tmp/\";\n"
7669 " // Location of the source list.\n"
7670 " Etc \"/disc/\";\n"
7674 #. type: Content of: <book><chapter><section><para>
7677 "More details can be seen by examining the apt.conf man page and the sample "
7678 "configuration file in "
7679 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
7682 #. type: Content of: <book><chapter><section><para>
7685 "On the target machine the first thing to do is mount the disc and copy "
7686 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
7687 "create the directories outlined in the Overview, "
7688 "<emphasis>archives/partial/</emphasis> and "
7689 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
7690 "machine and configure the sources.list. On the remote machine execute the "
7694 #. type: Content of: <book><chapter><section><screen>
7698 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7699 " # apt-get update\n"
7700 " [ APT fetches the package files ]\n"
7701 " # apt-get dist-upgrade\n"
7702 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
7705 #. type: Content of: <book><chapter><section><para>
7708 "The dist-upgrade command can be replaced with any other standard APT "
7709 "commands, particularly dselect-upgrade. You can even use an APT front end "
7710 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
7711 "communicating your selections back to the local computer."
7714 #. type: Content of: <book><chapter><section><para>
7717 "Now the disc contains all of the index files and archives needed to upgrade "
7718 "the target machine. Take the disc back and run:"
7721 #. type: Content of: <book><chapter><section><screen>
7725 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7726 " # apt-get check\n"
7727 " [ APT generates a local copy of the cache files ]\n"
7728 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7729 " [ Or any other APT command ]\n"
7732 #. type: Content of: <book><chapter><section><para>
7735 "It is necessary for proper function to re-specify the status file to be the "
7736 "local one. This is very important!"
7739 #. type: Content of: <book><chapter><section><para>
7742 "If you are using dselect you can do the very risky operation of copying "
7743 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7744 "remote machine are updated. I highly recommend that people only make "
7745 "selections on the local machine - but this may not always be possible. DO "
7746 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7749 #. type: Content of: <book><chapter><title>
7751 msgid "Using APT and wget"
7754 #. type: Content of: <book><chapter><section><para>
7757 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7758 "run on nearly any machine. Unlike the method above this requires that the "
7759 "Debian machine already has a list of available packages."
7762 #. type: Content of: <book><chapter><section><para>
7765 "The basic idea is to create a disc that has only the archive files "
7766 "downloaded from the remote site. This is done by using the --print-uris "
7767 "option to apt-get and then preparing a wget script to actually fetch the "
7771 #. type: Content of: <book><chapter><section><title>
7776 #. type: Content of: <book><chapter><section><para>
7779 "Unlike the previous technique no special configuration files are "
7780 "required. We merely use the standard APT commands to generate the file list."
7783 #. type: Content of: <book><chapter><section><screen>
7787 " # apt-get dist-upgrade\n"
7788 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7789 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7790 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7793 #. type: Content of: <book><chapter><section><para>
7796 "Any command other than dist-upgrade could be used here, including "
7800 #. type: Content of: <book><chapter><section><para>
7803 "The /disc/wget-script file will now contain a list of wget commands to "
7804 "execute in order to fetch the necessary archives. This script should be run "
7805 "with the current directory as the disc's mount point so as to save the "
7806 "output on the disc."
7809 #. type: Content of: <book><chapter><section><para>
7811 msgid "The remote machine would do something like"
7814 #. type: Content of: <book><chapter><section><screen>
7819 " # sh -x ./wget-script\n"
7823 #. type: Content of: <book><chapter><section><para>
7826 "Once the archives are downloaded and the disc returned to the Debian machine "
7827 "installation can proceed using,"
7830 #. type: Content of: <book><chapter><section><screen>
7833 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7836 #. type: Content of: <book><chapter><section><para>
7838 msgid "Which will use the already fetched archives on the disc."