1 # Translation of apt manpages and documentation to LANGUAGE
2 # This file is distributed under the same license as the apt-doc package.
3 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
8 "Project-Id-Version: apt-doc 1.3.1\n"
9 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
10 "POT-Creation-Date: 2016-10-04 19:44+0200\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
23 "<!ENTITY apt-author.team \"\n"
25 " <othername>APT team</othername>\n"
26 " <contrib></contrib>\n"
35 "<!ENTITY apt-qapage \"\n"
37 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
46 "<!-- Boiler plate Bug reporting section -->\n"
47 "<!ENTITY manbugs \"\n"
48 " <refsect1><title>Bugs</title>\n"
49 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
50 " If you wish to report a bug in APT, please see\n"
51 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
52 " &reportbug; command.\n"
62 "<!-- Boiler plate Author section -->\n"
63 "<!ENTITY manauthor \"\n"
64 " <refsect1><title>Author</title>\n"
65 " <para>APT was written by the APT team "
66 "<email>apt@packages.debian.org</email>.\n"
76 "<!-- Should be used within the option section of the text to\n"
77 " put in the blurb about -h, -v, -c and -o -->\n"
78 "<!ENTITY apt-commonoptions \"\n"
79 " <varlistentry><term><option>-h</option></term>\n"
80 " <term><option>--help</option></term>\n"
81 " <listitem><para>Show a short usage summary.\n"
92 " <term><option>-v</option></term>\n"
93 " <term><option>--version</option></term>\n"
94 " <listitem><para>Show the program version.\n"
105 " <term><option>-c</option></term>\n"
106 " <term><option>--config-file</option></term>\n"
107 " <listitem><para>Configuration File; Specify a configuration file to "
109 " The program will read the default configuration file and then this \n"
110 " configuration file. If configuration settings need to be set before "
112 " default configuration files are parsed specify a file with the "
113 "<envar>APT_CONFIG</envar>\n"
114 " environment variable. See &apt-conf; for syntax information.\n"
125 " <term><option>-o</option></term>\n"
126 " <term><option>--option</option></term>\n"
127 " <listitem><para>Set a Configuration Option; This will set an "
129 " configuration option. The syntax is <option>-o "
130 "Foo::Bar=bar</option>.\n"
131 " <option>-o</option> and <option>--option</option> can be used "
133 " times to set different options.\n"
144 "<!-- Should be used within the option section of the text to\n"
145 " put in the blurb about -h, -v, -c and -o -->\n"
146 "<!ENTITY apt-cmdblurb \"\n"
147 " <para>All command line options may be set using the configuration file, "
149 " descriptions indicate the configuration option to set. For boolean\n"
150 " options you can override the config file by using something like \n"
151 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
152 " or several other variations.\n"
161 "<!ENTITY file-aptconf \"\n"
162 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
163 " <listitem><para>APT configuration file.\n"
164 " Configuration Item: "
165 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
173 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
174 " <listitem><para>APT configuration file fragments.\n"
175 " Configuration Item: "
176 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
185 "<!ENTITY file-cachearchives \"\n"
186 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
187 " <listitem><para>Storage area for retrieved package files.\n"
188 " Configuration Item: "
189 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
198 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
199 " <listitem><para>Storage area for package files in transit.\n"
200 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
201 "(<filename>partial</filename> will be implicitly "
202 "appended)</para></listitem>\n"
211 "<!ENTITY file-preferences \"\n"
212 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
213 " <listitem><para>Version preferences file.\n"
214 " This is where you would specify "pinning",\n"
215 " i.e. a preference to get certain packages\n"
216 " from a separate source\n"
217 " or from a different version of a distribution.\n"
218 " Configuration Item: "
219 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
228 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
229 " <listitem><para>File fragments for the version preferences.\n"
230 " Configuration Item: "
231 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
240 "<!ENTITY file-sourceslist \"\n"
241 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
242 " <listitem><para>Locations to fetch packages from.\n"
243 " Configuration Item: "
244 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
253 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
254 " <listitem><para>File fragments for locations to fetch packages from.\n"
255 " Configuration Item: "
256 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
265 "<!ENTITY file-statelists \"\n"
266 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
267 " <listitem><para>Storage area for state information for each package "
268 "resource specified in\n"
270 " Configuration Item: "
271 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
280 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
281 " <listitem><para>Storage area for state information in transit.\n"
282 " Configuration Item: <literal>Dir::State::Lists</literal> "
283 "(<filename>partial</filename> will be implicitly "
284 "appended)</para></listitem>\n"
293 "<!ENTITY file-trustedgpg \"\n"
294 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
295 " <listitem><para>Keyring of local trusted keys, new keys will be added "
297 " Configuration Item: "
298 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
307 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
308 " <listitem><para>File fragments for the trusted keys, additional "
310 " be stored here (by other packages or the administrator).\n"
311 " Configuration Item "
312 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
321 "<!ENTITY file-extended_states \"\n"
323 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
324 " <listitem><para>Status list of auto-installed packages.\n"
325 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
326 " </para></listitem>\n"
335 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
337 " to the other headers like NAME and DESCRIPTION and should therefore be "
339 "<!ENTITY translation-title \"TRANSLATION\">\n"
346 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
348 " to the translation in the past, who is responsible now and maybe "
349 "further information\n"
350 " specially related to your translation. -->\n"
351 "<!ENTITY translation-holder \"\n"
352 " The english translation was done by John Doe "
353 "<email>john@doe.org</email> in 2009,\n"
354 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
356 " Debian Dummy l10n Team "
357 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
365 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
366 "untranslated/fuzzy strings\n"
367 " in a shipped manpage newer/modified paragraphs will maybe appear in "
369 " the generated manpage. This sentence is therefore here to tell the "
371 " is not a mistake by the translator - obviously the target is that at "
373 " releases this sentence is not needed. :) -->\n"
374 "<!ENTITY translation-english \"\n"
375 " Note that this translated document may contain untranslated parts.\n"
376 " This is done on purpose, to avoid losing content when the\n"
377 " translation is lagging behind the original content.\n"
384 "<!-- TRANSLATOR: used as in -o=config_string "
385 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
392 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
393 "synopsis-config-file \"config_file\">"
399 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
400 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
401 "\"target_release\">"
407 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
408 "synopsis-architecture \"architecture\">"
414 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
415 "--> <!ENTITY synopsis-pkg \"pkg\">"
421 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
422 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
428 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
429 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
435 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
436 "awesome --> <!ENTITY synopsis-regex \"regex\">"
442 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
443 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
449 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
450 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
451 "\"temporary_directory\">"
457 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
458 "synopsis-filename \"filename\">"
464 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
465 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
471 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
472 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
479 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
480 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
487 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
488 "generate section --> <!ENTITY synopsis-section \"section\">"
494 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
495 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
498 #. type: Content of: <refentry><refmeta><manvolnum>
499 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
500 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
504 #. type: Content of: <refentry><refmeta><refmiscinfo>
505 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
506 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
507 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
508 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
512 #. type: Content of: <refentry><refnamediv><refpurpose>
514 msgid "command-line interface"
517 #. type: Content of: <refentry><refsect1><title>
518 #: apt.8.xml:1 apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1
519 #: apt-mark.8.xml:1 apt-secure.8.xml:1 apt-cdrom.8.xml:1 apt-config.8.xml:1
520 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
521 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
525 #. type: Content of: <refentry><refsect1><para>
528 "<command>apt</command> provides a high-level commandline interface for the "
529 "package management system. It is intended as an end user interface and "
530 "enables some options better suited for interactive usage by default compared "
531 "to more specialized APT tools like &apt-get; and &apt-cache;."
534 #. type: Content of: <refentry><refsect1><para>
537 "Much like <command>apt</command> itself, its manpage is intended as an end "
538 "user interface and as such only mentions the most used commands and options "
539 "partly to not duplicate information in multiple places and partly to avoid "
540 "overwhelming readers with a cornucopia of options and details."
543 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
544 #: apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1 apt.8.xml:1
548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
551 "<option>update</option> is used to download package information from all "
552 "configured sources. Other commands operate on this data to e.g. perform "
553 "package upgrades or search in and display details about all packages "
554 "available for installation."
557 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
560 "<option>upgrade</option> is used to install available upgrades of all "
561 "packages currently installed on the system from the sources configured via "
562 "&sources-list;. New packages will be installed if required to statisfy "
563 "dependencies, but existing packages will never be removed. If an upgrade for "
564 "a package requires the remove of an installed package the upgrade for this "
565 "package isn't performed."
568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
571 "<literal>full-upgrade</literal> performs the function of upgrade but will "
572 "remove currently installed packages if this is needed to upgrade the system "
576 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
577 #: apt.8.xml:1 apt.8.xml:1 apt-key.8.xml:1
581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
584 "Performs the requested action on one or more packages specified via ®ex;, "
585 "&glob; or exact match. The requested action can be overridden for specific "
586 "packages by append a plus (+) to the package name to install this package or "
587 "a minus (-) to remove it."
590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
593 "A specific version of a package can be selected for installation by "
594 "following the package name with an equals (=) and the version of the package "
595 "to select. Alternatively the version from a specific release can be selected "
596 "by following the package name with a forward slash (/) and codename "
597 "(&debian-stable-codename;, &debian-testing-codename;, sid …) or suite name "
598 "(stable, testing, unstable). This will also select versions from this "
599 "release for dependencies of this package if needed to satisfy the request."
602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
605 "Removing a package removes all packaged data, but leaves usually small "
606 "(modified) user configuration files behind, in case the remove was an "
607 "accident. Just issuing an installation request for the accidentally removed "
608 "package will restore its function as before in that case. On the other hand "
609 "you can get rid of these leftovers by calling <command>purge</command> even "
610 "on already removed packages. Note that this does not affect any data or "
611 "configuration stored in your home directory."
614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
617 "<literal>autoremove</literal> is used to remove packages that were "
618 "automatically installed to satisfy dependencies for other packages and are "
619 "now no longer needed as dependencies changed or the package(s) needing them "
620 "were removed in the meantime."
623 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
626 "You should check that the list does not include applications you have grown "
627 "to like even though they were once installed just as a dependency of another "
628 "package. You can mark such a package as manually installed by using "
629 "&apt-mark;. Packages which you have installed explicitly via "
630 "<command>install</command> are also never proposed for automatic removal."
633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
634 #: apt.8.xml:1 apt.8.xml:1
635 msgid "(&apt-cache;)"
638 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
641 "<option>search</option> can be used to search for the given ®ex; term(s) "
642 "in the list of available packages and display matches. This can e.g. be "
643 "useful if you are looking for packages having a specific feature. If you "
644 "are looking for a package including a specific file try &apt-file;."
647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
650 "Show information about the given package(s) including its dependencies, "
651 "installation and download size, sources the package is available from, the "
652 "description of the packages content and much more. It can e.g. be helpful to "
653 "look at this information before allowing &apt; to remove a package or while "
654 "searching for new packages to install."
657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
658 #: apt.8.xml:1 apt.8.xml:1
659 msgid "(work-in-progress)"
662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
665 "<option>list</option> is somewhat similar to <command>dpkg-query "
666 "--list</command> in that it can display a list of packages satisfying "
667 "certain criteria. It supports &glob; patterns for matching package names as "
668 "well as options to list installed (<option>--installed</option>), "
669 "upgradeable (<option>--upgradeable</option>) or all available "
670 "(<option>--all-versions</option>) versions."
673 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
676 "<literal>edit-sources</literal> lets you edit your &sources-list; files in "
677 "your preferred texteditor while also providing basic sanity checks."
680 #. type: Content of: <refentry><refsect1><title>
682 msgid "Script Usage and Differences from Other APT Tools"
685 #. type: Content of: <refentry><refsect1><para>
688 "The &apt; commandline is designed as an end-user tool and it may change "
689 "behavior between versions. While it tries not to break backward "
690 "compatibility this is not guaranteed either if a change seems beneficial for "
694 #. type: Content of: <refentry><refsect1><para>
697 "All features of &apt; are available in dedicated APT tools like &apt-get; "
698 "and &apt-cache; as well. &apt; just changes the default value of some "
699 "options (see &apt-conf; and specifically the Binary scope). So you should "
700 "prefer using these commands (potentially with some additional options "
701 "enabled) in your scripts as they keep backward compatibility as much as "
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 "
1030 "file &apt-acquire-additional-files; shipped by the "
1031 "<package>apt-doc</package> package."
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 "Do not show a list of all packages that are to be upgraded. Configuration "
1155 "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. See also &apt-secure; for details on the "
1403 "concept and the implications. Configuration Item: "
1404 "<literal>Acquire::AllowInsecureRepositories</literal>."
1407 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1410 "Show user friendly progress information in the terminal window when packages "
1411 "are installed, upgraded or removed. For a machine parsable version of this "
1412 "data see README.progress-reporting in the apt doc directory. Configuration "
1413 "Item: <literal>Dpkg::Progress</literal> and "
1414 "<literal>Dpkg::Progress-Fancy</literal>."
1417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1420 "Adds the given file as a source for metadata. Can be repeated to add "
1421 "multiple files. See <option>--with-source</option> description in "
1422 "&apt-cache; for further details."
1425 #. type: Content of: <refentry><refsect1><title>
1426 #: apt-get.8.xml:1 apt-cache.8.xml:1 apt-key.8.xml:1 apt-mark.8.xml:1
1427 #: apt.conf.5.xml:1 apt_preferences.5.xml:1
1431 #. type: Content of: <refentry><refsect1><para>
1434 "&apt-cache;, &apt-cdrom;, &dpkg;, &sources-list;, &apt-conf;, &apt-config;, "
1435 "&apt-secure;, The APT User's guide in &guidesdir;, &apt-preferences;, the "
1439 #. type: Content of: <refentry><refsect1><para>
1442 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
1446 #. type: Content of: <refentry><refnamediv><refpurpose>
1447 #: apt-cache.8.xml:1
1448 msgid "query the APT cache"
1451 #. type: Content of: <refentry><refsect1><para>
1452 #: apt-cache.8.xml:1
1454 "<command>apt-cache</command> performs a variety of operations on APT's "
1455 "package cache. <command>apt-cache</command> does not manipulate the state of "
1456 "the system but does provide operations to search and generate interesting "
1457 "output from the package metadata. The metadata is acquired and updated via "
1458 "the 'update' command of e.g. <command>apt-get</command>, so that it can be "
1459 "outdated if the last update is too long ago, but in exchange "
1460 "<command>apt-cache</command> works independently of the availability of the "
1461 "configured sources (e.g. offline)."
1464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1465 #: apt-cache.8.xml:1
1467 "<literal>gencaches</literal> creates APT's package cache. This is done "
1468 "implicitly by all commands needing this cache if it is missing or outdated."
1471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1472 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1473 #: apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1 apt-cache.8.xml:1
1474 msgid "&synopsis-pkg;"
1477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1478 #: apt-cache.8.xml:1
1480 "<literal>showpkg</literal> displays information about the packages listed on "
1481 "the command line. Remaining arguments are package names. The available "
1482 "versions and reverse dependencies of each package listed are listed, as well "
1483 "as forward dependencies for each version. Forward (normal) dependencies are "
1484 "those packages upon which the package in question depends; reverse "
1485 "dependencies are those packages that depend upon the package in "
1486 "question. Thus, forward dependencies must be satisfied for a package, but "
1487 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
1488 "libreadline2</command> would produce output similar to the following:"
1491 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1492 #: apt-cache.8.xml:1
1495 "Package: libreadline2\n"
1496 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
1497 "Reverse Depends: \n"
1498 " libreadlineg2,libreadline2\n"
1499 " libreadline2-altdev,libreadline2\n"
1501 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
1504 "Reverse Provides: \n"
1507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1508 #: apt-cache.8.xml:1
1510 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
1511 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
1512 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
1513 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
1514 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
1515 "installed. For the specific meaning of the remainder of the output it is "
1516 "best to consult the apt source code."
1519 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1520 #: apt-cache.8.xml:1
1522 "<literal>stats</literal> displays some statistics about the cache. No "
1523 "further arguments are expected. Statistics reported are:"
1526 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1527 #: apt-cache.8.xml:1
1529 "<literal>Total package names</literal> is the number of package names found "
1533 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1534 #: apt-cache.8.xml:1
1536 "<literal>Normal packages</literal> is the number of regular, ordinary "
1537 "package names; these are packages that bear a one-to-one correspondence "
1538 "between their names and the names used by other packages for them in "
1539 "dependencies. The majority of packages fall into this category."
1542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1543 #: apt-cache.8.xml:1
1545 "<literal>Pure virtual packages</literal> is the number of packages that "
1546 "exist only as a virtual package name; that is, packages only \"provide\" the "
1547 "virtual package name, and no package actually uses the name. For instance, "
1548 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
1549 "several packages provide \"mail-transport-agent\", but there is no package "
1550 "named \"mail-transport-agent\"."
1553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1554 #: apt-cache.8.xml:1
1556 "<literal>Single virtual packages</literal> is the number of packages with "
1557 "only one package providing a particular virtual package. For example, in the "
1558 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
1559 "package, xless, provides \"X11-text-viewer\"."
1562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1563 #: apt-cache.8.xml:1
1565 "<literal>Mixed virtual packages</literal> is the number of packages that "
1566 "either provide a particular virtual package or have the virtual package name "
1567 "as the package name. For instance, in the Debian system, \"debconf\" is both "
1568 "an actual package, and provided by the debconf-tiny package."
1571 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1572 #: apt-cache.8.xml:1
1574 "<literal>Missing</literal> is the number of package names that were "
1575 "referenced in a dependency but were not provided by any package. Missing "
1576 "packages may be an evidence if a full distribution is not accessed, or if a "
1577 "package (real or virtual) has been dropped from the distribution. Usually "
1578 "they are referenced from Conflicts or Breaks statements."
1581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1582 #: apt-cache.8.xml:1
1584 "<literal>Total distinct</literal> versions is the number of package versions "
1585 "found in the cache. If more than one distribution is being accessed (for "
1586 "instance, \"stable\" and \"unstable\"), this value can be considerably "
1587 "larger than the number of total package names."
1590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
1591 #: apt-cache.8.xml:1
1593 "<literal>Total dependencies</literal> is the number of dependency "
1594 "relationships claimed by all of the packages in the cache."
1597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1598 #: apt-cache.8.xml:1
1600 "<literal>showsrc</literal> displays all the source package records that "
1601 "match the given package names. All versions are shown, as well as all "
1602 "records that declare the name to be a binary package. Use "
1603 "<option>--only-source</option> to display only source package names."
1606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1607 #: apt-cache.8.xml:1
1609 "<literal>dump</literal> shows a short listing of every package in the "
1610 "cache. It is primarily for debugging."
1613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1614 #: apt-cache.8.xml:1
1616 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
1617 "suitable for use with &dpkg; and is used by the &dselect; method."
1620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1621 #: apt-cache.8.xml:1
1623 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
1627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1628 #: apt-cache.8.xml:1
1630 "<literal>show</literal> performs a function similar to <command>dpkg "
1631 "--print-avail</command>; it displays the package records for the named "
1635 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1636 #: apt-cache.8.xml:1
1637 msgid "&synopsis-regex;"
1640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1641 #: apt-cache.8.xml:1
1643 "<literal>search</literal> performs a full text search on all available "
1644 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
1645 "the package names and the descriptions for an occurrence of the regular "
1646 "expression and prints out the package name and the short description, "
1647 "including virtual package names. If <option>--full</option> is given then "
1648 "output identical to <literal>show</literal> is produced for each matched "
1649 "package, and if <option>--names-only</option> is given then the long "
1650 "description is not searched, only the package name and provided packages "
1654 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1655 #: apt-cache.8.xml:1
1657 "Separate arguments can be used to specify multiple search patterns that are "
1661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1662 #: apt-cache.8.xml:1
1664 "<literal>depends</literal> shows a listing of each dependency a package has "
1665 "and all the possible other packages that can fulfill that dependency."
1668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1669 #: apt-cache.8.xml:1
1671 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
1675 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1676 #: apt-cache.8.xml:1
1677 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
1680 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1681 #: apt-cache.8.xml:1
1683 "This command prints the name of each package APT knows. The optional "
1684 "argument is a prefix match to filter the name list. The output is suitable "
1685 "for use in a shell tab complete function and the output is generated "
1686 "extremely quickly. This command is best used with the "
1687 "<option>--generate</option> option."
1690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1691 #: apt-cache.8.xml:1
1693 "Note that a package which APT knows of is not necessarily available to "
1694 "download, installable or installed, e.g. virtual packages are also listed in "
1695 "the generated list."
1698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1699 #: apt-cache.8.xml:1
1701 "<literal>dotty</literal> takes a list of packages on the command line and "
1702 "generates output suitable for use by dotty from the <ulink "
1703 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
1704 "package. The result will be a set of nodes and edges representing the "
1705 "relationships between the packages. By default the given packages will trace "
1706 "out all dependent packages; this can produce a very large graph. To limit "
1707 "the output to only the packages listed on the command line, set the "
1708 "<literal>APT::Cache::GivenOnly</literal> option."
1711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1712 #: apt-cache.8.xml:1
1714 "The resulting nodes will have several shapes; normal packages are boxes, "
1715 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
1716 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
1717 "packages), blue lines are pre-depends, green lines are conflicts."
1720 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1721 #: apt-cache.8.xml:1
1722 msgid "Caution, dotty cannot graph larger sets of packages."
1725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1726 #: apt-cache.8.xml:1
1728 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
1729 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
1733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1734 #: apt-cache.8.xml:1
1735 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
1738 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1739 #: apt-cache.8.xml:1
1741 "<literal>policy</literal> is meant to help debug issues relating to the "
1742 "preferences file. With no arguments it will print out the priorities of each "
1743 "source. Otherwise it prints out detailed information about the priority "
1744 "selection of the named package."
1747 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1748 #: apt-cache.8.xml:1
1750 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1751 "to mimic the output format and a subset of the functionality of the Debian "
1752 "archive management tool, <literal>madison</literal>. It displays available "
1753 "versions of a package in a tabular format. Unlike the original "
1754 "<literal>madison</literal>, it can only display information for the "
1755 "architecture for which APT has retrieved package lists "
1756 "(<literal>APT::Architecture</literal>)."
1759 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1760 #: apt-cache.8.xml:1
1762 "Select the file to store the package cache. The package cache is the primary "
1763 "cache used by all operations. Configuration Item: "
1764 "<literal>Dir::Cache::pkgcache</literal>."
1767 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1768 #: apt-cache.8.xml:1
1770 "Select the file to store the source cache. The source is used only by "
1771 "<literal>gencaches</literal> and it stores a parsed version of the package "
1772 "information from remote sources. When building the package cache the source "
1773 "cache is used to avoid reparsing all of the package files. Configuration "
1774 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1778 #: apt-cache.8.xml:1
1780 "Quiet; produces output suitable for logging, omitting progress indicators. "
1781 "More q's will produce more quietness up to a maximum of 2. You can also use "
1782 "<option>-q=#</option> to set the quietness level, overriding the "
1783 "configuration file. Configuration Item: <literal>quiet</literal>."
1786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1787 #: apt-cache.8.xml:1
1789 "Print only important dependencies; for use with <literal>unmet</literal> and "
1790 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
1791 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
1794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1795 #: apt-cache.8.xml:1
1797 "Per default the <command>depends</command> and <command>rdepends</command> "
1798 "print all dependencies. This can be tweaked with these flags which will omit "
1799 "the specified dependency type. Configuration Item: "
1800 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1801 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1804 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1805 #: apt-cache.8.xml:1
1807 "Per default <command>depends</command> and <command>rdepends</command> print "
1808 "only dependencies explicitly expressed in the metadata. With this flag it "
1809 "will also show dependencies implicitly added based on the encountered data. "
1810 "A <literal>Conflicts: foo</literal> e.g. expresses implicitly that this "
1811 "package also conflicts with the package foo from any other architecture. "
1812 "Configuration Item: <literal>APT::Cache::ShowImplicit</literal>."
1815 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1816 #: apt-cache.8.xml:1
1818 "Print full package records when searching. Configuration Item: "
1819 "<literal>APT::Cache::ShowFull</literal>."
1822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1823 #: apt-cache.8.xml:1
1825 "Print full records for all available versions. This is the default; to turn "
1826 "it off, use <option>--no-all-versions</option>. If "
1827 "<option>--no-all-versions</option> is specified, only the candidate version "
1828 "will be displayed (the one which would be selected for installation). This "
1829 "option is only applicable to the <literal>show</literal> command. "
1830 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1833 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1834 #: apt-cache.8.xml:1
1836 "Perform automatic package cache regeneration, rather than use the cache as "
1837 "it is. This is the default; to turn it off, use "
1838 "<option>--no-generate</option>. Configuration Item: "
1839 "<literal>APT::Cache::Generate</literal>."
1842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1843 #: apt-cache.8.xml:1
1845 "Only search on the package and provided package names, not the long "
1846 "descriptions. Configuration Item: <literal>APT::Cache::NamesOnly</literal>."
1849 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1850 #: apt-cache.8.xml:1
1852 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1853 "and missing dependencies. Configuration Item: "
1854 "<literal>APT::Cache::AllNames</literal>."
1857 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1858 #: apt-cache.8.xml:1
1860 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1861 "that all packages mentioned are printed once. Configuration Item: "
1862 "<literal>APT::Cache::RecurseDepends</literal>."
1865 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1866 #: apt-cache.8.xml:1
1868 "Limit the output of <literal>depends</literal> and "
1869 "<literal>rdepends</literal> to packages which are currently installed. "
1870 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1873 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1874 #: apt-cache.8.xml:1
1876 "Adds the given file as a source for metadata. Can be repeated to add "
1877 "multiple files. Supported are currently <literal>*.deb</literal>, "
1878 "<literal>*.dsc</literal>, <literal>*.changes</literal>, "
1879 "<literal>Sources</literal> and <literal>Packages</literal> files as well as "
1880 "source package directories. Files are matched based on their name only, not "
1884 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1885 #: apt-cache.8.xml:1
1887 "<literal>Sources</literal> and <literal>Packages</literal> can be compressed "
1888 "in any format apt supports as long as they have the correct extension. If "
1889 "you need to store multiple of these files in one directory you can prefix a "
1890 "name of your choice with the last character being an underscore "
1891 "(\"<literal>_</literal>\"). Example: my.example_Packages.xz"
1894 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1895 #: apt-cache.8.xml:1
1897 "Note that these sources are treated as trusted (see &apt-secure;). "
1898 "Configuration Item: <literal>APT::Sources::With</literal>."
1901 #. type: Content of: <refentry><refsect1><para>
1902 #: apt-cache.8.xml:1
1903 msgid "&apt-conf;, &sources-list;, &apt-get;"
1906 #. type: Content of: <refentry><refsect1><para>
1907 #: apt-cache.8.xml:1
1909 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1913 #. type: Content of: <refentry><refnamediv><refpurpose>
1915 msgid "APT key management utility"
1918 #. type: Content of: <refentry><refsect1><para>
1921 "<command>apt-key</command> is used to manage the list of keys used by apt to "
1922 "authenticate packages. Packages which have been authenticated using these "
1923 "keys will be considered trusted."
1926 #. type: Content of: <refentry><refsect1><para>
1929 "Note that if usage of <command>apt-key</command> is desired the additional "
1930 "installation of the GNU Privacy Guard suite (packaged in "
1931 "<package>gnupg</package>) is required. For this reason alone the "
1932 "programmatic usage (especially in package maintainerscripts!) is strongly "
1933 "discouraged. Further more the output format of all commands is undefined "
1934 "and can and does change whenever the underlying commands "
1935 "change. <command>apt-key</command> will try to detect such usage and "
1936 "generates warnings on stderr in these cases."
1939 #. type: Content of: <refentry><refsect1><title>
1944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1947 "Add a new key to the list of trusted keys. The key is read from the "
1948 "filename given with the parameter &synopsis-param-filename; or if the "
1949 "filename is <literal>-</literal> from standard input."
1952 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1955 "It is critical that keys added manually via <command>apt-key</command> are "
1956 "verified to belong to the owner of the repositories they claim to be for "
1957 "otherwise the &apt-secure; infrastructure is completely undermined."
1960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1963 "Instead of using this command a keyring can be placed directly in the "
1964 "<filename>/etc/apt/trusted.gpg.d/</filename> directory with a descriptive "
1965 "name (same rules for filename apply as for &apt-conf; files) and "
1966 "\"<literal>gpg</literal>\" as file extension."
1969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1971 msgid "Remove a key from the list of trusted keys."
1974 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1976 msgid "Output the key &synopsis-param-keyid; to standard output."
1979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1981 msgid "Output all trusted keys to standard output."
1984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1986 msgid "List trusted keys with fingerprints."
1989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1992 "Pass advanced options to gpg. With <command>adv --recv-key</command> you can "
1993 "e.g. download key from keyservers directly into the the trusted set of "
1994 "keys. Note that there are <emphasis>no</emphasis> checks performed, so it is "
1995 "easy to completely undermine the &apt-secure; infrastructure if used without "
1999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2001 msgid "(deprecated)"
2004 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2007 "Update the local keyring with the archive keyring and remove from the local "
2008 "keyring the archive keys which are no longer valid. The archive keyring is "
2009 "shipped in the <literal>archive-keyring</literal> package of your "
2010 "distribution, e.g. the &keyring-package; package in &keyring-distro;."
2013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2016 "Note that a distribution does not need to and in fact should not use this "
2017 "command any longer and instead ship keyring files in the "
2018 "<filename>/etc/apt/trusted.gpg</filename> directory directly as this avoids "
2019 "a dependency on <package>gnupg</package> and it is easier to manage keys by "
2020 "simply adding and removing files for maintainers and users alike."
2023 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2026 "Perform an update working similarly to the <command>update</command> command "
2027 "above, but get the archive keyring from a URI instead and validate it "
2028 "against a master key. This requires an installed &wget; and an APT build "
2029 "configured to have a server to fetch from and a master keyring to validate. "
2030 "APT in Debian does not support this command, relying on "
2031 "<command>update</command> instead, but Ubuntu's APT does."
2034 #. type: Content of: <refentry><refsect1><title>
2035 #: apt-key.8.xml:1 apt-mark.8.xml:1 apt-mark.8.xml:1 apt-cdrom.8.xml:1
2039 #. type: Content of: <refentry><refsect1><para>
2042 "Note that options need to be defined before the commands described in the "
2046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2049 "With this option it is possible to specify a particular keyring file the "
2050 "command should operate on. The default is that a command is executed on the "
2051 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2052 "<filename>trusted.gpg.d</filename> directory, though "
2053 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2054 "e.g. new keys are added to this one."
2057 #. type: Content of: <refentry><refsect1><para>
2059 msgid "&apt-get;, &apt-secure;"
2062 #. type: Content of: <refentry><refnamediv><refpurpose>
2064 msgid "show, set and unset various settings for a package"
2067 #. type: Content of: <refentry><refsect1><para>
2070 "<command>apt-mark</command> can be used as a unified front-end to set "
2071 "various settings for a package, such as marking a package as being "
2072 "automatically/manually installed or changing <command>dpkg</command> "
2073 "selections such as hold, install, deinstall and purge which are respected "
2074 "e.g. by <command>apt-get dselect-upgrade</command> or "
2075 "<command>aptitude</command>."
2078 #. type: Content of: <refentry><refsect1><title>
2080 msgid "Automatically and Manually Installed Packages"
2083 #. type: Content of: <refentry><refsect1><para>
2086 "When you request that a package is installed, and as a result other packages "
2087 "are installed to satisfy its dependencies, the dependencies are marked as "
2088 "being automatically installed, while the package you installed explicitly is "
2089 "marked as manually installed. Once an automatically installed package is no "
2090 "longer depended on by any manually installed package it is considered no "
2091 "longer needed and e.g. <command>apt-get</command> or "
2092 "<command>aptitude</command> will at least suggest removing them."
2095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2098 "<literal>auto</literal> is used to mark a package as being automatically "
2099 "installed, which will cause the package to be removed when no more manually "
2100 "installed packages depend on this package."
2103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2106 "<literal>manual</literal> is used to mark a package as being manually "
2107 "installed, which will prevent the package from being automatically removed "
2108 "if no other packages depend on it."
2111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2114 "<literal>showauto</literal> is used to print a list of automatically "
2115 "installed packages with each package on a new line. All automatically "
2116 "installed packages will be listed if no package is given. If packages are "
2117 "given only those which are automatically installed will be shown."
2120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2123 "<literal>showmanual</literal> can be used in the same way as "
2124 "<literal>showauto</literal> except that it will print a list of manually "
2125 "installed packages instead."
2128 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2131 "Read/Write package stats from the filename given with the parameter "
2132 "&synopsis-param-filename; instead of from the default location, which is "
2133 "<filename>extended_status</filename> in the directory defined by the "
2134 "Configuration Item: <literal>Dir::State</literal>."
2137 #. type: Content of: <refentry><refsect1><title>
2139 msgid "Prevent Changes for a Package"
2142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2145 "<literal>hold</literal> is used to mark a package as held back, which will "
2146 "prevent the package from being automatically installed, upgraded or removed."
2149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2152 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2153 "package to allow all actions again."
2156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2159 "<literal>showhold</literal> is used to print a list of packages on hold in "
2160 "the same way as for the other show commands."
2163 #. type: Content of: <refentry><refsect1><title>
2165 msgid "Schedule Packages for Install, Remove and Purge"
2168 #. type: Content of: <refentry><refsect1><para>
2171 "Some front-ends like <command>apt-get dselect-upgrade</command> can be used "
2172 "to apply previously scheduled changes to the install state of packages. Such "
2173 "changes can be scheduled with the <option>install</option>, "
2174 "<option>remove</option> (also known as <option>deinstall</option>) and "
2175 "<option>purge</option> commands. Packages with a specific selection can be "
2176 "displayed with <option>showinstall</option>, <option>showremove</option> and "
2177 "<option>showpurge</option> respectively. More information about these so "
2178 "called dpkg selections can be found in &dpkg;."
2181 #. type: Content of: <refentry><refsect1><para>
2184 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2188 #. type: Content of: <refentry><refnamediv><refpurpose>
2189 #: apt-secure.8.xml:1
2190 msgid "Archive authentication support for APT"
2193 #. type: Content of: <refentry><refsect1><para>
2194 #: apt-secure.8.xml:1
2196 "Starting with version 0.6, <command>APT</command> contains code that does "
2197 "signature checking of the Release file for all repositories. This ensures "
2198 "that data like packages in the archive can't be modified by people who have "
2199 "no access to the Release file signing key. Starting with version 1.1 "
2200 "<command>APT</command> requires repositories to provide recent "
2201 "authentication information for unimpeded usage of the repository."
2204 #. type: Content of: <refentry><refsect1><para>
2205 #: apt-secure.8.xml:1
2207 "If an archive has an unsigned Release file or no Release file at all current "
2208 "APT versions will refuse to download data from them by default in "
2209 "<command>update</command> operations and even if forced to download "
2210 "front-ends like &apt-get; will require explicit confirmation if an "
2211 "installation request includes a package from such an unauthenticated "
2215 #. type: Content of: <refentry><refsect1><para>
2216 #: apt-secure.8.xml:1
2218 "As a temporary exception &apt-get; (not &apt;!) raises warnings only if it "
2219 "encounters unauthenticated archives to give a slightly longer grace period "
2220 "on this backward compatibility effecting change. This exception will be "
2221 "removed in future releases and you can opt-out of this grace period by "
2222 "setting the configuration option "
2223 "<option>Binary::apt-get::Acquire::AllowInsecureRepositories</option> to "
2224 "<literal>false</literal> or "
2225 "<option>--no-allow-insecure-repositories</option> on the command line."
2228 #. type: Content of: <refentry><refsect1><para>
2229 #: apt-secure.8.xml:1
2231 "You can force all APT clients to raise only warnings by setting the "
2232 "configuration option <option>Acquire::AllowInsecureRepositories</option> to "
2233 "<literal>true</literal>. Individual repositories can also be allowed to be "
2234 "insecure via the &sources-list; option "
2235 "<literal>allow-insecure=yes</literal>. Note that insecure repositories are "
2236 "strongly discouraged and all options to force apt to continue supporting "
2237 "them will eventually be removed. Users also have the "
2238 "<option>Trusted</option> option available to disable even the warnings, but "
2239 "be sure to understand the implications as detailed in &sources-list;."
2242 #. type: Content of: <refentry><refsect1><para>
2243 #: apt-secure.8.xml:1
2245 "A repository which previously was authentication but would loose this state "
2246 "in an <command>update</command> operation raises an error in all APT clients "
2247 "irrespective of the option to allow or forbid usage of insecure "
2248 "repositories. The error can be overcome by additionally setting "
2249 "<option>Acquire::AllowDowngradeToInsecureRepositories</option> to "
2250 "<literal>true</literal> or for Individual repositories with the "
2251 "&sources-list; option <literal>allow-downgrade-to-insecure=yes</literal>."
2254 #. type: Content of: <refentry><refsect1><para>
2255 #: apt-secure.8.xml:1
2257 "Note: All APT-based package management front-ends like &apt-get;, &aptitude; "
2258 "and &synaptic; support this authentication feature, so this manpage uses "
2259 "<literal>APT</literal> to refer to them all for simplicity only."
2262 #. type: Content of: <refentry><refsect1><title>
2263 #: apt-secure.8.xml:1
2264 msgid "Trusted Repositories"
2267 #. type: Content of: <refentry><refsect1><para>
2268 #: apt-secure.8.xml:1
2270 "The chain of trust from an APT archive to the end user is made up of several "
2271 "steps. <command>apt-secure</command> is the last step in this chain; "
2272 "trusting an archive does not mean that you trust its packages not to contain "
2273 "malicious code, but means that you trust the archive maintainer. It's the "
2274 "archive maintainer's responsibility to ensure that the archive's integrity "
2278 #. type: Content of: <refentry><refsect1><para>
2279 #: apt-secure.8.xml:1
2281 "apt-secure does not review signatures at a package level. If you require "
2282 "tools to do this you should look at <command>debsig-verify</command> and "
2283 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2284 "packages respectively)."
2287 #. type: Content of: <refentry><refsect1><para>
2288 #: apt-secure.8.xml:1
2290 "The chain of trust in Debian starts (e.g.) when a maintainer uploads a new "
2291 "package or a new version of a package to the Debian archive. In order to "
2292 "become effective, this upload needs to be signed by a key contained in one "
2293 "of the Debian package maintainer keyrings (available in the debian-keyring "
2294 "package). Maintainers' keys are signed by other maintainers following "
2295 "pre-established procedures to ensure the identity of the key holder. Similar "
2296 "procedures exist in all Debian-based distributions."
2299 #. type: Content of: <refentry><refsect1><para>
2300 #: apt-secure.8.xml:1
2302 "Once the uploaded package is verified and included in the archive, the "
2303 "maintainer signature is stripped off, and checksums of the package are "
2304 "computed and put in the Packages file. The checksums of all of the Packages "
2305 "files are then computed and put into the Release file. The Release file is "
2306 "then signed by the archive key for this &keyring-distro; release, and "
2307 "distributed alongside the packages and the Packages files on "
2308 "&keyring-distro; mirrors. The keys are in the &keyring-distro; archive "
2309 "keyring available in the &keyring-package; package."
2312 #. type: Content of: <refentry><refsect1><para>
2313 #: apt-secure.8.xml:1
2315 "End users can check the signature of the Release file, extract a checksum of "
2316 "a package from it and compare it with the checksum of the package they "
2317 "downloaded by hand - or rely on APT doing this automatically."
2320 #. type: Content of: <refentry><refsect1><para>
2321 #: apt-secure.8.xml:1
2323 "Notice that this is distinct from checking signatures on a per package "
2324 "basis. It is designed to prevent two possible attacks:"
2327 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2328 #: apt-secure.8.xml:1
2330 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2331 "checking, malicious agents can introduce themselves into the package "
2332 "download process and provide malicious software either by controlling a "
2333 "network element (router, switch, etc.) or by redirecting traffic to a rogue "
2334 "server (through ARP or DNS spoofing attacks)."
2337 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2338 #: apt-secure.8.xml:1
2340 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2341 "malicious agent can compromise a mirror host and modify the files in it to "
2342 "propagate malicious software to all users downloading packages from that "
2346 #. type: Content of: <refentry><refsect1><para>
2347 #: apt-secure.8.xml:1
2349 "However, it does not defend against a compromise of the master server itself "
2350 "(which signs the packages) or against a compromise of the key used to sign "
2351 "the Release files. In any case, this mechanism can complement a per-package "
2355 #. type: Content of: <refentry><refsect1><title>
2356 #: apt-secure.8.xml:1
2357 msgid "User Configuration"
2360 #. type: Content of: <refentry><refsect1><para>
2361 #: apt-secure.8.xml:1
2363 "<command>apt-key</command> is the program that manages the list of keys used "
2364 "by APT to trust repositories. It can be used to add or remove keys as well "
2365 "as list the trusted keys. Limiting which key(s) are able to sign which "
2366 "archive is possible via the <option>Signed-By</option> in &sources-list;."
2369 #. type: Content of: <refentry><refsect1><para>
2370 #: apt-secure.8.xml:1
2372 "Note that a default installation already contains all keys to securely "
2373 "acquire packages from the default repositories, so fiddling with "
2374 "<command>apt-key</command> is only needed if third-party repositories are "
2378 #. type: Content of: <refentry><refsect1><para>
2379 #: apt-secure.8.xml:1
2381 "In order to add a new key you need to first download it (you should make "
2382 "sure you are using a trusted communication channel when retrieving it), add "
2383 "it with <command>apt-key</command> and then run <command>apt-get "
2384 "update</command> so that apt can download and verify the "
2385 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
2386 "from the archives you have configured."
2389 #. type: Content of: <refentry><refsect1><title>
2390 #: apt-secure.8.xml:1
2391 msgid "Archive Configuration"
2394 #. type: Content of: <refentry><refsect1><para>
2395 #: apt-secure.8.xml:1
2397 "If you want to provide archive signatures in an archive under your "
2398 "maintenance you have to:"
2401 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2402 #: apt-secure.8.xml:1
2404 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
2405 "already. You can do this by running <command>apt-ftparchive "
2406 "release</command> (provided in apt-utils)."
2409 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2410 #: apt-secure.8.xml:1
2412 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
2413 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
2414 "Release.gpg Release</command>."
2417 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2418 #: apt-secure.8.xml:1
2420 "<emphasis>Publish the key fingerprint</emphasis>, so that your users will "
2421 "know what key they need to import in order to authenticate the files in the "
2422 "archive. It is best to ship your key in its own keyring package like "
2423 "&keyring-distro; does with &keyring-package; to be able to distribute "
2424 "updates and key transitions automatically later."
2427 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2428 #: apt-secure.8.xml:1
2430 "<emphasis>Provide instructions on how to add your archive and "
2431 "key</emphasis>. If your users can't acquire your key securely the chain of "
2432 "trust described above is broken. How you can help users add your key "
2433 "depends on your archive and target audience ranging from having your keyring "
2434 "package included in another archive users already have configured (like the "
2435 "default repositories of their distribution) to leveraging the web of trust."
2438 #. type: Content of: <refentry><refsect1><para>
2439 #: apt-secure.8.xml:1
2441 "Whenever the contents of the archive change (new packages are added or "
2442 "removed) the archive maintainer has to follow the first two steps outlined "
2446 #. type: Content of: <refentry><refsect1><para>
2447 #: apt-secure.8.xml:1
2449 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
2450 "&debsign;, &debsig-verify;, &gpg;"
2453 #. type: Content of: <refentry><refsect1><para>
2454 #: apt-secure.8.xml:1
2456 "For more background information you might want to review the <ulink "
2457 "url=\"https://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
2458 "Security Infrastructure</ulink> chapter of the Securing Debian Manual (also "
2459 "available in the harden-doc package) and the <ulink "
2460 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
2461 "Distribution HOWTO</ulink> by V. Alex Brennen."
2464 #. type: Content of: <refentry><refsect1><title>
2465 #: apt-secure.8.xml:1
2466 msgid "Manpage Authors"
2469 #. type: Content of: <refentry><refsect1><para>
2470 #: apt-secure.8.xml:1
2472 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
2473 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
2476 #. type: Content of: <refentry><refnamediv><refpurpose>
2477 #: apt-cdrom.8.xml:1
2478 msgid "APT CD-ROM management utility"
2481 #. type: Content of: <refentry><refsect1><para>
2482 #: apt-cdrom.8.xml:1
2484 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
2485 "available sources. <command>apt-cdrom</command> takes care of determining "
2486 "the structure of the disc as well as correcting for several possible "
2487 "mis-burns and verifying the index files."
2490 #. type: Content of: <refentry><refsect1><para>
2491 #: apt-cdrom.8.xml:1
2493 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
2494 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
2495 "must be inserted and scanned separately to account for possible mis-burns."
2498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2499 #: apt-cdrom.8.xml:1
2501 "<literal>add</literal> is used to add a new disc to the source list. It will "
2502 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
2503 "to scan it and copy the index files. If the disc does not have a proper "
2504 "<filename>.disk</filename> directory you will be prompted for a descriptive "
2508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2509 #: apt-cdrom.8.xml:1
2511 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
2512 "maintains a database of these IDs in "
2513 "<filename>&statedir;/cdroms.list</filename>"
2516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2517 #: apt-cdrom.8.xml:1
2519 "A debugging tool to report the identity of the current disc as well as the "
2523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2524 #: apt-cdrom.8.xml:1
2526 "Do not try to auto-detect the CD-ROM path. Usually combined with the "
2527 "<option>--cdrom</option> option. Configuration Item: "
2528 "<literal>Acquire::cdrom::AutoDetect</literal>."
2531 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2532 #: apt-cdrom.8.xml:1
2534 "Mount point; specify the location to mount the CD-ROM. This mount point must "
2535 "be listed in <filename>/etc/fstab</filename> and properly configured. "
2536 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
2539 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2540 #: apt-cdrom.8.xml:1
2542 "Rename a disc; change the label of a disc or override the disc's given "
2543 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
2544 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
2547 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2548 #: apt-cdrom.8.xml:1
2550 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
2551 "unmounting the mount point. Configuration Item: "
2552 "<literal>APT::CDROM::NoMount</literal>."
2555 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2556 #: apt-cdrom.8.xml:1
2558 "Fast Copy; Assume the package files are valid and do not check every "
2559 "package. This option should be used only if <command>apt-cdrom</command> has "
2560 "been run on this disc before and did not detect any errors. Configuration "
2561 "Item: <literal>APT::CDROM::Fast</literal>."
2564 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2565 #: apt-cdrom.8.xml:1
2567 "Thorough Package Scan; This option may be needed with some old Debian "
2568 "1.1/1.2 discs that have Package files in strange places. It takes much "
2569 "longer to scan the CD but will pick them all up."
2572 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2573 #: apt-cdrom.8.xml:1
2575 "No Changes; Do not change the &sources-list; file and do not write index "
2576 "files. Everything is still checked however. Configuration Item: "
2577 "<literal>APT::CDROM::NoAct</literal>."
2580 #. type: Content of: <refentry><refsect1><para>
2581 #: apt-cdrom.8.xml:1
2582 msgid "&apt-conf;, &apt-get;, &sources-list;"
2585 #. type: Content of: <refentry><refsect1><para>
2586 #: apt-cdrom.8.xml:1
2588 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
2592 #. type: Content of: <refentry><refnamediv><refpurpose>
2593 #: apt-config.8.xml:1
2594 msgid "APT Configuration Query program"
2597 #. type: Content of: <refentry><refsect1><para>
2598 #: apt-config.8.xml:1
2600 "<command>apt-config</command> is an internal program used by various "
2601 "portions of the APT suite to provide consistent configurability. It accesses "
2602 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
2603 "manner that is easy to use for scripted applications."
2606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2607 #: apt-config.8.xml:1
2609 "shell is used to access the configuration information from a shell "
2610 "script. It is given pairs of arguments, the first being a shell variable and "
2611 "the second the configuration value to query. As output it lists shell "
2612 "assignment commands for each value present. In a shell script it should be "
2616 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
2617 #: apt-config.8.xml:1
2621 "RES=`apt-config shell OPTS MyApp::options`\n"
2625 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2626 #: apt-config.8.xml:1
2628 "This will set the shell environment variable $OPTS to the value of "
2629 "MyApp::options with a default of <option>-f</option>."
2632 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2633 #: apt-config.8.xml:1
2635 "The configuration item may be postfixed with a /[fdbi]. f returns file "
2636 "names, d returns directories, b returns true or false and i returns an "
2637 "integer. Each of the returns is normalized and verified internally."
2640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2641 #: apt-config.8.xml:1
2642 msgid "Just show the contents of the configuration space."
2645 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2646 #: apt-config.8.xml:1
2648 "Include options which have an empty value. This is the default, so use "
2649 "--no-empty to remove them from the output."
2652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
2653 #: apt-config.8.xml:1
2654 msgid "%f "%v";%n"
2657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2658 #: apt-config.8.xml:1
2660 "Defines the output of each config option. %t will be replaced with "
2661 "its individual name, %f with its full hierarchical name and %v "
2662 "with its value. Use uppercase letters and special characters in the value "
2663 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
2664 "as defined by RFC822. Additionally %n will be replaced by a newline, "
2665 "and %N by a tab. A % can be printed by using %%."
2668 #. type: Content of: <refentry><refsect1><para>
2669 #: apt-config.8.xml:1 apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1
2670 #: apt-ftparchive.1.xml:1
2674 #. type: Content of: <refentry><refsect1><para>
2675 #: apt-config.8.xml:1
2677 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
2681 #. type: Content of: <refentry><refentryinfo><author><contrib>
2683 msgid "Initial documentation of Debug::*."
2686 #. type: Content of: <refentry><refentryinfo><author><email>
2688 msgid "dburrows@debian.org"
2691 #. type: Content of: <refentry><refmeta><manvolnum>
2692 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
2696 #. type: Content of: <refentry><refnamediv><refpurpose>
2698 msgid "Configuration file for APT"
2701 #. type: Content of: <refentry><refsect1><para>
2704 "<filename>/etc/apt/apt.conf</filename> is the main configuration file shared "
2705 "by all the tools in the APT suite of tools, though it is by no means the "
2706 "only place options can be set. The suite also shares a common command line "
2707 "parser to provide a uniform environment."
2710 #. type: Content of: <refentry><refsect1><orderedlist><para>
2713 "When an APT tool starts up it will read the configuration files in the "
2717 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2720 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
2724 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2727 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
2728 "order which have either no or \"<literal>conf</literal>\" as filename "
2729 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
2730 "and period (.) characters. Otherwise APT will print a notice that it has "
2731 "ignored a file, unless that file matches a pattern in the "
2732 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
2733 "case it will be silently ignored."
2736 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2738 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
2741 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2744 "all options set in the binary specific configuration subtree are moved into "
2745 "the root of the tree."
2748 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
2751 "the command line options are applied to override the configuration "
2752 "directives or to load even more configuration files."
2755 #. type: Content of: <refentry><refsect1><title>
2760 #. type: Content of: <refentry><refsect1><para>
2763 "The configuration file is organized in a tree with options organized into "
2764 "functional groups. Option specification is given with a double colon "
2765 "notation; for instance <literal>APT::Get::Assume-Yes</literal> is an option "
2766 "within the APT tool group, for the Get tool. Options do not inherit from "
2767 "their parent groups."
2770 #. type: Content of: <refentry><refsect1><para>
2773 "Syntactically the configuration language is modeled after what the ISC tools "
2774 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
2775 "treated as comments (ignored), as well as all text between "
2776 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
2777 "Each line is of the form <literal>APT::Get::Assume-Yes \"true\";</literal>. "
2778 "The quotation marks and trailing semicolon are required. The value must be "
2779 "on one line, and there is no kind of string concatenation. Values must not "
2780 "include backslashes or extra quotation marks. Option names are made up of "
2781 "alphanumeric characters and the characters \"/-:._+\". A new scope can be "
2782 "opened with curly braces, like this:"
2785 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2791 " Assume-Yes \"true\";\n"
2792 " Fix-Broken \"true\";\n"
2797 #. type: Content of: <refentry><refsect1><para>
2800 "with newlines placed to make it more readable. Lists can be created by "
2801 "opening a scope and including a single string enclosed in quotes followed by "
2802 "a semicolon. Multiple entries can be included, separated by a semicolon."
2805 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
2808 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
2811 #. type: Content of: <refentry><refsect1><para>
2814 "In general the sample configuration file &configureindex; is a good guide "
2815 "for how it should look."
2818 #. type: Content of: <refentry><refsect1><para>
2821 "Case is not significant in names of configuration items, so in the previous "
2822 "example you could use <literal>dpkg::pre-install-pkgs</literal>."
2825 #. type: Content of: <refentry><refsect1><para>
2828 "Names for the configuration items are optional if a list is defined as can "
2829 "be seen in the <literal>DPkg::Pre-Install-Pkgs</literal> example above. If "
2830 "you don't specify a name a new entry will simply add a new option to the "
2831 "list. If you specify a name you can override the option in the same way as "
2832 "any other option by reassigning a new value to the option."
2835 #. type: Content of: <refentry><refsect1><para>
2838 "Two special commands are defined: <literal>#include</literal> (which is "
2839 "deprecated and not supported by alternative implementations) and "
2840 "<literal>#clear</literal>. <literal>#include</literal> will include the "
2841 "given file, unless the filename ends in a slash, in which case the whole "
2842 "directory is included. <literal>#clear</literal> is used to erase a part of "
2843 "the configuration tree. The specified element and all its descendants are "
2844 "erased. (Note that these lines also need to end with a semicolon.)"
2847 #. type: Content of: <refentry><refsect1><para>
2850 "The <literal>#clear</literal> command is the only way to delete a list or a "
2851 "complete scope. Reopening a scope (or using the syntax described below with "
2852 "an appended <literal>::</literal>) will <emphasis>not</emphasis> override "
2853 "previously written entries. Options can only be overridden by addressing a "
2854 "new value to them - lists and scopes can't be overridden, only cleared."
2857 #. type: Content of: <refentry><refsect1><para>
2860 "All of the APT tools take an -o option which allows an arbitrary "
2861 "configuration directive to be specified on the command line. The syntax is a "
2862 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
2863 "followed by an equals sign then the new value of the option. To append a new "
2864 "element to a list, add a trailing <literal>::</literal> to the name of the "
2865 "list. (As you might suspect, the scope syntax can't be used on the command "
2869 #. type: Content of: <refentry><refsect1><para>
2872 "Note that appending items to a list using <literal>::</literal> only works "
2873 "for one item per line, and that you should not use it in combination with "
2874 "the scope syntax (which adds <literal>::</literal> implicitly). Using both "
2875 "syntaxes together will trigger a bug which some users unfortunately depend "
2876 "on: an option with the unusual name \"<literal>::</literal>\" which acts "
2877 "like every other option with a name. This introduces many problems; for one "
2878 "thing, users who write multiple lines in this <emphasis>wrong</emphasis> "
2879 "syntax in the hope of appending to a list will achieve the opposite, as only "
2880 "the last assignment for this option \"<literal>::</literal>\" will be "
2881 "used. Future versions of APT will raise errors and stop working if they "
2882 "encounter this misuse, so please correct such statements now while APT "
2883 "doesn't explicitly complain about them."
2886 #. type: Content of: <refentry><refsect1><title>
2888 msgid "The APT Group"
2891 #. type: Content of: <refentry><refsect1><para>
2894 "This group of options controls general APT behavior as well as holding the "
2895 "options for all of the tools."
2898 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2901 "System Architecture; sets the architecture to use when fetching files and "
2902 "parsing package lists. The internal default is the architecture apt was "
2906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2909 "All Architectures the system supports. For instance, CPUs implementing the "
2910 "<literal>amd64</literal> (also called <literal>x86-64</literal>) "
2911 "instruction set are also able to execute binaries compiled for the "
2912 "<literal>i386</literal> (<literal>x86</literal>) instruction set. This list "
2913 "is used when fetching files and parsing package lists. The initial default "
2914 "is always the system's native architecture "
2915 "(<literal>APT::Architecture</literal>), and foreign architectures are added "
2916 "to the default list when they are registered via <command>dpkg "
2917 "--add-architecture</command>."
2920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2923 "This scope defines which compression formats are supported, how compression "
2924 "and decompression can be performed if support for this format isn't built "
2925 "into apt directly and a cost-value indicating how costly it is to compress "
2926 "something in this format. As an example the following configuration stanza "
2927 "would allow apt to download and uncompress as well as create and store files "
2928 "with the low-cost <literal>.reversed</literal> file extension which it will "
2929 "pass to the command <command>rev</command> without additional commandline "
2930 "parameters for compression and uncompression:"
2933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><informalexample><programlisting>
2937 "APT::Compressor::rev {\n"
2939 "\tExtension \".reversed\";\n"
2940 "\tBinary \"rev\";\n"
2941 "\tCompressArg {};\n"
2942 "\tUncompressArg {};\n"
2947 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2950 "List of all build profiles enabled for build-dependency resolution, without "
2951 "the \"<literal>profile.</literal>\" namespace prefix. By default this list "
2952 "is empty. The <envar>DEB_BUILD_PROFILES</envar> as used by "
2953 "&dpkg-buildpackage; overrides the list notation."
2956 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2959 "Default release to install packages from if more than one version is "
2960 "available. Contains release name, codename or release version. Examples: "
2961 "'stable', 'testing', 'unstable', '&debian-stable-codename;', "
2962 "'&debian-testing-codename;', '4.0', '5.0*'. See also &apt-preferences;."
2965 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2968 "Ignore held packages; this global option causes the problem resolver to "
2969 "ignore held packages in its decision making."
2972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2975 "Defaults to on. When turned on the autoclean feature will remove any "
2976 "packages which can no longer be downloaded from the cache. If turned off "
2977 "then packages that are locally installed are also excluded from cleaning - "
2978 "but note that APT provides no direct means to reinstall them."
2981 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2984 "Defaults to on, which will cause APT to install essential and important "
2985 "packages as soon as possible in an install/upgrade operation, in order to "
2986 "limit the effect of a failing &dpkg; call. If this option is disabled, APT "
2987 "treats an important package in the same way as an extra package: between the "
2988 "unpacking of the package A and its configuration there can be many other "
2989 "unpack or configuration calls for other unrelated packages B, C etc. If "
2990 "these cause the &dpkg; call to fail (e.g. because package B's maintainer "
2991 "scripts generate an error), this results in a system state in which package "
2992 "A is unpacked but unconfigured - so any package depending on A is now no "
2993 "longer guaranteed to work, as its dependency on A is no longer satisfied."
2996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2999 "The immediate configuration marker is also applied in the potentially "
3000 "problematic case of circular dependencies, since a dependency with the "
3001 "immediate flag is equivalent to a Pre-Dependency. In theory this allows APT "
3002 "to recognise a situation in which it is unable to perform immediate "
3003 "configuration, abort, and suggest to the user that the option should be "
3004 "temporarily deactivated in order to allow the operation to proceed. Note "
3005 "the use of the word \"theory\" here; in the real world this problem has "
3006 "rarely been encountered, in non-stable distribution versions, and was caused "
3007 "by wrong dependencies of the package in question or by a system in an "
3008 "already broken state; so you should not blindly disable this option, as the "
3009 "scenario mentioned above is not the only problem it can help to prevent in "
3013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3016 "Before a big operation like <literal>dist-upgrade</literal> is run with this "
3017 "option disabled you should try to explicitly <literal>install</literal> the "
3018 "package APT is unable to configure immediately; but please make sure you "
3019 "also report your problem to your distribution and to the APT team with the "
3020 "buglink below, so they can work on improving or correcting the upgrade "
3024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3027 "Never enable this option unless you <emphasis>really</emphasis> know what "
3028 "you are doing. It permits APT to temporarily remove an essential package to "
3029 "break a Conflicts/Conflicts or Conflicts/Pre-Depends loop between two "
3030 "essential packages. <emphasis>Such a loop should never exist and is a grave "
3031 "bug</emphasis>. This option will work if the essential packages are not "
3032 "<command>tar</command>, <command>gzip</command>, <command>libc</command>, "
3033 "<command>dpkg</command>, <command>dash</command> or anything that those "
3034 "packages depend on."
3037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3040 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3041 "the available information. <literal>Cache-Start</literal> acts as a hint of "
3042 "the size the cache will grow to, and is therefore the amount of memory APT "
3043 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3044 "that this amount of space needs to be available for APT; otherwise it will "
3045 "likely fail ungracefully, so for memory restricted devices this value should "
3046 "be lowered while on systems with a lot of configured sources it should be "
3047 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3048 "of 1048576 (~1 MB) how much the cache size will be increased in the event "
3049 "the space defined by <literal>Cache-Start</literal> is not enough. This "
3050 "value will be applied again and again until either the cache is big enough "
3051 "to store all information or the size of the cache reaches the "
3052 "<literal>Cache-Limit</literal>. The default of "
3053 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3054 "<literal>Cache-Grow</literal> is set to 0 the automatic growth of the cache "
3058 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3060 msgid "Defines which packages are considered essential build dependencies."
3063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3066 "The Get subsection controls the &apt-get; tool; please see its documentation "
3067 "for more information about the options here."
3070 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3073 "The Cache subsection controls the &apt-cache; tool; please see its "
3074 "documentation for more information about the options here."
3077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3080 "The CDROM subsection controls the &apt-cdrom; tool; please see its "
3081 "documentation for more information about the options here."
3084 #. type: Content of: <refentry><refsect1><title>
3086 msgid "The Acquire Group"
3089 #. type: Content of: <refentry><refsect1><para>
3092 "The <literal>Acquire</literal> group of options controls the download of "
3093 "packages as well as the various \"acquire methods\" responsible for the "
3094 "download itself (see also &sources-list;)."
3097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3100 "Security related option defaulting to true, as giving a Release file's "
3101 "validation an expiration date prevents replay attacks over a long timescale, "
3102 "and can also for example help users to identify mirrors that are no longer "
3103 "updated - but the feature depends on the correctness of the clock on the "
3104 "user system. Archive maintainers are encouraged to create Release files with "
3105 "the <literal>Valid-Until</literal> header, but if they don't or a stricter "
3106 "value is desired the <literal>Max-ValidTime</literal> option below can be "
3107 "used. The <option>Check-Valid-Until</option> option of &sources-list; "
3108 "entries should be preferred to disable the check selectively instead of "
3109 "using this global override."
3112 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3115 "Maximum time (in seconds) after its creation (as indicated by the "
3116 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3117 "should be considered valid. If the Release file itself includes a "
3118 "<literal>Valid-Until</literal> header the earlier date of the two is used as "
3119 "the expiration date. The default value is <literal>0</literal> which stands "
3120 "for \"valid forever\". Archive specific settings can be made by appending "
3121 "the label of the archive to the option name. Preferably, the same can be "
3122 "achieved for specific &sources-list; entries by using the "
3123 "<option>Valid-Until-Max</option> option there."
3126 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3129 "Minimum time (in seconds) after its creation (as indicated by the "
3130 "<literal>Date</literal> header) that the <filename>Release</filename> file "
3131 "should be considered valid. Use this if you need to use a seldom updated "
3132 "(local) mirror of a more frequently updated archive with a "
3133 "<literal>Valid-Until</literal> header instead of completely disabling the "
3134 "expiration date checking. Archive specific settings can and should be used "
3135 "by appending the label of the archive to the option name. Preferably, the "
3136 "same can be achieved for specific &sources-list; entries by using the "
3137 "<option>Valid-Until-Min</option> option there."
3140 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3143 "Try to download deltas called <literal>PDiffs</literal> for indexes (like "
3144 "<filename>Packages</filename> files) instead of downloading whole ones. True "
3145 "by default. Preferably, this can be set for specific &sources-list; entries "
3146 "or index files by using the <option>PDiffs</option> option there."
3149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3152 "Two sub-options to limit the use of PDiffs are also available: "
3153 "<literal>FileLimit</literal> can be used to specify a maximum number of "
3154 "PDiff files should be downloaded to update a "
3155 "file. <literal>SizeLimit</literal> on the other hand is the maximum "
3156 "percentage of the size of all patches compared to the size of the targeted "
3157 "file. If one of these limits is exceeded the complete file is downloaded "
3158 "instead of the patches."
3161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3164 "Try to download indexes via an URI constructed from a hashsum of the "
3165 "expected file rather than downloaded via a well-known stable filename. True "
3166 "by default, but automatically disabled if the source indicates no support "
3167 "for it. Usage can be forced with the special value \"force\". Preferably, "
3168 "this can be set for specific &sources-list; entries or index files by using "
3169 "the <option>By-Hash</option> option there."
3172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3175 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3176 "<literal>host</literal> or <literal>access</literal> which determines how "
3177 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3178 "one connection per target host will be opened, <literal>access</literal> "
3179 "means that one connection per URI type will be opened."
3182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3185 "Number of retries to perform. If this is non-zero APT will retry failed "
3186 "files the given number of times."
3189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3192 "Use symlinks for source archives. If set to true then source archives will "
3193 "be symlinked when possible instead of copying. True is the default."
3196 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3199 "<literal>http::Proxy</literal> sets the default proxy to use for HTTP "
3200 "URIs. It is in the standard form of "
3201 "<literal>http://[[user][:pass]@]host[:port]/</literal>. Per host proxies "
3202 "can also be specified by using the form "
3203 "<literal>http::Proxy::<host></literal> with the special keyword "
3204 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3205 "settings is specified, <envar>http_proxy</envar> environment variable will "
3209 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3212 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3213 "caches. <literal>No-Cache</literal> tells the proxy not to use its cached "
3214 "response under any circumstances. <literal>Max-Age</literal> sets the "
3215 "allowed maximum age (in seconds) of an index file in the cache of the "
3216 "proxy. <literal>No-Store</literal> specifies that the proxy should not "
3217 "store the requested archive files in its cache, which can be used to prevent "
3218 "the proxy from polluting its cache with (big) .deb files."
3221 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3222 #: apt.conf.5.xml:1 apt.conf.5.xml:1
3224 "The option <literal>timeout</literal> sets the timeout timer used by the "
3225 "method; this value applies to the connection as well as the data timeout."
3228 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3231 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3232 "enable HTTP pipelining (RFC 2616 section 8.1.2.2) which can be beneficial "
3233 "e.g. on high-latency connections. It specifies how many requests are sent in "
3234 "a pipeline. APT tries to detect and workaround misbehaving webservers and "
3235 "proxies at runtime, but if you know that yours does not conform to the "
3236 "HTTP/1.1 specification pipelining can be disabled by setting the value to "
3237 "0. It is enabled by default with the value 10."
3240 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3243 "<literal>Acquire::http::AllowRedirect</literal> controls whether APT will "
3244 "follow redirects, which is enabled by default."
3247 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3250 "The used bandwidth can be limited with "
3251 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3252 "kilobytes per second. The default value is 0 which deactivates the limit and "
3253 "tries to use all available bandwidth. Note that this option implicitly "
3254 "disables downloading from multiple servers at the same time."
3257 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3260 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3261 "User-Agent for the http download method as some proxies allow access for "
3262 "clients only if the client uses a known identifier."
3265 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3268 "<literal>Acquire::http::Proxy-Auto-Detect</literal> can be used to specify "
3269 "an external command to discover the http proxy to use. The first and only "
3270 "parameter is an URI denoting the host to be contacted to allow for "
3271 "host-specific configuration. APT expects the command to output the proxy on "
3272 "stdout as a single line in the style <literal>http://proxy:port/</literal> "
3273 "or the word <literal>DIRECT</literal> if no proxy should be used. No output "
3274 "indicates that the generic proxy settings should be used. Note that "
3275 "auto-detection will not be used for a host if a host-specific proxy "
3276 "configuration is already set via "
3277 "<literal>Acquire::http::Proxy::<replaceable>HOST</replaceable></literal>. "
3278 "See the &squid-deb-proxy-client; package for an example implementation that "
3279 "uses avahi. This option takes precedence over the legacy option name "
3280 "<literal>ProxyAutoDetect</literal>."
3283 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3286 "The <literal>Cache-control</literal>, <literal>Timeout</literal>, "
3287 "<literal>AllowRedirect</literal>, <literal>Dl-Limit</literal> and "
3288 "<literal>proxy</literal> options work for HTTPS URIs in the same way as for "
3289 "the <literal>http</literal> method, and default to the same values if they "
3290 "are not explicitly set. The <literal>Pipeline-Depth</literal> option is not "
3294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3297 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3298 "about trusted certificates. <literal><host>::CaInfo</literal> is the "
3299 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3300 "suboption determines whether or not the server's host certificate should be "
3301 "verified against trusted certificates. "
3302 "<literal><host>::Verify-Peer</literal> is the corresponding per-host "
3303 "option. <literal>Verify-Host</literal> boolean suboption determines whether "
3304 "or not the server's hostname should be verified. "
3305 "<literal><host>::Verify-Host</literal> is the corresponding per-host "
3306 "option. <literal>SslCert</literal> determines what certificate to use for "
3307 "client authentication. <literal><host>::SslCert</literal> is the "
3308 "corresponding per-host option. <literal>SslKey</literal> determines what "
3309 "private key to use for client "
3310 "authentication. <literal><host>::SslKey</literal> is the corresponding "
3311 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3312 "version to use. It can contain either of the strings "
3313 "'<literal>TLSv1</literal>' or '<literal>SSLv3</literal>'. "
3314 "<literal><host>::SslForceVersion</literal> is the corresponding "
3318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3321 "<literal>ftp::Proxy</literal> sets the default proxy to use for FTP URIs. "
3322 "It is in the standard form of "
3323 "<literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host proxies can "
3324 "also be specified by using the form "
3325 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3326 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3327 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3328 "used. To use an FTP proxy you will have to set the "
3329 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3330 "entry specifies the commands to send to tell the proxy server what to "
3331 "connect to. Please see &configureindex; for an example of how to do "
3332 "this. The substitution variables representing the corresponding URI "
3333 "component are <literal>$(PROXY_USER)</literal>, "
3334 "<literal>$(PROXY_PASS)</literal>, <literal>$(SITE_USER)</literal>, "
3335 "<literal>$(SITE_PASS)</literal>, <literal>$(SITE)</literal> and "
3336 "<literal>$(SITE_PORT)</literal>."
3339 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3342 "Several settings are provided to control passive mode. Generally it is safe "
3343 "to leave passive mode on; it works in nearly every environment. However, "
3344 "some situations require that passive mode be disabled and port mode FTP used "
3345 "instead. This can be done globally or for connections that go through a "
3346 "proxy or for a specific host (see the sample config file for examples)."
3349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3352 "It is possible to proxy FTP over HTTP by setting the "
3353 "<envar>ftp_proxy</envar> environment variable to an HTTP URL - see the "
3354 "discussion of the http method above for syntax. You cannot set this in the "
3355 "configuration file and it is not recommended to use FTP over HTTP due to its "
3359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3362 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3363 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3364 "false, which means these commands are only used if the control connection is "
3365 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3366 "that most FTP servers do not support RFC2428."
3369 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3372 msgid "/cdrom/::Mount \"foo\";"
3375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3378 "For URIs using the <literal>cdrom</literal> method, the only configurable "
3379 "option is the mount point, <literal>cdrom::Mount</literal>, which must be "
3380 "the mount point for the CD-ROM (or DVD, or whatever) drive as specified in "
3381 "<filename>/etc/fstab</filename>. It is possible to provide alternate mount "
3382 "and unmount commands if your mount point cannot be listed in the fstab. The "
3383 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3384 "<literal>cdrom</literal> block. It is important to have the trailing slash. "
3385 "Unmount commands can be specified using UMount."
3388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3391 "For GPGV URIs the only configurable option is "
3392 "<literal>gpgv::Options</literal>, which passes additional parameters to "
3396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3400 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3401 "\"<replaceable>Methodname</replaceable>\";"
3404 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3407 "List of compression types which are understood by the acquire methods. "
3408 "Files like <filename>Packages</filename> can be available in various "
3409 "compression formats. By default the acquire methods can decompress and "
3410 "recompress many common formats like <command>xz</command> and "
3411 "<command>gzip</command>; with this scope the supported formats can be "
3412 "queried, modified as well as support for more formats added (see also "
3413 "<option>APT::Compressor</option>). The syntax for this is: <placeholder "
3414 "type=\"synopsis\" id=\"0\"/>"
3417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3420 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><synopsis>
3426 msgid "Acquire::CompressionTypes::Order { \"xz\"; \"gz\"; };"
3429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3432 "Also, the <literal>Order</literal> subgroup can be used to define in which "
3433 "order the acquire system will try to download the compressed files. The "
3434 "acquire system will try the first and proceed with the next compression type "
3435 "in this list on error, so to prefer one over the other type simply add the "
3436 "preferred type first - types not already added will be implicitly appended "
3437 "to the end of the list, so e.g. <placeholder type=\"synopsis\" id=\"0\"/> "
3438 "can be used to prefer <command>gzip</command> compressed files over all "
3439 "other compression formats. If <command>xz</command> should be preferred "
3440 "over <command>gzip</command> and <command>bzip2</command> the configure "
3441 "setting should look like this: <placeholder type=\"synopsis\" id=\"1\"/> It "
3442 "is not needed to add <literal>bz2</literal> to the list explicitly as it "
3443 "will be added automatically."
3446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><literallayout>
3449 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3456 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3457 "checked at run time. If this option has been set and support for this format "
3458 "isn't directly built into apt, the method will only be used if this file "
3459 "exists; e.g. for the <literal>bzip2</literal> method (the inbuilt) setting "
3460 "is: <placeholder type=\"literallayout\" id=\"0\"/> Note also that list "
3461 "entries specified on the command line will be added at the end of the list "
3462 "specified in the configuration files, but before the default entries. To "
3463 "prefer a type in this case over the ones specified in the configuration "
3464 "files you can set the option direct - not in list style. This will not "
3465 "override the defined list; it will only prefix the list with this type."
3468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3471 "The special type <literal>uncompressed</literal> can be used to give "
3472 "uncompressed files a preference, but note that most archives don't provide "
3473 "uncompressed files so this is mostly only useable for local mirrors."
3476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3479 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3480 "Sources, or Translations), keep them gzip compressed locally instead of "
3481 "unpacking them. This saves quite a lot of disk space at the expense of more "
3482 "CPU requirements when building the local package caches. False by default."
3485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3488 "The Languages subsection controls which <filename>Translation</filename> "
3489 "files are downloaded and in which order APT tries to display the "
3490 "description-translations. APT will try to display the first available "
3491 "description in the language which is listed first. Languages can be defined "
3492 "with their short or long language codes. Note that not all archives provide "
3493 "<filename>Translation</filename> files for every language - the long "
3494 "language codes are especially rare."
3497 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><programlisting>
3500 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3503 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3506 "The default list includes \"environment\" and "
3507 "\"en\". \"<literal>environment</literal>\" has a special meaning here: it "
3508 "will be replaced at runtime with the language codes extracted from the "
3509 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3510 "that these codes are not included twice in the list. If "
3511 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3512 "<filename>Translation-en</filename> file (if available) will be used. To "
3513 "force APT to use no Translation file use the setting "
3514 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3515 "another special meaning code which will stop the search for a suitable "
3516 "<filename>Translation</filename> file. This tells APT to download these "
3517 "translations too, without actually using them unless the environment "
3518 "specifies the languages. So the following example configuration will result "
3519 "in the order \"en, de\" in an English locale or \"de, en\" in a German "
3520 "one. Note that \"fr\" is downloaded, but not used unless APT is used in a "
3521 "French locale (where the order would be \"fr, de, en\"). <placeholder "
3522 "type=\"programlisting\" id=\"0\"/>"
3525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3528 "Note: To prevent problems resulting from APT being executed in different "
3529 "environments (e.g. by different users or by other programs) all Translation "
3530 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3531 "added to the end of the list (after an implicit "
3532 "\"<literal>none</literal>\")."
3535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3537 msgid "When downloading, force to use only the IPv4 protocol."
3540 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3542 msgid "When downloading, force to use only the IPv6 protocol."
3545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3548 "The maximum file size of Release/Release.gpg/InRelease files. The default "
3552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3555 "This option controls if apt will use the DNS SRV server record as specified "
3556 "in RFC 2782 to select an alternative server to connect to. The default is "
3560 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3563 "Allow update operations to load data files from repositories without "
3564 "sufficient security information. The default value is "
3565 "\"<literal>false</literal>\". Concept, implications as well as alternatives "
3566 "are detailed in &apt-secure;."
3569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3572 "Allow update operations to load data files from repositories which provide "
3573 "security information, but these are deemed no longer cryptographically "
3574 "strong enough. The default value is \"<literal>false</literal>\". Concept, "
3575 "implications as well as alternatives are detailed in &apt-secure;."
3578 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3581 "Allow that a repository that was previously gpg signed to become unsigned "
3582 "during an update operation. When there is no valid signature for a "
3583 "previously trusted repository apt will refuse the update. This option can be "
3584 "used to override this protection. You almost certainly never want to enable "
3585 "this. The default is <literal>false</literal>. Concept, implications as "
3586 "well as alternatives are detailed in &apt-secure;."
3589 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3594 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3597 "Acquiring changelogs can only be done if an URI is known from where to get "
3598 "them. Preferable the Release file indicates this in a 'Changelogs' "
3599 "field. If this isn't available the Label/Origin field of the Release file is "
3600 "used to check if a "
3601 "<literal>Acquire::Changelogs::URI::Label::<replaceable>LABEL</replaceable></literal> "
3603 "<literal>Acquire::Changelogs::URI::Origin::<replaceable>ORIGIN</replaceable></literal> "
3604 "option exists and if so this value is taken. The value in the Release file "
3605 "can be overridden with "
3606 "<literal>Acquire::Changelogs::URI::Override::Label::<replaceable>LABEL</replaceable></literal> "
3608 "<literal>Acquire::Changelogs::URI::Override::Origin::<replaceable>ORIGIN</replaceable></literal>. "
3609 "The value should be a normal URI to a text file, except that package "
3610 "specific data is replaced with the placeholder "
3611 "<literal>@CHANGEPATH@</literal>. The value for it is: 1. if the package is "
3612 "from a component (e.g. <literal>main</literal>) this is the first part "
3613 "otherwise it is omitted, 2. the first letter of source package name, except "
3614 "if the source package name starts with '<literal>lib</literal>' in which "
3615 "case it will be the first four letters. 3. The complete source package "
3616 "name. 4. the complete name again and 5. the source version. The first (if "
3617 "present), second, third and fourth part are separated by a slash "
3618 "('<literal>/</literal>') and between the fourth and fifth part is an "
3619 "underscore ('<literal>_</literal>'). The special value "
3620 "'<literal>no</literal>' is available for this option indicating that this "
3621 "source can't be used to acquire changelog files from. Another source will be "
3622 "tried if available in this case."
3625 #. type: Content of: <refentry><refsect1><title>
3627 msgid "Binary specific configuration"
3630 #. type: Content of: <refentry><refsect1><para>
3633 "Especially with the introduction of the <command>apt</command> binary it can "
3634 "be useful to set certain options only for a specific binary as even options "
3635 "which look like they would effect only a certain binary like "
3636 "<option>APT::Get::Show-Versions</option> effect <command>apt-get</command> "
3637 "as well as <command>apt</command>."
3640 #. type: Content of: <refentry><refsect1><para>
3643 "Setting an option for a specific binary only can be achieved by setting the "
3644 "option inside the "
3645 "<option>Binary::<replaceable>specific-binary</replaceable></option> "
3646 "scope. Setting the option <option>APT::Get::Show-Versions</option> for the "
3647 "<command>apt</command> only can e.g. by done by setting "
3648 "<option>Binary::apt::APT::Get::Show-Versions</option> instead."
3651 #. type: Content of: <refentry><refsect1><para>
3654 "Note that as seen in the DESCRIPTION section further above you can't set "
3655 "binary-specific options on the commandline itself nor in configuration files "
3656 "loaded via the commandline."
3659 #. type: Content of: <refentry><refsect1><title>
3664 #. type: Content of: <refentry><refsect1><para>
3667 "The <literal>Dir::State</literal> section has directories that pertain to "
3668 "local state information. <literal>lists</literal> is the directory to place "
3669 "downloaded package lists in and <literal>status</literal> is the name of the "
3670 "&dpkg; status file. <literal>preferences</literal> is the name of the APT "
3671 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3672 "contains the default directory to prefix on all sub-items if they do not "
3673 "start with <filename>/</filename> or <filename>./</filename>."
3676 #. type: Content of: <refentry><refsect1><para>
3679 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3680 "information, such as the two package caches <literal>srcpkgcache</literal> "
3681 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3682 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3683 "be turned off by setting <literal>pkgcache</literal> or "
3684 "<literal>srcpkgcache</literal> to <literal>\"\"</literal>. This will slow "
3685 "down startup but save disk space. It is probably preferable to turn off the "
3686 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> "
3687 "the default directory is contained in <literal>Dir::Cache</literal>"
3690 #. type: Content of: <refentry><refsect1><para>
3693 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3694 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3695 "<literal>main</literal> is the default configuration file (setting has no "
3696 "effect, unless it is done from the config file specified by "
3697 "<envar>APT_CONFIG</envar>)."
3700 #. type: Content of: <refentry><refsect1><para>
3703 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3704 "in lexical order from the directory specified. After this is done then the "
3705 "main config file is loaded."
3708 #. type: Content of: <refentry><refsect1><para>
3711 "Binary programs are pointed to by "
3712 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3713 "the location of the method handlers and <literal>gzip</literal>, "
3714 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3715 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3716 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3717 "specify the location of the respective programs."
3720 #. type: Content of: <refentry><refsect1><para>
3723 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3724 "set, all paths will be relative to <literal>RootDir</literal>, "
3725 "<emphasis>even paths that are specified absolutely</emphasis>. So, for "
3726 "instance, if <literal>RootDir</literal> is set to "
3727 "<filename>/tmp/staging</filename> and <literal>Dir::State::status</literal> "
3728 "is set to <filename>/var/lib/dpkg/status</filename>, then the status file "
3729 "will be looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>. "
3730 "If you want to prefix only relative paths, set <literal>Dir</literal> "
3734 #. type: Content of: <refentry><refsect1><para>
3737 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3738 "which files APT should silently ignore while parsing the files in the "
3739 "fragment directories. Per default a file which end with "
3740 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3741 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3742 "default value these patterns can use regular expression syntax."
3745 #. type: Content of: <refentry><refsect1><title>
3747 msgid "APT in DSelect"
3750 #. type: Content of: <refentry><refsect1><para>
3753 "When APT is used as a &dselect; method several configuration directives "
3754 "control the default behavior. These are in the <literal>DSelect</literal> "
3758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3761 "Cache Clean mode; this value may be one of <literal>always</literal>, "
3762 "<literal>prompt</literal>, <literal>auto</literal>, "
3763 "<literal>pre-auto</literal> and <literal>never</literal>. "
3764 "<literal>always</literal> and <literal>prompt</literal> will remove all "
3765 "packages from the cache after upgrading, <literal>prompt</literal> (the "
3766 "default) does so conditionally. <literal>auto</literal> removes only those "
3767 "packages which are no longer downloadable (replaced with a new version for "
3768 "instance). <literal>pre-auto</literal> performs this action before "
3769 "downloading new packages."
3772 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3775 "The contents of this variable are passed to &apt-get; as command line "
3776 "options when it is run for the install phase."
3779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3782 "The contents of this variable are passed to &apt-get; as command line "
3783 "options when it is run for the update phase."
3786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3789 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
3790 "The default is to prompt only on error."
3793 #. type: Content of: <refentry><refsect1><title>
3795 msgid "How APT calls &dpkg;"
3798 #. type: Content of: <refentry><refsect1><para>
3801 "Several configuration directives control how APT invokes &dpkg;. These are "
3802 "in the <literal>DPkg</literal> section."
3805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3808 "This is a list of options to pass to &dpkg;. The options must be specified "
3809 "using the list notation and each list item is passed as a single argument to "
3813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3816 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
3817 "<literal>options</literal> this must be specified in list notation. The "
3818 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3819 "fail APT will abort."
3822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3825 "This is a list of shell commands to run before invoking &dpkg;. Like "
3826 "<literal>options</literal> this must be specified in list notation. The "
3827 "commands are invoked in order using <filename>/bin/sh</filename>; should any "
3828 "fail APT will abort. APT will pass the filenames of all .deb files it is "
3829 "going to install to the commands, one per line on the requested file "
3830 "descriptor, defaulting to standard input."
3833 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3836 "Version 2 of this protocol sends more information through the requested file "
3837 "descriptor: a line with the text <literal>VERSION 2</literal>, the APT "
3838 "configuration space, and a list of package actions with filename and version "
3842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3845 "Each configuration directive line has the form "
3846 "<literal>key=value</literal>. Special characters (equal signs, newlines, "
3847 "nonprintable characters, quotation marks, and percent signs in "
3848 "<literal>key</literal> and newlines, nonprintable characters, and percent "
3849 "signs in <literal>value</literal>) are %-encoded. Lists are represented by "
3850 "multiple <literal>key::=value</literal> lines with the same key. The "
3851 "configuration section ends with a blank line."
3854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3857 "Package action lines consist of five fields in Version 2: package name "
3858 "(without architecture qualification even if foreign), old version, direction "
3859 "of version change (< for upgrades, > for downgrades, = for no change), "
3860 "new version, action. The version fields are \"-\" for no version at all (for "
3861 "example when installing a package for the first time; no version is treated "
3862 "as earlier than any real version, so that is an upgrade, indicated as "
3863 "<literal>- < 1.23.4</literal>). The action field is \"**CONFIGURE**\" if "
3864 "the package is being configured, \"**REMOVE**\" if it is being removed, or "
3865 "the filename of a .deb file if it is being unpacked."
3868 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3871 "In Version 3 after each version field follows the architecture of this "
3872 "version, which is \"-\" if there is no version, and a field showing the "
3873 "MultiArch type \"same\", \"foreign\", \"allowed\" or \"none\". Note that "
3874 "\"none\" is an incorrect typename which is just kept to remain compatible, "
3875 "it should be read as \"no\" and users are encouraged to support both."
3878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3881 "The version of the protocol to be used for the command "
3882 "<literal><replaceable>cmd</replaceable></literal> can be chosen by setting "
3883 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::Version</literal> "
3884 "accordingly, the default being version 1. If APT isn't supporting the "
3885 "requested version it will send the information in the highest version it has "
3886 "support for instead."
3889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3892 "The file descriptor to be used to send the information can be requested with "
3893 "<literal>DPkg::Tools::options::<replaceable>cmd</replaceable>::InfoFD</literal> "
3894 "which defaults to <literal>0</literal> for standard input and is available "
3895 "since version 0.9.11. Support for the option can be detected by looking for "
3896 "the environment variable <envar>APT_HOOK_INFO_FD</envar> which contains the "
3897 "number of the used file descriptor as a confirmation."
3900 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3903 "APT chdirs to this directory before invoking &dpkg;, the default is "
3904 "<filename>/</filename>."
3907 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3910 "These options are passed to &dpkg-buildpackage; when compiling packages; the "
3911 "default is to disable signing and produce all binaries."
3914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3917 "If this option is set APT will call <command>dpkg --configure "
3918 "--pending</command> to let &dpkg; handle all required configurations and "
3919 "triggers. This option is activated by default, but deactivating it could be "
3920 "useful if you want to run APT multiple times in a row - e.g. in an "
3921 "installer. In this scenario you could deactivate this option in all but the "
3925 #. type: Content of: <refentry><refsect1><title>
3927 msgid "Periodic and Archives options"
3930 #. type: Content of: <refentry><refsect1><para>
3933 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
3934 "of options configure behavior of apt periodic updates, which is done by the "
3935 "<literal>/usr/lib/apt/apt.systemd.daily</literal> script. See the top of "
3936 "this script for the brief documentation of these options."
3939 #. type: Content of: <refentry><refsect1><title>
3941 msgid "Debug options"
3944 #. type: Content of: <refentry><refsect1><para>
3947 "Enabling options in the <literal>Debug::</literal> section will cause "
3948 "debugging information to be sent to the standard error stream of the program "
3949 "utilizing the <literal>apt</literal> libraries, or enable special program "
3950 "modes that are primarily useful for debugging the behavior of "
3951 "<literal>apt</literal>. Most of these options are not interesting to a "
3952 "normal user, but a few may be:"
3955 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3958 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
3959 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
3963 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3966 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
3967 "used to run some operations (for instance, <literal>apt-get -s "
3968 "install</literal>) as a non-root user."
3971 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3974 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
3975 "time that <literal>apt</literal> invokes &dpkg;."
3979 #. motivating example, except I haven't a clue why you'd want
3981 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
3984 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
3988 #. type: Content of: <refentry><refsect1><para>
3990 msgid "A full list of debugging options to apt follows."
3993 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3995 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
3998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4000 msgid "Print information related to downloading packages using FTP."
4003 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4005 msgid "Print information related to downloading packages using HTTP."
4008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4010 msgid "Print information related to downloading packages using HTTPS."
4013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4016 "Print information related to verifying cryptographic signatures using "
4017 "<literal>gpg</literal>."
4020 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4023 "Output information about the process of accessing collections of packages "
4024 "stored on CD-ROMs."
4027 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4029 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4032 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4035 "Output each cryptographic hash that is generated by the "
4036 "<literal>apt</literal> libraries."
4039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4042 "Do not include information from <literal>statfs</literal>, namely the number "
4043 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4047 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4050 "Disable all file locking. For instance, this will allow two instances of "
4051 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4056 msgid "Log when items are added to or removed from the global download queue."
4059 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4062 "Output status messages and errors related to verifying checksums and "
4063 "cryptographic signatures of downloaded files."
4066 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4069 "Output information about downloading and applying package index list diffs, "
4070 "and errors relating to package index list diffs."
4073 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4076 "Output information related to patching apt package lists when downloading "
4077 "index diffs instead of full indices."
4080 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4082 msgid "Log all interactions with the sub-processes that actually perform downloads."
4085 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4088 "Log events related to the automatically-installed status of packages and to "
4089 "the removal of unused packages."
4092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4095 "Generate debug messages describing which packages are being automatically "
4096 "installed to resolve dependencies. This corresponds to the initial "
4097 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4098 "and not to the full <literal>apt</literal> dependency resolver; see "
4099 "<literal>Debug::pkgProblemResolver</literal> for that."
4102 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4105 "Generate debug messages describing which packages are marked as "
4106 "keep/install/remove while the ProblemResolver does his work. Each addition "
4107 "or deletion may trigger additional actions; they are shown indented two "
4108 "additional spaces under the original entry. The format for each line is "
4109 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4110 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4111 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4112 "is the current version of the package, <literal>d.e.f</literal> is the "
4113 "version considered for installation and <literal>x.y.z</literal> is a newer "
4114 "version, but not considered for installation (because of a low pin "
4115 "score). The later two can be omitted if there is none or if it is the same "
4116 "as the installed version. <literal>section</literal> is the name of the "
4117 "section the package appears in."
4120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4123 "When invoking &dpkg;, output the precise command line with which it is being "
4124 "invoked, with arguments separated by a single space character."
4127 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4130 "Output all the data received from &dpkg; on the status file descriptor and "
4131 "any errors encountered while parsing it."
4134 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4137 "Generate a trace of the algorithm that decides the order in which "
4138 "<literal>apt</literal> should pass packages to &dpkg;."
4141 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4143 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4148 msgid "Output the priority of each package list on startup."
4151 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4154 "Trace the execution of the dependency resolver (this applies only to what "
4155 "happens when a complex dependency problem is encountered)."
4158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4161 "Display a list of all installed packages with their calculated score used by "
4162 "the pkgProblemResolver. The description of the package is the same as "
4163 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4166 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4169 "Print information about the vendors read from "
4170 "<filename>/etc/apt/vendors.list</filename>."
4173 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4176 "Display the external commands that are called by apt hooks. This includes "
4177 "e.g. the config options <literal>DPkg::{Pre,Post}-Invoke</literal> or "
4178 "<literal>APT::Update::{Pre,Post}-Invoke</literal>."
4181 #. type: Content of: <refentry><refsect1><title>
4182 #: apt.conf.5.xml:1 apt_preferences.5.xml:1 sources.list.5.xml:1
4183 #: apt-ftparchive.1.xml:1
4187 #. type: Content of: <refentry><refsect1><para>
4190 "&configureindex; is a configuration file showing example values for all "
4194 #. ? reading apt.conf
4195 #. type: Content of: <refentry><refsect1><para>
4197 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4200 #. type: Content of: <refentry><refnamediv><refpurpose>
4201 #: apt_preferences.5.xml:1
4202 msgid "Preference control file for APT"
4205 #. type: Content of: <refentry><refsect1><para>
4206 #: apt_preferences.5.xml:1
4208 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4209 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4210 "can be used to control which versions of packages will be selected for "
4214 #. type: Content of: <refentry><refsect1><para>
4215 #: apt_preferences.5.xml:1
4217 "Several versions of a package may be available for installation when the "
4218 "&sources-list; file contains references to more than one distribution (for "
4219 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4220 "assigns a priority to each version that is available. Subject to dependency "
4221 "constraints, <command>apt-get</command> selects the version with the highest "
4222 "priority for installation. The APT preferences override the priorities that "
4223 "APT assigns to package versions by default, thus giving the user control "
4224 "over which one is selected for installation."
4227 #. type: Content of: <refentry><refsect1><para>
4228 #: apt_preferences.5.xml:1
4230 "Several instances of the same version of a package may be available when the "
4231 "&sources-list; file contains references to more than one source. In this "
4232 "case <command>apt-get</command> downloads the instance listed earliest in "
4233 "the &sources-list; file. The APT preferences do not affect the choice of "
4234 "instance, only the choice of version."
4237 #. type: Content of: <refentry><refsect1><para>
4238 #: apt_preferences.5.xml:1
4240 "Preferences are a strong power in the hands of a system administrator but "
4241 "they can become also their biggest nightmare if used without care! APT will "
4242 "not question the preferences, so wrong settings can lead to uninstallable "
4243 "packages or wrong decisions while upgrading packages. Even more problems "
4244 "will arise if multiple distribution releases are mixed without a good "
4245 "understanding of the following paragraphs. Packages included in a specific "
4246 "release aren't tested in (and therefore don't always work as expected in) "
4247 "older or newer releases, or together with other packages from different "
4248 "releases. You have been warned."
4251 #. type: Content of: <refentry><refsect1><para>
4252 #: apt_preferences.5.xml:1
4254 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4255 "directory are parsed in alphanumeric ascending order and need to obey the "
4256 "following naming convention: The files have either no or "
4257 "\"<literal>pref</literal>\" as filename extension and only contain "
4258 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4259 "Otherwise APT will print a notice that it has ignored a file, unless that "
4260 "file matches a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4261 "configuration list - in which case it will be silently ignored."
4264 #. type: Content of: <refentry><refsect1><refsect2><title>
4265 #: apt_preferences.5.xml:1
4266 msgid "APT's Default Priority Assignments"
4269 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4270 #: apt_preferences.5.xml:1
4273 "<command>apt-get install -t testing "
4274 "<replaceable>some-package</replaceable></command>\n"
4277 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4278 #: apt_preferences.5.xml:1
4280 msgid "APT::Default-Release \"stable\";\n"
4283 #. type: Content of: <refentry><refsect1><refsect2><para>
4284 #: apt_preferences.5.xml:1
4286 "If there is no preferences file or if there is no entry in the file that "
4287 "applies to a particular version then the priority assigned to that version "
4288 "is the priority of the distribution to which that version belongs. It is "
4289 "possible to single out a distribution, \"the target release\", which "
4290 "receives a higher priority than other distributions do by default. The "
4291 "target release can be set on the <command>apt-get</command> command line or "
4292 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4293 "that this has precedence over any general priority you set in the "
4294 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4295 "specifically pinned packages. For example, <placeholder "
4296 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4300 #. type: Content of: <refentry><refsect1><refsect2><para>
4301 #: apt_preferences.5.xml:1
4303 "If the target release has been specified then APT uses the following "
4304 "algorithm to set the priorities of the versions of a package. Assign:"
4307 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4308 #: apt_preferences.5.xml:1
4312 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4313 #: apt_preferences.5.xml:1
4315 "to the versions coming from archives which in their "
4316 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4317 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the Debian "
4318 "<literal>experimental</literal> archive."
4321 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4322 #: apt_preferences.5.xml:1
4323 msgid "priority 100"
4326 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4327 #: apt_preferences.5.xml:1
4329 "to the version that is already installed (if any) and to the versions coming "
4330 "from archives which in their <filename>Release</filename> files are marked "
4331 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the Debian "
4332 "backports archive since <literal>squeeze-backports</literal>."
4335 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4336 #: apt_preferences.5.xml:1
4337 msgid "priority 500"
4340 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4341 #: apt_preferences.5.xml:1
4342 msgid "to the versions that do not belong to the target release."
4345 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4346 #: apt_preferences.5.xml:1
4347 msgid "priority 990"
4350 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4351 #: apt_preferences.5.xml:1
4352 msgid "to the versions that belong to the target release."
4355 #. type: Content of: <refentry><refsect1><refsect2><para>
4356 #: apt_preferences.5.xml:1
4358 "The highest of those priorities whose description matches the version is "
4359 "assigned to the version."
4362 #. type: Content of: <refentry><refsect1><refsect2><para>
4363 #: apt_preferences.5.xml:1
4365 "If the target release has not been specified then APT simply assigns "
4366 "priority 100 to all installed package versions and priority 500 to all "
4367 "uninstalled package versions, except versions coming from archives which in "
4368 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4369 "- these versions get the priority 1 or priority 100 if it is additionally "
4370 "marked as \"ButAutomaticUpgrades: yes\"."
4373 #. type: Content of: <refentry><refsect1><refsect2><para>
4374 #: apt_preferences.5.xml:1
4376 "APT then applies the following rules, listed in order of precedence, to "
4377 "determine which version of a package to install."
4380 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4381 #: apt_preferences.5.xml:1
4383 "Never downgrade unless the priority of an available version exceeds 1000. "
4384 "(\"Downgrading\" is installing a less recent version of a package in place "
4385 "of a more recent version. Note that none of APT's default priorities "
4386 "exceeds 1000; such high priorities can only be set in the preferences file. "
4387 "Note also that downgrading a package can be risky.)"
4390 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4391 #: apt_preferences.5.xml:1
4392 msgid "Install the highest priority version."
4395 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4396 #: apt_preferences.5.xml:1
4398 "If two or more versions have the same priority, install the most recent one "
4399 "(that is, the one with the higher version number)."
4402 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4403 #: apt_preferences.5.xml:1
4405 "If two or more versions have the same priority and version number but either "
4406 "the packages differ in some of their metadata or the "
4407 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4410 #. type: Content of: <refentry><refsect1><refsect2><para>
4411 #: apt_preferences.5.xml:1
4413 "In a typical situation, the installed version of a package (priority 100) "
4414 "is not as recent as one of the versions available from the sources listed in "
4415 "the &sources-list; file (priority 500 or 990). Then the package will be "
4416 "upgraded when <command>apt-get install "
4417 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4418 "upgrade</command> is executed."
4421 #. type: Content of: <refentry><refsect1><refsect2><para>
4422 #: apt_preferences.5.xml:1
4424 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4425 "recent than any of the other available versions. The package will not be "
4426 "downgraded when <command>apt-get install "
4427 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4428 "upgrade</command> is executed."
4431 #. type: Content of: <refentry><refsect1><refsect2><para>
4432 #: apt_preferences.5.xml:1
4434 "Sometimes the installed version of a package is more recent than the version "
4435 "belonging to the target release, but not as recent as a version belonging to "
4436 "some other distribution. Such a package will indeed be upgraded when "
4437 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4438 "or <command>apt-get upgrade</command> is executed, because at least "
4439 "<emphasis>one</emphasis> of the available versions has a higher priority "
4440 "than the installed version."
4443 #. type: Content of: <refentry><refsect1><refsect2><title>
4444 #: apt_preferences.5.xml:1
4445 msgid "The Effect of APT Preferences"
4448 #. type: Content of: <refentry><refsect1><refsect2><para>
4449 #: apt_preferences.5.xml:1
4451 "The APT preferences file allows the system administrator to control the "
4452 "assignment of priorities. The file consists of one or more multi-line "
4453 "records separated by blank lines. Records can have one of two forms, a "
4454 "specific form and a general form."
4457 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4458 #: apt_preferences.5.xml:1
4460 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4461 "specified packages with a specified version or version range. For example, "
4462 "the following record assigns a high priority to all versions of the "
4463 "<filename>perl</filename> package whose version number begins with "
4464 "\"<literal>&good-perl;</literal>\". Multiple packages can be separated by "
4468 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4469 #: apt_preferences.5.xml:1
4473 "Pin: version &good-perl;*\n"
4474 "Pin-Priority: 1001\n"
4477 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4478 #: apt_preferences.5.xml:1
4480 "The general form assigns a priority to all of the package versions in a "
4481 "given distribution (that is, to all the versions of packages that are listed "
4482 "in a certain <filename>Release</filename> file) or to all of the package "
4483 "versions coming from a particular Internet site, as identified by the site's "
4484 "fully qualified domain name."
4487 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4488 #: apt_preferences.5.xml:1
4490 "This general-form entry in the APT preferences file applies only to groups "
4491 "of packages. For example, the following record assigns a high priority to "
4492 "all package versions available from the local site."
4495 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4496 #: apt_preferences.5.xml:1
4500 "Pin: origin \"\"\n"
4501 "Pin-Priority: 999\n"
4504 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4505 #: apt_preferences.5.xml:1
4507 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4508 "which can be used to match a hostname. The following record will assign a "
4509 "high priority to all versions available from the server identified by the "
4510 "hostname \"ftp.de.debian.org\""
4513 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4514 #: apt_preferences.5.xml:1
4518 "Pin: origin \"ftp.de.debian.org\"\n"
4519 "Pin-Priority: 999\n"
4522 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4523 #: apt_preferences.5.xml:1
4525 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4526 "distribution as specified in a <filename>Release</filename> file. What "
4527 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4528 "Internet address but an author or vendor name, such as \"Debian\" or "
4532 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4533 #: apt_preferences.5.xml:1
4535 "The following record assigns a low priority to all package versions "
4536 "belonging to any distribution whose Archive name is "
4537 "\"<literal>unstable</literal>\"."
4540 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4541 #: apt_preferences.5.xml:1
4545 "Pin: release a=unstable\n"
4546 "Pin-Priority: 50\n"
4549 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4550 #: apt_preferences.5.xml:1
4552 "The following record assigns a high priority to all package versions "
4553 "belonging to any distribution whose Codename is "
4554 "\"<literal>&debian-testing-codename;</literal>\"."
4557 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4558 #: apt_preferences.5.xml:1
4562 "Pin: release n=&debian-testing-codename;\n"
4563 "Pin-Priority: 900\n"
4566 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4567 #: apt_preferences.5.xml:1
4569 "The following record assigns a high priority to all package versions "
4570 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4571 "and whose release Version number is "
4572 "\"<literal>&debian-stable-version;</literal>\"."
4575 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4576 #: apt_preferences.5.xml:1
4580 "Pin: release a=stable, v=&debian-stable-version;\n"
4581 "Pin-Priority: 500\n"
4584 #. type: Content of: <refentry><refsect1><refsect2><para>
4585 #: apt_preferences.5.xml:1
4587 "The effect of the comma operator is similar to an \"and\" in logic: All "
4588 "conditions must be satisfied for the pin to match. There is one exception: "
4589 "For any type of condition (such as two \"a\" conditions), only the last such "
4590 "condition is checked."
4593 #. type: Content of: <refentry><refsect1><refsect2><title>
4594 #: apt_preferences.5.xml:1
4595 msgid "Regular expressions and &glob; syntax"
4598 #. type: Content of: <refentry><refsect1><refsect2><para>
4599 #: apt_preferences.5.xml:1
4601 "APT also supports pinning by &glob; expressions, and regular expressions "
4602 "surrounded by slashes. For example, the following example assigns the "
4603 "priority 500 to all packages from experimental where the name starts with "
4604 "gnome (as a &glob;-like expression) or contains the word kde (as a POSIX "
4605 "extended regular expression surrounded by slashes)."
4608 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4609 #: apt_preferences.5.xml:1
4612 "Package: gnome* /kde/\n"
4613 "Pin: release a=experimental\n"
4614 "Pin-Priority: 500\n"
4617 #. type: Content of: <refentry><refsect1><refsect2><para>
4618 #: apt_preferences.5.xml:1
4620 "The rule for those expressions is that they can occur anywhere where a "
4621 "string can occur. Thus, the following pin assigns the priority 990 to all "
4622 "packages from a release starting with &ubuntu-codename;."
4625 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4626 #: apt_preferences.5.xml:1
4630 "Pin: release n=&ubuntu-codename;*\n"
4631 "Pin-Priority: 990\n"
4634 #. type: Content of: <refentry><refsect1><refsect2><para>
4635 #: apt_preferences.5.xml:1
4637 "If a regular expression occurs in a <literal>Package</literal> field, the "
4638 "behavior is the same as if this regular expression were replaced with a list "
4639 "of all package names it matches. It is undecided whether this will change in "
4640 "the future; thus you should always list wild-card pins first, so later "
4641 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4642 "Package field is not considered a &glob; expression in itself."
4645 #. type: Content of: <refentry><refsect1><refsect2><title>
4646 #: apt_preferences.5.xml:1
4647 msgid "How APT Interprets Priorities"
4650 #. type: Content of: <refentry><refsect1><refsect2><para>
4651 #: apt_preferences.5.xml:1
4653 "Priorities (P) assigned in the APT preferences file must be positive or "
4654 "negative integers. They are interpreted as follows (roughly speaking):"
4657 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4658 #: apt_preferences.5.xml:1
4659 msgid "P >= 1000"
4662 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4663 #: apt_preferences.5.xml:1
4665 "causes a version to be installed even if this constitutes a downgrade of the "
4669 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4670 #: apt_preferences.5.xml:1
4671 msgid "990 <= P < 1000"
4674 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4675 #: apt_preferences.5.xml:1
4677 "causes a version to be installed even if it does not come from the target "
4678 "release, unless the installed version is more recent"
4681 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4682 #: apt_preferences.5.xml:1
4683 msgid "500 <= P < 990"
4686 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4687 #: apt_preferences.5.xml:1
4689 "causes a version to be installed unless there is a version available "
4690 "belonging to the target release or the installed version is more recent"
4693 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4694 #: apt_preferences.5.xml:1
4695 msgid "100 <= P < 500"
4698 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4699 #: apt_preferences.5.xml:1
4701 "causes a version to be installed unless there is a version available "
4702 "belonging to some other distribution or the installed version is more recent"
4705 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4706 #: apt_preferences.5.xml:1
4707 msgid "0 < P < 100"
4710 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4711 #: apt_preferences.5.xml:1
4713 "causes a version to be installed only if there is no installed version of "
4717 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4718 #: apt_preferences.5.xml:1
4722 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4723 #: apt_preferences.5.xml:1
4724 msgid "prevents the version from being installed"
4727 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4728 #: apt_preferences.5.xml:1
4732 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4733 #: apt_preferences.5.xml:1
4734 msgid "has undefined behaviour, do not use it."
4737 #. type: Content of: <refentry><refsect1><refsect2><para>
4738 #: apt_preferences.5.xml:1
4740 "The first specific-form record matching an available package version "
4741 "determines the priority of the package version. Failing that, the priority "
4742 "of the package is defined as the maximum of all priorities defined by "
4743 "generic-form records matching the version. Records defined using patterns "
4744 "in the Pin field other than \"*\" are treated like specific-form records."
4747 #. type: Content of: <refentry><refsect1><refsect2><para>
4748 #: apt_preferences.5.xml:1
4750 "For example, suppose the APT preferences file contains the three records "
4751 "presented earlier:"
4754 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4755 #: apt_preferences.5.xml:1
4759 "Pin: version &good-perl;*\n"
4760 "Pin-Priority: 1001\n"
4763 "Pin: origin \"\"\n"
4764 "Pin-Priority: 999\n"
4767 "Pin: release unstable\n"
4768 "Pin-Priority: 50\n"
4771 #. type: Content of: <refentry><refsect1><refsect2><para>
4772 #: apt_preferences.5.xml:1
4776 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4777 #: apt_preferences.5.xml:1
4779 "The most recent available version of the <literal>perl</literal> package "
4780 "will be installed, so long as that version's version number begins with "
4781 "\"<literal>&good-perl;</literal>\". If <emphasis>any</emphasis> "
4782 "&good-perl;* version of <literal>perl</literal> is available and the "
4783 "installed version is &bad-perl;*, then <literal>perl</literal> will be "
4787 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4788 #: apt_preferences.5.xml:1
4790 "A version of any package other than <literal>perl</literal> that is "
4791 "available from the local system has priority over other versions, even "
4792 "versions belonging to the target release."
4795 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4796 #: apt_preferences.5.xml:1
4798 "A version of a package whose origin is not the local system but some other "
4799 "site listed in &sources-list; and which belongs to an "
4800 "<literal>unstable</literal> distribution is only installed if it is selected "
4801 "for installation and no version of the package is already installed."
4804 #. type: Content of: <refentry><refsect1><refsect2><title>
4805 #: apt_preferences.5.xml:1
4806 msgid "Determination of Package Version and Distribution Properties"
4809 #. type: Content of: <refentry><refsect1><refsect2><para>
4810 #: apt_preferences.5.xml:1
4812 "The locations listed in the &sources-list; file should provide "
4813 "<filename>Packages</filename> and <filename>Release</filename> files to "
4814 "describe the packages available at that location."
4817 #. type: Content of: <refentry><refsect1><refsect2><para>
4818 #: apt_preferences.5.xml:1
4820 "The <filename>Packages</filename> file is normally found in the directory "
4821 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
4823 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
4824 "consists of a series of multi-line records, one for each package available "
4825 "in that directory. Only two lines in each record are relevant for setting "
4829 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4830 #: apt_preferences.5.xml:1
4831 msgid "the <literal>Package:</literal> line"
4834 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4835 #: apt_preferences.5.xml:1
4836 msgid "gives the package name"
4839 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4840 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1
4841 msgid "the <literal>Version:</literal> line"
4844 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4845 #: apt_preferences.5.xml:1
4846 msgid "gives the version number for the named package"
4849 #. type: Content of: <refentry><refsect1><refsect2><para>
4850 #: apt_preferences.5.xml:1
4852 "The <filename>Release</filename> file is normally found in the directory "
4853 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
4854 "example, <filename>.../dists/stable/Release</filename>, or "
4855 "<filename>.../dists/&debian-stable-codename;/Release</filename>. It "
4856 "consists of a single multi-line record which applies to "
4857 "<emphasis>all</emphasis> of the packages in the directory tree below its "
4858 "parent. Unlike the <filename>Packages</filename> file, nearly all of the "
4859 "lines in a <filename>Release</filename> file are relevant for setting APT "
4863 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4864 #: apt_preferences.5.xml:1
4865 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
4868 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4869 #: apt_preferences.5.xml:1
4871 "names the archive to which all the packages in the directory tree belong. "
4872 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
4873 "that all of the packages in the directory tree below the parent of the "
4874 "<filename>Release</filename> file are in a <literal>stable</literal> "
4875 "archive. Specifying this value in the APT preferences file would require "
4879 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4880 #: apt_preferences.5.xml:1
4882 msgid "Pin: release a=stable\n"
4885 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4886 #: apt_preferences.5.xml:1
4887 msgid "the <literal>Codename:</literal> line"
4890 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4891 #: apt_preferences.5.xml:1
4893 "names the codename to which all the packages in the directory tree belong. "
4894 "For example, the line \"Codename: &debian-testing-codename;\" specifies that "
4895 "all of the packages in the directory tree below the parent of the "
4896 "<filename>Release</filename> file belong to a version named "
4897 "<literal>&debian-testing-codename;</literal>. Specifying this value in the "
4898 "APT preferences file would require the line:"
4901 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4902 #: apt_preferences.5.xml:1
4904 msgid "Pin: release n=&debian-testing-codename;\n"
4907 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4908 #: apt_preferences.5.xml:1
4910 "names the release version. For example, the packages in the tree might "
4911 "belong to Debian release version &debian-stable-version;. Note that there "
4912 "is normally no version number for the <literal>testing</literal> and "
4913 "<literal>unstable</literal> distributions because they have not been "
4914 "released yet. Specifying this in the APT preferences file would require one "
4915 "of the following lines."
4918 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4919 #: apt_preferences.5.xml:1
4922 "Pin: release v=&debian-stable-version;\n"
4923 "Pin: release a=stable, v=&debian-stable-version;\n"
4924 "Pin: release &debian-stable-version;\n"
4927 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4928 #: apt_preferences.5.xml:1
4929 msgid "the <literal>Component:</literal> line"
4932 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4933 #: apt_preferences.5.xml:1
4935 "names the licensing component associated with the packages in the directory "
4936 "tree of the <filename>Release</filename> file. For example, the line "
4937 "\"Component: main\" specifies that all the packages in the directory tree "
4938 "are from the <literal>main</literal> component, which entails that they are "
4939 "licensed under terms listed in the Debian Free Software Guidelines. "
4940 "Specifying this component in the APT preferences file would require the "
4944 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4945 #: apt_preferences.5.xml:1
4947 msgid "Pin: release c=main\n"
4950 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4951 #: apt_preferences.5.xml:1
4952 msgid "the <literal>Origin:</literal> line"
4955 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4956 #: apt_preferences.5.xml:1
4958 "names the originator of the packages in the directory tree of the "
4959 "<filename>Release</filename> file. Most commonly, this is "
4960 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
4961 "file would require the line:"
4964 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4965 #: apt_preferences.5.xml:1
4967 msgid "Pin: release o=Debian\n"
4970 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4971 #: apt_preferences.5.xml:1
4972 msgid "the <literal>Label:</literal> line"
4975 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4976 #: apt_preferences.5.xml:1
4978 "names the label of the packages in the directory tree of the "
4979 "<filename>Release</filename> file. Most commonly, this is "
4980 "<literal>Debian</literal>. Specifying this label in the APT preferences "
4981 "file would require the line:"
4984 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
4985 #: apt_preferences.5.xml:1
4987 msgid "Pin: release l=Debian\n"
4990 #. type: Content of: <refentry><refsect1><refsect2><para>
4991 #: apt_preferences.5.xml:1
4993 "All of the <filename>Packages</filename> and <filename>Release</filename> "
4994 "files retrieved from locations listed in the &sources-list; file are stored "
4995 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
4996 "named by the variable <literal>Dir::State::Lists</literal> in the "
4997 "<filename>apt.conf</filename> file. For example, the file "
4998 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
4999 "contains the <filename>Release</filename> file retrieved from the site "
5000 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5001 "architecture files from the <literal>contrib</literal> component of the "
5002 "<literal>unstable</literal> distribution."
5005 #. type: Content of: <refentry><refsect1><refsect2><title>
5006 #: apt_preferences.5.xml:1
5007 msgid "Optional Lines in an APT Preferences Record"
5010 #. type: Content of: <refentry><refsect1><refsect2><para>
5011 #: apt_preferences.5.xml:1
5013 "Each record in the APT preferences file can optionally begin with one or "
5014 "more lines beginning with the word <literal>Explanation:</literal>. This "
5015 "provides a place for comments."
5018 #. type: Content of: <refentry><refsect1><refsect2><title>
5019 #: apt_preferences.5.xml:1
5020 msgid "Tracking Stable"
5023 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5024 #: apt_preferences.5.xml:1
5027 "Explanation: Uninstall or do not install any Debian-originated\n"
5028 "Explanation: package versions other than those in the stable distro\n"
5030 "Pin: release a=stable\n"
5031 "Pin-Priority: 900\n"
5034 "Pin: release o=Debian\n"
5035 "Pin-Priority: -10\n"
5038 #. type: Content of: <refentry><refsect1><refsect2><para>
5039 #: apt_preferences.5.xml:1
5041 "The following APT preferences file will cause APT to assign a priority "
5042 "higher than the default (500) to all package versions belonging to a "
5043 "<literal>stable</literal> distribution and a prohibitively low priority to "
5044 "package versions belonging to other <literal>Debian</literal> "
5045 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5048 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5049 #: apt_preferences.5.xml:1 apt_preferences.5.xml:1 apt_preferences.5.xml:1
5052 "apt-get install <replaceable>package-name</replaceable>\n"
5054 "apt-get dist-upgrade\n"
5057 #. type: Content of: <refentry><refsect1><refsect2><para>
5058 #: apt_preferences.5.xml:1
5060 "With a suitable &sources-list; file and the above preferences file, any of "
5061 "the following commands will cause APT to upgrade to the latest "
5062 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5066 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5067 #: apt_preferences.5.xml:1
5069 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5072 #. type: Content of: <refentry><refsect1><refsect2><para>
5073 #: apt_preferences.5.xml:1
5075 "The following command will cause APT to upgrade the specified package to the "
5076 "latest version from the <literal>testing</literal> distribution; the package "
5077 "will not be upgraded again unless this command is given again. <placeholder "
5078 "type=\"programlisting\" id=\"0\"/>"
5081 #. type: Content of: <refentry><refsect1><refsect2><title>
5082 #: apt_preferences.5.xml:1
5083 msgid "Tracking Testing or Unstable"
5086 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5087 #: apt_preferences.5.xml:1
5091 "Pin: release a=testing\n"
5092 "Pin-Priority: 900\n"
5095 "Pin: release a=unstable\n"
5096 "Pin-Priority: 800\n"
5099 "Pin: release o=Debian\n"
5100 "Pin-Priority: -10\n"
5103 #. type: Content of: <refentry><refsect1><refsect2><para>
5104 #: apt_preferences.5.xml:1
5106 "The following APT preferences file will cause APT to assign a high priority "
5107 "to package versions from the <literal>testing</literal> distribution, a "
5108 "lower priority to package versions from the <literal>unstable</literal> "
5109 "distribution, and a prohibitively low priority to package versions from "
5110 "other <literal>Debian</literal> distributions. <placeholder "
5111 "type=\"programlisting\" id=\"0\"/>"
5114 #. type: Content of: <refentry><refsect1><refsect2><para>
5115 #: apt_preferences.5.xml:1
5117 "With a suitable &sources-list; file and the above preferences file, any of "
5118 "the following commands will cause APT to upgrade to the latest "
5119 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5123 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5124 #: apt_preferences.5.xml:1
5126 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5129 #. type: Content of: <refentry><refsect1><refsect2><para>
5130 #: apt_preferences.5.xml:1
5132 "The following command will cause APT to upgrade the specified package to the "
5133 "latest version from the <literal>unstable</literal> distribution. "
5134 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5135 "the most recent <literal>testing</literal> version if that is more recent "
5136 "than the installed version, otherwise, to the most recent "
5137 "<literal>unstable</literal> version if that is more recent than the "
5138 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5141 #. type: Content of: <refentry><refsect1><refsect2><title>
5142 #: apt_preferences.5.xml:1
5143 msgid "Tracking the evolution of a codename release"
5146 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5147 #: apt_preferences.5.xml:1
5150 "Explanation: Uninstall or do not install any Debian-originated package "
5152 "Explanation: other than those in the distribution codenamed with "
5153 "&debian-testing-codename; or sid\n"
5155 "Pin: release n=&debian-testing-codename;\n"
5156 "Pin-Priority: 900\n"
5158 "Explanation: Debian unstable is always codenamed with sid\n"
5160 "Pin: release n=sid\n"
5161 "Pin-Priority: 800\n"
5164 "Pin: release o=Debian\n"
5165 "Pin-Priority: -10\n"
5168 #. type: Content of: <refentry><refsect1><refsect2><para>
5169 #: apt_preferences.5.xml:1
5171 "The following APT preferences file will cause APT to assign a priority "
5172 "higher than the default (500) to all package versions belonging to a "
5173 "specified codename of a distribution and a prohibitively low priority to "
5174 "package versions belonging to other <literal>Debian</literal> distributions, "
5175 "codenames and archives. Note that with this APT preference APT will follow "
5176 "the migration of a release from the archive <literal>testing</literal> to "
5177 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5178 "want to follow for example the progress in <literal>testing</literal> "
5179 "notwithstanding the codename changes you should use the example "
5180 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5183 #. type: Content of: <refentry><refsect1><refsect2><para>
5184 #: apt_preferences.5.xml:1
5186 "With a suitable &sources-list; file and the above preferences file, any of "
5187 "the following commands will cause APT to upgrade to the latest version(s) in "
5188 "the release codenamed with <literal>&debian-testing-codename;</literal>. "
5189 "<placeholder type=\"programlisting\" id=\"0\"/>"
5192 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5193 #: apt_preferences.5.xml:1
5195 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5198 #. type: Content of: <refentry><refsect1><refsect2><para>
5199 #: apt_preferences.5.xml:1
5201 "The following command will cause APT to upgrade the specified package to the "
5202 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5203 "<command>apt-get upgrade</command> will upgrade the package to the most "
5204 "recent <literal>&debian-testing-codename;</literal> version if that is more "
5205 "recent than the installed version, otherwise, to the most recent "
5206 "<literal>sid</literal> version if that is more recent than the installed "
5207 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5210 #. type: Content of: <refentry><refsect1><para>
5211 #: apt_preferences.5.xml:1
5212 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5215 #. type: Content of: <refentry><refnamediv><refpurpose>
5216 #: sources.list.5.xml:1
5217 msgid "List of configured APT data sources"
5220 #. type: Content of: <refentry><refsect1><para>
5221 #: sources.list.5.xml:1
5223 "The source list <filename>/etc/apt/sources.list</filename> and the files "
5224 "contained in <filename>/etc/apt/sources.list.d/</filename> are designed to "
5225 "support any number of active sources and a variety of source media. The "
5226 "files list one source per line (one-line style) or contain multiline stanzas "
5227 "defining one or more sources per stanza (deb822 style), with the most "
5228 "preferred source listed first (in case a single version is available from "
5229 "more than one source). The information available from the configured sources "
5230 "is acquired by <command>apt-get update</command> (or by an equivalent "
5231 "command from another APT front-end)."
5234 #. type: Content of: <refentry><refsect1><title>
5235 #: sources.list.5.xml:1
5236 msgid "sources.list.d"
5239 #. type: Content of: <refentry><refsect1><para>
5240 #: sources.list.5.xml:1
5242 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5243 "add sources.list entries in separate files. Two different file formats are "
5244 "allowed as described in the next two sections. Filenames need to have "
5245 "either the extension <filename>.list</filename> or "
5246 "<filename>.sources</filename> depending on the contained format. The "
5247 "filenames may only contain letters (a-z and A-Z), digits (0-9), underscore "
5248 "(_), hyphen (-) and period (.) characters. Otherwise APT will print a "
5249 "notice that it has ignored a file, unless that file matches a pattern in the "
5250 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in which "
5251 "case it will be silently ignored."
5254 #. type: Content of: <refentry><refsect1><title>
5255 #: sources.list.5.xml:1
5256 msgid "One-Line-Style Format"
5259 #. type: Content of: <refentry><refsect1><para>
5260 #: sources.list.5.xml:1
5262 "Files in this format have the extension <filename>.list</filename>. Each "
5263 "line specifying a source starts with a type "
5264 "(e.g. <literal>deb-src</literal>) followed by options and arguments for "
5265 "this type. Individual entries cannot be continued onto a following "
5266 "line. Empty lines are ignored, and a <literal>#</literal> character anywhere "
5267 "on a line marks the remainder of that line as a comment. Consequently an "
5268 "entry can be disabled by commenting out the entire line. If options should "
5269 "be provided they are separated by spaces and all of them together are "
5270 "enclosed by square brackets (<literal>[]</literal>) included in the line "
5271 "after the type separated from it with a space. If an option allows multiple "
5272 "values these are separated from each other with a comma "
5273 "(<literal>,</literal>). An option name is separated from its value(s) by an "
5274 "equals sign (<literal>=</literal>). Multivalue options also have "
5275 "<literal>-=</literal> and <literal>+=</literal> as separators, which instead "
5276 "of replacing the default with the given value(s) modify the default value(s) "
5277 "to remove or include the given values."
5280 #. type: Content of: <refentry><refsect1><para>
5281 #: sources.list.5.xml:1
5283 "This is the traditional format and supported by all apt versions. Note that "
5284 "not all options as described below are supported by all apt versions. Note "
5285 "also that some older applications parsing this format on their own might not "
5286 "expect to encounter options as they were uncommon before the introduction of "
5287 "multi-architecture support."
5290 #. type: Content of: <refentry><refsect1><title>
5291 #: sources.list.5.xml:1
5292 msgid "deb822-Style Format"
5295 #. type: Content of: <refentry><refsect1><para>
5296 #: sources.list.5.xml:1
5298 "Files in this format have the extension <filename>.sources</filename>. The "
5299 "format is similar in syntax to other files used by Debian and its "
5300 "derivatives, such as the metadata files that apt will download from the "
5301 "configured sources or the <filename>debian/control</filename> file in a "
5302 "Debian source package. Individual entries are separated by an empty line; "
5303 "additional empty lines are ignored, and a <literal>#</literal> character at "
5304 "the start of the line marks the entire line as a comment. An entry can hence "
5305 "be disabled by commenting out each line belonging to the stanza, but it is "
5306 "usually easier to add the field \"Enabled: no\" to the stanza to disable the "
5307 "entry. Removing the field or setting it to yes reenables it. Options have "
5308 "the same syntax as every other field: A fieldname separated by a colon "
5309 "(<literal>:</literal>) and optionally spaces from its value(s). Note "
5310 "especially that multiple values are separated by spaces, not by commas as in "
5311 "the one-line format. Multivalue fields like <literal>Architectures</literal> "
5312 "also have <literal>Architectures-Add</literal> and "
5313 "<literal>Architectures-Remove</literal> to modify the default value rather "
5314 "than replacing it."
5317 #. type: Content of: <refentry><refsect1><para>
5318 #: sources.list.5.xml:1
5320 "This is a new format supported by apt itself since version 1.1. Previous "
5321 "versions ignore such files with a notice message as described earlier. It "
5322 "is intended to make this format gradually the default format, deprecating "
5323 "the previously described one-line-style format, as it is easier to create, "
5324 "extend and modify for humans and machines alike especially if a lot of "
5325 "sources and/or options are involved. Developers who are working with and/or "
5326 "parsing apt sources are highly encouraged to add support for this format and "
5327 "to contact the APT team to coordinate and share this work. Users can freely "
5328 "adopt this format already, but may encounter problems with software not "
5329 "supporting the format yet."
5332 #. type: Content of: <refentry><refsect1><title>
5333 #: sources.list.5.xml:1
5334 msgid "The deb and deb-src Types: General Format"
5337 #. type: Content of: <refentry><refsect1><para>
5338 #: sources.list.5.xml:1
5340 "The <literal>deb</literal> type references a typical two-level Debian "
5341 "archive, <filename>distribution/component</filename>. The "
5342 "<literal>distribution</literal> is generally a suite name like "
5343 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5344 "<literal>&debian-stable-codename;</literal> or "
5345 "<literal>&debian-testing-codename;</literal> while component is one of "
5346 "<literal>main</literal>, <literal>contrib</literal> or "
5347 "<literal>non-free</literal>. The <literal>deb-src</literal> type references "
5348 "a Debian distribution's source code in the same form as the "
5349 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5350 "to fetch source indexes."
5353 #. type: Content of: <refentry><refsect1><para>
5354 #: sources.list.5.xml:1
5356 "The format for two one-line-style entries using the <literal>deb</literal> "
5357 "and <literal>deb-src</literal> types is:"
5360 #. type: Content of: <refentry><refsect1><literallayout>
5361 #: sources.list.5.xml:1
5364 "deb [ option1=value1 option2=value2 ] uri suite [component1] [component2] "
5366 "deb-src [ option1=value1 option2=value2 ] uri suite [component1] "
5367 "[component2] [...]"
5370 #. type: Content of: <refentry><refsect1><para><literallayout>
5371 #: sources.list.5.xml:1
5374 " Types: deb deb-src\n"
5377 " Components: [component1] [component2] [...]\n"
5378 " option1: value1\n"
5379 " option2: value2\n"
5383 #. type: Content of: <refentry><refsect1><para>
5384 #: sources.list.5.xml:1
5386 "Alternatively the equivalent entry in deb822 style looks like this: "
5387 "<placeholder type=\"literallayout\" id=\"0\"/>"
5390 #. type: Content of: <refentry><refsect1><para>
5391 #: sources.list.5.xml:1
5393 "The URI for the <literal>deb</literal> type must specify the base of the "
5394 "Debian distribution, from which APT will find the information it needs. "
5395 "<literal>suite</literal> can specify an exact path, in which case the "
5396 "components must be omitted and <literal>suite</literal> must end with a "
5397 "slash (<literal>/</literal>). This is useful for the case when only a "
5398 "particular sub-directory of the archive denoted by the URI is of interest. "
5399 "If <literal>suite</literal> does not specify an exact path, at least one "
5400 "<literal>component</literal> must be present."
5403 #. type: Content of: <refentry><refsect1><para>
5404 #: sources.list.5.xml:1
5406 "<literal>suite</literal> may also contain a variable, "
5407 "<literal>$(ARCH)</literal> which expands to the Debian architecture (such as "
5408 "<literal>amd64</literal> or <literal>armel</literal>) used on the "
5409 "system. This permits architecture-independent "
5410 "<filename>sources.list</filename> files to be used. In general this is only "
5411 "of interest when specifying an exact path; <literal>APT</literal> will "
5412 "automatically generate a URI with the current architecture otherwise."
5415 #. type: Content of: <refentry><refsect1><para>
5416 #: sources.list.5.xml:1
5418 "Especially in the one-line-style format since only one distribution can be "
5419 "specified per line it may be necessary to have multiple lines for the same "
5420 "URI, if a subset of all available distributions or components at that "
5421 "location is desired. APT will sort the URI list after it has generated a "
5422 "complete set internally, and will collapse multiple references to the same "
5423 "Internet host, for instance, into a single connection, so that it does not "
5424 "inefficiently establish a connection, close it, do something else, and then "
5425 "re-establish a connection to that same host. APT also parallelizes "
5426 "connections to different hosts to more effectively deal with sites with low "
5430 #. type: Content of: <refentry><refsect1><para>
5431 #: sources.list.5.xml:1
5433 "It is important to list sources in order of preference, with the most "
5434 "preferred source listed first. Typically this will result in sorting by "
5435 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5436 "followed by distant Internet hosts, for example)."
5439 #. type: Content of: <refentry><refsect1><para><literallayout>
5440 #: sources.list.5.xml:1
5442 msgid "&sourceslist-list-format;"
5445 #. type: Content of: <refentry><refsect1><para><literallayout>
5446 #: sources.list.5.xml:1
5448 msgid "&sourceslist-sources-format;"
5451 #. type: Content of: <refentry><refsect1><para>
5452 #: sources.list.5.xml:1
5454 "As an example, the sources for your distribution could look like this in "
5455 "one-line-style format: <placeholder type=\"literallayout\" id=\"0\"/> or "
5456 "like this in deb822 style format: <placeholder type=\"literallayout\" "
5460 #. type: Content of: <refentry><refsect1><title>
5461 #: sources.list.5.xml:1
5462 msgid "The deb and deb-src types: Options"
5465 #. type: Content of: <refentry><refsect1><para>
5466 #: sources.list.5.xml:1
5468 "Each source entry can have options specified to modify which source is "
5469 "accessed and how data is acquired from it. Format, syntax and names of the "
5470 "options vary between the one-line-style and deb822-style formats as "
5471 "described, but they both have the same options available. For simplicity we "
5472 "list the deb822 fieldname and provide the one-line name in brackets. "
5473 "Remember that besides setting multivalue options explicitly, there is also "
5474 "the option to modify them based on the default, but we aren't listing those "
5475 "names explicitly here. Unsupported options are silently ignored by all APT "
5479 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5480 #: sources.list.5.xml:1
5482 "<option>Architectures</option> (<option>arch</option>) is a multivalue "
5483 "option defining for which architectures information should be downloaded. If "
5484 "this option isn't set the default is all architectures as defined by the "
5485 "<option>APT::Architectures</option> config option."
5488 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5489 #: sources.list.5.xml:1
5491 "<option>Languages</option> (<option>lang</option>) is a multivalue option "
5492 "defining for which languages information such as translated package "
5493 "descriptions should be downloaded. If this option isn't set the default is "
5494 "all languages as defined by the <option>Acquire::Languages</option> config "
5498 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5499 #: sources.list.5.xml:1
5501 "<option>Targets</option> (<option>target</option>) is a multivalue option "
5502 "defining which download targets apt will try to acquire from this source. If "
5503 "not specified, the default set is defined by the "
5504 "<option>Acquire::IndexTargets</option> configuration scope (targets are "
5505 "specified by their name in the <literal>Created-By</literal> field). "
5506 "Additionally, targets can be enabled or disabled by using the "
5507 "<literal>Identifier</literal> field as an option with a boolean value "
5508 "instead of using this multivalue option."
5511 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5512 #: sources.list.5.xml:1
5514 "<option>PDiffs</option> (<option>pdiffs</option>) is a yes/no value which "
5515 "controls if APT should try to use PDiffs to update old indexes instead of "
5516 "downloading the new indexes entirely. The value of this option is ignored if "
5517 "the repository doesn't announce the availability of PDiffs. Defaults to the "
5518 "value of the option with the same name for a specific index file defined in "
5519 "the <option>Acquire::IndexTargets</option> scope, which itself defaults to "
5520 "the value of configuration option <option>Acquire::PDiffs</option> which "
5521 "defaults to <literal>yes</literal>."
5524 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5525 #: sources.list.5.xml:1
5527 "<option>By-Hash</option> (<option>by-hash</option>) can have the value "
5528 "<literal>yes</literal>, <literal>no</literal> or <literal>force</literal> "
5529 "and controls if APT should try to acquire indexes via a URI constructed from "
5530 "a hashsum of the expected file instead of using the well-known stable "
5531 "filename of the index. Using this can avoid hashsum mismatches, but requires "
5532 "a supporting mirror. A <literal>yes</literal> or <literal>no</literal> value "
5533 "activates/disables the use of this feature if this source indicates support "
5534 "for it, while <literal>force</literal> will enable the feature regardless of "
5535 "what the source indicates. Defaults to the value of the option of the same "
5536 "name for a specific index file defined in the "
5537 "<option>Acquire::IndexTargets</option> scope, which itself defaults to the "
5538 "value of configuration option <option>Acquire::By-Hash</option> which "
5539 "defaults to <literal>yes</literal>."
5542 #. type: Content of: <refentry><refsect1><para>
5543 #: sources.list.5.xml:1
5545 "Furthermore, there are options which if set affect <emphasis>all</emphasis> "
5546 "sources with the same URI and Suite, so they have to be set on all such "
5547 "entries and can not be varied between different components. APT will try to "
5548 "detect and error out on such anomalies."
5551 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5552 #: sources.list.5.xml:1
5554 "<option>Allow-Insecure</option> (<option>allow-insecure</option>), "
5555 "<option>Allow-Weak</option> (<option>allow-weak</option>) and "
5556 "<option>Allow-Downgrade-To-Insecure</option> "
5557 "(<option>allow-downgrade-to-insecure</option>) are boolean values which all "
5558 "default to <literal>no</literal>. If set to <literal>yes</literal> they "
5559 "circumvent parts of &apt-secure; and should therefore not be used lightly!"
5562 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5563 #: sources.list.5.xml:1
5565 "<option>Trusted</option> (<option>trusted</option>) is a tri-state value "
5566 "which defaults to APT deciding if a source is considered trusted or if "
5567 "warnings should be raised before e.g. packages are installed from this "
5568 "source. This option can be used to override that decision. The value "
5569 "<literal>yes</literal> tells APT always to consider this source as trusted, "
5570 "even if it doesn't pass authentication checks. It disables parts of "
5571 "&apt-secure;, and should therefore only be used in a local and trusted "
5572 "context (if at all) as otherwise security is breached. The value "
5573 "<literal>no</literal> does the opposite, causing the source to be handled as "
5574 "untrusted even if the authentication checks passed successfully. The default "
5575 "value can't be set explicitly."
5578 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5579 #: sources.list.5.xml:1
5581 "<option>Signed-By</option> (<option>signed-by</option>) is either an "
5582 "absolute path to a keyring file (has to be accessible and readable for the "
5583 "<literal>_apt</literal> user, so ensure everyone has read-permissions on the "
5584 "file) or one or more fingerprints of keys either in the "
5585 "<filename>trusted.gpg</filename> keyring or in the keyrings in the "
5586 "<filename>trusted.gpg.d/</filename> directory (see <command>apt-key "
5587 "fingerprint</command>). If the option is set, only the key(s) in this "
5588 "keyring or only the keys with these fingerprints are used for the "
5589 "&apt-secure; verification of this repository. Defaults to the value of the "
5590 "option with the same name if set in the previously acquired "
5591 "<filename>Release</filename> file. Otherwise all keys in the trusted "
5592 "keyrings are considered valid signers for this repository."
5595 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5596 #: sources.list.5.xml:1
5598 "<option>Check-Valid-Until</option> (<option>check-valid-until</option>) is "
5599 "a yes/no value which controls if APT should try to detect replay attacks. A "
5600 "repository creator can declare a time until which the data provided in the "
5601 "repository should be considered valid, and if this time is reached, but no "
5602 "new data is provided, the data is considered expired and an error is "
5603 "raised. Besides increasing security, as a malicious attacker can't send old "
5604 "data forever to prevent a user from upgrading to a new version, this also "
5605 "helps users identify mirrors which are no longer updated. However, some "
5606 "repositories such as historic archives are not updated any more by design, "
5607 "so this check can be disabled by setting this option to "
5608 "<literal>no</literal>. Defaults to the value of configuration option "
5609 "<option>Acquire::Check-Valid-Until</option> which itself defaults to "
5610 "<literal>yes</literal>."
5613 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5614 #: sources.list.5.xml:1
5616 "<option>Valid-Until-Min</option> (<option>valid-until-min</option>) and "
5617 "<option>Valid-Until-Max</option> (<option>valid-until-max</option>) can be "
5618 "used to raise or lower the time period in seconds in which the data from "
5619 "this repository is considered valid. -Max can be especially useful if the "
5620 "repository provides no Valid-Until field on its Release file to set your own "
5621 "value, while -Min can be used to increase the valid time on seldom updated "
5622 "(local) mirrors of a more frequently updated but less accessible archive "
5623 "(which is in the sources.list as well) instead of disabling the check "
5624 "entirely. Default to the value of the configuration options "
5625 "<option>Acquire::Min-ValidTime</option> and "
5626 "<option>Acquire::Max-ValidTime</option> which are both unset by default."
5629 #. type: Content of: <refentry><refsect1><title>
5630 #: sources.list.5.xml:1
5631 msgid "URI Specification"
5634 #. type: Content of: <refentry><refsect1><para>
5635 #: sources.list.5.xml:1
5636 msgid "The currently recognized URI types are:"
5639 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5640 #: sources.list.5.xml:1
5642 "The file scheme allows an arbitrary directory in the file system to be "
5643 "considered an archive. This is useful for NFS mounts and local mirrors or "
5647 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5648 #: sources.list.5.xml:1
5650 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5651 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5655 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5656 #: sources.list.5.xml:1
5658 "The http scheme specifies an HTTP server for the archive. If an environment "
5659 "variable <envar>http_proxy</envar> is set with the format "
5660 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5661 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5662 "the format http://user:pass@server:port/. Note that this is an insecure "
5663 "method of authentication."
5666 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5667 #: sources.list.5.xml:1
5669 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5670 "is highly configurable; for more information see the &apt-conf; manual "
5671 "page. Please note that an FTP proxy can be specified by using the "
5672 "<envar>ftp_proxy</envar> environment variable. It is possible to specify an "
5673 "HTTP proxy (HTTP proxy servers often understand FTP URLs) using this "
5674 "environment variable and <emphasis>only</emphasis> this environment "
5675 "variable. Proxies using HTTP specified in the configuration file will be "
5679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5680 #: sources.list.5.xml:1
5682 "The copy scheme is identical to the file scheme except that packages are "
5683 "copied into the cache directory instead of used directly at their location. "
5684 "This is useful for people using removable media to copy files around with "
5688 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5689 #: sources.list.5.xml:1
5691 "The rsh/ssh method invokes RSH/SSH to connect to a remote host and access "
5692 "the files as a given user. Prior configuration of rhosts or RSA keys is "
5693 "recommended. The standard <command>find</command> and <command>dd</command> "
5694 "commands are used to perform the file transfers from the remote host."
5697 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5698 #: sources.list.5.xml:1
5699 msgid "adding more recognizable URI types"
5702 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5703 #: sources.list.5.xml:1
5705 "APT can be extended with more methods shipped in other optional packages, "
5706 "which should follow the naming scheme "
5707 "<package>apt-transport-<replaceable>method</replaceable></package>. For "
5708 "instance, the APT team also maintains the package "
5709 "<package>apt-transport-https</package>, which provides access methods for "
5710 "HTTPS URIs with features similar to the http method. Methods for using "
5711 "e.g. debtorrent are also available - see &apt-transport-debtorrent;."
5714 #. type: Content of: <refentry><refsect1><para>
5715 #: sources.list.5.xml:1
5717 "Uses the archive stored locally (or NFS mounted) at /home/apt/debian for "
5718 "stable/main, stable/contrib, and stable/non-free."
5721 #. type: Content of: <refentry><refsect1><literallayout>
5722 #: sources.list.5.xml:1
5724 msgid "deb file:/home/apt/debian stable main contrib non-free"
5727 #. type: Content of: <refentry><refsect1><literallayout>
5728 #: sources.list.5.xml:1
5732 "URIs: file:/home/apt/debian\n"
5734 "Components: main contrib non-free"
5737 #. type: Content of: <refentry><refsect1><para>
5738 #: sources.list.5.xml:1
5739 msgid "As above, except this uses the unstable (development) distribution."
5742 #. type: Content of: <refentry><refsect1><literallayout>
5743 #: sources.list.5.xml:1
5745 msgid "deb 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
5760 msgid "Sources specification for the above."
5763 #. type: Content of: <refentry><refsect1><literallayout>
5764 #: sources.list.5.xml:1
5766 msgid "deb-src file:/home/apt/debian unstable main contrib non-free"
5769 #. type: Content of: <refentry><refsect1><literallayout>
5770 #: sources.list.5.xml:1
5774 "URIs: file:/home/apt/debian\n"
5775 "Suites: unstable\n"
5776 "Components: main contrib non-free"
5779 #. type: Content of: <refentry><refsect1><para>
5780 #: sources.list.5.xml:1
5782 "The first line gets package information for the architectures in "
5783 "<literal>APT::Architectures</literal> while the second always retrieves "
5784 "<literal>amd64</literal> and <literal>armel</literal>."
5787 #. type: Content of: <refentry><refsect1><literallayout>
5788 #: sources.list.5.xml:1
5791 "deb http://deb.debian.org/debian &debian-stable-codename; main\n"
5792 "deb [ arch=amd64,armel ] http://deb.debian.org/debian "
5793 "&debian-stable-codename; main"
5796 #. type: Content of: <refentry><refsect1><literallayout>
5797 #: sources.list.5.xml:1
5801 "URIs: http://deb.debian.org/debian\n"
5802 "Suites: &debian-stable-codename;\n"
5803 "Components: main\n"
5806 "URIs: http://deb.debian.org/debian\n"
5807 "Suites: &debian-stable-codename;\n"
5808 "Components: main\n"
5809 "Architectures: amd64 armel\n"
5812 #. type: Content of: <refentry><refsect1><para>
5813 #: sources.list.5.xml:1
5815 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5819 #. type: Content of: <refentry><refsect1><literallayout>
5820 #: sources.list.5.xml:1
5822 msgid "deb http://archive.debian.org/debian-archive hamm main"
5825 #. type: Content of: <refentry><refsect1><literallayout>
5826 #: sources.list.5.xml:1
5830 "URIs: http://archive.debian.org/debian-archive\n"
5835 #. type: Content of: <refentry><refsect1><para>
5836 #: sources.list.5.xml:1
5838 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5839 "directory, and uses only the &debian-stable-codename;/contrib area."
5842 #. type: Content of: <refentry><refsect1><literallayout>
5843 #: sources.list.5.xml:1
5845 msgid "deb ftp://ftp.debian.org/debian &debian-stable-codename; contrib"
5848 #. type: Content of: <refentry><refsect1><literallayout>
5849 #: sources.list.5.xml:1
5853 "URIs: ftp://ftp.debian.org/debian\n"
5854 "Suites: &debian-stable-codename;\n"
5855 "Components: contrib"
5858 #. type: Content of: <refentry><refsect1><para>
5859 #: sources.list.5.xml:1
5861 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5862 "directory, and uses only the unstable/contrib area. If this line appears as "
5863 "well as the one in the previous example in <filename>sources.list</filename> "
5864 "a single FTP session will be used for both resource lines."
5867 #. type: Content of: <refentry><refsect1><literallayout>
5868 #: sources.list.5.xml:1
5870 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5873 #. type: Content of: <refentry><refsect1><literallayout>
5874 #: sources.list.5.xml:1
5878 "URIs: ftp://ftp.debian.org/debian\n"
5879 "Suites: unstable\n"
5880 "Components: contrib"
5883 #. type: Content of: <refentry><refsect1><para><literallayout>
5884 #: sources.list.5.xml:1
5886 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5889 #. type: Content of: <refentry><refsect1><para><literallayout>
5890 #: sources.list.5.xml:1
5894 "URIs: http://ftp.tlh.debian.org/universe\n"
5895 "Suites: unstable/binary-$(ARCH)/"
5898 #. type: Content of: <refentry><refsect1><para>
5899 #: sources.list.5.xml:1
5901 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5902 "directory, and uses only files found under "
5903 "<filename>unstable/binary-i386</filename> on i386 machines, "
5904 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5905 "supported architectures. [Note this example only illustrates how to use the "
5906 "substitution variable; official debian archives are not structured like "
5907 "this] <placeholder type=\"literallayout\" id=\"0\"/> <placeholder "
5908 "type=\"literallayout\" id=\"1\"/>"
5911 #. type: Content of: <refentry><refsect1><para>
5912 #: sources.list.5.xml:1
5914 "Uses HTTP to get binary packages as well as sources from the stable, testing "
5915 "and unstable suites and the components main and contrib."
5918 #. type: Content of: <refentry><refsect1><literallayout>
5919 #: sources.list.5.xml:1
5922 "deb http://deb.debian.org/debian stable main contrib\n"
5923 "deb-src http://deb.debian.org/debian stable main contrib\n"
5924 "deb http://deb.debian.org/debian testing main contrib\n"
5925 "deb-src http://deb.debian.org/debian testing main contrib\n"
5926 "deb http://deb.debian.org/debian unstable main contrib\n"
5927 "deb-src http://deb.debian.org/debian unstable main contrib"
5930 #. type: Content of: <refentry><refsect1><literallayout>
5931 #: sources.list.5.xml:1
5934 "Types: deb deb-src\n"
5935 "URIs: http://deb.debian.org/debian\n"
5936 "Suites: stable testing unstable\n"
5937 "Components: main contrib\n"
5940 #. type: Content of: <refentry><refsect1><para>
5941 #: sources.list.5.xml:1
5942 msgid "&apt-get;, &apt-conf;, &apt-acquire-additional-files;"
5945 #. type: Content of: <refentry><refmeta><manvolnum>
5946 #: apt-extracttemplates.1.xml:1 apt-sortpkgs.1.xml:1 apt-ftparchive.1.xml:1
5950 #. type: Content of: <refentry><refnamediv><refpurpose>
5951 #: apt-extracttemplates.1.xml:1
5953 "Utility to extract <command>debconf</command> config and templates from "
5957 #. type: Content of: <refentry><refsect1><para>
5958 #: apt-extracttemplates.1.xml:1
5960 "<command>apt-extracttemplates</command> will take one or more Debian package "
5961 "files as input and write out (to a temporary directory) all associated "
5962 "config scripts and template files. For each passed in package that contains "
5963 "config scripts and templates, one line of output will be generated in the "
5967 #. type: Content of: <refentry><refsect1><para>
5968 #: apt-extracttemplates.1.xml:1
5969 msgid "package version template-file config-script"
5972 #. type: Content of: <refentry><refsect1><para>
5973 #: apt-extracttemplates.1.xml:1
5975 "template-file and config-script are written to the temporary directory "
5976 "specified by the <option>-t</option> or <option>--tempdir</option> "
5977 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
5978 "filenames of the form <filename>package.template.XXXXXX</filename> and "
5979 "<filename>package.config.XXXXXX</filename>"
5982 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5983 #: apt-extracttemplates.1.xml:1
5985 "Temporary directory in which to write extracted <command>debconf</command> "
5986 "template files and config scripts. Configuration Item: "
5987 "<literal>APT::ExtractTemplates::TempDir</literal>"
5990 #. type: Content of: <refentry><refsect1><para>
5991 #: apt-extracttemplates.1.xml:1
5993 "<command>apt-extracttemplates</command> returns zero on normal operation, "
5994 "decimal 100 on error."
5997 #. type: Content of: <refentry><refnamediv><refpurpose>
5998 #: apt-sortpkgs.1.xml:1
5999 msgid "Utility to sort package index files"
6002 #. type: Content of: <refentry><refsect1><para>
6003 #: apt-sortpkgs.1.xml:1
6005 "<command>apt-sortpkgs</command> will take an index file (source index or "
6006 "package index) and sort the records so that they are ordered by the package "
6007 "name. It will also sort the internal fields of each record according to the "
6008 "internal sorting rules."
6011 #. type: Content of: <refentry><refsect1><para>
6012 #: apt-sortpkgs.1.xml:1
6013 msgid "All output is sent to standard output; the input must be a seekable file."
6016 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6017 #: apt-sortpkgs.1.xml:1
6019 "Use source index field ordering. Configuration Item: "
6020 "<literal>APT::SortPkgs::Source</literal>."
6023 #. type: Content of: <refentry><refsect1><para>
6024 #: apt-sortpkgs.1.xml:1
6026 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
6030 #. type: Content of: <refentry><refnamediv><refpurpose>
6031 #: apt-ftparchive.1.xml:1
6032 msgid "Utility to generate index files"
6035 #. type: Content of: <refentry><refsect1><para>
6036 #: apt-ftparchive.1.xml:1
6038 "<command>apt-ftparchive</command> is the command line tool that generates "
6039 "the index files that APT uses to access a distribution source. The index "
6040 "files should be generated on the origin site based on the content of that "
6044 #. type: Content of: <refentry><refsect1><para>
6045 #: apt-ftparchive.1.xml:1
6047 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
6048 "program, incorporating its entire functionality via the "
6049 "<literal>packages</literal> command. It also contains a contents file "
6050 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
6051 "the generation process for a complete archive."
6054 #. type: Content of: <refentry><refsect1><para>
6055 #: apt-ftparchive.1.xml:1
6057 "Internally <command>apt-ftparchive</command> can make use of binary "
6058 "databases to cache the contents of a .deb file and it does not rely on any "
6059 "external programs aside from &gzip;. When doing a full generate it "
6060 "automatically performs file-change checks and builds the desired compressed "
6064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6065 #: apt-ftparchive.1.xml:1
6067 "The packages command generates a package file from a directory tree. It "
6068 "takes the given directory and recursively searches it for .deb files, "
6069 "emitting a package record to stdout for each. This command is approximately "
6070 "equivalent to &dpkg-scanpackages;."
6073 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6074 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6075 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
6078 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6079 #: apt-ftparchive.1.xml:1
6081 "The <literal>sources</literal> command generates a source index file from a "
6082 "directory tree. It takes the given directory and recursively searches it "
6083 "for .dsc files, emitting a source record to stdout for each. This command is "
6084 "approximately equivalent to &dpkg-scansources;."
6087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6088 #: apt-ftparchive.1.xml:1
6090 "If an override file is specified then a source override file will be looked "
6091 "for with an extension of .src. The --source-override option can be used to "
6092 "change the source override file that will be used."
6095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6096 #: apt-ftparchive.1.xml:1
6098 "The <literal>contents</literal> command generates a contents file from a "
6099 "directory tree. It takes the given directory and recursively searches it for "
6100 ".deb files, and reads the file list from each file. It then sorts and writes "
6101 "to stdout the list of files matched to packages. Directories are not written "
6102 "to the output. If multiple packages own the same file then each package is "
6103 "separated by a comma in the output."
6106 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6107 #: apt-ftparchive.1.xml:1
6109 "The <literal>release</literal> command generates a Release file from a "
6110 "directory tree. It recursively searches the given directory for uncompressed "
6111 "and compressed <filename>Packages</filename>, <filename>Sources</filename>, "
6112 "<filename>Contents</filename>, <filename>Components</filename> and "
6113 "<filename>icons</filename> files as well as <filename>Release</filename>, "
6114 "<filename>Index</filename> and <filename>md5sum.txt</filename> files by "
6115 "default (<literal>APT::FTPArchive::Release::Default-Patterns</literal>). "
6116 "Additional filename patterns can be added by listing them in "
6117 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
6118 "stdout a <filename>Release</filename> file containing (by default) an MD5, "
6119 "SHA1, SHA256 and SHA512 digest for each file."
6122 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6123 #: apt-ftparchive.1.xml:1
6125 "Values for the additional metadata fields in the Release file are taken from "
6126 "the corresponding variables under "
6127 "<literal>APT::FTPArchive::Release</literal>, "
6128 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
6129 "fields are <literal>Origin</literal>, <literal>Label</literal>, "
6130 "<literal>Suite</literal>, <literal>Version</literal>, "
6131 "<literal>Codename</literal>, <literal>Date</literal>, "
6132 "<literal>Valid-Until</literal>, <literal>Signed-By</literal>, "
6133 "<literal>Architectures</literal>, <literal>Components</literal> and "
6134 "<literal>Description</literal>."
6137 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6138 #: apt-ftparchive.1.xml:1
6140 "The <literal>generate</literal> command is designed to be runnable from a "
6141 "cron script and builds indexes according to the given config file. The "
6142 "config language provides a flexible means of specifying which index files "
6143 "are built from which directories, as well as providing a simple means of "
6144 "maintaining the required settings."
6147 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6148 #: apt-ftparchive.1.xml:1
6150 "The <literal>clean</literal> command tidies the databases used by the given "
6151 "configuration file by removing any records that are no longer necessary."
6154 #. type: Content of: <refentry><refsect1><title>
6155 #: apt-ftparchive.1.xml:1
6156 msgid "The Generate Configuration"
6159 #. type: Content of: <refentry><refsect1><para>
6160 #: apt-ftparchive.1.xml:1
6162 "The <literal>generate</literal> command uses a configuration file to "
6163 "describe the archives that are going to be generated. It follows the typical "
6164 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
6165 "&apt-conf; contains a description of the syntax. Note that the generate "
6166 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
6167 "tree manner. This only effects how the scope tag is handled."
6170 #. type: Content of: <refentry><refsect1><para>
6171 #: apt-ftparchive.1.xml:1
6172 msgid "The generate configuration has four separate sections, each described below."
6175 #. type: Content of: <refentry><refsect1><refsect2><title>
6176 #: apt-ftparchive.1.xml:1
6177 msgid "<literal>Dir</literal> Section"
6180 #. type: Content of: <refentry><refsect1><refsect2><para>
6181 #: apt-ftparchive.1.xml:1
6183 "The <literal>Dir</literal> section defines the standard directories needed "
6184 "to locate the files required during the generation process. These "
6185 "directories are prepended certain relative paths defined in later sections "
6186 "to produce a complete an absolute path."
6189 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6190 #: apt-ftparchive.1.xml:1
6192 "Specifies the root of the FTP archive, in a standard Debian configuration "
6193 "this is the directory that contains the <filename>ls-LR</filename> and dist "
6197 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6198 #: apt-ftparchive.1.xml:1
6199 msgid "Specifies the location of the override files."
6202 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6203 #: apt-ftparchive.1.xml:1
6204 msgid "Specifies the location of the cache files."
6207 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6208 #: apt-ftparchive.1.xml:1
6210 "Specifies the location of the file list files, if the "
6211 "<literal>FileList</literal> setting is used below."
6214 #. type: Content of: <refentry><refsect1><refsect2><title>
6215 #: apt-ftparchive.1.xml:1
6216 msgid "<literal>Default</literal> Section"
6219 #. type: Content of: <refentry><refsect1><refsect2><para>
6220 #: apt-ftparchive.1.xml:1
6222 "The <literal>Default</literal> section specifies default values, and "
6223 "settings that control the operation of the generator. Other sections may "
6224 "override these defaults with a per-section setting."
6227 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6228 #: apt-ftparchive.1.xml:1
6230 "Sets the default compression schemes to use for the package index files. It "
6231 "is a string that contains a space separated list of at least one of the "
6232 "compressors configured via the <option>APT::Compressor</option> "
6233 "configuration scope. The default for all compression schemes is '. gzip'."
6236 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6237 #: apt-ftparchive.1.xml:1
6239 "Sets the default list of file extensions that are package files. This "
6240 "defaults to '.deb'."
6243 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6244 #: apt-ftparchive.1.xml:1
6246 "This is similar to <literal>Packages::Compress</literal> except that it "
6247 "controls the compression for the Sources files."
6250 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6251 #: apt-ftparchive.1.xml:1
6253 "Sets the default list of file extensions that are source files. This "
6254 "defaults to '.dsc'."
6257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6258 #: apt-ftparchive.1.xml:1
6260 "This is similar to <literal>Packages::Compress</literal> except that it "
6261 "controls the compression for the Contents files."
6264 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6265 #: apt-ftparchive.1.xml:1
6267 "This is similar to <literal>Packages::Compress</literal> except that it "
6268 "controls the compression for the Translation-en master file."
6271 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6272 #: apt-ftparchive.1.xml:1
6274 "Specifies the number of kilobytes to delink (and replace with hard links) "
6275 "per run. This is used in conjunction with the per-section "
6276 "<literal>External-Links</literal> setting."
6279 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6280 #: apt-ftparchive.1.xml:1
6282 "Specifies the mode of all created index files. It defaults to 0644. All "
6283 "index files are set to this mode with no regard to the umask."
6286 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6287 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6289 "Specifies whether long descriptions should be included in the "
6290 "<filename>Packages</filename> file or split out into a master "
6291 "<filename>Translation-en</filename> file."
6294 #. type: Content of: <refentry><refsect1><refsect2><title>
6295 #: apt-ftparchive.1.xml:1
6296 msgid "<literal>TreeDefault</literal> Section"
6299 #. type: Content of: <refentry><refsect1><refsect2><para>
6300 #: apt-ftparchive.1.xml:1
6302 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
6303 "variables are substitution variables and have the strings $(DIST), "
6304 "$(SECTION) and $(ARCH) replaced with their respective values."
6307 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6308 #: apt-ftparchive.1.xml:1
6310 "Sets the number of kilobytes of contents files that are generated each "
6311 "day. The contents files are round-robined so that over several days they "
6312 "will all be rebuilt."
6315 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6316 #: apt-ftparchive.1.xml:1
6318 "Controls the number of days a contents file is allowed to be checked without "
6319 "changing. If this limit is passed the mtime of the contents file is "
6320 "updated. This case can occur if the package file is changed in such a way "
6321 "that does not result in a new contents file [override edit for instance]. A "
6322 "hold off is allowed in hopes that new .debs will be installed, requiring a "
6323 "new file anyhow. The default is 10, the units are in days."
6326 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6327 #: apt-ftparchive.1.xml:1
6329 "Sets the top of the .deb directory tree. Defaults to "
6330 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
6333 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6334 #: apt-ftparchive.1.xml:1
6336 "Sets the top of the source package directory tree. Defaults to "
6337 "<filename>$(DIST)/$(SECTION)/source/</filename>"
6340 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6341 #: apt-ftparchive.1.xml:1
6343 "Sets the output Packages file. Defaults to "
6344 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
6347 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6348 #: apt-ftparchive.1.xml:1
6350 "Sets the output Sources file. Defaults to "
6351 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
6354 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6355 #: apt-ftparchive.1.xml:1
6357 "Sets the output Translation-en master file with the long descriptions if "
6358 "they should be not included in the Packages file. Defaults to "
6359 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
6362 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6363 #: apt-ftparchive.1.xml:1
6365 "Sets the path prefix that causes a symlink to be considered an internal link "
6366 "instead of an external link. Defaults to "
6367 "<filename>$(DIST)/$(SECTION)/</filename>"
6370 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6371 #: apt-ftparchive.1.xml:1
6373 "Sets the output Contents file. Defaults to "
6374 "<filename>$(DIST)/$(SECTION)/Contents-$(ARCH)</filename>. If this setting "
6375 "causes multiple Packages files to map onto a single Contents file (as is the "
6376 "default) then <command>apt-ftparchive</command> will integrate those "
6377 "package files together automatically."
6380 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6381 #: apt-ftparchive.1.xml:1
6382 msgid "Sets header file to prepend to the contents output."
6385 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6386 #: apt-ftparchive.1.xml:1
6388 "Sets the binary cache database to use for this section. Multiple sections "
6389 "can share the same database."
6392 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6393 #: apt-ftparchive.1.xml:1
6395 "Specifies that instead of walking the directory tree, "
6396 "<command>apt-ftparchive</command> should read the list of files from the "
6397 "given file. Relative files names are prefixed with the archive directory."
6400 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6401 #: apt-ftparchive.1.xml:1
6403 "Specifies that instead of walking the directory tree, "
6404 "<command>apt-ftparchive</command> should read the list of files from the "
6405 "given file. Relative files names are prefixed with the archive directory. "
6406 "This is used when processing source indexes."
6409 #. type: Content of: <refentry><refsect1><refsect2><title>
6410 #: apt-ftparchive.1.xml:1
6411 msgid "<literal>Tree</literal> Section"
6414 #. type: Content of: <refentry><refsect1><refsect2><para>
6415 #: apt-ftparchive.1.xml:1
6417 "The <literal>Tree</literal> section defines a standard Debian file tree "
6418 "which consists of a base directory, then multiple sections in that base "
6419 "directory and finally multiple Architectures in each section. The exact "
6420 "pathing used is defined by the <literal>Directory</literal> substitution "
6424 #. type: Content of: <refentry><refsect1><refsect2><para>
6425 #: apt-ftparchive.1.xml:1
6427 "The <literal>Tree</literal> section takes a scope tag which sets the "
6428 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
6429 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
6430 "setting such as <filename>dists/&debian-stable-codename;</filename>."
6433 #. type: Content of: <refentry><refsect1><refsect2><para>
6434 #: apt-ftparchive.1.xml:1
6436 "All of the settings defined in the <literal>TreeDefault</literal> section "
6437 "can be used in a <literal>Tree</literal> section as well as three new "
6441 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6442 #: apt-ftparchive.1.xml:1
6445 "for i in Sections do \n"
6446 " for j in Architectures do\n"
6447 " Generate for DIST=scope SECTION=i ARCH=j\n"
6451 #. type: Content of: <refentry><refsect1><refsect2><para>
6452 #: apt-ftparchive.1.xml:1
6454 "When processing a <literal>Tree</literal> section "
6455 "<command>apt-ftparchive</command> performs an operation similar to: "
6456 "<placeholder type=\"programlisting\" id=\"0\"/>"
6459 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6460 #: apt-ftparchive.1.xml:1
6462 "This is a space separated list of sections which appear under the "
6463 "distribution; typically this is something like <literal>main contrib "
6464 "non-free</literal>"
6467 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6468 #: apt-ftparchive.1.xml:1
6470 "This is a space separated list of all the architectures that appear under "
6471 "search section. The special architecture 'source' is used to indicate that "
6472 "this tree has a source archive. The architecture 'all' signals that "
6473 "architecture specific files like <filename>Packages</filename> should not "
6474 "include information about architecture <literal>all</literal> packages in "
6475 "all files as they will be available in a dedicated file."
6478 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6479 #: apt-ftparchive.1.xml:1
6481 "Sets the binary override file. The override file contains section, priority "
6482 "and maintainer address information."
6485 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6486 #: apt-ftparchive.1.xml:1
6488 "Sets the source override file. The override file contains section "
6492 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6493 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6494 msgid "Sets the binary extra override file."
6497 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6498 #: apt-ftparchive.1.xml:1 apt-ftparchive.1.xml:1
6499 msgid "Sets the source extra override file."
6502 #. type: Content of: <refentry><refsect1><refsect2><title>
6503 #: apt-ftparchive.1.xml:1
6504 msgid "<literal>BinDirectory</literal> Section"
6507 #. type: Content of: <refentry><refsect1><refsect2><para>
6508 #: apt-ftparchive.1.xml:1
6510 "The <literal>bindirectory</literal> section defines a binary directory tree "
6511 "with no special structure. The scope tag specifies the location of the "
6512 "binary directory and the settings are similar to the <literal>Tree</literal> "
6513 "section with no substitution variables or "
6514 "<literal>Section</literal><literal>Architecture</literal> settings."
6517 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6518 #: apt-ftparchive.1.xml:1
6519 msgid "Sets the Packages file output."
6522 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6523 #: apt-ftparchive.1.xml:1
6525 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
6526 "<literal>Sources</literal> is required."
6529 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6530 #: apt-ftparchive.1.xml:1
6531 msgid "Sets the Contents file output (optional)."
6534 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6535 #: apt-ftparchive.1.xml:1
6536 msgid "Sets the binary override file."
6539 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6540 #: apt-ftparchive.1.xml:1
6541 msgid "Sets the source override file."
6544 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6545 #: apt-ftparchive.1.xml:1
6546 msgid "Sets the cache DB."
6549 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6550 #: apt-ftparchive.1.xml:1
6551 msgid "Appends a path to all the output paths."
6554 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
6555 #: apt-ftparchive.1.xml:1
6556 msgid "Specifies the file list file."
6559 #. type: Content of: <refentry><refsect1><title>
6560 #: apt-ftparchive.1.xml:1
6561 msgid "The Binary Override File"
6564 #. type: Content of: <refentry><refsect1><para>
6565 #: apt-ftparchive.1.xml:1
6567 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
6568 "contains four fields separated by spaces. The first field is the package "
6569 "name, the second is the priority to force that package to, the third is the "
6570 "section to force that package to and the final field is the maintainer "
6571 "permutation field."
6574 #. type: Content of: <refentry><refsect1><para><literallayout>
6575 #: apt-ftparchive.1.xml:1
6577 msgid "old [// oldn]* => new"
6580 #. type: Content of: <refentry><refsect1><para><literallayout>
6581 #: apt-ftparchive.1.xml:1
6586 #. type: Content of: <refentry><refsect1><para>
6587 #: apt-ftparchive.1.xml:1
6589 "The general form of the maintainer field is: <placeholder "
6590 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
6591 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
6592 "separated list of old email addresses to be specified. If any of those are "
6593 "found then new is substituted for the maintainer field. The second form "
6594 "unconditionally substitutes the maintainer field."
6597 #. type: Content of: <refentry><refsect1><title>
6598 #: apt-ftparchive.1.xml:1
6599 msgid "The Source Override File"
6602 #. type: Content of: <refentry><refsect1><para>
6603 #: apt-ftparchive.1.xml:1
6605 "The source override file is fully compatible with &dpkg-scansources;. It "
6606 "contains two fields separated by spaces. The first field is the source "
6607 "package name, the second is the section to assign it."
6610 #. type: Content of: <refentry><refsect1><title>
6611 #: apt-ftparchive.1.xml:1
6612 msgid "The Extra Override File"
6615 #. type: Content of: <refentry><refsect1><para>
6616 #: apt-ftparchive.1.xml:1
6618 "The extra override file allows any arbitrary tag to be added or replaced in "
6619 "the output. It has three columns, the first is the package, the second is "
6620 "the tag and the remainder of the line is the new value."
6623 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6624 #: apt-ftparchive.1.xml:1
6626 "Generate the given checksum. These options default to on, when turned off "
6627 "the generated index files will not have the checksum fields where possible. "
6628 "Configuration Items: "
6629 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
6630 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
6631 "where <literal><replaceable>Index</replaceable></literal> can be "
6632 "<literal>Packages</literal>, <literal>Sources</literal> or "
6633 "<literal>Release</literal> and "
6634 "<literal><replaceable>Checksum</replaceable></literal> can be "
6635 "<literal>MD5</literal>, <literal>SHA1</literal>, <literal>SHA256</literal> "
6636 "or <literal>SHA512</literal>."
6639 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6640 #: apt-ftparchive.1.xml:1
6642 "Use a binary caching DB. This has no effect on the generate command. "
6643 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
6646 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6647 #: apt-ftparchive.1.xml:1
6649 "Quiet; produces output suitable for logging, omitting progress indicators. "
6650 "More q's will produce more quiet up to a maximum of 2. You can also use "
6651 "<option>-q=#</option> to set the quiet level, overriding the configuration "
6652 "file. Configuration Item: <literal>quiet</literal>."
6655 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6656 #: apt-ftparchive.1.xml:1
6658 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
6659 "then this option actually enables delinking of the files. It defaults to on "
6660 "and can be turned off with <option>--no-delink</option>. Configuration "
6661 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
6664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6665 #: apt-ftparchive.1.xml:1
6667 "Perform contents generation. When this option is set and package indexes are "
6668 "being generated with a cache DB then the file listing will also be extracted "
6669 "and stored in the DB for later use. When using the generate command this "
6670 "option also allows the creation of any Contents files. The default is on. "
6671 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
6674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6675 #: apt-ftparchive.1.xml:1
6677 "Select the source override file to use with the <literal>sources</literal> "
6678 "command. Configuration Item: "
6679 "<literal>APT::FTPArchive::SourceOverride</literal>."
6682 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6683 #: apt-ftparchive.1.xml:1
6685 "Make the caching databases read only. Configuration Item: "
6686 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
6689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6690 #: apt-ftparchive.1.xml:1
6692 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
6693 "commands only package files matching <literal>*_arch.deb</literal> or "
6694 "<literal>*_all.deb</literal> instead of all package files in the given "
6695 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
6698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6699 #: apt-ftparchive.1.xml:1
6701 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
6702 "packages are recompiled and/or republished with the same version again, this "
6703 "will lead to problems as the now outdated cached metadata like size and "
6704 "checksums will be used. With this option enabled this will no longer happen "
6705 "as it will be checked if the file was changed. Note that this option is set "
6706 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
6707 "multiply versions/builds of a package with the same versionnumber, so in "
6708 "theory nobody will have these problems and therefore all these extra checks "
6712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
6713 #: apt-ftparchive.1.xml:1
6715 "This configuration option defaults to \"<literal>true</literal>\" and should "
6716 "only be set to <literal>\"false\"</literal> if the Archive generated with "
6717 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
6718 "that the <filename>Translation-en</filename> master file can only be created "
6719 "in the generate command."
6722 #. type: Content of: <refentry><refsect1><para><programlisting>
6723 #: apt-ftparchive.1.xml:1
6726 "<command>apt-ftparchive</command> packages "
6727 "<replaceable>directory</replaceable> | <command>gzip</command> > "
6728 "<filename>Packages.gz</filename>\n"
6731 #. type: Content of: <refentry><refsect1><para>
6732 #: apt-ftparchive.1.xml:1
6734 "To create a compressed Packages file for a directory containing binary "
6735 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
6738 #. type: Content of: <refentry><refsect1><para>
6739 #: apt-ftparchive.1.xml:1
6741 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
6745 #. type: Attribute 'lang' of: <book>
6746 #: guide.dbk:1 offline.dbk:1
6750 #. type: Content of: <book><title>
6752 msgid "APT User's Guide"
6755 #. type: Content of: <book><bookinfo><authorgroup><author><personname>
6756 #: guide.dbk:1 offline.dbk:1
6757 msgid "Jason Gunthorpe"
6760 #. type: Content of: <book><bookinfo><authorgroup><author><email>
6761 #: guide.dbk:1 offline.dbk:1
6762 msgid "jgg@debian.org"
6765 #. type: Content of: <book><bookinfo><releaseinfo>
6766 #: guide.dbk:1 offline.dbk:1
6767 msgid "Version &apt-product-version;"
6770 #. type: Content of: <book><bookinfo><abstract><para>
6773 "This document provides an overview of how to use the the APT package "
6777 #. type: Content of: <book><bookinfo>
6779 msgid "<copyright><year>1998</year><holder>Jason Gunthorpe</holder></copyright>"
6782 #. type: Content of: <book><bookinfo><legalnotice><title>
6783 #: guide.dbk:1 offline.dbk:1
6784 msgid "License Notice"
6787 #. type: Content of: <book><bookinfo><legalnotice><para>
6788 #: guide.dbk:1 offline.dbk:1
6790 "\"APT\" and this document are free software; you can redistribute them "
6791 "and/or modify them under the terms of the GNU General Public License as "
6792 "published by the Free Software Foundation; either version 2 of the License, "
6793 "or (at your option) any later version."
6796 #. type: Content of: <book><bookinfo><legalnotice><para>
6797 #: guide.dbk:1 offline.dbk:1
6799 "For more details, on Debian systems, see the file "
6800 "/usr/share/common-licenses/GPL for the full license."
6803 #. type: Content of: <book><chapter><title>
6808 #. type: Content of: <book><chapter><para>
6811 "The APT package currently contains two sections, the APT "
6812 "<command>dselect</command> method and the <command>apt-get</command> command "
6813 "line user interface. Both provide a way to install and remove packages as "
6814 "well as download new packages from the Internet."
6817 #. type: Content of: <book><chapter><section><title>
6819 msgid "Anatomy of the Package System"
6822 #. type: Content of: <book><chapter><section><para>
6825 "The Debian packaging system has a large amount of information associated "
6826 "with each package to help assure that it integrates cleanly and easily into "
6827 "the system. The most prominent of its features is the dependency system."
6830 #. type: Content of: <book><chapter><section><para>
6833 "The dependency system allows individual programs to make use of shared "
6834 "elements in the system such as libraries. It simplifies placing infrequently "
6835 "used portions of a program in separate packages to reduce the number of "
6836 "things the average user is required to install. Also, it allows for choices "
6837 "in mail transport agents, X servers and so on."
6840 #. type: Content of: <book><chapter><section><para>
6843 "The first step to understanding the dependency system is to grasp the "
6844 "concept of a simple dependency. The meaning of a simple dependency is that a "
6845 "package requires another package to be installed at the same time to work "
6849 #. type: Content of: <book><chapter><section><para>
6852 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6853 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6854 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6855 "simple dependency on emacs, without emacs it is completely useless."
6858 #. type: Content of: <book><chapter><section><para>
6861 "The other important dependency to understand is a conflicting dependency. It "
6862 "means that a package, when installed with another package, will not work and "
6863 "may possibly be extremely harmful to the system. As an example consider a "
6864 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6865 "have two mail transport agents installed because both need to listen to the "
6866 "network to receive mail. Attempting to install two will seriously damage the "
6867 "system so all mail transport agents have a conflicting dependency with all "
6868 "other mail transport agents."
6871 #. type: Content of: <book><chapter><section><para>
6874 "As an added complication there is the possibility for a package to pretend "
6875 "to be another package. Consider that exim and sendmail for many intents are "
6876 "identical, they both deliver mail and understand a common interface. Hence, "
6877 "the package system has a way for them to declare that they are both "
6878 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6879 "a mail-transport-agent and other packages that need a mail transport agent "
6880 "depend on mail-transport-agent. This can add a great deal of confusion when "
6881 "trying to manually fix packages."
6884 #. type: Content of: <book><chapter><section><para>
6887 "At any given time a single dependency may be met by packages that are "
6888 "already installed or it may not be. APT attempts to help resolve dependency "
6889 "issues by providing a number of automatic algorithms that help in selecting "
6890 "packages for installation."
6893 #. type: Content of: <book><chapter><title>
6898 #. type: Content of: <book><chapter><para>
6901 "<command>apt-get</command> provides a simple way to install packages from "
6902 "the command line. Unlike <command>dpkg</command>, <command>apt-get</command> "
6903 "does not understand .deb files, it works with the package's proper name and "
6904 "can only install .deb archives from a <emphasis>Source</emphasis>."
6907 #. type: Content of: <book><chapter><para><footnote><para>
6910 "If you are using an http proxy server you must set the http_proxy "
6911 "environment variable first, see sources.list(5)"
6914 #. type: Content of: <book><chapter><para>
6917 "The first <placeholder type=\"footnote\" id=\"0\"/> thing that should be "
6918 "done before using <command>apt-get</command> is to fetch the package lists "
6919 "from the <emphasis>Sources</emphasis> so that it knows what packages are "
6920 "available. This is done with <literal>apt-get update</literal>. For "
6924 #. type: Content of: <book><chapter><screen>
6928 "# apt-get update\n"
6929 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6930 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6931 "Reading Package Lists... Done\n"
6932 "Building Dependency Tree... Done\n"
6935 #. type: Content of: <book><chapter><para>
6937 msgid "Once updated there are several commands that can be used:"
6940 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6945 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6948 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6949 "install a new package or remove an existing package, nor will it ever "
6950 "upgrade a package that might cause some other package to break. This can be "
6951 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6952 "the packages that it could not upgrade, this usually means that they depend "
6953 "on new packages or conflict with some other "
6954 "package. <command>dselect</command> or <literal>apt-get install</literal> "
6955 "can be used to force these packages to install."
6958 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6963 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6966 "Install is used to install packages by name. The package is automatically "
6967 "fetched and installed. This can be useful if you already know the name of "
6968 "the package to install and do not want to go into a GUI to select it. Any "
6969 "number of packages may be passed to install, they will all be "
6970 "fetched. Install automatically attempts to resolve dependency problems with "
6971 "the listed packages and will print a summary and ask for confirmation if "
6972 "anything other than its arguments are changed."
6975 #. type: Content of: <book><chapter><variablelist><varlistentry><term>
6977 msgid "dist-upgrade"
6980 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6983 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6984 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6985 "set of packages to install, upgrade and remove to get as much of the system "
6986 "to the newest release. In some situations it may be desired to use "
6987 "dist-upgrade rather than spend the time manually resolving dependencies in "
6988 "<command>dselect</command>. Once dist-upgrade has completed then "
6989 "<command>dselect</command> can be used to install any packages that may have "
6993 #. type: Content of: <book><chapter><variablelist><varlistentry><listitem><para>
6996 "It is important to closely look at what dist-upgrade is going to do, its "
6997 "decisions may sometimes be quite surprising."
7000 #. type: Content of: <book><chapter><para>
7003 "<command>apt-get</command> has several command line options that are "
7004 "detailed in its man page, "
7005 "<citerefentry><refentrytitle>apt-get</refentrytitle><manvolnum>8</manvolnum></citerefentry>. "
7006 "The most useful option is <literal>-d</literal> which does not install the "
7007 "fetched files. If the system has to download a large number of package it "
7008 "would be undesired to start installing them in case something goes "
7009 "wrong. When <literal>-d</literal> is used the downloaded archives can be "
7010 "installed by simply running the command that caused them to be downloaded "
7011 "again without <literal>-d</literal>."
7014 #. type: Content of: <book><chapter><title>
7019 #. type: Content of: <book><chapter><para>
7022 "The APT <command>dselect</command> method provides the complete APT system "
7023 "with the <command>dselect</command> package selection "
7024 "GUI. <command>dselect</command> is used to select the packages to be "
7025 "installed or removed and APT actually installs them."
7028 #. type: Content of: <book><chapter><para>
7031 "To enable the APT method you need to select [A]ccess in "
7032 "<command>dselect</command> and then choose the APT method. You will be "
7033 "prompted for a set of <emphasis>Sources</emphasis> which are places to fetch "
7034 "archives from. These can be remote Internet sites, local Debian mirrors or "
7035 "CD-ROMs. Each source can provide a fragment of the total Debian archive, APT "
7036 "will automatically combine them to form a complete set of packages. If you "
7037 "have a CD-ROM then it is a good idea to specify it first and then specify a "
7038 "mirror so that you have access to the latest bug fixes. APT will "
7039 "automatically use packages on your CD-ROM before downloading from the "
7043 #. type: Content of: <book><chapter><screen>
7047 " Set up a list of distribution source locations\n"
7049 " Please give the base URL of the debian distribution.\n"
7050 " The access schemes I know about are: http file\n"
7053 " file:/mnt/debian,\n"
7054 " ftp://ftp.debian.org/debian,\n"
7055 " http://ftp.de.debian.org/debian,\n"
7058 " URL [http://llug.sep.bnl.gov/debian]:\n"
7061 #. type: Content of: <book><chapter><para>
7064 "The <emphasis>Sources</emphasis> setup starts by asking for the base of the "
7065 "Debian archive, defaulting to a HTTP mirror. Next it asks for the "
7066 "distribution to get."
7069 #. type: Content of: <book><chapter><screen>
7073 " Please give the distribution tag to get or a path to the\n"
7074 " package file ending in a /. The distribution\n"
7075 " tags are typically something like: stable unstable testing non-US\n"
7077 " Distribution [stable]:\n"
7080 #. type: Content of: <book><chapter><para>
7083 "The distribution refers to the Debian version in the archive, "
7084 "<emphasis>stable</emphasis> refers to the latest released version and "
7085 "<emphasis>unstable</emphasis> refers to the developmental "
7086 "version. <emphasis>non-US</emphasis> is only available on some mirrors and "
7087 "refers to packages that contain encryption technology or other things that "
7088 "cannot be exported from the United States. Importing these packages into the "
7089 "US is legal however."
7092 #. type: Content of: <book><chapter><screen>
7096 " Please give the components to get\n"
7097 " The components are typically something like: main contrib non-free\n"
7099 " Components [main contrib non-free]:\n"
7102 #. type: Content of: <book><chapter><para>
7105 "The components list refers to the list of sub distributions to fetch. The "
7106 "distribution is split up based on software licenses, main being DFSG free "
7107 "packages while contrib and non-free contain things that have various "
7108 "restrictions placed on their use and distribution."
7111 #. type: Content of: <book><chapter><para>
7114 "Any number of sources can be added, the setup script will continue to prompt "
7115 "until you have specified all that you want."
7118 #. type: Content of: <book><chapter><para>
7121 "Before starting to use <command>dselect</command> it is necessary to update "
7122 "the available list by selecting [U]pdate from the menu. This is a superset "
7123 "of <literal>apt-get update</literal> that makes the fetched information "
7124 "available to <command>dselect</command>. [U]pdate must be performed even if "
7125 "<literal>apt-get update</literal> has been run before."
7128 #. type: Content of: <book><chapter><para>
7131 "You can then go on and make your selections using [S]elect and then perform "
7132 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7133 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7137 #. type: Content of: <book><chapter><para>
7140 "By default APT will automatically remove the package (.deb) files once they "
7141 "have been successfully installed. To change this behavior place "
7142 "<literal>Dselect::clean \"prompt\";</literal> in /etc/apt/apt.conf."
7145 #. type: Content of: <book><chapter><title>
7147 msgid "The Interface"
7150 #. type: Content of: <book><chapter><para><footnote><para>
7153 "The <command>dselect</command> method actually is a set of wrapper scripts "
7154 "to <command>apt-get</command>. The method actually provides more "
7155 "functionality than is present in <command>apt-get</command> alone."
7158 #. type: Content of: <book><chapter><para>
7161 "Both that APT <command>dselect</command> method and "
7162 "<command>apt-get</command> share the same interface. It is a simple system "
7163 "that generally tells you what it will do and then goes and does "
7164 "it. <placeholder type=\"footnote\" id=\"0\"/> After printing out a summary "
7165 "of what will happen APT then will print out some informative status messages "
7166 "so that you can estimate how far along it is and how much is left to do."
7169 #. type: Content of: <book><chapter><section><title>
7174 #. type: Content of: <book><chapter><section><para>
7177 "Before all operations except update, APT performs a number of actions to "
7178 "prepare its internal state. It also does some checks of the system's "
7179 "state. At any time these operations can be performed by running "
7180 "<literal>apt-get check</literal>."
7183 #. type: Content of: <book><chapter><section><screen>
7188 "Reading Package Lists... Done\n"
7189 "Building Dependency Tree... Done\n"
7192 #. type: Content of: <book><chapter><section><para>
7195 "The first thing it does is read all the package files into memory. APT uses "
7196 "a caching scheme so this operation will be faster the second time it is "
7197 "run. If some of the package files are not found then they will be ignored "
7198 "and a warning will be printed when apt-get exits."
7201 #. type: Content of: <book><chapter><section><para>
7204 "The final operation performs a detailed analysis of the system's "
7205 "dependencies. It checks every dependency of every installed or unpacked "
7206 "package and considers if it is OK. Should this find a problem then a report "
7207 "will be printed out and <command>apt-get</command> will refuse to run."
7210 #. type: Content of: <book><chapter><section><screen>
7215 "Reading Package Lists... Done\n"
7216 "Building Dependency Tree... Done\n"
7217 "You might want to run apt-get -f install' to correct these.\n"
7218 "Sorry, but the following packages have unmet dependencies:\n"
7219 " 9fonts: Depends: xlib6g but it is not installed\n"
7220 " uucp: Depends: mailx but it is not installed\n"
7221 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7222 " adduser: Depends: perl-base but it is not installed\n"
7223 " aumix: Depends: libgpmg1 but it is not installed\n"
7224 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7225 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7226 " cthugha: Depends: svgalibg1 but it is not installed\n"
7227 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7228 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)\n"
7231 #. type: Content of: <book><chapter><section><para>
7234 "In this example the system has many problems, including a serious problem "
7235 "with libreadlineg2. For each package that has unmet dependencies a line is "
7236 "printed out indicating the package with the problem and the dependencies "
7237 "that are unmet. A short explanation of why the package has a dependency "
7238 "problem is also included."
7241 #. type: Content of: <book><chapter><section><para><footnote><para>
7244 "APT however considers all known dependencies and attempts to prevent broken "
7248 #. type: Content of: <book><chapter><section><para>
7251 "There are two ways a system can get into a broken state like this. The first "
7252 "is caused by <command>dpkg</command> missing some subtle relationships "
7253 "between packages when performing upgrades. <placeholder type=\"footnote\" "
7254 "id=\"0\"/>. The second is if a package installation fails during an "
7255 "operation. In this situation a package may have been unpacked without its "
7256 "dependents being installed."
7259 #. type: Content of: <book><chapter><section><para>
7262 "The second situation is much less serious than the first because APT places "
7263 "certain constraints on the order that packages are installed. In both cases "
7264 "supplying the <literal>-f</literal> option to <command>apt-get</command> "
7265 "will cause APT to deduce a possible solution to the problem and then "
7266 "continue on. The APT <command>dselect</command> method always supplies the "
7267 "<literal>-f</literal> option to allow for easy continuation of failed "
7268 "maintainer scripts."
7271 #. type: Content of: <book><chapter><section><para>
7274 "However, if the <literal>-f</literal> option is used to correct a seriously "
7275 "broken system caused by the first case then it is possible that it will "
7276 "either fail immediately or the installation sequence will fail. In either "
7277 "case it is necessary to manually use dpkg (possibly with forcing options) to "
7278 "correct the situation enough to allow APT to proceed."
7281 #. type: Content of: <book><chapter><section><title>
7283 msgid "The Status Report"
7286 #. type: Content of: <book><chapter><section><para>
7289 "Before proceeding <command>apt-get</command> will present a report on what "
7290 "will happen. Generally the report reflects the type of operation being "
7291 "performed but there are several common elements. In all cases the lists "
7292 "reflect the final state of things, taking into account the "
7293 "<literal>-f</literal> option and any other relevant activities to the "
7294 "command being executed."
7297 #. type: Content of: <book><chapter><section><section><title>
7299 msgid "The Extra Package list"
7302 #. type: Content of: <book><chapter><section><section><screen>
7306 "The following extra packages will be installed:\n"
7307 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7308 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7309 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7310 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7314 #. type: Content of: <book><chapter><section><section><para>
7317 "The Extra Package list shows all of the packages that will be installed or "
7318 "upgraded in excess of the ones mentioned on the command line. It is only "
7319 "generated for an <literal>install</literal> command. The listed packages are "
7320 "often the result of an Auto Install."
7323 #. type: Content of: <book><chapter><section><section><title>
7325 msgid "The Packages to Remove"
7328 #. type: Content of: <book><chapter><section><section><screen>
7332 "The following packages will be REMOVED:\n"
7333 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7334 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7335 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7336 " nas xpilot xfig\n"
7339 #. type: Content of: <book><chapter><section><section><para>
7342 "The Packages to Remove list shows all of the packages that will be removed "
7343 "from the system. It can be shown for any of the operations and should be "
7344 "given a careful inspection to ensure nothing important is to be taken "
7345 "off. The <literal>-f</literal> option is especially good at generating "
7346 "packages to remove so extreme care should be used in that case. The list may "
7347 "contain packages that are going to be removed because they are only "
7348 "partially installed, possibly due to an aborted installation."
7351 #. type: Content of: <book><chapter><section><section><title>
7353 msgid "The New Packages list"
7356 #. type: Content of: <book><chapter><section><section><screen>
7360 "The following NEW packages will installed:\n"
7361 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base\n"
7364 #. type: Content of: <book><chapter><section><section><para>
7367 "The New Packages list is simply a reminder of what will happen. The packages "
7368 "listed are not presently installed in the system but will be when APT is "
7372 #. type: Content of: <book><chapter><section><section><title>
7374 msgid "The Kept Back list"
7377 #. type: Content of: <book><chapter><section><section><screen>
7381 "The following packages have been kept back\n"
7382 " compface man-db tetex-base msql libpaper svgalib1\n"
7383 " gs snmp arena lynx xpat2 groff xscreensaver\n"
7386 #. type: Content of: <book><chapter><section><section><para>
7389 "Whenever the whole system is being upgraded there is the possibility that "
7390 "new versions of packages cannot be installed because they require new things "
7391 "or conflict with already installed things. In this case the package will "
7392 "appear in the Kept Back list. The best way to convince packages listed there "
7393 "to install is with <literal>apt-get install</literal> or by using "
7394 "<command>dselect</command> to resolve their problems."
7397 #. type: Content of: <book><chapter><section><section><title>
7399 msgid "Held Packages warning"
7402 #. type: Content of: <book><chapter><section><section><screen>
7406 "The following held packages will be changed:\n"
7410 #. type: Content of: <book><chapter><section><section><para>
7413 "Sometimes you can ask APT to install a package that is on hold, in such a "
7414 "case it prints out a warning that the held package is going to be "
7415 "changed. This should only happen during dist-upgrade or install."
7418 #. type: Content of: <book><chapter><section><section><title>
7420 msgid "Final summary"
7423 #. type: Content of: <book><chapter><section><section><para>
7425 msgid "Finally, APT will print out a summary of all the changes that will occur."
7428 #. type: Content of: <book><chapter><section><section><screen>
7432 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7434 "12 packages not fully installed or removed.\n"
7435 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used.\n"
7438 #. type: Content of: <book><chapter><section><section><para>
7441 "The first line of the summary simply is a reduced version of all of the "
7442 "lists and includes the number of upgrades - that is packages already "
7443 "installed that have new versions available. The second line indicates the "
7444 "number of poorly configured packages, possibly the result of an aborted "
7445 "installation. The final line shows the space requirements that the "
7446 "installation needs. The first pair of numbers refer to the size of the "
7447 "archive files. The first number indicates the number of bytes that must be "
7448 "fetched from remote locations and the second indicates the total size of all "
7449 "the archives required. The next number indicates the size difference between "
7450 "the presently installed packages and the newly installed packages. It is "
7451 "roughly equivalent to the space required in /usr after everything is "
7452 "done. If a large number of packages are being removed then the value may "
7453 "indicate the amount of space that will be freed."
7456 #. type: Content of: <book><chapter><section><section><para>
7459 "Some other reports can be generated by using the -u option to show packages "
7460 "to upgrade, they are similar to the previous examples."
7463 #. type: Content of: <book><chapter><section><title>
7465 msgid "The Status Display"
7468 #. type: Content of: <book><chapter><section><para>
7471 "During the download of archives and package files APT prints out a series of "
7475 #. type: Content of: <book><chapter><section><screen>
7479 "# apt-get update\n"
7480 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7481 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7482 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7483 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7485 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7486 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s\n"
7489 #. type: Content of: <book><chapter><section><para>
7492 "The lines starting with <emphasis>Get</emphasis> are printed out when APT "
7493 "begins to fetch a file while the last line indicates the progress of the "
7494 "download. The first percent value on the progress line indicates the total "
7495 "percent done of all files. Unfortunately since the size of the Package files "
7496 "is unknown <literal>apt-get update</literal> estimates the percent done "
7497 "which causes some inaccuracies."
7500 #. type: Content of: <book><chapter><section><para>
7503 "The next section of the status line is repeated once for each download "
7504 "thread and indicates the operation being performed and some useful "
7505 "information about what is happening. Sometimes this section will simply read "
7506 "<emphasis>Forking</emphasis> which means the OS is loading the download "
7507 "module. The first word after the [ is the fetch number as shown on the "
7508 "history lines. The next word is the short form name of the object being "
7509 "downloaded. For archives it will contain the name of the package that is "
7513 #. type: Content of: <book><chapter><section><para>
7516 "Inside of the single quote is an informative string indicating the progress "
7517 "of the negotiation phase of the download. Typically it progresses from "
7518 "<emphasis>Connecting</emphasis> to <emphasis>Waiting for file</emphasis> to "
7519 "<emphasis>Downloading</emphasis> or <emphasis>Resuming</emphasis>. The final "
7520 "value is the number of bytes downloaded from the remote site. Once the "
7521 "download begins this is represented as <literal>102/10.2k</literal> "
7522 "indicating that 102 bytes have been fetched and 10.2 kilobytes is "
7523 "expected. The total size is always shown in 4 figure notation to preserve "
7524 "space. After the size display is a percent meter for the file itself. The "
7525 "second last element is the instantaneous average speed. This values is "
7526 "updated every 5 seconds and reflects the rate of data transfer for that "
7527 "period. Finally is shown the estimated transfer time. This is updated "
7528 "regularly and reflects the time to complete everything at the shown transfer "
7532 #. type: Content of: <book><chapter><section><para>
7535 "The status display updates every half second to provide a constant feedback "
7536 "on the download progress while the Get lines scroll back whenever a new file "
7537 "is started. Since the status display is constantly updated it is unsuitable "
7538 "for logging to a file, use the <literal>-q</literal> option to remove the "
7542 #. type: Content of: <book><chapter><section><title>
7547 #. type: Content of: <book><chapter><section><para>
7550 "APT uses <command>dpkg</command> for installing the archives and will switch "
7551 "over to the <command>dpkg</command> interface once downloading is "
7552 "completed. <command>dpkg</command> will also ask a number of questions as it "
7553 "processes the packages and the packages themselves may also ask several "
7554 "questions. Before each question there is usually a description of what it is "
7555 "asking and the questions are too varied to discuss completely here."
7558 #. type: Content of: <book><title>
7560 msgid "Using APT Offline"
7563 #. type: Content of: <book><bookinfo><abstract><para>
7566 "This document describes how to use APT in a non-networked environment, "
7567 "specifically a 'sneaker-net' approach for performing upgrades."
7570 #. type: Content of: <book><bookinfo>
7572 msgid "<copyright><year>1999</year><holder>Jason Gunthorpe</holder></copyright>"
7575 #. type: Content of: <book><chapter><title>
7577 msgid "Introduction"
7580 #. type: Content of: <book><chapter><section><title>
7581 #: offline.dbk:1 offline.dbk:1 offline.dbk:1
7585 #. type: Content of: <book><chapter><section><para>
7588 "Normally APT requires direct access to a Debian archive, either from a local "
7589 "media or through a network. Another common complaint is that a Debian "
7590 "machine is on a slow link, such as a modem and another machine has a very "
7591 "fast connection but they are physically distant."
7594 #. type: Content of: <book><chapter><section><para>
7597 "The solution to this is to use large removable media such as a Zip disc or a "
7598 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7599 "archive but can easily fit a subset large enough for most users. The idea is "
7600 "to use APT to generate a list of packages that are required and then fetch "
7601 "them onto the disc using another machine with good connectivity. It is even "
7602 "possible to use another Debian machine with APT or to use a completely "
7603 "different OS and a download tool like wget. Let <emphasis>remote "
7604 "host</emphasis> mean the machine downloading the packages, and "
7605 "<emphasis>target host</emphasis> the one with bad or no connection."
7608 #. type: Content of: <book><chapter><section><para>
7611 "This is achieved by creatively manipulating the APT configuration file. The "
7612 "essential premise to tell APT to look on a disc for it's archive files. Note "
7613 "that the disc should be formatted with a filesystem that can handle long "
7614 "file names such as ext2, fat32 or vfat."
7617 #. type: Content of: <book><chapter><title>
7619 msgid "Using APT on both machines"
7622 #. type: Content of: <book><chapter><section><para>
7625 "APT being available on both machines gives the simplest configuration. The "
7626 "basic idea is to place a copy of the status file on the disc and use the "
7627 "remote machine to fetch the latest package files and decide which packages "
7628 "to download. The disk directory structure should look like:"
7631 #. type: Content of: <book><chapter><section><screen>
7645 #. type: Content of: <book><chapter><section><title>
7647 msgid "The configuration file"
7650 #. type: Content of: <book><chapter><section><para>
7653 "The configuration file should tell APT to store its files on the disc and to "
7654 "use the configuration files on the disc as well. The sources.list should "
7655 "contain the proper sites that you wish to use from the remote machine, and "
7656 "the status file should be a copy of "
7657 "<emphasis>/var/lib/dpkg/status</emphasis> from the <emphasis>target "
7658 "host</emphasis>. Please note, if you are using a local archive you must use "
7659 "copy URIs, the syntax is identical to file URIs."
7662 #. type: Content of: <book><chapter><section><para>
7665 "<emphasis>apt.conf</emphasis> must contain the necessary information to make "
7669 #. type: Content of: <book><chapter><section><screen>
7675 " /* This is not necessary if the two machines are the same arch, it "
7677 " the remote APT what architecture the target machine is */\n"
7678 " Architecture \"i386\";\n"
7680 " Get::Download-Only \"true\";\n"
7685 " /* Use the disc for state information and redirect the status file from\n"
7686 " the /var/lib/dpkg default */\n"
7687 " State \"/disc/\";\n"
7688 " State::status \"status\";\n"
7690 " // Binary caches will be stored locally\n"
7691 " Cache::archives \"/disc/archives/\";\n"
7692 " Cache \"/tmp/\";\n"
7694 " // Location of the source list.\n"
7695 " Etc \"/disc/\";\n"
7699 #. type: Content of: <book><chapter><section><para>
7702 "More details can be seen by examining the apt.conf man page and the sample "
7703 "configuration file in "
7704 "<emphasis>/usr/share/doc/apt/examples/apt.conf</emphasis>."
7707 #. type: Content of: <book><chapter><section><para>
7710 "On the target machine the first thing to do is mount the disc and copy "
7711 "<emphasis>/var/lib/dpkg/status</emphasis> to it. You will also need to "
7712 "create the directories outlined in the Overview, "
7713 "<emphasis>archives/partial/</emphasis> and "
7714 "<emphasis>lists/partial/</emphasis>. Then take the disc to the remote "
7715 "machine and configure the sources.list. On the remote machine execute the "
7719 #. type: Content of: <book><chapter><section><screen>
7723 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7724 " # apt-get update\n"
7725 " [ APT fetches the package files ]\n"
7726 " # apt-get dist-upgrade\n"
7727 " [ APT fetches all the packages needed to upgrade the target machine ]\n"
7730 #. type: Content of: <book><chapter><section><para>
7733 "The dist-upgrade command can be replaced with any other standard APT "
7734 "commands, particularly dselect-upgrade. You can even use an APT front end "
7735 "such as <emphasis>dselect</emphasis>. However this presents a problem in "
7736 "communicating your selections back to the local computer."
7739 #. type: Content of: <book><chapter><section><para>
7742 "Now the disc contains all of the index files and archives needed to upgrade "
7743 "the target machine. Take the disc back and run:"
7746 #. type: Content of: <book><chapter><section><screen>
7750 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7751 " # apt-get check\n"
7752 " [ APT generates a local copy of the cache files ]\n"
7753 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
7754 " [ Or any other APT command ]\n"
7757 #. type: Content of: <book><chapter><section><para>
7760 "It is necessary for proper function to re-specify the status file to be the "
7761 "local one. This is very important!"
7764 #. type: Content of: <book><chapter><section><para>
7767 "If you are using dselect you can do the very risky operation of copying "
7768 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7769 "remote machine are updated. I highly recommend that people only make "
7770 "selections on the local machine - but this may not always be possible. DO "
7771 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7774 #. type: Content of: <book><chapter><title>
7776 msgid "Using APT and wget"
7779 #. type: Content of: <book><chapter><section><para>
7782 "<emphasis>wget</emphasis> is a popular and portable download tool that can "
7783 "run on nearly any machine. Unlike the method above this requires that the "
7784 "Debian machine already has a list of available packages."
7787 #. type: Content of: <book><chapter><section><para>
7790 "The basic idea is to create a disc that has only the archive files "
7791 "downloaded from the remote site. This is done by using the --print-uris "
7792 "option to apt-get and then preparing a wget script to actually fetch the "
7796 #. type: Content of: <book><chapter><section><title>
7801 #. type: Content of: <book><chapter><section><para>
7804 "Unlike the previous technique no special configuration files are "
7805 "required. We merely use the standard APT commands to generate the file list."
7808 #. type: Content of: <book><chapter><section><screen>
7812 " # apt-get dist-upgrade\n"
7813 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7814 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7815 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script\n"
7818 #. type: Content of: <book><chapter><section><para>
7821 "Any command other than dist-upgrade could be used here, including "
7825 #. type: Content of: <book><chapter><section><para>
7828 "The /disc/wget-script file will now contain a list of wget commands to "
7829 "execute in order to fetch the necessary archives. This script should be run "
7830 "with the current directory as the disc's mount point so as to save the "
7831 "output on the disc."
7834 #. type: Content of: <book><chapter><section><para>
7836 msgid "The remote machine would do something like"
7839 #. type: Content of: <book><chapter><section><screen>
7844 " # sh -x ./wget-script\n"
7848 #. type: Content of: <book><chapter><section><para>
7851 "Once the archives are downloaded and the disc returned to the Debian machine "
7852 "installation can proceed using,"
7855 #. type: Content of: <book><chapter><section><screen>
7858 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade\n"
7861 #. type: Content of: <book><chapter><section><para>
7863 msgid "Which will use the already fetched archives on the disc."