1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2012-05-21 13:37+0300\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
34 msgid "Debian GNU/Linux"
45 msgid "apt - Advanced Package Tool"
68 "APT is a management system for software packages. For normal day to day "
69 "package management there are several frontends available, such as "
70 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
71 "System. Some options are only implemented in B<apt-get>(8) though."
83 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
84 "B<apt_preferences>(5), B<apt-secure>(8)"
95 msgid "apt returns zero on normal operation, decimal 100 on error."
106 msgid "This manpage isn't even started."
112 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
113 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
114 "B<reportbug>(1) command."
125 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
132 "<!ENTITY apt-author.team \"\n"
134 " <othername>APT team</othername>\n"
135 " <contrib></contrib>\n"
144 "<!ENTITY apt-qapage \"\n"
146 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
155 "<!-- Boiler plate Bug reporting section -->\n"
156 "<!ENTITY manbugs \"\n"
157 " <refsect1><title>Bugs</title>\n"
158 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
159 " If you wish to report a bug in APT, please see\n"
160 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
161 " &reportbug; command.\n"
171 "<!-- Boiler plate Author section -->\n"
172 "<!ENTITY manauthor \"\n"
173 " <refsect1><title>Author</title>\n"
174 " <para>APT was written by the APT team "
175 "<email>apt@packages.debian.org</email>.\n"
185 "<!-- Should be used within the option section of the text to\n"
186 " put in the blurb about -h, -v, -c and -o -->\n"
187 "<!ENTITY apt-commonoptions \"\n"
188 " <varlistentry><term><option>-h</option></term>\n"
189 " <term><option>--help</option></term>\n"
190 " <listitem><para>Show a short usage summary.\n"
201 " <term><option>-v</option></term>\n"
202 " <term><option>--version</option></term>\n"
203 " <listitem><para>Show the program version.\n"
214 " <term><option>-c</option></term>\n"
215 " <term><option>--config-file</option></term>\n"
216 " <listitem><para>Configuration File; Specify a configuration file to "
218 " The program will read the default configuration file and then this \n"
219 " configuration file. If configuration settings need to be set before "
221 " default configuration files are parsed specify a file with the "
222 "<envar>APT_CONFIG</envar>\n"
223 " environment variable. See &apt-conf; for syntax information.\n"
234 " <term><option>-o</option></term>\n"
235 " <term><option>--option</option></term>\n"
236 " <listitem><para>Set a Configuration Option; This will set an "
238 " configuration option. The syntax is <option>-o "
239 "Foo::Bar=bar</option>.\n"
240 " <option>-o</option> and <option>--option</option> can be used "
242 " times to set different options.\n"
253 "<!-- Should be used within the option section of the text to\n"
254 " put in the blurb about -h, -v, -c and -o -->\n"
255 "<!ENTITY apt-cmdblurb \"\n"
256 " <para>All command line options may be set using the configuration file, "
258 " descriptions indicate the configuration option to set. For boolean\n"
259 " options you can override the config file by using something like \n"
260 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
261 " or several other variations.\n"
270 "<!ENTITY file-aptconf \"\n"
271 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
272 " <listitem><para>APT configuration file.\n"
273 " Configuration Item: "
274 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
282 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
283 " <listitem><para>APT configuration file fragments.\n"
284 " Configuration Item: "
285 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
294 "<!ENTITY file-cachearchives \"\n"
295 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
296 " <listitem><para>Storage area for retrieved package files.\n"
297 " Configuration Item: "
298 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
307 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
308 " <listitem><para>Storage area for package files in transit.\n"
309 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
310 "(<filename>partial</filename> will be implicitly "
311 "appended). </para></listitem>\n"
320 "<!ENTITY file-preferences \"\n"
321 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
322 " <listitem><para>Version preferences file.\n"
323 " This is where you would specify "pinning",\n"
324 " i.e. a preference to get certain packages\n"
325 " from a separate source\n"
326 " or from a different version of a distribution.\n"
327 " Configuration Item: "
328 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
337 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
338 " <listitem><para>File fragments for the version preferences.\n"
339 " Configuration Item: "
340 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
349 "<!ENTITY file-sourceslist \"\n"
350 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
351 " <listitem><para>Locations to fetch packages from.\n"
352 " Configuration Item: "
353 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
362 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
363 " <listitem><para>File fragments for locations to fetch packages from.\n"
364 " Configuration Item: "
365 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
374 "<!ENTITY file-statelists \"\n"
375 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
376 " <listitem><para>Storage area for state information for each package "
377 "resource specified in\n"
379 " Configuration Item: "
380 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
389 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
390 " <listitem><para>Storage area for state information in transit.\n"
391 " Configuration Item: <literal>Dir::State::Lists</literal> "
392 "(<filename>partial</filename> will be implicitly "
393 "appended).</para></listitem>\n"
402 "<!ENTITY file-trustedgpg \"\n"
403 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
404 " <listitem><para>Keyring of local trusted keys, new keys will be added "
406 " Configuration Item: "
407 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
416 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
417 " <listitem><para>File fragments for the trusted keys, additional "
419 " be stored here (by other packages or the administrator).\n"
420 " Configuration Item "
421 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
430 "<!ENTITY file-extended_states \"\n"
432 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
433 " <listitem><para>Status list of auto-installed packages.\n"
434 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
435 " </para></listitem>\n"
444 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
446 " to the other headers like NAME and DESCRIPTION and should therefore be "
448 "<!ENTITY translation-title \"TRANSLATION\">\n"
455 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
457 " to the translation in the past, who is responsible now and maybe "
458 "further information\n"
459 " specially related to your translation. -->\n"
460 "<!ENTITY translation-holder \"\n"
461 " The english translation was done by John Doe "
462 "<email>john@doe.org</email> in 2009,\n"
463 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
465 " Debian Dummy l10n Team "
466 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
474 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
475 "untranslated/fuzzy strings\n"
476 " in a shipped manpage newer/modified paragraphs will maybe appear in "
478 " the generated manpage. This sentence is therefore here to tell the "
480 " is not a mistake by the translator - obviously the target is that at "
482 " releases this sentence is not needed. :) -->\n"
483 "<!ENTITY translation-english \"\n"
484 " Note that this translated document may contain untranslated parts.\n"
485 " This is done on purpose, to avoid losing content when the\n"
486 " translation is lagging behind the original content.\n"
493 "<!-- TRANSLATOR: used as in -o=config_string "
494 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
501 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
502 "synopsis-config-file \"config_file\">"
508 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
509 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
510 "\"target_release\">"
516 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
517 "synopsis-architecture \"architecture\">"
523 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
524 "--> <!ENTITY synopsis-pkg \"pkg\">"
530 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
531 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
537 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
538 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
544 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
545 "awesome --> <!ENTITY synopsis-regex \"regex\">"
551 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
552 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
558 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
559 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
560 "\"temporary_directory\">"
566 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
567 "synopsis-filename \"filename\">"
573 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
574 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
580 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
581 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
588 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
589 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
596 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
597 "generate section --> <!ENTITY synopsis-section \"section\">"
603 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
604 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
607 #. type: Content of: <refentry><refmeta><manvolnum>
608 #: 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
612 #. type: Content of: <refentry><refmeta><refmiscinfo>
613 #: 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
617 #. type: Content of: <refentry><refnamediv><refpurpose>
618 #: apt-cache.8.xml:33
619 msgid "query the APT cache"
622 #. type: Content of: <refentry><refsect1><title>
623 #: 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
627 #. type: Content of: <refentry><refsect1><para>
628 #: apt-cache.8.xml:39
630 "<command>apt-cache</command> performs a variety of operations on APT's "
631 "package cache. <command>apt-cache</command> does not manipulate the state of "
632 "the system but does provide operations to search and generate interesting "
633 "output from the package metadata."
636 #. type: Content of: <refentry><refsect1><para>
637 #: apt-cache.8.xml:44 apt-get.8.xml:44
639 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
640 "one of the commands below must be present."
643 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
644 #: apt-cache.8.xml:49
646 "<literal>gencaches</literal> creates APT's package cache. This is done "
647 "implicitly by all commands needing this cache if it is missing or outdated."
650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
651 #: 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
652 msgid "&synopsis-pkg;"
655 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
656 #: apt-cache.8.xml:54
658 "<literal>showpkg</literal> displays information about the packages listed on "
659 "the command line. Remaining arguments are package names. The available "
660 "versions and reverse dependencies of each package listed are listed, as well "
661 "as forward dependencies for each version. Forward (normal) dependencies are "
662 "those packages upon which the package in question depends; reverse "
663 "dependencies are those packages that depend upon the package in "
664 "question. Thus, forward dependencies must be satisfied for a package, but "
665 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
666 "libreadline2</command> would produce output similar to the following:"
669 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
670 #: apt-cache.8.xml:66
673 "Package: libreadline2\n"
674 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
675 "Reverse Depends: \n"
676 " libreadlineg2,libreadline2\n"
677 " libreadline2-altdev,libreadline2\n"
679 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
682 "Reverse Provides: \n"
685 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
686 #: apt-cache.8.xml:78
688 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
689 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
690 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
691 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
692 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
693 "installed. For the specific meaning of the remainder of the output it is "
694 "best to consult the apt source code."
697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
698 #: apt-cache.8.xml:87
700 "<literal>stats</literal> displays some statistics about the cache. No "
701 "further arguments are expected. Statistics reported are:"
704 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
705 #: apt-cache.8.xml:90
707 "<literal>Total package names</literal> is the number of package names found "
711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
712 #: apt-cache.8.xml:94
714 "<literal>Normal packages</literal> is the number of regular, ordinary "
715 "package names; these are packages that bear a one-to-one correspondence "
716 "between their names and the names used by other packages for them in "
717 "dependencies. The majority of packages fall into this category."
720 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
721 #: apt-cache.8.xml:100
723 "<literal>Pure virtual packages</literal> is the number of packages that "
724 "exist only as a virtual package name; that is, packages only \"provide\" the "
725 "virtual package name, and no package actually uses the name. For instance, "
726 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
727 "package; several packages provide \"mail-transport-agent\", but there is no "
728 "package named \"mail-transport-agent\"."
731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
732 #: apt-cache.8.xml:108
734 "<literal>Single virtual packages</literal> is the number of packages with "
735 "only one package providing a particular virtual package. For example, in the "
736 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
737 "one package, xless, provides \"X11-text-viewer\"."
740 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
741 #: apt-cache.8.xml:114
743 "<literal>Mixed virtual packages</literal> is the number of packages that "
744 "either provide a particular virtual package or have the virtual package name "
745 "as the package name. For instance, in the Debian GNU/Linux system, "
746 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
751 #: apt-cache.8.xml:121
753 "<literal>Missing</literal> is the number of package names that were "
754 "referenced in a dependency but were not provided by any package. Missing "
755 "packages may be an evidence if a full distribution is not accessed, or if a "
756 "package (real or virtual) has been dropped from the distribution. Usually "
757 "they are referenced from Conflicts or Breaks statements."
760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
761 #: apt-cache.8.xml:128
763 "<literal>Total distinct</literal> versions is the number of package versions "
764 "found in the cache; this value is therefore at least equal to the number of "
765 "total package names. If more than one distribution (both \"stable\" and "
766 "\"unstable\", for instance), is being accessed, this value can be "
767 "considerably larger than the number of total package names."
770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
771 #: apt-cache.8.xml:135
773 "<literal>Total dependencies</literal> is the number of dependency "
774 "relationships claimed by all of the packages in the cache."
777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
778 #: apt-cache.8.xml:143
780 "<literal>showsrc</literal> displays all the source package records that "
781 "match the given package names. All versions are shown, as well as all "
782 "records that declare the name to be a Binary."
785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
786 #: apt-cache.8.xml:149
788 "<literal>dump</literal> shows a short listing of every package in the "
789 "cache. It is primarily for debugging."
792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
793 #: apt-cache.8.xml:154
795 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
796 "suitable for use with &dpkg; and is used by the &dselect; method."
799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
800 #: apt-cache.8.xml:159
802 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
807 #: apt-cache.8.xml:164
809 "<literal>show</literal> performs a function similar to <command>dpkg "
810 "--print-avail</command>; it displays the package records for the named "
814 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
815 #: apt-cache.8.xml:169
816 msgid "&synopsis-regex;"
819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
820 #: apt-cache.8.xml:170
822 "<literal>search</literal> performs a full text search on all available "
823 "package lists for the POSIX regex pattern given, see "
824 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
825 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
826 "the descriptions for an occurrence of the regular expression and prints out "
827 "the package name and the short description, including virtual package "
828 "names. If <option>--full</option> is given then output identical to "
829 "<literal>show</literal> is produced for each matched package, and if "
830 "<option>--names-only</option> is given then the long description is not "
831 "searched, only the package name is."
834 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
835 #: apt-cache.8.xml:183
837 "Separate arguments can be used to specify multiple search patterns that are "
841 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
842 #: apt-cache.8.xml:188
844 "<literal>depends</literal> shows a listing of each dependency a package has "
845 "and all the possible other packages that can fulfill that dependency."
848 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
849 #: apt-cache.8.xml:193
851 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
855 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
856 #: apt-cache.8.xml:197
857 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
861 #: apt-cache.8.xml:198
863 "This command prints the name of each package APT knows. The optional "
864 "argument is a prefix match to filter the name list. The output is suitable "
865 "for use in a shell tab complete function and the output is generated "
866 "extremely quickly. This command is best used with the "
867 "<option>--generate</option> option."
870 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
871 #: apt-cache.8.xml:203
873 "Note that a package which APT knows of is not necessarily available to "
874 "download, installable or installed, e.g. virtual packages are also listed in "
875 "the generated list."
878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
879 #: apt-cache.8.xml:209
881 "<literal>dotty</literal> takes a list of packages on the command line and "
882 "generates output suitable for use by dotty from the <ulink "
883 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
884 "package. The result will be a set of nodes and edges representing the "
885 "relationships between the packages. By default the given packages will trace "
886 "out all dependent packages; this can produce a very large graph. To limit "
887 "the output to only the packages listed on the command line, set the "
888 "<literal>APT::Cache::GivenOnly</literal> option."
891 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
892 #: apt-cache.8.xml:218
894 "The resulting nodes will have several shapes; normal packages are boxes, "
895 "pure provides are triangles, mixed provides are diamonds, missing packages "
896 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
897 "lines are pre-depends, green lines are conflicts."
900 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
901 #: apt-cache.8.xml:223
902 msgid "Caution, dotty cannot graph larger sets of packages."
905 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
906 #: apt-cache.8.xml:227
908 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
909 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
913 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
914 #: apt-cache.8.xml:231
915 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
919 #: apt-cache.8.xml:232
921 "<literal>policy</literal> is meant to help debug issues relating to the "
922 "preferences file. With no arguments it will print out the priorities of each "
923 "source. Otherwise it prints out detailed information about the priority "
924 "selection of the named package."
927 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
928 #: apt-cache.8.xml:239
930 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
931 "to mimic the output format and a subset of the functionality of the Debian "
932 "archive management tool, <literal>madison</literal>. It displays available "
933 "versions of a package in a tabular format. Unlike the original "
934 "<literal>madison</literal>, it can only display information for the "
935 "architecture for which APT has retrieved package lists "
936 "(<literal>APT::Architecture</literal>)."
939 #. type: Content of: <refentry><refsect1><title>
940 #: 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
944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
945 #: apt-cache.8.xml:255
947 "Select the file to store the package cache. The package cache is the primary "
948 "cache used by all operations. Configuration Item: "
949 "<literal>Dir::Cache::pkgcache</literal>."
952 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
953 #: apt-cache.8.xml:261
955 "Select the file to store the source cache. The source is used only by "
956 "<literal>gencaches</literal> and it stores a parsed version of the package "
957 "information from remote sources. When building the package cache the source "
958 "cache is used to avoid reparsing all of the package files. Configuration "
959 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
962 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
963 #: apt-cache.8.xml:269
965 "Quiet; produces output suitable for logging, omitting progress indicators. "
966 "More q's will produce more quietness up to a maximum of 2. You can also use "
967 "<option>-q=#</option> to set the quietness level, overriding the "
968 "configuration file. Configuration Item: <literal>quiet</literal>."
971 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
972 #: apt-cache.8.xml:276
974 "Print only important dependencies; for use with unmet and depends. Causes "
975 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
976 "<literal>APT::Cache::Important</literal>."
979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
980 #: apt-cache.8.xml:289
982 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
983 "print all dependencies. This can be tweaked with these flags which will omit "
984 "the specified dependency type. Configuration Item: "
985 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
986 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
990 #: apt-cache.8.xml:296
992 "Print full package records when searching. Configuration Item: "
993 "<literal>APT::Cache::ShowFull</literal>."
996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
997 #: apt-cache.8.xml:301
999 "Print full records for all available versions. This is the default; to turn "
1000 "it off, use <option>--no-all-versions</option>. If "
1001 "<option>--no-all-versions</option> is specified, only the candidate version "
1002 "will displayed (the one which would be selected for installation). This "
1003 "option is only applicable to the <literal>show</literal> command. "
1004 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1007 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1008 #: apt-cache.8.xml:310
1010 "Perform automatic package cache regeneration, rather than use the cache as "
1011 "it is. This is the default; to turn it off, use "
1012 "<option>--no-generate</option>. Configuration Item: "
1013 "<literal>APT::Cache::Generate</literal>."
1016 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1017 #: apt-cache.8.xml:316
1019 "Only search on the package names, not the long descriptions. Configuration "
1020 "Item: <literal>APT::Cache::NamesOnly</literal>."
1023 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1024 #: apt-cache.8.xml:321
1026 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1027 "and missing dependencies. Configuration Item: "
1028 "<literal>APT::Cache::AllNames</literal>."
1031 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1032 #: apt-cache.8.xml:327
1034 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1035 "that all packages mentioned are printed once. Configuration Item: "
1036 "<literal>APT::Cache::RecurseDepends</literal>."
1039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1040 #: apt-cache.8.xml:334
1042 "Limit the output of <literal>depends</literal> and "
1043 "<literal>rdepends</literal> to packages which are currently installed. "
1044 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1047 #. type: Content of: <refentry><refsect1><variablelist>
1048 #: 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
1049 msgid "&apt-commonoptions;"
1052 #. type: Content of: <refentry><refsect1><title>
1053 #: 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
1057 #. type: Content of: <refentry><refsect1><variablelist>
1058 #: apt-cache.8.xml:346
1059 msgid "&file-sourceslist; &file-statelists;"
1062 #. type: Content of: <refentry><refsect1><title>
1063 #: 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
1067 #. type: Content of: <refentry><refsect1><para>
1068 #: apt-cache.8.xml:352
1069 msgid "&apt-conf;, &sources-list;, &apt-get;"
1072 #. type: Content of: <refentry><refsect1><title>
1073 #: 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
1077 #. type: Content of: <refentry><refsect1><para>
1078 #: apt-cache.8.xml:357
1080 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1084 #. type: Content of: <refentry><refnamediv><refpurpose>
1085 #: apt-cdrom.8.xml:32
1086 msgid "APT CDROM management utility"
1089 #. type: Content of: <refentry><refsect1><para>
1090 #: apt-cdrom.8.xml:38
1092 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1093 "available sources. <command>apt-cdrom</command> takes care of determining "
1094 "the structure of the disc as well as correcting for several possible "
1095 "mis-burns and verifying the index files."
1098 #. type: Content of: <refentry><refsect1><para>
1099 #: apt-cdrom.8.xml:45
1101 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1102 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1103 "must be inserted and scanned separately to account for possible mis-burns."
1106 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1107 #: apt-cdrom.8.xml:56
1109 "<literal>add</literal> is used to add a new disc to the source list. It will "
1110 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1111 "to scan it and copy the index files. If the disc does not have a proper "
1112 "<filename>disk</filename> directory you will be prompted for a descriptive "
1116 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1117 #: apt-cdrom.8.xml:64
1119 "APT uses a CDROM ID to track which disc is currently in the drive and "
1120 "maintains a database of these IDs in "
1121 "<filename>&statedir;/cdroms.list</filename>"
1124 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1125 #: apt-cdrom.8.xml:72
1127 "A debugging tool to report the identity of the current disc as well as the "
1131 #. type: Content of: <refentry><refsect1><para>
1132 #: apt-cdrom.8.xml:51
1134 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1135 "one of the commands below must be present. <placeholder "
1136 "type=\"variablelist\" id=\"0\"/>"
1139 #. type: Content of: <refentry><refsect1><title>
1140 #: apt-cdrom.8.xml:81 apt-key.8.xml:160
1144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1145 #: apt-cdrom.8.xml:86
1147 "Mount point; specify the location to mount the cdrom. This mount point must "
1148 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1149 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1153 #: apt-cdrom.8.xml:95
1155 "Rename a disc; change the label of a disk or override the disks given "
1156 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1157 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1160 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1161 #: apt-cdrom.8.xml:104
1163 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1164 "unmounting the mount point. Configuration Item: "
1165 "<literal>APT::CDROM::NoMount</literal>."
1168 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1169 #: apt-cdrom.8.xml:112
1171 "Fast Copy; Assume the package files are valid and do not check every "
1172 "package. This option should be used only if <command>apt-cdrom</command> has "
1173 "been run on this disc before and did not detect any errors. Configuration "
1174 "Item: <literal>APT::CDROM::Fast</literal>."
1177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1178 #: apt-cdrom.8.xml:122
1180 "Thorough Package Scan; This option may be needed with some old Debian "
1181 "1.1/1.2 discs that have Package files in strange places. It takes much "
1182 "longer to scan the CD but will pick them all up."
1185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1186 #: apt-cdrom.8.xml:133
1188 "No Changes; Do not change the &sources-list; file and do not write index "
1189 "files. Everything is still checked however. Configuration Item: "
1190 "<literal>APT::CDROM::NoAct</literal>."
1193 #. type: Content of: <refentry><refsect1><para>
1194 #: apt-cdrom.8.xml:146
1195 msgid "&apt-conf;, &apt-get;, &sources-list;"
1198 #. type: Content of: <refentry><refsect1><para>
1199 #: apt-cdrom.8.xml:151
1201 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1205 #. type: Content of: <refentry><refnamediv><refpurpose>
1206 #: apt-config.8.xml:33
1207 msgid "APT Configuration Query program"
1210 #. type: Content of: <refentry><refsect1><para>
1211 #: apt-config.8.xml:39
1213 "<command>apt-config</command> is an internal program used by various "
1214 "portions of the APT suite to provide consistent configurability. It accesses "
1215 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1216 "manner that is easy to use by scripted applications."
1219 #. type: Content of: <refentry><refsect1><para>
1220 #: apt-config.8.xml:44 apt-ftparchive.1.xml:54
1222 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1223 "one of the commands below must be present."
1226 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1227 #: apt-config.8.xml:51
1229 "shell is used to access the configuration information from a shell "
1230 "script. It is given pairs of arguments, the first being a shell variable and "
1231 "the second the configuration value to query. As output it lists a series of "
1232 "shell assignments commands for each present value. In a shell script it "
1233 "should be used like:"
1236 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1237 #: apt-config.8.xml:59
1241 "RES=`apt-config shell OPTS MyApp::options`\n"
1245 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1246 #: apt-config.8.xml:64
1248 "This will set the shell environment variable $OPTS to the value of "
1249 "MyApp::options with a default of <option>-f</option>."
1252 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1253 #: apt-config.8.xml:68
1255 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1256 "names, d returns directories, b returns true or false and i returns an "
1257 "integer. Each of the returns is normalized and verified internally."
1260 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1261 #: apt-config.8.xml:77
1262 msgid "Just show the contents of the configuration space."
1265 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1266 #: apt-config.8.xml:90
1268 "Include options which have an empty value. This is the default, so use "
1269 "--no-empty to remove them from the output."
1272 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1273 #: apt-config.8.xml:95
1274 msgid "%f "%v";%n"
1277 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1278 #: apt-config.8.xml:96
1280 "Defines the output of each config option. %t will be replaced with "
1281 "the name of the option, %f with the complete optionname and %v "
1282 "with the value of the option. Use uppercase letters and special characters "
1283 "in the value will be encoded to ensure that it can e.g. be savely used in a "
1284 "quoted-string as defined by RFC822. Additionally %n will be replaced "
1285 "by a newline, %N by a tab. A % can be printed by using "
1289 #. type: Content of: <refentry><refsect1><para>
1290 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1294 #. type: Content of: <refentry><refsect1><para>
1295 #: apt-config.8.xml:115
1297 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1301 #. type: Content of: <refentry><refmeta><manvolnum>
1302 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1306 #. type: Content of: <refentry><refnamediv><refpurpose>
1307 #: apt-extracttemplates.1.xml:33
1308 msgid "Utility to extract DebConf config and templates from Debian packages"
1311 #. type: Content of: <refentry><refsect1><para>
1312 #: apt-extracttemplates.1.xml:39
1314 "<command>apt-extracttemplates</command> will take one or more Debian package "
1315 "files as input and write out (to a temporary directory) all associated "
1316 "config scripts and template files. For each passed in package that contains "
1317 "config scripts and templates, one line of output will be generated in the "
1321 #. type: Content of: <refentry><refsect1><para>
1322 #: apt-extracttemplates.1.xml:44
1323 msgid "package version template-file config-script"
1326 #. type: Content of: <refentry><refsect1><para>
1327 #: apt-extracttemplates.1.xml:45
1329 "template-file and config-script are written to the temporary directory "
1330 "specified by the <option>-t</option> or <option>--tempdir</option> "
1331 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1332 "filenames of the form <filename>package.template.XXXX</filename> and "
1333 "<filename>package.config.XXXX</filename>"
1336 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1337 #: apt-extracttemplates.1.xml:58
1339 "Temporary directory in which to write extracted debconf template files and "
1340 "config scripts. Configuration Item: "
1341 "<literal>APT::ExtractTemplates::TempDir</literal>"
1344 #. type: Content of: <refentry><refsect1><para>
1345 #: apt-extracttemplates.1.xml:75
1347 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1348 "decimal 100 on error."
1351 #. type: Content of: <refentry><refnamediv><refpurpose>
1352 #: apt-ftparchive.1.xml:33
1353 msgid "Utility to generate index files"
1356 #. type: Content of: <refentry><refsect1><para>
1357 #: apt-ftparchive.1.xml:39
1359 "<command>apt-ftparchive</command> is the command line tool that generates "
1360 "the index files that APT uses to access a distribution source. The index "
1361 "files should be generated on the origin site based on the content of that "
1365 #. type: Content of: <refentry><refsect1><para>
1366 #: apt-ftparchive.1.xml:43
1368 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1369 "program, incorporating its entire functionality via the "
1370 "<literal>packages</literal> command. It also contains a contents file "
1371 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1372 "the generation process for a complete archive."
1375 #. type: Content of: <refentry><refsect1><para>
1376 #: apt-ftparchive.1.xml:49
1378 "Internally <command>apt-ftparchive</command> can make use of binary "
1379 "databases to cache the contents of a .deb file and it does not rely on any "
1380 "external programs aside from &gzip;. When doing a full generate it "
1381 "automatically performs file-change checks and builds the desired compressed "
1385 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1386 #: apt-ftparchive.1.xml:60
1388 "The packages command generates a package file from a directory tree. It "
1389 "takes the given directory and recursively searches it for .deb files, "
1390 "emitting a package record to stdout for each. This command is approximately "
1391 "equivalent to &dpkg-scanpackages;."
1394 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1395 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1396 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1399 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1400 #: apt-ftparchive.1.xml:70
1402 "The <literal>sources</literal> command generates a source index file from a "
1403 "directory tree. It takes the given directory and recursively searches it "
1404 "for .dsc files, emitting a source record to stdout for each. This command is "
1405 "approximately equivalent to &dpkg-scansources;."
1408 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1409 #: apt-ftparchive.1.xml:75
1411 "If an override file is specified then a source override file will be looked "
1412 "for with an extension of .src. The --source-override option can be used to "
1413 "change the source override file that will be used."
1416 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1417 #: apt-ftparchive.1.xml:82
1419 "The <literal>contents</literal> command generates a contents file from a "
1420 "directory tree. It takes the given directory and recursively searches it for "
1421 ".deb files, and reads the file list from each file. It then sorts and writes "
1422 "to stdout the list of files matched to packages. Directories are not written "
1423 "to the output. If multiple packages own the same file then each package is "
1424 "separated by a comma in the output."
1427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1428 #: apt-ftparchive.1.xml:94
1430 "The <literal>release</literal> command generates a Release file from a "
1431 "directory tree. It recursively searches the given directory for uncompressed "
1432 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1433 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1434 "<command>lzma</command> as well as <filename>Release</filename> and "
1435 "<filename>md5sum.txt</filename> files by default "
1436 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1437 "filename patterns can be added by listing them in "
1438 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1439 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1444 #: apt-ftparchive.1.xml:104
1446 "Values for the additional metadata fields in the Release file are taken from "
1447 "the corresponding variables under "
1448 "<literal>APT::FTPArchive::Release</literal>, "
1449 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1450 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1451 "<literal>Suite</literal>, <literal>Version</literal>, "
1452 "<literal>Codename</literal>, <literal>Date</literal>, "
1453 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1454 "<literal>Components</literal>, <literal>Description</literal>."
1457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1458 #: apt-ftparchive.1.xml:117
1460 "The <literal>generate</literal> command is designed to be runnable from a "
1461 "cron script and builds indexes according to the given config file. The "
1462 "config language provides a flexible means of specifying which index files "
1463 "are built from which directories, as well as providing a simple means of "
1464 "maintaining the required settings."
1467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1468 #: apt-ftparchive.1.xml:126
1470 "The <literal>clean</literal> command tidies the databases used by the given "
1471 "configuration file by removing any records that are no longer necessary."
1474 #. type: Content of: <refentry><refsect1><title>
1475 #: apt-ftparchive.1.xml:132
1476 msgid "The Generate Configuration"
1479 #. type: Content of: <refentry><refsect1><para>
1480 #: apt-ftparchive.1.xml:134
1482 "The <literal>generate</literal> command uses a configuration file to "
1483 "describe the archives that are going to be generated. It follows the typical "
1484 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1485 "&apt-conf; contains a description of the syntax. Note that the generate "
1486 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1487 "tree manner. This only effects how the scope tag is handled."
1490 #. type: Content of: <refentry><refsect1><para>
1491 #: apt-ftparchive.1.xml:142
1492 msgid "The generate configuration has 4 separate sections, each described below."
1495 #. type: Content of: <refentry><refsect1><refsect2><title>
1496 #: apt-ftparchive.1.xml:144
1500 #. type: Content of: <refentry><refsect1><refsect2><para>
1501 #: apt-ftparchive.1.xml:146
1503 "The <literal>Dir</literal> section defines the standard directories needed "
1504 "to locate the files required during the generation process. These "
1505 "directories are prepended certain relative paths defined in later sections "
1506 "to produce a complete an absolute path."
1509 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1510 #: apt-ftparchive.1.xml:153
1512 "Specifies the root of the FTP archive, in a standard Debian configuration "
1513 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1517 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1518 #: apt-ftparchive.1.xml:160
1519 msgid "Specifies the location of the override files."
1522 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1523 #: apt-ftparchive.1.xml:165
1524 msgid "Specifies the location of the cache files"
1527 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1528 #: apt-ftparchive.1.xml:170
1530 "Specifies the location of the file list files, if the "
1531 "<literal>FileList</literal> setting is used below."
1534 #. type: Content of: <refentry><refsect1><refsect2><title>
1535 #: apt-ftparchive.1.xml:176
1536 msgid "Default Section"
1539 #. type: Content of: <refentry><refsect1><refsect2><para>
1540 #: apt-ftparchive.1.xml:178
1542 "The <literal>Default</literal> section specifies default values, and "
1543 "settings that control the operation of the generator. Other sections may "
1544 "override these defaults with a per-section setting."
1547 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1548 #: apt-ftparchive.1.xml:184
1550 "Sets the default compression schemes to use for the Package index files. It "
1551 "is a string that contains a space separated list of at least one of: '.' (no "
1552 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1556 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1557 #: apt-ftparchive.1.xml:192
1559 "Sets the default list of file extensions that are package files. This "
1560 "defaults to '.deb'."
1563 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1564 #: apt-ftparchive.1.xml:198
1566 "This is similar to <literal>Packages::Compress</literal> except that it "
1567 "controls the compression for the Sources files."
1570 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1571 #: apt-ftparchive.1.xml:204
1573 "Sets the default list of file extensions that are source files. This "
1574 "defaults to '.dsc'."
1577 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1578 #: apt-ftparchive.1.xml:210
1580 "This is similar to <literal>Packages::Compress</literal> except that it "
1581 "controls the compression for the Contents files."
1584 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1585 #: apt-ftparchive.1.xml:216
1587 "This is similar to <literal>Packages::Compress</literal> except that it "
1588 "controls the compression for the Translation-en master file."
1591 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1592 #: apt-ftparchive.1.xml:222
1594 "Specifies the number of kilobytes to delink (and replace with hard links) "
1595 "per run. This is used in conjunction with the per-section "
1596 "<literal>External-Links</literal> setting."
1599 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1600 #: apt-ftparchive.1.xml:229
1602 "Specifies the mode of all created index files. It defaults to 0644. All "
1603 "index files are set to this mode with no regard to the umask."
1606 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1607 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
1609 "Sets if long descriptions should be included in the Packages file or split "
1610 "out into a master Translation-en file."
1613 #. type: Content of: <refentry><refsect1><refsect2><title>
1614 #: apt-ftparchive.1.xml:242
1615 msgid "TreeDefault Section"
1618 #. type: Content of: <refentry><refsect1><refsect2><para>
1619 #: apt-ftparchive.1.xml:244
1621 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
1622 "variables are substitution variables and have the strings $(DIST), "
1623 "$(SECTION) and $(ARCH) replaced with their respective values."
1626 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1627 #: apt-ftparchive.1.xml:251
1629 "Sets the number of kilobytes of contents files that are generated each "
1630 "day. The contents files are round-robined so that over several days they "
1631 "will all be rebuilt."
1634 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1635 #: apt-ftparchive.1.xml:258
1637 "Controls the number of days a contents file is allowed to be checked without "
1638 "changing. If this limit is passed the mtime of the contents file is "
1639 "updated. This case can occur if the package file is changed in such a way "
1640 "that does not result in a new contents file [override edit for instance]. A "
1641 "hold off is allowed in hopes that new .debs will be installed, requiring a "
1642 "new file anyhow. The default is 10, the units are in days."
1645 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1646 #: apt-ftparchive.1.xml:269
1648 "Sets the top of the .deb directory tree. Defaults to "
1649 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
1652 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1653 #: apt-ftparchive.1.xml:275
1655 "Sets the top of the source package directory tree. Defaults to "
1656 "<filename>$(DIST)/$(SECTION)/source/</filename>"
1659 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1660 #: apt-ftparchive.1.xml:281
1662 "Sets the output Packages file. Defaults to "
1663 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
1666 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1667 #: apt-ftparchive.1.xml:287
1669 "Sets the output Sources file. Defaults to "
1670 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
1673 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1674 #: apt-ftparchive.1.xml:293
1676 "Set the output Translation-en master file with the long descriptions if they "
1677 "should be not included in the Packages file. Defaults to "
1678 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
1681 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1682 #: apt-ftparchive.1.xml:300
1684 "Sets the path prefix that causes a symlink to be considered an internal link "
1685 "instead of an external link. Defaults to "
1686 "<filename>$(DIST)/$(SECTION)/</filename>"
1689 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1690 #: apt-ftparchive.1.xml:307
1692 "Sets the output Contents file. Defaults to "
1693 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
1694 "multiple Packages files to map onto a single Contents file (such as the "
1695 "default) then <command>apt-ftparchive</command> will integrate those "
1696 "package files together automatically."
1699 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1700 #: apt-ftparchive.1.xml:316
1701 msgid "Sets header file to prepend to the contents output."
1704 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1705 #: apt-ftparchive.1.xml:321
1707 "Sets the binary cache database to use for this section. Multiple sections "
1708 "can share the same database."
1711 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1712 #: apt-ftparchive.1.xml:327
1714 "Specifies that instead of walking the directory tree, "
1715 "<command>apt-ftparchive</command> should read the list of files from the "
1716 "given file. Relative files names are prefixed with the archive directory."
1719 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1720 #: apt-ftparchive.1.xml:334
1722 "Specifies that instead of walking the directory tree, "
1723 "<command>apt-ftparchive</command> should read the list of files from the "
1724 "given file. Relative files names are prefixed with the archive directory. "
1725 "This is used when processing source indexes."
1728 #. type: Content of: <refentry><refsect1><refsect2><title>
1729 #: apt-ftparchive.1.xml:342
1730 msgid "Tree Section"
1733 #. type: Content of: <refentry><refsect1><refsect2><para>
1734 #: apt-ftparchive.1.xml:344
1736 "The <literal>Tree</literal> section defines a standard Debian file tree "
1737 "which consists of a base directory, then multiple sections in that base "
1738 "directory and finally multiple Architectures in each section. The exact "
1739 "pathing used is defined by the <literal>Directory</literal> substitution "
1743 #. type: Content of: <refentry><refsect1><refsect2><para>
1744 #: apt-ftparchive.1.xml:349
1746 "The <literal>Tree</literal> section takes a scope tag which sets the "
1747 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
1748 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
1749 "setting such as <filename>dists/&stable-codename;</filename>."
1752 #. type: Content of: <refentry><refsect1><refsect2><para>
1753 #: apt-ftparchive.1.xml:354
1755 "All of the settings defined in the <literal>TreeDefault</literal> section "
1756 "can be use in a <literal>Tree</literal> section as well as three new "
1760 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
1761 #: apt-ftparchive.1.xml:360
1764 "for i in Sections do \n"
1765 " for j in Architectures do\n"
1766 " Generate for DIST=scope SECTION=i ARCH=j\n"
1770 #. type: Content of: <refentry><refsect1><refsect2><para>
1771 #: apt-ftparchive.1.xml:357
1773 "When processing a <literal>Tree</literal> section "
1774 "<command>apt-ftparchive</command> performs an operation similar to: "
1775 "<placeholder type=\"programlisting\" id=\"0\"/>"
1778 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1779 #: apt-ftparchive.1.xml:368
1781 "This is a space separated list of sections which appear under the "
1782 "distribution, typically this is something like <literal>main contrib "
1783 "non-free</literal>"
1786 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1787 #: apt-ftparchive.1.xml:375
1789 "This is a space separated list of all the architectures that appear under "
1790 "search section. The special architecture 'source' is used to indicate that "
1791 "this tree has a source archive."
1794 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1795 #: apt-ftparchive.1.xml:388
1797 "Sets the binary override file. The override file contains section, priority "
1798 "and maintainer address information."
1801 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1802 #: apt-ftparchive.1.xml:394
1804 "Sets the source override file. The override file contains section "
1808 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1809 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
1810 msgid "Sets the binary extra override file."
1813 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1814 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
1815 msgid "Sets the source extra override file."
1818 #. type: Content of: <refentry><refsect1><refsect2><title>
1819 #: apt-ftparchive.1.xml:410
1820 msgid "BinDirectory Section"
1823 #. type: Content of: <refentry><refsect1><refsect2><para>
1824 #: apt-ftparchive.1.xml:412
1826 "The <literal>bindirectory</literal> section defines a binary directory tree "
1827 "with no special structure. The scope tag specifies the location of the "
1828 "binary directory and the settings are similar to the <literal>Tree</literal> "
1829 "section with no substitution variables or "
1830 "<literal>Section</literal><literal>Architecture</literal> settings."
1833 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1834 #: apt-ftparchive.1.xml:420
1835 msgid "Sets the Packages file output."
1838 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1839 #: apt-ftparchive.1.xml:425
1841 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
1842 "<literal>Sources</literal> is required."
1845 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1846 #: apt-ftparchive.1.xml:431
1847 msgid "Sets the Contents file output. (optional)"
1850 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1851 #: apt-ftparchive.1.xml:436
1852 msgid "Sets the binary override file."
1855 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1856 #: apt-ftparchive.1.xml:441
1857 msgid "Sets the source override file."
1860 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1861 #: apt-ftparchive.1.xml:456
1862 msgid "Sets the cache DB."
1865 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1866 #: apt-ftparchive.1.xml:461
1867 msgid "Appends a path to all the output paths."
1870 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1871 #: apt-ftparchive.1.xml:466
1872 msgid "Specifies the file list file."
1875 #. type: Content of: <refentry><refsect1><title>
1876 #: apt-ftparchive.1.xml:473
1877 msgid "The Binary Override File"
1880 #. type: Content of: <refentry><refsect1><para>
1881 #: apt-ftparchive.1.xml:474
1883 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
1884 "contains 4 fields separated by spaces. The first field is the package name, "
1885 "the second is the priority to force that package to, the third is the the "
1886 "section to force that package to and the final field is the maintainer "
1887 "permutation field."
1890 #. type: Content of: <refentry><refsect1><para><literallayout>
1891 #: apt-ftparchive.1.xml:480
1893 msgid "old [// oldn]* => new"
1896 #. type: Content of: <refentry><refsect1><para><literallayout>
1897 #: apt-ftparchive.1.xml:482
1902 #. type: Content of: <refentry><refsect1><para>
1903 #: apt-ftparchive.1.xml:479
1905 "The general form of the maintainer field is: <placeholder "
1906 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
1907 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
1908 "separated list of old email addresses to be specified. If any of those are "
1909 "found then new is substituted for the maintainer field. The second form "
1910 "unconditionally substitutes the maintainer field."
1913 #. type: Content of: <refentry><refsect1><title>
1914 #: apt-ftparchive.1.xml:490
1915 msgid "The Source Override File"
1918 #. type: Content of: <refentry><refsect1><para>
1919 #: apt-ftparchive.1.xml:492
1921 "The source override file is fully compatible with &dpkg-scansources;. It "
1922 "contains 2 fields separated by spaces. The first fields is the source "
1923 "package name, the second is the section to assign it."
1926 #. type: Content of: <refentry><refsect1><title>
1927 #: apt-ftparchive.1.xml:497
1928 msgid "The Extra Override File"
1931 #. type: Content of: <refentry><refsect1><para>
1932 #: apt-ftparchive.1.xml:499
1934 "The extra override file allows any arbitrary tag to be added or replaced in "
1935 "the output. It has 3 columns, the first is the package, the second is the "
1936 "tag and the remainder of the line is the new value."
1939 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1940 #: apt-ftparchive.1.xml:510
1942 "Generate the given checksum. These options default to on, when turned off "
1943 "the generated index files will not have the checksum fields where possible. "
1944 "Configuration Items: "
1945 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
1946 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
1947 "where <literal><replaceable>Index</replaceable></literal> can be "
1948 "<literal>Packages</literal>, <literal>Sources</literal> or "
1949 "<literal>Release</literal> and "
1950 "<literal><replaceable>Checksum</replaceable></literal> can be "
1951 "<literal>MD5</literal>, <literal>SHA1</literal> or "
1952 "<literal>SHA256</literal>."
1955 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1956 #: apt-ftparchive.1.xml:521
1958 "Use a binary caching DB. This has no effect on the generate command. "
1959 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
1962 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1963 #: apt-ftparchive.1.xml:527
1965 "Quiet; produces output suitable for logging, omitting progress indicators. "
1966 "More q's will produce more quiet up to a maximum of 2. You can also use "
1967 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1968 "file. Configuration Item: <literal>quiet</literal>."
1971 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1972 #: apt-ftparchive.1.xml:535
1974 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
1975 "then this option actually enables delinking of the files. It defaults to on "
1976 "and can be turned off with <option>--no-delink</option>. Configuration "
1977 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
1980 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1981 #: apt-ftparchive.1.xml:543
1983 "Perform contents generation. When this option is set and package indexes are "
1984 "being generated with a cache DB then the file listing will also be extracted "
1985 "and stored in the DB for later use. When using the generate command this "
1986 "option also allows the creation of any Contents files. The default is on. "
1987 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
1990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1991 #: apt-ftparchive.1.xml:553
1993 "Select the source override file to use with the <literal>sources</literal> "
1994 "command. Configuration Item: "
1995 "<literal>APT::FTPArchive::SourceOverride</literal>."
1998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1999 #: apt-ftparchive.1.xml:559
2001 "Make the caching databases read only. Configuration Item: "
2002 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2005 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2006 #: apt-ftparchive.1.xml:564
2008 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2009 "commands only package files matching <literal>*_arch.deb</literal> or "
2010 "<literal>*_all.deb</literal> instead of all package files in the given "
2011 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2015 #: apt-ftparchive.1.xml:572
2017 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2018 "packages are recompiled and/or republished with the same version again, this "
2019 "will lead to problems as the now outdated cached metadata like size and "
2020 "checksums will be used. With this option enabled this will no longer happen "
2021 "as it will be checked if the file was changed. Note that this option is set "
2022 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2023 "multiply versions/builds of a package with the same versionnumber, so in "
2024 "theory nobody will have these problems and therefore all these extra checks "
2028 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2029 #: apt-ftparchive.1.xml:584
2031 "This configuration option defaults to \"<literal>true</literal>\" and should "
2032 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2033 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2034 "that the <filename>Translation-en</filename> master file can only be created "
2035 "in the generate command."
2038 #. type: Content of: <refentry><refsect1><title>
2039 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1112 apt_preferences.5.xml:545 sources.list.5.xml:214
2043 #. type: Content of: <refentry><refsect1><para><programlisting>
2044 #: apt-ftparchive.1.xml:602
2047 "<command>apt-ftparchive</command> packages "
2048 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2049 "<filename>Packages.gz</filename>\n"
2052 #. type: Content of: <refentry><refsect1><para>
2053 #: apt-ftparchive.1.xml:598
2055 "To create a compressed Packages file for a directory containing binary "
2056 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2059 #. type: Content of: <refentry><refsect1><para>
2060 #: apt-ftparchive.1.xml:612
2062 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2066 #. type: Content of: <refentry><refnamediv><refpurpose>
2068 msgid "APT package handling utility -- command-line interface"
2071 #. type: Content of: <refentry><refsect1><para>
2074 "<command>apt-get</command> is the command-line tool for handling packages, "
2075 "and may be considered the user's \"back-end\" to other tools using the APT "
2076 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2077 "&aptitude;, &synaptic; and &wajig;."
2080 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2083 "<literal>update</literal> is used to resynchronize the package index files "
2084 "from their sources. The indexes of available packages are fetched from the "
2085 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2086 "example, when using a Debian archive, this command retrieves and scans the "
2087 "<filename>Packages.gz</filename> files, so that information about new and "
2088 "updated packages is available. An <literal>update</literal> should always be "
2089 "performed before an <literal>upgrade</literal> or "
2090 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2091 "meter will be incorrect as the size of the package files cannot be known in "
2095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2098 "<literal>upgrade</literal> is used to install the newest versions of all "
2099 "packages currently installed on the system from the sources enumerated in "
2100 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2101 "with new versions available are retrieved and upgraded; under no "
2102 "circumstances are currently installed packages removed, or packages not "
2103 "already installed retrieved and installed. New versions of currently "
2104 "installed packages that cannot be upgraded without changing the install "
2105 "status of another package will be left at their current version. An "
2106 "<literal>update</literal> must be performed first so that "
2107 "<command>apt-get</command> knows that new versions of packages are "
2111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2114 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2115 "traditional Debian packaging front-end, "
2116 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2117 "&dselect; to the <literal>Status</literal> field of available packages, and "
2118 "performs the actions necessary to realize that state (for instance, the "
2119 "removal of old and the installation of new packages)."
2122 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2125 "<literal>dist-upgrade</literal> in addition to performing the function of "
2126 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2127 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2128 "conflict resolution system, and it will attempt to upgrade the most "
2129 "important packages at the expense of less important ones if necessary. So, "
2130 "<literal>dist-upgrade</literal> command may remove some packages. The "
2131 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2132 "from which to retrieve desired package files. See also &apt-preferences; "
2133 "for a mechanism for overriding the general settings for individual packages."
2136 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2139 "<literal>install</literal> is followed by one or more packages desired for "
2140 "installation or upgrading. Each package is a package name, not a fully "
2141 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2142 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2143 "packages required by the package(s) specified for installation will also be "
2144 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2145 "file is used to locate the desired packages. If a hyphen is appended to the "
2146 "package name (with no intervening space), the identified package will be "
2147 "removed if it is installed. Similarly a plus sign can be used to designate "
2148 "a package to install. These latter features may be used to override "
2149 "decisions made by apt-get's conflict resolution system."
2152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2153 #: apt-get.8.xml:116
2155 "A specific version of a package can be selected for installation by "
2156 "following the package name with an equals and the version of the package to "
2157 "select. This will cause that version to be located and selected for "
2158 "install. Alternatively a specific distribution can be selected by following "
2159 "the package name with a slash and the version of the distribution or the "
2160 "Archive name (stable, testing, unstable)."
2163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2164 #: apt-get.8.xml:123
2166 "Both of the version selection mechanisms can downgrade packages and must be "
2170 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2171 #: apt-get.8.xml:126
2173 "This is also the target to use if you want to upgrade one or more "
2174 "already-installed packages without upgrading every package you have on your "
2175 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2176 "all currently installed packages, \"install\" will install the newest "
2177 "version of only the package(s) specified. Simply provide the name of the "
2178 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2179 "its dependencies, as described above) will be downloaded and installed."
2182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2183 #: apt-get.8.xml:137
2185 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2186 "installation policy for individual packages."
2189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2190 #: apt-get.8.xml:141
2192 "If no package matches the given expression and the expression contains one "
2193 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2194 "it is applied to all package names in the database. Any matches are then "
2195 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2196 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2197 "expression with a '^' or '$' character, or create a more specific regular "
2201 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2202 #: apt-get.8.xml:151
2204 "<literal>remove</literal> is identical to <literal>install</literal> except "
2205 "that packages are removed instead of installed. Note the removing a package "
2206 "leaves its configuration files in system. If a plus sign is appended to the "
2207 "package name (with no intervening space), the identified package will be "
2208 "installed instead of removed."
2211 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2212 #: apt-get.8.xml:159
2214 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2215 "that packages are removed and purged (any configuration files are deleted "
2219 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2220 #: apt-get.8.xml:164
2222 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2223 "packages. APT will examine the available packages to decide which source "
2224 "package to fetch. It will then find and download into the current directory "
2225 "the newest available version of that source package while respecting the "
2226 "default release, set with the option "
2227 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2228 "per package with the <literal>pkg/release</literal> syntax, if possible."
2231 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2232 #: apt-get.8.xml:172
2234 "Source packages are tracked separately from binary packages via "
2235 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2236 "that you will need to add such a line for each repository you want to get "
2237 "sources from. If you don't do this you will properly get another (newer, "
2238 "older or none) source version than the one you have installed or could "
2242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2243 #: apt-get.8.xml:179
2245 "If the <option>--compile</option> option is specified then the package will "
2246 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2247 "the architecture as defined by the <command>--host-architecture</command> "
2248 "option. If <option>--download-only</option> is specified then the source "
2249 "package will not be unpacked."
2252 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2253 #: apt-get.8.xml:186
2255 "A specific source version can be retrieved by postfixing the source name "
2256 "with an equals and then the version to fetch, similar to the mechanism used "
2257 "for the package files. This enables exact matching of the source package "
2258 "name and version, implicitly enabling the "
2259 "<literal>APT::Get::Only-Source</literal> option."
2262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2263 #: apt-get.8.xml:192
2265 "Note that source packages are not tracked like binary packages, they exist "
2266 "only in the current directory and are similar to downloading source tar "
2270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2271 #: apt-get.8.xml:198
2273 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2274 "attempt to satisfy the build dependencies for a source package. By default "
2275 "the dependencies are satisfied to build the package natively. If desired a "
2276 "host-architecture can be specified with the "
2277 "<option>--host-architecture</option> option instead."
2280 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2281 #: apt-get.8.xml:205
2283 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2284 "and checks for broken dependencies."
2287 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2288 #: apt-get.8.xml:210
2290 "<literal>download</literal> will download the given binary package into the "
2291 "current directory."
2294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2295 #: apt-get.8.xml:216
2297 "<literal>clean</literal> clears out the local repository of retrieved "
2298 "package files. It removes everything but the lock file from "
2299 "<filename>&cachedir;/archives/</filename> and "
2300 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2301 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2302 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2303 "from time to time to free up disk space."
2306 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2307 #: apt-get.8.xml:226
2309 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2310 "local repository of retrieved package files. The difference is that it only "
2311 "removes package files that can no longer be downloaded, and are largely "
2312 "useless. This allows a cache to be maintained over a long period without it "
2313 "growing out of control. The configuration option "
2314 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2315 "being erased if it is set to off."
2318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2319 #: apt-get.8.xml:236
2321 "<literal>autoremove</literal> is used to remove packages that were "
2322 "automatically installed to satisfy dependencies for other packages and are "
2323 "now no longer needed."
2326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2327 #: apt-get.8.xml:241
2329 "<literal>changelog</literal> downloads a package changelog and displays it "
2330 "through <command>sensible-pager</command>. The server name and base "
2331 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2332 "variable (e. g. <ulink "
2333 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
2334 "for Debian or <ulink "
2335 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
2336 "for Ubuntu). By default it displays the changelog for the version that is "
2337 "installed. However, you can specify the same options as for the "
2338 "<option>install</option> command."
2341 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2342 #: apt-get.8.xml:264
2344 "Do not consider recommended packages as a dependency for installing. "
2345 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2348 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2349 #: apt-get.8.xml:269
2351 "Consider suggested packages as a dependency for installing. Configuration "
2352 "Item: <literal>APT::Install-Suggests</literal>."
2355 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2356 #: apt-get.8.xml:274
2358 "Download only; package files are only retrieved, not unpacked or installed. "
2359 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
2362 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2363 #: apt-get.8.xml:279
2365 "Fix; attempt to correct a system with broken dependencies in place. This "
2366 "option, when used with install/remove, can omit any packages to permit APT "
2367 "to deduce a likely solution. If packages are specified, these have to "
2368 "completely correct the problem. The option is sometimes necessary when "
2369 "running APT for the first time; APT itself does not allow broken package "
2370 "dependencies to exist on a system. It is possible that a system's dependency "
2371 "structure can be so corrupt as to require manual intervention (which usually "
2372 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
2373 "of the offending packages). Use of this option together with "
2374 "<option>-m</option> may produce an error in some situations. Configuration "
2375 "Item: <literal>APT::Get::Fix-Broken</literal>."
2378 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2379 #: apt-get.8.xml:294
2381 "Ignore missing packages; If packages cannot be retrieved or fail the "
2382 "integrity check after retrieval (corrupted package files), hold back those "
2383 "packages and handle the result. Use of this option together with "
2384 "<option>-f</option> may produce an error in some situations. If a package is "
2385 "selected for installation (particularly if it is mentioned on the command "
2386 "line) and it could not be downloaded then it will be silently held back. "
2387 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
2390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2391 #: apt-get.8.xml:305
2393 "Disables downloading of packages. This is best used with "
2394 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
2395 "already downloaded. Configuration Item: "
2396 "<literal>APT::Get::Download</literal>."
2399 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2400 #: apt-get.8.xml:312
2402 "Quiet; produces output suitable for logging, omitting progress indicators. "
2403 "More q's will produce more quiet up to a maximum of 2. You can also use "
2404 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2405 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
2406 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
2407 "may decided to do something you did not expect. Configuration Item: "
2408 "<literal>quiet</literal>."
2411 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2412 #: apt-get.8.xml:327
2414 "No action; perform a simulation of events that would occur but do not "
2415 "actually change the system. Configuration Item: "
2416 "<literal>APT::Get::Simulate</literal>."
2419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2420 #: apt-get.8.xml:331
2422 "Simulation run as user will deactivate locking "
2423 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
2424 "displayed indicating that this is only a simulation, if the option "
2425 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
2426 "true). Neither NoLocking nor the notice will be triggered if run as root "
2427 "(root should know what he is doing without further warnings by "
2428 "<literal>apt-get</literal>)."
2431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2432 #: apt-get.8.xml:337
2434 "Simulate prints out a series of lines each one representing a dpkg "
2435 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
2436 "indicate broken packages and empty set of square brackets meaning breaks "
2437 "that are of no consequence (rare)."
2440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2441 #: apt-get.8.xml:346
2443 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
2444 "non-interactively. If an undesirable situation, such as changing a held "
2445 "package, trying to install a unauthenticated package or removing an "
2446 "essential package occurs then <literal>apt-get</literal> will abort. "
2447 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
2450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2451 #: apt-get.8.xml:354
2453 "Automatic \"no\" to all prompts. Configuration Item: "
2454 "<literal>APT::Get::Assume-No</literal>."
2457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2458 #: apt-get.8.xml:359
2460 "Show upgraded packages; Print out a list of all packages that are to be "
2461 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
2464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2465 #: apt-get.8.xml:365
2467 "Show full versions for upgraded and installed packages. Configuration Item: "
2468 "<literal>APT::Get::Show-Versions</literal>."
2471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2472 #: apt-get.8.xml:371
2474 "This option controls the architecture packages are built for by "
2475 "<command>apt-get source --compile</command> and how cross-builddependencies "
2476 "are satisfied. By default is it not set which means that the host "
2477 "architecture is the same as the build architecture (which is defined by "
2478 "<literal>APT::Architecture</literal>). Configuration Item: "
2479 "<literal>APT::Get::Host-Architecture</literal>"
2482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2483 #: apt-get.8.xml:381
2485 "Compile source packages after downloading them. Configuration Item: "
2486 "<literal>APT::Get::Compile</literal>."
2489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2490 #: apt-get.8.xml:386
2492 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
2493 "hold placed on a package. This may be useful in conjunction with "
2494 "<literal>dist-upgrade</literal> to override a large number of undesired "
2495 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
2498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2499 #: apt-get.8.xml:393
2501 "Do not upgrade packages; When used in conjunction with "
2502 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
2503 "packages on the command line from being upgraded if they are already "
2504 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
2507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2508 #: apt-get.8.xml:400
2510 "Do not install new packages; When used in conjunction with "
2511 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
2512 "upgrades for already installed packages only and ignore requests to install "
2513 "new packages. Configuration Item: "
2514 "<literal>APT::Get::Only-Upgrade</literal>."
2517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2518 #: apt-get.8.xml:408
2520 "Force yes; This is a dangerous option that will cause apt to continue "
2521 "without prompting if it is doing something potentially harmful. It should "
2522 "not be used except in very special situations. Using "
2523 "<literal>force-yes</literal> can potentially destroy your system! "
2524 "Configuration Item: <literal>APT::Get::force-yes</literal>."
2527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2528 #: apt-get.8.xml:416
2530 "Instead of fetching the files to install their URIs are printed. Each URI "
2531 "will have the path, the destination file name, the size and the expected md5 "
2532 "hash. Note that the file name to write to will not always match the file "
2533 "name on the remote site! This also works with the <literal>source</literal> "
2534 "and <literal>update</literal> commands. When used with the "
2535 "<literal>update</literal> command the MD5 and size are not included, and it "
2536 "is up to the user to decompress any compressed files. Configuration Item: "
2537 "<literal>APT::Get::Print-URIs</literal>."
2540 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2541 #: apt-get.8.xml:427
2543 "Use purge instead of remove for anything that would be removed. An asterisk "
2544 "(\"*\") will be displayed next to packages which are scheduled to be "
2545 "purged. <option>remove --purge</option> is equivalent to the "
2546 "<option>purge</option> command. Configuration Item: "
2547 "<literal>APT::Get::Purge</literal>."
2550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2551 #: apt-get.8.xml:435
2553 "Re-Install packages that are already installed and at the newest version. "
2554 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
2557 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2558 #: apt-get.8.xml:440
2560 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
2561 "it off. When on <command>apt-get</command> will automatically manage the "
2562 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
2563 "files are erased. The only reason to turn it off is if you frequently "
2564 "change your source list. Configuration Item: "
2565 "<literal>APT::Get::List-Cleanup</literal>."
2568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2569 #: apt-get.8.xml:451
2571 "This option controls the default input to the policy engine, it creates a "
2572 "default pin at priority 990 using the specified release string. This "
2573 "overrides the general settings in "
2574 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
2575 "not affected by the value of this option. In short, this option lets you "
2576 "have simple control over which distribution packages will be retrieved "
2577 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
2578 "unstable</option> or <option>-t sid</option>. Configuration Item: "
2579 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
2583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2584 #: apt-get.8.xml:466
2586 "Only perform operations that are 'trivial'. Logically this can be considered "
2587 "related to <option>--assume-yes</option>, where "
2588 "<option>--assume-yes</option> will answer yes to any prompt, "
2589 "<option>--trivial-only</option> will answer no. Configuration Item: "
2590 "<literal>APT::Get::Trivial-Only</literal>."
2593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2594 #: apt-get.8.xml:473
2596 "If any packages are to be removed apt-get immediately aborts without "
2597 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
2600 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2601 #: apt-get.8.xml:479
2603 "If the command is either <literal>install</literal> or "
2604 "<literal>remove</literal>, then this option acts like running "
2605 "<literal>autoremove</literal> command, removing the unused dependency "
2606 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
2609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2610 #: apt-get.8.xml:486
2612 "Only has meaning for the <literal>source</literal> and "
2613 "<literal>build-dep</literal> commands. Indicates that the given source "
2614 "names are not to be mapped through the binary table. This means that if "
2615 "this option is specified, these commands will only accept source package "
2616 "names as arguments, rather than accepting binary package names and looking "
2617 "up the corresponding source package. Configuration Item: "
2618 "<literal>APT::Get::Only-Source</literal>."
2621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2622 #: apt-get.8.xml:497
2624 "Download only the diff, dsc, or tar file of a source archive. Configuration "
2625 "Item: <literal>APT::Get::Diff-Only</literal>, "
2626 "<literal>APT::Get::Dsc-Only</literal>, and "
2627 "<literal>APT::Get::Tar-Only</literal>."
2630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2631 #: apt-get.8.xml:503
2633 "Only process architecture-dependent build-dependencies. Configuration Item: "
2634 "<literal>APT::Get::Arch-Only</literal>."
2637 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2638 #: apt-get.8.xml:508
2640 "Ignore if packages can't be authenticated and don't prompt about it. This "
2641 "is useful for tools like pbuilder. Configuration Item: "
2642 "<literal>APT::Get::AllowUnauthenticated</literal>."
2645 #. type: Content of: <refentry><refsect1><variablelist>
2646 #: apt-get.8.xml:521
2648 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
2652 #. type: Content of: <refentry><refsect1><para>
2653 #: apt-get.8.xml:530
2655 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
2656 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
2657 "&apt-preferences;, the APT Howto."
2660 #. type: Content of: <refentry><refsect1><para>
2661 #: apt-get.8.xml:536
2663 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
2667 #. type: Content of: <refentry><refnamediv><refpurpose>
2669 msgid "APT key management utility"
2672 #. type: Content of: <refentry><refsect1><para>
2675 "<command>apt-key</command> is used to manage the list of keys used by apt to "
2676 "authenticate packages. Packages which have been authenticated using these "
2677 "keys will be considered trusted."
2680 #. type: Content of: <refentry><refsect1><title>
2685 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2688 "Add a new key to the list of trusted keys. The key is read from the "
2689 "filename given with the parameter &synopsis-param-filename; or if the "
2690 "filename is <literal>-</literal> from standard input."
2693 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2695 msgid "Remove a key from the list of trusted keys."
2698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2700 msgid "Output the key &synopsis-param-keyid; to standard output."
2703 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2705 msgid "Output all trusted keys to standard output."
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2710 msgid "List trusted keys."
2713 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2714 #: apt-key.8.xml:107
2715 msgid "List fingerprints of trusted keys."
2718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2719 #: apt-key.8.xml:118
2721 "Pass advanced options to gpg. With adv --recv-key you can download the "
2725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2726 #: apt-key.8.xml:130
2728 "Update the local keyring with the archive keyring and remove from the local "
2729 "keyring the archive keys which are no longer valid. The archive keyring is "
2730 "shipped in the <literal>archive-keyring</literal> package of your "
2731 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
2735 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2736 #: apt-key.8.xml:144
2738 "Work similar to the <command>update</command> command above, but get the "
2739 "archive keyring from an URI instead and validate it against a master key. "
2740 "This requires an installed &wget; and an APT build configured to have a "
2741 "server to fetch from and a master keyring to validate. APT in Debian does "
2742 "not support this command and relies on <command>update</command> instead, "
2743 "but Ubuntu's APT does."
2746 #. type: Content of: <refentry><refsect1><para>
2747 #: apt-key.8.xml:161
2749 "Note that options need to be defined before the commands described in the "
2753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2754 #: apt-key.8.xml:164
2756 "With this option it is possible to specify a specific keyring file the "
2757 "command should operate on. The default is that a command is executed on the "
2758 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2759 "<filename>trusted.gpg.d</filename> directory, though "
2760 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2761 "e.g. new keys are added to this one."
2764 #. type: Content of: <refentry><refsect1><variablelist>
2765 #: apt-key.8.xml:177
2766 msgid "&file-trustedgpg;"
2769 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2770 #: apt-key.8.xml:179
2771 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
2774 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2775 #: apt-key.8.xml:180
2776 msgid "Local trust database of archive keys."
2779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2780 #: apt-key.8.xml:183
2781 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
2784 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2785 #: apt-key.8.xml:184
2786 msgid "Keyring of Debian archive trusted keys."
2789 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2790 #: apt-key.8.xml:187
2791 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
2794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2795 #: apt-key.8.xml:188
2796 msgid "Keyring of Debian archive removed trusted keys."
2799 #. type: Content of: <refentry><refsect1><para>
2800 #: apt-key.8.xml:197
2801 msgid "&apt-get;, &apt-secure;"
2804 #. type: Content of: <refentry><refnamediv><refpurpose>
2805 #: apt-mark.8.xml:33
2806 msgid "mark/unmark a package as being automatically-installed"
2809 #. type: Content of: <refentry><refsect1><para>
2810 #: apt-mark.8.xml:39
2812 "<command>apt-mark</command> will change whether a package has been marked as "
2813 "being automatically installed."
2816 #. type: Content of: <refentry><refsect1><para>
2817 #: apt-mark.8.xml:43
2819 "When you request that a package is installed, and as a result other packages "
2820 "are installed to satisfy its dependencies, the dependencies are marked as "
2821 "being automatically installed. Once these automatically installed packages "
2822 "are no longer depended on by any manually installed packages, they will be "
2823 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
2826 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2827 #: apt-mark.8.xml:52
2829 "<literal>auto</literal> is used to mark a package as being automatically "
2830 "installed, which will cause the package to be removed when no more manually "
2831 "installed packages depend on this package."
2834 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2835 #: apt-mark.8.xml:60
2837 "<literal>manual</literal> is used to mark a package as being manually "
2838 "installed, which will prevent the package from being automatically removed "
2839 "if no other packages depend on it."
2842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2843 #: apt-mark.8.xml:68
2845 "<literal>hold</literal> is used to mark a package as hold back, which will "
2846 "prevent the package from being automatically installed, upgraded or "
2847 "removed. The command is only a wrapper around <command>dpkg "
2848 "--set-selections</command> and the state is therefore maintained by &dpkg; "
2849 "and not effected by the <option>--filename</option> option."
2852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2853 #: apt-mark.8.xml:78
2855 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2856 "package to allow all actions again."
2859 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2860 #: apt-mark.8.xml:84
2862 "<literal>showauto</literal> is used to print a list of automatically "
2863 "installed packages with each package on a new line. All automatically "
2864 "installed packages will be listed if no package is given. If packages are "
2865 "given only those which are automatically installed will be shown."
2868 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2869 #: apt-mark.8.xml:92
2871 "<literal>showmanual</literal> can be used in the same way as "
2872 "<literal>showauto</literal> except that it will print a list of manually "
2873 "installed packages instead."
2876 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2877 #: apt-mark.8.xml:99
2879 "<literal>showhold</literal> is used to print a list of packages on hold in "
2880 "the same way as for the other show commands."
2883 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><filename>
2884 #: apt-mark.8.xml:112 apt-mark.8.xml:113
2885 msgid "<replaceable>&synopsis-filename;</replaceable>"
2888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2889 #: apt-mark.8.xml:115
2891 "Read/Write package stats from the filename given with the parameter "
2892 "<filename><replaceable>&synopsis-filename;</replaceable></filename> instead "
2893 "of from the default location, which is <filename>extended_status</filename> "
2894 "in the directory defined by the Configuration Item: "
2895 "<literal>Dir::State</literal>."
2898 #. type: Content of: <refentry><refsect1><variablelist>
2899 #: apt-mark.8.xml:128
2900 msgid " &file-extended_states;"
2903 #. type: Content of: <refentry><refsect1><para>
2904 #: apt-mark.8.xml:133
2905 msgid "&apt-get;,&aptitude;,&apt-conf;"
2908 #. type: Content of: <refentry><refsect1><para>
2909 #: apt-mark.8.xml:137
2911 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2915 #. type: Content of: <refentry><refnamediv><refpurpose>
2916 #: apt-secure.8.xml:47
2917 msgid "Archive authentication support for APT"
2920 #. type: Content of: <refentry><refsect1><para>
2921 #: apt-secure.8.xml:52
2923 "Starting with version 0.6, <command>apt</command> contains code that does "
2924 "signature checking of the Release file for all archives. This ensures that "
2925 "packages in the archive can't be modified by people who have no access to "
2926 "the Release file signing key."
2929 #. type: Content of: <refentry><refsect1><para>
2930 #: apt-secure.8.xml:60
2932 "If a package comes from a archive without a signature or with a signature "
2933 "that apt does not have a key for that package is considered untrusted and "
2934 "installing it will result in a big warning. <command>apt-get</command> will "
2935 "currently only warn for unsigned archives, future releases might force all "
2936 "sources to be verified before downloading packages from them."
2939 #. type: Content of: <refentry><refsect1><para>
2940 #: apt-secure.8.xml:69
2942 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2943 "authentication feature."
2946 #. type: Content of: <refentry><refsect1><title>
2947 #: apt-secure.8.xml:74
2948 msgid "Trusted archives"
2951 #. type: Content of: <refentry><refsect1><para>
2952 #: apt-secure.8.xml:77
2954 "The chain of trust from an apt archive to the end user is made up of "
2955 "different steps. <command>apt-secure</command> is the last step in this "
2956 "chain, trusting an archive does not mean that the packages that you trust it "
2957 "do not contain malicious code but means that you trust the archive "
2958 "maintainer. It's the archive maintainer responsibility to ensure that the "
2959 "archive integrity is correct."
2962 #. type: Content of: <refentry><refsect1><para>
2963 #: apt-secure.8.xml:85
2965 "apt-secure does not review signatures at a package level. If you require "
2966 "tools to do this you should look at <command>debsig-verify</command> and "
2967 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2968 "packages respectively)."
2971 #. type: Content of: <refentry><refsect1><para>
2972 #: apt-secure.8.xml:92
2974 "The chain of trust in Debian starts when a maintainer uploads a new package "
2975 "or a new version of a package to the Debian archive. This upload in order to "
2976 "become effective needs to be signed by a key of a maintainer within the "
2977 "Debian maintainer's keyring (available in the debian-keyring "
2978 "package). Maintainer's keys are signed by other maintainers following "
2979 "pre-established procedures to ensure the identity of the key holder."
2982 #. type: Content of: <refentry><refsect1><para>
2983 #: apt-secure.8.xml:102
2985 "Once the uploaded package is verified and included in the archive, the "
2986 "maintainer signature is stripped off, an MD5 sum of the package is computed "
2987 "and put in the Packages file. The MD5 sum of all of the packages files are "
2988 "then computed and put into the Release file. The Release file is then signed "
2989 "by the archive key (which is created once a year) and distributed through "
2990 "the FTP server. This key is also on the Debian keyring."
2993 #. type: Content of: <refentry><refsect1><para>
2994 #: apt-secure.8.xml:112
2996 "Any end user can check the signature of the Release file, extract the MD5 "
2997 "sum of a package from it and compare it with the MD5 sum of the package he "
2998 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
2999 "package was checked. Now both the MD5 sum and the signature of the Release "
3003 #. type: Content of: <refentry><refsect1><para>
3004 #: apt-secure.8.xml:119
3006 "Notice that this is distinct from checking signatures on a per package "
3007 "basis. It is designed to prevent two possible attacks:"
3010 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3011 #: apt-secure.8.xml:124
3013 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3014 "checking, a malicious agent can introduce himself in the package download "
3015 "process and provide malicious software either by controlling a network "
3016 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3017 "(through arp or DNS spoofing attacks)."
3020 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3021 #: apt-secure.8.xml:132
3023 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3024 "malicious agent can compromise a mirror host and modify the files in it to "
3025 "propagate malicious software to all users downloading packages from that "
3029 #. type: Content of: <refentry><refsect1><para>
3030 #: apt-secure.8.xml:139
3032 "However, it does not defend against a compromise of the Debian master server "
3033 "itself (which signs the packages) or against a compromise of the key used to "
3034 "sign the Release files. In any case, this mechanism can complement a "
3035 "per-package signature."
3038 #. type: Content of: <refentry><refsect1><title>
3039 #: apt-secure.8.xml:145
3040 msgid "User configuration"
3043 #. type: Content of: <refentry><refsect1><para>
3044 #: apt-secure.8.xml:147
3046 "<command>apt-key</command> is the program that manages the list of keys used "
3047 "by apt. It can be used to add or remove keys although an installation of "
3048 "this release will automatically provide the default Debian archive signing "
3049 "keys used in the Debian package repositories."
3052 #. type: Content of: <refentry><refsect1><para>
3053 #: apt-secure.8.xml:154
3055 "In order to add a new key you need to first download it (you should make "
3056 "sure you are using a trusted communication channel when retrieving it), add "
3057 "it with <command>apt-key</command> and then run <command>apt-get "
3058 "update</command> so that apt can download and verify the "
3059 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3060 "from the archives you have configured."
3063 #. type: Content of: <refentry><refsect1><title>
3064 #: apt-secure.8.xml:163
3065 msgid "Archive configuration"
3068 #. type: Content of: <refentry><refsect1><para>
3069 #: apt-secure.8.xml:165
3071 "If you want to provide archive signatures in an archive under your "
3072 "maintenance you have to:"
3075 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3076 #: apt-secure.8.xml:170
3078 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3079 "already. You can do this by running <command>apt-ftparchive "
3080 "release</command> (provided in apt-utils)."
3083 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3084 #: apt-secure.8.xml:175
3086 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
3087 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
3088 "Release.gpg Release</command>."
3091 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3092 #: apt-secure.8.xml:179
3094 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
3095 "know what key they need to import in order to authenticate the files in the "
3099 #. type: Content of: <refentry><refsect1><para>
3100 #: apt-secure.8.xml:186
3102 "Whenever the contents of the archive changes (new packages are added or "
3103 "removed) the archive maintainer has to follow the first two steps previously "
3107 #. type: Content of: <refentry><refsect1><para>
3108 #: apt-secure.8.xml:194
3110 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
3111 "&debsign; &debsig-verify;, &gpg;"
3114 #. type: Content of: <refentry><refsect1><para>
3115 #: apt-secure.8.xml:198
3117 "For more background information you might want to review the <ulink "
3118 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
3119 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
3120 "(available also in the harden-doc package) and the <ulink "
3121 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
3122 "Distribution HOWTO</ulink> by V. Alex Brennen."
3125 #. type: Content of: <refentry><refsect1><title>
3126 #: apt-secure.8.xml:211
3127 msgid "Manpage Authors"
3130 #. type: Content of: <refentry><refsect1><para>
3131 #: apt-secure.8.xml:213
3133 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
3134 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
3137 #. type: Content of: <refentry><refnamediv><refpurpose>
3138 #: apt-sortpkgs.1.xml:33
3139 msgid "Utility to sort package index files"
3142 #. type: Content of: <refentry><refsect1><para>
3143 #: apt-sortpkgs.1.xml:39
3145 "<command>apt-sortpkgs</command> will take an index file (Source index or "
3146 "Package index) and sort the records so that they are ordered by the package "
3147 "name. It will also sort the internal fields of each record according to the "
3148 "internal sorting rules."
3151 #. type: Content of: <refentry><refsect1><para>
3152 #: apt-sortpkgs.1.xml:45
3153 msgid "All output is sent to stdout, the input must be a seekable file."
3156 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3157 #: apt-sortpkgs.1.xml:54
3159 "Use Source index field ordering. Configuration Item: "
3160 "<literal>APT::SortPkgs::Source</literal>."
3163 #. type: Content of: <refentry><refsect1><para>
3164 #: apt-sortpkgs.1.xml:68
3166 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
3170 #. type: Content of: <refentry><refentryinfo><author><contrib>
3171 #: apt.conf.5.xml:20
3172 msgid "Initial documentation of Debug::*."
3175 #. type: Content of: <refentry><refentryinfo><author><email>
3176 #: apt.conf.5.xml:21
3177 msgid "dburrows@debian.org"
3180 #. type: Content of: <refentry><refmeta><manvolnum>
3181 #: apt.conf.5.xml:31 apt_preferences.5.xml:25 sources.list.5.xml:26
3185 #. type: Content of: <refentry><refnamediv><refpurpose>
3186 #: apt.conf.5.xml:38
3187 msgid "Configuration file for APT"
3190 #. type: Content of: <refentry><refsect1><para>
3191 #: apt.conf.5.xml:42
3193 "<filename>apt.conf</filename> is the main configuration file for the APT "
3194 "suite of tools, but by far not the only place changes to options can be "
3195 "made. All tools therefore share the configuration files and also use a "
3196 "common command line parser to provide a uniform environment."
3199 #. type: Content of: <refentry><refsect1><orderedlist><para>
3200 #: apt.conf.5.xml:47
3202 "When an APT tool starts up it will read the configuration files in the "
3206 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3207 #: apt.conf.5.xml:49
3209 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
3213 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3214 #: apt.conf.5.xml:51
3216 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
3217 "order which have either no or \"<literal>conf</literal>\" as filename "
3218 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
3219 "and period (.) characters. Otherwise APT will print a notice that it has "
3220 "ignored a file if the file doesn't match a pattern in the "
3221 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
3222 "case it will be silently ignored."
3225 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3226 #: apt.conf.5.xml:58
3227 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
3230 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3231 #: apt.conf.5.xml:60
3233 "the command line options are applied to override the configuration "
3234 "directives or to load even more configuration files."
3237 #. type: Content of: <refentry><refsect1><title>
3238 #: apt.conf.5.xml:64
3242 #. type: Content of: <refentry><refsect1><para>
3243 #: apt.conf.5.xml:65
3245 "The configuration file is organized in a tree with options organized into "
3246 "functional groups. Option specification is given with a double colon "
3247 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
3248 "within the APT tool group, for the Get tool. Options do not inherit from "
3249 "their parent groups."
3252 #. type: Content of: <refentry><refsect1><para>
3253 #: apt.conf.5.xml:71
3255 "Syntactically the configuration language is modeled after what the ISC tools "
3256 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
3257 "treated as comments (ignored), as well as all text between "
3258 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
3259 "Each line is of the form <literal>APT::Get::Assume-Yes "
3260 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
3261 "value must be on one line, and there is no kind of string concatenation. It "
3262 "must not include inside quotes. The behavior of the backslash \"\\\" and "
3263 "escaped characters inside a value is undefined and it should not be used. An "
3264 "option name may include alphanumerical characters and the \"/-:._+\" "
3265 "characters. A new scope can be opened with curly braces, like:"
3268 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3269 #: apt.conf.5.xml:85
3274 " Assume-Yes \"true\";\n"
3275 " Fix-Broken \"true\";\n"
3280 #. type: Content of: <refentry><refsect1><para>
3281 #: apt.conf.5.xml:93
3283 "with newlines placed to make it more readable. Lists can be created by "
3284 "opening a scope and including a single string enclosed in quotes followed by "
3285 "a semicolon. Multiple entries can be included, each separated by a "
3289 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3290 #: apt.conf.5.xml:98
3292 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
3295 #. type: Content of: <refentry><refsect1><para>
3296 #: apt.conf.5.xml:101
3298 "In general the sample configuration file in "
3299 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
3300 "guide for how it should look."
3303 #. type: Content of: <refentry><refsect1><para>
3304 #: apt.conf.5.xml:105
3306 "The names of the configuration items are not case-sensitive. So in the "
3307 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
3310 #. type: Content of: <refentry><refsect1><para>
3311 #: apt.conf.5.xml:108
3313 "Names for the configuration items are optional if a list is defined as it "
3314 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
3315 "above. If you don't specify a name a new entry will simply add a new option "
3316 "to the list. If you specify a name you can override the option as every "
3317 "other option by reassigning a new value to the option."
3320 #. type: Content of: <refentry><refsect1><para>
3321 #: apt.conf.5.xml:113
3323 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
3324 "and not supported by alternative implementations) and "
3325 "<literal>#clear</literal>: <literal>#include</literal> will include the "
3326 "given file, unless the filename ends in a slash, then the whole directory is "
3327 "included. <literal>#clear</literal> is used to erase a part of the "
3328 "configuration tree. The specified element and all its descendants are "
3329 "erased. (Note that these lines also need to end with a semicolon.)"
3332 #. type: Content of: <refentry><refsect1><para>
3333 #: apt.conf.5.xml:121
3335 "The #clear command is the only way to delete a list or a complete scope. "
3336 "Reopening a scope or the ::-style described below will "
3337 "<emphasis>not</emphasis> override previously written entries. Only options "
3338 "can be overridden by addressing a new value to it - lists and scopes can't "
3339 "be overridden, only cleared."
3342 #. type: Content of: <refentry><refsect1><para>
3343 #: apt.conf.5.xml:126
3345 "All of the APT tools take a -o option which allows an arbitrary "
3346 "configuration directive to be specified on the command line. The syntax is a "
3347 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
3348 "followed by an equals sign then the new value of the option. To append a new "
3349 "element to a list, add a trailing :: to the name of the list. (As you might "
3350 "suspect: The scope syntax can't be used on the command line.)"
3353 #. type: Content of: <refentry><refsect1><para>
3354 #: apt.conf.5.xml:133
3356 "Note that you can use :: only for appending one item per line to a list and "
3357 "that you should not use it in combination with the scope syntax. (The scope "
3358 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
3359 "which some users unfortunately depend on: An option with the unusual name "
3360 "\"<literal>::</literal>\" which acts like every other option with a "
3361 "name. These introduces many problems including that a user who writes "
3362 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
3363 "append to a list will gain the opposite as only the last assignment for this "
3364 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
3365 "raise errors and will stop working if they encounter this misuse, so please "
3366 "correct such statements now as long as APT doesn't complain explicit about "
3370 #. type: Content of: <refentry><refsect1><title>
3371 #: apt.conf.5.xml:145
3372 msgid "The APT Group"
3375 #. type: Content of: <refentry><refsect1><para>
3376 #: apt.conf.5.xml:146
3378 "This group of options controls general APT behavior as well as holding the "
3379 "options for all of the tools."
3382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3383 #: apt.conf.5.xml:151
3385 "System Architecture; sets the architecture to use when fetching files and "
3386 "parsing package lists. The internal default is the architecture apt was "
3390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3391 #: apt.conf.5.xml:157
3393 "All Architectures the system supports. Processors implementing the "
3394 "<literal>amd64</literal> (also called <literal>x86-64</literal>) instruction "
3395 "set are e.g. also able to execute binaries compiled for the "
3396 "<literal>i386</literal> (<literal>x86</literal>) instruction set; This list "
3397 "is use when fetching files and parsing package lists. The internal default "
3398 "is always the native architecture (<literal>APT::Architecture</literal>) "
3399 "and all foreign architectures it can retrieve by calling <command>dpkg "
3400 "--print-foreign-architectures</command>."
3403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3404 #: apt.conf.5.xml:167
3406 "Default release to install packages from if more than one version "
3407 "available. Contains release name, codename or release version. Examples: "
3408 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
3409 "'4.0', '5.0*'. See also &apt-preferences;."
3412 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3413 #: apt.conf.5.xml:173
3415 "Ignore Held packages; This global option causes the problem resolver to "
3416 "ignore held packages in its decision making."
3419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3420 #: apt.conf.5.xml:178
3422 "Defaults to on. When turned on the autoclean feature will remove any "
3423 "packages which can no longer be downloaded from the cache. If turned off "
3424 "then packages that are locally installed are also excluded from cleaning - "
3425 "but note that APT provides no direct means to reinstall them."
3428 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3429 #: apt.conf.5.xml:185
3431 "Defaults to on which will cause APT to install essential and important "
3432 "packages as fast as possible in the install/upgrade operation. This is done "
3433 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
3434 "does treat an important package in the same way as an extra package: Between "
3435 "the unpacking of the important package A and his configuration can then be "
3436 "many other unpack or configuration calls, e.g. for package B which has no "
3437 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
3438 "script of package B generates an error) which results in a system state in "
3439 "which package A is unpacked but unconfigured - each package depending on A "
3440 "is now no longer guaranteed to work as their dependency on A is not longer "
3441 "satisfied. The immediate configuration marker is also applied to all "
3442 "dependencies which can generate a problem if the dependencies e.g. form a "
3443 "circle as a dependency with the immediate flag is comparable with a "
3444 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
3445 "in which it is unable to perform immediate configuration, errors out and "
3446 "refers to this option so the user can deactivate the immediate configuration "
3447 "temporarily to be able to perform an install/upgrade again. Note the use of "
3448 "the word \"theory\" here as this problem was only encountered by now in real "
3449 "world a few times in non-stable distribution versions and was caused by "
3450 "wrong dependencies of the package in question or by a system in an already "
3451 "broken state, so you should not blindly disable this option as the mentioned "
3452 "scenario above is not the only problem immediate configuration can help to "
3453 "prevent in the first place. Before a big operation like "
3454 "<literal>dist-upgrade</literal> is run with this option disabled it should "
3455 "be tried to explicitly <literal>install</literal> the package APT is unable "
3456 "to configure immediately, but please make sure to report your problem also "
3457 "to your distribution and to the APT team with the buglink below so they can "
3458 "work on improving or correcting the upgrade process."
3461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3462 #: apt.conf.5.xml:208
3464 "Never Enable this option unless you -really- know what you are doing. It "
3465 "permits APT to temporarily remove an essential package to break a "
3466 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
3467 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
3468 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
3469 "anything that those packages depend on."
3472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3473 #: apt.conf.5.xml:217
3475 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3476 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
3477 "to which size the Cache will grow and is therefore the amount of memory APT "
3478 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3479 "that this amount of space needs to be available for APT otherwise it will "
3480 "likely fail ungracefully, so for memory restricted devices this value should "
3481 "be lowered while on systems with a lot of configured sources it should be "
3482 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3483 "of 1048576 (~1 MB) how much the Cache size will be increased in the event "
3484 "the space defined by <literal>Cache-Start</literal> is not enough. These "
3485 "value will be applied again and again until either the cache is big enough "
3486 "to store all information or the size of the cache reaches the "
3487 "<literal>Cache-Limit</literal>. The default of "
3488 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3489 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
3493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3494 #: apt.conf.5.xml:233
3495 msgid "Defines which package(s) are considered essential build dependencies."
3498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3499 #: apt.conf.5.xml:237
3501 "The Get subsection controls the &apt-get; tool, please see its documentation "
3502 "for more information about the options here."
3505 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3506 #: apt.conf.5.xml:242
3508 "The Cache subsection controls the &apt-cache; tool, please see its "
3509 "documentation for more information about the options here."
3512 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3513 #: apt.conf.5.xml:247
3515 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
3516 "documentation for more information about the options here."
3519 #. type: Content of: <refentry><refsect1><title>
3520 #: apt.conf.5.xml:253
3521 msgid "The Acquire Group"
3524 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3525 #: apt.conf.5.xml:259
3527 "Security related option defaulting to true as an expiring validation for a "
3528 "Release file prevents longtime replay attacks and can e.g. also help users "
3529 "to identify no longer updated mirrors - but the feature depends on the "
3530 "correctness of the time on the user system. Archive maintainers are "
3531 "encouraged to create Release files with the <literal>Valid-Until</literal> "
3532 "header, but if they don't or a stricter value is volitional the following "
3533 "<literal>Max-ValidTime</literal> option can be used."
3536 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3537 #: apt.conf.5.xml:270
3539 "Seconds the Release file should be considered valid after it was created "
3540 "(indicated by the <literal>Date</literal> header). If the Release file "
3541 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
3542 "the two is used as the expiration date. The default value is "
3543 "<literal>0</literal> which stands for \"for ever valid\". Archive specific "
3544 "settings can be made by appending the label of the archive to the option "
3548 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3549 #: apt.conf.5.xml:281
3551 "Minimum of seconds the Release file should be considered valid after it was "
3552 "created (indicated by the <literal>Date</literal> header). Use this if you "
3553 "need to use a seldomly updated (local) mirror of a more regular updated "
3554 "archive with a <literal>Valid-Until</literal> header instead of completely "
3555 "disabling the expiration date checking. Archive specific settings can and "
3556 "should be used by appending the label of the archive to the option name."
3559 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3560 #: apt.conf.5.xml:292
3562 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
3563 "Sources files instead of downloading whole ones. True by default."
3566 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3567 #: apt.conf.5.xml:295
3569 "Two sub-options to limit the use of PDiffs are also available: With "
3570 "<literal>FileLimit</literal> can be specified how many PDiff files are "
3571 "downloaded at most to update a file. <literal>SizeLimit</literal> on the "
3572 "other hand is the maximum percentage of the size of all patches compared to "
3573 "the size of the targeted file. If one of these limits is exceeded the "
3574 "complete file is downloaded instead of the patches."
3577 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3578 #: apt.conf.5.xml:305
3580 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3581 "<literal>host</literal> or <literal>access</literal> which determines how "
3582 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3583 "one connection per target host will be opened, <literal>access</literal> "
3584 "means that one connection per URI type will be opened."
3587 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3588 #: apt.conf.5.xml:313
3590 "Number of retries to perform. If this is non-zero APT will retry failed "
3591 "files the given number of times."
3594 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3595 #: apt.conf.5.xml:318
3597 "Use symlinks for source archives. If set to true then source archives will "
3598 "be symlinked when possible instead of copying. True is the default."
3601 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3602 #: apt.conf.5.xml:323
3604 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
3605 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
3606 "host proxies can also be specified by using the form "
3607 "<literal>http::Proxy::<host></literal> with the special keyword "
3608 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3609 "settings is specified, <envar>http_proxy</envar> environment variable will "
3613 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3614 #: apt.conf.5.xml:331
3616 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3617 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
3618 "response under any circumstances, <literal>Max-Age</literal> is sent only "
3619 "for index files and tells the cache to refresh its object if it is older "
3620 "than the given number of seconds. Debian updates its index files daily so "
3621 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
3622 "should never store this request, it is only set for archive files. This may "
3623 "be useful to prevent polluting a proxy cache with very large .deb "
3624 "files. Note: Squid 2.0.2 does not support any of these options."
3627 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3628 #: apt.conf.5.xml:341 apt.conf.5.xml:407
3630 "The option <literal>timeout</literal> sets the timeout timer used by the "
3631 "method, this applies to all things including connection timeout and data "
3635 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3636 #: apt.conf.5.xml:344
3638 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3639 "enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial "
3640 "e.g. on high-latency connections. It specifies how many requests are send in "
3641 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
3642 "the default value is now 0 (= disabled) to avoid problems with the "
3643 "ever-growing amount of webservers and proxies which choose to not conform to "
3644 "the HTTP/1.1 specification."
3647 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3648 #: apt.conf.5.xml:351
3650 "<literal>Acquire::http::AllowRedirect</literal> controls if APT will follow "
3651 "redirects, which is enabled by default."
3654 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3655 #: apt.conf.5.xml:354
3657 "The used bandwidth can be limited with "
3658 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3659 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
3660 "as much as possible of the bandwidth (Note that this option implicit "
3661 "deactivates the download from multiple servers at the same time.)"
3664 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3665 #: apt.conf.5.xml:359
3667 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3668 "User-Agent for the http download method as some proxies allow access for "
3669 "clients only if the client uses a known identifier."
3672 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3673 #: apt.conf.5.xml:366
3675 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
3676 "options are the same as for <literal>http</literal> method and will also "
3677 "default to the options from the <literal>http</literal> method if they are "
3678 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
3679 "not supported yet."
3682 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3683 #: apt.conf.5.xml:372
3685 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3686 "about trusted certificates. <literal><host>::CaInfo</literal> is "
3687 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3688 "suboption determines whether verify server's host certificate against "
3689 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
3690 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
3691 "suboption determines whether verify server's hostname or not. "
3692 "<literal><host>::Verify-Host</literal> is corresponding per-host "
3693 "option. <literal>SslCert</literal> determines what certificate to use for "
3694 "client authentication. <literal><host>::SslCert</literal> is "
3695 "corresponding per-host option. <literal>SslKey</literal> determines what "
3696 "private key to use for client "
3697 "authentication. <literal><host>::SslKey</literal> is corresponding "
3698 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3699 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
3700 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
3704 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3705 #: apt.conf.5.xml:391
3707 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
3708 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
3709 "proxies can also be specified by using the form "
3710 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3711 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3712 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3713 "used. To use a ftp proxy you will have to set the "
3714 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3715 "entry specifies the commands to send to tell the proxy server what to "
3716 "connect to. Please see &configureindex; for an example of how to do "
3717 "this. The substitution variables available are "
3718 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
3719 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
3720 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
3721 "from it's respective URI component."
3724 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3725 #: apt.conf.5.xml:410
3727 "Several settings are provided to control passive mode. Generally it is safe "
3728 "to leave passive mode on, it works in nearly every environment. However "
3729 "some situations require that passive mode be disabled and port mode ftp used "
3730 "instead. This can be done globally, for connections that go through a proxy "
3731 "or for a specific host (See the sample config file for examples)."
3734 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3735 #: apt.conf.5.xml:417
3737 "It is possible to proxy FTP over HTTP by setting the "
3738 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
3739 "discussion of the http method above for syntax. You cannot set this in the "
3740 "configuration file and it is not recommended to use FTP over HTTP due to its "
3744 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3745 #: apt.conf.5.xml:422
3747 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3748 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3749 "false, which means these commands are only used if the control connection is "
3750 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3751 "that most FTP servers do not support RFC2428."
3754 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3755 #: apt.conf.5.xml:435
3757 msgid "/cdrom/::Mount \"foo\";"
3760 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3761 #: apt.conf.5.xml:430
3763 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
3764 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
3765 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
3766 "provide alternate mount and unmount commands if your mount point cannot be "
3767 "listed in the fstab (such as an SMB mount and old mount packages). The "
3768 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3769 "cdrom block. It is important to have the trailing slash. Unmount commands "
3770 "can be specified using UMount."
3773 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3774 #: apt.conf.5.xml:441
3776 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
3777 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
3781 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3782 #: apt.conf.5.xml:452
3785 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3786 "\"<replaceable>Methodname</replaceable>\";"
3789 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3790 #: apt.conf.5.xml:447
3792 "List of compression types which are understood by the acquire methods. "
3793 "Files like <filename>Packages</filename> can be available in various "
3794 "compression formats. Per default the acquire methods can decompress "
3795 "<command>bzip2</command>, <command>lzma</command> and "
3796 "<command>gzip</command> compressed files, with this setting more formats can "
3797 "be added on the fly or the used method can be changed. The syntax for this "
3798 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3801 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3802 #: apt.conf.5.xml:457
3804 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3807 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3808 #: apt.conf.5.xml:460
3810 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3813 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3814 #: apt.conf.5.xml:453
3816 "Also the <literal>Order</literal> subgroup can be used to define in which "
3817 "order the acquire system will try to download the compressed files. The "
3818 "acquire system will try the first and proceed with the next compression type "
3819 "in this list on error, so to prefer one over the other type simple add the "
3820 "preferred type at first - not already added default types will be added at "
3821 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3822 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3823 "over <command>bzip2</command> and <command>lzma</command>. If "
3824 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3825 "<command>bzip2</command> the configure setting should look like this "
3826 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3827 "<literal>bz2</literal> explicit to the list as it will be added automatic."
3830 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3831 #: apt.conf.5.xml:464
3833 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3836 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3837 #: apt.conf.5.xml:462
3839 "Note that at run time the "
3840 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3841 "checked: If this setting exists the method will only be used if this file "
3842 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
3843 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
3844 "the command line will be added at the end of the list specified in the "
3845 "configuration files, but before the default entries. To prefer a type in "
3846 "this case over the ones specified in the configuration files you can set the "
3847 "option direct - not in list style. This will not override the defined list, "
3848 "it will only prefix the list with this type."
3851 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3852 #: apt.conf.5.xml:469
3854 "The special type <literal>uncompressed</literal> can be used to give "
3855 "uncompressed files a preference, but note that most archives don't provide "
3856 "uncompressed files so this is mostly only useable for local mirrors."
3859 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3860 #: apt.conf.5.xml:476
3862 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3863 "Sources, or Translations), keep them gzip compressed locally instead of "
3864 "unpacking them. This saves quite a lot of disk space at the expense of more "
3865 "CPU requirements when building the local package caches. False by default."
3868 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3869 #: apt.conf.5.xml:484
3871 "The Languages subsection controls which <filename>Translation</filename> "
3872 "files are downloaded and in which order APT tries to display the "
3873 "Description-Translations. APT will try to display the first available "
3874 "Description in the Language which is listed at first. Languages can be "
3875 "defined with their short or long Languagecodes. Note that not all archives "
3876 "provide <filename>Translation</filename> files for every Language - "
3877 "especially the long Languagecodes are rare, so please inform you which ones "
3878 "are available before you set here impossible values."
3881 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
3882 #: apt.conf.5.xml:500
3884 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3887 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3888 #: apt.conf.5.xml:490
3890 "The default list includes \"environment\" and "
3891 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
3892 "will be replaced at runtime with the languagecodes extracted from the "
3893 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3894 "that these codes are not included twice in the list. If "
3895 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3896 "<filename>Translation-en</filename> file (if available) will be used. To "
3897 "force apt to use no Translation file use the setting "
3898 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3899 "another special meaning code which will stop the search for a fitting "
3900 "<filename>Translation</filename> file. This can be used by the system "
3901 "administrator to let APT know that it should download also this files "
3902 "without actually use them if the environment doesn't specify this "
3903 "languages. So the following example configuration will result in the order "
3904 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
3905 "that \"fr\" is downloaded, but not used if APT is not used in a french "
3906 "localization, in such an environment the order would be \"fr, de, en\". "
3907 "<placeholder type=\"programlisting\" id=\"0\"/>"
3910 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3911 #: apt.conf.5.xml:501
3913 "Note: To prevent problems resulting from APT being executed in different "
3914 "environments (e.g. by different users or by other programs) all Translation "
3915 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3916 "added to the end of the list (after an implicit "
3917 "\"<literal>none</literal>\")."
3920 #. type: Content of: <refentry><refsect1><para>
3921 #: apt.conf.5.xml:254
3923 "The <literal>Acquire</literal> group of options controls the download of "
3924 "packages and the URI handlers. <placeholder type=\"variablelist\" "
3928 #. type: Content of: <refentry><refsect1><title>
3929 #: apt.conf.5.xml:512
3933 #. type: Content of: <refentry><refsect1><para>
3934 #: apt.conf.5.xml:514
3936 "The <literal>Dir::State</literal> section has directories that pertain to "
3937 "local state information. <literal>lists</literal> is the directory to place "
3938 "downloaded package lists in and <literal>status</literal> is the name of the "
3939 "dpkg status file. <literal>preferences</literal> is the name of the APT "
3940 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3941 "contains the default directory to prefix on all sub items if they do not "
3942 "start with <filename>/</filename> or <filename>./</filename>."
3945 #. type: Content of: <refentry><refsect1><para>
3946 #: apt.conf.5.xml:521
3948 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3949 "information, such as the two package caches <literal>srcpkgcache</literal> "
3950 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3951 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3952 "be turned off by setting their names to be blank. This will slow down "
3953 "startup but save disk space. It is probably preferred to turn off the "
3954 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3955 "default directory is contained in <literal>Dir::Cache</literal>"
3958 #. type: Content of: <refentry><refsect1><para>
3959 #: apt.conf.5.xml:530
3961 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3962 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3963 "<literal>main</literal> is the default configuration file (setting has no "
3964 "effect, unless it is done from the config file specified by "
3965 "<envar>APT_CONFIG</envar>)."
3968 #. type: Content of: <refentry><refsect1><para>
3969 #: apt.conf.5.xml:536
3971 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3972 "in lexical order from the directory specified. After this is done then the "
3973 "main config file is loaded."
3976 #. type: Content of: <refentry><refsect1><para>
3977 #: apt.conf.5.xml:540
3979 "Binary programs are pointed to by "
3980 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3981 "the location of the method handlers and <literal>gzip</literal>, "
3982 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3983 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3984 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3985 "specify the location of the respective programs."
3988 #. type: Content of: <refentry><refsect1><para>
3989 #: apt.conf.5.xml:548
3991 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3992 "set, all paths in <literal>Dir::</literal> will be relative to "
3993 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3994 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3995 "set to <filename>/tmp/staging</filename> and "
3996 "<literal>Dir::State::status</literal> is set to "
3997 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3998 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
4001 #. type: Content of: <refentry><refsect1><para>
4002 #: apt.conf.5.xml:561
4004 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
4005 "which files APT should silently ignore while parsing the files in the "
4006 "fragment directories. Per default a file which end with "
4007 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
4008 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
4009 "default value these patterns can use regular expression syntax."
4012 #. type: Content of: <refentry><refsect1><title>
4013 #: apt.conf.5.xml:570
4014 msgid "APT in DSelect"
4017 #. type: Content of: <refentry><refsect1><para>
4018 #: apt.conf.5.xml:572
4020 "When APT is used as a &dselect; method several configuration directives "
4021 "control the default behaviour. These are in the <literal>DSelect</literal> "
4025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4026 #: apt.conf.5.xml:577
4028 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
4029 "and never. always and prompt will remove all packages from the cache after "
4030 "upgrading, prompt (the default) does so conditionally. auto removes only "
4031 "those packages which are no longer downloadable (replaced with a new version "
4032 "for instance). pre-auto performs this action before downloading new "
4036 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4037 #: apt.conf.5.xml:586
4039 "The contents of this variable is passed to &apt-get; as command line options "
4040 "when it is run for the install phase."
4043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4044 #: apt.conf.5.xml:591
4046 "The contents of this variable is passed to &apt-get; as command line options "
4047 "when it is run for the update phase."
4050 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4051 #: apt.conf.5.xml:596
4053 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
4054 "The default is to prompt only on error."
4057 #. type: Content of: <refentry><refsect1><title>
4058 #: apt.conf.5.xml:602
4059 msgid "How APT calls dpkg"
4062 #. type: Content of: <refentry><refsect1><para>
4063 #: apt.conf.5.xml:603
4065 "Several configuration directives control how APT invokes &dpkg;. These are "
4066 "in the <literal>DPkg</literal> section."
4069 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4070 #: apt.conf.5.xml:608
4072 "This is a list of options to pass to dpkg. The options must be specified "
4073 "using the list notation and each list item is passed as a single argument to "
4077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4078 #: apt.conf.5.xml:614
4080 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
4081 "<literal>options</literal> this must be specified in list notation. The "
4082 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4083 "fail APT will abort."
4086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4087 #: apt.conf.5.xml:621
4089 "This is a list of shell commands to run before invoking dpkg. Like "
4090 "<literal>options</literal> this must be specified in list notation. The "
4091 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4092 "fail APT will abort. APT will pass to the commands on standard input the "
4093 "filenames of all .deb files it is going to install, one per line."
4096 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4097 #: apt.conf.5.xml:627
4099 "Version 2 of this protocol dumps more information, including the protocol "
4100 "version, the APT configuration space and the packages, files and versions "
4101 "being changed. Version 2 is enabled by setting "
4102 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
4103 "2. <literal>cmd</literal> is a command given to "
4104 "<literal>Pre-Install-Pkgs</literal>."
4107 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4108 #: apt.conf.5.xml:635
4110 "APT chdirs to this directory before invoking dpkg, the default is "
4111 "<filename>/</filename>."
4114 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4115 #: apt.conf.5.xml:640
4117 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
4118 "default is to disable signing and produce all binaries."
4121 #. type: Content of: <refentry><refsect1><refsect2><title>
4122 #: apt.conf.5.xml:645
4123 msgid "dpkg trigger usage (and related options)"
4126 #. type: Content of: <refentry><refsect1><refsect2><para>
4127 #: apt.conf.5.xml:646
4129 "APT can call dpkg in a way so it can make aggressive use of triggers over "
4130 "multiple calls of dpkg. Without further options dpkg will use triggers only "
4131 "in between his own run. Activating these options can therefore decrease the "
4132 "time needed to perform the install / upgrade. Note that it is intended to "
4133 "activate these options per default in the future, but as it changes the way "
4134 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
4135 "options are therefore currently experimental and should not be used in "
4136 "productive environments.</emphasis> Also it breaks the progress reporting so "
4137 "all frontends will currently stay around half (or more) of the time in the "
4138 "100% state while it actually configures all packages."
4141 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
4142 #: apt.conf.5.xml:661
4145 "DPkg::NoTriggers \"true\";\n"
4146 "PackageManager::Configure \"smart\";\n"
4147 "DPkg::ConfigurePending \"true\";\n"
4148 "DPkg::TriggersPending \"true\";"
4151 #. type: Content of: <refentry><refsect1><refsect2><para>
4152 #: apt.conf.5.xml:655
4154 "Note that it is not guaranteed that APT will support these options or that "
4155 "these options will not cause (big) trouble in the future. If you have "
4156 "understand the current risks and problems with these options, but are brave "
4157 "enough to help testing them create a new configuration file and test a "
4158 "combination of options. Please report any bugs, problems and improvements "
4159 "you encounter and make sure to note which options you have used in your "
4160 "reports. Asking dpkg for help could also be useful for debugging proposes, "
4161 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
4162 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
4165 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4166 #: apt.conf.5.xml:668
4168 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
4169 "call). See &dpkg; if you are interested in what this actually means. In "
4170 "short: dpkg will not run the triggers when this flag is present unless it is "
4171 "explicitly called to do so in an extra call. Note that this option exists "
4172 "(undocumented) also in older apt versions with a slightly different meaning: "
4173 "Previously these option only append --no-triggers to the configure calls to "
4174 "dpkg - now apt will add these flag also to the unpack and remove calls."
4177 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4178 #: apt.conf.5.xml:676
4180 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
4181 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
4182 "value and causes APT to configure all packages explicit. The "
4183 "\"<literal>smart</literal>\" way is it to configure only packages which need "
4184 "to be configured before another package can be unpacked (Pre-Depends) and "
4185 "let the rest configure by dpkg with a call generated by the next "
4186 "option. \"<literal>no</literal>\" on the other hand will not configure "
4187 "anything and totally rely on dpkg for configuration (which will at the "
4188 "moment fail if a Pre-Depends is encountered). Setting this option to "
4189 "another than the all value will implicitly activate also the next option per "
4190 "default as otherwise the system could end in an unconfigured status which "
4191 "could be unbootable!"
4194 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4195 #: apt.conf.5.xml:687
4197 "If this option is set apt will call <command>dpkg --configure "
4198 "--pending</command> to let dpkg handle all required configurations and "
4199 "triggers. This option is activated automatic per default if the previous "
4200 "option is not set to <literal>all</literal>, but deactivating could be "
4201 "useful if you want to run APT multiple times in a row - e.g. in an "
4202 "installer. In these sceneries you could deactivate this option in all but "
4206 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4207 #: apt.conf.5.xml:694
4209 "Useful for <literal>smart</literal> configuration as a package which has "
4210 "pending triggers is not considered as <literal>installed</literal> and dpkg "
4211 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
4212 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
4213 "triggers, not only the triggers needed to configure this package."
4216 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4217 #: apt.conf.5.xml:700
4219 "As the configuration can be deferred to be done at the end by dpkg it can be "
4220 "tried to order the unpack series only by critical needs, e.g. by "
4221 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
4222 "various steps by everything. While both method were present in earlier APT "
4223 "versions the <literal>OrderCritical</literal> method was unused, so this "
4224 "method is very experimental and needs further improvements before becoming "
4228 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
4229 #: apt.conf.5.xml:715
4232 "OrderList::Score {\n"
4234 "\tEssential 200;\n"
4236 "\tPreDepends 50;\n"
4240 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4241 #: apt.conf.5.xml:708
4243 "Essential packages (and there dependencies) should be configured immediately "
4244 "after unpacking. It will be a good idea to do this quite early in the "
4245 "upgrade process as these these configure calls require currently also "
4246 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
4247 "(which maybe not needed). Essentials get per default a high score but the "
4248 "immediate flag is relatively low (a package which has a Pre-Depends is "
4249 "higher rated). These option and the others in the same group can be used to "
4250 "change the scoring. The following example shows the settings with there "
4251 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
4254 #. type: Content of: <refentry><refsect1><title>
4255 #: apt.conf.5.xml:728
4256 msgid "Periodic and Archives options"
4259 #. type: Content of: <refentry><refsect1><para>
4260 #: apt.conf.5.xml:729
4262 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
4263 "of options configure behavior of apt periodic updates, which is done by "
4264 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
4265 "the brief documentation of these options."
4268 #. type: Content of: <refentry><refsect1><title>
4269 #: apt.conf.5.xml:737
4270 msgid "Debug options"
4273 #. type: Content of: <refentry><refsect1><para>
4274 #: apt.conf.5.xml:739
4276 "Enabling options in the <literal>Debug::</literal> section will cause "
4277 "debugging information to be sent to the standard error stream of the program "
4278 "utilizing the <literal>apt</literal> libraries, or enable special program "
4279 "modes that are primarily useful for debugging the behavior of "
4280 "<literal>apt</literal>. Most of these options are not interesting to a "
4281 "normal user, but a few may be:"
4284 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4285 #: apt.conf.5.xml:750
4287 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
4288 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
4292 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4293 #: apt.conf.5.xml:758
4295 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
4296 "used to run some operations (for instance, <literal>apt-get -s "
4297 "install</literal>) as a non-root user."
4300 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4301 #: apt.conf.5.xml:767
4303 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
4304 "time that <literal>apt</literal> invokes &dpkg;."
4308 #. motivating example, except I haven't a clue why you'd want
4310 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4311 #: apt.conf.5.xml:775
4313 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
4317 #. type: Content of: <refentry><refsect1><para>
4318 #: apt.conf.5.xml:785
4319 msgid "A full list of debugging options to apt follows."
4322 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4323 #: apt.conf.5.xml:794
4324 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
4327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4328 #: apt.conf.5.xml:805
4329 msgid "Print information related to downloading packages using FTP."
4332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4333 #: apt.conf.5.xml:816
4334 msgid "Print information related to downloading packages using HTTP."
4337 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4338 #: apt.conf.5.xml:827
4339 msgid "Print information related to downloading packages using HTTPS."
4342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4343 #: apt.conf.5.xml:838
4345 "Print information related to verifying cryptographic signatures using "
4346 "<literal>gpg</literal>."
4349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4350 #: apt.conf.5.xml:849
4352 "Output information about the process of accessing collections of packages "
4353 "stored on CD-ROMs."
4356 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4357 #: apt.conf.5.xml:859
4358 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4362 #: apt.conf.5.xml:869
4364 "Output each cryptographic hash that is generated by the "
4365 "<literal>apt</literal> libraries."
4368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4369 #: apt.conf.5.xml:879
4371 "Do not include information from <literal>statfs</literal>, namely the number "
4372 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4376 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4377 #: apt.conf.5.xml:890
4379 "Disable all file locking. For instance, this will allow two instances of "
4380 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4384 #: apt.conf.5.xml:902
4385 msgid "Log when items are added to or removed from the global download queue."
4388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4389 #: apt.conf.5.xml:912
4391 "Output status messages and errors related to verifying checksums and "
4392 "cryptographic signatures of downloaded files."
4395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4396 #: apt.conf.5.xml:922
4398 "Output information about downloading and applying package index list diffs, "
4399 "and errors relating to package index list diffs."
4402 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4403 #: apt.conf.5.xml:934
4405 "Output information related to patching apt package lists when downloading "
4406 "index diffs instead of full indices."
4409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4410 #: apt.conf.5.xml:945
4411 msgid "Log all interactions with the sub-processes that actually perform downloads."
4414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4415 #: apt.conf.5.xml:956
4417 "Log events related to the automatically-installed status of packages and to "
4418 "the removal of unused packages."
4421 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4422 #: apt.conf.5.xml:966
4424 "Generate debug messages describing which packages are being automatically "
4425 "installed to resolve dependencies. This corresponds to the initial "
4426 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4427 "and not to the full <literal>apt</literal> dependency resolver; see "
4428 "<literal>Debug::pkgProblemResolver</literal> for that."
4431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4432 #: apt.conf.5.xml:980
4434 "Generate debug messages describing which package is marked as "
4435 "keep/install/remove while the ProblemResolver does his work. Each addition "
4436 "or deletion may trigger additional actions; they are shown indented two "
4437 "additional space under the original entry. The format for each line is "
4438 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4439 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4440 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4441 "is the current version of the package, <literal>d.e.f</literal> is the "
4442 "version considered for installation and <literal>x.y.z</literal> is a newer "
4443 "version, but not considered for installation (because of a low pin "
4444 "score). The later two can be omitted if there is none or if it is the same "
4445 "version as the installed. <literal>section</literal> is the name of the "
4446 "section the package appears in."
4449 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4450 #: apt.conf.5.xml:1002
4451 msgid "Dump the default configuration to standard error on startup."
4454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4455 #: apt.conf.5.xml:1012
4457 "When invoking &dpkg;, output the precise command line with which it is being "
4458 "invoked, with arguments separated by a single space character."
4461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4462 #: apt.conf.5.xml:1023
4464 "Output all the data received from &dpkg; on the status file descriptor and "
4465 "any errors encountered while parsing it."
4468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4469 #: apt.conf.5.xml:1034
4471 "Generate a trace of the algorithm that decides the order in which "
4472 "<literal>apt</literal> should pass packages to &dpkg;."
4475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4476 #: apt.conf.5.xml:1046
4477 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4481 #: apt.conf.5.xml:1057
4482 msgid "Output the priority of each package list on startup."
4485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4486 #: apt.conf.5.xml:1067
4488 "Trace the execution of the dependency resolver (this applies only to what "
4489 "happens when a complex dependency problem is encountered)."
4492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4493 #: apt.conf.5.xml:1078
4495 "Display a list of all installed packages with their calculated score used by "
4496 "the pkgProblemResolver. The description of the package is the same as "
4497 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4501 #: apt.conf.5.xml:1090
4503 "Print information about the vendors read from "
4504 "<filename>/etc/apt/vendors.list</filename>."
4507 #. type: Content of: <refentry><refsect1><para>
4508 #: apt.conf.5.xml:1113
4510 "&configureindex; is a configuration file showing example values for all "
4514 #. type: Content of: <refentry><refsect1><variablelist>
4515 #: apt.conf.5.xml:1120
4516 msgid "&file-aptconf;"
4519 #. ? reading apt.conf
4520 #. type: Content of: <refentry><refsect1><para>
4521 #: apt.conf.5.xml:1125
4522 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4525 #. type: Content of: <refentry><refnamediv><refpurpose>
4526 #: apt_preferences.5.xml:32
4527 msgid "Preference control file for APT"
4530 #. type: Content of: <refentry><refsect1><para>
4531 #: apt_preferences.5.xml:37
4533 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4534 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4535 "can be used to control which versions of packages will be selected for "
4539 #. type: Content of: <refentry><refsect1><para>
4540 #: apt_preferences.5.xml:42
4542 "Several versions of a package may be available for installation when the "
4543 "&sources-list; file contains references to more than one distribution (for "
4544 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4545 "assigns a priority to each version that is available. Subject to dependency "
4546 "constraints, <command>apt-get</command> selects the version with the highest "
4547 "priority for installation. The APT preferences file overrides the "
4548 "priorities that APT assigns to package versions by default, thus giving the "
4549 "user control over which one is selected for installation."
4552 #. type: Content of: <refentry><refsect1><para>
4553 #: apt_preferences.5.xml:52
4555 "Several instances of the same version of a package may be available when the "
4556 "&sources-list; file contains references to more than one source. In this "
4557 "case <command>apt-get</command> downloads the instance listed earliest in "
4558 "the &sources-list; file. The APT preferences file does not affect the "
4559 "choice of instance, only the choice of version."
4562 #. type: Content of: <refentry><refsect1><para>
4563 #: apt_preferences.5.xml:59
4565 "Preferences are a strong power in the hands of a system administrator but "
4566 "they can become also their biggest nightmare if used without care! APT will "
4567 "not questioning the preferences so wrong settings will therefore lead to "
4568 "uninstallable packages or wrong decisions while upgrading packages. Even "
4569 "more problems will arise if multiply distribution releases are mixed without "
4570 "a good understanding of the following paragraphs. Packages included in a "
4571 "specific release aren't tested in and therefore doesn't always work as "
4572 "expected in older or newer releases or together with other packages from "
4573 "different releases. You have been warned."
4576 #. type: Content of: <refentry><refsect1><para>
4577 #: apt_preferences.5.xml:70
4579 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4580 "directory are parsed in alphanumeric ascending order and need to obey the "
4581 "following naming convention: The files have either no or "
4582 "\"<literal>pref</literal>\" as filename extension and only contain "
4583 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4584 "Otherwise APT will print a notice that it has ignored a file if the file "
4585 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4586 "configuration list - in this case it will be silently ignored."
4589 #. type: Content of: <refentry><refsect1><refsect2><title>
4590 #: apt_preferences.5.xml:79
4591 msgid "APT's Default Priority Assignments"
4594 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4595 #: apt_preferences.5.xml:94
4598 "<command>apt-get install -t testing "
4599 "<replaceable>some-package</replaceable></command>\n"
4602 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4603 #: apt_preferences.5.xml:97
4605 msgid "APT::Default-Release \"stable\";\n"
4608 #. type: Content of: <refentry><refsect1><refsect2><para>
4609 #: apt_preferences.5.xml:81
4611 "If there is no preferences file or if there is no entry in the file that "
4612 "applies to a particular version then the priority assigned to that version "
4613 "is the priority of the distribution to which that version belongs. It is "
4614 "possible to single out a distribution, \"the target release\", which "
4615 "receives a higher priority than other distributions do by default. The "
4616 "target release can be set on the <command>apt-get</command> command line or "
4617 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4618 "that this has precedence over any general priority you set in the "
4619 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4620 "specifically pinned packages. For example, <placeholder "
4621 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4625 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4626 #: apt_preferences.5.xml:106
4630 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4631 #: apt_preferences.5.xml:107
4633 "to the versions coming from archives which in their "
4634 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4635 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
4636 "<literal>experimental</literal> archive."
4639 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4640 #: apt_preferences.5.xml:113
4641 msgid "priority 100"
4644 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4645 #: apt_preferences.5.xml:114
4647 "to the version that is already installed (if any) and to the versions coming "
4648 "from archives which in their <filename>Release</filename> files are marked "
4649 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
4650 "backports archive since <literal>squeeze-backports</literal>."
4653 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4654 #: apt_preferences.5.xml:121
4655 msgid "priority 500"
4658 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4659 #: apt_preferences.5.xml:122
4661 "to the versions that are not installed and do not belong to the target "
4665 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4666 #: apt_preferences.5.xml:126
4667 msgid "priority 990"
4670 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4671 #: apt_preferences.5.xml:127
4672 msgid "to the versions that are not installed and belong to the target release."
4675 #. type: Content of: <refentry><refsect1><refsect2><para>
4676 #: apt_preferences.5.xml:101
4678 "If the target release has been specified then APT uses the following "
4679 "algorithm to set the priorities of the versions of a package. Assign: "
4680 "<placeholder type=\"variablelist\" id=\"0\"/>"
4683 #. type: Content of: <refentry><refsect1><refsect2><para>
4684 #: apt_preferences.5.xml:132
4686 "If the target release has not been specified then APT simply assigns "
4687 "priority 100 to all installed package versions and priority 500 to all "
4688 "uninstalled package versions, except versions coming from archives which in "
4689 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4690 "- these versions get the priority 1 or priority 100 if it is additionally "
4691 "marked as \"ButAutomaticUpgrades: yes\"."
4694 #. type: Content of: <refentry><refsect1><refsect2><para>
4695 #: apt_preferences.5.xml:139
4697 "APT then applies the following rules, listed in order of precedence, to "
4698 "determine which version of a package to install."
4701 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4702 #: apt_preferences.5.xml:142
4704 "Never downgrade unless the priority of an available version exceeds 1000. "
4705 "(\"Downgrading\" is installing a less recent version of a package in place "
4706 "of a more recent version. Note that none of APT's default priorities "
4707 "exceeds 1000; such high priorities can only be set in the preferences file. "
4708 "Note also that downgrading a package can be risky.)"
4711 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4712 #: apt_preferences.5.xml:148
4713 msgid "Install the highest priority version."
4716 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4717 #: apt_preferences.5.xml:149
4719 "If two or more versions have the same priority, install the most recent one "
4720 "(that is, the one with the higher version number)."
4723 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4724 #: apt_preferences.5.xml:152
4726 "If two or more versions have the same priority and version number but either "
4727 "the packages differ in some of their metadata or the "
4728 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4731 #. type: Content of: <refentry><refsect1><refsect2><para>
4732 #: apt_preferences.5.xml:158
4734 "In a typical situation, the installed version of a package (priority 100) "
4735 "is not as recent as one of the versions available from the sources listed in "
4736 "the &sources-list; file (priority 500 or 990). Then the package will be "
4737 "upgraded when <command>apt-get install "
4738 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4739 "upgrade</command> is executed."
4742 #. type: Content of: <refentry><refsect1><refsect2><para>
4743 #: apt_preferences.5.xml:165
4745 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4746 "recent than any of the other available versions. The package will not be "
4747 "downgraded when <command>apt-get install "
4748 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4749 "upgrade</command> is executed."
4752 #. type: Content of: <refentry><refsect1><refsect2><para>
4753 #: apt_preferences.5.xml:170
4755 "Sometimes the installed version of a package is more recent than the version "
4756 "belonging to the target release, but not as recent as a version belonging to "
4757 "some other distribution. Such a package will indeed be upgraded when "
4758 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4759 "or <command>apt-get upgrade</command> is executed, because at least "
4760 "<emphasis>one</emphasis> of the available versions has a higher priority "
4761 "than the installed version."
4764 #. type: Content of: <refentry><refsect1><refsect2><title>
4765 #: apt_preferences.5.xml:179
4766 msgid "The Effect of APT Preferences"
4769 #. type: Content of: <refentry><refsect1><refsect2><para>
4770 #: apt_preferences.5.xml:181
4772 "The APT preferences file allows the system administrator to control the "
4773 "assignment of priorities. The file consists of one or more multi-line "
4774 "records separated by blank lines. Records can have one of two forms, a "
4775 "specific form and a general form."
4778 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4779 #: apt_preferences.5.xml:187
4781 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4782 "specified packages and specified version or version range. For example, the "
4783 "following record assigns a high priority to all versions of the "
4784 "<filename>perl</filename> package whose version number begins with "
4785 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
4788 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4789 #: apt_preferences.5.xml:194
4793 "Pin: version 5.8*\n"
4794 "Pin-Priority: 1001\n"
4797 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4798 #: apt_preferences.5.xml:200
4800 "The general form assigns a priority to all of the package versions in a "
4801 "given distribution (that is, to all the versions of packages that are listed "
4802 "in a certain <filename>Release</filename> file) or to all of the package "
4803 "versions coming from a particular Internet site, as identified by the site's "
4804 "fully qualified domain name."
4807 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4808 #: apt_preferences.5.xml:206
4810 "This general-form entry in the APT preferences file applies only to groups "
4811 "of packages. For example, the following record assigns a high priority to "
4812 "all package versions available from the local site."
4815 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4816 #: apt_preferences.5.xml:211
4820 "Pin: origin \"\"\n"
4821 "Pin-Priority: 999\n"
4824 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4825 #: apt_preferences.5.xml:216
4827 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4828 "which can be used to match a hostname. The following record will assign a "
4829 "high priority to all versions available from the server identified by the "
4830 "hostname \"ftp.de.debian.org\""
4833 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4834 #: apt_preferences.5.xml:220
4838 "Pin: origin \"ftp.de.debian.org\"\n"
4839 "Pin-Priority: 999\n"
4842 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4843 #: apt_preferences.5.xml:224
4845 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4846 "distribution as specified in a <filename>Release</filename> file. What "
4847 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4848 "Internet address but an author or vendor name, such as \"Debian\" or "
4852 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4853 #: apt_preferences.5.xml:229
4855 "The following record assigns a low priority to all package versions "
4856 "belonging to any distribution whose Archive name is "
4857 "\"<literal>unstable</literal>\"."
4860 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4861 #: apt_preferences.5.xml:233
4865 "Pin: release a=unstable\n"
4866 "Pin-Priority: 50\n"
4869 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4870 #: apt_preferences.5.xml:238
4872 "The following record assigns a high priority to all package versions "
4873 "belonging to any distribution whose Codename is "
4874 "\"<literal>&testing-codename;</literal>\"."
4877 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4878 #: apt_preferences.5.xml:242
4882 "Pin: release n=&testing-codename;\n"
4883 "Pin-Priority: 900\n"
4886 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4887 #: apt_preferences.5.xml:247
4889 "The following record assigns a high priority to all package versions "
4890 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4891 "and whose release Version number is \"<literal>3.0</literal>\"."
4894 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4895 #: apt_preferences.5.xml:252
4899 "Pin: release a=stable, v=3.0\n"
4900 "Pin-Priority: 500\n"
4903 #. type: Content of: <refentry><refsect1><refsect2><title>
4904 #: apt_preferences.5.xml:262
4905 msgid "Regular expressions and glob() syntax"
4908 #. type: Content of: <refentry><refsect1><refsect2><para>
4909 #: apt_preferences.5.xml:264
4911 "APT also supports pinning by glob() expressions and regular expressions "
4912 "surrounded by /. For example, the following example assigns the priority 500 "
4913 "to all packages from experimental where the name starts with gnome (as a "
4914 "glob()-like expression) or contains the word kde (as a POSIX extended "
4915 "regular expression surrounded by slashes)."
4918 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4919 #: apt_preferences.5.xml:273
4922 "Package: gnome* /kde/\n"
4923 "Pin: release n=experimental\n"
4924 "Pin-Priority: 500\n"
4927 #. type: Content of: <refentry><refsect1><refsect2><para>
4928 #: apt_preferences.5.xml:279
4930 "The rule for those expressions is that they can occur anywhere where a "
4931 "string can occur. Thus, the following pin assigns the priority 990 to all "
4932 "packages from a release starting with karmic."
4935 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4936 #: apt_preferences.5.xml:285
4940 "Pin: release n=karmic*\n"
4941 "Pin-Priority: 990\n"
4944 #. type: Content of: <refentry><refsect1><refsect2><para>
4945 #: apt_preferences.5.xml:291
4947 "If a regular expression occurs in a <literal>Package</literal> field, the "
4948 "behavior is the same as if this regular expression were replaced with a list "
4949 "of all package names it matches. It is undecided whether this will change in "
4950 "the future, thus you should always list wild-card pins first, so later "
4951 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4952 "Package field is not considered a glob() expression in itself."
4955 #. type: Content of: <refentry><refsect1><refsect2><title>
4956 #: apt_preferences.5.xml:307
4957 msgid "How APT Interprets Priorities"
4960 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4961 #: apt_preferences.5.xml:315
4965 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4966 #: apt_preferences.5.xml:316
4968 "causes a version to be installed even if this constitutes a downgrade of the "
4972 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4973 #: apt_preferences.5.xml:320
4974 msgid "990 < P <=1000"
4977 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4978 #: apt_preferences.5.xml:321
4980 "causes a version to be installed even if it does not come from the target "
4981 "release, unless the installed version is more recent"
4984 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4985 #: apt_preferences.5.xml:326
4986 msgid "500 < P <=990"
4989 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4990 #: apt_preferences.5.xml:327
4992 "causes a version to be installed unless there is a version available "
4993 "belonging to the target release or the installed version is more recent"
4996 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4997 #: apt_preferences.5.xml:332
4998 msgid "100 < P <=500"
5001 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5002 #: apt_preferences.5.xml:333
5004 "causes a version to be installed unless there is a version available "
5005 "belonging to some other distribution or the installed version is more recent"
5008 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5009 #: apt_preferences.5.xml:338
5010 msgid "0 < P <=100"
5013 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5014 #: apt_preferences.5.xml:339
5016 "causes a version to be installed only if there is no installed version of "
5020 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5021 #: apt_preferences.5.xml:343
5025 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5026 #: apt_preferences.5.xml:344
5027 msgid "prevents the version from being installed"
5030 #. type: Content of: <refentry><refsect1><refsect2><para>
5031 #: apt_preferences.5.xml:310
5033 "Priorities (P) assigned in the APT preferences file must be positive or "
5034 "negative integers. They are interpreted as follows (roughly speaking): "
5035 "<placeholder type=\"variablelist\" id=\"0\"/>"
5038 #. type: Content of: <refentry><refsect1><refsect2><para>
5039 #: apt_preferences.5.xml:349
5041 "If any specific-form records match an available package version then the "
5042 "first such record determines the priority of the package version. Failing "
5043 "that, if any general-form records match an available package version then "
5044 "the first such record determines the priority of the package version."
5047 #. type: Content of: <refentry><refsect1><refsect2><para>
5048 #: apt_preferences.5.xml:355
5050 "For example, suppose the APT preferences file contains the three records "
5051 "presented earlier:"
5054 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5055 #: apt_preferences.5.xml:359
5059 "Pin: version 5.8*\n"
5060 "Pin-Priority: 1001\n"
5063 "Pin: origin \"\"\n"
5064 "Pin-Priority: 999\n"
5067 "Pin: release unstable\n"
5068 "Pin-Priority: 50\n"
5071 #. type: Content of: <refentry><refsect1><refsect2><para>
5072 #: apt_preferences.5.xml:372
5076 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5077 #: apt_preferences.5.xml:374
5079 "The most recent available version of the <literal>perl</literal> package "
5080 "will be installed, so long as that version's version number begins with "
5081 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
5082 "<literal>perl</literal> is available and the installed version is 5.9*, then "
5083 "<literal>perl</literal> will be downgraded."
5086 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5087 #: apt_preferences.5.xml:379
5089 "A version of any package other than <literal>perl</literal> that is "
5090 "available from the local system has priority over other versions, even "
5091 "versions belonging to the target release."
5094 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5095 #: apt_preferences.5.xml:383
5097 "A version of a package whose origin is not the local system but some other "
5098 "site listed in &sources-list; and which belongs to an "
5099 "<literal>unstable</literal> distribution is only installed if it is selected "
5100 "for installation and no version of the package is already installed."
5103 #. type: Content of: <refentry><refsect1><refsect2><title>
5104 #: apt_preferences.5.xml:393
5105 msgid "Determination of Package Version and Distribution Properties"
5108 #. type: Content of: <refentry><refsect1><refsect2><para>
5109 #: apt_preferences.5.xml:395
5111 "The locations listed in the &sources-list; file should provide "
5112 "<filename>Packages</filename> and <filename>Release</filename> files to "
5113 "describe the packages available at that location."
5116 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5117 #: apt_preferences.5.xml:407
5118 msgid "the <literal>Package:</literal> line"
5121 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5122 #: apt_preferences.5.xml:408
5123 msgid "gives the package name"
5126 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5127 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
5128 msgid "the <literal>Version:</literal> line"
5131 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5132 #: apt_preferences.5.xml:412
5133 msgid "gives the version number for the named package"
5136 #. type: Content of: <refentry><refsect1><refsect2><para>
5137 #: apt_preferences.5.xml:399
5139 "The <filename>Packages</filename> file is normally found in the directory "
5140 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
5142 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
5143 "consists of a series of multi-line records, one for each package available "
5144 "in that directory. Only two lines in each record are relevant for setting "
5145 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
5148 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5149 #: apt_preferences.5.xml:428
5150 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
5153 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5154 #: apt_preferences.5.xml:429
5156 "names the archive to which all the packages in the directory tree belong. "
5157 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
5158 "that all of the packages in the directory tree below the parent of the "
5159 "<filename>Release</filename> file are in a <literal>stable</literal> "
5160 "archive. Specifying this value in the APT preferences file would require "
5164 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5165 #: apt_preferences.5.xml:439
5167 msgid "Pin: release a=stable\n"
5170 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5171 #: apt_preferences.5.xml:445
5172 msgid "the <literal>Codename:</literal> line"
5175 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5176 #: apt_preferences.5.xml:446
5178 "names the codename to which all the packages in the directory tree belong. "
5179 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
5180 "the packages in the directory tree below the parent of the "
5181 "<filename>Release</filename> file belong to a version named "
5182 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
5183 "preferences file would require the line:"
5186 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5187 #: apt_preferences.5.xml:455
5189 msgid "Pin: release n=&testing-codename;\n"
5192 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5193 #: apt_preferences.5.xml:462
5195 "names the release version. For example, the packages in the tree might "
5196 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
5197 "no version number for the <literal>testing</literal> and "
5198 "<literal>unstable</literal> distributions because they have not been "
5199 "released yet. Specifying this in the APT preferences file would require one "
5200 "of the following lines."
5203 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5204 #: apt_preferences.5.xml:471
5207 "Pin: release v=3.0\n"
5208 "Pin: release a=stable, v=3.0\n"
5209 "Pin: release 3.0\n"
5212 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5213 #: apt_preferences.5.xml:480
5214 msgid "the <literal>Component:</literal> line"
5217 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5218 #: apt_preferences.5.xml:481
5220 "names the licensing component associated with the packages in the directory "
5221 "tree of the <filename>Release</filename> file. For example, the line "
5222 "\"Component: main\" specifies that all the packages in the directory tree "
5223 "are from the <literal>main</literal> component, which entails that they are "
5224 "licensed under terms listed in the Debian Free Software Guidelines. "
5225 "Specifying this component in the APT preferences file would require the "
5229 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5230 #: apt_preferences.5.xml:490
5232 msgid "Pin: release c=main\n"
5235 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5236 #: apt_preferences.5.xml:496
5237 msgid "the <literal>Origin:</literal> line"
5240 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5241 #: apt_preferences.5.xml:497
5243 "names the originator of the packages in the directory tree of the "
5244 "<filename>Release</filename> file. Most commonly, this is "
5245 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
5246 "file would require the line:"
5249 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5250 #: apt_preferences.5.xml:503
5252 msgid "Pin: release o=Debian\n"
5255 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5256 #: apt_preferences.5.xml:509
5257 msgid "the <literal>Label:</literal> line"
5260 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5261 #: apt_preferences.5.xml:510
5263 "names the label of the packages in the directory tree of the "
5264 "<filename>Release</filename> file. Most commonly, this is "
5265 "<literal>Debian</literal>. Specifying this label in the APT preferences "
5266 "file would require the line:"
5269 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5270 #: apt_preferences.5.xml:516
5272 msgid "Pin: release l=Debian\n"
5275 #. type: Content of: <refentry><refsect1><refsect2><para>
5276 #: apt_preferences.5.xml:417
5278 "The <filename>Release</filename> file is normally found in the directory "
5279 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
5280 "example, <filename>.../dists/stable/Release</filename>, or "
5281 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
5282 "single multi-line record which applies to <emphasis>all</emphasis> of the "
5283 "packages in the directory tree below its parent. Unlike the "
5284 "<filename>Packages</filename> file, nearly all of the lines in a "
5285 "<filename>Release</filename> file are relevant for setting APT priorities: "
5286 "<placeholder type=\"variablelist\" id=\"0\"/>"
5289 #. type: Content of: <refentry><refsect1><refsect2><para>
5290 #: apt_preferences.5.xml:523
5292 "All of the <filename>Packages</filename> and <filename>Release</filename> "
5293 "files retrieved from locations listed in the &sources-list; file are stored "
5294 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
5295 "named by the variable <literal>Dir::State::Lists</literal> in the "
5296 "<filename>apt.conf</filename> file. For example, the file "
5297 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
5298 "contains the <filename>Release</filename> file retrieved from the site "
5299 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5300 "architecture files from the <literal>contrib</literal> component of the "
5301 "<literal>unstable</literal> distribution."
5304 #. type: Content of: <refentry><refsect1><refsect2><title>
5305 #: apt_preferences.5.xml:536
5306 msgid "Optional Lines in an APT Preferences Record"
5309 #. type: Content of: <refentry><refsect1><refsect2><para>
5310 #: apt_preferences.5.xml:538
5312 "Each record in the APT preferences file can optionally begin with one or "
5313 "more lines beginning with the word <literal>Explanation:</literal>. This "
5314 "provides a place for comments."
5317 #. type: Content of: <refentry><refsect1><refsect2><title>
5318 #: apt_preferences.5.xml:547
5319 msgid "Tracking Stable"
5322 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5323 #: apt_preferences.5.xml:555
5326 "Explanation: Uninstall or do not install any Debian-originated\n"
5327 "Explanation: package versions other than those in the stable distro\n"
5329 "Pin: release a=stable\n"
5330 "Pin-Priority: 900\n"
5333 "Pin: release o=Debian\n"
5334 "Pin-Priority: -10\n"
5337 #. type: Content of: <refentry><refsect1><refsect2><para>
5338 #: apt_preferences.5.xml:549
5340 "The following APT preferences file will cause APT to assign a priority "
5341 "higher than the default (500) to all package versions belonging to a "
5342 "<literal>stable</literal> distribution and a prohibitively low priority to "
5343 "package versions belonging to other <literal>Debian</literal> "
5344 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5347 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5348 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
5351 "apt-get install <replaceable>package-name</replaceable>\n"
5353 "apt-get dist-upgrade\n"
5356 #. type: Content of: <refentry><refsect1><refsect2><para>
5357 #: apt_preferences.5.xml:567
5359 "With a suitable &sources-list; file and the above preferences file, any of "
5360 "the following commands will cause APT to upgrade to the latest "
5361 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5365 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5366 #: apt_preferences.5.xml:584
5368 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5371 #. type: Content of: <refentry><refsect1><refsect2><para>
5372 #: apt_preferences.5.xml:578
5374 "The following command will cause APT to upgrade the specified package to the "
5375 "latest version from the <literal>testing</literal> distribution; the package "
5376 "will not be upgraded again unless this command is given again. <placeholder "
5377 "type=\"programlisting\" id=\"0\"/>"
5380 #. type: Content of: <refentry><refsect1><refsect2><title>
5381 #: apt_preferences.5.xml:590
5382 msgid "Tracking Testing or Unstable"
5385 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5386 #: apt_preferences.5.xml:599
5390 "Pin: release a=testing\n"
5391 "Pin-Priority: 900\n"
5394 "Pin: release a=unstable\n"
5395 "Pin-Priority: 800\n"
5398 "Pin: release o=Debian\n"
5399 "Pin-Priority: -10\n"
5402 #. type: Content of: <refentry><refsect1><refsect2><para>
5403 #: apt_preferences.5.xml:592
5405 "The following APT preferences file will cause APT to assign a high priority "
5406 "to package versions from the <literal>testing</literal> distribution, a "
5407 "lower priority to package versions from the <literal>unstable</literal> "
5408 "distribution, and a prohibitively low priority to package versions from "
5409 "other <literal>Debian</literal> distributions. <placeholder "
5410 "type=\"programlisting\" id=\"0\"/>"
5413 #. type: Content of: <refentry><refsect1><refsect2><para>
5414 #: apt_preferences.5.xml:613
5416 "With a suitable &sources-list; file and the above preferences file, any of "
5417 "the following commands will cause APT to upgrade to the latest "
5418 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5422 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5423 #: apt_preferences.5.xml:633
5425 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5428 #. type: Content of: <refentry><refsect1><refsect2><para>
5429 #: apt_preferences.5.xml:624
5431 "The following command will cause APT to upgrade the specified package to the "
5432 "latest version from the <literal>unstable</literal> distribution. "
5433 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5434 "the most recent <literal>testing</literal> version if that is more recent "
5435 "than the installed version, otherwise, to the most recent "
5436 "<literal>unstable</literal> version if that is more recent than the "
5437 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5440 #. type: Content of: <refentry><refsect1><refsect2><title>
5441 #: apt_preferences.5.xml:640
5442 msgid "Tracking the evolution of a codename release"
5445 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5446 #: apt_preferences.5.xml:654
5449 "Explanation: Uninstall or do not install any Debian-originated package "
5451 "Explanation: other than those in the distribution codenamed with "
5452 "&testing-codename; or sid\n"
5454 "Pin: release n=&testing-codename;\n"
5455 "Pin-Priority: 900\n"
5457 "Explanation: Debian unstable is always codenamed with sid\n"
5459 "Pin: release n=sid\n"
5460 "Pin-Priority: 800\n"
5463 "Pin: release o=Debian\n"
5464 "Pin-Priority: -10\n"
5467 #. type: Content of: <refentry><refsect1><refsect2><para>
5468 #: apt_preferences.5.xml:642
5470 "The following APT preferences file will cause APT to assign a priority "
5471 "higher than the default (500) to all package versions belonging to a "
5472 "specified codename of a distribution and a prohibitively low priority to "
5473 "package versions belonging to other <literal>Debian</literal> distributions, "
5474 "codenames and archives. Note that with this APT preference APT will follow "
5475 "the migration of a release from the archive <literal>testing</literal> to "
5476 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5477 "want to follow for example the progress in <literal>testing</literal> "
5478 "notwithstanding the codename changes you should use the example "
5479 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5482 #. type: Content of: <refentry><refsect1><refsect2><para>
5483 #: apt_preferences.5.xml:671
5485 "With a suitable &sources-list; file and the above preferences file, any of "
5486 "the following commands will cause APT to upgrade to the latest version(s) in "
5487 "the release codenamed with <literal>&testing-codename;</literal>. "
5488 "<placeholder type=\"programlisting\" id=\"0\"/>"
5491 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5492 #: apt_preferences.5.xml:691
5494 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5497 #. type: Content of: <refentry><refsect1><refsect2><para>
5498 #: apt_preferences.5.xml:682
5500 "The following command will cause APT to upgrade the specified package to the "
5501 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5502 "<command>apt-get upgrade</command> will upgrade the package to the most "
5503 "recent <literal>&testing-codename;</literal> version if that is more recent "
5504 "than the installed version, otherwise, to the most recent "
5505 "<literal>sid</literal> version if that is more recent than the installed "
5506 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5509 #. type: Content of: <refentry><refsect1><variablelist>
5510 #: apt_preferences.5.xml:700
5511 msgid "&file-preferences;"
5514 #. type: Content of: <refentry><refsect1><para>
5515 #: apt_preferences.5.xml:706
5516 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5519 #. type: Content of: <refentry><refnamediv><refpurpose>
5520 #: sources.list.5.xml:33
5521 msgid "Package resource list for APT"
5524 #. type: Content of: <refentry><refsect1><para>
5525 #: sources.list.5.xml:37
5527 "The package resource list is used to locate archives of the package "
5528 "distribution system in use on the system. At this time, this manual page "
5529 "documents only the packaging system used by the Debian GNU/Linux system. "
5530 "This control file is <filename>/etc/apt/sources.list</filename>."
5533 #. type: Content of: <refentry><refsect1><para>
5534 #: sources.list.5.xml:42
5536 "The source list is designed to support any number of active sources and a "
5537 "variety of source media. The file lists one source per line, with the most "
5538 "preferred source listed first. The format of each line is: <literal>type uri "
5539 "args</literal> The first item, <literal>type</literal> determines the format "
5540 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
5541 "Identifier (URI), which is a superset of the more specific and well-known "
5542 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
5543 "comment by using a #."
5546 #. type: Content of: <refentry><refsect1><title>
5547 #: sources.list.5.xml:53
5548 msgid "sources.list.d"
5551 #. type: Content of: <refentry><refsect1><para>
5552 #: sources.list.5.xml:54
5554 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5555 "add sources.list entries in separate files. The format is the same as for "
5556 "the regular <filename>sources.list</filename> file. File names need to end "
5557 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
5558 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
5559 "Otherwise APT will print a notice that it has ignored a file if the file "
5560 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5561 "configuration list - in this case it will be silently ignored."
5564 #. type: Content of: <refentry><refsect1><title>
5565 #: sources.list.5.xml:65
5566 msgid "The deb and deb-src types"
5569 #. type: Content of: <refentry><refsect1><para>
5570 #: sources.list.5.xml:66
5572 "The <literal>deb</literal> type describes a typical two-level Debian "
5573 "archive, <filename>distribution/component</filename>. Typically, "
5574 "<literal>distribution</literal> is generally an archivename like "
5575 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5576 "<literal>&stable-codename;</literal> or "
5577 "<literal>&testing-codename;</literal> while component is one of "
5578 "<literal>main</literal> <literal>contrib</literal> or "
5579 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
5580 "debian distribution's source code in the same form as the "
5581 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5582 "to fetch source indexes."
5585 #. type: Content of: <refentry><refsect1><para>
5586 #: sources.list.5.xml:78
5588 "The format for a <filename>sources.list</filename> entry using the "
5589 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
5592 #. type: Content of: <refentry><refsect1><literallayout>
5593 #: sources.list.5.xml:81
5595 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
5598 #. type: Content of: <refentry><refsect1><para>
5599 #: sources.list.5.xml:83
5601 "The URI for the <literal>deb</literal> type must specify the base of the "
5602 "Debian distribution, from which APT will find the information it needs. "
5603 "<literal>distribution</literal> can specify an exact path, in which case the "
5604 "components must be omitted and <literal>distribution</literal> must end with "
5605 "a slash (/). This is useful for when the case only a particular sub-section "
5606 "of the archive denoted by the URI is of interest. If "
5607 "<literal>distribution</literal> does not specify an exact path, at least one "
5608 "<literal>component</literal> must be present."
5611 #. type: Content of: <refentry><refsect1><para>
5612 #: sources.list.5.xml:92
5614 "<literal>distribution</literal> may also contain a variable, "
5615 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
5616 "m68k, powerpc, ...) used on the system. This permits "
5617 "architecture-independent <filename>sources.list</filename> files to be "
5618 "used. In general this is only of interest when specifying an exact path, "
5619 "<literal>APT</literal> will automatically generate a URI with the current "
5620 "architecture otherwise."
5623 #. type: Content of: <refentry><refsect1><para>
5624 #: sources.list.5.xml:100
5626 "Since only one distribution can be specified per line it may be necessary to "
5627 "have multiple lines for the same URI, if a subset of all available "
5628 "distributions or components at that location is desired. APT will sort the "
5629 "URI list after it has generated a complete set internally, and will collapse "
5630 "multiple references to the same Internet host, for instance, into a single "
5631 "connection, so that it does not inefficiently establish an FTP connection, "
5632 "close it, do something else, and then re-establish a connection to that same "
5633 "host. This feature is useful for accessing busy FTP sites with limits on the "
5634 "number of simultaneous anonymous users. APT also parallelizes connections to "
5635 "different hosts to more effectively deal with sites with low bandwidth."
5638 #. type: Content of: <refentry><refsect1><para>
5639 #: sources.list.5.xml:112
5641 "<literal>options</literal> is always optional and needs to be surounded by "
5642 "square brackets. It can consist of multiple settings in the form "
5643 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
5644 "Multiple settings are separated by spaces. The following settings are "
5645 "supported by APT, note though that unsupported settings will be ignored "
5649 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5650 #: sources.list.5.xml:117
5652 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
5653 "can be used to specify for which architectures packages information should "
5654 "be downloaded. If this option is not set all architectures defined by the "
5655 "<literal>APT::Architectures</literal> option will be downloaded."
5658 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5659 #: sources.list.5.xml:121
5661 "<literal>trusted=yes</literal> can be set to indicate that packages from "
5662 "this source are always authenticated even if the "
5663 "<filename>Release</filename> file is not signed or the signature can't be "
5664 "checked. This disables parts of &apt-secure; and should therefore only be "
5665 "used in a local and trusted context. <literal>trusted=no</literal> is the "
5666 "opposite which handles even correctly authenticated sources as not "
5670 #. type: Content of: <refentry><refsect1><para>
5671 #: sources.list.5.xml:128
5673 "It is important to list sources in order of preference, with the most "
5674 "preferred source listed first. Typically this will result in sorting by "
5675 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5676 "followed by distant Internet hosts, for example)."
5679 #. type: Content of: <refentry><refsect1><para>
5680 #: sources.list.5.xml:133
5681 msgid "Some examples:"
5684 #. type: Content of: <refentry><refsect1><literallayout>
5685 #: sources.list.5.xml:135
5688 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5689 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5694 #. type: Content of: <refentry><refsect1><title>
5695 #: sources.list.5.xml:141
5696 msgid "URI specification"
5699 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5700 #: sources.list.5.xml:146
5704 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5705 #: sources.list.5.xml:148
5707 "The file scheme allows an arbitrary directory in the file system to be "
5708 "considered an archive. This is useful for NFS mounts and local mirrors or "
5712 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5713 #: sources.list.5.xml:153
5717 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5718 #: sources.list.5.xml:155
5720 "The cdrom scheme allows APT to use a local CDROM drive with media "
5721 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5725 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5726 #: sources.list.5.xml:160
5730 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5731 #: sources.list.5.xml:162
5733 "The http scheme specifies an HTTP server for the archive. If an environment "
5734 "variable <envar>http_proxy</envar> is set with the format "
5735 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5736 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5737 "the format http://user:pass@server:port/. Note that this is an insecure "
5738 "method of authentication."
5741 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5742 #: sources.list.5.xml:171
5746 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5747 #: sources.list.5.xml:173
5749 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5750 "is highly configurable; for more information see the &apt-conf; manual "
5751 "page. Please note that a ftp proxy can be specified by using the "
5752 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
5753 "http proxy (http proxy servers often understand ftp urls) using this method "
5754 "and ONLY this method. ftp proxies using http specified in the configuration "
5755 "file will be ignored."
5758 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5759 #: sources.list.5.xml:182
5763 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5764 #: sources.list.5.xml:184
5766 "The copy scheme is identical to the file scheme except that packages are "
5767 "copied into the cache directory instead of used directly at their location. "
5768 "This is useful for people using a zip disk to copy files around with APT."
5771 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5772 #: sources.list.5.xml:189
5776 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5777 #: sources.list.5.xml:189
5781 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5782 #: sources.list.5.xml:191
5784 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
5785 "user and access the files. It is a good idea to do prior arrangements with "
5786 "RSA keys or rhosts. Access to files on the remote uses standard "
5787 "<command>find</command> and <command>dd</command> commands to perform the "
5788 "file transfers from the remote."
5791 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5792 #: sources.list.5.xml:199
5793 msgid "more recognizable URI types"
5796 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5797 #: sources.list.5.xml:201
5799 "APT can be extended with more methods shipped in other optional packages "
5800 "which should follow the nameing scheme "
5801 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
5802 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
5803 "which provides access methods for https-URIs with features similar to the "
5804 "http method, but other methods for using e.g. debtorrent are also available, "
5805 "see <citerefentry> "
5806 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
5807 "<manvolnum>1</manvolnum></citerefentry>."
5810 #. type: Content of: <refentry><refsect1><para>
5811 #: sources.list.5.xml:143
5813 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
5814 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
5817 #. type: Content of: <refentry><refsect1><para>
5818 #: sources.list.5.xml:215
5820 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5821 "stable/main, stable/contrib, and stable/non-free."
5824 #. type: Content of: <refentry><refsect1><literallayout>
5825 #: sources.list.5.xml:217
5827 msgid "deb file:/home/jason/debian stable main contrib non-free"
5830 #. type: Content of: <refentry><refsect1><para>
5831 #: sources.list.5.xml:219
5832 msgid "As above, except this uses the unstable (development) distribution."
5835 #. type: Content of: <refentry><refsect1><literallayout>
5836 #: sources.list.5.xml:220
5838 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5841 #. type: Content of: <refentry><refsect1><para>
5842 #: sources.list.5.xml:222
5843 msgid "Source line for the above"
5846 #. type: Content of: <refentry><refsect1><literallayout>
5847 #: sources.list.5.xml:223
5849 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5852 #. type: Content of: <refentry><refsect1><para>
5853 #: sources.list.5.xml:225
5855 "The first line gets package information for the architectures in "
5856 "<literal>APT::Architectures</literal> while the second always retrieves "
5857 "<literal>amd64</literal> and <literal>armel</literal>."
5860 #. type: Content of: <refentry><refsect1><literallayout>
5861 #: sources.list.5.xml:227
5864 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5865 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5868 #. type: Content of: <refentry><refsect1><para>
5869 #: sources.list.5.xml:230
5871 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5875 #. type: Content of: <refentry><refsect1><literallayout>
5876 #: sources.list.5.xml:232
5878 msgid "deb http://archive.debian.org/debian-archive hamm main"
5881 #. type: Content of: <refentry><refsect1><para>
5882 #: sources.list.5.xml:234
5884 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5885 "directory, and uses only the &stable-codename;/contrib area."
5888 #. type: Content of: <refentry><refsect1><literallayout>
5889 #: sources.list.5.xml:236
5891 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5894 #. type: Content of: <refentry><refsect1><para>
5895 #: sources.list.5.xml:238
5897 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5898 "directory, and uses only the unstable/contrib area. If this line appears as "
5899 "well as the one in the previous example in <filename>sources.list</filename> "
5900 "a single FTP session will be used for both resource lines."
5903 #. type: Content of: <refentry><refsect1><literallayout>
5904 #: sources.list.5.xml:242
5906 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5909 #. type: Content of: <refentry><refsect1><para><literallayout>
5910 #: sources.list.5.xml:251
5912 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5915 #. type: Content of: <refentry><refsect1><para>
5916 #: sources.list.5.xml:244
5918 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5919 "directory, and uses only files found under "
5920 "<filename>unstable/binary-i386</filename> on i386 machines, "
5921 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5922 "supported architectures. [Note this example only illustrates how to use the "
5923 "substitution variable; official debian archives are not structured like "
5924 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5927 #. type: Content of: <refentry><refsect1><para>
5928 #: sources.list.5.xml:256
5929 msgid "&apt-cache; &apt-conf;"
5932 #. type: <title></title>
5934 msgid "APT User's Guide"
5937 #. type: <author></author>
5938 #: guide.sgml:6 offline.sgml:6
5939 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5942 #. type: <version></version>
5944 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5947 #. type: <abstract></abstract>
5950 "This document provides an overview of how to use the the APT package "
5954 #. type: <copyrightsummary></copyrightsummary>
5956 msgid "Copyright © Jason Gunthorpe, 1998."
5960 #: guide.sgml:21 offline.sgml:22
5962 "\"APT\" and this document are free software; you can redistribute them "
5963 "and/or modify them under the terms of the GNU General Public License as "
5964 "published by the Free Software Foundation; either version 2 of the License, "
5965 "or (at your option) any later version."
5969 #: guide.sgml:24 offline.sgml:25
5971 "For more details, on Debian GNU/Linux systems, see the file "
5972 "/usr/share/common-licenses/GPL for the full license."
5975 #. type: <heading></heading>
5983 "The APT package currently contains two sections, the APT "
5984 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
5985 "interface. Both provide a way to install and remove packages as well as "
5986 "download new packages from the Internet."
5989 #. type: <heading></heading>
5991 msgid "Anatomy of the Package System"
5997 "The Debian packaging system has a large amount of information associated "
5998 "with each package to help assure that it integrates cleanly and easily into "
5999 "the system. The most prominent of its features is the dependency system."
6005 "The dependency system allows individual programs to make use of shared "
6006 "elements in the system such as libraries. It simplifies placing infrequently "
6007 "used portions of a program in separate packages to reduce the number of "
6008 "things the average user is required to install. Also, it allows for choices "
6009 "in mail transport agents, X servers and so on."
6015 "The first step to understanding the dependency system is to grasp the "
6016 "concept of a simple dependency. The meaning of a simple dependency is that a "
6017 "package requires another package to be installed at the same time to work "
6024 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6025 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6026 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6027 "simple dependency on emacs, without emacs it is completely useless."
6033 "The other important dependency to understand is a conflicting dependency. It "
6034 "means that a package, when installed with another package, will not work and "
6035 "may possibly be extremely harmful to the system. As an example consider a "
6036 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6037 "have two mail transport agents installed because both need to listen to the "
6038 "network to receive mail. Attempting to install two will seriously damage the "
6039 "system so all mail transport agents have a conflicting dependency with all "
6040 "other mail transport agents."
6046 "As an added complication there is the possibility for a package to pretend "
6047 "to be another package. Consider that exim and sendmail for many intents are "
6048 "identical, they both deliver mail and understand a common interface. Hence, "
6049 "the package system has a way for them to declare that they are both "
6050 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6051 "a mail-transport-agent and other packages that need a mail transport agent "
6052 "depend on mail-transport-agent. This can add a great deal of confusion when "
6053 "trying to manually fix packages."
6059 "At any given time a single dependency may be met by packages that are "
6060 "already installed or it may not be. APT attempts to help resolve dependency "
6061 "issues by providing a number of automatic algorithms that help in selecting "
6062 "packages for installation."
6065 #. type: <heading></heading>
6073 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6074 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6075 "understand .deb files, it works with the package's proper name and can only "
6076 "install .deb archives from a <em>Source</em>."
6082 "The first <footnote><p>If you are using an http proxy server you must set "
6083 "the http_proxy environment variable first, see "
6084 "sources.list(5)</p></footnote> thing that should be done before using "
6085 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6086 "so that it knows what packages are available. This is done with <tt>apt-get "
6087 "update</tt>. For instance,"
6090 #. type: <example></example>
6094 "# apt-get update\n"
6095 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6096 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6097 "Reading Package Lists... Done\n"
6098 "Building Dependency Tree... Done"
6101 #. type: <p><taglist>
6103 msgid "Once updated there are several commands that can be used:"
6106 #. type: <tag></tag>
6114 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6115 "install a new package or remove an existing package, nor will it ever "
6116 "upgrade a package that might cause some other package to break. This can be "
6117 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6118 "the packages that it could not upgrade, this usually means that they depend "
6119 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6120 "<tt>apt-get install</tt> can be used to force these packages to install."
6123 #. type: <tag></tag>
6131 "Install is used to install packages by name. The package is automatically "
6132 "fetched and installed. This can be useful if you already know the name of "
6133 "the package to install and do not want to go into a GUI to select it. Any "
6134 "number of packages may be passed to install, they will all be "
6135 "fetched. Install automatically attempts to resolve dependency problems with "
6136 "the listed packages and will print a summary and ask for confirmation if "
6137 "anything other than its arguments are changed."
6140 #. type: <tag></tag>
6142 msgid "dist-upgrade"
6148 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6149 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6150 "set of packages to install, upgrade and remove to get as much of the system "
6151 "to the newest release. In some situations it may be desired to use "
6152 "dist-upgrade rather than spend the time manually resolving dependencies in "
6153 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6154 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6161 "It is important to closely look at what dist-upgrade is going to do, its "
6162 "decisions may sometimes be quite surprising."
6168 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6169 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6170 "option is <tt>-d</tt> which does not install the fetched files. If the "
6171 "system has to download a large number of package it would be undesired to "
6172 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6173 "the downloaded archives can be installed by simply running the command that "
6174 "caused them to be downloaded again without <tt>-d</tt>."
6177 #. type: <heading></heading>
6185 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6186 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6187 "to select the packages to be installed or removed and APT actually installs "
6194 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6195 "and then choose the APT method. You will be prompted for a set of "
6196 "<em>Sources</em> which are places to fetch archives from. These can be "
6197 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
6198 "provide a fragment of the total Debian archive, APT will automatically "
6199 "combine them to form a complete set of packages. If you have a CDROM then it "
6200 "is a good idea to specify it first and then specify a mirror so that you "
6201 "have access to the latest bug fixes. APT will automatically use packages on "
6202 "your CDROM before downloading from the Internet."
6205 #. type: <example></example>
6209 " Set up a list of distribution source locations\n"
6211 " Please give the base URL of the debian distribution.\n"
6212 " The access schemes I know about are: http file\n"
6215 " file:/mnt/debian,\n"
6216 " ftp://ftp.debian.org/debian,\n"
6217 " http://ftp.de.debian.org/debian,\n"
6220 " URL [http://llug.sep.bnl.gov/debian]:"
6226 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6227 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6231 #. type: <example></example>
6235 " Please give the distribution tag to get or a path to the\n"
6236 " package file ending in a /. The distribution\n"
6237 " tags are typically something like: stable unstable testing non-US\n"
6239 " Distribution [stable]:"
6245 "The distribution refers to the Debian version in the archive, "
6246 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6247 "refers to the developmental version. <em>non-US</em> is only available on "
6248 "some mirrors and refers to packages that contain encryption technology or "
6249 "other things that cannot be exported from the United States. Importing these "
6250 "packages into the US is legal however."
6253 #. type: <example></example>
6257 " Please give the components to get\n"
6258 " The components are typically something like: main contrib non-free\n"
6260 " Components [main contrib non-free]:"
6266 "The components list refers to the list of sub distributions to fetch. The "
6267 "distribution is split up based on software licenses, main being DFSG free "
6268 "packages while contrib and non-free contain things that have various "
6269 "restrictions placed on their use and distribution."
6275 "Any number of sources can be added, the setup script will continue to prompt "
6276 "until you have specified all that you want."
6282 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6283 "available list by selecting [U]pdate from the menu. This is a superset of "
6284 "<tt>apt-get update</tt> that makes the fetched information available to "
6285 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6286 "update</tt> has been run before."
6292 "You can then go on and make your selections using [S]elect and then perform "
6293 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6294 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6301 "By default APT will automatically remove the package (.deb) files once they "
6302 "have been successfully installed. To change this behavior place "
6303 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6306 #. type: <heading></heading>
6308 msgid "The Interface"
6314 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6315 "same interface. It is a simple system that generally tells you what it will "
6316 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6317 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6318 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6319 "alone.</p></footnote> After printing out a summary of what will happen APT "
6320 "then will print out some informative status messages so that you can "
6321 "estimate how far along it is and how much is left to do."
6324 #. type: <heading></heading>
6332 "Before all operations except update, APT performs a number of actions to "
6333 "prepare its internal state. It also does some checks of the system's "
6334 "state. At any time these operations can be performed by running <tt>apt-get "
6338 #. type: <example></example>
6343 "Reading Package Lists... Done\n"
6344 "Building Dependency Tree... Done"
6350 "The first thing it does is read all the package files into memory. APT uses "
6351 "a caching scheme so this operation will be faster the second time it is "
6352 "run. If some of the package files are not found then they will be ignored "
6353 "and a warning will be printed when apt-get exits."
6359 "The final operation performs a detailed analysis of the system's "
6360 "dependencies. It checks every dependency of every installed or unpacked "
6361 "package and considers if it is OK. Should this find a problem then a report "
6362 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6365 #. type: <example></example>
6370 "Reading Package Lists... Done\n"
6371 "Building Dependency Tree... Done\n"
6372 "You might want to run apt-get -f install' to correct these.\n"
6373 "Sorry, but the following packages have unmet dependencies:\n"
6374 " 9fonts: Depends: xlib6g but it is not installed\n"
6375 " uucp: Depends: mailx but it is not installed\n"
6376 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6377 " adduser: Depends: perl-base but it is not installed\n"
6378 " aumix: Depends: libgpmg1 but it is not installed\n"
6379 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6380 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6381 " cthugha: Depends: svgalibg1 but it is not installed\n"
6382 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6383 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6389 "In this example the system has many problems, including a serious problem "
6390 "with libreadlineg2. For each package that has unmet dependencies a line is "
6391 "printed out indicating the package with the problem and the dependencies "
6392 "that are unmet. A short explanation of why the package has a dependency "
6393 "problem is also included."
6399 "There are two ways a system can get into a broken state like this. The first "
6400 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6401 "packages when performing upgrades. <footnote><p>APT however considers all "
6402 "known dependencies and attempts to prevent broken "
6403 "packages</p></footnote>. The second is if a package installation fails "
6404 "during an operation. In this situation a package may have been unpacked "
6405 "without its dependents being installed."
6411 "The second situation is much less serious than the first because APT places "
6412 "certain constraints on the order that packages are installed. In both cases "
6413 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6414 "deduce a possible solution to the problem and then continue on. The APT "
6415 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6416 "for easy continuation of failed maintainer scripts."
6422 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6423 "system caused by the first case then it is possible that it will either fail "
6424 "immediately or the installation sequence will fail. In either case it is "
6425 "necessary to manually use dpkg (possibly with forcing options) to correct "
6426 "the situation enough to allow APT to proceed."
6429 #. type: <heading></heading>
6431 msgid "The Status Report"
6437 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6438 "happen. Generally the report reflects the type of operation being performed "
6439 "but there are several common elements. In all cases the lists reflect the "
6440 "final state of things, taking into account the <tt>-f</tt> option and any "
6441 "other relevant activities to the command being executed."
6444 #. type: <heading></heading>
6446 msgid "The Extra Package list"
6449 #. type: <example></example>
6453 "The following extra packages will be installed:\n"
6454 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6455 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6456 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6457 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6464 "The Extra Package list shows all of the packages that will be installed or "
6465 "upgraded in excess of the ones mentioned on the command line. It is only "
6466 "generated for an <tt>install</tt> command. The listed packages are often the "
6467 "result of an Auto Install."
6470 #. type: <heading></heading>
6472 msgid "The Packages to Remove"
6475 #. type: <example></example>
6479 "The following packages will be REMOVED:\n"
6480 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6481 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6482 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6489 "The Packages to Remove list shows all of the packages that will be removed "
6490 "from the system. It can be shown for any of the operations and should be "
6491 "given a careful inspection to ensure nothing important is to be taken "
6492 "off. The <tt>-f</tt> option is especially good at generating packages to "
6493 "remove so extreme care should be used in that case. The list may contain "
6494 "packages that are going to be removed because they are only partially "
6495 "installed, possibly due to an aborted installation."
6498 #. type: <heading></heading>
6500 msgid "The New Packages list"
6503 #. type: <example></example>
6507 "The following NEW packages will installed:\n"
6508 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6514 "The New Packages list is simply a reminder of what will happen. The packages "
6515 "listed are not presently installed in the system but will be when APT is "
6519 #. type: <heading></heading>
6521 msgid "The Kept Back list"
6524 #. type: <example></example>
6528 "The following packages have been kept back\n"
6529 " compface man-db tetex-base msql libpaper svgalib1\n"
6530 " gs snmp arena lynx xpat2 groff xscreensaver"
6536 "Whenever the whole system is being upgraded there is the possibility that "
6537 "new versions of packages cannot be installed because they require new things "
6538 "or conflict with already installed things. In this case the package will "
6539 "appear in the Kept Back list. The best way to convince packages listed there "
6540 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6541 "to resolve their problems."
6544 #. type: <heading></heading>
6546 msgid "Held Packages warning"
6549 #. type: <example></example>
6553 "The following held packages will be changed:\n"
6560 "Sometimes you can ask APT to install a package that is on hold, in such a "
6561 "case it prints out a warning that the held package is going to be "
6562 "changed. This should only happen during dist-upgrade or install."
6565 #. type: <heading></heading>
6567 msgid "Final summary"
6572 msgid "Finally, APT will print out a summary of all the changes that will occur."
6575 #. type: <example></example>
6579 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6581 "12 packages not fully installed or removed.\n"
6582 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6588 "The first line of the summary simply is a reduced version of all of the "
6589 "lists and includes the number of upgrades - that is packages already "
6590 "installed that have new versions available. The second line indicates the "
6591 "number of poorly configured packages, possibly the result of an aborted "
6592 "installation. The final line shows the space requirements that the "
6593 "installation needs. The first pair of numbers refer to the size of the "
6594 "archive files. The first number indicates the number of bytes that must be "
6595 "fetched from remote locations and the second indicates the total size of all "
6596 "the archives required. The next number indicates the size difference between "
6597 "the presently installed packages and the newly installed packages. It is "
6598 "roughly equivalent to the space required in /usr after everything is "
6599 "done. If a large number of packages are being removed then the value may "
6600 "indicate the amount of space that will be freed."
6606 "Some other reports can be generated by using the -u option to show packages "
6607 "to upgrade, they are similar to the previous examples."
6610 #. type: <heading></heading>
6612 msgid "The Status Display"
6618 "During the download of archives and package files APT prints out a series of "
6622 #. type: <example></example>
6626 "# apt-get update\n"
6627 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6628 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6629 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6630 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6632 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6633 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6639 "The lines starting with <em>Get</em> are printed out when APT begins to "
6640 "fetch a file while the last line indicates the progress of the download. The "
6641 "first percent value on the progress line indicates the total percent done of "
6642 "all files. Unfortunately since the size of the Package files is unknown "
6643 "<tt>apt-get update</tt> estimates the percent done which causes some "
6650 "The next section of the status line is repeated once for each download "
6651 "thread and indicates the operation being performed and some useful "
6652 "information about what is happening. Sometimes this section will simply read "
6653 "<em>Forking</em> which means the OS is loading the download module. The "
6654 "first word after the [ is the fetch number as shown on the history "
6655 "lines. The next word is the short form name of the object being "
6656 "downloaded. For archives it will contain the name of the package that is "
6663 "Inside of the single quote is an informative string indicating the progress "
6664 "of the negotiation phase of the download. Typically it progresses from "
6665 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6666 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6667 "the remote site. Once the download begins this is represented as "
6668 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6669 "kilobytes is expected. The total size is always shown in 4 figure notation "
6670 "to preserve space. After the size display is a percent meter for the file "
6671 "itself. The second last element is the instantaneous average speed. This "
6672 "values is updated every 5 seconds and reflects the rate of data transfer for "
6673 "that period. Finally is shown the estimated transfer time. This is updated "
6674 "regularly and reflects the time to complete everything at the shown transfer "
6681 "The status display updates every half second to provide a constant feedback "
6682 "on the download progress while the Get lines scroll back whenever a new file "
6683 "is started. Since the status display is constantly updated it is unsuitable "
6684 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6688 #. type: <heading></heading>
6696 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6697 "to the <prgn>dpkg</prgn> interface once downloading is "
6698 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6699 "processes the packages and the packages themselves may also ask several "
6700 "questions. Before each question there is usually a description of what it is "
6701 "asking and the questions are too varied to discuss completely here."
6704 #. type: <title></title>
6706 msgid "Using APT Offline"
6709 #. type: <version></version>
6711 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6714 #. type: <abstract></abstract>
6717 "This document describes how to use APT in a non-networked environment, "
6718 "specifically a 'sneaker-net' approach for performing upgrades."
6721 #. type: <copyrightsummary></copyrightsummary>
6723 msgid "Copyright © Jason Gunthorpe, 1999."
6726 #. type: <heading></heading>
6728 msgid "Introduction"
6731 #. type: <heading></heading>
6732 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6739 "Normally APT requires direct access to a Debian archive, either from a local "
6740 "media or through a network. Another common complaint is that a Debian "
6741 "machine is on a slow link, such as a modem and another machine has a very "
6742 "fast connection but they are physically distant."
6748 "The solution to this is to use large removable media such as a Zip disc or a "
6749 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6750 "archive but can easily fit a subset large enough for most users. The idea is "
6751 "to use APT to generate a list of packages that are required and then fetch "
6752 "them onto the disc using another machine with good connectivity. It is even "
6753 "possible to use another Debian machine with APT or to use a completely "
6754 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6755 "the machine downloading the packages, and <em>target host</em> the one with "
6756 "bad or no connection."
6762 "This is achieved by creatively manipulating the APT configuration file. The "
6763 "essential premise to tell APT to look on a disc for it's archive files. Note "
6764 "that the disc should be formated with a filesystem that can handle long file "
6765 "names such as ext2, fat32 or vfat."
6768 #. type: <heading></heading>
6770 msgid "Using APT on both machines"
6773 #. type: <p><example>
6776 "APT being available on both machines gives the simplest configuration. The "
6777 "basic idea is to place a copy of the status file on the disc and use the "
6778 "remote machine to fetch the latest package files and decide which packages "
6779 "to download. The disk directory structure should look like:"
6782 #. type: <example></example>
6796 #. type: <heading></heading>
6798 msgid "The configuration file"
6804 "The configuration file should tell APT to store its files on the disc and to "
6805 "use the configuration files on the disc as well. The sources.list should "
6806 "contain the proper sites that you wish to use from the remote machine, and "
6807 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6808 "<em>target host</em>. Please note, if you are using a local archive you must "
6809 "use copy URIs, the syntax is identical to file URIs."
6812 #. type: <p><example>
6815 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6819 #. type: <example></example>
6825 " /* This is not necessary if the two machines are the same arch, it "
6827 " the remote APT what architecture the target machine is */\n"
6828 " Architecture \"i386\";\n"
6830 " Get::Download-Only \"true\";\n"
6835 " /* Use the disc for state information and redirect the status file from\n"
6836 " the /var/lib/dpkg default */\n"
6837 " State \"/disc/\";\n"
6838 " State::status \"status\";\n"
6840 " // Binary caches will be stored locally\n"
6841 " Cache::archives \"/disc/archives/\";\n"
6842 " Cache \"/tmp/\";\n"
6844 " // Location of the source list.\n"
6845 " Etc \"/disc/\";\n"
6849 #. type: </example></p>
6852 "More details can be seen by examining the apt.conf man page and the sample "
6853 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6856 #. type: <p><example>
6859 "On the target machine the first thing to do is mount the disc and copy "
6860 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6861 "directories outlined in the Overview, <em>archives/partial/</em> and "
6862 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6863 "configure the sources.list. On the remote machine execute the following:"
6866 #. type: <example></example>
6870 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6871 " # apt-get update\n"
6872 " [ APT fetches the package files ]\n"
6873 " # apt-get dist-upgrade\n"
6874 " [ APT fetches all the packages needed to upgrade the target machine ]"
6877 #. type: </example></p>
6880 "The dist-upgrade command can be replaced with any other standard APT "
6881 "commands, particularly dselect-upgrade. You can even use an APT front end "
6882 "such as <em>dselect</em>. However this presents a problem in communicating "
6883 "your selections back to the local computer."
6886 #. type: <p><example>
6889 "Now the disc contains all of the index files and archives needed to upgrade "
6890 "the target machine. Take the disc back and run:"
6893 #. type: <example></example>
6897 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6898 " # apt-get check\n"
6899 " [ APT generates a local copy of the cache files ]\n"
6900 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6901 " [ Or any other APT command ]"
6907 "It is necessary for proper function to re-specify the status file to be the "
6908 "local one. This is very important!"
6914 "If you are using dselect you can do the very risky operation of copying "
6915 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6916 "remote machine are updated. I highly recommend that people only make "
6917 "selections on the local machine - but this may not always be possible. DO "
6918 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6921 #. type: <heading></heading>
6923 msgid "Using APT and wget"
6929 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6930 "any machine. Unlike the method above this requires that the Debian machine "
6931 "already has a list of available packages."
6937 "The basic idea is to create a disc that has only the archive files "
6938 "downloaded from the remote site. This is done by using the --print-uris "
6939 "option to apt-get and then preparing a wget script to actually fetch the "
6943 #. type: <heading></heading>
6948 #. type: <p><example>
6951 "Unlike the previous technique no special configuration files are "
6952 "required. We merely use the standard APT commands to generate the file list."
6955 #. type: <example></example>
6959 " # apt-get dist-upgrade \n"
6960 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6961 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6962 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6965 #. type: </example></p>
6968 "Any command other than dist-upgrade could be used here, including "
6975 "The /disc/wget-script file will now contain a list of wget commands to "
6976 "execute in order to fetch the necessary archives. This script should be run "
6977 "with the current directory as the disc's mount point so as to save the "
6978 "output on the disc."
6981 #. type: <p><example>
6983 msgid "The remote machine would do something like"
6986 #. type: <example></example>
6991 " # sh -x ./wget-script\n"
6995 #. type: </example><example>
6998 "Once the archives are downloaded and the disc returned to the Debian machine "
6999 "installation can proceed using,"
7002 #. type: <example></example>
7005 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
7008 #. type: </example></p>
7010 msgid "Which will use the already fetched archives on the disc."