1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the apt package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: apt 0.9.5\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2012-05-22 16:30+0300\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
35 msgid "Debian GNU/Linux"
46 msgid "apt - Advanced Package Tool"
69 "APT is a management system for software packages. For normal day to day "
70 "package management there are several frontends available, such as "
71 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
72 "System. Some options are only implemented in B<apt-get>(8) though."
84 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
85 "B<apt_preferences>(5), B<apt-secure>(8)"
96 msgid "apt returns zero on normal operation, decimal 100 on error."
107 msgid "This manpage isn't even started."
113 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
114 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
115 "B<reportbug>(1) command."
126 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
133 "<!ENTITY apt-author.team \"\n"
135 " <othername>APT team</othername>\n"
136 " <contrib></contrib>\n"
145 "<!ENTITY apt-qapage \"\n"
147 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
156 "<!-- Boiler plate Bug reporting section -->\n"
157 "<!ENTITY manbugs \"\n"
158 " <refsect1><title>Bugs</title>\n"
159 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
160 " If you wish to report a bug in APT, please see\n"
161 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
162 " &reportbug; command.\n"
172 "<!-- Boiler plate Author section -->\n"
173 "<!ENTITY manauthor \"\n"
174 " <refsect1><title>Author</title>\n"
175 " <para>APT was written by the APT team "
176 "<email>apt@packages.debian.org</email>.\n"
186 "<!-- Should be used within the option section of the text to\n"
187 " put in the blurb about -h, -v, -c and -o -->\n"
188 "<!ENTITY apt-commonoptions \"\n"
189 " <varlistentry><term><option>-h</option></term>\n"
190 " <term><option>--help</option></term>\n"
191 " <listitem><para>Show a short usage summary.\n"
202 " <term><option>-v</option></term>\n"
203 " <term><option>--version</option></term>\n"
204 " <listitem><para>Show the program version.\n"
215 " <term><option>-c</option></term>\n"
216 " <term><option>--config-file</option></term>\n"
217 " <listitem><para>Configuration File; Specify a configuration file to "
219 " The program will read the default configuration file and then this \n"
220 " configuration file. If configuration settings need to be set before "
222 " default configuration files are parsed specify a file with the "
223 "<envar>APT_CONFIG</envar>\n"
224 " environment variable. See &apt-conf; for syntax information.\n"
235 " <term><option>-o</option></term>\n"
236 " <term><option>--option</option></term>\n"
237 " <listitem><para>Set a Configuration Option; This will set an "
239 " configuration option. The syntax is <option>-o "
240 "Foo::Bar=bar</option>.\n"
241 " <option>-o</option> and <option>--option</option> can be used "
243 " times to set different options.\n"
254 "<!-- Should be used within the option section of the text to\n"
255 " put in the blurb about -h, -v, -c and -o -->\n"
256 "<!ENTITY apt-cmdblurb \"\n"
257 " <para>All command line options may be set using the configuration file, "
259 " descriptions indicate the configuration option to set. For boolean\n"
260 " options you can override the config file by using something like \n"
261 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
262 " or several other variations.\n"
271 "<!ENTITY file-aptconf \"\n"
272 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
273 " <listitem><para>APT configuration file.\n"
274 " Configuration Item: "
275 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
283 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
284 " <listitem><para>APT configuration file fragments.\n"
285 " Configuration Item: "
286 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
295 "<!ENTITY file-cachearchives \"\n"
296 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
297 " <listitem><para>Storage area for retrieved package files.\n"
298 " Configuration Item: "
299 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
308 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
309 " <listitem><para>Storage area for package files in transit.\n"
310 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
311 "(<filename>partial</filename> will be implicitly "
312 "appended). </para></listitem>\n"
321 "<!ENTITY file-preferences \"\n"
322 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
323 " <listitem><para>Version preferences file.\n"
324 " This is where you would specify "pinning",\n"
325 " i.e. a preference to get certain packages\n"
326 " from a separate source\n"
327 " or from a different version of a distribution.\n"
328 " Configuration Item: "
329 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
338 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
339 " <listitem><para>File fragments for the version preferences.\n"
340 " Configuration Item: "
341 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
350 "<!ENTITY file-sourceslist \"\n"
351 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
352 " <listitem><para>Locations to fetch packages from.\n"
353 " Configuration Item: "
354 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
363 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
364 " <listitem><para>File fragments for locations to fetch packages from.\n"
365 " Configuration Item: "
366 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
375 "<!ENTITY file-statelists \"\n"
376 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
377 " <listitem><para>Storage area for state information for each package "
378 "resource specified in\n"
380 " Configuration Item: "
381 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
390 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
391 " <listitem><para>Storage area for state information in transit.\n"
392 " Configuration Item: <literal>Dir::State::Lists</literal> "
393 "(<filename>partial</filename> will be implicitly "
394 "appended).</para></listitem>\n"
403 "<!ENTITY file-trustedgpg \"\n"
404 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
405 " <listitem><para>Keyring of local trusted keys, new keys will be added "
407 " Configuration Item: "
408 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
417 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
418 " <listitem><para>File fragments for the trusted keys, additional "
420 " be stored here (by other packages or the administrator).\n"
421 " Configuration Item "
422 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
431 "<!ENTITY file-extended_states \"\n"
433 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
434 " <listitem><para>Status list of auto-installed packages.\n"
435 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
436 " </para></listitem>\n"
445 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
447 " to the other headers like NAME and DESCRIPTION and should therefore be "
449 "<!ENTITY translation-title \"TRANSLATION\">\n"
456 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
458 " to the translation in the past, who is responsible now and maybe "
459 "further information\n"
460 " specially related to your translation. -->\n"
461 "<!ENTITY translation-holder \"\n"
462 " The english translation was done by John Doe "
463 "<email>john@doe.org</email> in 2009,\n"
464 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
466 " Debian Dummy l10n Team "
467 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
475 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
476 "untranslated/fuzzy strings\n"
477 " in a shipped manpage newer/modified paragraphs will maybe appear in "
479 " the generated manpage. This sentence is therefore here to tell the "
481 " is not a mistake by the translator - obviously the target is that at "
483 " releases this sentence is not needed. :) -->\n"
484 "<!ENTITY translation-english \"\n"
485 " Note that this translated document may contain untranslated parts.\n"
486 " This is done on purpose, to avoid losing content when the\n"
487 " translation is lagging behind the original content.\n"
494 "<!-- TRANSLATOR: used as in -o=config_string "
495 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
502 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
503 "synopsis-config-file \"config_file\">"
509 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
510 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
511 "\"target_release\">"
517 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
518 "synopsis-architecture \"architecture\">"
524 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
525 "--> <!ENTITY synopsis-pkg \"pkg\">"
531 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
532 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
538 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
539 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
545 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
546 "awesome --> <!ENTITY synopsis-regex \"regex\">"
552 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
553 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
559 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
560 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
561 "\"temporary_directory\">"
567 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
568 "synopsis-filename \"filename\">"
574 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
575 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
581 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
582 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
589 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
590 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
597 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
598 "generate section --> <!ENTITY synopsis-section \"section\">"
604 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
605 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
608 #. type: Content of: <refentry><refmeta><manvolnum>
609 #: apt-cache.8.xml:26 apt-cdrom.8.xml:25 apt-config.8.xml:26 apt-get.8.xml:26 apt-key.8.xml:25 apt-mark.8.xml:26 apt-secure.8.xml:25
613 #. type: Content of: <refentry><refmeta><refmiscinfo>
614 #: apt-cache.8.xml:27 apt-cdrom.8.xml:26 apt-config.8.xml:27 apt-extracttemplates.1.xml:27 apt-ftparchive.1.xml:27 apt-get.8.xml:27 apt-key.8.xml:26 apt-mark.8.xml:27 apt-secure.8.xml:26 apt-sortpkgs.1.xml:27 apt.conf.5.xml:32 apt_preferences.5.xml:26 sources.list.5.xml:27
618 #. type: Content of: <refentry><refnamediv><refpurpose>
619 #: apt-cache.8.xml:33
620 msgid "query the APT cache"
623 #. type: Content of: <refentry><refsect1><title>
624 #: apt-cache.8.xml:38 apt-cdrom.8.xml:37 apt-config.8.xml:38 apt-extracttemplates.1.xml:38 apt-ftparchive.1.xml:38 apt-get.8.xml:38 apt-key.8.xml:37 apt-mark.8.xml:38 apt-secure.8.xml:50 apt-sortpkgs.1.xml:38 apt.conf.5.xml:41 apt_preferences.5.xml:36 sources.list.5.xml:36
628 #. type: Content of: <refentry><refsect1><para>
629 #: apt-cache.8.xml:39
631 "<command>apt-cache</command> performs a variety of operations on APT's "
632 "package cache. <command>apt-cache</command> does not manipulate the state of "
633 "the system but does provide operations to search and generate interesting "
634 "output from the package metadata."
637 #. type: Content of: <refentry><refsect1><para>
638 #: apt-cache.8.xml:44 apt-get.8.xml:44
640 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
641 "one of the commands below must be present."
644 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
645 #: apt-cache.8.xml:49
647 "<literal>gencaches</literal> creates APT's package cache. This is done "
648 "implicitly by all commands needing this cache if it is missing or outdated."
651 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
652 #: apt-cache.8.xml:53 apt-cache.8.xml:142 apt-cache.8.xml:163 apt-cache.8.xml:187 apt-cache.8.xml:192 apt-cache.8.xml:208 apt-cache.8.xml:226 apt-cache.8.xml:238
653 msgid "&synopsis-pkg;"
656 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
657 #: apt-cache.8.xml:54
659 "<literal>showpkg</literal> displays information about the packages listed on "
660 "the command line. Remaining arguments are package names. The available "
661 "versions and reverse dependencies of each package listed are listed, as well "
662 "as forward dependencies for each version. Forward (normal) dependencies are "
663 "those packages upon which the package in question depends; reverse "
664 "dependencies are those packages that depend upon the package in "
665 "question. Thus, forward dependencies must be satisfied for a package, but "
666 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
667 "libreadline2</command> would produce output similar to the following:"
670 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
671 #: apt-cache.8.xml:66
674 "Package: libreadline2\n"
675 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
676 "Reverse Depends: \n"
677 " libreadlineg2,libreadline2\n"
678 " libreadline2-altdev,libreadline2\n"
680 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
683 "Reverse Provides: \n"
686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
687 #: apt-cache.8.xml:78
689 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
690 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
691 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
692 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
693 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
694 "installed. For the specific meaning of the remainder of the output it is "
695 "best to consult the apt source code."
698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
699 #: apt-cache.8.xml:87
701 "<literal>stats</literal> displays some statistics about the cache. No "
702 "further arguments are expected. Statistics reported are:"
705 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
706 #: apt-cache.8.xml:90
708 "<literal>Total package names</literal> is the number of package names found "
712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
713 #: apt-cache.8.xml:94
715 "<literal>Normal packages</literal> is the number of regular, ordinary "
716 "package names; these are packages that bear a one-to-one correspondence "
717 "between their names and the names used by other packages for them in "
718 "dependencies. The majority of packages fall into this category."
721 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
722 #: apt-cache.8.xml:100
724 "<literal>Pure virtual packages</literal> is the number of packages that "
725 "exist only as a virtual package name; that is, packages only \"provide\" the "
726 "virtual package name, and no package actually uses the name. For instance, "
727 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
728 "package; several packages provide \"mail-transport-agent\", but there is no "
729 "package named \"mail-transport-agent\"."
732 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
733 #: apt-cache.8.xml:108
735 "<literal>Single virtual packages</literal> is the number of packages with "
736 "only one package providing a particular virtual package. For example, in the "
737 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
738 "one package, xless, provides \"X11-text-viewer\"."
741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
742 #: apt-cache.8.xml:114
744 "<literal>Mixed virtual packages</literal> is the number of packages that "
745 "either provide a particular virtual package or have the virtual package name "
746 "as the package name. For instance, in the Debian GNU/Linux system, "
747 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
751 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
752 #: apt-cache.8.xml:121
754 "<literal>Missing</literal> is the number of package names that were "
755 "referenced in a dependency but were not provided by any package. Missing "
756 "packages may be an evidence if a full distribution is not accessed, or if a "
757 "package (real or virtual) has been dropped from the distribution. Usually "
758 "they are referenced from Conflicts or Breaks statements."
761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
762 #: apt-cache.8.xml:128
764 "<literal>Total distinct</literal> versions is the number of package versions "
765 "found in the cache; this value is therefore at least equal to the number of "
766 "total package names. If more than one distribution (both \"stable\" and "
767 "\"unstable\", for instance), is being accessed, this value can be "
768 "considerably larger than the number of total package names."
771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
772 #: apt-cache.8.xml:135
774 "<literal>Total dependencies</literal> is the number of dependency "
775 "relationships claimed by all of the packages in the cache."
778 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
779 #: apt-cache.8.xml:143
781 "<literal>showsrc</literal> displays all the source package records that "
782 "match the given package names. All versions are shown, as well as all "
783 "records that declare the name to be a Binary."
786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
787 #: apt-cache.8.xml:149
789 "<literal>dump</literal> shows a short listing of every package in the "
790 "cache. It is primarily for debugging."
793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
794 #: apt-cache.8.xml:154
796 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
797 "suitable for use with &dpkg; and is used by the &dselect; method."
800 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
801 #: apt-cache.8.xml:159
803 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
808 #: apt-cache.8.xml:164
810 "<literal>show</literal> performs a function similar to <command>dpkg "
811 "--print-avail</command>; it displays the package records for the named "
815 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
816 #: apt-cache.8.xml:169
817 msgid "&synopsis-regex;"
820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
821 #: apt-cache.8.xml:170
823 "<literal>search</literal> performs a full text search on all available "
824 "package lists for the POSIX regex pattern given, see "
825 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
826 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
827 "the descriptions for an occurrence of the regular expression and prints out "
828 "the package name and the short description, including virtual package "
829 "names. If <option>--full</option> is given then output identical to "
830 "<literal>show</literal> is produced for each matched package, and if "
831 "<option>--names-only</option> is given then the long description is not "
832 "searched, only the package name is."
835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
836 #: apt-cache.8.xml:183
838 "Separate arguments can be used to specify multiple search patterns that are "
842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
843 #: apt-cache.8.xml:188
845 "<literal>depends</literal> shows a listing of each dependency a package has "
846 "and all the possible other packages that can fulfill that dependency."
849 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
850 #: apt-cache.8.xml:193
852 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
856 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
857 #: apt-cache.8.xml:197
858 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
861 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
862 #: apt-cache.8.xml:198
864 "This command prints the name of each package APT knows. The optional "
865 "argument is a prefix match to filter the name list. The output is suitable "
866 "for use in a shell tab complete function and the output is generated "
867 "extremely quickly. This command is best used with the "
868 "<option>--generate</option> option."
871 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
872 #: apt-cache.8.xml:203
874 "Note that a package which APT knows of is not necessarily available to "
875 "download, installable or installed, e.g. virtual packages are also listed in "
876 "the generated list."
879 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
880 #: apt-cache.8.xml:209
882 "<literal>dotty</literal> takes a list of packages on the command line and "
883 "generates output suitable for use by dotty from the <ulink "
884 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
885 "package. The result will be a set of nodes and edges representing the "
886 "relationships between the packages. By default the given packages will trace "
887 "out all dependent packages; this can produce a very large graph. To limit "
888 "the output to only the packages listed on the command line, set the "
889 "<literal>APT::Cache::GivenOnly</literal> option."
892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
893 #: apt-cache.8.xml:218
895 "The resulting nodes will have several shapes; normal packages are boxes, "
896 "pure provides are triangles, mixed provides are diamonds, missing packages "
897 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
898 "lines are pre-depends, green lines are conflicts."
901 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
902 #: apt-cache.8.xml:223
903 msgid "Caution, dotty cannot graph larger sets of packages."
906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
907 #: apt-cache.8.xml:227
909 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
910 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
915 #: apt-cache.8.xml:231
916 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
920 #: apt-cache.8.xml:232
922 "<literal>policy</literal> is meant to help debug issues relating to the "
923 "preferences file. With no arguments it will print out the priorities of each "
924 "source. Otherwise it prints out detailed information about the priority "
925 "selection of the named package."
928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
929 #: apt-cache.8.xml:239
931 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
932 "to mimic the output format and a subset of the functionality of the Debian "
933 "archive management tool, <literal>madison</literal>. It displays available "
934 "versions of a package in a tabular format. Unlike the original "
935 "<literal>madison</literal>, it can only display information for the "
936 "architecture for which APT has retrieved package lists "
937 "(<literal>APT::Architecture</literal>)."
940 #. type: Content of: <refentry><refsect1><title>
941 #: apt-cache.8.xml:250 apt-config.8.xml:84 apt-extracttemplates.1.xml:52 apt-ftparchive.1.xml:504 apt-get.8.xml:259 apt-mark.8.xml:108 apt-sortpkgs.1.xml:48
945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
946 #: apt-cache.8.xml:255
948 "Select the file to store the package cache. The package cache is the primary "
949 "cache used by all operations. Configuration Item: "
950 "<literal>Dir::Cache::pkgcache</literal>."
953 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
954 #: apt-cache.8.xml:261
956 "Select the file to store the source cache. The source is used only by "
957 "<literal>gencaches</literal> and it stores a parsed version of the package "
958 "information from remote sources. When building the package cache the source "
959 "cache is used to avoid reparsing all of the package files. Configuration "
960 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
963 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
964 #: apt-cache.8.xml:269
966 "Quiet; produces output suitable for logging, omitting progress indicators. "
967 "More q's will produce more quietness up to a maximum of 2. You can also use "
968 "<option>-q=#</option> to set the quietness level, overriding the "
969 "configuration file. Configuration Item: <literal>quiet</literal>."
972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
973 #: apt-cache.8.xml:276
975 "Print only important dependencies; for use with unmet and depends. Causes "
976 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
977 "<literal>APT::Cache::Important</literal>."
980 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
981 #: apt-cache.8.xml:289
983 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
984 "print all dependencies. This can be tweaked with these flags which will omit "
985 "the specified dependency type. Configuration Item: "
986 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
987 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
991 #: apt-cache.8.xml:296
993 "Print full package records when searching. Configuration Item: "
994 "<literal>APT::Cache::ShowFull</literal>."
997 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
998 #: apt-cache.8.xml:301
1000 "Print full records for all available versions. This is the default; to turn "
1001 "it off, use <option>--no-all-versions</option>. If "
1002 "<option>--no-all-versions</option> is specified, only the candidate version "
1003 "will displayed (the one which would be selected for installation). This "
1004 "option is only applicable to the <literal>show</literal> command. "
1005 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1009 #: apt-cache.8.xml:310
1011 "Perform automatic package cache regeneration, rather than use the cache as "
1012 "it is. This is the default; to turn it off, use "
1013 "<option>--no-generate</option>. Configuration Item: "
1014 "<literal>APT::Cache::Generate</literal>."
1017 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1018 #: apt-cache.8.xml:316
1020 "Only search on the package names, not the long descriptions. Configuration "
1021 "Item: <literal>APT::Cache::NamesOnly</literal>."
1024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1025 #: apt-cache.8.xml:321
1027 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1028 "and missing dependencies. Configuration Item: "
1029 "<literal>APT::Cache::AllNames</literal>."
1032 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1033 #: apt-cache.8.xml:327
1035 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1036 "that all packages mentioned are printed once. Configuration Item: "
1037 "<literal>APT::Cache::RecurseDepends</literal>."
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1041 #: apt-cache.8.xml:334
1043 "Limit the output of <literal>depends</literal> and "
1044 "<literal>rdepends</literal> to packages which are currently installed. "
1045 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1048 #. type: Content of: <refentry><refsect1><variablelist>
1049 #: apt-cache.8.xml:339 apt-cdrom.8.xml:140 apt-config.8.xml:104 apt-extracttemplates.1.xml:63 apt-ftparchive.1.xml:591 apt-get.8.xml:514 apt-mark.8.xml:122 apt-sortpkgs.1.xml:58
1050 msgid "&apt-commonoptions;"
1053 #. type: Content of: <refentry><refsect1><title>
1054 #: apt-cache.8.xml:344 apt-get.8.xml:519 apt-key.8.xml:174 apt-mark.8.xml:126 apt.conf.5.xml:1118 apt_preferences.5.xml:698
1058 #. type: Content of: <refentry><refsect1><variablelist>
1059 #: apt-cache.8.xml:346
1060 msgid "&file-sourceslist; &file-statelists;"
1063 #. type: Content of: <refentry><refsect1><title>
1064 #: apt-cache.8.xml:351 apt-cdrom.8.xml:145 apt-config.8.xml:109 apt-extracttemplates.1.xml:70 apt-ftparchive.1.xml:607 apt-get.8.xml:529 apt-key.8.xml:195 apt-mark.8.xml:132 apt-secure.8.xml:192 apt-sortpkgs.1.xml:63 apt.conf.5.xml:1124 apt_preferences.5.xml:705 sources.list.5.xml:255
1068 #. type: Content of: <refentry><refsect1><para>
1069 #: apt-cache.8.xml:352
1070 msgid "&apt-conf;, &sources-list;, &apt-get;"
1073 #. type: Content of: <refentry><refsect1><title>
1074 #: apt-cache.8.xml:356 apt-cdrom.8.xml:150 apt-config.8.xml:114 apt-extracttemplates.1.xml:74 apt-ftparchive.1.xml:611 apt-get.8.xml:535 apt-mark.8.xml:136 apt-sortpkgs.1.xml:67
1078 #. type: Content of: <refentry><refsect1><para>
1079 #: apt-cache.8.xml:357
1081 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1085 #. type: Content of: <refentry><refnamediv><refpurpose>
1086 #: apt-cdrom.8.xml:32
1087 msgid "APT CDROM management utility"
1090 #. type: Content of: <refentry><refsect1><para>
1091 #: apt-cdrom.8.xml:38
1093 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1094 "available sources. <command>apt-cdrom</command> takes care of determining "
1095 "the structure of the disc as well as correcting for several possible "
1096 "mis-burns and verifying the index files."
1099 #. type: Content of: <refentry><refsect1><para>
1100 #: apt-cdrom.8.xml:45
1102 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1103 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1104 "must be inserted and scanned separately to account for possible mis-burns."
1107 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1108 #: apt-cdrom.8.xml:56
1110 "<literal>add</literal> is used to add a new disc to the source list. It will "
1111 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1112 "to scan it and copy the index files. If the disc does not have a proper "
1113 "<filename>disk</filename> directory you will be prompted for a descriptive "
1117 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1118 #: apt-cdrom.8.xml:64
1120 "APT uses a CDROM ID to track which disc is currently in the drive and "
1121 "maintains a database of these IDs in "
1122 "<filename>&statedir;/cdroms.list</filename>"
1125 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1126 #: apt-cdrom.8.xml:72
1128 "A debugging tool to report the identity of the current disc as well as the "
1132 #. type: Content of: <refentry><refsect1><para>
1133 #: apt-cdrom.8.xml:51
1135 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1136 "one of the commands below must be present. <placeholder "
1137 "type=\"variablelist\" id=\"0\"/>"
1140 #. type: Content of: <refentry><refsect1><title>
1141 #: apt-cdrom.8.xml:81 apt-key.8.xml:160
1145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1146 #: apt-cdrom.8.xml:86
1148 "Mount point; specify the location to mount the cdrom. This mount point must "
1149 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1150 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1153 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1154 #: apt-cdrom.8.xml:95
1156 "Rename a disc; change the label of a disk or override the disks given "
1157 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1158 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1162 #: apt-cdrom.8.xml:104
1164 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1165 "unmounting the mount point. Configuration Item: "
1166 "<literal>APT::CDROM::NoMount</literal>."
1169 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1170 #: apt-cdrom.8.xml:112
1172 "Fast Copy; Assume the package files are valid and do not check every "
1173 "package. This option should be used only if <command>apt-cdrom</command> has "
1174 "been run on this disc before and did not detect any errors. Configuration "
1175 "Item: <literal>APT::CDROM::Fast</literal>."
1178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1179 #: apt-cdrom.8.xml:122
1181 "Thorough Package Scan; This option may be needed with some old Debian "
1182 "1.1/1.2 discs that have Package files in strange places. It takes much "
1183 "longer to scan the CD but will pick them all up."
1186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1187 #: apt-cdrom.8.xml:133
1189 "No Changes; Do not change the &sources-list; file and do not write index "
1190 "files. Everything is still checked however. Configuration Item: "
1191 "<literal>APT::CDROM::NoAct</literal>."
1194 #. type: Content of: <refentry><refsect1><para>
1195 #: apt-cdrom.8.xml:146
1196 msgid "&apt-conf;, &apt-get;, &sources-list;"
1199 #. type: Content of: <refentry><refsect1><para>
1200 #: apt-cdrom.8.xml:151
1202 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1206 #. type: Content of: <refentry><refnamediv><refpurpose>
1207 #: apt-config.8.xml:33
1208 msgid "APT Configuration Query program"
1211 #. type: Content of: <refentry><refsect1><para>
1212 #: apt-config.8.xml:39
1214 "<command>apt-config</command> is an internal program used by various "
1215 "portions of the APT suite to provide consistent configurability. It accesses "
1216 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1217 "manner that is easy to use by scripted applications."
1220 #. type: Content of: <refentry><refsect1><para>
1221 #: apt-config.8.xml:44 apt-ftparchive.1.xml:54
1223 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1224 "one of the commands below must be present."
1227 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1228 #: apt-config.8.xml:51
1230 "shell is used to access the configuration information from a shell "
1231 "script. It is given pairs of arguments, the first being a shell variable and "
1232 "the second the configuration value to query. As output it lists a series of "
1233 "shell assignments commands for each present value. In a shell script it "
1234 "should be used like:"
1237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1238 #: apt-config.8.xml:59
1242 "RES=`apt-config shell OPTS MyApp::options`\n"
1246 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1247 #: apt-config.8.xml:64
1249 "This will set the shell environment variable $OPTS to the value of "
1250 "MyApp::options with a default of <option>-f</option>."
1253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1254 #: apt-config.8.xml:68
1256 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1257 "names, d returns directories, b returns true or false and i returns an "
1258 "integer. Each of the returns is normalized and verified internally."
1261 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1262 #: apt-config.8.xml:77
1263 msgid "Just show the contents of the configuration space."
1266 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1267 #: apt-config.8.xml:90
1269 "Include options which have an empty value. This is the default, so use "
1270 "--no-empty to remove them from the output."
1273 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1274 #: apt-config.8.xml:95
1275 msgid "%f "%v";%n"
1278 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1279 #: apt-config.8.xml:96
1281 "Defines the output of each config option. %t will be replaced with "
1282 "the name of the option, %f with the complete optionname and %v "
1283 "with the value of the option. Use uppercase letters and special characters "
1284 "in the value will be encoded to ensure that it can e.g. be savely used in a "
1285 "quoted-string as defined by RFC822. Additionally %n will be replaced "
1286 "by a newline, %N by a tab. A % can be printed by using "
1290 #. type: Content of: <refentry><refsect1><para>
1291 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1295 #. type: Content of: <refentry><refsect1><para>
1296 #: apt-config.8.xml:115
1298 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1302 #. type: Content of: <refentry><refmeta><manvolnum>
1303 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1307 #. type: Content of: <refentry><refnamediv><refpurpose>
1308 #: apt-extracttemplates.1.xml:33
1309 msgid "Utility to extract DebConf config and templates from Debian packages"
1312 #. type: Content of: <refentry><refsect1><para>
1313 #: apt-extracttemplates.1.xml:39
1315 "<command>apt-extracttemplates</command> will take one or more Debian package "
1316 "files as input and write out (to a temporary directory) all associated "
1317 "config scripts and template files. For each passed in package that contains "
1318 "config scripts and templates, one line of output will be generated in the "
1322 #. type: Content of: <refentry><refsect1><para>
1323 #: apt-extracttemplates.1.xml:44
1324 msgid "package version template-file config-script"
1327 #. type: Content of: <refentry><refsect1><para>
1328 #: apt-extracttemplates.1.xml:45
1330 "template-file and config-script are written to the temporary directory "
1331 "specified by the <option>-t</option> or <option>--tempdir</option> "
1332 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1333 "filenames of the form <filename>package.template.XXXX</filename> and "
1334 "<filename>package.config.XXXX</filename>"
1337 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1338 #: apt-extracttemplates.1.xml:58
1340 "Temporary directory in which to write extracted debconf template files and "
1341 "config scripts. Configuration Item: "
1342 "<literal>APT::ExtractTemplates::TempDir</literal>"
1345 #. type: Content of: <refentry><refsect1><para>
1346 #: apt-extracttemplates.1.xml:75
1348 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1349 "decimal 100 on error."
1352 #. type: Content of: <refentry><refnamediv><refpurpose>
1353 #: apt-ftparchive.1.xml:33
1354 msgid "Utility to generate index files"
1357 #. type: Content of: <refentry><refsect1><para>
1358 #: apt-ftparchive.1.xml:39
1360 "<command>apt-ftparchive</command> is the command line tool that generates "
1361 "the index files that APT uses to access a distribution source. The index "
1362 "files should be generated on the origin site based on the content of that "
1366 #. type: Content of: <refentry><refsect1><para>
1367 #: apt-ftparchive.1.xml:43
1369 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1370 "program, incorporating its entire functionality via the "
1371 "<literal>packages</literal> command. It also contains a contents file "
1372 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1373 "the generation process for a complete archive."
1376 #. type: Content of: <refentry><refsect1><para>
1377 #: apt-ftparchive.1.xml:49
1379 "Internally <command>apt-ftparchive</command> can make use of binary "
1380 "databases to cache the contents of a .deb file and it does not rely on any "
1381 "external programs aside from &gzip;. When doing a full generate it "
1382 "automatically performs file-change checks and builds the desired compressed "
1386 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1387 #: apt-ftparchive.1.xml:60
1389 "The packages command generates a package file from a directory tree. It "
1390 "takes the given directory and recursively searches it for .deb files, "
1391 "emitting a package record to stdout for each. This command is approximately "
1392 "equivalent to &dpkg-scanpackages;."
1395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1396 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1397 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1401 #: apt-ftparchive.1.xml:70
1403 "The <literal>sources</literal> command generates a source index file from a "
1404 "directory tree. It takes the given directory and recursively searches it "
1405 "for .dsc files, emitting a source record to stdout for each. This command is "
1406 "approximately equivalent to &dpkg-scansources;."
1409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1410 #: apt-ftparchive.1.xml:75
1412 "If an override file is specified then a source override file will be looked "
1413 "for with an extension of .src. The --source-override option can be used to "
1414 "change the source override file that will be used."
1417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1418 #: apt-ftparchive.1.xml:82
1420 "The <literal>contents</literal> command generates a contents file from a "
1421 "directory tree. It takes the given directory and recursively searches it for "
1422 ".deb files, and reads the file list from each file. It then sorts and writes "
1423 "to stdout the list of files matched to packages. Directories are not written "
1424 "to the output. If multiple packages own the same file then each package is "
1425 "separated by a comma in the output."
1428 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1429 #: apt-ftparchive.1.xml:94
1431 "The <literal>release</literal> command generates a Release file from a "
1432 "directory tree. It recursively searches the given directory for uncompressed "
1433 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1434 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1435 "<command>lzma</command> as well as <filename>Release</filename> and "
1436 "<filename>md5sum.txt</filename> files by default "
1437 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1438 "filename patterns can be added by listing them in "
1439 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1440 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1444 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1445 #: apt-ftparchive.1.xml:104
1447 "Values for the additional metadata fields in the Release file are taken from "
1448 "the corresponding variables under "
1449 "<literal>APT::FTPArchive::Release</literal>, "
1450 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1451 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1452 "<literal>Suite</literal>, <literal>Version</literal>, "
1453 "<literal>Codename</literal>, <literal>Date</literal>, "
1454 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1455 "<literal>Components</literal>, <literal>Description</literal>."
1458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1459 #: apt-ftparchive.1.xml:117
1461 "The <literal>generate</literal> command is designed to be runnable from a "
1462 "cron script and builds indexes according to the given config file. The "
1463 "config language provides a flexible means of specifying which index files "
1464 "are built from which directories, as well as providing a simple means of "
1465 "maintaining the required settings."
1468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1469 #: apt-ftparchive.1.xml:126
1471 "The <literal>clean</literal> command tidies the databases used by the given "
1472 "configuration file by removing any records that are no longer necessary."
1475 #. type: Content of: <refentry><refsect1><title>
1476 #: apt-ftparchive.1.xml:132
1477 msgid "The Generate Configuration"
1480 #. type: Content of: <refentry><refsect1><para>
1481 #: apt-ftparchive.1.xml:134
1483 "The <literal>generate</literal> command uses a configuration file to "
1484 "describe the archives that are going to be generated. It follows the typical "
1485 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1486 "&apt-conf; contains a description of the syntax. Note that the generate "
1487 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1488 "tree manner. This only effects how the scope tag is handled."
1491 #. type: Content of: <refentry><refsect1><para>
1492 #: apt-ftparchive.1.xml:142
1493 msgid "The generate configuration has 4 separate sections, each described below."
1496 #. type: Content of: <refentry><refsect1><refsect2><title>
1497 #: apt-ftparchive.1.xml:144
1501 #. type: Content of: <refentry><refsect1><refsect2><para>
1502 #: apt-ftparchive.1.xml:146
1504 "The <literal>Dir</literal> section defines the standard directories needed "
1505 "to locate the files required during the generation process. These "
1506 "directories are prepended certain relative paths defined in later sections "
1507 "to produce a complete an absolute path."
1510 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1511 #: apt-ftparchive.1.xml:153
1513 "Specifies the root of the FTP archive, in a standard Debian configuration "
1514 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1518 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1519 #: apt-ftparchive.1.xml:160
1520 msgid "Specifies the location of the override files."
1523 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1524 #: apt-ftparchive.1.xml:165
1525 msgid "Specifies the location of the cache files"
1528 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1529 #: apt-ftparchive.1.xml:170
1531 "Specifies the location of the file list files, if the "
1532 "<literal>FileList</literal> setting is used below."
1535 #. type: Content of: <refentry><refsect1><refsect2><title>
1536 #: apt-ftparchive.1.xml:176
1537 msgid "Default Section"
1540 #. type: Content of: <refentry><refsect1><refsect2><para>
1541 #: apt-ftparchive.1.xml:178
1543 "The <literal>Default</literal> section specifies default values, and "
1544 "settings that control the operation of the generator. Other sections may "
1545 "override these defaults with a per-section setting."
1548 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1549 #: apt-ftparchive.1.xml:184
1551 "Sets the default compression schemes to use for the Package index files. It "
1552 "is a string that contains a space separated list of at least one of: '.' (no "
1553 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1557 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1558 #: apt-ftparchive.1.xml:192
1560 "Sets the default list of file extensions that are package files. This "
1561 "defaults to '.deb'."
1564 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1565 #: apt-ftparchive.1.xml:198
1567 "This is similar to <literal>Packages::Compress</literal> except that it "
1568 "controls the compression for the Sources files."
1571 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1572 #: apt-ftparchive.1.xml:204
1574 "Sets the default list of file extensions that are source files. This "
1575 "defaults to '.dsc'."
1578 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1579 #: apt-ftparchive.1.xml:210
1581 "This is similar to <literal>Packages::Compress</literal> except that it "
1582 "controls the compression for the Contents files."
1585 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1586 #: apt-ftparchive.1.xml:216
1588 "This is similar to <literal>Packages::Compress</literal> except that it "
1589 "controls the compression for the Translation-en master file."
1592 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1593 #: apt-ftparchive.1.xml:222
1595 "Specifies the number of kilobytes to delink (and replace with hard links) "
1596 "per run. This is used in conjunction with the per-section "
1597 "<literal>External-Links</literal> setting."
1600 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1601 #: apt-ftparchive.1.xml:229
1603 "Specifies the mode of all created index files. It defaults to 0644. All "
1604 "index files are set to this mode with no regard to the umask."
1607 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1608 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
1610 "Sets if long descriptions should be included in the Packages file or split "
1611 "out into a master Translation-en file."
1614 #. type: Content of: <refentry><refsect1><refsect2><title>
1615 #: apt-ftparchive.1.xml:242
1616 msgid "TreeDefault Section"
1619 #. type: Content of: <refentry><refsect1><refsect2><para>
1620 #: apt-ftparchive.1.xml:244
1622 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
1623 "variables are substitution variables and have the strings $(DIST), "
1624 "$(SECTION) and $(ARCH) replaced with their respective values."
1627 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1628 #: apt-ftparchive.1.xml:251
1630 "Sets the number of kilobytes of contents files that are generated each "
1631 "day. The contents files are round-robined so that over several days they "
1632 "will all be rebuilt."
1635 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1636 #: apt-ftparchive.1.xml:258
1638 "Controls the number of days a contents file is allowed to be checked without "
1639 "changing. If this limit is passed the mtime of the contents file is "
1640 "updated. This case can occur if the package file is changed in such a way "
1641 "that does not result in a new contents file [override edit for instance]. A "
1642 "hold off is allowed in hopes that new .debs will be installed, requiring a "
1643 "new file anyhow. The default is 10, the units are in days."
1646 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1647 #: apt-ftparchive.1.xml:269
1649 "Sets the top of the .deb directory tree. Defaults to "
1650 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
1653 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1654 #: apt-ftparchive.1.xml:275
1656 "Sets the top of the source package directory tree. Defaults to "
1657 "<filename>$(DIST)/$(SECTION)/source/</filename>"
1660 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1661 #: apt-ftparchive.1.xml:281
1663 "Sets the output Packages file. Defaults to "
1664 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
1667 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1668 #: apt-ftparchive.1.xml:287
1670 "Sets the output Sources file. Defaults to "
1671 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
1674 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1675 #: apt-ftparchive.1.xml:293
1677 "Set the output Translation-en master file with the long descriptions if they "
1678 "should be not included in the Packages file. Defaults to "
1679 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
1682 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1683 #: apt-ftparchive.1.xml:300
1685 "Sets the path prefix that causes a symlink to be considered an internal link "
1686 "instead of an external link. Defaults to "
1687 "<filename>$(DIST)/$(SECTION)/</filename>"
1690 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1691 #: apt-ftparchive.1.xml:307
1693 "Sets the output Contents file. Defaults to "
1694 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
1695 "multiple Packages files to map onto a single Contents file (such as the "
1696 "default) then <command>apt-ftparchive</command> will integrate those "
1697 "package files together automatically."
1700 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1701 #: apt-ftparchive.1.xml:316
1702 msgid "Sets header file to prepend to the contents output."
1705 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1706 #: apt-ftparchive.1.xml:321
1708 "Sets the binary cache database to use for this section. Multiple sections "
1709 "can share the same database."
1712 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1713 #: apt-ftparchive.1.xml:327
1715 "Specifies that instead of walking the directory tree, "
1716 "<command>apt-ftparchive</command> should read the list of files from the "
1717 "given file. Relative files names are prefixed with the archive directory."
1720 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1721 #: apt-ftparchive.1.xml:334
1723 "Specifies that instead of walking the directory tree, "
1724 "<command>apt-ftparchive</command> should read the list of files from the "
1725 "given file. Relative files names are prefixed with the archive directory. "
1726 "This is used when processing source indexes."
1729 #. type: Content of: <refentry><refsect1><refsect2><title>
1730 #: apt-ftparchive.1.xml:342
1731 msgid "Tree Section"
1734 #. type: Content of: <refentry><refsect1><refsect2><para>
1735 #: apt-ftparchive.1.xml:344
1737 "The <literal>Tree</literal> section defines a standard Debian file tree "
1738 "which consists of a base directory, then multiple sections in that base "
1739 "directory and finally multiple Architectures in each section. The exact "
1740 "pathing used is defined by the <literal>Directory</literal> substitution "
1744 #. type: Content of: <refentry><refsect1><refsect2><para>
1745 #: apt-ftparchive.1.xml:349
1747 "The <literal>Tree</literal> section takes a scope tag which sets the "
1748 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
1749 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
1750 "setting such as <filename>dists/&stable-codename;</filename>."
1753 #. type: Content of: <refentry><refsect1><refsect2><para>
1754 #: apt-ftparchive.1.xml:354
1756 "All of the settings defined in the <literal>TreeDefault</literal> section "
1757 "can be use in a <literal>Tree</literal> section as well as three new "
1761 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
1762 #: apt-ftparchive.1.xml:360
1765 "for i in Sections do \n"
1766 " for j in Architectures do\n"
1767 " Generate for DIST=scope SECTION=i ARCH=j\n"
1771 #. type: Content of: <refentry><refsect1><refsect2><para>
1772 #: apt-ftparchive.1.xml:357
1774 "When processing a <literal>Tree</literal> section "
1775 "<command>apt-ftparchive</command> performs an operation similar to: "
1776 "<placeholder type=\"programlisting\" id=\"0\"/>"
1779 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1780 #: apt-ftparchive.1.xml:368
1782 "This is a space separated list of sections which appear under the "
1783 "distribution, typically this is something like <literal>main contrib "
1784 "non-free</literal>"
1787 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1788 #: apt-ftparchive.1.xml:375
1790 "This is a space separated list of all the architectures that appear under "
1791 "search section. The special architecture 'source' is used to indicate that "
1792 "this tree has a source archive."
1795 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1796 #: apt-ftparchive.1.xml:388
1798 "Sets the binary override file. The override file contains section, priority "
1799 "and maintainer address information."
1802 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1803 #: apt-ftparchive.1.xml:394
1805 "Sets the source override file. The override file contains section "
1809 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1810 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
1811 msgid "Sets the binary extra override file."
1814 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1815 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
1816 msgid "Sets the source extra override file."
1819 #. type: Content of: <refentry><refsect1><refsect2><title>
1820 #: apt-ftparchive.1.xml:410
1821 msgid "BinDirectory Section"
1824 #. type: Content of: <refentry><refsect1><refsect2><para>
1825 #: apt-ftparchive.1.xml:412
1827 "The <literal>bindirectory</literal> section defines a binary directory tree "
1828 "with no special structure. The scope tag specifies the location of the "
1829 "binary directory and the settings are similar to the <literal>Tree</literal> "
1830 "section with no substitution variables or "
1831 "<literal>Section</literal><literal>Architecture</literal> settings."
1834 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1835 #: apt-ftparchive.1.xml:420
1836 msgid "Sets the Packages file output."
1839 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1840 #: apt-ftparchive.1.xml:425
1842 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
1843 "<literal>Sources</literal> is required."
1846 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1847 #: apt-ftparchive.1.xml:431
1848 msgid "Sets the Contents file output. (optional)"
1851 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1852 #: apt-ftparchive.1.xml:436
1853 msgid "Sets the binary override file."
1856 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1857 #: apt-ftparchive.1.xml:441
1858 msgid "Sets the source override file."
1861 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1862 #: apt-ftparchive.1.xml:456
1863 msgid "Sets the cache DB."
1866 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1867 #: apt-ftparchive.1.xml:461
1868 msgid "Appends a path to all the output paths."
1871 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1872 #: apt-ftparchive.1.xml:466
1873 msgid "Specifies the file list file."
1876 #. type: Content of: <refentry><refsect1><title>
1877 #: apt-ftparchive.1.xml:473
1878 msgid "The Binary Override File"
1881 #. type: Content of: <refentry><refsect1><para>
1882 #: apt-ftparchive.1.xml:474
1884 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
1885 "contains 4 fields separated by spaces. The first field is the package name, "
1886 "the second is the priority to force that package to, the third is the the "
1887 "section to force that package to and the final field is the maintainer "
1888 "permutation field."
1891 #. type: Content of: <refentry><refsect1><para><literallayout>
1892 #: apt-ftparchive.1.xml:480
1894 msgid "old [// oldn]* => new"
1897 #. type: Content of: <refentry><refsect1><para><literallayout>
1898 #: apt-ftparchive.1.xml:482
1903 #. type: Content of: <refentry><refsect1><para>
1904 #: apt-ftparchive.1.xml:479
1906 "The general form of the maintainer field is: <placeholder "
1907 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
1908 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
1909 "separated list of old email addresses to be specified. If any of those are "
1910 "found then new is substituted for the maintainer field. The second form "
1911 "unconditionally substitutes the maintainer field."
1914 #. type: Content of: <refentry><refsect1><title>
1915 #: apt-ftparchive.1.xml:490
1916 msgid "The Source Override File"
1919 #. type: Content of: <refentry><refsect1><para>
1920 #: apt-ftparchive.1.xml:492
1922 "The source override file is fully compatible with &dpkg-scansources;. It "
1923 "contains 2 fields separated by spaces. The first fields is the source "
1924 "package name, the second is the section to assign it."
1927 #. type: Content of: <refentry><refsect1><title>
1928 #: apt-ftparchive.1.xml:497
1929 msgid "The Extra Override File"
1932 #. type: Content of: <refentry><refsect1><para>
1933 #: apt-ftparchive.1.xml:499
1935 "The extra override file allows any arbitrary tag to be added or replaced in "
1936 "the output. It has 3 columns, the first is the package, the second is the "
1937 "tag and the remainder of the line is the new value."
1940 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1941 #: apt-ftparchive.1.xml:510
1943 "Generate the given checksum. These options default to on, when turned off "
1944 "the generated index files will not have the checksum fields where possible. "
1945 "Configuration Items: "
1946 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
1947 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
1948 "where <literal><replaceable>Index</replaceable></literal> can be "
1949 "<literal>Packages</literal>, <literal>Sources</literal> or "
1950 "<literal>Release</literal> and "
1951 "<literal><replaceable>Checksum</replaceable></literal> can be "
1952 "<literal>MD5</literal>, <literal>SHA1</literal> or "
1953 "<literal>SHA256</literal>."
1956 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1957 #: apt-ftparchive.1.xml:521
1959 "Use a binary caching DB. This has no effect on the generate command. "
1960 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
1963 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1964 #: apt-ftparchive.1.xml:527
1966 "Quiet; produces output suitable for logging, omitting progress indicators. "
1967 "More q's will produce more quiet up to a maximum of 2. You can also use "
1968 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1969 "file. Configuration Item: <literal>quiet</literal>."
1972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1973 #: apt-ftparchive.1.xml:535
1975 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
1976 "then this option actually enables delinking of the files. It defaults to on "
1977 "and can be turned off with <option>--no-delink</option>. Configuration "
1978 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
1981 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1982 #: apt-ftparchive.1.xml:543
1984 "Perform contents generation. When this option is set and package indexes are "
1985 "being generated with a cache DB then the file listing will also be extracted "
1986 "and stored in the DB for later use. When using the generate command this "
1987 "option also allows the creation of any Contents files. The default is on. "
1988 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
1991 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1992 #: apt-ftparchive.1.xml:553
1994 "Select the source override file to use with the <literal>sources</literal> "
1995 "command. Configuration Item: "
1996 "<literal>APT::FTPArchive::SourceOverride</literal>."
1999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2000 #: apt-ftparchive.1.xml:559
2002 "Make the caching databases read only. Configuration Item: "
2003 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2006 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2007 #: apt-ftparchive.1.xml:564
2009 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2010 "commands only package files matching <literal>*_arch.deb</literal> or "
2011 "<literal>*_all.deb</literal> instead of all package files in the given "
2012 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2015 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2016 #: apt-ftparchive.1.xml:572
2018 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2019 "packages are recompiled and/or republished with the same version again, this "
2020 "will lead to problems as the now outdated cached metadata like size and "
2021 "checksums will be used. With this option enabled this will no longer happen "
2022 "as it will be checked if the file was changed. Note that this option is set "
2023 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2024 "multiply versions/builds of a package with the same versionnumber, so in "
2025 "theory nobody will have these problems and therefore all these extra checks "
2029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2030 #: apt-ftparchive.1.xml:584
2032 "This configuration option defaults to \"<literal>true</literal>\" and should "
2033 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2034 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2035 "that the <filename>Translation-en</filename> master file can only be created "
2036 "in the generate command."
2039 #. type: Content of: <refentry><refsect1><title>
2040 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1112 apt_preferences.5.xml:545 sources.list.5.xml:214
2044 #. type: Content of: <refentry><refsect1><para><programlisting>
2045 #: apt-ftparchive.1.xml:602
2048 "<command>apt-ftparchive</command> packages "
2049 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2050 "<filename>Packages.gz</filename>\n"
2053 #. type: Content of: <refentry><refsect1><para>
2054 #: apt-ftparchive.1.xml:598
2056 "To create a compressed Packages file for a directory containing binary "
2057 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2060 #. type: Content of: <refentry><refsect1><para>
2061 #: apt-ftparchive.1.xml:612
2063 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2067 #. type: Content of: <refentry><refnamediv><refpurpose>
2069 msgid "APT package handling utility -- command-line interface"
2072 #. type: Content of: <refentry><refsect1><para>
2075 "<command>apt-get</command> is the command-line tool for handling packages, "
2076 "and may be considered the user's \"back-end\" to other tools using the APT "
2077 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2078 "&aptitude;, &synaptic; and &wajig;."
2081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2084 "<literal>update</literal> is used to resynchronize the package index files "
2085 "from their sources. The indexes of available packages are fetched from the "
2086 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2087 "example, when using a Debian archive, this command retrieves and scans the "
2088 "<filename>Packages.gz</filename> files, so that information about new and "
2089 "updated packages is available. An <literal>update</literal> should always be "
2090 "performed before an <literal>upgrade</literal> or "
2091 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2092 "meter will be incorrect as the size of the package files cannot be known in "
2096 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2099 "<literal>upgrade</literal> is used to install the newest versions of all "
2100 "packages currently installed on the system from the sources enumerated in "
2101 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2102 "with new versions available are retrieved and upgraded; under no "
2103 "circumstances are currently installed packages removed, or packages not "
2104 "already installed retrieved and installed. New versions of currently "
2105 "installed packages that cannot be upgraded without changing the install "
2106 "status of another package will be left at their current version. An "
2107 "<literal>update</literal> must be performed first so that "
2108 "<command>apt-get</command> knows that new versions of packages are "
2112 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2115 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2116 "traditional Debian packaging front-end, "
2117 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2118 "&dselect; to the <literal>Status</literal> field of available packages, and "
2119 "performs the actions necessary to realize that state (for instance, the "
2120 "removal of old and the installation of new packages)."
2123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2126 "<literal>dist-upgrade</literal> in addition to performing the function of "
2127 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2128 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2129 "conflict resolution system, and it will attempt to upgrade the most "
2130 "important packages at the expense of less important ones if necessary. So, "
2131 "<literal>dist-upgrade</literal> command may remove some packages. The "
2132 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2133 "from which to retrieve desired package files. See also &apt-preferences; "
2134 "for a mechanism for overriding the general settings for individual packages."
2137 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2140 "<literal>install</literal> is followed by one or more packages desired for "
2141 "installation or upgrading. Each package is a package name, not a fully "
2142 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2143 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2144 "packages required by the package(s) specified for installation will also be "
2145 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2146 "file is used to locate the desired packages. If a hyphen is appended to the "
2147 "package name (with no intervening space), the identified package will be "
2148 "removed if it is installed. Similarly a plus sign can be used to designate "
2149 "a package to install. These latter features may be used to override "
2150 "decisions made by apt-get's conflict resolution system."
2153 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2154 #: apt-get.8.xml:116
2156 "A specific version of a package can be selected for installation by "
2157 "following the package name with an equals and the version of the package to "
2158 "select. This will cause that version to be located and selected for "
2159 "install. Alternatively a specific distribution can be selected by following "
2160 "the package name with a slash and the version of the distribution or the "
2161 "Archive name (stable, testing, unstable)."
2164 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2165 #: apt-get.8.xml:123
2167 "Both of the version selection mechanisms can downgrade packages and must be "
2171 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2172 #: apt-get.8.xml:126
2174 "This is also the target to use if you want to upgrade one or more "
2175 "already-installed packages without upgrading every package you have on your "
2176 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2177 "all currently installed packages, \"install\" will install the newest "
2178 "version of only the package(s) specified. Simply provide the name of the "
2179 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2180 "its dependencies, as described above) will be downloaded and installed."
2183 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2184 #: apt-get.8.xml:137
2186 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2187 "installation policy for individual packages."
2190 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2191 #: apt-get.8.xml:141
2193 "If no package matches the given expression and the expression contains one "
2194 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2195 "it is applied to all package names in the database. Any matches are then "
2196 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2197 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2198 "expression with a '^' or '$' character, or create a more specific regular "
2202 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2203 #: apt-get.8.xml:151
2205 "<literal>remove</literal> is identical to <literal>install</literal> except "
2206 "that packages are removed instead of installed. Note the removing a package "
2207 "leaves its configuration files in system. If a plus sign is appended to the "
2208 "package name (with no intervening space), the identified package will be "
2209 "installed instead of removed."
2212 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2213 #: apt-get.8.xml:159
2215 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2216 "that packages are removed and purged (any configuration files are deleted "
2220 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2221 #: apt-get.8.xml:164
2223 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2224 "packages. APT will examine the available packages to decide which source "
2225 "package to fetch. It will then find and download into the current directory "
2226 "the newest available version of that source package while respecting the "
2227 "default release, set with the option "
2228 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2229 "per package with the <literal>pkg/release</literal> syntax, if possible."
2232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2233 #: apt-get.8.xml:172
2235 "Source packages are tracked separately from binary packages via "
2236 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2237 "that you will need to add such a line for each repository you want to get "
2238 "sources from. If you don't do this you will properly get another (newer, "
2239 "older or none) source version than the one you have installed or could "
2243 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2244 #: apt-get.8.xml:179
2246 "If the <option>--compile</option> option is specified then the package will "
2247 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2248 "the architecture as defined by the <command>--host-architecture</command> "
2249 "option. If <option>--download-only</option> is specified then the source "
2250 "package will not be unpacked."
2253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2254 #: apt-get.8.xml:186
2256 "A specific source version can be retrieved by postfixing the source name "
2257 "with an equals and then the version to fetch, similar to the mechanism used "
2258 "for the package files. This enables exact matching of the source package "
2259 "name and version, implicitly enabling the "
2260 "<literal>APT::Get::Only-Source</literal> option."
2263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2264 #: apt-get.8.xml:192
2266 "Note that source packages are not tracked like binary packages, they exist "
2267 "only in the current directory and are similar to downloading source tar "
2271 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2272 #: apt-get.8.xml:198
2274 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2275 "attempt to satisfy the build dependencies for a source package. By default "
2276 "the dependencies are satisfied to build the package natively. If desired a "
2277 "host-architecture can be specified with the "
2278 "<option>--host-architecture</option> option instead."
2281 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2282 #: apt-get.8.xml:205
2284 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2285 "and checks for broken dependencies."
2288 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2289 #: apt-get.8.xml:210
2291 "<literal>download</literal> will download the given binary package into the "
2292 "current directory."
2295 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2296 #: apt-get.8.xml:216
2298 "<literal>clean</literal> clears out the local repository of retrieved "
2299 "package files. It removes everything but the lock file from "
2300 "<filename>&cachedir;/archives/</filename> and "
2301 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2302 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2303 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2304 "from time to time to free up disk space."
2307 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2308 #: apt-get.8.xml:226
2310 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2311 "local repository of retrieved package files. The difference is that it only "
2312 "removes package files that can no longer be downloaded, and are largely "
2313 "useless. This allows a cache to be maintained over a long period without it "
2314 "growing out of control. The configuration option "
2315 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2316 "being erased if it is set to off."
2319 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2320 #: apt-get.8.xml:236
2322 "<literal>autoremove</literal> is used to remove packages that were "
2323 "automatically installed to satisfy dependencies for other packages and are "
2324 "now no longer needed."
2327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2328 #: apt-get.8.xml:241
2330 "<literal>changelog</literal> downloads a package changelog and displays it "
2331 "through <command>sensible-pager</command>. The server name and base "
2332 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2333 "variable (e. g. <ulink "
2334 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
2335 "for Debian or <ulink "
2336 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
2337 "for Ubuntu). By default it displays the changelog for the version that is "
2338 "installed. However, you can specify the same options as for the "
2339 "<option>install</option> command."
2342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2343 #: apt-get.8.xml:264
2345 "Do not consider recommended packages as a dependency for installing. "
2346 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2350 #: apt-get.8.xml:269
2352 "Consider suggested packages as a dependency for installing. Configuration "
2353 "Item: <literal>APT::Install-Suggests</literal>."
2356 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2357 #: apt-get.8.xml:274
2359 "Download only; package files are only retrieved, not unpacked or installed. "
2360 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
2363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2364 #: apt-get.8.xml:279
2366 "Fix; attempt to correct a system with broken dependencies in place. This "
2367 "option, when used with install/remove, can omit any packages to permit APT "
2368 "to deduce a likely solution. If packages are specified, these have to "
2369 "completely correct the problem. The option is sometimes necessary when "
2370 "running APT for the first time; APT itself does not allow broken package "
2371 "dependencies to exist on a system. It is possible that a system's dependency "
2372 "structure can be so corrupt as to require manual intervention (which usually "
2373 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
2374 "of the offending packages). Use of this option together with "
2375 "<option>-m</option> may produce an error in some situations. Configuration "
2376 "Item: <literal>APT::Get::Fix-Broken</literal>."
2379 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2380 #: apt-get.8.xml:294
2382 "Ignore missing packages; If packages cannot be retrieved or fail the "
2383 "integrity check after retrieval (corrupted package files), hold back those "
2384 "packages and handle the result. Use of this option together with "
2385 "<option>-f</option> may produce an error in some situations. If a package is "
2386 "selected for installation (particularly if it is mentioned on the command "
2387 "line) and it could not be downloaded then it will be silently held back. "
2388 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
2391 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2392 #: apt-get.8.xml:305
2394 "Disables downloading of packages. This is best used with "
2395 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
2396 "already downloaded. Configuration Item: "
2397 "<literal>APT::Get::Download</literal>."
2400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2401 #: apt-get.8.xml:312
2403 "Quiet; produces output suitable for logging, omitting progress indicators. "
2404 "More q's will produce more quiet up to a maximum of 2. You can also use "
2405 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2406 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
2407 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
2408 "may decided to do something you did not expect. Configuration Item: "
2409 "<literal>quiet</literal>."
2412 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2413 #: apt-get.8.xml:327
2415 "No action; perform a simulation of events that would occur but do not "
2416 "actually change the system. Configuration Item: "
2417 "<literal>APT::Get::Simulate</literal>."
2420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2421 #: apt-get.8.xml:331
2423 "Simulation run as user will deactivate locking "
2424 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
2425 "displayed indicating that this is only a simulation, if the option "
2426 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
2427 "true). Neither NoLocking nor the notice will be triggered if run as root "
2428 "(root should know what he is doing without further warnings by "
2429 "<literal>apt-get</literal>)."
2432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2433 #: apt-get.8.xml:337
2435 "Simulate prints out a series of lines each one representing a dpkg "
2436 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
2437 "indicate broken packages and empty set of square brackets meaning breaks "
2438 "that are of no consequence (rare)."
2441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2442 #: apt-get.8.xml:346
2444 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
2445 "non-interactively. If an undesirable situation, such as changing a held "
2446 "package, trying to install a unauthenticated package or removing an "
2447 "essential package occurs then <literal>apt-get</literal> will abort. "
2448 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
2451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2452 #: apt-get.8.xml:354
2454 "Automatic \"no\" to all prompts. Configuration Item: "
2455 "<literal>APT::Get::Assume-No</literal>."
2458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2459 #: apt-get.8.xml:359
2461 "Show upgraded packages; Print out a list of all packages that are to be "
2462 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
2465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2466 #: apt-get.8.xml:365
2468 "Show full versions for upgraded and installed packages. Configuration Item: "
2469 "<literal>APT::Get::Show-Versions</literal>."
2472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2473 #: apt-get.8.xml:371
2475 "This option controls the architecture packages are built for by "
2476 "<command>apt-get source --compile</command> and how cross-builddependencies "
2477 "are satisfied. By default is it not set which means that the host "
2478 "architecture is the same as the build architecture (which is defined by "
2479 "<literal>APT::Architecture</literal>). Configuration Item: "
2480 "<literal>APT::Get::Host-Architecture</literal>"
2483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2484 #: apt-get.8.xml:381
2486 "Compile source packages after downloading them. Configuration Item: "
2487 "<literal>APT::Get::Compile</literal>."
2490 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2491 #: apt-get.8.xml:386
2493 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
2494 "hold placed on a package. This may be useful in conjunction with "
2495 "<literal>dist-upgrade</literal> to override a large number of undesired "
2496 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
2499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2500 #: apt-get.8.xml:393
2502 "Do not upgrade packages; When used in conjunction with "
2503 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
2504 "packages on the command line from being upgraded if they are already "
2505 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
2508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2509 #: apt-get.8.xml:400
2511 "Do not install new packages; When used in conjunction with "
2512 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
2513 "upgrades for already installed packages only and ignore requests to install "
2514 "new packages. Configuration Item: "
2515 "<literal>APT::Get::Only-Upgrade</literal>."
2518 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2519 #: apt-get.8.xml:408
2521 "Force yes; This is a dangerous option that will cause apt to continue "
2522 "without prompting if it is doing something potentially harmful. It should "
2523 "not be used except in very special situations. Using "
2524 "<literal>force-yes</literal> can potentially destroy your system! "
2525 "Configuration Item: <literal>APT::Get::force-yes</literal>."
2528 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2529 #: apt-get.8.xml:416
2531 "Instead of fetching the files to install their URIs are printed. Each URI "
2532 "will have the path, the destination file name, the size and the expected md5 "
2533 "hash. Note that the file name to write to will not always match the file "
2534 "name on the remote site! This also works with the <literal>source</literal> "
2535 "and <literal>update</literal> commands. When used with the "
2536 "<literal>update</literal> command the MD5 and size are not included, and it "
2537 "is up to the user to decompress any compressed files. Configuration Item: "
2538 "<literal>APT::Get::Print-URIs</literal>."
2541 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2542 #: apt-get.8.xml:427
2544 "Use purge instead of remove for anything that would be removed. An asterisk "
2545 "(\"*\") will be displayed next to packages which are scheduled to be "
2546 "purged. <option>remove --purge</option> is equivalent to the "
2547 "<option>purge</option> command. Configuration Item: "
2548 "<literal>APT::Get::Purge</literal>."
2551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2552 #: apt-get.8.xml:435
2554 "Re-Install packages that are already installed and at the newest version. "
2555 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
2558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2559 #: apt-get.8.xml:440
2561 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
2562 "it off. When on <command>apt-get</command> will automatically manage the "
2563 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
2564 "files are erased. The only reason to turn it off is if you frequently "
2565 "change your source list. Configuration Item: "
2566 "<literal>APT::Get::List-Cleanup</literal>."
2569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2570 #: apt-get.8.xml:451
2572 "This option controls the default input to the policy engine, it creates a "
2573 "default pin at priority 990 using the specified release string. This "
2574 "overrides the general settings in "
2575 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
2576 "not affected by the value of this option. In short, this option lets you "
2577 "have simple control over which distribution packages will be retrieved "
2578 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
2579 "unstable</option> or <option>-t sid</option>. Configuration Item: "
2580 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
2584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2585 #: apt-get.8.xml:466
2587 "Only perform operations that are 'trivial'. Logically this can be considered "
2588 "related to <option>--assume-yes</option>, where "
2589 "<option>--assume-yes</option> will answer yes to any prompt, "
2590 "<option>--trivial-only</option> will answer no. Configuration Item: "
2591 "<literal>APT::Get::Trivial-Only</literal>."
2594 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2595 #: apt-get.8.xml:473
2597 "If any packages are to be removed apt-get immediately aborts without "
2598 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
2601 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2602 #: apt-get.8.xml:479
2604 "If the command is either <literal>install</literal> or "
2605 "<literal>remove</literal>, then this option acts like running "
2606 "<literal>autoremove</literal> command, removing the unused dependency "
2607 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
2610 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2611 #: apt-get.8.xml:486
2613 "Only has meaning for the <literal>source</literal> and "
2614 "<literal>build-dep</literal> commands. Indicates that the given source "
2615 "names are not to be mapped through the binary table. This means that if "
2616 "this option is specified, these commands will only accept source package "
2617 "names as arguments, rather than accepting binary package names and looking "
2618 "up the corresponding source package. Configuration Item: "
2619 "<literal>APT::Get::Only-Source</literal>."
2622 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2623 #: apt-get.8.xml:497
2625 "Download only the diff, dsc, or tar file of a source archive. Configuration "
2626 "Item: <literal>APT::Get::Diff-Only</literal>, "
2627 "<literal>APT::Get::Dsc-Only</literal>, and "
2628 "<literal>APT::Get::Tar-Only</literal>."
2631 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2632 #: apt-get.8.xml:503
2634 "Only process architecture-dependent build-dependencies. Configuration Item: "
2635 "<literal>APT::Get::Arch-Only</literal>."
2638 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2639 #: apt-get.8.xml:508
2641 "Ignore if packages can't be authenticated and don't prompt about it. This "
2642 "is useful for tools like pbuilder. Configuration Item: "
2643 "<literal>APT::Get::AllowUnauthenticated</literal>."
2646 #. type: Content of: <refentry><refsect1><variablelist>
2647 #: apt-get.8.xml:521
2649 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
2653 #. type: Content of: <refentry><refsect1><para>
2654 #: apt-get.8.xml:530
2656 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
2657 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
2658 "&apt-preferences;, the APT Howto."
2661 #. type: Content of: <refentry><refsect1><para>
2662 #: apt-get.8.xml:536
2664 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
2668 #. type: Content of: <refentry><refnamediv><refpurpose>
2670 msgid "APT key management utility"
2673 #. type: Content of: <refentry><refsect1><para>
2676 "<command>apt-key</command> is used to manage the list of keys used by apt to "
2677 "authenticate packages. Packages which have been authenticated using these "
2678 "keys will be considered trusted."
2681 #. type: Content of: <refentry><refsect1><title>
2686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2689 "Add a new key to the list of trusted keys. The key is read from the "
2690 "filename given with the parameter &synopsis-param-filename; or if the "
2691 "filename is <literal>-</literal> from standard input."
2694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2696 msgid "Remove a key from the list of trusted keys."
2699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2701 msgid "Output the key &synopsis-param-keyid; to standard output."
2704 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2706 msgid "Output all trusted keys to standard output."
2709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2711 msgid "List trusted keys."
2714 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2715 #: apt-key.8.xml:107
2716 msgid "List fingerprints of trusted keys."
2719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2720 #: apt-key.8.xml:118
2722 "Pass advanced options to gpg. With adv --recv-key you can download the "
2726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2727 #: apt-key.8.xml:130
2729 "Update the local keyring with the archive keyring and remove from the local "
2730 "keyring the archive keys which are no longer valid. The archive keyring is "
2731 "shipped in the <literal>archive-keyring</literal> package of your "
2732 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
2736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2737 #: apt-key.8.xml:144
2739 "Work similar to the <command>update</command> command above, but get the "
2740 "archive keyring from an URI instead and validate it against a master key. "
2741 "This requires an installed &wget; and an APT build configured to have a "
2742 "server to fetch from and a master keyring to validate. APT in Debian does "
2743 "not support this command and relies on <command>update</command> instead, "
2744 "but Ubuntu's APT does."
2747 #. type: Content of: <refentry><refsect1><para>
2748 #: apt-key.8.xml:161
2750 "Note that options need to be defined before the commands described in the "
2754 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2755 #: apt-key.8.xml:164
2757 "With this option it is possible to specify a specific keyring file the "
2758 "command should operate on. The default is that a command is executed on the "
2759 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2760 "<filename>trusted.gpg.d</filename> directory, though "
2761 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2762 "e.g. new keys are added to this one."
2765 #. type: Content of: <refentry><refsect1><variablelist>
2766 #: apt-key.8.xml:177
2767 msgid "&file-trustedgpg;"
2770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2771 #: apt-key.8.xml:179
2772 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
2775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2776 #: apt-key.8.xml:180
2777 msgid "Local trust database of archive keys."
2780 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2781 #: apt-key.8.xml:183
2782 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
2785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2786 #: apt-key.8.xml:184
2787 msgid "Keyring of Debian archive trusted keys."
2790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2791 #: apt-key.8.xml:187
2792 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
2795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2796 #: apt-key.8.xml:188
2797 msgid "Keyring of Debian archive removed trusted keys."
2800 #. type: Content of: <refentry><refsect1><para>
2801 #: apt-key.8.xml:197
2802 msgid "&apt-get;, &apt-secure;"
2805 #. type: Content of: <refentry><refnamediv><refpurpose>
2806 #: apt-mark.8.xml:33
2807 msgid "mark/unmark a package as being automatically-installed"
2810 #. type: Content of: <refentry><refsect1><para>
2811 #: apt-mark.8.xml:39
2813 "<command>apt-mark</command> will change whether a package has been marked as "
2814 "being automatically installed."
2817 #. type: Content of: <refentry><refsect1><para>
2818 #: apt-mark.8.xml:43
2820 "When you request that a package is installed, and as a result other packages "
2821 "are installed to satisfy its dependencies, the dependencies are marked as "
2822 "being automatically installed. Once these automatically installed packages "
2823 "are no longer depended on by any manually installed packages, they will be "
2824 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
2827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2828 #: apt-mark.8.xml:52
2830 "<literal>auto</literal> is used to mark a package as being automatically "
2831 "installed, which will cause the package to be removed when no more manually "
2832 "installed packages depend on this package."
2835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2836 #: apt-mark.8.xml:60
2838 "<literal>manual</literal> is used to mark a package as being manually "
2839 "installed, which will prevent the package from being automatically removed "
2840 "if no other packages depend on it."
2843 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2844 #: apt-mark.8.xml:68
2846 "<literal>hold</literal> is used to mark a package as hold back, which will "
2847 "prevent the package from being automatically installed, upgraded or "
2848 "removed. The command is only a wrapper around <command>dpkg "
2849 "--set-selections</command> and the state is therefore maintained by &dpkg; "
2850 "and not effected by the <option>--filename</option> option."
2853 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2854 #: apt-mark.8.xml:78
2856 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2857 "package to allow all actions again."
2860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2861 #: apt-mark.8.xml:84
2863 "<literal>showauto</literal> is used to print a list of automatically "
2864 "installed packages with each package on a new line. All automatically "
2865 "installed packages will be listed if no package is given. If packages are "
2866 "given only those which are automatically installed will be shown."
2869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2870 #: apt-mark.8.xml:92
2872 "<literal>showmanual</literal> can be used in the same way as "
2873 "<literal>showauto</literal> except that it will print a list of manually "
2874 "installed packages instead."
2877 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2878 #: apt-mark.8.xml:99
2880 "<literal>showhold</literal> is used to print a list of packages on hold in "
2881 "the same way as for the other show commands."
2884 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><filename>
2885 #: apt-mark.8.xml:112 apt-mark.8.xml:113
2886 msgid "<replaceable>&synopsis-filename;</replaceable>"
2889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2890 #: apt-mark.8.xml:115
2892 "Read/Write package stats from the filename given with the parameter "
2893 "<filename><replaceable>&synopsis-filename;</replaceable></filename> instead "
2894 "of from the default location, which is <filename>extended_status</filename> "
2895 "in the directory defined by the Configuration Item: "
2896 "<literal>Dir::State</literal>."
2899 #. type: Content of: <refentry><refsect1><variablelist>
2900 #: apt-mark.8.xml:128
2901 msgid " &file-extended_states;"
2904 #. type: Content of: <refentry><refsect1><para>
2905 #: apt-mark.8.xml:133
2906 msgid "&apt-get;,&aptitude;,&apt-conf;"
2909 #. type: Content of: <refentry><refsect1><para>
2910 #: apt-mark.8.xml:137
2912 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2916 #. type: Content of: <refentry><refnamediv><refpurpose>
2917 #: apt-secure.8.xml:47
2918 msgid "Archive authentication support for APT"
2921 #. type: Content of: <refentry><refsect1><para>
2922 #: apt-secure.8.xml:52
2924 "Starting with version 0.6, <command>apt</command> contains code that does "
2925 "signature checking of the Release file for all archives. This ensures that "
2926 "packages in the archive can't be modified by people who have no access to "
2927 "the Release file signing key."
2930 #. type: Content of: <refentry><refsect1><para>
2931 #: apt-secure.8.xml:60
2933 "If a package comes from a archive without a signature or with a signature "
2934 "that apt does not have a key for that package is considered untrusted and "
2935 "installing it will result in a big warning. <command>apt-get</command> will "
2936 "currently only warn for unsigned archives, future releases might force all "
2937 "sources to be verified before downloading packages from them."
2940 #. type: Content of: <refentry><refsect1><para>
2941 #: apt-secure.8.xml:69
2943 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2944 "authentication feature."
2947 #. type: Content of: <refentry><refsect1><title>
2948 #: apt-secure.8.xml:74
2949 msgid "Trusted archives"
2952 #. type: Content of: <refentry><refsect1><para>
2953 #: apt-secure.8.xml:77
2955 "The chain of trust from an apt archive to the end user is made up of "
2956 "different steps. <command>apt-secure</command> is the last step in this "
2957 "chain, trusting an archive does not mean that the packages that you trust it "
2958 "do not contain malicious code but means that you trust the archive "
2959 "maintainer. It's the archive maintainer responsibility to ensure that the "
2960 "archive integrity is correct."
2963 #. type: Content of: <refentry><refsect1><para>
2964 #: apt-secure.8.xml:85
2966 "apt-secure does not review signatures at a package level. If you require "
2967 "tools to do this you should look at <command>debsig-verify</command> and "
2968 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2969 "packages respectively)."
2972 #. type: Content of: <refentry><refsect1><para>
2973 #: apt-secure.8.xml:92
2975 "The chain of trust in Debian starts when a maintainer uploads a new package "
2976 "or a new version of a package to the Debian archive. This upload in order to "
2977 "become effective needs to be signed by a key of a maintainer within the "
2978 "Debian maintainer's keyring (available in the debian-keyring "
2979 "package). Maintainer's keys are signed by other maintainers following "
2980 "pre-established procedures to ensure the identity of the key holder."
2983 #. type: Content of: <refentry><refsect1><para>
2984 #: apt-secure.8.xml:102
2986 "Once the uploaded package is verified and included in the archive, the "
2987 "maintainer signature is stripped off, an MD5 sum of the package is computed "
2988 "and put in the Packages file. The MD5 sum of all of the packages files are "
2989 "then computed and put into the Release file. The Release file is then signed "
2990 "by the archive key (which is created once a year) and distributed through "
2991 "the FTP server. This key is also on the Debian keyring."
2994 #. type: Content of: <refentry><refsect1><para>
2995 #: apt-secure.8.xml:112
2997 "Any end user can check the signature of the Release file, extract the MD5 "
2998 "sum of a package from it and compare it with the MD5 sum of the package he "
2999 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3000 "package was checked. Now both the MD5 sum and the signature of the Release "
3004 #. type: Content of: <refentry><refsect1><para>
3005 #: apt-secure.8.xml:119
3007 "Notice that this is distinct from checking signatures on a per package "
3008 "basis. It is designed to prevent two possible attacks:"
3011 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3012 #: apt-secure.8.xml:124
3014 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3015 "checking, a malicious agent can introduce himself in the package download "
3016 "process and provide malicious software either by controlling a network "
3017 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3018 "(through arp or DNS spoofing attacks)."
3021 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3022 #: apt-secure.8.xml:132
3024 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3025 "malicious agent can compromise a mirror host and modify the files in it to "
3026 "propagate malicious software to all users downloading packages from that "
3030 #. type: Content of: <refentry><refsect1><para>
3031 #: apt-secure.8.xml:139
3033 "However, it does not defend against a compromise of the Debian master server "
3034 "itself (which signs the packages) or against a compromise of the key used to "
3035 "sign the Release files. In any case, this mechanism can complement a "
3036 "per-package signature."
3039 #. type: Content of: <refentry><refsect1><title>
3040 #: apt-secure.8.xml:145
3041 msgid "User configuration"
3044 #. type: Content of: <refentry><refsect1><para>
3045 #: apt-secure.8.xml:147
3047 "<command>apt-key</command> is the program that manages the list of keys used "
3048 "by apt. It can be used to add or remove keys although an installation of "
3049 "this release will automatically provide the default Debian archive signing "
3050 "keys used in the Debian package repositories."
3053 #. type: Content of: <refentry><refsect1><para>
3054 #: apt-secure.8.xml:154
3056 "In order to add a new key you need to first download it (you should make "
3057 "sure you are using a trusted communication channel when retrieving it), add "
3058 "it with <command>apt-key</command> and then run <command>apt-get "
3059 "update</command> so that apt can download and verify the "
3060 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3061 "from the archives you have configured."
3064 #. type: Content of: <refentry><refsect1><title>
3065 #: apt-secure.8.xml:163
3066 msgid "Archive configuration"
3069 #. type: Content of: <refentry><refsect1><para>
3070 #: apt-secure.8.xml:165
3072 "If you want to provide archive signatures in an archive under your "
3073 "maintenance you have to:"
3076 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3077 #: apt-secure.8.xml:170
3079 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3080 "already. You can do this by running <command>apt-ftparchive "
3081 "release</command> (provided in apt-utils)."
3084 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3085 #: apt-secure.8.xml:175
3087 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
3088 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
3089 "Release.gpg Release</command>."
3092 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3093 #: apt-secure.8.xml:179
3095 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
3096 "know what key they need to import in order to authenticate the files in the "
3100 #. type: Content of: <refentry><refsect1><para>
3101 #: apt-secure.8.xml:186
3103 "Whenever the contents of the archive changes (new packages are added or "
3104 "removed) the archive maintainer has to follow the first two steps previously "
3108 #. type: Content of: <refentry><refsect1><para>
3109 #: apt-secure.8.xml:194
3111 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
3112 "&debsign; &debsig-verify;, &gpg;"
3115 #. type: Content of: <refentry><refsect1><para>
3116 #: apt-secure.8.xml:198
3118 "For more background information you might want to review the <ulink "
3119 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
3120 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
3121 "(available also in the harden-doc package) and the <ulink "
3122 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
3123 "Distribution HOWTO</ulink> by V. Alex Brennen."
3126 #. type: Content of: <refentry><refsect1><title>
3127 #: apt-secure.8.xml:211
3128 msgid "Manpage Authors"
3131 #. type: Content of: <refentry><refsect1><para>
3132 #: apt-secure.8.xml:213
3134 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
3135 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
3138 #. type: Content of: <refentry><refnamediv><refpurpose>
3139 #: apt-sortpkgs.1.xml:33
3140 msgid "Utility to sort package index files"
3143 #. type: Content of: <refentry><refsect1><para>
3144 #: apt-sortpkgs.1.xml:39
3146 "<command>apt-sortpkgs</command> will take an index file (Source index or "
3147 "Package index) and sort the records so that they are ordered by the package "
3148 "name. It will also sort the internal fields of each record according to the "
3149 "internal sorting rules."
3152 #. type: Content of: <refentry><refsect1><para>
3153 #: apt-sortpkgs.1.xml:45
3154 msgid "All output is sent to stdout, the input must be a seekable file."
3157 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3158 #: apt-sortpkgs.1.xml:54
3160 "Use Source index field ordering. Configuration Item: "
3161 "<literal>APT::SortPkgs::Source</literal>."
3164 #. type: Content of: <refentry><refsect1><para>
3165 #: apt-sortpkgs.1.xml:68
3167 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
3171 #. type: Content of: <refentry><refentryinfo><author><contrib>
3172 #: apt.conf.5.xml:20
3173 msgid "Initial documentation of Debug::*."
3176 #. type: Content of: <refentry><refentryinfo><author><email>
3177 #: apt.conf.5.xml:21
3178 msgid "dburrows@debian.org"
3181 #. type: Content of: <refentry><refmeta><manvolnum>
3182 #: apt.conf.5.xml:31 apt_preferences.5.xml:25 sources.list.5.xml:26
3186 #. type: Content of: <refentry><refnamediv><refpurpose>
3187 #: apt.conf.5.xml:38
3188 msgid "Configuration file for APT"
3191 #. type: Content of: <refentry><refsect1><para>
3192 #: apt.conf.5.xml:42
3194 "<filename>apt.conf</filename> is the main configuration file for the APT "
3195 "suite of tools, but by far not the only place changes to options can be "
3196 "made. All tools therefore share the configuration files and also use a "
3197 "common command line parser to provide a uniform environment."
3200 #. type: Content of: <refentry><refsect1><orderedlist><para>
3201 #: apt.conf.5.xml:47
3203 "When an APT tool starts up it will read the configuration files in the "
3207 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3208 #: apt.conf.5.xml:49
3210 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
3214 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3215 #: apt.conf.5.xml:51
3217 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
3218 "order which have either no or \"<literal>conf</literal>\" as filename "
3219 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
3220 "and period (.) characters. Otherwise APT will print a notice that it has "
3221 "ignored a file if the file doesn't match a pattern in the "
3222 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
3223 "case it will be silently ignored."
3226 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3227 #: apt.conf.5.xml:58
3228 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
3231 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3232 #: apt.conf.5.xml:60
3234 "the command line options are applied to override the configuration "
3235 "directives or to load even more configuration files."
3238 #. type: Content of: <refentry><refsect1><title>
3239 #: apt.conf.5.xml:64
3243 #. type: Content of: <refentry><refsect1><para>
3244 #: apt.conf.5.xml:65
3246 "The configuration file is organized in a tree with options organized into "
3247 "functional groups. Option specification is given with a double colon "
3248 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
3249 "within the APT tool group, for the Get tool. Options do not inherit from "
3250 "their parent groups."
3253 #. type: Content of: <refentry><refsect1><para>
3254 #: apt.conf.5.xml:71
3256 "Syntactically the configuration language is modeled after what the ISC tools "
3257 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
3258 "treated as comments (ignored), as well as all text between "
3259 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
3260 "Each line is of the form <literal>APT::Get::Assume-Yes "
3261 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
3262 "value must be on one line, and there is no kind of string concatenation. It "
3263 "must not include inside quotes. The behavior of the backslash \"\\\" and "
3264 "escaped characters inside a value is undefined and it should not be used. An "
3265 "option name may include alphanumerical characters and the \"/-:._+\" "
3266 "characters. A new scope can be opened with curly braces, like:"
3269 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3270 #: apt.conf.5.xml:85
3275 " Assume-Yes \"true\";\n"
3276 " Fix-Broken \"true\";\n"
3281 #. type: Content of: <refentry><refsect1><para>
3282 #: apt.conf.5.xml:93
3284 "with newlines placed to make it more readable. Lists can be created by "
3285 "opening a scope and including a single string enclosed in quotes followed by "
3286 "a semicolon. Multiple entries can be included, each separated by a "
3290 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3291 #: apt.conf.5.xml:98
3293 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
3296 #. type: Content of: <refentry><refsect1><para>
3297 #: apt.conf.5.xml:101
3299 "In general the sample configuration file in "
3300 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
3301 "guide for how it should look."
3304 #. type: Content of: <refentry><refsect1><para>
3305 #: apt.conf.5.xml:105
3307 "The names of the configuration items are not case-sensitive. So in the "
3308 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
3311 #. type: Content of: <refentry><refsect1><para>
3312 #: apt.conf.5.xml:108
3314 "Names for the configuration items are optional if a list is defined as it "
3315 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
3316 "above. If you don't specify a name a new entry will simply add a new option "
3317 "to the list. If you specify a name you can override the option as every "
3318 "other option by reassigning a new value to the option."
3321 #. type: Content of: <refentry><refsect1><para>
3322 #: apt.conf.5.xml:113
3324 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
3325 "and not supported by alternative implementations) and "
3326 "<literal>#clear</literal>: <literal>#include</literal> will include the "
3327 "given file, unless the filename ends in a slash, then the whole directory is "
3328 "included. <literal>#clear</literal> is used to erase a part of the "
3329 "configuration tree. The specified element and all its descendants are "
3330 "erased. (Note that these lines also need to end with a semicolon.)"
3333 #. type: Content of: <refentry><refsect1><para>
3334 #: apt.conf.5.xml:121
3336 "The #clear command is the only way to delete a list or a complete scope. "
3337 "Reopening a scope or the ::-style described below will "
3338 "<emphasis>not</emphasis> override previously written entries. Only options "
3339 "can be overridden by addressing a new value to it - lists and scopes can't "
3340 "be overridden, only cleared."
3343 #. type: Content of: <refentry><refsect1><para>
3344 #: apt.conf.5.xml:126
3346 "All of the APT tools take a -o option which allows an arbitrary "
3347 "configuration directive to be specified on the command line. The syntax is a "
3348 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
3349 "followed by an equals sign then the new value of the option. To append a new "
3350 "element to a list, add a trailing :: to the name of the list. (As you might "
3351 "suspect: The scope syntax can't be used on the command line.)"
3354 #. type: Content of: <refentry><refsect1><para>
3355 #: apt.conf.5.xml:133
3357 "Note that you can use :: only for appending one item per line to a list and "
3358 "that you should not use it in combination with the scope syntax. (The scope "
3359 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
3360 "which some users unfortunately depend on: An option with the unusual name "
3361 "\"<literal>::</literal>\" which acts like every other option with a "
3362 "name. These introduces many problems including that a user who writes "
3363 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
3364 "append to a list will gain the opposite as only the last assignment for this "
3365 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
3366 "raise errors and will stop working if they encounter this misuse, so please "
3367 "correct such statements now as long as APT doesn't complain explicit about "
3371 #. type: Content of: <refentry><refsect1><title>
3372 #: apt.conf.5.xml:145
3373 msgid "The APT Group"
3376 #. type: Content of: <refentry><refsect1><para>
3377 #: apt.conf.5.xml:146
3379 "This group of options controls general APT behavior as well as holding the "
3380 "options for all of the tools."
3383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3384 #: apt.conf.5.xml:151
3386 "System Architecture; sets the architecture to use when fetching files and "
3387 "parsing package lists. The internal default is the architecture apt was "
3391 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3392 #: apt.conf.5.xml:157
3394 "All Architectures the system supports. Processors implementing the "
3395 "<literal>amd64</literal> (also called <literal>x86-64</literal>) instruction "
3396 "set are e.g. also able to execute binaries compiled for the "
3397 "<literal>i386</literal> (<literal>x86</literal>) instruction set; This list "
3398 "is use when fetching files and parsing package lists. The internal default "
3399 "is always the native architecture (<literal>APT::Architecture</literal>) "
3400 "and all foreign architectures it can retrieve by calling <command>dpkg "
3401 "--print-foreign-architectures</command>."
3404 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3405 #: apt.conf.5.xml:167
3407 "Default release to install packages from if more than one version "
3408 "available. Contains release name, codename or release version. Examples: "
3409 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
3410 "'4.0', '5.0*'. See also &apt-preferences;."
3413 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3414 #: apt.conf.5.xml:173
3416 "Ignore Held packages; This global option causes the problem resolver to "
3417 "ignore held packages in its decision making."
3420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3421 #: apt.conf.5.xml:178
3423 "Defaults to on. When turned on the autoclean feature will remove any "
3424 "packages which can no longer be downloaded from the cache. If turned off "
3425 "then packages that are locally installed are also excluded from cleaning - "
3426 "but note that APT provides no direct means to reinstall them."
3429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3430 #: apt.conf.5.xml:185
3432 "Defaults to on which will cause APT to install essential and important "
3433 "packages as fast as possible in the install/upgrade operation. This is done "
3434 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
3435 "does treat an important package in the same way as an extra package: Between "
3436 "the unpacking of the important package A and his configuration can then be "
3437 "many other unpack or configuration calls, e.g. for package B which has no "
3438 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
3439 "script of package B generates an error) which results in a system state in "
3440 "which package A is unpacked but unconfigured - each package depending on A "
3441 "is now no longer guaranteed to work as their dependency on A is not longer "
3442 "satisfied. The immediate configuration marker is also applied to all "
3443 "dependencies which can generate a problem if the dependencies e.g. form a "
3444 "circle as a dependency with the immediate flag is comparable with a "
3445 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
3446 "in which it is unable to perform immediate configuration, errors out and "
3447 "refers to this option so the user can deactivate the immediate configuration "
3448 "temporarily to be able to perform an install/upgrade again. Note the use of "
3449 "the word \"theory\" here as this problem was only encountered by now in real "
3450 "world a few times in non-stable distribution versions and was caused by "
3451 "wrong dependencies of the package in question or by a system in an already "
3452 "broken state, so you should not blindly disable this option as the mentioned "
3453 "scenario above is not the only problem immediate configuration can help to "
3454 "prevent in the first place. Before a big operation like "
3455 "<literal>dist-upgrade</literal> is run with this option disabled it should "
3456 "be tried to explicitly <literal>install</literal> the package APT is unable "
3457 "to configure immediately, but please make sure to report your problem also "
3458 "to your distribution and to the APT team with the buglink below so they can "
3459 "work on improving or correcting the upgrade process."
3462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3463 #: apt.conf.5.xml:208
3465 "Never Enable this option unless you -really- know what you are doing. It "
3466 "permits APT to temporarily remove an essential package to break a "
3467 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
3468 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
3469 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
3470 "anything that those packages depend on."
3473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3474 #: apt.conf.5.xml:217
3476 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3477 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
3478 "to which size the Cache will grow and is therefore the amount of memory APT "
3479 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3480 "that this amount of space needs to be available for APT otherwise it will "
3481 "likely fail ungracefully, so for memory restricted devices this value should "
3482 "be lowered while on systems with a lot of configured sources it should be "
3483 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3484 "of 1048576 (~1 MB) how much the Cache size will be increased in the event "
3485 "the space defined by <literal>Cache-Start</literal> is not enough. These "
3486 "value will be applied again and again until either the cache is big enough "
3487 "to store all information or the size of the cache reaches the "
3488 "<literal>Cache-Limit</literal>. The default of "
3489 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3490 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
3494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3495 #: apt.conf.5.xml:233
3496 msgid "Defines which package(s) are considered essential build dependencies."
3499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3500 #: apt.conf.5.xml:237
3502 "The Get subsection controls the &apt-get; tool, please see its documentation "
3503 "for more information about the options here."
3506 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3507 #: apt.conf.5.xml:242
3509 "The Cache subsection controls the &apt-cache; tool, please see its "
3510 "documentation for more information about the options here."
3513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3514 #: apt.conf.5.xml:247
3516 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
3517 "documentation for more information about the options here."
3520 #. type: Content of: <refentry><refsect1><title>
3521 #: apt.conf.5.xml:253
3522 msgid "The Acquire Group"
3525 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3526 #: apt.conf.5.xml:259
3528 "Security related option defaulting to true as an expiring validation for a "
3529 "Release file prevents longtime replay attacks and can e.g. also help users "
3530 "to identify no longer updated mirrors - but the feature depends on the "
3531 "correctness of the time on the user system. Archive maintainers are "
3532 "encouraged to create Release files with the <literal>Valid-Until</literal> "
3533 "header, but if they don't or a stricter value is volitional the following "
3534 "<literal>Max-ValidTime</literal> option can be used."
3537 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3538 #: apt.conf.5.xml:270
3540 "Seconds the Release file should be considered valid after it was created "
3541 "(indicated by the <literal>Date</literal> header). If the Release file "
3542 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
3543 "the two is used as the expiration date. The default value is "
3544 "<literal>0</literal> which stands for \"for ever valid\". Archive specific "
3545 "settings can be made by appending the label of the archive to the option "
3549 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3550 #: apt.conf.5.xml:281
3552 "Minimum of seconds the Release file should be considered valid after it was "
3553 "created (indicated by the <literal>Date</literal> header). Use this if you "
3554 "need to use a seldomly updated (local) mirror of a more regular updated "
3555 "archive with a <literal>Valid-Until</literal> header instead of completely "
3556 "disabling the expiration date checking. Archive specific settings can and "
3557 "should be used by appending the label of the archive to the option name."
3560 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3561 #: apt.conf.5.xml:292
3563 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
3564 "Sources files instead of downloading whole ones. True by default."
3567 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3568 #: apt.conf.5.xml:295
3570 "Two sub-options to limit the use of PDiffs are also available: With "
3571 "<literal>FileLimit</literal> can be specified how many PDiff files are "
3572 "downloaded at most to update a file. <literal>SizeLimit</literal> on the "
3573 "other hand is the maximum percentage of the size of all patches compared to "
3574 "the size of the targeted file. If one of these limits is exceeded the "
3575 "complete file is downloaded instead of the patches."
3578 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3579 #: apt.conf.5.xml:305
3581 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3582 "<literal>host</literal> or <literal>access</literal> which determines how "
3583 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3584 "one connection per target host will be opened, <literal>access</literal> "
3585 "means that one connection per URI type will be opened."
3588 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3589 #: apt.conf.5.xml:313
3591 "Number of retries to perform. If this is non-zero APT will retry failed "
3592 "files the given number of times."
3595 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3596 #: apt.conf.5.xml:318
3598 "Use symlinks for source archives. If set to true then source archives will "
3599 "be symlinked when possible instead of copying. True is the default."
3602 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3603 #: apt.conf.5.xml:323
3605 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
3606 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
3607 "host proxies can also be specified by using the form "
3608 "<literal>http::Proxy::<host></literal> with the special keyword "
3609 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3610 "settings is specified, <envar>http_proxy</envar> environment variable will "
3614 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3615 #: apt.conf.5.xml:331
3617 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3618 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
3619 "response under any circumstances, <literal>Max-Age</literal> is sent only "
3620 "for index files and tells the cache to refresh its object if it is older "
3621 "than the given number of seconds. Debian updates its index files daily so "
3622 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
3623 "should never store this request, it is only set for archive files. This may "
3624 "be useful to prevent polluting a proxy cache with very large .deb "
3625 "files. Note: Squid 2.0.2 does not support any of these options."
3628 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3629 #: apt.conf.5.xml:341 apt.conf.5.xml:407
3631 "The option <literal>timeout</literal> sets the timeout timer used by the "
3632 "method, this applies to all things including connection timeout and data "
3636 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3637 #: apt.conf.5.xml:344
3639 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3640 "enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial "
3641 "e.g. on high-latency connections. It specifies how many requests are send in "
3642 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
3643 "the default value is now 0 (= disabled) to avoid problems with the "
3644 "ever-growing amount of webservers and proxies which choose to not conform to "
3645 "the HTTP/1.1 specification."
3648 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3649 #: apt.conf.5.xml:351
3651 "<literal>Acquire::http::AllowRedirect</literal> controls if APT will follow "
3652 "redirects, which is enabled by default."
3655 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3656 #: apt.conf.5.xml:354
3658 "The used bandwidth can be limited with "
3659 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3660 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
3661 "as much as possible of the bandwidth (Note that this option implicit "
3662 "deactivates the download from multiple servers at the same time.)"
3665 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3666 #: apt.conf.5.xml:359
3668 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3669 "User-Agent for the http download method as some proxies allow access for "
3670 "clients only if the client uses a known identifier."
3673 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3674 #: apt.conf.5.xml:366
3676 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
3677 "options are the same as for <literal>http</literal> method and will also "
3678 "default to the options from the <literal>http</literal> method if they are "
3679 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
3680 "not supported yet."
3683 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3684 #: apt.conf.5.xml:372
3686 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3687 "about trusted certificates. <literal><host>::CaInfo</literal> is "
3688 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3689 "suboption determines whether verify server's host certificate against "
3690 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
3691 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
3692 "suboption determines whether verify server's hostname or not. "
3693 "<literal><host>::Verify-Host</literal> is corresponding per-host "
3694 "option. <literal>SslCert</literal> determines what certificate to use for "
3695 "client authentication. <literal><host>::SslCert</literal> is "
3696 "corresponding per-host option. <literal>SslKey</literal> determines what "
3697 "private key to use for client "
3698 "authentication. <literal><host>::SslKey</literal> is corresponding "
3699 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3700 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
3701 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
3705 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3706 #: apt.conf.5.xml:391
3708 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
3709 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
3710 "proxies can also be specified by using the form "
3711 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3712 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3713 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3714 "used. To use a ftp proxy you will have to set the "
3715 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3716 "entry specifies the commands to send to tell the proxy server what to "
3717 "connect to. Please see &configureindex; for an example of how to do "
3718 "this. The substitution variables available are "
3719 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
3720 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
3721 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
3722 "from it's respective URI component."
3725 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3726 #: apt.conf.5.xml:410
3728 "Several settings are provided to control passive mode. Generally it is safe "
3729 "to leave passive mode on, it works in nearly every environment. However "
3730 "some situations require that passive mode be disabled and port mode ftp used "
3731 "instead. This can be done globally, for connections that go through a proxy "
3732 "or for a specific host (See the sample config file for examples)."
3735 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3736 #: apt.conf.5.xml:417
3738 "It is possible to proxy FTP over HTTP by setting the "
3739 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
3740 "discussion of the http method above for syntax. You cannot set this in the "
3741 "configuration file and it is not recommended to use FTP over HTTP due to its "
3745 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3746 #: apt.conf.5.xml:422
3748 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3749 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3750 "false, which means these commands are only used if the control connection is "
3751 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3752 "that most FTP servers do not support RFC2428."
3755 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3756 #: apt.conf.5.xml:435
3758 msgid "/cdrom/::Mount \"foo\";"
3761 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3762 #: apt.conf.5.xml:430
3764 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
3765 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
3766 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
3767 "provide alternate mount and unmount commands if your mount point cannot be "
3768 "listed in the fstab (such as an SMB mount and old mount packages). The "
3769 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3770 "cdrom block. It is important to have the trailing slash. Unmount commands "
3771 "can be specified using UMount."
3774 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3775 #: apt.conf.5.xml:441
3777 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
3778 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
3782 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3783 #: apt.conf.5.xml:452
3786 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3787 "\"<replaceable>Methodname</replaceable>\";"
3790 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3791 #: apt.conf.5.xml:447
3793 "List of compression types which are understood by the acquire methods. "
3794 "Files like <filename>Packages</filename> can be available in various "
3795 "compression formats. Per default the acquire methods can decompress "
3796 "<command>bzip2</command>, <command>lzma</command> and "
3797 "<command>gzip</command> compressed files, with this setting more formats can "
3798 "be added on the fly or the used method can be changed. The syntax for this "
3799 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3802 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3803 #: apt.conf.5.xml:457
3805 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3808 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3809 #: apt.conf.5.xml:460
3811 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3814 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3815 #: apt.conf.5.xml:453
3817 "Also the <literal>Order</literal> subgroup can be used to define in which "
3818 "order the acquire system will try to download the compressed files. The "
3819 "acquire system will try the first and proceed with the next compression type "
3820 "in this list on error, so to prefer one over the other type simple add the "
3821 "preferred type at first - not already added default types will be added at "
3822 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3823 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3824 "over <command>bzip2</command> and <command>lzma</command>. If "
3825 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3826 "<command>bzip2</command> the configure setting should look like this "
3827 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3828 "<literal>bz2</literal> explicit to the list as it will be added automatic."
3831 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3832 #: apt.conf.5.xml:464
3834 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3837 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3838 #: apt.conf.5.xml:462
3840 "Note that at run time the "
3841 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3842 "checked: If this setting exists the method will only be used if this file "
3843 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
3844 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
3845 "the command line will be added at the end of the list specified in the "
3846 "configuration files, but before the default entries. To prefer a type in "
3847 "this case over the ones specified in the configuration files you can set the "
3848 "option direct - not in list style. This will not override the defined list, "
3849 "it will only prefix the list with this type."
3852 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3853 #: apt.conf.5.xml:469
3855 "The special type <literal>uncompressed</literal> can be used to give "
3856 "uncompressed files a preference, but note that most archives don't provide "
3857 "uncompressed files so this is mostly only useable for local mirrors."
3860 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3861 #: apt.conf.5.xml:476
3863 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3864 "Sources, or Translations), keep them gzip compressed locally instead of "
3865 "unpacking them. This saves quite a lot of disk space at the expense of more "
3866 "CPU requirements when building the local package caches. False by default."
3869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3870 #: apt.conf.5.xml:484
3872 "The Languages subsection controls which <filename>Translation</filename> "
3873 "files are downloaded and in which order APT tries to display the "
3874 "Description-Translations. APT will try to display the first available "
3875 "Description in the Language which is listed at first. Languages can be "
3876 "defined with their short or long Languagecodes. Note that not all archives "
3877 "provide <filename>Translation</filename> files for every Language - "
3878 "especially the long Languagecodes are rare, so please inform you which ones "
3879 "are available before you set here impossible values."
3882 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
3883 #: apt.conf.5.xml:500
3885 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3888 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3889 #: apt.conf.5.xml:490
3891 "The default list includes \"environment\" and "
3892 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
3893 "will be replaced at runtime with the languagecodes extracted from the "
3894 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3895 "that these codes are not included twice in the list. If "
3896 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3897 "<filename>Translation-en</filename> file (if available) will be used. To "
3898 "force apt to use no Translation file use the setting "
3899 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3900 "another special meaning code which will stop the search for a fitting "
3901 "<filename>Translation</filename> file. This can be used by the system "
3902 "administrator to let APT know that it should download also this files "
3903 "without actually use them if the environment doesn't specify this "
3904 "languages. So the following example configuration will result in the order "
3905 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
3906 "that \"fr\" is downloaded, but not used if APT is not used in a french "
3907 "localization, in such an environment the order would be \"fr, de, en\". "
3908 "<placeholder type=\"programlisting\" id=\"0\"/>"
3911 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3912 #: apt.conf.5.xml:501
3914 "Note: To prevent problems resulting from APT being executed in different "
3915 "environments (e.g. by different users or by other programs) all Translation "
3916 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3917 "added to the end of the list (after an implicit "
3918 "\"<literal>none</literal>\")."
3921 #. type: Content of: <refentry><refsect1><para>
3922 #: apt.conf.5.xml:254
3924 "The <literal>Acquire</literal> group of options controls the download of "
3925 "packages and the URI handlers. <placeholder type=\"variablelist\" "
3929 #. type: Content of: <refentry><refsect1><title>
3930 #: apt.conf.5.xml:512
3934 #. type: Content of: <refentry><refsect1><para>
3935 #: apt.conf.5.xml:514
3937 "The <literal>Dir::State</literal> section has directories that pertain to "
3938 "local state information. <literal>lists</literal> is the directory to place "
3939 "downloaded package lists in and <literal>status</literal> is the name of the "
3940 "dpkg status file. <literal>preferences</literal> is the name of the APT "
3941 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3942 "contains the default directory to prefix on all sub items if they do not "
3943 "start with <filename>/</filename> or <filename>./</filename>."
3946 #. type: Content of: <refentry><refsect1><para>
3947 #: apt.conf.5.xml:521
3949 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3950 "information, such as the two package caches <literal>srcpkgcache</literal> "
3951 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3952 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3953 "be turned off by setting their names to be blank. This will slow down "
3954 "startup but save disk space. It is probably preferred to turn off the "
3955 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3956 "default directory is contained in <literal>Dir::Cache</literal>"
3959 #. type: Content of: <refentry><refsect1><para>
3960 #: apt.conf.5.xml:530
3962 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3963 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3964 "<literal>main</literal> is the default configuration file (setting has no "
3965 "effect, unless it is done from the config file specified by "
3966 "<envar>APT_CONFIG</envar>)."
3969 #. type: Content of: <refentry><refsect1><para>
3970 #: apt.conf.5.xml:536
3972 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3973 "in lexical order from the directory specified. After this is done then the "
3974 "main config file is loaded."
3977 #. type: Content of: <refentry><refsect1><para>
3978 #: apt.conf.5.xml:540
3980 "Binary programs are pointed to by "
3981 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3982 "the location of the method handlers and <literal>gzip</literal>, "
3983 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3984 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3985 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3986 "specify the location of the respective programs."
3989 #. type: Content of: <refentry><refsect1><para>
3990 #: apt.conf.5.xml:548
3992 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3993 "set, all paths in <literal>Dir::</literal> will be relative to "
3994 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3995 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3996 "set to <filename>/tmp/staging</filename> and "
3997 "<literal>Dir::State::status</literal> is set to "
3998 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3999 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
4002 #. type: Content of: <refentry><refsect1><para>
4003 #: apt.conf.5.xml:561
4005 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
4006 "which files APT should silently ignore while parsing the files in the "
4007 "fragment directories. Per default a file which end with "
4008 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
4009 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
4010 "default value these patterns can use regular expression syntax."
4013 #. type: Content of: <refentry><refsect1><title>
4014 #: apt.conf.5.xml:570
4015 msgid "APT in DSelect"
4018 #. type: Content of: <refentry><refsect1><para>
4019 #: apt.conf.5.xml:572
4021 "When APT is used as a &dselect; method several configuration directives "
4022 "control the default behaviour. These are in the <literal>DSelect</literal> "
4026 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4027 #: apt.conf.5.xml:577
4029 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
4030 "and never. always and prompt will remove all packages from the cache after "
4031 "upgrading, prompt (the default) does so conditionally. auto removes only "
4032 "those packages which are no longer downloadable (replaced with a new version "
4033 "for instance). pre-auto performs this action before downloading new "
4037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4038 #: apt.conf.5.xml:586
4040 "The contents of this variable is passed to &apt-get; as command line options "
4041 "when it is run for the install phase."
4044 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4045 #: apt.conf.5.xml:591
4047 "The contents of this variable is passed to &apt-get; as command line options "
4048 "when it is run for the update phase."
4051 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4052 #: apt.conf.5.xml:596
4054 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
4055 "The default is to prompt only on error."
4058 #. type: Content of: <refentry><refsect1><title>
4059 #: apt.conf.5.xml:602
4060 msgid "How APT calls dpkg"
4063 #. type: Content of: <refentry><refsect1><para>
4064 #: apt.conf.5.xml:603
4066 "Several configuration directives control how APT invokes &dpkg;. These are "
4067 "in the <literal>DPkg</literal> section."
4070 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4071 #: apt.conf.5.xml:608
4073 "This is a list of options to pass to dpkg. The options must be specified "
4074 "using the list notation and each list item is passed as a single argument to "
4078 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4079 #: apt.conf.5.xml:614
4081 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
4082 "<literal>options</literal> this must be specified in list notation. The "
4083 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4084 "fail APT will abort."
4087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4088 #: apt.conf.5.xml:621
4090 "This is a list of shell commands to run before invoking dpkg. Like "
4091 "<literal>options</literal> this must be specified in list notation. The "
4092 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4093 "fail APT will abort. APT will pass to the commands on standard input the "
4094 "filenames of all .deb files it is going to install, one per line."
4097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4098 #: apt.conf.5.xml:627
4100 "Version 2 of this protocol dumps more information, including the protocol "
4101 "version, the APT configuration space and the packages, files and versions "
4102 "being changed. Version 2 is enabled by setting "
4103 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
4104 "2. <literal>cmd</literal> is a command given to "
4105 "<literal>Pre-Install-Pkgs</literal>."
4108 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4109 #: apt.conf.5.xml:635
4111 "APT chdirs to this directory before invoking dpkg, the default is "
4112 "<filename>/</filename>."
4115 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4116 #: apt.conf.5.xml:640
4118 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
4119 "default is to disable signing and produce all binaries."
4122 #. type: Content of: <refentry><refsect1><refsect2><title>
4123 #: apt.conf.5.xml:645
4124 msgid "dpkg trigger usage (and related options)"
4127 #. type: Content of: <refentry><refsect1><refsect2><para>
4128 #: apt.conf.5.xml:646
4130 "APT can call dpkg in a way so it can make aggressive use of triggers over "
4131 "multiple calls of dpkg. Without further options dpkg will use triggers only "
4132 "in between his own run. Activating these options can therefore decrease the "
4133 "time needed to perform the install / upgrade. Note that it is intended to "
4134 "activate these options per default in the future, but as it changes the way "
4135 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
4136 "options are therefore currently experimental and should not be used in "
4137 "productive environments.</emphasis> Also it breaks the progress reporting so "
4138 "all frontends will currently stay around half (or more) of the time in the "
4139 "100% state while it actually configures all packages."
4142 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
4143 #: apt.conf.5.xml:661
4146 "DPkg::NoTriggers \"true\";\n"
4147 "PackageManager::Configure \"smart\";\n"
4148 "DPkg::ConfigurePending \"true\";\n"
4149 "DPkg::TriggersPending \"true\";"
4152 #. type: Content of: <refentry><refsect1><refsect2><para>
4153 #: apt.conf.5.xml:655
4155 "Note that it is not guaranteed that APT will support these options or that "
4156 "these options will not cause (big) trouble in the future. If you have "
4157 "understand the current risks and problems with these options, but are brave "
4158 "enough to help testing them create a new configuration file and test a "
4159 "combination of options. Please report any bugs, problems and improvements "
4160 "you encounter and make sure to note which options you have used in your "
4161 "reports. Asking dpkg for help could also be useful for debugging proposes, "
4162 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
4163 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
4166 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4167 #: apt.conf.5.xml:668
4169 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
4170 "call). See &dpkg; if you are interested in what this actually means. In "
4171 "short: dpkg will not run the triggers when this flag is present unless it is "
4172 "explicitly called to do so in an extra call. Note that this option exists "
4173 "(undocumented) also in older apt versions with a slightly different meaning: "
4174 "Previously these option only append --no-triggers to the configure calls to "
4175 "dpkg - now apt will add these flag also to the unpack and remove calls."
4178 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4179 #: apt.conf.5.xml:676
4181 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
4182 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
4183 "value and causes APT to configure all packages explicit. The "
4184 "\"<literal>smart</literal>\" way is it to configure only packages which need "
4185 "to be configured before another package can be unpacked (Pre-Depends) and "
4186 "let the rest configure by dpkg with a call generated by the next "
4187 "option. \"<literal>no</literal>\" on the other hand will not configure "
4188 "anything and totally rely on dpkg for configuration (which will at the "
4189 "moment fail if a Pre-Depends is encountered). Setting this option to "
4190 "another than the all value will implicitly activate also the next option per "
4191 "default as otherwise the system could end in an unconfigured status which "
4192 "could be unbootable!"
4195 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4196 #: apt.conf.5.xml:687
4198 "If this option is set apt will call <command>dpkg --configure "
4199 "--pending</command> to let dpkg handle all required configurations and "
4200 "triggers. This option is activated automatic per default if the previous "
4201 "option is not set to <literal>all</literal>, but deactivating could be "
4202 "useful if you want to run APT multiple times in a row - e.g. in an "
4203 "installer. In these sceneries you could deactivate this option in all but "
4207 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4208 #: apt.conf.5.xml:694
4210 "Useful for <literal>smart</literal> configuration as a package which has "
4211 "pending triggers is not considered as <literal>installed</literal> and dpkg "
4212 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
4213 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
4214 "triggers, not only the triggers needed to configure this package."
4217 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4218 #: apt.conf.5.xml:700
4220 "As the configuration can be deferred to be done at the end by dpkg it can be "
4221 "tried to order the unpack series only by critical needs, e.g. by "
4222 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
4223 "various steps by everything. While both method were present in earlier APT "
4224 "versions the <literal>OrderCritical</literal> method was unused, so this "
4225 "method is very experimental and needs further improvements before becoming "
4229 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
4230 #: apt.conf.5.xml:715
4233 "OrderList::Score {\n"
4235 "\tEssential 200;\n"
4237 "\tPreDepends 50;\n"
4241 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4242 #: apt.conf.5.xml:708
4244 "Essential packages (and there dependencies) should be configured immediately "
4245 "after unpacking. It will be a good idea to do this quite early in the "
4246 "upgrade process as these these configure calls require currently also "
4247 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
4248 "(which maybe not needed). Essentials get per default a high score but the "
4249 "immediate flag is relatively low (a package which has a Pre-Depends is "
4250 "higher rated). These option and the others in the same group can be used to "
4251 "change the scoring. The following example shows the settings with there "
4252 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
4255 #. type: Content of: <refentry><refsect1><title>
4256 #: apt.conf.5.xml:728
4257 msgid "Periodic and Archives options"
4260 #. type: Content of: <refentry><refsect1><para>
4261 #: apt.conf.5.xml:729
4263 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
4264 "of options configure behavior of apt periodic updates, which is done by "
4265 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
4266 "the brief documentation of these options."
4269 #. type: Content of: <refentry><refsect1><title>
4270 #: apt.conf.5.xml:737
4271 msgid "Debug options"
4274 #. type: Content of: <refentry><refsect1><para>
4275 #: apt.conf.5.xml:739
4277 "Enabling options in the <literal>Debug::</literal> section will cause "
4278 "debugging information to be sent to the standard error stream of the program "
4279 "utilizing the <literal>apt</literal> libraries, or enable special program "
4280 "modes that are primarily useful for debugging the behavior of "
4281 "<literal>apt</literal>. Most of these options are not interesting to a "
4282 "normal user, but a few may be:"
4285 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4286 #: apt.conf.5.xml:750
4288 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
4289 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
4293 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4294 #: apt.conf.5.xml:758
4296 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
4297 "used to run some operations (for instance, <literal>apt-get -s "
4298 "install</literal>) as a non-root user."
4301 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4302 #: apt.conf.5.xml:767
4304 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
4305 "time that <literal>apt</literal> invokes &dpkg;."
4309 #. motivating example, except I haven't a clue why you'd want
4311 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4312 #: apt.conf.5.xml:775
4314 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
4318 #. type: Content of: <refentry><refsect1><para>
4319 #: apt.conf.5.xml:785
4320 msgid "A full list of debugging options to apt follows."
4323 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4324 #: apt.conf.5.xml:794
4325 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
4328 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4329 #: apt.conf.5.xml:805
4330 msgid "Print information related to downloading packages using FTP."
4333 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4334 #: apt.conf.5.xml:816
4335 msgid "Print information related to downloading packages using HTTP."
4338 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4339 #: apt.conf.5.xml:827
4340 msgid "Print information related to downloading packages using HTTPS."
4343 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4344 #: apt.conf.5.xml:838
4346 "Print information related to verifying cryptographic signatures using "
4347 "<literal>gpg</literal>."
4350 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4351 #: apt.conf.5.xml:849
4353 "Output information about the process of accessing collections of packages "
4354 "stored on CD-ROMs."
4357 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4358 #: apt.conf.5.xml:859
4359 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4362 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4363 #: apt.conf.5.xml:869
4365 "Output each cryptographic hash that is generated by the "
4366 "<literal>apt</literal> libraries."
4369 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4370 #: apt.conf.5.xml:879
4372 "Do not include information from <literal>statfs</literal>, namely the number "
4373 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4377 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4378 #: apt.conf.5.xml:890
4380 "Disable all file locking. For instance, this will allow two instances of "
4381 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4384 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4385 #: apt.conf.5.xml:902
4386 msgid "Log when items are added to or removed from the global download queue."
4389 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4390 #: apt.conf.5.xml:912
4392 "Output status messages and errors related to verifying checksums and "
4393 "cryptographic signatures of downloaded files."
4396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4397 #: apt.conf.5.xml:922
4399 "Output information about downloading and applying package index list diffs, "
4400 "and errors relating to package index list diffs."
4403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4404 #: apt.conf.5.xml:934
4406 "Output information related to patching apt package lists when downloading "
4407 "index diffs instead of full indices."
4410 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4411 #: apt.conf.5.xml:945
4412 msgid "Log all interactions with the sub-processes that actually perform downloads."
4415 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4416 #: apt.conf.5.xml:956
4418 "Log events related to the automatically-installed status of packages and to "
4419 "the removal of unused packages."
4422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4423 #: apt.conf.5.xml:966
4425 "Generate debug messages describing which packages are being automatically "
4426 "installed to resolve dependencies. This corresponds to the initial "
4427 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4428 "and not to the full <literal>apt</literal> dependency resolver; see "
4429 "<literal>Debug::pkgProblemResolver</literal> for that."
4432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4433 #: apt.conf.5.xml:980
4435 "Generate debug messages describing which package is marked as "
4436 "keep/install/remove while the ProblemResolver does his work. Each addition "
4437 "or deletion may trigger additional actions; they are shown indented two "
4438 "additional space under the original entry. The format for each line is "
4439 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4440 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4441 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4442 "is the current version of the package, <literal>d.e.f</literal> is the "
4443 "version considered for installation and <literal>x.y.z</literal> is a newer "
4444 "version, but not considered for installation (because of a low pin "
4445 "score). The later two can be omitted if there is none or if it is the same "
4446 "version as the installed. <literal>section</literal> is the name of the "
4447 "section the package appears in."
4450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4451 #: apt.conf.5.xml:1002
4452 msgid "Dump the default configuration to standard error on startup."
4455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4456 #: apt.conf.5.xml:1012
4458 "When invoking &dpkg;, output the precise command line with which it is being "
4459 "invoked, with arguments separated by a single space character."
4462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4463 #: apt.conf.5.xml:1023
4465 "Output all the data received from &dpkg; on the status file descriptor and "
4466 "any errors encountered while parsing it."
4469 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4470 #: apt.conf.5.xml:1034
4472 "Generate a trace of the algorithm that decides the order in which "
4473 "<literal>apt</literal> should pass packages to &dpkg;."
4476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4477 #: apt.conf.5.xml:1046
4478 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4482 #: apt.conf.5.xml:1057
4483 msgid "Output the priority of each package list on startup."
4486 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4487 #: apt.conf.5.xml:1067
4489 "Trace the execution of the dependency resolver (this applies only to what "
4490 "happens when a complex dependency problem is encountered)."
4493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4494 #: apt.conf.5.xml:1078
4496 "Display a list of all installed packages with their calculated score used by "
4497 "the pkgProblemResolver. The description of the package is the same as "
4498 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4502 #: apt.conf.5.xml:1090
4504 "Print information about the vendors read from "
4505 "<filename>/etc/apt/vendors.list</filename>."
4508 #. type: Content of: <refentry><refsect1><para>
4509 #: apt.conf.5.xml:1113
4511 "&configureindex; is a configuration file showing example values for all "
4515 #. type: Content of: <refentry><refsect1><variablelist>
4516 #: apt.conf.5.xml:1120
4517 msgid "&file-aptconf;"
4520 #. ? reading apt.conf
4521 #. type: Content of: <refentry><refsect1><para>
4522 #: apt.conf.5.xml:1125
4523 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4526 #. type: Content of: <refentry><refnamediv><refpurpose>
4527 #: apt_preferences.5.xml:32
4528 msgid "Preference control file for APT"
4531 #. type: Content of: <refentry><refsect1><para>
4532 #: apt_preferences.5.xml:37
4534 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4535 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4536 "can be used to control which versions of packages will be selected for "
4540 #. type: Content of: <refentry><refsect1><para>
4541 #: apt_preferences.5.xml:42
4543 "Several versions of a package may be available for installation when the "
4544 "&sources-list; file contains references to more than one distribution (for "
4545 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4546 "assigns a priority to each version that is available. Subject to dependency "
4547 "constraints, <command>apt-get</command> selects the version with the highest "
4548 "priority for installation. The APT preferences file overrides the "
4549 "priorities that APT assigns to package versions by default, thus giving the "
4550 "user control over which one is selected for installation."
4553 #. type: Content of: <refentry><refsect1><para>
4554 #: apt_preferences.5.xml:52
4556 "Several instances of the same version of a package may be available when the "
4557 "&sources-list; file contains references to more than one source. In this "
4558 "case <command>apt-get</command> downloads the instance listed earliest in "
4559 "the &sources-list; file. The APT preferences file does not affect the "
4560 "choice of instance, only the choice of version."
4563 #. type: Content of: <refentry><refsect1><para>
4564 #: apt_preferences.5.xml:59
4566 "Preferences are a strong power in the hands of a system administrator but "
4567 "they can become also their biggest nightmare if used without care! APT will "
4568 "not questioning the preferences so wrong settings will therefore lead to "
4569 "uninstallable packages or wrong decisions while upgrading packages. Even "
4570 "more problems will arise if multiply distribution releases are mixed without "
4571 "a good understanding of the following paragraphs. Packages included in a "
4572 "specific release aren't tested in and therefore doesn't always work as "
4573 "expected in older or newer releases or together with other packages from "
4574 "different releases. You have been warned."
4577 #. type: Content of: <refentry><refsect1><para>
4578 #: apt_preferences.5.xml:70
4580 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4581 "directory are parsed in alphanumeric ascending order and need to obey the "
4582 "following naming convention: The files have either no or "
4583 "\"<literal>pref</literal>\" as filename extension and only contain "
4584 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4585 "Otherwise APT will print a notice that it has ignored a file if the file "
4586 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4587 "configuration list - in this case it will be silently ignored."
4590 #. type: Content of: <refentry><refsect1><refsect2><title>
4591 #: apt_preferences.5.xml:79
4592 msgid "APT's Default Priority Assignments"
4595 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4596 #: apt_preferences.5.xml:94
4599 "<command>apt-get install -t testing "
4600 "<replaceable>some-package</replaceable></command>\n"
4603 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4604 #: apt_preferences.5.xml:97
4606 msgid "APT::Default-Release \"stable\";\n"
4609 #. type: Content of: <refentry><refsect1><refsect2><para>
4610 #: apt_preferences.5.xml:81
4612 "If there is no preferences file or if there is no entry in the file that "
4613 "applies to a particular version then the priority assigned to that version "
4614 "is the priority of the distribution to which that version belongs. It is "
4615 "possible to single out a distribution, \"the target release\", which "
4616 "receives a higher priority than other distributions do by default. The "
4617 "target release can be set on the <command>apt-get</command> command line or "
4618 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4619 "that this has precedence over any general priority you set in the "
4620 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4621 "specifically pinned packages. For example, <placeholder "
4622 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4626 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4627 #: apt_preferences.5.xml:106
4631 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4632 #: apt_preferences.5.xml:107
4634 "to the versions coming from archives which in their "
4635 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4636 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
4637 "<literal>experimental</literal> archive."
4640 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4641 #: apt_preferences.5.xml:113
4642 msgid "priority 100"
4645 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4646 #: apt_preferences.5.xml:114
4648 "to the version that is already installed (if any) and to the versions coming "
4649 "from archives which in their <filename>Release</filename> files are marked "
4650 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
4651 "backports archive since <literal>squeeze-backports</literal>."
4654 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4655 #: apt_preferences.5.xml:121
4656 msgid "priority 500"
4659 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4660 #: apt_preferences.5.xml:122
4662 "to the versions that are not installed and do not belong to the target "
4666 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4667 #: apt_preferences.5.xml:126
4668 msgid "priority 990"
4671 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4672 #: apt_preferences.5.xml:127
4673 msgid "to the versions that are not installed and belong to the target release."
4676 #. type: Content of: <refentry><refsect1><refsect2><para>
4677 #: apt_preferences.5.xml:101
4679 "If the target release has been specified then APT uses the following "
4680 "algorithm to set the priorities of the versions of a package. Assign: "
4681 "<placeholder type=\"variablelist\" id=\"0\"/>"
4684 #. type: Content of: <refentry><refsect1><refsect2><para>
4685 #: apt_preferences.5.xml:132
4687 "If the target release has not been specified then APT simply assigns "
4688 "priority 100 to all installed package versions and priority 500 to all "
4689 "uninstalled package versions, except versions coming from archives which in "
4690 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4691 "- these versions get the priority 1 or priority 100 if it is additionally "
4692 "marked as \"ButAutomaticUpgrades: yes\"."
4695 #. type: Content of: <refentry><refsect1><refsect2><para>
4696 #: apt_preferences.5.xml:139
4698 "APT then applies the following rules, listed in order of precedence, to "
4699 "determine which version of a package to install."
4702 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4703 #: apt_preferences.5.xml:142
4705 "Never downgrade unless the priority of an available version exceeds 1000. "
4706 "(\"Downgrading\" is installing a less recent version of a package in place "
4707 "of a more recent version. Note that none of APT's default priorities "
4708 "exceeds 1000; such high priorities can only be set in the preferences file. "
4709 "Note also that downgrading a package can be risky.)"
4712 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4713 #: apt_preferences.5.xml:148
4714 msgid "Install the highest priority version."
4717 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4718 #: apt_preferences.5.xml:149
4720 "If two or more versions have the same priority, install the most recent one "
4721 "(that is, the one with the higher version number)."
4724 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4725 #: apt_preferences.5.xml:152
4727 "If two or more versions have the same priority and version number but either "
4728 "the packages differ in some of their metadata or the "
4729 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4732 #. type: Content of: <refentry><refsect1><refsect2><para>
4733 #: apt_preferences.5.xml:158
4735 "In a typical situation, the installed version of a package (priority 100) "
4736 "is not as recent as one of the versions available from the sources listed in "
4737 "the &sources-list; file (priority 500 or 990). Then the package will be "
4738 "upgraded when <command>apt-get install "
4739 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4740 "upgrade</command> is executed."
4743 #. type: Content of: <refentry><refsect1><refsect2><para>
4744 #: apt_preferences.5.xml:165
4746 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4747 "recent than any of the other available versions. The package will not be "
4748 "downgraded when <command>apt-get install "
4749 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4750 "upgrade</command> is executed."
4753 #. type: Content of: <refentry><refsect1><refsect2><para>
4754 #: apt_preferences.5.xml:170
4756 "Sometimes the installed version of a package is more recent than the version "
4757 "belonging to the target release, but not as recent as a version belonging to "
4758 "some other distribution. Such a package will indeed be upgraded when "
4759 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4760 "or <command>apt-get upgrade</command> is executed, because at least "
4761 "<emphasis>one</emphasis> of the available versions has a higher priority "
4762 "than the installed version."
4765 #. type: Content of: <refentry><refsect1><refsect2><title>
4766 #: apt_preferences.5.xml:179
4767 msgid "The Effect of APT Preferences"
4770 #. type: Content of: <refentry><refsect1><refsect2><para>
4771 #: apt_preferences.5.xml:181
4773 "The APT preferences file allows the system administrator to control the "
4774 "assignment of priorities. The file consists of one or more multi-line "
4775 "records separated by blank lines. Records can have one of two forms, a "
4776 "specific form and a general form."
4779 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4780 #: apt_preferences.5.xml:187
4782 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4783 "specified packages and specified version or version range. For example, the "
4784 "following record assigns a high priority to all versions of the "
4785 "<filename>perl</filename> package whose version number begins with "
4786 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
4789 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4790 #: apt_preferences.5.xml:194
4794 "Pin: version 5.8*\n"
4795 "Pin-Priority: 1001\n"
4798 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4799 #: apt_preferences.5.xml:200
4801 "The general form assigns a priority to all of the package versions in a "
4802 "given distribution (that is, to all the versions of packages that are listed "
4803 "in a certain <filename>Release</filename> file) or to all of the package "
4804 "versions coming from a particular Internet site, as identified by the site's "
4805 "fully qualified domain name."
4808 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4809 #: apt_preferences.5.xml:206
4811 "This general-form entry in the APT preferences file applies only to groups "
4812 "of packages. For example, the following record assigns a high priority to "
4813 "all package versions available from the local site."
4816 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4817 #: apt_preferences.5.xml:211
4821 "Pin: origin \"\"\n"
4822 "Pin-Priority: 999\n"
4825 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4826 #: apt_preferences.5.xml:216
4828 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4829 "which can be used to match a hostname. The following record will assign a "
4830 "high priority to all versions available from the server identified by the "
4831 "hostname \"ftp.de.debian.org\""
4834 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4835 #: apt_preferences.5.xml:220
4839 "Pin: origin \"ftp.de.debian.org\"\n"
4840 "Pin-Priority: 999\n"
4843 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4844 #: apt_preferences.5.xml:224
4846 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4847 "distribution as specified in a <filename>Release</filename> file. What "
4848 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4849 "Internet address but an author or vendor name, such as \"Debian\" or "
4853 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4854 #: apt_preferences.5.xml:229
4856 "The following record assigns a low priority to all package versions "
4857 "belonging to any distribution whose Archive name is "
4858 "\"<literal>unstable</literal>\"."
4861 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4862 #: apt_preferences.5.xml:233
4866 "Pin: release a=unstable\n"
4867 "Pin-Priority: 50\n"
4870 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4871 #: apt_preferences.5.xml:238
4873 "The following record assigns a high priority to all package versions "
4874 "belonging to any distribution whose Codename is "
4875 "\"<literal>&testing-codename;</literal>\"."
4878 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4879 #: apt_preferences.5.xml:242
4883 "Pin: release n=&testing-codename;\n"
4884 "Pin-Priority: 900\n"
4887 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4888 #: apt_preferences.5.xml:247
4890 "The following record assigns a high priority to all package versions "
4891 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4892 "and whose release Version number is \"<literal>3.0</literal>\"."
4895 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4896 #: apt_preferences.5.xml:252
4900 "Pin: release a=stable, v=3.0\n"
4901 "Pin-Priority: 500\n"
4904 #. type: Content of: <refentry><refsect1><refsect2><title>
4905 #: apt_preferences.5.xml:262
4906 msgid "Regular expressions and glob() syntax"
4909 #. type: Content of: <refentry><refsect1><refsect2><para>
4910 #: apt_preferences.5.xml:264
4912 "APT also supports pinning by glob() expressions and regular expressions "
4913 "surrounded by /. For example, the following example assigns the priority 500 "
4914 "to all packages from experimental where the name starts with gnome (as a "
4915 "glob()-like expression) or contains the word kde (as a POSIX extended "
4916 "regular expression surrounded by slashes)."
4919 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4920 #: apt_preferences.5.xml:273
4923 "Package: gnome* /kde/\n"
4924 "Pin: release n=experimental\n"
4925 "Pin-Priority: 500\n"
4928 #. type: Content of: <refentry><refsect1><refsect2><para>
4929 #: apt_preferences.5.xml:279
4931 "The rule for those expressions is that they can occur anywhere where a "
4932 "string can occur. Thus, the following pin assigns the priority 990 to all "
4933 "packages from a release starting with karmic."
4936 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4937 #: apt_preferences.5.xml:285
4941 "Pin: release n=karmic*\n"
4942 "Pin-Priority: 990\n"
4945 #. type: Content of: <refentry><refsect1><refsect2><para>
4946 #: apt_preferences.5.xml:291
4948 "If a regular expression occurs in a <literal>Package</literal> field, the "
4949 "behavior is the same as if this regular expression were replaced with a list "
4950 "of all package names it matches. It is undecided whether this will change in "
4951 "the future, thus you should always list wild-card pins first, so later "
4952 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4953 "Package field is not considered a glob() expression in itself."
4956 #. type: Content of: <refentry><refsect1><refsect2><title>
4957 #: apt_preferences.5.xml:307
4958 msgid "How APT Interprets Priorities"
4961 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4962 #: apt_preferences.5.xml:315
4966 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4967 #: apt_preferences.5.xml:316
4969 "causes a version to be installed even if this constitutes a downgrade of the "
4973 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4974 #: apt_preferences.5.xml:320
4975 msgid "990 < P <=1000"
4978 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4979 #: apt_preferences.5.xml:321
4981 "causes a version to be installed even if it does not come from the target "
4982 "release, unless the installed version is more recent"
4985 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4986 #: apt_preferences.5.xml:326
4987 msgid "500 < P <=990"
4990 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4991 #: apt_preferences.5.xml:327
4993 "causes a version to be installed unless there is a version available "
4994 "belonging to the target release or the installed version is more recent"
4997 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4998 #: apt_preferences.5.xml:332
4999 msgid "100 < P <=500"
5002 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5003 #: apt_preferences.5.xml:333
5005 "causes a version to be installed unless there is a version available "
5006 "belonging to some other distribution or the installed version is more recent"
5009 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5010 #: apt_preferences.5.xml:338
5011 msgid "0 < P <=100"
5014 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5015 #: apt_preferences.5.xml:339
5017 "causes a version to be installed only if there is no installed version of "
5021 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5022 #: apt_preferences.5.xml:343
5026 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5027 #: apt_preferences.5.xml:344
5028 msgid "prevents the version from being installed"
5031 #. type: Content of: <refentry><refsect1><refsect2><para>
5032 #: apt_preferences.5.xml:310
5034 "Priorities (P) assigned in the APT preferences file must be positive or "
5035 "negative integers. They are interpreted as follows (roughly speaking): "
5036 "<placeholder type=\"variablelist\" id=\"0\"/>"
5039 #. type: Content of: <refentry><refsect1><refsect2><para>
5040 #: apt_preferences.5.xml:349
5042 "If any specific-form records match an available package version then the "
5043 "first such record determines the priority of the package version. Failing "
5044 "that, if any general-form records match an available package version then "
5045 "the first such record determines the priority of the package version."
5048 #. type: Content of: <refentry><refsect1><refsect2><para>
5049 #: apt_preferences.5.xml:355
5051 "For example, suppose the APT preferences file contains the three records "
5052 "presented earlier:"
5055 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5056 #: apt_preferences.5.xml:359
5060 "Pin: version 5.8*\n"
5061 "Pin-Priority: 1001\n"
5064 "Pin: origin \"\"\n"
5065 "Pin-Priority: 999\n"
5068 "Pin: release unstable\n"
5069 "Pin-Priority: 50\n"
5072 #. type: Content of: <refentry><refsect1><refsect2><para>
5073 #: apt_preferences.5.xml:372
5077 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5078 #: apt_preferences.5.xml:374
5080 "The most recent available version of the <literal>perl</literal> package "
5081 "will be installed, so long as that version's version number begins with "
5082 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
5083 "<literal>perl</literal> is available and the installed version is 5.9*, then "
5084 "<literal>perl</literal> will be downgraded."
5087 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5088 #: apt_preferences.5.xml:379
5090 "A version of any package other than <literal>perl</literal> that is "
5091 "available from the local system has priority over other versions, even "
5092 "versions belonging to the target release."
5095 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5096 #: apt_preferences.5.xml:383
5098 "A version of a package whose origin is not the local system but some other "
5099 "site listed in &sources-list; and which belongs to an "
5100 "<literal>unstable</literal> distribution is only installed if it is selected "
5101 "for installation and no version of the package is already installed."
5104 #. type: Content of: <refentry><refsect1><refsect2><title>
5105 #: apt_preferences.5.xml:393
5106 msgid "Determination of Package Version and Distribution Properties"
5109 #. type: Content of: <refentry><refsect1><refsect2><para>
5110 #: apt_preferences.5.xml:395
5112 "The locations listed in the &sources-list; file should provide "
5113 "<filename>Packages</filename> and <filename>Release</filename> files to "
5114 "describe the packages available at that location."
5117 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5118 #: apt_preferences.5.xml:407
5119 msgid "the <literal>Package:</literal> line"
5122 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5123 #: apt_preferences.5.xml:408
5124 msgid "gives the package name"
5127 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5128 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
5129 msgid "the <literal>Version:</literal> line"
5132 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5133 #: apt_preferences.5.xml:412
5134 msgid "gives the version number for the named package"
5137 #. type: Content of: <refentry><refsect1><refsect2><para>
5138 #: apt_preferences.5.xml:399
5140 "The <filename>Packages</filename> file is normally found in the directory "
5141 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
5143 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
5144 "consists of a series of multi-line records, one for each package available "
5145 "in that directory. Only two lines in each record are relevant for setting "
5146 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
5149 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5150 #: apt_preferences.5.xml:428
5151 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
5154 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5155 #: apt_preferences.5.xml:429
5157 "names the archive to which all the packages in the directory tree belong. "
5158 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
5159 "that all of the packages in the directory tree below the parent of the "
5160 "<filename>Release</filename> file are in a <literal>stable</literal> "
5161 "archive. Specifying this value in the APT preferences file would require "
5165 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5166 #: apt_preferences.5.xml:439
5168 msgid "Pin: release a=stable\n"
5171 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5172 #: apt_preferences.5.xml:445
5173 msgid "the <literal>Codename:</literal> line"
5176 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5177 #: apt_preferences.5.xml:446
5179 "names the codename to which all the packages in the directory tree belong. "
5180 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
5181 "the packages in the directory tree below the parent of the "
5182 "<filename>Release</filename> file belong to a version named "
5183 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
5184 "preferences file would require the line:"
5187 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5188 #: apt_preferences.5.xml:455
5190 msgid "Pin: release n=&testing-codename;\n"
5193 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5194 #: apt_preferences.5.xml:462
5196 "names the release version. For example, the packages in the tree might "
5197 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
5198 "no version number for the <literal>testing</literal> and "
5199 "<literal>unstable</literal> distributions because they have not been "
5200 "released yet. Specifying this in the APT preferences file would require one "
5201 "of the following lines."
5204 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5205 #: apt_preferences.5.xml:471
5208 "Pin: release v=3.0\n"
5209 "Pin: release a=stable, v=3.0\n"
5210 "Pin: release 3.0\n"
5213 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5214 #: apt_preferences.5.xml:480
5215 msgid "the <literal>Component:</literal> line"
5218 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5219 #: apt_preferences.5.xml:481
5221 "names the licensing component associated with the packages in the directory "
5222 "tree of the <filename>Release</filename> file. For example, the line "
5223 "\"Component: main\" specifies that all the packages in the directory tree "
5224 "are from the <literal>main</literal> component, which entails that they are "
5225 "licensed under terms listed in the Debian Free Software Guidelines. "
5226 "Specifying this component in the APT preferences file would require the "
5230 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5231 #: apt_preferences.5.xml:490
5233 msgid "Pin: release c=main\n"
5236 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5237 #: apt_preferences.5.xml:496
5238 msgid "the <literal>Origin:</literal> line"
5241 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5242 #: apt_preferences.5.xml:497
5244 "names the originator of the packages in the directory tree of the "
5245 "<filename>Release</filename> file. Most commonly, this is "
5246 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
5247 "file would require the line:"
5250 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5251 #: apt_preferences.5.xml:503
5253 msgid "Pin: release o=Debian\n"
5256 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5257 #: apt_preferences.5.xml:509
5258 msgid "the <literal>Label:</literal> line"
5261 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5262 #: apt_preferences.5.xml:510
5264 "names the label of the packages in the directory tree of the "
5265 "<filename>Release</filename> file. Most commonly, this is "
5266 "<literal>Debian</literal>. Specifying this label in the APT preferences "
5267 "file would require the line:"
5270 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5271 #: apt_preferences.5.xml:516
5273 msgid "Pin: release l=Debian\n"
5276 #. type: Content of: <refentry><refsect1><refsect2><para>
5277 #: apt_preferences.5.xml:417
5279 "The <filename>Release</filename> file is normally found in the directory "
5280 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
5281 "example, <filename>.../dists/stable/Release</filename>, or "
5282 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
5283 "single multi-line record which applies to <emphasis>all</emphasis> of the "
5284 "packages in the directory tree below its parent. Unlike the "
5285 "<filename>Packages</filename> file, nearly all of the lines in a "
5286 "<filename>Release</filename> file are relevant for setting APT priorities: "
5287 "<placeholder type=\"variablelist\" id=\"0\"/>"
5290 #. type: Content of: <refentry><refsect1><refsect2><para>
5291 #: apt_preferences.5.xml:523
5293 "All of the <filename>Packages</filename> and <filename>Release</filename> "
5294 "files retrieved from locations listed in the &sources-list; file are stored "
5295 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
5296 "named by the variable <literal>Dir::State::Lists</literal> in the "
5297 "<filename>apt.conf</filename> file. For example, the file "
5298 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
5299 "contains the <filename>Release</filename> file retrieved from the site "
5300 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5301 "architecture files from the <literal>contrib</literal> component of the "
5302 "<literal>unstable</literal> distribution."
5305 #. type: Content of: <refentry><refsect1><refsect2><title>
5306 #: apt_preferences.5.xml:536
5307 msgid "Optional Lines in an APT Preferences Record"
5310 #. type: Content of: <refentry><refsect1><refsect2><para>
5311 #: apt_preferences.5.xml:538
5313 "Each record in the APT preferences file can optionally begin with one or "
5314 "more lines beginning with the word <literal>Explanation:</literal>. This "
5315 "provides a place for comments."
5318 #. type: Content of: <refentry><refsect1><refsect2><title>
5319 #: apt_preferences.5.xml:547
5320 msgid "Tracking Stable"
5323 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5324 #: apt_preferences.5.xml:555
5327 "Explanation: Uninstall or do not install any Debian-originated\n"
5328 "Explanation: package versions other than those in the stable distro\n"
5330 "Pin: release a=stable\n"
5331 "Pin-Priority: 900\n"
5334 "Pin: release o=Debian\n"
5335 "Pin-Priority: -10\n"
5338 #. type: Content of: <refentry><refsect1><refsect2><para>
5339 #: apt_preferences.5.xml:549
5341 "The following APT preferences file will cause APT to assign a priority "
5342 "higher than the default (500) to all package versions belonging to a "
5343 "<literal>stable</literal> distribution and a prohibitively low priority to "
5344 "package versions belonging to other <literal>Debian</literal> "
5345 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5348 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5349 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
5352 "apt-get install <replaceable>package-name</replaceable>\n"
5354 "apt-get dist-upgrade\n"
5357 #. type: Content of: <refentry><refsect1><refsect2><para>
5358 #: apt_preferences.5.xml:567
5360 "With a suitable &sources-list; file and the above preferences file, any of "
5361 "the following commands will cause APT to upgrade to the latest "
5362 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5366 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5367 #: apt_preferences.5.xml:584
5369 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5372 #. type: Content of: <refentry><refsect1><refsect2><para>
5373 #: apt_preferences.5.xml:578
5375 "The following command will cause APT to upgrade the specified package to the "
5376 "latest version from the <literal>testing</literal> distribution; the package "
5377 "will not be upgraded again unless this command is given again. <placeholder "
5378 "type=\"programlisting\" id=\"0\"/>"
5381 #. type: Content of: <refentry><refsect1><refsect2><title>
5382 #: apt_preferences.5.xml:590
5383 msgid "Tracking Testing or Unstable"
5386 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5387 #: apt_preferences.5.xml:599
5391 "Pin: release a=testing\n"
5392 "Pin-Priority: 900\n"
5395 "Pin: release a=unstable\n"
5396 "Pin-Priority: 800\n"
5399 "Pin: release o=Debian\n"
5400 "Pin-Priority: -10\n"
5403 #. type: Content of: <refentry><refsect1><refsect2><para>
5404 #: apt_preferences.5.xml:592
5406 "The following APT preferences file will cause APT to assign a high priority "
5407 "to package versions from the <literal>testing</literal> distribution, a "
5408 "lower priority to package versions from the <literal>unstable</literal> "
5409 "distribution, and a prohibitively low priority to package versions from "
5410 "other <literal>Debian</literal> distributions. <placeholder "
5411 "type=\"programlisting\" id=\"0\"/>"
5414 #. type: Content of: <refentry><refsect1><refsect2><para>
5415 #: apt_preferences.5.xml:613
5417 "With a suitable &sources-list; file and the above preferences file, any of "
5418 "the following commands will cause APT to upgrade to the latest "
5419 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5423 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5424 #: apt_preferences.5.xml:633
5426 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5429 #. type: Content of: <refentry><refsect1><refsect2><para>
5430 #: apt_preferences.5.xml:624
5432 "The following command will cause APT to upgrade the specified package to the "
5433 "latest version from the <literal>unstable</literal> distribution. "
5434 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5435 "the most recent <literal>testing</literal> version if that is more recent "
5436 "than the installed version, otherwise, to the most recent "
5437 "<literal>unstable</literal> version if that is more recent than the "
5438 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5441 #. type: Content of: <refentry><refsect1><refsect2><title>
5442 #: apt_preferences.5.xml:640
5443 msgid "Tracking the evolution of a codename release"
5446 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5447 #: apt_preferences.5.xml:654
5450 "Explanation: Uninstall or do not install any Debian-originated package "
5452 "Explanation: other than those in the distribution codenamed with "
5453 "&testing-codename; or sid\n"
5455 "Pin: release n=&testing-codename;\n"
5456 "Pin-Priority: 900\n"
5458 "Explanation: Debian unstable is always codenamed with sid\n"
5460 "Pin: release n=sid\n"
5461 "Pin-Priority: 800\n"
5464 "Pin: release o=Debian\n"
5465 "Pin-Priority: -10\n"
5468 #. type: Content of: <refentry><refsect1><refsect2><para>
5469 #: apt_preferences.5.xml:642
5471 "The following APT preferences file will cause APT to assign a priority "
5472 "higher than the default (500) to all package versions belonging to a "
5473 "specified codename of a distribution and a prohibitively low priority to "
5474 "package versions belonging to other <literal>Debian</literal> distributions, "
5475 "codenames and archives. Note that with this APT preference APT will follow "
5476 "the migration of a release from the archive <literal>testing</literal> to "
5477 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5478 "want to follow for example the progress in <literal>testing</literal> "
5479 "notwithstanding the codename changes you should use the example "
5480 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5483 #. type: Content of: <refentry><refsect1><refsect2><para>
5484 #: apt_preferences.5.xml:671
5486 "With a suitable &sources-list; file and the above preferences file, any of "
5487 "the following commands will cause APT to upgrade to the latest version(s) in "
5488 "the release codenamed with <literal>&testing-codename;</literal>. "
5489 "<placeholder type=\"programlisting\" id=\"0\"/>"
5492 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5493 #: apt_preferences.5.xml:691
5495 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5498 #. type: Content of: <refentry><refsect1><refsect2><para>
5499 #: apt_preferences.5.xml:682
5501 "The following command will cause APT to upgrade the specified package to the "
5502 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5503 "<command>apt-get upgrade</command> will upgrade the package to the most "
5504 "recent <literal>&testing-codename;</literal> version if that is more recent "
5505 "than the installed version, otherwise, to the most recent "
5506 "<literal>sid</literal> version if that is more recent than the installed "
5507 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5510 #. type: Content of: <refentry><refsect1><variablelist>
5511 #: apt_preferences.5.xml:700
5512 msgid "&file-preferences;"
5515 #. type: Content of: <refentry><refsect1><para>
5516 #: apt_preferences.5.xml:706
5517 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5520 #. type: Content of: <refentry><refnamediv><refpurpose>
5521 #: sources.list.5.xml:33
5522 msgid "Package resource list for APT"
5525 #. type: Content of: <refentry><refsect1><para>
5526 #: sources.list.5.xml:37
5528 "The package resource list is used to locate archives of the package "
5529 "distribution system in use on the system. At this time, this manual page "
5530 "documents only the packaging system used by the Debian GNU/Linux system. "
5531 "This control file is <filename>/etc/apt/sources.list</filename>."
5534 #. type: Content of: <refentry><refsect1><para>
5535 #: sources.list.5.xml:42
5537 "The source list is designed to support any number of active sources and a "
5538 "variety of source media. The file lists one source per line, with the most "
5539 "preferred source listed first. The format of each line is: <literal>type uri "
5540 "args</literal> The first item, <literal>type</literal> determines the format "
5541 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
5542 "Identifier (URI), which is a superset of the more specific and well-known "
5543 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
5544 "comment by using a #."
5547 #. type: Content of: <refentry><refsect1><title>
5548 #: sources.list.5.xml:53
5549 msgid "sources.list.d"
5552 #. type: Content of: <refentry><refsect1><para>
5553 #: sources.list.5.xml:54
5555 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5556 "add sources.list entries in separate files. The format is the same as for "
5557 "the regular <filename>sources.list</filename> file. File names need to end "
5558 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
5559 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
5560 "Otherwise APT will print a notice that it has ignored a file if the file "
5561 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5562 "configuration list - in this case it will be silently ignored."
5565 #. type: Content of: <refentry><refsect1><title>
5566 #: sources.list.5.xml:65
5567 msgid "The deb and deb-src types"
5570 #. type: Content of: <refentry><refsect1><para>
5571 #: sources.list.5.xml:66
5573 "The <literal>deb</literal> type describes a typical two-level Debian "
5574 "archive, <filename>distribution/component</filename>. Typically, "
5575 "<literal>distribution</literal> is generally an archivename like "
5576 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5577 "<literal>&stable-codename;</literal> or "
5578 "<literal>&testing-codename;</literal> while component is one of "
5579 "<literal>main</literal> <literal>contrib</literal> or "
5580 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
5581 "debian distribution's source code in the same form as the "
5582 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5583 "to fetch source indexes."
5586 #. type: Content of: <refentry><refsect1><para>
5587 #: sources.list.5.xml:78
5589 "The format for a <filename>sources.list</filename> entry using the "
5590 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
5593 #. type: Content of: <refentry><refsect1><literallayout>
5594 #: sources.list.5.xml:81
5596 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
5599 #. type: Content of: <refentry><refsect1><para>
5600 #: sources.list.5.xml:83
5602 "The URI for the <literal>deb</literal> type must specify the base of the "
5603 "Debian distribution, from which APT will find the information it needs. "
5604 "<literal>distribution</literal> can specify an exact path, in which case the "
5605 "components must be omitted and <literal>distribution</literal> must end with "
5606 "a slash (/). This is useful for when the case only a particular sub-section "
5607 "of the archive denoted by the URI is of interest. If "
5608 "<literal>distribution</literal> does not specify an exact path, at least one "
5609 "<literal>component</literal> must be present."
5612 #. type: Content of: <refentry><refsect1><para>
5613 #: sources.list.5.xml:92
5615 "<literal>distribution</literal> may also contain a variable, "
5616 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
5617 "m68k, powerpc, ...) used on the system. This permits "
5618 "architecture-independent <filename>sources.list</filename> files to be "
5619 "used. In general this is only of interest when specifying an exact path, "
5620 "<literal>APT</literal> will automatically generate a URI with the current "
5621 "architecture otherwise."
5624 #. type: Content of: <refentry><refsect1><para>
5625 #: sources.list.5.xml:100
5627 "Since only one distribution can be specified per line it may be necessary to "
5628 "have multiple lines for the same URI, if a subset of all available "
5629 "distributions or components at that location is desired. APT will sort the "
5630 "URI list after it has generated a complete set internally, and will collapse "
5631 "multiple references to the same Internet host, for instance, into a single "
5632 "connection, so that it does not inefficiently establish an FTP connection, "
5633 "close it, do something else, and then re-establish a connection to that same "
5634 "host. This feature is useful for accessing busy FTP sites with limits on the "
5635 "number of simultaneous anonymous users. APT also parallelizes connections to "
5636 "different hosts to more effectively deal with sites with low bandwidth."
5639 #. type: Content of: <refentry><refsect1><para>
5640 #: sources.list.5.xml:112
5642 "<literal>options</literal> is always optional and needs to be surounded by "
5643 "square brackets. It can consist of multiple settings in the form "
5644 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
5645 "Multiple settings are separated by spaces. The following settings are "
5646 "supported by APT, note though that unsupported settings will be ignored "
5650 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5651 #: sources.list.5.xml:117
5653 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
5654 "can be used to specify for which architectures packages information should "
5655 "be downloaded. If this option is not set all architectures defined by the "
5656 "<literal>APT::Architectures</literal> option will be downloaded."
5659 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5660 #: sources.list.5.xml:121
5662 "<literal>trusted=yes</literal> can be set to indicate that packages from "
5663 "this source are always authenticated even if the "
5664 "<filename>Release</filename> file is not signed or the signature can't be "
5665 "checked. This disables parts of &apt-secure; and should therefore only be "
5666 "used in a local and trusted context. <literal>trusted=no</literal> is the "
5667 "opposite which handles even correctly authenticated sources as not "
5671 #. type: Content of: <refentry><refsect1><para>
5672 #: sources.list.5.xml:128
5674 "It is important to list sources in order of preference, with the most "
5675 "preferred source listed first. Typically this will result in sorting by "
5676 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5677 "followed by distant Internet hosts, for example)."
5680 #. type: Content of: <refentry><refsect1><para>
5681 #: sources.list.5.xml:133
5682 msgid "Some examples:"
5685 #. type: Content of: <refentry><refsect1><literallayout>
5686 #: sources.list.5.xml:135
5689 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5690 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5695 #. type: Content of: <refentry><refsect1><title>
5696 #: sources.list.5.xml:141
5697 msgid "URI specification"
5700 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5701 #: sources.list.5.xml:146
5705 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5706 #: sources.list.5.xml:148
5708 "The file scheme allows an arbitrary directory in the file system to be "
5709 "considered an archive. This is useful for NFS mounts and local mirrors or "
5713 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5714 #: sources.list.5.xml:153
5718 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5719 #: sources.list.5.xml:155
5721 "The cdrom scheme allows APT to use a local CDROM drive with media "
5722 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5726 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5727 #: sources.list.5.xml:160
5731 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5732 #: sources.list.5.xml:162
5734 "The http scheme specifies an HTTP server for the archive. If an environment "
5735 "variable <envar>http_proxy</envar> is set with the format "
5736 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5737 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5738 "the format http://user:pass@server:port/. Note that this is an insecure "
5739 "method of authentication."
5742 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5743 #: sources.list.5.xml:171
5747 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5748 #: sources.list.5.xml:173
5750 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5751 "is highly configurable; for more information see the &apt-conf; manual "
5752 "page. Please note that a ftp proxy can be specified by using the "
5753 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
5754 "http proxy (http proxy servers often understand ftp urls) using this method "
5755 "and ONLY this method. ftp proxies using http specified in the configuration "
5756 "file will be ignored."
5759 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5760 #: sources.list.5.xml:182
5764 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5765 #: sources.list.5.xml:184
5767 "The copy scheme is identical to the file scheme except that packages are "
5768 "copied into the cache directory instead of used directly at their location. "
5769 "This is useful for people using a zip disk to copy files around with APT."
5772 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5773 #: sources.list.5.xml:189
5777 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5778 #: sources.list.5.xml:189
5782 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5783 #: sources.list.5.xml:191
5785 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
5786 "user and access the files. It is a good idea to do prior arrangements with "
5787 "RSA keys or rhosts. Access to files on the remote uses standard "
5788 "<command>find</command> and <command>dd</command> commands to perform the "
5789 "file transfers from the remote."
5792 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5793 #: sources.list.5.xml:199
5794 msgid "more recognizable URI types"
5797 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5798 #: sources.list.5.xml:201
5800 "APT can be extended with more methods shipped in other optional packages "
5801 "which should follow the nameing scheme "
5802 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
5803 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
5804 "which provides access methods for https-URIs with features similar to the "
5805 "http method, but other methods for using e.g. debtorrent are also available, "
5806 "see <citerefentry> "
5807 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
5808 "<manvolnum>1</manvolnum></citerefentry>."
5811 #. type: Content of: <refentry><refsect1><para>
5812 #: sources.list.5.xml:143
5814 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
5815 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
5818 #. type: Content of: <refentry><refsect1><para>
5819 #: sources.list.5.xml:215
5821 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5822 "stable/main, stable/contrib, and stable/non-free."
5825 #. type: Content of: <refentry><refsect1><literallayout>
5826 #: sources.list.5.xml:217
5828 msgid "deb file:/home/jason/debian stable main contrib non-free"
5831 #. type: Content of: <refentry><refsect1><para>
5832 #: sources.list.5.xml:219
5833 msgid "As above, except this uses the unstable (development) distribution."
5836 #. type: Content of: <refentry><refsect1><literallayout>
5837 #: sources.list.5.xml:220
5839 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5842 #. type: Content of: <refentry><refsect1><para>
5843 #: sources.list.5.xml:222
5844 msgid "Source line for the above"
5847 #. type: Content of: <refentry><refsect1><literallayout>
5848 #: sources.list.5.xml:223
5850 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5853 #. type: Content of: <refentry><refsect1><para>
5854 #: sources.list.5.xml:225
5856 "The first line gets package information for the architectures in "
5857 "<literal>APT::Architectures</literal> while the second always retrieves "
5858 "<literal>amd64</literal> and <literal>armel</literal>."
5861 #. type: Content of: <refentry><refsect1><literallayout>
5862 #: sources.list.5.xml:227
5865 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5866 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5869 #. type: Content of: <refentry><refsect1><para>
5870 #: sources.list.5.xml:230
5872 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5876 #. type: Content of: <refentry><refsect1><literallayout>
5877 #: sources.list.5.xml:232
5879 msgid "deb http://archive.debian.org/debian-archive hamm main"
5882 #. type: Content of: <refentry><refsect1><para>
5883 #: sources.list.5.xml:234
5885 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5886 "directory, and uses only the &stable-codename;/contrib area."
5889 #. type: Content of: <refentry><refsect1><literallayout>
5890 #: sources.list.5.xml:236
5892 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5895 #. type: Content of: <refentry><refsect1><para>
5896 #: sources.list.5.xml:238
5898 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5899 "directory, and uses only the unstable/contrib area. If this line appears as "
5900 "well as the one in the previous example in <filename>sources.list</filename> "
5901 "a single FTP session will be used for both resource lines."
5904 #. type: Content of: <refentry><refsect1><literallayout>
5905 #: sources.list.5.xml:242
5907 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5910 #. type: Content of: <refentry><refsect1><para><literallayout>
5911 #: sources.list.5.xml:251
5913 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5916 #. type: Content of: <refentry><refsect1><para>
5917 #: sources.list.5.xml:244
5919 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5920 "directory, and uses only files found under "
5921 "<filename>unstable/binary-i386</filename> on i386 machines, "
5922 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5923 "supported architectures. [Note this example only illustrates how to use the "
5924 "substitution variable; official debian archives are not structured like "
5925 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5928 #. type: Content of: <refentry><refsect1><para>
5929 #: sources.list.5.xml:256
5930 msgid "&apt-cache; &apt-conf;"
5933 #. type: <title></title>
5935 msgid "APT User's Guide"
5938 #. type: <author></author>
5939 #: guide.sgml:6 offline.sgml:6
5940 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5943 #. type: <version></version>
5945 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5948 #. type: <abstract></abstract>
5951 "This document provides an overview of how to use the the APT package "
5955 #. type: <copyrightsummary></copyrightsummary>
5957 msgid "Copyright © Jason Gunthorpe, 1998."
5961 #: guide.sgml:21 offline.sgml:22
5963 "\"APT\" and this document are free software; you can redistribute them "
5964 "and/or modify them under the terms of the GNU General Public License as "
5965 "published by the Free Software Foundation; either version 2 of the License, "
5966 "or (at your option) any later version."
5970 #: guide.sgml:24 offline.sgml:25
5972 "For more details, on Debian GNU/Linux systems, see the file "
5973 "/usr/share/common-licenses/GPL for the full license."
5976 #. type: <heading></heading>
5984 "The APT package currently contains two sections, the APT "
5985 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
5986 "interface. Both provide a way to install and remove packages as well as "
5987 "download new packages from the Internet."
5990 #. type: <heading></heading>
5992 msgid "Anatomy of the Package System"
5998 "The Debian packaging system has a large amount of information associated "
5999 "with each package to help assure that it integrates cleanly and easily into "
6000 "the system. The most prominent of its features is the dependency system."
6006 "The dependency system allows individual programs to make use of shared "
6007 "elements in the system such as libraries. It simplifies placing infrequently "
6008 "used portions of a program in separate packages to reduce the number of "
6009 "things the average user is required to install. Also, it allows for choices "
6010 "in mail transport agents, X servers and so on."
6016 "The first step to understanding the dependency system is to grasp the "
6017 "concept of a simple dependency. The meaning of a simple dependency is that a "
6018 "package requires another package to be installed at the same time to work "
6025 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6026 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6027 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6028 "simple dependency on emacs, without emacs it is completely useless."
6034 "The other important dependency to understand is a conflicting dependency. It "
6035 "means that a package, when installed with another package, will not work and "
6036 "may possibly be extremely harmful to the system. As an example consider a "
6037 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6038 "have two mail transport agents installed because both need to listen to the "
6039 "network to receive mail. Attempting to install two will seriously damage the "
6040 "system so all mail transport agents have a conflicting dependency with all "
6041 "other mail transport agents."
6047 "As an added complication there is the possibility for a package to pretend "
6048 "to be another package. Consider that exim and sendmail for many intents are "
6049 "identical, they both deliver mail and understand a common interface. Hence, "
6050 "the package system has a way for them to declare that they are both "
6051 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6052 "a mail-transport-agent and other packages that need a mail transport agent "
6053 "depend on mail-transport-agent. This can add a great deal of confusion when "
6054 "trying to manually fix packages."
6060 "At any given time a single dependency may be met by packages that are "
6061 "already installed or it may not be. APT attempts to help resolve dependency "
6062 "issues by providing a number of automatic algorithms that help in selecting "
6063 "packages for installation."
6066 #. type: <heading></heading>
6074 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6075 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6076 "understand .deb files, it works with the package's proper name and can only "
6077 "install .deb archives from a <em>Source</em>."
6083 "The first <footnote><p>If you are using an http proxy server you must set "
6084 "the http_proxy environment variable first, see "
6085 "sources.list(5)</p></footnote> thing that should be done before using "
6086 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6087 "so that it knows what packages are available. This is done with <tt>apt-get "
6088 "update</tt>. For instance,"
6091 #. type: <example></example>
6095 "# apt-get update\n"
6096 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6097 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6098 "Reading Package Lists... Done\n"
6099 "Building Dependency Tree... Done"
6102 #. type: <p><taglist>
6104 msgid "Once updated there are several commands that can be used:"
6107 #. type: <tag></tag>
6115 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6116 "install a new package or remove an existing package, nor will it ever "
6117 "upgrade a package that might cause some other package to break. This can be "
6118 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6119 "the packages that it could not upgrade, this usually means that they depend "
6120 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6121 "<tt>apt-get install</tt> can be used to force these packages to install."
6124 #. type: <tag></tag>
6132 "Install is used to install packages by name. The package is automatically "
6133 "fetched and installed. This can be useful if you already know the name of "
6134 "the package to install and do not want to go into a GUI to select it. Any "
6135 "number of packages may be passed to install, they will all be "
6136 "fetched. Install automatically attempts to resolve dependency problems with "
6137 "the listed packages and will print a summary and ask for confirmation if "
6138 "anything other than its arguments are changed."
6141 #. type: <tag></tag>
6143 msgid "dist-upgrade"
6149 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6150 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6151 "set of packages to install, upgrade and remove to get as much of the system "
6152 "to the newest release. In some situations it may be desired to use "
6153 "dist-upgrade rather than spend the time manually resolving dependencies in "
6154 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6155 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6162 "It is important to closely look at what dist-upgrade is going to do, its "
6163 "decisions may sometimes be quite surprising."
6169 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6170 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6171 "option is <tt>-d</tt> which does not install the fetched files. If the "
6172 "system has to download a large number of package it would be undesired to "
6173 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6174 "the downloaded archives can be installed by simply running the command that "
6175 "caused them to be downloaded again without <tt>-d</tt>."
6178 #. type: <heading></heading>
6186 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6187 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6188 "to select the packages to be installed or removed and APT actually installs "
6195 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6196 "and then choose the APT method. You will be prompted for a set of "
6197 "<em>Sources</em> which are places to fetch archives from. These can be "
6198 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
6199 "provide a fragment of the total Debian archive, APT will automatically "
6200 "combine them to form a complete set of packages. If you have a CDROM then it "
6201 "is a good idea to specify it first and then specify a mirror so that you "
6202 "have access to the latest bug fixes. APT will automatically use packages on "
6203 "your CDROM before downloading from the Internet."
6206 #. type: <example></example>
6210 " Set up a list of distribution source locations\n"
6212 " Please give the base URL of the debian distribution.\n"
6213 " The access schemes I know about are: http file\n"
6216 " file:/mnt/debian,\n"
6217 " ftp://ftp.debian.org/debian,\n"
6218 " http://ftp.de.debian.org/debian,\n"
6221 " URL [http://llug.sep.bnl.gov/debian]:"
6227 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6228 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6232 #. type: <example></example>
6236 " Please give the distribution tag to get or a path to the\n"
6237 " package file ending in a /. The distribution\n"
6238 " tags are typically something like: stable unstable testing non-US\n"
6240 " Distribution [stable]:"
6246 "The distribution refers to the Debian version in the archive, "
6247 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6248 "refers to the developmental version. <em>non-US</em> is only available on "
6249 "some mirrors and refers to packages that contain encryption technology or "
6250 "other things that cannot be exported from the United States. Importing these "
6251 "packages into the US is legal however."
6254 #. type: <example></example>
6258 " Please give the components to get\n"
6259 " The components are typically something like: main contrib non-free\n"
6261 " Components [main contrib non-free]:"
6267 "The components list refers to the list of sub distributions to fetch. The "
6268 "distribution is split up based on software licenses, main being DFSG free "
6269 "packages while contrib and non-free contain things that have various "
6270 "restrictions placed on their use and distribution."
6276 "Any number of sources can be added, the setup script will continue to prompt "
6277 "until you have specified all that you want."
6283 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6284 "available list by selecting [U]pdate from the menu. This is a superset of "
6285 "<tt>apt-get update</tt> that makes the fetched information available to "
6286 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6287 "update</tt> has been run before."
6293 "You can then go on and make your selections using [S]elect and then perform "
6294 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6295 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6302 "By default APT will automatically remove the package (.deb) files once they "
6303 "have been successfully installed. To change this behavior place "
6304 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6307 #. type: <heading></heading>
6309 msgid "The Interface"
6315 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6316 "same interface. It is a simple system that generally tells you what it will "
6317 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6318 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6319 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6320 "alone.</p></footnote> After printing out a summary of what will happen APT "
6321 "then will print out some informative status messages so that you can "
6322 "estimate how far along it is and how much is left to do."
6325 #. type: <heading></heading>
6333 "Before all operations except update, APT performs a number of actions to "
6334 "prepare its internal state. It also does some checks of the system's "
6335 "state. At any time these operations can be performed by running <tt>apt-get "
6339 #. type: <example></example>
6344 "Reading Package Lists... Done\n"
6345 "Building Dependency Tree... Done"
6351 "The first thing it does is read all the package files into memory. APT uses "
6352 "a caching scheme so this operation will be faster the second time it is "
6353 "run. If some of the package files are not found then they will be ignored "
6354 "and a warning will be printed when apt-get exits."
6360 "The final operation performs a detailed analysis of the system's "
6361 "dependencies. It checks every dependency of every installed or unpacked "
6362 "package and considers if it is OK. Should this find a problem then a report "
6363 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6366 #. type: <example></example>
6371 "Reading Package Lists... Done\n"
6372 "Building Dependency Tree... Done\n"
6373 "You might want to run apt-get -f install' to correct these.\n"
6374 "Sorry, but the following packages have unmet dependencies:\n"
6375 " 9fonts: Depends: xlib6g but it is not installed\n"
6376 " uucp: Depends: mailx but it is not installed\n"
6377 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6378 " adduser: Depends: perl-base but it is not installed\n"
6379 " aumix: Depends: libgpmg1 but it is not installed\n"
6380 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6381 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6382 " cthugha: Depends: svgalibg1 but it is not installed\n"
6383 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6384 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6390 "In this example the system has many problems, including a serious problem "
6391 "with libreadlineg2. For each package that has unmet dependencies a line is "
6392 "printed out indicating the package with the problem and the dependencies "
6393 "that are unmet. A short explanation of why the package has a dependency "
6394 "problem is also included."
6400 "There are two ways a system can get into a broken state like this. The first "
6401 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6402 "packages when performing upgrades. <footnote><p>APT however considers all "
6403 "known dependencies and attempts to prevent broken "
6404 "packages</p></footnote>. The second is if a package installation fails "
6405 "during an operation. In this situation a package may have been unpacked "
6406 "without its dependents being installed."
6412 "The second situation is much less serious than the first because APT places "
6413 "certain constraints on the order that packages are installed. In both cases "
6414 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6415 "deduce a possible solution to the problem and then continue on. The APT "
6416 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6417 "for easy continuation of failed maintainer scripts."
6423 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6424 "system caused by the first case then it is possible that it will either fail "
6425 "immediately or the installation sequence will fail. In either case it is "
6426 "necessary to manually use dpkg (possibly with forcing options) to correct "
6427 "the situation enough to allow APT to proceed."
6430 #. type: <heading></heading>
6432 msgid "The Status Report"
6438 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6439 "happen. Generally the report reflects the type of operation being performed "
6440 "but there are several common elements. In all cases the lists reflect the "
6441 "final state of things, taking into account the <tt>-f</tt> option and any "
6442 "other relevant activities to the command being executed."
6445 #. type: <heading></heading>
6447 msgid "The Extra Package list"
6450 #. type: <example></example>
6454 "The following extra packages will be installed:\n"
6455 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6456 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6457 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6458 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6465 "The Extra Package list shows all of the packages that will be installed or "
6466 "upgraded in excess of the ones mentioned on the command line. It is only "
6467 "generated for an <tt>install</tt> command. The listed packages are often the "
6468 "result of an Auto Install."
6471 #. type: <heading></heading>
6473 msgid "The Packages to Remove"
6476 #. type: <example></example>
6480 "The following packages will be REMOVED:\n"
6481 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6482 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6483 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6490 "The Packages to Remove list shows all of the packages that will be removed "
6491 "from the system. It can be shown for any of the operations and should be "
6492 "given a careful inspection to ensure nothing important is to be taken "
6493 "off. The <tt>-f</tt> option is especially good at generating packages to "
6494 "remove so extreme care should be used in that case. The list may contain "
6495 "packages that are going to be removed because they are only partially "
6496 "installed, possibly due to an aborted installation."
6499 #. type: <heading></heading>
6501 msgid "The New Packages list"
6504 #. type: <example></example>
6508 "The following NEW packages will installed:\n"
6509 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6515 "The New Packages list is simply a reminder of what will happen. The packages "
6516 "listed are not presently installed in the system but will be when APT is "
6520 #. type: <heading></heading>
6522 msgid "The Kept Back list"
6525 #. type: <example></example>
6529 "The following packages have been kept back\n"
6530 " compface man-db tetex-base msql libpaper svgalib1\n"
6531 " gs snmp arena lynx xpat2 groff xscreensaver"
6537 "Whenever the whole system is being upgraded there is the possibility that "
6538 "new versions of packages cannot be installed because they require new things "
6539 "or conflict with already installed things. In this case the package will "
6540 "appear in the Kept Back list. The best way to convince packages listed there "
6541 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6542 "to resolve their problems."
6545 #. type: <heading></heading>
6547 msgid "Held Packages warning"
6550 #. type: <example></example>
6554 "The following held packages will be changed:\n"
6561 "Sometimes you can ask APT to install a package that is on hold, in such a "
6562 "case it prints out a warning that the held package is going to be "
6563 "changed. This should only happen during dist-upgrade or install."
6566 #. type: <heading></heading>
6568 msgid "Final summary"
6573 msgid "Finally, APT will print out a summary of all the changes that will occur."
6576 #. type: <example></example>
6580 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6582 "12 packages not fully installed or removed.\n"
6583 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6589 "The first line of the summary simply is a reduced version of all of the "
6590 "lists and includes the number of upgrades - that is packages already "
6591 "installed that have new versions available. The second line indicates the "
6592 "number of poorly configured packages, possibly the result of an aborted "
6593 "installation. The final line shows the space requirements that the "
6594 "installation needs. The first pair of numbers refer to the size of the "
6595 "archive files. The first number indicates the number of bytes that must be "
6596 "fetched from remote locations and the second indicates the total size of all "
6597 "the archives required. The next number indicates the size difference between "
6598 "the presently installed packages and the newly installed packages. It is "
6599 "roughly equivalent to the space required in /usr after everything is "
6600 "done. If a large number of packages are being removed then the value may "
6601 "indicate the amount of space that will be freed."
6607 "Some other reports can be generated by using the -u option to show packages "
6608 "to upgrade, they are similar to the previous examples."
6611 #. type: <heading></heading>
6613 msgid "The Status Display"
6619 "During the download of archives and package files APT prints out a series of "
6623 #. type: <example></example>
6627 "# apt-get update\n"
6628 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6629 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6630 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6631 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6633 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6634 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6640 "The lines starting with <em>Get</em> are printed out when APT begins to "
6641 "fetch a file while the last line indicates the progress of the download. The "
6642 "first percent value on the progress line indicates the total percent done of "
6643 "all files. Unfortunately since the size of the Package files is unknown "
6644 "<tt>apt-get update</tt> estimates the percent done which causes some "
6651 "The next section of the status line is repeated once for each download "
6652 "thread and indicates the operation being performed and some useful "
6653 "information about what is happening. Sometimes this section will simply read "
6654 "<em>Forking</em> which means the OS is loading the download module. The "
6655 "first word after the [ is the fetch number as shown on the history "
6656 "lines. The next word is the short form name of the object being "
6657 "downloaded. For archives it will contain the name of the package that is "
6664 "Inside of the single quote is an informative string indicating the progress "
6665 "of the negotiation phase of the download. Typically it progresses from "
6666 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6667 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6668 "the remote site. Once the download begins this is represented as "
6669 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6670 "kilobytes is expected. The total size is always shown in 4 figure notation "
6671 "to preserve space. After the size display is a percent meter for the file "
6672 "itself. The second last element is the instantaneous average speed. This "
6673 "values is updated every 5 seconds and reflects the rate of data transfer for "
6674 "that period. Finally is shown the estimated transfer time. This is updated "
6675 "regularly and reflects the time to complete everything at the shown transfer "
6682 "The status display updates every half second to provide a constant feedback "
6683 "on the download progress while the Get lines scroll back whenever a new file "
6684 "is started. Since the status display is constantly updated it is unsuitable "
6685 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6689 #. type: <heading></heading>
6697 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6698 "to the <prgn>dpkg</prgn> interface once downloading is "
6699 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6700 "processes the packages and the packages themselves may also ask several "
6701 "questions. Before each question there is usually a description of what it is "
6702 "asking and the questions are too varied to discuss completely here."
6705 #. type: <title></title>
6707 msgid "Using APT Offline"
6710 #. type: <version></version>
6712 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6715 #. type: <abstract></abstract>
6718 "This document describes how to use APT in a non-networked environment, "
6719 "specifically a 'sneaker-net' approach for performing upgrades."
6722 #. type: <copyrightsummary></copyrightsummary>
6724 msgid "Copyright © Jason Gunthorpe, 1999."
6727 #. type: <heading></heading>
6729 msgid "Introduction"
6732 #. type: <heading></heading>
6733 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6740 "Normally APT requires direct access to a Debian archive, either from a local "
6741 "media or through a network. Another common complaint is that a Debian "
6742 "machine is on a slow link, such as a modem and another machine has a very "
6743 "fast connection but they are physically distant."
6749 "The solution to this is to use large removable media such as a Zip disc or a "
6750 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6751 "archive but can easily fit a subset large enough for most users. The idea is "
6752 "to use APT to generate a list of packages that are required and then fetch "
6753 "them onto the disc using another machine with good connectivity. It is even "
6754 "possible to use another Debian machine with APT or to use a completely "
6755 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6756 "the machine downloading the packages, and <em>target host</em> the one with "
6757 "bad or no connection."
6763 "This is achieved by creatively manipulating the APT configuration file. The "
6764 "essential premise to tell APT to look on a disc for it's archive files. Note "
6765 "that the disc should be formated with a filesystem that can handle long file "
6766 "names such as ext2, fat32 or vfat."
6769 #. type: <heading></heading>
6771 msgid "Using APT on both machines"
6774 #. type: <p><example>
6777 "APT being available on both machines gives the simplest configuration. The "
6778 "basic idea is to place a copy of the status file on the disc and use the "
6779 "remote machine to fetch the latest package files and decide which packages "
6780 "to download. The disk directory structure should look like:"
6783 #. type: <example></example>
6797 #. type: <heading></heading>
6799 msgid "The configuration file"
6805 "The configuration file should tell APT to store its files on the disc and to "
6806 "use the configuration files on the disc as well. The sources.list should "
6807 "contain the proper sites that you wish to use from the remote machine, and "
6808 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6809 "<em>target host</em>. Please note, if you are using a local archive you must "
6810 "use copy URIs, the syntax is identical to file URIs."
6813 #. type: <p><example>
6816 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6820 #. type: <example></example>
6826 " /* This is not necessary if the two machines are the same arch, it "
6828 " the remote APT what architecture the target machine is */\n"
6829 " Architecture \"i386\";\n"
6831 " Get::Download-Only \"true\";\n"
6836 " /* Use the disc for state information and redirect the status file from\n"
6837 " the /var/lib/dpkg default */\n"
6838 " State \"/disc/\";\n"
6839 " State::status \"status\";\n"
6841 " // Binary caches will be stored locally\n"
6842 " Cache::archives \"/disc/archives/\";\n"
6843 " Cache \"/tmp/\";\n"
6845 " // Location of the source list.\n"
6846 " Etc \"/disc/\";\n"
6850 #. type: </example></p>
6853 "More details can be seen by examining the apt.conf man page and the sample "
6854 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6857 #. type: <p><example>
6860 "On the target machine the first thing to do is mount the disc and copy "
6861 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6862 "directories outlined in the Overview, <em>archives/partial/</em> and "
6863 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6864 "configure the sources.list. On the remote machine execute the following:"
6867 #. type: <example></example>
6871 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6872 " # apt-get update\n"
6873 " [ APT fetches the package files ]\n"
6874 " # apt-get dist-upgrade\n"
6875 " [ APT fetches all the packages needed to upgrade the target machine ]"
6878 #. type: </example></p>
6881 "The dist-upgrade command can be replaced with any other standard APT "
6882 "commands, particularly dselect-upgrade. You can even use an APT front end "
6883 "such as <em>dselect</em>. However this presents a problem in communicating "
6884 "your selections back to the local computer."
6887 #. type: <p><example>
6890 "Now the disc contains all of the index files and archives needed to upgrade "
6891 "the target machine. Take the disc back and run:"
6894 #. type: <example></example>
6898 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6899 " # apt-get check\n"
6900 " [ APT generates a local copy of the cache files ]\n"
6901 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6902 " [ Or any other APT command ]"
6908 "It is necessary for proper function to re-specify the status file to be the "
6909 "local one. This is very important!"
6915 "If you are using dselect you can do the very risky operation of copying "
6916 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6917 "remote machine are updated. I highly recommend that people only make "
6918 "selections on the local machine - but this may not always be possible. DO "
6919 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6922 #. type: <heading></heading>
6924 msgid "Using APT and wget"
6930 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6931 "any machine. Unlike the method above this requires that the Debian machine "
6932 "already has a list of available packages."
6938 "The basic idea is to create a disc that has only the archive files "
6939 "downloaded from the remote site. This is done by using the --print-uris "
6940 "option to apt-get and then preparing a wget script to actually fetch the "
6944 #. type: <heading></heading>
6949 #. type: <p><example>
6952 "Unlike the previous technique no special configuration files are "
6953 "required. We merely use the standard APT commands to generate the file list."
6956 #. type: <example></example>
6960 " # apt-get dist-upgrade \n"
6961 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6962 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6963 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6966 #. type: </example></p>
6969 "Any command other than dist-upgrade could be used here, including "
6976 "The /disc/wget-script file will now contain a list of wget commands to "
6977 "execute in order to fetch the necessary archives. This script should be run "
6978 "with the current directory as the disc's mount point so as to save the "
6979 "output on the disc."
6982 #. type: <p><example>
6984 msgid "The remote machine would do something like"
6987 #. type: <example></example>
6992 " # sh -x ./wget-script\n"
6996 #. type: </example><example>
6999 "Once the archives are downloaded and the disc returned to the Debian machine "
7000 "installation can proceed using,"
7003 #. type: <example></example>
7006 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
7009 #. type: </example></p>
7011 msgid "Which will use the already fetched archives on the disc."