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 06:11+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 #. The last update date
608 #. type: Content of: <refentry><refentryinfo>
609 #: apt-cache.8.xml:16 apt-cdrom.8.xml:16 apt-config.8.xml:16 apt-extracttemplates.1.xml:16 apt-ftparchive.1.xml:16 apt-get.8.xml:16 apt-key.8.xml:15 apt-secure.8.xml:15 apt-sortpkgs.1.xml:16 sources.list.5.xml:16
610 msgid "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product;"
613 #. type: Content of: <refentry><refmeta><manvolnum>
614 #: 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
618 #. type: Content of: <refentry><refmeta><refmiscinfo>
619 #: 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:33 apt_preferences.5.xml:26 sources.list.5.xml:27
623 #. type: Content of: <refentry><refnamediv><refpurpose>
624 #: apt-cache.8.xml:33
625 msgid "query the APT cache"
628 #. type: Content of: <refentry><refsect1><title>
629 #: 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:42 apt_preferences.5.xml:36 sources.list.5.xml:36
633 #. type: Content of: <refentry><refsect1><para>
634 #: apt-cache.8.xml:39
636 "<command>apt-cache</command> performs a variety of operations on APT's "
637 "package cache. <command>apt-cache</command> does not manipulate the state of "
638 "the system but does provide operations to search and generate interesting "
639 "output from the package metadata."
642 #. type: Content of: <refentry><refsect1><para>
643 #: apt-cache.8.xml:44 apt-get.8.xml:44
645 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
646 "one of the commands below must be present."
649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
650 #: apt-cache.8.xml:49
652 "<literal>gencaches</literal> creates APT's package cache. This is done "
653 "implicitly by all commands needing this cache if it is missing or outdated."
656 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
657 #: 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
658 msgid "&synopsis-pkg;"
661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
662 #: apt-cache.8.xml:54
664 "<literal>showpkg</literal> displays information about the packages listed on "
665 "the command line. Remaining arguments are package names. The available "
666 "versions and reverse dependencies of each package listed are listed, as well "
667 "as forward dependencies for each version. Forward (normal) dependencies are "
668 "those packages upon which the package in question depends; reverse "
669 "dependencies are those packages that depend upon the package in "
670 "question. Thus, forward dependencies must be satisfied for a package, but "
671 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
672 "libreadline2</command> would produce output similar to the following:"
675 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
676 #: apt-cache.8.xml:66
679 "Package: libreadline2\n"
680 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
681 "Reverse Depends: \n"
682 " libreadlineg2,libreadline2\n"
683 " libreadline2-altdev,libreadline2\n"
685 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
688 "Reverse Provides: \n"
691 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
692 #: apt-cache.8.xml:78
694 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
695 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
696 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
697 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
698 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
699 "installed. For the specific meaning of the remainder of the output it is "
700 "best to consult the apt source code."
703 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
704 #: apt-cache.8.xml:87
706 "<literal>stats</literal> displays some statistics about the cache. No "
707 "further arguments are expected. Statistics reported are:"
710 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
711 #: apt-cache.8.xml:90
713 "<literal>Total package names</literal> is the number of package names found "
717 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
718 #: apt-cache.8.xml:94
720 "<literal>Normal packages</literal> is the number of regular, ordinary "
721 "package names; these are packages that bear a one-to-one correspondence "
722 "between their names and the names used by other packages for them in "
723 "dependencies. The majority of packages fall into this category."
726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
727 #: apt-cache.8.xml:100
729 "<literal>Pure virtual packages</literal> is the number of packages that "
730 "exist only as a virtual package name; that is, packages only \"provide\" the "
731 "virtual package name, and no package actually uses the name. For instance, "
732 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
733 "package; several packages provide \"mail-transport-agent\", but there is no "
734 "package named \"mail-transport-agent\"."
737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
738 #: apt-cache.8.xml:108
740 "<literal>Single virtual packages</literal> is the number of packages with "
741 "only one package providing a particular virtual package. For example, in the "
742 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
743 "one package, xless, provides \"X11-text-viewer\"."
746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
747 #: apt-cache.8.xml:114
749 "<literal>Mixed virtual packages</literal> is the number of packages that "
750 "either provide a particular virtual package or have the virtual package name "
751 "as the package name. For instance, in the Debian GNU/Linux system, "
752 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
757 #: apt-cache.8.xml:121
759 "<literal>Missing</literal> is the number of package names that were "
760 "referenced in a dependency but were not provided by any package. Missing "
761 "packages may be an evidence if a full distribution is not accessed, or if a "
762 "package (real or virtual) has been dropped from the distribution. Usually "
763 "they are referenced from Conflicts or Breaks statements."
766 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
767 #: apt-cache.8.xml:128
769 "<literal>Total distinct</literal> versions is the number of package versions "
770 "found in the cache; this value is therefore at least equal to the number of "
771 "total package names. If more than one distribution (both \"stable\" and "
772 "\"unstable\", for instance), is being accessed, this value can be "
773 "considerably larger than the number of total package names."
776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
777 #: apt-cache.8.xml:135
779 "<literal>Total dependencies</literal> is the number of dependency "
780 "relationships claimed by all of the packages in the cache."
783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
784 #: apt-cache.8.xml:143
786 "<literal>showsrc</literal> displays all the source package records that "
787 "match the given package names. All versions are shown, as well as all "
788 "records that declare the name to be a Binary."
791 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
792 #: apt-cache.8.xml:149
794 "<literal>dump</literal> shows a short listing of every package in the "
795 "cache. It is primarily for debugging."
798 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
799 #: apt-cache.8.xml:154
801 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
802 "suitable for use with &dpkg; and is used by the &dselect; method."
805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
806 #: apt-cache.8.xml:159
808 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
812 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
813 #: apt-cache.8.xml:164
815 "<literal>show</literal> performs a function similar to <command>dpkg "
816 "--print-avail</command>; it displays the package records for the named "
820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
821 #: apt-cache.8.xml:169
822 msgid "&synopsis-regex;"
825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
826 #: apt-cache.8.xml:170
828 "<literal>search</literal> performs a full text search on all available "
829 "package lists for the POSIX regex pattern given, see "
830 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
831 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
832 "the descriptions for an occurrence of the regular expression and prints out "
833 "the package name and the short description, including virtual package "
834 "names. If <option>--full</option> is given then output identical to "
835 "<literal>show</literal> is produced for each matched package, and if "
836 "<option>--names-only</option> is given then the long description is not "
837 "searched, only the package name is."
840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
841 #: apt-cache.8.xml:183
843 "Separate arguments can be used to specify multiple search patterns that are "
847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
848 #: apt-cache.8.xml:188
850 "<literal>depends</literal> shows a listing of each dependency a package has "
851 "and all the possible other packages that can fulfill that dependency."
854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
855 #: apt-cache.8.xml:193
857 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
861 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
862 #: apt-cache.8.xml:197
863 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
867 #: apt-cache.8.xml:198
869 "This command prints the name of each package APT knows. The optional "
870 "argument is a prefix match to filter the name list. The output is suitable "
871 "for use in a shell tab complete function and the output is generated "
872 "extremely quickly. This command is best used with the "
873 "<option>--generate</option> option."
876 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
877 #: apt-cache.8.xml:203
879 "Note that a package which APT knows of is not necessarily available to "
880 "download, installable or installed, e.g. virtual packages are also listed in "
881 "the generated list."
884 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
885 #: apt-cache.8.xml:209
887 "<literal>dotty</literal> takes a list of packages on the command line and "
888 "generates output suitable for use by dotty from the <ulink "
889 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
890 "package. The result will be a set of nodes and edges representing the "
891 "relationships between the packages. By default the given packages will trace "
892 "out all dependent packages; this can produce a very large graph. To limit "
893 "the output to only the packages listed on the command line, set the "
894 "<literal>APT::Cache::GivenOnly</literal> option."
897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
898 #: apt-cache.8.xml:218
900 "The resulting nodes will have several shapes; normal packages are boxes, "
901 "pure provides are triangles, mixed provides are diamonds, missing packages "
902 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
903 "lines are pre-depends, green lines are conflicts."
906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
907 #: apt-cache.8.xml:223
908 msgid "Caution, dotty cannot graph larger sets of packages."
911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
912 #: apt-cache.8.xml:227
914 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
915 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
920 #: apt-cache.8.xml:231
921 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
924 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
925 #: apt-cache.8.xml:232
927 "<literal>policy</literal> is meant to help debug issues relating to the "
928 "preferences file. With no arguments it will print out the priorities of each "
929 "source. Otherwise it prints out detailed information about the priority "
930 "selection of the named package."
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
934 #: apt-cache.8.xml:239
936 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
937 "to mimic the output format and a subset of the functionality of the Debian "
938 "archive management tool, <literal>madison</literal>. It displays available "
939 "versions of a package in a tabular format. Unlike the original "
940 "<literal>madison</literal>, it can only display information for the "
941 "architecture for which APT has retrieved package lists "
942 "(<literal>APT::Architecture</literal>)."
945 #. type: Content of: <refentry><refsect1><title>
946 #: 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
950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
951 #: apt-cache.8.xml:255
953 "Select the file to store the package cache. The package cache is the primary "
954 "cache used by all operations. Configuration Item: "
955 "<literal>Dir::Cache::pkgcache</literal>."
958 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
959 #: apt-cache.8.xml:261
961 "Select the file to store the source cache. The source is used only by "
962 "<literal>gencaches</literal> and it stores a parsed version of the package "
963 "information from remote sources. When building the package cache the source "
964 "cache is used to avoid reparsing all of the package files. Configuration "
965 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
969 #: apt-cache.8.xml:269
971 "Quiet; produces output suitable for logging, omitting progress indicators. "
972 "More q's will produce more quietness up to a maximum of 2. You can also use "
973 "<option>-q=#</option> to set the quietness level, overriding the "
974 "configuration file. Configuration Item: <literal>quiet</literal>."
977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
978 #: apt-cache.8.xml:276
980 "Print only important dependencies; for use with unmet and depends. Causes "
981 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
982 "<literal>APT::Cache::Important</literal>."
985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
986 #: apt-cache.8.xml:289
988 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
989 "print all dependencies. This can be tweaked with these flags which will omit "
990 "the specified dependency type. Configuration Item: "
991 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
992 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
996 #: apt-cache.8.xml:296
998 "Print full package records when searching. Configuration Item: "
999 "<literal>APT::Cache::ShowFull</literal>."
1002 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1003 #: apt-cache.8.xml:301
1005 "Print full records for all available versions. This is the default; to turn "
1006 "it off, use <option>--no-all-versions</option>. If "
1007 "<option>--no-all-versions</option> is specified, only the candidate version "
1008 "will displayed (the one which would be selected for installation). This "
1009 "option is only applicable to the <literal>show</literal> command. "
1010 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1014 #: apt-cache.8.xml:310
1016 "Perform automatic package cache regeneration, rather than use the cache as "
1017 "it is. This is the default; to turn it off, use "
1018 "<option>--no-generate</option>. Configuration Item: "
1019 "<literal>APT::Cache::Generate</literal>."
1022 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1023 #: apt-cache.8.xml:316
1025 "Only search on the package names, not the long descriptions. Configuration "
1026 "Item: <literal>APT::Cache::NamesOnly</literal>."
1029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1030 #: apt-cache.8.xml:321
1032 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1033 "and missing dependencies. Configuration Item: "
1034 "<literal>APT::Cache::AllNames</literal>."
1037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1038 #: apt-cache.8.xml:327
1040 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1041 "that all packages mentioned are printed once. Configuration Item: "
1042 "<literal>APT::Cache::RecurseDepends</literal>."
1045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1046 #: apt-cache.8.xml:334
1048 "Limit the output of <literal>depends</literal> and "
1049 "<literal>rdepends</literal> to packages which are currently installed. "
1050 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1053 #. type: Content of: <refentry><refsect1><variablelist>
1054 #: 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
1055 msgid "&apt-commonoptions;"
1058 #. type: Content of: <refentry><refsect1><title>
1059 #: apt-cache.8.xml:344 apt-get.8.xml:519 apt-key.8.xml:174 apt-mark.8.xml:126 apt.conf.5.xml:1119 apt_preferences.5.xml:698
1063 #. type: Content of: <refentry><refsect1><variablelist>
1064 #: apt-cache.8.xml:346
1065 msgid "&file-sourceslist; &file-statelists;"
1068 #. type: Content of: <refentry><refsect1><title>
1069 #: 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:1125 apt_preferences.5.xml:705 sources.list.5.xml:255
1073 #. type: Content of: <refentry><refsect1><para>
1074 #: apt-cache.8.xml:352
1075 msgid "&apt-conf;, &sources-list;, &apt-get;"
1078 #. type: Content of: <refentry><refsect1><title>
1079 #: 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
1083 #. type: Content of: <refentry><refsect1><para>
1084 #: apt-cache.8.xml:357
1086 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1090 #. type: Content of: <refentry><refnamediv><refpurpose>
1091 #: apt-cdrom.8.xml:32
1092 msgid "APT CDROM management utility"
1095 #. type: Content of: <refentry><refsect1><para>
1096 #: apt-cdrom.8.xml:38
1098 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1099 "available sources. <command>apt-cdrom</command> takes care of determining "
1100 "the structure of the disc as well as correcting for several possible "
1101 "mis-burns and verifying the index files."
1104 #. type: Content of: <refentry><refsect1><para>
1105 #: apt-cdrom.8.xml:45
1107 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1108 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1109 "must be inserted and scanned separately to account for possible mis-burns."
1112 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1113 #: apt-cdrom.8.xml:56
1115 "<literal>add</literal> is used to add a new disc to the source list. It will "
1116 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1117 "to scan it and copy the index files. If the disc does not have a proper "
1118 "<filename>disk</filename> directory you will be prompted for a descriptive "
1122 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1123 #: apt-cdrom.8.xml:64
1125 "APT uses a CDROM ID to track which disc is currently in the drive and "
1126 "maintains a database of these IDs in "
1127 "<filename>&statedir;/cdroms.list</filename>"
1130 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1131 #: apt-cdrom.8.xml:72
1133 "A debugging tool to report the identity of the current disc as well as the "
1137 #. type: Content of: <refentry><refsect1><para>
1138 #: apt-cdrom.8.xml:51
1140 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1141 "one of the commands below must be present. <placeholder "
1142 "type=\"variablelist\" id=\"0\"/>"
1145 #. type: Content of: <refentry><refsect1><title>
1146 #: apt-cdrom.8.xml:81 apt-key.8.xml:160
1150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1151 #: apt-cdrom.8.xml:86
1153 "Mount point; specify the location to mount the cdrom. This mount point must "
1154 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1155 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1159 #: apt-cdrom.8.xml:95
1161 "Rename a disc; change the label of a disk or override the disks given "
1162 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1163 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1166 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1167 #: apt-cdrom.8.xml:104
1169 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1170 "unmounting the mount point. Configuration Item: "
1171 "<literal>APT::CDROM::NoMount</literal>."
1174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1175 #: apt-cdrom.8.xml:112
1177 "Fast Copy; Assume the package files are valid and do not check every "
1178 "package. This option should be used only if <command>apt-cdrom</command> has "
1179 "been run on this disc before and did not detect any errors. Configuration "
1180 "Item: <literal>APT::CDROM::Fast</literal>."
1183 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1184 #: apt-cdrom.8.xml:122
1186 "Thorough Package Scan; This option may be needed with some old Debian "
1187 "1.1/1.2 discs that have Package files in strange places. It takes much "
1188 "longer to scan the CD but will pick them all up."
1191 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1192 #: apt-cdrom.8.xml:133
1194 "No Changes; Do not change the &sources-list; file and do not write index "
1195 "files. Everything is still checked however. Configuration Item: "
1196 "<literal>APT::CDROM::NoAct</literal>."
1199 #. type: Content of: <refentry><refsect1><para>
1200 #: apt-cdrom.8.xml:146
1201 msgid "&apt-conf;, &apt-get;, &sources-list;"
1204 #. type: Content of: <refentry><refsect1><para>
1205 #: apt-cdrom.8.xml:151
1207 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1211 #. type: Content of: <refentry><refnamediv><refpurpose>
1212 #: apt-config.8.xml:33
1213 msgid "APT Configuration Query program"
1216 #. type: Content of: <refentry><refsect1><para>
1217 #: apt-config.8.xml:39
1219 "<command>apt-config</command> is an internal program used by various "
1220 "portions of the APT suite to provide consistent configurability. It accesses "
1221 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1222 "manner that is easy to use by scripted applications."
1225 #. type: Content of: <refentry><refsect1><para>
1226 #: apt-config.8.xml:44 apt-ftparchive.1.xml:54
1228 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1229 "one of the commands below must be present."
1232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1233 #: apt-config.8.xml:51
1235 "shell is used to access the configuration information from a shell "
1236 "script. It is given pairs of arguments, the first being a shell variable and "
1237 "the second the configuration value to query. As output it lists a series of "
1238 "shell assignments commands for each present value. In a shell script it "
1239 "should be used like:"
1242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1243 #: apt-config.8.xml:59
1247 "RES=`apt-config shell OPTS MyApp::options`\n"
1251 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1252 #: apt-config.8.xml:64
1254 "This will set the shell environment variable $OPTS to the value of "
1255 "MyApp::options with a default of <option>-f</option>."
1258 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1259 #: apt-config.8.xml:68
1261 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1262 "names, d returns directories, b returns true or false and i returns an "
1263 "integer. Each of the returns is normalized and verified internally."
1266 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1267 #: apt-config.8.xml:77
1268 msgid "Just show the contents of the configuration space."
1271 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1272 #: apt-config.8.xml:90
1274 "Include options which have an empty value. This is the default, so use "
1275 "--no-empty to remove them from the output."
1278 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1279 #: apt-config.8.xml:95
1280 msgid "%f "%v";%n"
1283 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1284 #: apt-config.8.xml:96
1286 "Defines the output of each config option. %t will be replaced with "
1287 "the name of the option, %f with the complete optionname and %v "
1288 "with the value of the option. Use uppercase letters and special characters "
1289 "in the value will be encoded to ensure that it can e.g. be savely used in a "
1290 "quoted-string as defined by RFC822. Additionally %n will be replaced "
1291 "by a newline, %N by a tab. A % can be printed by using "
1295 #. type: Content of: <refentry><refsect1><para>
1296 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1300 #. type: Content of: <refentry><refsect1><para>
1301 #: apt-config.8.xml:115
1303 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1307 #. type: Content of: <refentry><refmeta><manvolnum>
1308 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1312 #. type: Content of: <refentry><refnamediv><refpurpose>
1313 #: apt-extracttemplates.1.xml:33
1314 msgid "Utility to extract DebConf config and templates from Debian packages"
1317 #. type: Content of: <refentry><refsect1><para>
1318 #: apt-extracttemplates.1.xml:39
1320 "<command>apt-extracttemplates</command> will take one or more Debian package "
1321 "files as input and write out (to a temporary directory) all associated "
1322 "config scripts and template files. For each passed in package that contains "
1323 "config scripts and templates, one line of output will be generated in the "
1327 #. type: Content of: <refentry><refsect1><para>
1328 #: apt-extracttemplates.1.xml:44
1329 msgid "package version template-file config-script"
1332 #. type: Content of: <refentry><refsect1><para>
1333 #: apt-extracttemplates.1.xml:45
1335 "template-file and config-script are written to the temporary directory "
1336 "specified by the <option>-t</option> or <option>--tempdir</option> "
1337 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1338 "filenames of the form <filename>package.template.XXXX</filename> and "
1339 "<filename>package.config.XXXX</filename>"
1342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1343 #: apt-extracttemplates.1.xml:58
1345 "Temporary directory in which to write extracted debconf template files and "
1346 "config scripts. Configuration Item: "
1347 "<literal>APT::ExtractTemplates::TempDir</literal>"
1350 #. type: Content of: <refentry><refsect1><para>
1351 #: apt-extracttemplates.1.xml:75
1353 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1354 "decimal 100 on error."
1357 #. type: Content of: <refentry><refnamediv><refpurpose>
1358 #: apt-ftparchive.1.xml:33
1359 msgid "Utility to generate index files"
1362 #. type: Content of: <refentry><refsect1><para>
1363 #: apt-ftparchive.1.xml:39
1365 "<command>apt-ftparchive</command> is the command line tool that generates "
1366 "the index files that APT uses to access a distribution source. The index "
1367 "files should be generated on the origin site based on the content of that "
1371 #. type: Content of: <refentry><refsect1><para>
1372 #: apt-ftparchive.1.xml:43
1374 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1375 "program, incorporating its entire functionality via the "
1376 "<literal>packages</literal> command. It also contains a contents file "
1377 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1378 "the generation process for a complete archive."
1381 #. type: Content of: <refentry><refsect1><para>
1382 #: apt-ftparchive.1.xml:49
1384 "Internally <command>apt-ftparchive</command> can make use of binary "
1385 "databases to cache the contents of a .deb file and it does not rely on any "
1386 "external programs aside from &gzip;. When doing a full generate it "
1387 "automatically performs file-change checks and builds the desired compressed "
1391 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1392 #: apt-ftparchive.1.xml:60
1394 "The packages command generates a package file from a directory tree. It "
1395 "takes the given directory and recursively searches it for .deb files, "
1396 "emitting a package record to stdout for each. This command is approximately "
1397 "equivalent to &dpkg-scanpackages;."
1400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1401 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1402 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1406 #: apt-ftparchive.1.xml:70
1408 "The <literal>sources</literal> command generates a source index file from a "
1409 "directory tree. It takes the given directory and recursively searches it "
1410 "for .dsc files, emitting a source record to stdout for each. This command is "
1411 "approximately equivalent to &dpkg-scansources;."
1414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1415 #: apt-ftparchive.1.xml:75
1417 "If an override file is specified then a source override file will be looked "
1418 "for with an extension of .src. The --source-override option can be used to "
1419 "change the source override file that will be used."
1422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1423 #: apt-ftparchive.1.xml:82
1425 "The <literal>contents</literal> command generates a contents file from a "
1426 "directory tree. It takes the given directory and recursively searches it for "
1427 ".deb files, and reads the file list from each file. It then sorts and writes "
1428 "to stdout the list of files matched to packages. Directories are not written "
1429 "to the output. If multiple packages own the same file then each package is "
1430 "separated by a comma in the output."
1433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1434 #: apt-ftparchive.1.xml:94
1436 "The <literal>release</literal> command generates a Release file from a "
1437 "directory tree. It recursively searches the given directory for uncompressed "
1438 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1439 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1440 "<command>lzma</command> as well as <filename>Release</filename> and "
1441 "<filename>md5sum.txt</filename> files by default "
1442 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1443 "filename patterns can be added by listing them in "
1444 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1445 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1449 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1450 #: apt-ftparchive.1.xml:104
1452 "Values for the additional metadata fields in the Release file are taken from "
1453 "the corresponding variables under "
1454 "<literal>APT::FTPArchive::Release</literal>, "
1455 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1456 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1457 "<literal>Suite</literal>, <literal>Version</literal>, "
1458 "<literal>Codename</literal>, <literal>Date</literal>, "
1459 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1460 "<literal>Components</literal>, <literal>Description</literal>."
1463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1464 #: apt-ftparchive.1.xml:117
1466 "The <literal>generate</literal> command is designed to be runnable from a "
1467 "cron script and builds indexes according to the given config file. The "
1468 "config language provides a flexible means of specifying which index files "
1469 "are built from which directories, as well as providing a simple means of "
1470 "maintaining the required settings."
1473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1474 #: apt-ftparchive.1.xml:126
1476 "The <literal>clean</literal> command tidies the databases used by the given "
1477 "configuration file by removing any records that are no longer necessary."
1480 #. type: Content of: <refentry><refsect1><title>
1481 #: apt-ftparchive.1.xml:132
1482 msgid "The Generate Configuration"
1485 #. type: Content of: <refentry><refsect1><para>
1486 #: apt-ftparchive.1.xml:134
1488 "The <literal>generate</literal> command uses a configuration file to "
1489 "describe the archives that are going to be generated. It follows the typical "
1490 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1491 "&apt-conf; contains a description of the syntax. Note that the generate "
1492 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1493 "tree manner. This only effects how the scope tag is handled."
1496 #. type: Content of: <refentry><refsect1><para>
1497 #: apt-ftparchive.1.xml:142
1498 msgid "The generate configuration has 4 separate sections, each described below."
1501 #. type: Content of: <refentry><refsect1><refsect2><title>
1502 #: apt-ftparchive.1.xml:144
1506 #. type: Content of: <refentry><refsect1><refsect2><para>
1507 #: apt-ftparchive.1.xml:146
1509 "The <literal>Dir</literal> section defines the standard directories needed "
1510 "to locate the files required during the generation process. These "
1511 "directories are prepended certain relative paths defined in later sections "
1512 "to produce a complete an absolute path."
1515 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1516 #: apt-ftparchive.1.xml:153
1518 "Specifies the root of the FTP archive, in a standard Debian configuration "
1519 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1523 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1524 #: apt-ftparchive.1.xml:160
1525 msgid "Specifies the location of the override files."
1528 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1529 #: apt-ftparchive.1.xml:165
1530 msgid "Specifies the location of the cache files"
1533 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1534 #: apt-ftparchive.1.xml:170
1536 "Specifies the location of the file list files, if the "
1537 "<literal>FileList</literal> setting is used below."
1540 #. type: Content of: <refentry><refsect1><refsect2><title>
1541 #: apt-ftparchive.1.xml:176
1542 msgid "Default Section"
1545 #. type: Content of: <refentry><refsect1><refsect2><para>
1546 #: apt-ftparchive.1.xml:178
1548 "The <literal>Default</literal> section specifies default values, and "
1549 "settings that control the operation of the generator. Other sections may "
1550 "override these defaults with a per-section setting."
1553 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1554 #: apt-ftparchive.1.xml:184
1556 "Sets the default compression schemes to use for the Package index files. It "
1557 "is a string that contains a space separated list of at least one of: '.' (no "
1558 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1562 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1563 #: apt-ftparchive.1.xml:192
1565 "Sets the default list of file extensions that are package files. This "
1566 "defaults to '.deb'."
1569 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1570 #: apt-ftparchive.1.xml:198
1572 "This is similar to <literal>Packages::Compress</literal> except that it "
1573 "controls the compression for the Sources files."
1576 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1577 #: apt-ftparchive.1.xml:204
1579 "Sets the default list of file extensions that are source files. This "
1580 "defaults to '.dsc'."
1583 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1584 #: apt-ftparchive.1.xml:210
1586 "This is similar to <literal>Packages::Compress</literal> except that it "
1587 "controls the compression for the Contents files."
1590 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1591 #: apt-ftparchive.1.xml:216
1593 "This is similar to <literal>Packages::Compress</literal> except that it "
1594 "controls the compression for the Translation-en master file."
1597 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1598 #: apt-ftparchive.1.xml:222
1600 "Specifies the number of kilobytes to delink (and replace with hard links) "
1601 "per run. This is used in conjunction with the per-section "
1602 "<literal>External-Links</literal> setting."
1605 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1606 #: apt-ftparchive.1.xml:229
1608 "Specifies the mode of all created index files. It defaults to 0644. All "
1609 "index files are set to this mode with no regard to the umask."
1612 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1613 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
1615 "Sets if long descriptions should be included in the Packages file or split "
1616 "out into a master Translation-en file."
1619 #. type: Content of: <refentry><refsect1><refsect2><title>
1620 #: apt-ftparchive.1.xml:242
1621 msgid "TreeDefault Section"
1624 #. type: Content of: <refentry><refsect1><refsect2><para>
1625 #: apt-ftparchive.1.xml:244
1627 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
1628 "variables are substitution variables and have the strings $(DIST), "
1629 "$(SECTION) and $(ARCH) replaced with their respective values."
1632 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1633 #: apt-ftparchive.1.xml:251
1635 "Sets the number of kilobytes of contents files that are generated each "
1636 "day. The contents files are round-robined so that over several days they "
1637 "will all be rebuilt."
1640 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1641 #: apt-ftparchive.1.xml:258
1643 "Controls the number of days a contents file is allowed to be checked without "
1644 "changing. If this limit is passed the mtime of the contents file is "
1645 "updated. This case can occur if the package file is changed in such a way "
1646 "that does not result in a new contents file [override edit for instance]. A "
1647 "hold off is allowed in hopes that new .debs will be installed, requiring a "
1648 "new file anyhow. The default is 10, the units are in days."
1651 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1652 #: apt-ftparchive.1.xml:269
1654 "Sets the top of the .deb directory tree. Defaults to "
1655 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
1658 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1659 #: apt-ftparchive.1.xml:275
1661 "Sets the top of the source package directory tree. Defaults to "
1662 "<filename>$(DIST)/$(SECTION)/source/</filename>"
1665 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1666 #: apt-ftparchive.1.xml:281
1668 "Sets the output Packages file. Defaults to "
1669 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
1672 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1673 #: apt-ftparchive.1.xml:287
1675 "Sets the output Sources file. Defaults to "
1676 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
1679 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1680 #: apt-ftparchive.1.xml:293
1682 "Set the output Translation-en master file with the long descriptions if they "
1683 "should be not included in the Packages file. Defaults to "
1684 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
1687 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1688 #: apt-ftparchive.1.xml:300
1690 "Sets the path prefix that causes a symlink to be considered an internal link "
1691 "instead of an external link. Defaults to "
1692 "<filename>$(DIST)/$(SECTION)/</filename>"
1695 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1696 #: apt-ftparchive.1.xml:307
1698 "Sets the output Contents file. Defaults to "
1699 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
1700 "multiple Packages files to map onto a single Contents file (such as the "
1701 "default) then <command>apt-ftparchive</command> will integrate those "
1702 "package files together automatically."
1705 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1706 #: apt-ftparchive.1.xml:316
1707 msgid "Sets header file to prepend to the contents output."
1710 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1711 #: apt-ftparchive.1.xml:321
1713 "Sets the binary cache database to use for this section. Multiple sections "
1714 "can share the same database."
1717 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1718 #: apt-ftparchive.1.xml:327
1720 "Specifies that instead of walking the directory tree, "
1721 "<command>apt-ftparchive</command> should read the list of files from the "
1722 "given file. Relative files names are prefixed with the archive directory."
1725 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1726 #: apt-ftparchive.1.xml:334
1728 "Specifies that instead of walking the directory tree, "
1729 "<command>apt-ftparchive</command> should read the list of files from the "
1730 "given file. Relative files names are prefixed with the archive directory. "
1731 "This is used when processing source indexes."
1734 #. type: Content of: <refentry><refsect1><refsect2><title>
1735 #: apt-ftparchive.1.xml:342
1736 msgid "Tree Section"
1739 #. type: Content of: <refentry><refsect1><refsect2><para>
1740 #: apt-ftparchive.1.xml:344
1742 "The <literal>Tree</literal> section defines a standard Debian file tree "
1743 "which consists of a base directory, then multiple sections in that base "
1744 "directory and finally multiple Architectures in each section. The exact "
1745 "pathing used is defined by the <literal>Directory</literal> substitution "
1749 #. type: Content of: <refentry><refsect1><refsect2><para>
1750 #: apt-ftparchive.1.xml:349
1752 "The <literal>Tree</literal> section takes a scope tag which sets the "
1753 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
1754 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
1755 "setting such as <filename>dists/&stable-codename;</filename>."
1758 #. type: Content of: <refentry><refsect1><refsect2><para>
1759 #: apt-ftparchive.1.xml:354
1761 "All of the settings defined in the <literal>TreeDefault</literal> section "
1762 "can be use in a <literal>Tree</literal> section as well as three new "
1766 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
1767 #: apt-ftparchive.1.xml:360
1770 "for i in Sections do \n"
1771 " for j in Architectures do\n"
1772 " Generate for DIST=scope SECTION=i ARCH=j\n"
1776 #. type: Content of: <refentry><refsect1><refsect2><para>
1777 #: apt-ftparchive.1.xml:357
1779 "When processing a <literal>Tree</literal> section "
1780 "<command>apt-ftparchive</command> performs an operation similar to: "
1781 "<placeholder type=\"programlisting\" id=\"0\"/>"
1784 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1785 #: apt-ftparchive.1.xml:368
1787 "This is a space separated list of sections which appear under the "
1788 "distribution, typically this is something like <literal>main contrib "
1789 "non-free</literal>"
1792 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1793 #: apt-ftparchive.1.xml:375
1795 "This is a space separated list of all the architectures that appear under "
1796 "search section. The special architecture 'source' is used to indicate that "
1797 "this tree has a source archive."
1800 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1801 #: apt-ftparchive.1.xml:388
1803 "Sets the binary override file. The override file contains section, priority "
1804 "and maintainer address information."
1807 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1808 #: apt-ftparchive.1.xml:394
1810 "Sets the source override file. The override file contains section "
1814 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1815 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
1816 msgid "Sets the binary extra override file."
1819 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1820 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
1821 msgid "Sets the source extra override file."
1824 #. type: Content of: <refentry><refsect1><refsect2><title>
1825 #: apt-ftparchive.1.xml:410
1826 msgid "BinDirectory Section"
1829 #. type: Content of: <refentry><refsect1><refsect2><para>
1830 #: apt-ftparchive.1.xml:412
1832 "The <literal>bindirectory</literal> section defines a binary directory tree "
1833 "with no special structure. The scope tag specifies the location of the "
1834 "binary directory and the settings are similar to the <literal>Tree</literal> "
1835 "section with no substitution variables or "
1836 "<literal>Section</literal><literal>Architecture</literal> settings."
1839 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1840 #: apt-ftparchive.1.xml:420
1841 msgid "Sets the Packages file output."
1844 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1845 #: apt-ftparchive.1.xml:425
1847 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
1848 "<literal>Sources</literal> is required."
1851 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1852 #: apt-ftparchive.1.xml:431
1853 msgid "Sets the Contents file output. (optional)"
1856 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1857 #: apt-ftparchive.1.xml:436
1858 msgid "Sets the binary override file."
1861 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1862 #: apt-ftparchive.1.xml:441
1863 msgid "Sets the source override file."
1866 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1867 #: apt-ftparchive.1.xml:456
1868 msgid "Sets the cache DB."
1871 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1872 #: apt-ftparchive.1.xml:461
1873 msgid "Appends a path to all the output paths."
1876 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1877 #: apt-ftparchive.1.xml:466
1878 msgid "Specifies the file list file."
1881 #. type: Content of: <refentry><refsect1><title>
1882 #: apt-ftparchive.1.xml:473
1883 msgid "The Binary Override File"
1886 #. type: Content of: <refentry><refsect1><para>
1887 #: apt-ftparchive.1.xml:474
1889 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
1890 "contains 4 fields separated by spaces. The first field is the package name, "
1891 "the second is the priority to force that package to, the third is the the "
1892 "section to force that package to and the final field is the maintainer "
1893 "permutation field."
1896 #. type: Content of: <refentry><refsect1><para><literallayout>
1897 #: apt-ftparchive.1.xml:480
1899 msgid "old [// oldn]* => new"
1902 #. type: Content of: <refentry><refsect1><para><literallayout>
1903 #: apt-ftparchive.1.xml:482
1908 #. type: Content of: <refentry><refsect1><para>
1909 #: apt-ftparchive.1.xml:479
1911 "The general form of the maintainer field is: <placeholder "
1912 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
1913 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
1914 "separated list of old email addresses to be specified. If any of those are "
1915 "found then new is substituted for the maintainer field. The second form "
1916 "unconditionally substitutes the maintainer field."
1919 #. type: Content of: <refentry><refsect1><title>
1920 #: apt-ftparchive.1.xml:490
1921 msgid "The Source Override File"
1924 #. type: Content of: <refentry><refsect1><para>
1925 #: apt-ftparchive.1.xml:492
1927 "The source override file is fully compatible with &dpkg-scansources;. It "
1928 "contains 2 fields separated by spaces. The first fields is the source "
1929 "package name, the second is the section to assign it."
1932 #. type: Content of: <refentry><refsect1><title>
1933 #: apt-ftparchive.1.xml:497
1934 msgid "The Extra Override File"
1937 #. type: Content of: <refentry><refsect1><para>
1938 #: apt-ftparchive.1.xml:499
1940 "The extra override file allows any arbitrary tag to be added or replaced in "
1941 "the output. It has 3 columns, the first is the package, the second is the "
1942 "tag and the remainder of the line is the new value."
1945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1946 #: apt-ftparchive.1.xml:510
1948 "Generate the given checksum. These options default to on, when turned off "
1949 "the generated index files will not have the checksum fields where possible. "
1950 "Configuration Items: "
1951 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
1952 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
1953 "where <literal><replaceable>Index</replaceable></literal> can be "
1954 "<literal>Packages</literal>, <literal>Sources</literal> or "
1955 "<literal>Release</literal> and "
1956 "<literal><replaceable>Checksum</replaceable></literal> can be "
1957 "<literal>MD5</literal>, <literal>SHA1</literal> or "
1958 "<literal>SHA256</literal>."
1961 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1962 #: apt-ftparchive.1.xml:521
1964 "Use a binary caching DB. This has no effect on the generate command. "
1965 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
1968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1969 #: apt-ftparchive.1.xml:527
1971 "Quiet; produces output suitable for logging, omitting progress indicators. "
1972 "More q's will produce more quiet up to a maximum of 2. You can also use "
1973 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1974 "file. Configuration Item: <literal>quiet</literal>."
1977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1978 #: apt-ftparchive.1.xml:535
1980 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
1981 "then this option actually enables delinking of the files. It defaults to on "
1982 "and can be turned off with <option>--no-delink</option>. Configuration "
1983 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
1986 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1987 #: apt-ftparchive.1.xml:543
1989 "Perform contents generation. When this option is set and package indexes are "
1990 "being generated with a cache DB then the file listing will also be extracted "
1991 "and stored in the DB for later use. When using the generate command this "
1992 "option also allows the creation of any Contents files. The default is on. "
1993 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
1996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1997 #: apt-ftparchive.1.xml:553
1999 "Select the source override file to use with the <literal>sources</literal> "
2000 "command. Configuration Item: "
2001 "<literal>APT::FTPArchive::SourceOverride</literal>."
2004 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2005 #: apt-ftparchive.1.xml:559
2007 "Make the caching databases read only. Configuration Item: "
2008 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2012 #: apt-ftparchive.1.xml:564
2014 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2015 "commands only package files matching <literal>*_arch.deb</literal> or "
2016 "<literal>*_all.deb</literal> instead of all package files in the given "
2017 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2020 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2021 #: apt-ftparchive.1.xml:572
2023 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2024 "packages are recompiled and/or republished with the same version again, this "
2025 "will lead to problems as the now outdated cached metadata like size and "
2026 "checksums will be used. With this option enabled this will no longer happen "
2027 "as it will be checked if the file was changed. Note that this option is set "
2028 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2029 "multiply versions/builds of a package with the same versionnumber, so in "
2030 "theory nobody will have these problems and therefore all these extra checks "
2034 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2035 #: apt-ftparchive.1.xml:584
2037 "This configuration option defaults to \"<literal>true</literal>\" and should "
2038 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2039 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2040 "that the <filename>Translation-en</filename> master file can only be created "
2041 "in the generate command."
2044 #. type: Content of: <refentry><refsect1><title>
2045 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1113 apt_preferences.5.xml:545 sources.list.5.xml:214
2049 #. type: Content of: <refentry><refsect1><para><programlisting>
2050 #: apt-ftparchive.1.xml:602
2053 "<command>apt-ftparchive</command> packages "
2054 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2055 "<filename>Packages.gz</filename>\n"
2058 #. type: Content of: <refentry><refsect1><para>
2059 #: apt-ftparchive.1.xml:598
2061 "To create a compressed Packages file for a directory containing binary "
2062 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2065 #. type: Content of: <refentry><refsect1><para>
2066 #: apt-ftparchive.1.xml:612
2068 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2072 #. type: Content of: <refentry><refnamediv><refpurpose>
2074 msgid "APT package handling utility -- command-line interface"
2077 #. type: Content of: <refentry><refsect1><para>
2080 "<command>apt-get</command> is the command-line tool for handling packages, "
2081 "and may be considered the user's \"back-end\" to other tools using the APT "
2082 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2083 "&aptitude;, &synaptic; and &wajig;."
2086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2089 "<literal>update</literal> is used to resynchronize the package index files "
2090 "from their sources. The indexes of available packages are fetched from the "
2091 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2092 "example, when using a Debian archive, this command retrieves and scans the "
2093 "<filename>Packages.gz</filename> files, so that information about new and "
2094 "updated packages is available. An <literal>update</literal> should always be "
2095 "performed before an <literal>upgrade</literal> or "
2096 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2097 "meter will be incorrect as the size of the package files cannot be known in "
2101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2104 "<literal>upgrade</literal> is used to install the newest versions of all "
2105 "packages currently installed on the system from the sources enumerated in "
2106 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2107 "with new versions available are retrieved and upgraded; under no "
2108 "circumstances are currently installed packages removed, or packages not "
2109 "already installed retrieved and installed. New versions of currently "
2110 "installed packages that cannot be upgraded without changing the install "
2111 "status of another package will be left at their current version. An "
2112 "<literal>update</literal> must be performed first so that "
2113 "<command>apt-get</command> knows that new versions of packages are "
2117 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2120 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2121 "traditional Debian packaging front-end, "
2122 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2123 "&dselect; to the <literal>Status</literal> field of available packages, and "
2124 "performs the actions necessary to realize that state (for instance, the "
2125 "removal of old and the installation of new packages)."
2128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2131 "<literal>dist-upgrade</literal> in addition to performing the function of "
2132 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2133 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2134 "conflict resolution system, and it will attempt to upgrade the most "
2135 "important packages at the expense of less important ones if necessary. So, "
2136 "<literal>dist-upgrade</literal> command may remove some packages. The "
2137 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2138 "from which to retrieve desired package files. See also &apt-preferences; "
2139 "for a mechanism for overriding the general settings for individual packages."
2142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2145 "<literal>install</literal> is followed by one or more packages desired for "
2146 "installation or upgrading. Each package is a package name, not a fully "
2147 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2148 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2149 "packages required by the package(s) specified for installation will also be "
2150 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2151 "file is used to locate the desired packages. If a hyphen is appended to the "
2152 "package name (with no intervening space), the identified package will be "
2153 "removed if it is installed. Similarly a plus sign can be used to designate "
2154 "a package to install. These latter features may be used to override "
2155 "decisions made by apt-get's conflict resolution system."
2158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2159 #: apt-get.8.xml:116
2161 "A specific version of a package can be selected for installation by "
2162 "following the package name with an equals and the version of the package to "
2163 "select. This will cause that version to be located and selected for "
2164 "install. Alternatively a specific distribution can be selected by following "
2165 "the package name with a slash and the version of the distribution or the "
2166 "Archive name (stable, testing, unstable)."
2169 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2170 #: apt-get.8.xml:123
2172 "Both of the version selection mechanisms can downgrade packages and must be "
2176 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2177 #: apt-get.8.xml:126
2179 "This is also the target to use if you want to upgrade one or more "
2180 "already-installed packages without upgrading every package you have on your "
2181 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2182 "all currently installed packages, \"install\" will install the newest "
2183 "version of only the package(s) specified. Simply provide the name of the "
2184 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2185 "its dependencies, as described above) will be downloaded and installed."
2188 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2189 #: apt-get.8.xml:137
2191 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2192 "installation policy for individual packages."
2195 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2196 #: apt-get.8.xml:141
2198 "If no package matches the given expression and the expression contains one "
2199 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2200 "it is applied to all package names in the database. Any matches are then "
2201 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2202 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2203 "expression with a '^' or '$' character, or create a more specific regular "
2207 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2208 #: apt-get.8.xml:151
2210 "<literal>remove</literal> is identical to <literal>install</literal> except "
2211 "that packages are removed instead of installed. Note the removing a package "
2212 "leaves its configuration files in system. If a plus sign is appended to the "
2213 "package name (with no intervening space), the identified package will be "
2214 "installed instead of removed."
2217 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2218 #: apt-get.8.xml:159
2220 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2221 "that packages are removed and purged (any configuration files are deleted "
2225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2226 #: apt-get.8.xml:164
2228 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2229 "packages. APT will examine the available packages to decide which source "
2230 "package to fetch. It will then find and download into the current directory "
2231 "the newest available version of that source package while respecting the "
2232 "default release, set with the option "
2233 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2234 "per package with the <literal>pkg/release</literal> syntax, if possible."
2237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2238 #: apt-get.8.xml:172
2240 "Source packages are tracked separately from binary packages via "
2241 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2242 "that you will need to add such a line for each repository you want to get "
2243 "sources from. If you don't do this you will properly get another (newer, "
2244 "older or none) source version than the one you have installed or could "
2248 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2249 #: apt-get.8.xml:179
2251 "If the <option>--compile</option> option is specified then the package will "
2252 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2253 "the architecture as defined by the <command>--host-architecture</command> "
2254 "option. If <option>--download-only</option> is specified then the source "
2255 "package will not be unpacked."
2258 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2259 #: apt-get.8.xml:186
2261 "A specific source version can be retrieved by postfixing the source name "
2262 "with an equals and then the version to fetch, similar to the mechanism used "
2263 "for the package files. This enables exact matching of the source package "
2264 "name and version, implicitly enabling the "
2265 "<literal>APT::Get::Only-Source</literal> option."
2268 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2269 #: apt-get.8.xml:192
2271 "Note that source packages are not tracked like binary packages, they exist "
2272 "only in the current directory and are similar to downloading source tar "
2276 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2277 #: apt-get.8.xml:198
2279 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2280 "attempt to satisfy the build dependencies for a source package. By default "
2281 "the dependencies are satisfied to build the package natively. If desired a "
2282 "host-architecture can be specified with the "
2283 "<option>--host-architecture</option> option instead."
2286 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2287 #: apt-get.8.xml:205
2289 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2290 "and checks for broken dependencies."
2293 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2294 #: apt-get.8.xml:210
2296 "<literal>download</literal> will download the given binary package into the "
2297 "current directory."
2300 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2301 #: apt-get.8.xml:216
2303 "<literal>clean</literal> clears out the local repository of retrieved "
2304 "package files. It removes everything but the lock file from "
2305 "<filename>&cachedir;/archives/</filename> and "
2306 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2307 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2308 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2309 "from time to time to free up disk space."
2312 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2313 #: apt-get.8.xml:226
2315 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2316 "local repository of retrieved package files. The difference is that it only "
2317 "removes package files that can no longer be downloaded, and are largely "
2318 "useless. This allows a cache to be maintained over a long period without it "
2319 "growing out of control. The configuration option "
2320 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2321 "being erased if it is set to off."
2324 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2325 #: apt-get.8.xml:236
2327 "<literal>autoremove</literal> is used to remove packages that were "
2328 "automatically installed to satisfy dependencies for other packages and are "
2329 "now no longer needed."
2332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2333 #: apt-get.8.xml:241
2335 "<literal>changelog</literal> downloads a package changelog and displays it "
2336 "through <command>sensible-pager</command>. The server name and base "
2337 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2338 "variable (e. g. <ulink "
2339 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
2340 "for Debian or <ulink "
2341 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
2342 "for Ubuntu). By default it displays the changelog for the version that is "
2343 "installed. However, you can specify the same options as for the "
2344 "<option>install</option> command."
2347 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2348 #: apt-get.8.xml:264
2350 "Do not consider recommended packages as a dependency for installing. "
2351 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2355 #: apt-get.8.xml:269
2357 "Consider suggested packages as a dependency for installing. Configuration "
2358 "Item: <literal>APT::Install-Suggests</literal>."
2361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2362 #: apt-get.8.xml:274
2364 "Download only; package files are only retrieved, not unpacked or installed. "
2365 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
2368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2369 #: apt-get.8.xml:279
2371 "Fix; attempt to correct a system with broken dependencies in place. This "
2372 "option, when used with install/remove, can omit any packages to permit APT "
2373 "to deduce a likely solution. If packages are specified, these have to "
2374 "completely correct the problem. The option is sometimes necessary when "
2375 "running APT for the first time; APT itself does not allow broken package "
2376 "dependencies to exist on a system. It is possible that a system's dependency "
2377 "structure can be so corrupt as to require manual intervention (which usually "
2378 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
2379 "of the offending packages). Use of this option together with "
2380 "<option>-m</option> may produce an error in some situations. Configuration "
2381 "Item: <literal>APT::Get::Fix-Broken</literal>."
2384 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2385 #: apt-get.8.xml:294
2387 "Ignore missing packages; If packages cannot be retrieved or fail the "
2388 "integrity check after retrieval (corrupted package files), hold back those "
2389 "packages and handle the result. Use of this option together with "
2390 "<option>-f</option> may produce an error in some situations. If a package is "
2391 "selected for installation (particularly if it is mentioned on the command "
2392 "line) and it could not be downloaded then it will be silently held back. "
2393 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
2396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2397 #: apt-get.8.xml:305
2399 "Disables downloading of packages. This is best used with "
2400 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
2401 "already downloaded. Configuration Item: "
2402 "<literal>APT::Get::Download</literal>."
2405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2406 #: apt-get.8.xml:312
2408 "Quiet; produces output suitable for logging, omitting progress indicators. "
2409 "More q's will produce more quiet up to a maximum of 2. You can also use "
2410 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2411 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
2412 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
2413 "may decided to do something you did not expect. Configuration Item: "
2414 "<literal>quiet</literal>."
2417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2418 #: apt-get.8.xml:327
2420 "No action; perform a simulation of events that would occur but do not "
2421 "actually change the system. Configuration Item: "
2422 "<literal>APT::Get::Simulate</literal>."
2425 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2426 #: apt-get.8.xml:331
2428 "Simulation run as user will deactivate locking "
2429 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
2430 "displayed indicating that this is only a simulation, if the option "
2431 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
2432 "true). Neither NoLocking nor the notice will be triggered if run as root "
2433 "(root should know what he is doing without further warnings by "
2434 "<literal>apt-get</literal>)."
2437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2438 #: apt-get.8.xml:337
2440 "Simulate prints out a series of lines each one representing a dpkg "
2441 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
2442 "indicate broken packages and empty set of square brackets meaning breaks "
2443 "that are of no consequence (rare)."
2446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2447 #: apt-get.8.xml:346
2449 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
2450 "non-interactively. If an undesirable situation, such as changing a held "
2451 "package, trying to install a unauthenticated package or removing an "
2452 "essential package occurs then <literal>apt-get</literal> will abort. "
2453 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
2456 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2457 #: apt-get.8.xml:354
2459 "Automatic \"no\" to all prompts. Configuration Item: "
2460 "<literal>APT::Get::Assume-No</literal>."
2463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2464 #: apt-get.8.xml:359
2466 "Show upgraded packages; Print out a list of all packages that are to be "
2467 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
2470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2471 #: apt-get.8.xml:365
2473 "Show full versions for upgraded and installed packages. Configuration Item: "
2474 "<literal>APT::Get::Show-Versions</literal>."
2477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2478 #: apt-get.8.xml:371
2480 "This option controls the architecture packages are built for by "
2481 "<command>apt-get source --compile</command> and how cross-builddependencies "
2482 "are satisfied. By default is it not set which means that the host "
2483 "architecture is the same as the build architecture (which is defined by "
2484 "<literal>APT::Architecture</literal>). Configuration Item: "
2485 "<literal>APT::Get::Host-Architecture</literal>"
2488 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2489 #: apt-get.8.xml:381
2491 "Compile source packages after downloading them. Configuration Item: "
2492 "<literal>APT::Get::Compile</literal>."
2495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2496 #: apt-get.8.xml:386
2498 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
2499 "hold placed on a package. This may be useful in conjunction with "
2500 "<literal>dist-upgrade</literal> to override a large number of undesired "
2501 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
2504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2505 #: apt-get.8.xml:393
2507 "Do not upgrade packages; When used in conjunction with "
2508 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
2509 "packages on the command line from being upgraded if they are already "
2510 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
2513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2514 #: apt-get.8.xml:400
2516 "Do not install new packages; When used in conjunction with "
2517 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
2518 "upgrades for already installed packages only and ignore requests to install "
2519 "new packages. Configuration Item: "
2520 "<literal>APT::Get::Only-Upgrade</literal>."
2523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2524 #: apt-get.8.xml:408
2526 "Force yes; This is a dangerous option that will cause apt to continue "
2527 "without prompting if it is doing something potentially harmful. It should "
2528 "not be used except in very special situations. Using "
2529 "<literal>force-yes</literal> can potentially destroy your system! "
2530 "Configuration Item: <literal>APT::Get::force-yes</literal>."
2533 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2534 #: apt-get.8.xml:416
2536 "Instead of fetching the files to install their URIs are printed. Each URI "
2537 "will have the path, the destination file name, the size and the expected md5 "
2538 "hash. Note that the file name to write to will not always match the file "
2539 "name on the remote site! This also works with the <literal>source</literal> "
2540 "and <literal>update</literal> commands. When used with the "
2541 "<literal>update</literal> command the MD5 and size are not included, and it "
2542 "is up to the user to decompress any compressed files. Configuration Item: "
2543 "<literal>APT::Get::Print-URIs</literal>."
2546 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2547 #: apt-get.8.xml:427
2549 "Use purge instead of remove for anything that would be removed. An asterisk "
2550 "(\"*\") will be displayed next to packages which are scheduled to be "
2551 "purged. <option>remove --purge</option> is equivalent to the "
2552 "<option>purge</option> command. Configuration Item: "
2553 "<literal>APT::Get::Purge</literal>."
2556 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2557 #: apt-get.8.xml:435
2559 "Re-Install packages that are already installed and at the newest version. "
2560 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
2563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2564 #: apt-get.8.xml:440
2566 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
2567 "it off. When on <command>apt-get</command> will automatically manage the "
2568 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
2569 "files are erased. The only reason to turn it off is if you frequently "
2570 "change your source list. Configuration Item: "
2571 "<literal>APT::Get::List-Cleanup</literal>."
2574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2575 #: apt-get.8.xml:451
2577 "This option controls the default input to the policy engine, it creates a "
2578 "default pin at priority 990 using the specified release string. This "
2579 "overrides the general settings in "
2580 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
2581 "not affected by the value of this option. In short, this option lets you "
2582 "have simple control over which distribution packages will be retrieved "
2583 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
2584 "unstable</option> or <option>-t sid</option>. Configuration Item: "
2585 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
2589 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2590 #: apt-get.8.xml:466
2592 "Only perform operations that are 'trivial'. Logically this can be considered "
2593 "related to <option>--assume-yes</option>, where "
2594 "<option>--assume-yes</option> will answer yes to any prompt, "
2595 "<option>--trivial-only</option> will answer no. Configuration Item: "
2596 "<literal>APT::Get::Trivial-Only</literal>."
2599 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2600 #: apt-get.8.xml:473
2602 "If any packages are to be removed apt-get immediately aborts without "
2603 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
2606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2607 #: apt-get.8.xml:479
2609 "If the command is either <literal>install</literal> or "
2610 "<literal>remove</literal>, then this option acts like running "
2611 "<literal>autoremove</literal> command, removing the unused dependency "
2612 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
2615 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2616 #: apt-get.8.xml:486
2618 "Only has meaning for the <literal>source</literal> and "
2619 "<literal>build-dep</literal> commands. Indicates that the given source "
2620 "names are not to be mapped through the binary table. This means that if "
2621 "this option is specified, these commands will only accept source package "
2622 "names as arguments, rather than accepting binary package names and looking "
2623 "up the corresponding source package. Configuration Item: "
2624 "<literal>APT::Get::Only-Source</literal>."
2627 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2628 #: apt-get.8.xml:497
2630 "Download only the diff, dsc, or tar file of a source archive. Configuration "
2631 "Item: <literal>APT::Get::Diff-Only</literal>, "
2632 "<literal>APT::Get::Dsc-Only</literal>, and "
2633 "<literal>APT::Get::Tar-Only</literal>."
2636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2637 #: apt-get.8.xml:503
2639 "Only process architecture-dependent build-dependencies. Configuration Item: "
2640 "<literal>APT::Get::Arch-Only</literal>."
2643 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2644 #: apt-get.8.xml:508
2646 "Ignore if packages can't be authenticated and don't prompt about it. This "
2647 "is useful for tools like pbuilder. Configuration Item: "
2648 "<literal>APT::Get::AllowUnauthenticated</literal>."
2651 #. type: Content of: <refentry><refsect1><variablelist>
2652 #: apt-get.8.xml:521
2654 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
2658 #. type: Content of: <refentry><refsect1><para>
2659 #: apt-get.8.xml:530
2661 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
2662 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
2663 "&apt-preferences;, the APT Howto."
2666 #. type: Content of: <refentry><refsect1><para>
2667 #: apt-get.8.xml:536
2669 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
2673 #. type: Content of: <refentry><refsect1><title>
2674 #: apt-get.8.xml:539
2675 msgid "ORIGINAL AUTHORS"
2678 #. type: Content of: <refentry><refsect1><para>
2679 #: apt-get.8.xml:540
2680 msgid "&apt-author.jgunthorpe;"
2683 #. type: Content of: <refentry><refsect1><title>
2684 #: apt-get.8.xml:543
2685 msgid "CURRENT AUTHORS"
2688 #. type: Content of: <refentry><refsect1><para>
2689 #: apt-get.8.xml:545
2690 msgid "&apt-author.team;"
2693 #. type: Content of: <refentry><refnamediv><refpurpose>
2695 msgid "APT key management utility"
2698 #. type: Content of: <refentry><refsect1><para>
2701 "<command>apt-key</command> is used to manage the list of keys used by apt to "
2702 "authenticate packages. Packages which have been authenticated using these "
2703 "keys will be considered trusted."
2706 #. type: Content of: <refentry><refsect1><title>
2711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2714 "Add a new key to the list of trusted keys. The key is read from the "
2715 "filename given with the parameter &synopsis-param-filename; or if the "
2716 "filename is <literal>-</literal> from standard input."
2719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2721 msgid "Remove a key from the list of trusted keys."
2724 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2726 msgid "Output the key &synopsis-param-keyid; to standard output."
2729 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2731 msgid "Output all trusted keys to standard output."
2734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2736 msgid "List trusted keys."
2739 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2740 #: apt-key.8.xml:107
2741 msgid "List fingerprints of trusted keys."
2744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2745 #: apt-key.8.xml:118
2747 "Pass advanced options to gpg. With adv --recv-key you can download the "
2751 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2752 #: apt-key.8.xml:130
2754 "Update the local keyring with the archive keyring and remove from the local "
2755 "keyring the archive keys which are no longer valid. The archive keyring is "
2756 "shipped in the <literal>archive-keyring</literal> package of your "
2757 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
2761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2762 #: apt-key.8.xml:144
2764 "Work similar to the <command>update</command> command above, but get the "
2765 "archive keyring from an URI instead and validate it against a master key. "
2766 "This requires an installed &wget; and an APT build configured to have a "
2767 "server to fetch from and a master keyring to validate. APT in Debian does "
2768 "not support this command and relies on <command>update</command> instead, "
2769 "but Ubuntu's APT does."
2772 #. type: Content of: <refentry><refsect1><para>
2773 #: apt-key.8.xml:161
2775 "Note that options need to be defined before the commands described in the "
2779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2780 #: apt-key.8.xml:164
2782 "With this option it is possible to specify a specific keyring file the "
2783 "command should operate on. The default is that a command is executed on the "
2784 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2785 "<filename>trusted.gpg.d</filename> directory, though "
2786 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2787 "e.g. new keys are added to this one."
2790 #. type: Content of: <refentry><refsect1><variablelist>
2791 #: apt-key.8.xml:177
2792 msgid "&file-trustedgpg;"
2795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2796 #: apt-key.8.xml:179
2797 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
2800 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2801 #: apt-key.8.xml:180
2802 msgid "Local trust database of archive keys."
2805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2806 #: apt-key.8.xml:183
2807 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
2810 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2811 #: apt-key.8.xml:184
2812 msgid "Keyring of Debian archive trusted keys."
2815 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2816 #: apt-key.8.xml:187
2817 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
2820 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2821 #: apt-key.8.xml:188
2822 msgid "Keyring of Debian archive removed trusted keys."
2825 #. type: Content of: <refentry><refsect1><para>
2826 #: apt-key.8.xml:197
2827 msgid "&apt-get;, &apt-secure;"
2830 #. The last update date
2831 #. type: Content of: <refentry><refentryinfo>
2832 #: apt-mark.8.xml:16
2833 msgid "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product;"
2836 #. type: Content of: <refentry><refnamediv><refpurpose>
2837 #: apt-mark.8.xml:33
2838 msgid "mark/unmark a package as being automatically-installed"
2841 #. type: Content of: <refentry><refsect1><para>
2842 #: apt-mark.8.xml:39
2844 "<command>apt-mark</command> will change whether a package has been marked as "
2845 "being automatically installed."
2848 #. type: Content of: <refentry><refsect1><para>
2849 #: apt-mark.8.xml:43
2851 "When you request that a package is installed, and as a result other packages "
2852 "are installed to satisfy its dependencies, the dependencies are marked as "
2853 "being automatically installed. Once these automatically installed packages "
2854 "are no longer depended on by any manually installed packages, they will be "
2855 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2859 #: apt-mark.8.xml:52
2861 "<literal>auto</literal> is used to mark a package as being automatically "
2862 "installed, which will cause the package to be removed when no more manually "
2863 "installed packages depend on this package."
2866 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2867 #: apt-mark.8.xml:60
2869 "<literal>manual</literal> is used to mark a package as being manually "
2870 "installed, which will prevent the package from being automatically removed "
2871 "if no other packages depend on it."
2874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2875 #: apt-mark.8.xml:68
2877 "<literal>hold</literal> is used to mark a package as hold back, which will "
2878 "prevent the package from being automatically installed, upgraded or "
2879 "removed. The command is only a wrapper around <command>dpkg "
2880 "--set-selections</command> and the state is therefore maintained by &dpkg; "
2881 "and not effected by the <option>--filename</option> option."
2884 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2885 #: apt-mark.8.xml:78
2887 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2888 "package to allow all actions again."
2891 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2892 #: apt-mark.8.xml:84
2894 "<literal>showauto</literal> is used to print a list of automatically "
2895 "installed packages with each package on a new line. All automatically "
2896 "installed packages will be listed if no package is given. If packages are "
2897 "given only those which are automatically installed will be shown."
2900 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2901 #: apt-mark.8.xml:92
2903 "<literal>showmanual</literal> can be used in the same way as "
2904 "<literal>showauto</literal> except that it will print a list of manually "
2905 "installed packages instead."
2908 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2909 #: apt-mark.8.xml:99
2911 "<literal>showhold</literal> is used to print a list of packages on hold in "
2912 "the same way as for the other show commands."
2915 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><filename>
2916 #: apt-mark.8.xml:112 apt-mark.8.xml:113
2917 msgid "<replaceable>&synopsis-filename;</replaceable>"
2920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2921 #: apt-mark.8.xml:115
2923 "Read/Write package stats from the filename given with the parameter "
2924 "<filename><replaceable>&synopsis-filename;</replaceable></filename> instead "
2925 "of from the default location, which is <filename>extended_status</filename> "
2926 "in the directory defined by the Configuration Item: "
2927 "<literal>Dir::State</literal>."
2930 #. type: Content of: <refentry><refsect1><variablelist>
2931 #: apt-mark.8.xml:128
2932 msgid " &file-extended_states;"
2935 #. type: Content of: <refentry><refsect1><para>
2936 #: apt-mark.8.xml:133
2937 msgid "&apt-get;,&aptitude;,&apt-conf;"
2940 #. type: Content of: <refentry><refsect1><para>
2941 #: apt-mark.8.xml:137
2943 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2947 #. type: Content of: <refentry><refnamediv><refpurpose>
2948 #: apt-secure.8.xml:47
2949 msgid "Archive authentication support for APT"
2952 #. type: Content of: <refentry><refsect1><para>
2953 #: apt-secure.8.xml:52
2955 "Starting with version 0.6, <command>apt</command> contains code that does "
2956 "signature checking of the Release file for all archives. This ensures that "
2957 "packages in the archive can't be modified by people who have no access to "
2958 "the Release file signing key."
2961 #. type: Content of: <refentry><refsect1><para>
2962 #: apt-secure.8.xml:60
2964 "If a package comes from a archive without a signature or with a signature "
2965 "that apt does not have a key for that package is considered untrusted and "
2966 "installing it will result in a big warning. <command>apt-get</command> will "
2967 "currently only warn for unsigned archives, future releases might force all "
2968 "sources to be verified before downloading packages from them."
2971 #. type: Content of: <refentry><refsect1><para>
2972 #: apt-secure.8.xml:69
2974 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2975 "authentication feature."
2978 #. type: Content of: <refentry><refsect1><title>
2979 #: apt-secure.8.xml:74
2980 msgid "Trusted archives"
2983 #. type: Content of: <refentry><refsect1><para>
2984 #: apt-secure.8.xml:77
2986 "The chain of trust from an apt archive to the end user is made up of "
2987 "different steps. <command>apt-secure</command> is the last step in this "
2988 "chain, trusting an archive does not mean that the packages that you trust it "
2989 "do not contain malicious code but means that you trust the archive "
2990 "maintainer. It's the archive maintainer responsibility to ensure that the "
2991 "archive integrity is correct."
2994 #. type: Content of: <refentry><refsect1><para>
2995 #: apt-secure.8.xml:85
2997 "apt-secure does not review signatures at a package level. If you require "
2998 "tools to do this you should look at <command>debsig-verify</command> and "
2999 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3000 "packages respectively)."
3003 #. type: Content of: <refentry><refsect1><para>
3004 #: apt-secure.8.xml:92
3006 "The chain of trust in Debian starts when a maintainer uploads a new package "
3007 "or a new version of a package to the Debian archive. This upload in order to "
3008 "become effective needs to be signed by a key of a maintainer within the "
3009 "Debian maintainer's keyring (available in the debian-keyring "
3010 "package). Maintainer's keys are signed by other maintainers following "
3011 "pre-established procedures to ensure the identity of the key holder."
3014 #. type: Content of: <refentry><refsect1><para>
3015 #: apt-secure.8.xml:102
3017 "Once the uploaded package is verified and included in the archive, the "
3018 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3019 "and put in the Packages file. The MD5 sum of all of the packages files are "
3020 "then computed and put into the Release file. The Release file is then signed "
3021 "by the archive key (which is created once a year) and distributed through "
3022 "the FTP server. This key is also on the Debian keyring."
3025 #. type: Content of: <refentry><refsect1><para>
3026 #: apt-secure.8.xml:112
3028 "Any end user can check the signature of the Release file, extract the MD5 "
3029 "sum of a package from it and compare it with the MD5 sum of the package he "
3030 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3031 "package was checked. Now both the MD5 sum and the signature of the Release "
3035 #. type: Content of: <refentry><refsect1><para>
3036 #: apt-secure.8.xml:119
3038 "Notice that this is distinct from checking signatures on a per package "
3039 "basis. It is designed to prevent two possible attacks:"
3042 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3043 #: apt-secure.8.xml:124
3045 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3046 "checking, a malicious agent can introduce himself in the package download "
3047 "process and provide malicious software either by controlling a network "
3048 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3049 "(through arp or DNS spoofing attacks)."
3052 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3053 #: apt-secure.8.xml:132
3055 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3056 "malicious agent can compromise a mirror host and modify the files in it to "
3057 "propagate malicious software to all users downloading packages from that "
3061 #. type: Content of: <refentry><refsect1><para>
3062 #: apt-secure.8.xml:139
3064 "However, it does not defend against a compromise of the Debian master server "
3065 "itself (which signs the packages) or against a compromise of the key used to "
3066 "sign the Release files. In any case, this mechanism can complement a "
3067 "per-package signature."
3070 #. type: Content of: <refentry><refsect1><title>
3071 #: apt-secure.8.xml:145
3072 msgid "User configuration"
3075 #. type: Content of: <refentry><refsect1><para>
3076 #: apt-secure.8.xml:147
3078 "<command>apt-key</command> is the program that manages the list of keys used "
3079 "by apt. It can be used to add or remove keys although an installation of "
3080 "this release will automatically provide the default Debian archive signing "
3081 "keys used in the Debian package repositories."
3084 #. type: Content of: <refentry><refsect1><para>
3085 #: apt-secure.8.xml:154
3087 "In order to add a new key you need to first download it (you should make "
3088 "sure you are using a trusted communication channel when retrieving it), add "
3089 "it with <command>apt-key</command> and then run <command>apt-get "
3090 "update</command> so that apt can download and verify the "
3091 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3092 "from the archives you have configured."
3095 #. type: Content of: <refentry><refsect1><title>
3096 #: apt-secure.8.xml:163
3097 msgid "Archive configuration"
3100 #. type: Content of: <refentry><refsect1><para>
3101 #: apt-secure.8.xml:165
3103 "If you want to provide archive signatures in an archive under your "
3104 "maintenance you have to:"
3107 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3108 #: apt-secure.8.xml:170
3110 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3111 "already. You can do this by running <command>apt-ftparchive "
3112 "release</command> (provided in apt-utils)."
3115 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3116 #: apt-secure.8.xml:175
3118 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
3119 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
3120 "Release.gpg Release</command>."
3123 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3124 #: apt-secure.8.xml:179
3126 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
3127 "know what key they need to import in order to authenticate the files in the "
3131 #. type: Content of: <refentry><refsect1><para>
3132 #: apt-secure.8.xml:186
3134 "Whenever the contents of the archive changes (new packages are added or "
3135 "removed) the archive maintainer has to follow the first two steps previously "
3139 #. type: Content of: <refentry><refsect1><para>
3140 #: apt-secure.8.xml:194
3142 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
3143 "&debsign; &debsig-verify;, &gpg;"
3146 #. type: Content of: <refentry><refsect1><para>
3147 #: apt-secure.8.xml:198
3149 "For more background information you might want to review the <ulink "
3150 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
3151 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
3152 "(available also in the harden-doc package) and the <ulink "
3153 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
3154 "Distribution HOWTO</ulink> by V. Alex Brennen."
3157 #. type: Content of: <refentry><refsect1><title>
3158 #: apt-secure.8.xml:211
3159 msgid "Manpage Authors"
3162 #. type: Content of: <refentry><refsect1><para>
3163 #: apt-secure.8.xml:213
3165 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
3166 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
3169 #. type: Content of: <refentry><refnamediv><refpurpose>
3170 #: apt-sortpkgs.1.xml:33
3171 msgid "Utility to sort package index files"
3174 #. type: Content of: <refentry><refsect1><para>
3175 #: apt-sortpkgs.1.xml:39
3177 "<command>apt-sortpkgs</command> will take an index file (Source index or "
3178 "Package index) and sort the records so that they are ordered by the package "
3179 "name. It will also sort the internal fields of each record according to the "
3180 "internal sorting rules."
3183 #. type: Content of: <refentry><refsect1><para>
3184 #: apt-sortpkgs.1.xml:45
3185 msgid "All output is sent to stdout, the input must be a seekable file."
3188 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3189 #: apt-sortpkgs.1.xml:54
3191 "Use Source index field ordering. Configuration Item: "
3192 "<literal>APT::SortPkgs::Source</literal>."
3195 #. type: Content of: <refentry><refsect1><para>
3196 #: apt-sortpkgs.1.xml:68
3198 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
3202 #. The last update date
3203 #. type: Content of: <refentry><refentryinfo>
3204 #: apt.conf.5.xml:16
3206 "&apt-author.jgunthorpe; &apt-author.team; <author> "
3207 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
3208 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
3209 "</author> &apt-email; &apt-product;"
3212 #. type: Content of: <refentry><refmeta><manvolnum>
3213 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
3217 #. type: Content of: <refentry><refnamediv><refpurpose>
3218 #: apt.conf.5.xml:39
3219 msgid "Configuration file for APT"
3222 #. type: Content of: <refentry><refsect1><para>
3223 #: apt.conf.5.xml:43
3225 "<filename>apt.conf</filename> is the main configuration file for the APT "
3226 "suite of tools, but by far not the only place changes to options can be "
3227 "made. All tools therefore share the configuration files and also use a "
3228 "common command line parser to provide a uniform environment."
3231 #. type: Content of: <refentry><refsect1><orderedlist><para>
3232 #: apt.conf.5.xml:48
3234 "When an APT tool starts up it will read the configuration files in the "
3238 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3239 #: apt.conf.5.xml:50
3241 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
3245 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3246 #: apt.conf.5.xml:52
3248 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
3249 "order which have either no or \"<literal>conf</literal>\" as filename "
3250 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
3251 "and period (.) characters. Otherwise APT will print a notice that it has "
3252 "ignored a file if the file doesn't match a pattern in the "
3253 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
3254 "case it will be silently ignored."
3257 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3258 #: apt.conf.5.xml:59
3259 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
3262 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3263 #: apt.conf.5.xml:61
3265 "the command line options are applied to override the configuration "
3266 "directives or to load even more configuration files."
3269 #. type: Content of: <refentry><refsect1><title>
3270 #: apt.conf.5.xml:65
3274 #. type: Content of: <refentry><refsect1><para>
3275 #: apt.conf.5.xml:66
3277 "The configuration file is organized in a tree with options organized into "
3278 "functional groups. Option specification is given with a double colon "
3279 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
3280 "within the APT tool group, for the Get tool. Options do not inherit from "
3281 "their parent groups."
3284 #. type: Content of: <refentry><refsect1><para>
3285 #: apt.conf.5.xml:72
3287 "Syntactically the configuration language is modeled after what the ISC tools "
3288 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
3289 "treated as comments (ignored), as well as all text between "
3290 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
3291 "Each line is of the form <literal>APT::Get::Assume-Yes "
3292 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
3293 "value must be on one line, and there is no kind of string concatenation. It "
3294 "must not include inside quotes. The behavior of the backslash \"\\\" and "
3295 "escaped characters inside a value is undefined and it should not be used. An "
3296 "option name may include alphanumerical characters and the \"/-:._+\" "
3297 "characters. A new scope can be opened with curly braces, like:"
3300 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3301 #: apt.conf.5.xml:86
3306 " Assume-Yes \"true\";\n"
3307 " Fix-Broken \"true\";\n"
3312 #. type: Content of: <refentry><refsect1><para>
3313 #: apt.conf.5.xml:94
3315 "with newlines placed to make it more readable. Lists can be created by "
3316 "opening a scope and including a single string enclosed in quotes followed by "
3317 "a semicolon. Multiple entries can be included, each separated by a "
3321 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3322 #: apt.conf.5.xml:99
3324 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
3327 #. type: Content of: <refentry><refsect1><para>
3328 #: apt.conf.5.xml:102
3330 "In general the sample configuration file in "
3331 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
3332 "guide for how it should look."
3335 #. type: Content of: <refentry><refsect1><para>
3336 #: apt.conf.5.xml:106
3338 "The names of the configuration items are not case-sensitive. So in the "
3339 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
3342 #. type: Content of: <refentry><refsect1><para>
3343 #: apt.conf.5.xml:109
3345 "Names for the configuration items are optional if a list is defined as it "
3346 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
3347 "above. If you don't specify a name a new entry will simply add a new option "
3348 "to the list. If you specify a name you can override the option as every "
3349 "other option by reassigning a new value to the option."
3352 #. type: Content of: <refentry><refsect1><para>
3353 #: apt.conf.5.xml:114
3355 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
3356 "and not supported by alternative implementations) and "
3357 "<literal>#clear</literal>: <literal>#include</literal> will include the "
3358 "given file, unless the filename ends in a slash, then the whole directory is "
3359 "included. <literal>#clear</literal> is used to erase a part of the "
3360 "configuration tree. The specified element and all its descendants are "
3361 "erased. (Note that these lines also need to end with a semicolon.)"
3364 #. type: Content of: <refentry><refsect1><para>
3365 #: apt.conf.5.xml:122
3367 "The #clear command is the only way to delete a list or a complete scope. "
3368 "Reopening a scope or the ::-style described below will "
3369 "<emphasis>not</emphasis> override previously written entries. Only options "
3370 "can be overridden by addressing a new value to it - lists and scopes can't "
3371 "be overridden, only cleared."
3374 #. type: Content of: <refentry><refsect1><para>
3375 #: apt.conf.5.xml:127
3377 "All of the APT tools take a -o option which allows an arbitrary "
3378 "configuration directive to be specified on the command line. The syntax is a "
3379 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
3380 "followed by an equals sign then the new value of the option. To append a new "
3381 "element to a list, add a trailing :: to the name of the list. (As you might "
3382 "suspect: The scope syntax can't be used on the command line.)"
3385 #. type: Content of: <refentry><refsect1><para>
3386 #: apt.conf.5.xml:134
3388 "Note that you can use :: only for appending one item per line to a list and "
3389 "that you should not use it in combination with the scope syntax. (The scope "
3390 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
3391 "which some users unfortunately depend on: An option with the unusual name "
3392 "\"<literal>::</literal>\" which acts like every other option with a "
3393 "name. These introduces many problems including that a user who writes "
3394 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
3395 "append to a list will gain the opposite as only the last assignment for this "
3396 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
3397 "raise errors and will stop working if they encounter this misuse, so please "
3398 "correct such statements now as long as APT doesn't complain explicit about "
3402 #. type: Content of: <refentry><refsect1><title>
3403 #: apt.conf.5.xml:146
3404 msgid "The APT Group"
3407 #. type: Content of: <refentry><refsect1><para>
3408 #: apt.conf.5.xml:147
3410 "This group of options controls general APT behavior as well as holding the "
3411 "options for all of the tools."
3414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3415 #: apt.conf.5.xml:152
3417 "System Architecture; sets the architecture to use when fetching files and "
3418 "parsing package lists. The internal default is the architecture apt was "
3422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3423 #: apt.conf.5.xml:158
3425 "All Architectures the system supports. Processors implementing the "
3426 "<literal>amd64</literal> (also called <literal>x86-64</literal>) instruction "
3427 "set are e.g. also able to execute binaries compiled for the "
3428 "<literal>i386</literal> (<literal>x86</literal>) instruction set; This list "
3429 "is use when fetching files and parsing package lists. The internal default "
3430 "is always the native architecture (<literal>APT::Architecture</literal>) "
3431 "and all foreign architectures it can retrieve by calling <command>dpkg "
3432 "--print-foreign-architectures</command>."
3435 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3436 #: apt.conf.5.xml:168
3438 "Default release to install packages from if more than one version "
3439 "available. Contains release name, codename or release version. Examples: "
3440 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
3441 "'4.0', '5.0*'. See also &apt-preferences;."
3444 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3445 #: apt.conf.5.xml:174
3447 "Ignore Held packages; This global option causes the problem resolver to "
3448 "ignore held packages in its decision making."
3451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3452 #: apt.conf.5.xml:179
3454 "Defaults to on. When turned on the autoclean feature will remove any "
3455 "packages which can no longer be downloaded from the cache. If turned off "
3456 "then packages that are locally installed are also excluded from cleaning - "
3457 "but note that APT provides no direct means to reinstall them."
3460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3461 #: apt.conf.5.xml:186
3463 "Defaults to on which will cause APT to install essential and important "
3464 "packages as fast as possible in the install/upgrade operation. This is done "
3465 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
3466 "does treat an important package in the same way as an extra package: Between "
3467 "the unpacking of the important package A and his configuration can then be "
3468 "many other unpack or configuration calls, e.g. for package B which has no "
3469 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
3470 "script of package B generates an error) which results in a system state in "
3471 "which package A is unpacked but unconfigured - each package depending on A "
3472 "is now no longer guaranteed to work as their dependency on A is not longer "
3473 "satisfied. The immediate configuration marker is also applied to all "
3474 "dependencies which can generate a problem if the dependencies e.g. form a "
3475 "circle as a dependency with the immediate flag is comparable with a "
3476 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
3477 "in which it is unable to perform immediate configuration, errors out and "
3478 "refers to this option so the user can deactivate the immediate configuration "
3479 "temporarily to be able to perform an install/upgrade again. Note the use of "
3480 "the word \"theory\" here as this problem was only encountered by now in real "
3481 "world a few times in non-stable distribution versions and was caused by "
3482 "wrong dependencies of the package in question or by a system in an already "
3483 "broken state, so you should not blindly disable this option as the mentioned "
3484 "scenario above is not the only problem immediate configuration can help to "
3485 "prevent in the first place. Before a big operation like "
3486 "<literal>dist-upgrade</literal> is run with this option disabled it should "
3487 "be tried to explicitly <literal>install</literal> the package APT is unable "
3488 "to configure immediately, but please make sure to report your problem also "
3489 "to your distribution and to the APT team with the buglink below so they can "
3490 "work on improving or correcting the upgrade process."
3493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3494 #: apt.conf.5.xml:209
3496 "Never Enable this option unless you -really- know what you are doing. It "
3497 "permits APT to temporarily remove an essential package to break a "
3498 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
3499 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
3500 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
3501 "anything that those packages depend on."
3504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3505 #: apt.conf.5.xml:218
3507 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3508 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
3509 "to which size the Cache will grow and is therefore the amount of memory APT "
3510 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3511 "that this amount of space needs to be available for APT otherwise it will "
3512 "likely fail ungracefully, so for memory restricted devices this value should "
3513 "be lowered while on systems with a lot of configured sources it should be "
3514 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3515 "of 1048576 (~1 MB) how much the Cache size will be increased in the event "
3516 "the space defined by <literal>Cache-Start</literal> is not enough. These "
3517 "value will be applied again and again until either the cache is big enough "
3518 "to store all information or the size of the cache reaches the "
3519 "<literal>Cache-Limit</literal>. The default of "
3520 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3521 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
3525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3526 #: apt.conf.5.xml:234
3527 msgid "Defines which package(s) are considered essential build dependencies."
3530 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3531 #: apt.conf.5.xml:238
3533 "The Get subsection controls the &apt-get; tool, please see its documentation "
3534 "for more information about the options here."
3537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3538 #: apt.conf.5.xml:243
3540 "The Cache subsection controls the &apt-cache; tool, please see its "
3541 "documentation for more information about the options here."
3544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3545 #: apt.conf.5.xml:248
3547 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
3548 "documentation for more information about the options here."
3551 #. type: Content of: <refentry><refsect1><title>
3552 #: apt.conf.5.xml:254
3553 msgid "The Acquire Group"
3556 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3557 #: apt.conf.5.xml:260
3559 "Security related option defaulting to true as an expiring validation for a "
3560 "Release file prevents longtime replay attacks and can e.g. also help users "
3561 "to identify no longer updated mirrors - but the feature depends on the "
3562 "correctness of the time on the user system. Archive maintainers are "
3563 "encouraged to create Release files with the <literal>Valid-Until</literal> "
3564 "header, but if they don't or a stricter value is volitional the following "
3565 "<literal>Max-ValidTime</literal> option can be used."
3568 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3569 #: apt.conf.5.xml:271
3571 "Seconds the Release file should be considered valid after it was created "
3572 "(indicated by the <literal>Date</literal> header). If the Release file "
3573 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
3574 "the two is used as the expiration date. The default value is "
3575 "<literal>0</literal> which stands for \"for ever valid\". Archive specific "
3576 "settings can be made by appending the label of the archive to the option "
3580 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3581 #: apt.conf.5.xml:282
3583 "Minimum of seconds the Release file should be considered valid after it was "
3584 "created (indicated by the <literal>Date</literal> header). Use this if you "
3585 "need to use a seldomly updated (local) mirror of a more regular updated "
3586 "archive with a <literal>Valid-Until</literal> header instead of completely "
3587 "disabling the expiration date checking. Archive specific settings can and "
3588 "should be used by appending the label of the archive to the option name."
3591 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3592 #: apt.conf.5.xml:293
3594 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
3595 "Sources files instead of downloading whole ones. True by default."
3598 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3599 #: apt.conf.5.xml:296
3601 "Two sub-options to limit the use of PDiffs are also available: With "
3602 "<literal>FileLimit</literal> can be specified how many PDiff files are "
3603 "downloaded at most to update a file. <literal>SizeLimit</literal> on the "
3604 "other hand is the maximum percentage of the size of all patches compared to "
3605 "the size of the targeted file. If one of these limits is exceeded the "
3606 "complete file is downloaded instead of the patches."
3609 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3610 #: apt.conf.5.xml:306
3612 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3613 "<literal>host</literal> or <literal>access</literal> which determines how "
3614 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3615 "one connection per target host will be opened, <literal>access</literal> "
3616 "means that one connection per URI type will be opened."
3619 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3620 #: apt.conf.5.xml:314
3622 "Number of retries to perform. If this is non-zero APT will retry failed "
3623 "files the given number of times."
3626 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3627 #: apt.conf.5.xml:319
3629 "Use symlinks for source archives. If set to true then source archives will "
3630 "be symlinked when possible instead of copying. True is the default."
3633 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3634 #: apt.conf.5.xml:324
3636 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
3637 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
3638 "host proxies can also be specified by using the form "
3639 "<literal>http::Proxy::<host></literal> with the special keyword "
3640 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3641 "settings is specified, <envar>http_proxy</envar> environment variable will "
3645 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3646 #: apt.conf.5.xml:332
3648 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3649 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
3650 "response under any circumstances, <literal>Max-Age</literal> is sent only "
3651 "for index files and tells the cache to refresh its object if it is older "
3652 "than the given number of seconds. Debian updates its index files daily so "
3653 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
3654 "should never store this request, it is only set for archive files. This may "
3655 "be useful to prevent polluting a proxy cache with very large .deb "
3656 "files. Note: Squid 2.0.2 does not support any of these options."
3659 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3660 #: apt.conf.5.xml:342 apt.conf.5.xml:408
3662 "The option <literal>timeout</literal> sets the timeout timer used by the "
3663 "method, this applies to all things including connection timeout and data "
3667 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3668 #: apt.conf.5.xml:345
3670 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3671 "enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial "
3672 "e.g. on high-latency connections. It specifies how many requests are send in "
3673 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
3674 "the default value is now 0 (= disabled) to avoid problems with the "
3675 "ever-growing amount of webservers and proxies which choose to not conform to "
3676 "the HTTP/1.1 specification."
3679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3680 #: apt.conf.5.xml:352
3682 "<literal>Acquire::http::AllowRedirect</literal> controls if APT will follow "
3683 "redirects, which is enabled by default."
3686 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3687 #: apt.conf.5.xml:355
3689 "The used bandwidth can be limited with "
3690 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3691 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
3692 "as much as possible of the bandwidth (Note that this option implicit "
3693 "deactivates the download from multiple servers at the same time.)"
3696 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3697 #: apt.conf.5.xml:360
3699 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3700 "User-Agent for the http download method as some proxies allow access for "
3701 "clients only if the client uses a known identifier."
3704 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3705 #: apt.conf.5.xml:367
3707 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
3708 "options are the same as for <literal>http</literal> method and will also "
3709 "default to the options from the <literal>http</literal> method if they are "
3710 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
3711 "not supported yet."
3714 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3715 #: apt.conf.5.xml:373
3717 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3718 "about trusted certificates. <literal><host>::CaInfo</literal> is "
3719 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3720 "suboption determines whether verify server's host certificate against "
3721 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
3722 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
3723 "suboption determines whether verify server's hostname or not. "
3724 "<literal><host>::Verify-Host</literal> is corresponding per-host "
3725 "option. <literal>SslCert</literal> determines what certificate to use for "
3726 "client authentication. <literal><host>::SslCert</literal> is "
3727 "corresponding per-host option. <literal>SslKey</literal> determines what "
3728 "private key to use for client "
3729 "authentication. <literal><host>::SslKey</literal> is corresponding "
3730 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3731 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
3732 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
3736 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3737 #: apt.conf.5.xml:392
3739 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
3740 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
3741 "proxies can also be specified by using the form "
3742 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3743 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3744 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3745 "used. To use a ftp proxy you will have to set the "
3746 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3747 "entry specifies the commands to send to tell the proxy server what to "
3748 "connect to. Please see &configureindex; for an example of how to do "
3749 "this. The substitution variables available are "
3750 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
3751 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
3752 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
3753 "from it's respective URI component."
3756 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3757 #: apt.conf.5.xml:411
3759 "Several settings are provided to control passive mode. Generally it is safe "
3760 "to leave passive mode on, it works in nearly every environment. However "
3761 "some situations require that passive mode be disabled and port mode ftp used "
3762 "instead. This can be done globally, for connections that go through a proxy "
3763 "or for a specific host (See the sample config file for examples)."
3766 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3767 #: apt.conf.5.xml:418
3769 "It is possible to proxy FTP over HTTP by setting the "
3770 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
3771 "discussion of the http method above for syntax. You cannot set this in the "
3772 "configuration file and it is not recommended to use FTP over HTTP due to its "
3776 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3777 #: apt.conf.5.xml:423
3779 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3780 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3781 "false, which means these commands are only used if the control connection is "
3782 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3783 "that most FTP servers do not support RFC2428."
3786 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3787 #: apt.conf.5.xml:436
3789 msgid "/cdrom/::Mount \"foo\";"
3792 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3793 #: apt.conf.5.xml:431
3795 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
3796 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
3797 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
3798 "provide alternate mount and unmount commands if your mount point cannot be "
3799 "listed in the fstab (such as an SMB mount and old mount packages). The "
3800 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3801 "cdrom block. It is important to have the trailing slash. Unmount commands "
3802 "can be specified using UMount."
3805 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3806 #: apt.conf.5.xml:442
3808 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
3809 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
3813 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3814 #: apt.conf.5.xml:453
3817 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3818 "\"<replaceable>Methodname</replaceable>\";"
3821 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3822 #: apt.conf.5.xml:448
3824 "List of compression types which are understood by the acquire methods. "
3825 "Files like <filename>Packages</filename> can be available in various "
3826 "compression formats. Per default the acquire methods can decompress "
3827 "<command>bzip2</command>, <command>lzma</command> and "
3828 "<command>gzip</command> compressed files, with this setting more formats can "
3829 "be added on the fly or the used method can be changed. The syntax for this "
3830 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3833 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3834 #: apt.conf.5.xml:458
3836 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3839 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3840 #: apt.conf.5.xml:461
3842 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3845 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3846 #: apt.conf.5.xml:454
3848 "Also the <literal>Order</literal> subgroup can be used to define in which "
3849 "order the acquire system will try to download the compressed files. The "
3850 "acquire system will try the first and proceed with the next compression type "
3851 "in this list on error, so to prefer one over the other type simple add the "
3852 "preferred type at first - not already added default types will be added at "
3853 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3854 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3855 "over <command>bzip2</command> and <command>lzma</command>. If "
3856 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3857 "<command>bzip2</command> the configure setting should look like this "
3858 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3859 "<literal>bz2</literal> explicit to the list as it will be added automatic."
3862 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3863 #: apt.conf.5.xml:465
3865 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3868 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3869 #: apt.conf.5.xml:463
3871 "Note that at run time the "
3872 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3873 "checked: If this setting exists the method will only be used if this file "
3874 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
3875 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
3876 "the command line will be added at the end of the list specified in the "
3877 "configuration files, but before the default entries. To prefer a type in "
3878 "this case over the ones specified in the configuration files you can set the "
3879 "option direct - not in list style. This will not override the defined list, "
3880 "it will only prefix the list with this type."
3883 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3884 #: apt.conf.5.xml:470
3886 "The special type <literal>uncompressed</literal> can be used to give "
3887 "uncompressed files a preference, but note that most archives don't provide "
3888 "uncompressed files so this is mostly only useable for local mirrors."
3891 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3892 #: apt.conf.5.xml:477
3894 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3895 "Sources, or Translations), keep them gzip compressed locally instead of "
3896 "unpacking them. This saves quite a lot of disk space at the expense of more "
3897 "CPU requirements when building the local package caches. False by default."
3900 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3901 #: apt.conf.5.xml:485
3903 "The Languages subsection controls which <filename>Translation</filename> "
3904 "files are downloaded and in which order APT tries to display the "
3905 "Description-Translations. APT will try to display the first available "
3906 "Description in the Language which is listed at first. Languages can be "
3907 "defined with their short or long Languagecodes. Note that not all archives "
3908 "provide <filename>Translation</filename> files for every Language - "
3909 "especially the long Languagecodes are rare, so please inform you which ones "
3910 "are available before you set here impossible values."
3913 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
3914 #: apt.conf.5.xml:501
3916 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3919 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3920 #: apt.conf.5.xml:491
3922 "The default list includes \"environment\" and "
3923 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
3924 "will be replaced at runtime with the languagecodes extracted from the "
3925 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3926 "that these codes are not included twice in the list. If "
3927 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3928 "<filename>Translation-en</filename> file (if available) will be used. To "
3929 "force apt to use no Translation file use the setting "
3930 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3931 "another special meaning code which will stop the search for a fitting "
3932 "<filename>Translation</filename> file. This can be used by the system "
3933 "administrator to let APT know that it should download also this files "
3934 "without actually use them if the environment doesn't specify this "
3935 "languages. So the following example configuration will result in the order "
3936 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
3937 "that \"fr\" is downloaded, but not used if APT is not used in a french "
3938 "localization, in such an environment the order would be \"fr, de, en\". "
3939 "<placeholder type=\"programlisting\" id=\"0\"/>"
3942 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3943 #: apt.conf.5.xml:502
3945 "Note: To prevent problems resulting from APT being executed in different "
3946 "environments (e.g. by different users or by other programs) all Translation "
3947 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3948 "added to the end of the list (after an implicit "
3949 "\"<literal>none</literal>\")."
3952 #. type: Content of: <refentry><refsect1><para>
3953 #: apt.conf.5.xml:255
3955 "The <literal>Acquire</literal> group of options controls the download of "
3956 "packages and the URI handlers. <placeholder type=\"variablelist\" "
3960 #. type: Content of: <refentry><refsect1><title>
3961 #: apt.conf.5.xml:513
3965 #. type: Content of: <refentry><refsect1><para>
3966 #: apt.conf.5.xml:515
3968 "The <literal>Dir::State</literal> section has directories that pertain to "
3969 "local state information. <literal>lists</literal> is the directory to place "
3970 "downloaded package lists in and <literal>status</literal> is the name of the "
3971 "dpkg status file. <literal>preferences</literal> is the name of the APT "
3972 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3973 "contains the default directory to prefix on all sub items if they do not "
3974 "start with <filename>/</filename> or <filename>./</filename>."
3977 #. type: Content of: <refentry><refsect1><para>
3978 #: apt.conf.5.xml:522
3980 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3981 "information, such as the two package caches <literal>srcpkgcache</literal> "
3982 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3983 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3984 "be turned off by setting their names to be blank. This will slow down "
3985 "startup but save disk space. It is probably preferred to turn off the "
3986 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3987 "default directory is contained in <literal>Dir::Cache</literal>"
3990 #. type: Content of: <refentry><refsect1><para>
3991 #: apt.conf.5.xml:531
3993 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3994 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3995 "<literal>main</literal> is the default configuration file (setting has no "
3996 "effect, unless it is done from the config file specified by "
3997 "<envar>APT_CONFIG</envar>)."
4000 #. type: Content of: <refentry><refsect1><para>
4001 #: apt.conf.5.xml:537
4003 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
4004 "in lexical order from the directory specified. After this is done then the "
4005 "main config file is loaded."
4008 #. type: Content of: <refentry><refsect1><para>
4009 #: apt.conf.5.xml:541
4011 "Binary programs are pointed to by "
4012 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
4013 "the location of the method handlers and <literal>gzip</literal>, "
4014 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
4015 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
4016 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
4017 "specify the location of the respective programs."
4020 #. type: Content of: <refentry><refsect1><para>
4021 #: apt.conf.5.xml:549
4023 "The configuration item <literal>RootDir</literal> has a special meaning. If "
4024 "set, all paths in <literal>Dir::</literal> will be relative to "
4025 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
4026 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
4027 "set to <filename>/tmp/staging</filename> and "
4028 "<literal>Dir::State::status</literal> is set to "
4029 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
4030 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
4033 #. type: Content of: <refentry><refsect1><para>
4034 #: apt.conf.5.xml:562
4036 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
4037 "which files APT should silently ignore while parsing the files in the "
4038 "fragment directories. Per default a file which end with "
4039 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
4040 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
4041 "default value these patterns can use regular expression syntax."
4044 #. type: Content of: <refentry><refsect1><title>
4045 #: apt.conf.5.xml:571
4046 msgid "APT in DSelect"
4049 #. type: Content of: <refentry><refsect1><para>
4050 #: apt.conf.5.xml:573
4052 "When APT is used as a &dselect; method several configuration directives "
4053 "control the default behaviour. These are in the <literal>DSelect</literal> "
4057 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4058 #: apt.conf.5.xml:578
4060 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
4061 "and never. always and prompt will remove all packages from the cache after "
4062 "upgrading, prompt (the default) does so conditionally. auto removes only "
4063 "those packages which are no longer downloadable (replaced with a new version "
4064 "for instance). pre-auto performs this action before downloading new "
4068 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4069 #: apt.conf.5.xml:587
4071 "The contents of this variable is passed to &apt-get; as command line options "
4072 "when it is run for the install phase."
4075 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4076 #: apt.conf.5.xml:592
4078 "The contents of this variable is passed to &apt-get; as command line options "
4079 "when it is run for the update phase."
4082 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4083 #: apt.conf.5.xml:597
4085 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
4086 "The default is to prompt only on error."
4089 #. type: Content of: <refentry><refsect1><title>
4090 #: apt.conf.5.xml:603
4091 msgid "How APT calls dpkg"
4094 #. type: Content of: <refentry><refsect1><para>
4095 #: apt.conf.5.xml:604
4097 "Several configuration directives control how APT invokes &dpkg;. These are "
4098 "in the <literal>DPkg</literal> section."
4101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4102 #: apt.conf.5.xml:609
4104 "This is a list of options to pass to dpkg. The options must be specified "
4105 "using the list notation and each list item is passed as a single argument to "
4109 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4110 #: apt.conf.5.xml:615
4112 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
4113 "<literal>options</literal> this must be specified in list notation. The "
4114 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4115 "fail APT will abort."
4118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4119 #: apt.conf.5.xml:622
4121 "This is a list of shell commands to run before invoking dpkg. Like "
4122 "<literal>options</literal> this must be specified in list notation. The "
4123 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4124 "fail APT will abort. APT will pass to the commands on standard input the "
4125 "filenames of all .deb files it is going to install, one per line."
4128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4129 #: apt.conf.5.xml:628
4131 "Version 2 of this protocol dumps more information, including the protocol "
4132 "version, the APT configuration space and the packages, files and versions "
4133 "being changed. Version 2 is enabled by setting "
4134 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
4135 "2. <literal>cmd</literal> is a command given to "
4136 "<literal>Pre-Install-Pkgs</literal>."
4139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4140 #: apt.conf.5.xml:636
4142 "APT chdirs to this directory before invoking dpkg, the default is "
4143 "<filename>/</filename>."
4146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4147 #: apt.conf.5.xml:641
4149 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
4150 "default is to disable signing and produce all binaries."
4153 #. type: Content of: <refentry><refsect1><refsect2><title>
4154 #: apt.conf.5.xml:646
4155 msgid "dpkg trigger usage (and related options)"
4158 #. type: Content of: <refentry><refsect1><refsect2><para>
4159 #: apt.conf.5.xml:647
4161 "APT can call dpkg in a way so it can make aggressive use of triggers over "
4162 "multiple calls of dpkg. Without further options dpkg will use triggers only "
4163 "in between his own run. Activating these options can therefore decrease the "
4164 "time needed to perform the install / upgrade. Note that it is intended to "
4165 "activate these options per default in the future, but as it changes the way "
4166 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
4167 "options are therefore currently experimental and should not be used in "
4168 "productive environments.</emphasis> Also it breaks the progress reporting so "
4169 "all frontends will currently stay around half (or more) of the time in the "
4170 "100% state while it actually configures all packages."
4173 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
4174 #: apt.conf.5.xml:662
4177 "DPkg::NoTriggers \"true\";\n"
4178 "PackageManager::Configure \"smart\";\n"
4179 "DPkg::ConfigurePending \"true\";\n"
4180 "DPkg::TriggersPending \"true\";"
4183 #. type: Content of: <refentry><refsect1><refsect2><para>
4184 #: apt.conf.5.xml:656
4186 "Note that it is not guaranteed that APT will support these options or that "
4187 "these options will not cause (big) trouble in the future. If you have "
4188 "understand the current risks and problems with these options, but are brave "
4189 "enough to help testing them create a new configuration file and test a "
4190 "combination of options. Please report any bugs, problems and improvements "
4191 "you encounter and make sure to note which options you have used in your "
4192 "reports. Asking dpkg for help could also be useful for debugging proposes, "
4193 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
4194 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
4197 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4198 #: apt.conf.5.xml:669
4200 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
4201 "call). See &dpkg; if you are interested in what this actually means. In "
4202 "short: dpkg will not run the triggers when this flag is present unless it is "
4203 "explicitly called to do so in an extra call. Note that this option exists "
4204 "(undocumented) also in older apt versions with a slightly different meaning: "
4205 "Previously these option only append --no-triggers to the configure calls to "
4206 "dpkg - now apt will add these flag also to the unpack and remove calls."
4209 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4210 #: apt.conf.5.xml:677
4212 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
4213 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
4214 "value and causes APT to configure all packages explicit. The "
4215 "\"<literal>smart</literal>\" way is it to configure only packages which need "
4216 "to be configured before another package can be unpacked (Pre-Depends) and "
4217 "let the rest configure by dpkg with a call generated by the next "
4218 "option. \"<literal>no</literal>\" on the other hand will not configure "
4219 "anything and totally rely on dpkg for configuration (which will at the "
4220 "moment fail if a Pre-Depends is encountered). Setting this option to "
4221 "another than the all value will implicitly activate also the next option per "
4222 "default as otherwise the system could end in an unconfigured status which "
4223 "could be unbootable!"
4226 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4227 #: apt.conf.5.xml:688
4229 "If this option is set apt will call <command>dpkg --configure "
4230 "--pending</command> to let dpkg handle all required configurations and "
4231 "triggers. This option is activated automatic per default if the previous "
4232 "option is not set to <literal>all</literal>, but deactivating could be "
4233 "useful if you want to run APT multiple times in a row - e.g. in an "
4234 "installer. In these sceneries you could deactivate this option in all but "
4238 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4239 #: apt.conf.5.xml:695
4241 "Useful for <literal>smart</literal> configuration as a package which has "
4242 "pending triggers is not considered as <literal>installed</literal> and dpkg "
4243 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
4244 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
4245 "triggers, not only the triggers needed to configure this package."
4248 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4249 #: apt.conf.5.xml:701
4251 "As the configuration can be deferred to be done at the end by dpkg it can be "
4252 "tried to order the unpack series only by critical needs, e.g. by "
4253 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
4254 "various steps by everything. While both method were present in earlier APT "
4255 "versions the <literal>OrderCritical</literal> method was unused, so this "
4256 "method is very experimental and needs further improvements before becoming "
4260 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
4261 #: apt.conf.5.xml:716
4264 "OrderList::Score {\n"
4266 "\tEssential 200;\n"
4268 "\tPreDepends 50;\n"
4272 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4273 #: apt.conf.5.xml:709
4275 "Essential packages (and there dependencies) should be configured immediately "
4276 "after unpacking. It will be a good idea to do this quite early in the "
4277 "upgrade process as these these configure calls require currently also "
4278 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
4279 "(which maybe not needed). Essentials get per default a high score but the "
4280 "immediate flag is relatively low (a package which has a Pre-Depends is "
4281 "higher rated). These option and the others in the same group can be used to "
4282 "change the scoring. The following example shows the settings with there "
4283 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
4286 #. type: Content of: <refentry><refsect1><title>
4287 #: apt.conf.5.xml:729
4288 msgid "Periodic and Archives options"
4291 #. type: Content of: <refentry><refsect1><para>
4292 #: apt.conf.5.xml:730
4294 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
4295 "of options configure behavior of apt periodic updates, which is done by "
4296 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
4297 "the brief documentation of these options."
4300 #. type: Content of: <refentry><refsect1><title>
4301 #: apt.conf.5.xml:738
4302 msgid "Debug options"
4305 #. type: Content of: <refentry><refsect1><para>
4306 #: apt.conf.5.xml:740
4308 "Enabling options in the <literal>Debug::</literal> section will cause "
4309 "debugging information to be sent to the standard error stream of the program "
4310 "utilizing the <literal>apt</literal> libraries, or enable special program "
4311 "modes that are primarily useful for debugging the behavior of "
4312 "<literal>apt</literal>. Most of these options are not interesting to a "
4313 "normal user, but a few may be:"
4316 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4317 #: apt.conf.5.xml:751
4319 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
4320 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
4324 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4325 #: apt.conf.5.xml:759
4327 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
4328 "used to run some operations (for instance, <literal>apt-get -s "
4329 "install</literal>) as a non-root user."
4332 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4333 #: apt.conf.5.xml:768
4335 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
4336 "time that <literal>apt</literal> invokes &dpkg;."
4340 #. motivating example, except I haven't a clue why you'd want
4342 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4343 #: apt.conf.5.xml:776
4345 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
4349 #. type: Content of: <refentry><refsect1><para>
4350 #: apt.conf.5.xml:786
4351 msgid "A full list of debugging options to apt follows."
4354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4355 #: apt.conf.5.xml:795
4356 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
4359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4360 #: apt.conf.5.xml:806
4361 msgid "Print information related to downloading packages using FTP."
4364 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4365 #: apt.conf.5.xml:817
4366 msgid "Print information related to downloading packages using HTTP."
4369 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4370 #: apt.conf.5.xml:828
4371 msgid "Print information related to downloading packages using HTTPS."
4374 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4375 #: apt.conf.5.xml:839
4377 "Print information related to verifying cryptographic signatures using "
4378 "<literal>gpg</literal>."
4381 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4382 #: apt.conf.5.xml:850
4384 "Output information about the process of accessing collections of packages "
4385 "stored on CD-ROMs."
4388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4389 #: apt.conf.5.xml:860
4390 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4393 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4394 #: apt.conf.5.xml:870
4396 "Output each cryptographic hash that is generated by the "
4397 "<literal>apt</literal> libraries."
4400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4401 #: apt.conf.5.xml:880
4403 "Do not include information from <literal>statfs</literal>, namely the number "
4404 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4408 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4409 #: apt.conf.5.xml:891
4411 "Disable all file locking. For instance, this will allow two instances of "
4412 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4415 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4416 #: apt.conf.5.xml:903
4417 msgid "Log when items are added to or removed from the global download queue."
4420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4421 #: apt.conf.5.xml:913
4423 "Output status messages and errors related to verifying checksums and "
4424 "cryptographic signatures of downloaded files."
4427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4428 #: apt.conf.5.xml:923
4430 "Output information about downloading and applying package index list diffs, "
4431 "and errors relating to package index list diffs."
4434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4435 #: apt.conf.5.xml:935
4437 "Output information related to patching apt package lists when downloading "
4438 "index diffs instead of full indices."
4441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4442 #: apt.conf.5.xml:946
4443 msgid "Log all interactions with the sub-processes that actually perform downloads."
4446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4447 #: apt.conf.5.xml:957
4449 "Log events related to the automatically-installed status of packages and to "
4450 "the removal of unused packages."
4453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4454 #: apt.conf.5.xml:967
4456 "Generate debug messages describing which packages are being automatically "
4457 "installed to resolve dependencies. This corresponds to the initial "
4458 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4459 "and not to the full <literal>apt</literal> dependency resolver; see "
4460 "<literal>Debug::pkgProblemResolver</literal> for that."
4463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4464 #: apt.conf.5.xml:981
4466 "Generate debug messages describing which package is marked as "
4467 "keep/install/remove while the ProblemResolver does his work. Each addition "
4468 "or deletion may trigger additional actions; they are shown indented two "
4469 "additional space under the original entry. The format for each line is "
4470 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4471 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4472 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4473 "is the current version of the package, <literal>d.e.f</literal> is the "
4474 "version considered for installation and <literal>x.y.z</literal> is a newer "
4475 "version, but not considered for installation (because of a low pin "
4476 "score). The later two can be omitted if there is none or if it is the same "
4477 "version as the installed. <literal>section</literal> is the name of the "
4478 "section the package appears in."
4481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4482 #: apt.conf.5.xml:1003
4483 msgid "Dump the default configuration to standard error on startup."
4486 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4487 #: apt.conf.5.xml:1013
4489 "When invoking &dpkg;, output the precise command line with which it is being "
4490 "invoked, with arguments separated by a single space character."
4493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4494 #: apt.conf.5.xml:1024
4496 "Output all the data received from &dpkg; on the status file descriptor and "
4497 "any errors encountered while parsing it."
4500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4501 #: apt.conf.5.xml:1035
4503 "Generate a trace of the algorithm that decides the order in which "
4504 "<literal>apt</literal> should pass packages to &dpkg;."
4507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4508 #: apt.conf.5.xml:1047
4509 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4512 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4513 #: apt.conf.5.xml:1058
4514 msgid "Output the priority of each package list on startup."
4517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4518 #: apt.conf.5.xml:1068
4520 "Trace the execution of the dependency resolver (this applies only to what "
4521 "happens when a complex dependency problem is encountered)."
4524 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4525 #: apt.conf.5.xml:1079
4527 "Display a list of all installed packages with their calculated score used by "
4528 "the pkgProblemResolver. The description of the package is the same as "
4529 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4533 #: apt.conf.5.xml:1091
4535 "Print information about the vendors read from "
4536 "<filename>/etc/apt/vendors.list</filename>."
4539 #. type: Content of: <refentry><refsect1><para>
4540 #: apt.conf.5.xml:1114
4542 "&configureindex; is a configuration file showing example values for all "
4546 #. type: Content of: <refentry><refsect1><variablelist>
4547 #: apt.conf.5.xml:1121
4548 msgid "&file-aptconf;"
4551 #. ? reading apt.conf
4552 #. type: Content of: <refentry><refsect1><para>
4553 #: apt.conf.5.xml:1126
4554 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4557 #. The last update date
4558 #. type: Content of: <refentry><refentryinfo>
4559 #: apt_preferences.5.xml:16
4560 msgid "&apt-author.team; &apt-email; &apt-product;"
4563 #. type: Content of: <refentry><refnamediv><refpurpose>
4564 #: apt_preferences.5.xml:32
4565 msgid "Preference control file for APT"
4568 #. type: Content of: <refentry><refsect1><para>
4569 #: apt_preferences.5.xml:37
4571 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4572 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4573 "can be used to control which versions of packages will be selected for "
4577 #. type: Content of: <refentry><refsect1><para>
4578 #: apt_preferences.5.xml:42
4580 "Several versions of a package may be available for installation when the "
4581 "&sources-list; file contains references to more than one distribution (for "
4582 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4583 "assigns a priority to each version that is available. Subject to dependency "
4584 "constraints, <command>apt-get</command> selects the version with the highest "
4585 "priority for installation. The APT preferences file overrides the "
4586 "priorities that APT assigns to package versions by default, thus giving the "
4587 "user control over which one is selected for installation."
4590 #. type: Content of: <refentry><refsect1><para>
4591 #: apt_preferences.5.xml:52
4593 "Several instances of the same version of a package may be available when the "
4594 "&sources-list; file contains references to more than one source. In this "
4595 "case <command>apt-get</command> downloads the instance listed earliest in "
4596 "the &sources-list; file. The APT preferences file does not affect the "
4597 "choice of instance, only the choice of version."
4600 #. type: Content of: <refentry><refsect1><para>
4601 #: apt_preferences.5.xml:59
4603 "Preferences are a strong power in the hands of a system administrator but "
4604 "they can become also their biggest nightmare if used without care! APT will "
4605 "not questioning the preferences so wrong settings will therefore lead to "
4606 "uninstallable packages or wrong decisions while upgrading packages. Even "
4607 "more problems will arise if multiply distribution releases are mixed without "
4608 "a good understanding of the following paragraphs. Packages included in a "
4609 "specific release aren't tested in and therefore doesn't always work as "
4610 "expected in older or newer releases or together with other packages from "
4611 "different releases. You have been warned."
4614 #. type: Content of: <refentry><refsect1><para>
4615 #: apt_preferences.5.xml:70
4617 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4618 "directory are parsed in alphanumeric ascending order and need to obey the "
4619 "following naming convention: The files have either no or "
4620 "\"<literal>pref</literal>\" as filename extension and only contain "
4621 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4622 "Otherwise APT will print a notice that it has ignored a file if the file "
4623 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4624 "configuration list - in this case it will be silently ignored."
4627 #. type: Content of: <refentry><refsect1><refsect2><title>
4628 #: apt_preferences.5.xml:79
4629 msgid "APT's Default Priority Assignments"
4632 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4633 #: apt_preferences.5.xml:94
4636 "<command>apt-get install -t testing "
4637 "<replaceable>some-package</replaceable></command>\n"
4640 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4641 #: apt_preferences.5.xml:97
4643 msgid "APT::Default-Release \"stable\";\n"
4646 #. type: Content of: <refentry><refsect1><refsect2><para>
4647 #: apt_preferences.5.xml:81
4649 "If there is no preferences file or if there is no entry in the file that "
4650 "applies to a particular version then the priority assigned to that version "
4651 "is the priority of the distribution to which that version belongs. It is "
4652 "possible to single out a distribution, \"the target release\", which "
4653 "receives a higher priority than other distributions do by default. The "
4654 "target release can be set on the <command>apt-get</command> command line or "
4655 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4656 "that this has precedence over any general priority you set in the "
4657 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4658 "specifically pinned packages. For example, <placeholder "
4659 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4663 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4664 #: apt_preferences.5.xml:106
4668 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4669 #: apt_preferences.5.xml:107
4671 "to the versions coming from archives which in their "
4672 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4673 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
4674 "<literal>experimental</literal> archive."
4677 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4678 #: apt_preferences.5.xml:113
4679 msgid "priority 100"
4682 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4683 #: apt_preferences.5.xml:114
4685 "to the version that is already installed (if any) and to the versions coming "
4686 "from archives which in their <filename>Release</filename> files are marked "
4687 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
4688 "backports archive since <literal>squeeze-backports</literal>."
4691 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4692 #: apt_preferences.5.xml:121
4693 msgid "priority 500"
4696 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4697 #: apt_preferences.5.xml:122
4699 "to the versions that are not installed and do not belong to the target "
4703 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4704 #: apt_preferences.5.xml:126
4705 msgid "priority 990"
4708 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4709 #: apt_preferences.5.xml:127
4710 msgid "to the versions that are not installed and belong to the target release."
4713 #. type: Content of: <refentry><refsect1><refsect2><para>
4714 #: apt_preferences.5.xml:101
4716 "If the target release has been specified then APT uses the following "
4717 "algorithm to set the priorities of the versions of a package. Assign: "
4718 "<placeholder type=\"variablelist\" id=\"0\"/>"
4721 #. type: Content of: <refentry><refsect1><refsect2><para>
4722 #: apt_preferences.5.xml:132
4724 "If the target release has not been specified then APT simply assigns "
4725 "priority 100 to all installed package versions and priority 500 to all "
4726 "uninstalled package versions, except versions coming from archives which in "
4727 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4728 "- these versions get the priority 1 or priority 100 if it is additionally "
4729 "marked as \"ButAutomaticUpgrades: yes\"."
4732 #. type: Content of: <refentry><refsect1><refsect2><para>
4733 #: apt_preferences.5.xml:139
4735 "APT then applies the following rules, listed in order of precedence, to "
4736 "determine which version of a package to install."
4739 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4740 #: apt_preferences.5.xml:142
4742 "Never downgrade unless the priority of an available version exceeds 1000. "
4743 "(\"Downgrading\" is installing a less recent version of a package in place "
4744 "of a more recent version. Note that none of APT's default priorities "
4745 "exceeds 1000; such high priorities can only be set in the preferences file. "
4746 "Note also that downgrading a package can be risky.)"
4749 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4750 #: apt_preferences.5.xml:148
4751 msgid "Install the highest priority version."
4754 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4755 #: apt_preferences.5.xml:149
4757 "If two or more versions have the same priority, install the most recent one "
4758 "(that is, the one with the higher version number)."
4761 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4762 #: apt_preferences.5.xml:152
4764 "If two or more versions have the same priority and version number but either "
4765 "the packages differ in some of their metadata or the "
4766 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4769 #. type: Content of: <refentry><refsect1><refsect2><para>
4770 #: apt_preferences.5.xml:158
4772 "In a typical situation, the installed version of a package (priority 100) "
4773 "is not as recent as one of the versions available from the sources listed in "
4774 "the &sources-list; file (priority 500 or 990). Then the package will be "
4775 "upgraded when <command>apt-get install "
4776 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4777 "upgrade</command> is executed."
4780 #. type: Content of: <refentry><refsect1><refsect2><para>
4781 #: apt_preferences.5.xml:165
4783 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4784 "recent than any of the other available versions. The package will not be "
4785 "downgraded when <command>apt-get install "
4786 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4787 "upgrade</command> is executed."
4790 #. type: Content of: <refentry><refsect1><refsect2><para>
4791 #: apt_preferences.5.xml:170
4793 "Sometimes the installed version of a package is more recent than the version "
4794 "belonging to the target release, but not as recent as a version belonging to "
4795 "some other distribution. Such a package will indeed be upgraded when "
4796 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4797 "or <command>apt-get upgrade</command> is executed, because at least "
4798 "<emphasis>one</emphasis> of the available versions has a higher priority "
4799 "than the installed version."
4802 #. type: Content of: <refentry><refsect1><refsect2><title>
4803 #: apt_preferences.5.xml:179
4804 msgid "The Effect of APT Preferences"
4807 #. type: Content of: <refentry><refsect1><refsect2><para>
4808 #: apt_preferences.5.xml:181
4810 "The APT preferences file allows the system administrator to control the "
4811 "assignment of priorities. The file consists of one or more multi-line "
4812 "records separated by blank lines. Records can have one of two forms, a "
4813 "specific form and a general form."
4816 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4817 #: apt_preferences.5.xml:187
4819 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4820 "specified packages and specified version or version range. For example, the "
4821 "following record assigns a high priority to all versions of the "
4822 "<filename>perl</filename> package whose version number begins with "
4823 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
4826 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4827 #: apt_preferences.5.xml:194
4831 "Pin: version 5.8*\n"
4832 "Pin-Priority: 1001\n"
4835 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4836 #: apt_preferences.5.xml:200
4838 "The general form assigns a priority to all of the package versions in a "
4839 "given distribution (that is, to all the versions of packages that are listed "
4840 "in a certain <filename>Release</filename> file) or to all of the package "
4841 "versions coming from a particular Internet site, as identified by the site's "
4842 "fully qualified domain name."
4845 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4846 #: apt_preferences.5.xml:206
4848 "This general-form entry in the APT preferences file applies only to groups "
4849 "of packages. For example, the following record assigns a high priority to "
4850 "all package versions available from the local site."
4853 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4854 #: apt_preferences.5.xml:211
4858 "Pin: origin \"\"\n"
4859 "Pin-Priority: 999\n"
4862 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4863 #: apt_preferences.5.xml:216
4865 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4866 "which can be used to match a hostname. The following record will assign a "
4867 "high priority to all versions available from the server identified by the "
4868 "hostname \"ftp.de.debian.org\""
4871 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4872 #: apt_preferences.5.xml:220
4876 "Pin: origin \"ftp.de.debian.org\"\n"
4877 "Pin-Priority: 999\n"
4880 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4881 #: apt_preferences.5.xml:224
4883 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4884 "distribution as specified in a <filename>Release</filename> file. What "
4885 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4886 "Internet address but an author or vendor name, such as \"Debian\" or "
4890 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4891 #: apt_preferences.5.xml:229
4893 "The following record assigns a low priority to all package versions "
4894 "belonging to any distribution whose Archive name is "
4895 "\"<literal>unstable</literal>\"."
4898 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4899 #: apt_preferences.5.xml:233
4903 "Pin: release a=unstable\n"
4904 "Pin-Priority: 50\n"
4907 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4908 #: apt_preferences.5.xml:238
4910 "The following record assigns a high priority to all package versions "
4911 "belonging to any distribution whose Codename is "
4912 "\"<literal>&testing-codename;</literal>\"."
4915 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4916 #: apt_preferences.5.xml:242
4920 "Pin: release n=&testing-codename;\n"
4921 "Pin-Priority: 900\n"
4924 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4925 #: apt_preferences.5.xml:247
4927 "The following record assigns a high priority to all package versions "
4928 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4929 "and whose release Version number is \"<literal>3.0</literal>\"."
4932 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4933 #: apt_preferences.5.xml:252
4937 "Pin: release a=stable, v=3.0\n"
4938 "Pin-Priority: 500\n"
4941 #. type: Content of: <refentry><refsect1><refsect2><title>
4942 #: apt_preferences.5.xml:262
4943 msgid "Regular expressions and glob() syntax"
4946 #. type: Content of: <refentry><refsect1><refsect2><para>
4947 #: apt_preferences.5.xml:264
4949 "APT also supports pinning by glob() expressions and regular expressions "
4950 "surrounded by /. For example, the following example assigns the priority 500 "
4951 "to all packages from experimental where the name starts with gnome (as a "
4952 "glob()-like expression) or contains the word kde (as a POSIX extended "
4953 "regular expression surrounded by slashes)."
4956 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4957 #: apt_preferences.5.xml:273
4960 "Package: gnome* /kde/\n"
4961 "Pin: release n=experimental\n"
4962 "Pin-Priority: 500\n"
4965 #. type: Content of: <refentry><refsect1><refsect2><para>
4966 #: apt_preferences.5.xml:279
4968 "The rule for those expressions is that they can occur anywhere where a "
4969 "string can occur. Thus, the following pin assigns the priority 990 to all "
4970 "packages from a release starting with karmic."
4973 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4974 #: apt_preferences.5.xml:285
4978 "Pin: release n=karmic*\n"
4979 "Pin-Priority: 990\n"
4982 #. type: Content of: <refentry><refsect1><refsect2><para>
4983 #: apt_preferences.5.xml:291
4985 "If a regular expression occurs in a <literal>Package</literal> field, the "
4986 "behavior is the same as if this regular expression were replaced with a list "
4987 "of all package names it matches. It is undecided whether this will change in "
4988 "the future, thus you should always list wild-card pins first, so later "
4989 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4990 "Package field is not considered a glob() expression in itself."
4993 #. type: Content of: <refentry><refsect1><refsect2><title>
4994 #: apt_preferences.5.xml:307
4995 msgid "How APT Interprets Priorities"
4998 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4999 #: apt_preferences.5.xml:315
5003 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5004 #: apt_preferences.5.xml:316
5006 "causes a version to be installed even if this constitutes a downgrade of the "
5010 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5011 #: apt_preferences.5.xml:320
5012 msgid "990 < P <=1000"
5015 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5016 #: apt_preferences.5.xml:321
5018 "causes a version to be installed even if it does not come from the target "
5019 "release, unless the installed version is more recent"
5022 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5023 #: apt_preferences.5.xml:326
5024 msgid "500 < P <=990"
5027 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5028 #: apt_preferences.5.xml:327
5030 "causes a version to be installed unless there is a version available "
5031 "belonging to the target release or the installed version is more recent"
5034 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5035 #: apt_preferences.5.xml:332
5036 msgid "100 < P <=500"
5039 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5040 #: apt_preferences.5.xml:333
5042 "causes a version to be installed unless there is a version available "
5043 "belonging to some other distribution or the installed version is more recent"
5046 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5047 #: apt_preferences.5.xml:338
5048 msgid "0 < P <=100"
5051 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5052 #: apt_preferences.5.xml:339
5054 "causes a version to be installed only if there is no installed version of "
5058 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5059 #: apt_preferences.5.xml:343
5063 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5064 #: apt_preferences.5.xml:344
5065 msgid "prevents the version from being installed"
5068 #. type: Content of: <refentry><refsect1><refsect2><para>
5069 #: apt_preferences.5.xml:310
5071 "Priorities (P) assigned in the APT preferences file must be positive or "
5072 "negative integers. They are interpreted as follows (roughly speaking): "
5073 "<placeholder type=\"variablelist\" id=\"0\"/>"
5076 #. type: Content of: <refentry><refsect1><refsect2><para>
5077 #: apt_preferences.5.xml:349
5079 "If any specific-form records match an available package version then the "
5080 "first such record determines the priority of the package version. Failing "
5081 "that, if any general-form records match an available package version then "
5082 "the first such record determines the priority of the package version."
5085 #. type: Content of: <refentry><refsect1><refsect2><para>
5086 #: apt_preferences.5.xml:355
5088 "For example, suppose the APT preferences file contains the three records "
5089 "presented earlier:"
5092 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5093 #: apt_preferences.5.xml:359
5097 "Pin: version 5.8*\n"
5098 "Pin-Priority: 1001\n"
5101 "Pin: origin \"\"\n"
5102 "Pin-Priority: 999\n"
5105 "Pin: release unstable\n"
5106 "Pin-Priority: 50\n"
5109 #. type: Content of: <refentry><refsect1><refsect2><para>
5110 #: apt_preferences.5.xml:372
5114 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5115 #: apt_preferences.5.xml:374
5117 "The most recent available version of the <literal>perl</literal> package "
5118 "will be installed, so long as that version's version number begins with "
5119 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
5120 "<literal>perl</literal> is available and the installed version is 5.9*, then "
5121 "<literal>perl</literal> will be downgraded."
5124 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5125 #: apt_preferences.5.xml:379
5127 "A version of any package other than <literal>perl</literal> that is "
5128 "available from the local system has priority over other versions, even "
5129 "versions belonging to the target release."
5132 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5133 #: apt_preferences.5.xml:383
5135 "A version of a package whose origin is not the local system but some other "
5136 "site listed in &sources-list; and which belongs to an "
5137 "<literal>unstable</literal> distribution is only installed if it is selected "
5138 "for installation and no version of the package is already installed."
5141 #. type: Content of: <refentry><refsect1><refsect2><title>
5142 #: apt_preferences.5.xml:393
5143 msgid "Determination of Package Version and Distribution Properties"
5146 #. type: Content of: <refentry><refsect1><refsect2><para>
5147 #: apt_preferences.5.xml:395
5149 "The locations listed in the &sources-list; file should provide "
5150 "<filename>Packages</filename> and <filename>Release</filename> files to "
5151 "describe the packages available at that location."
5154 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5155 #: apt_preferences.5.xml:407
5156 msgid "the <literal>Package:</literal> line"
5159 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5160 #: apt_preferences.5.xml:408
5161 msgid "gives the package name"
5164 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5165 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
5166 msgid "the <literal>Version:</literal> line"
5169 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5170 #: apt_preferences.5.xml:412
5171 msgid "gives the version number for the named package"
5174 #. type: Content of: <refentry><refsect1><refsect2><para>
5175 #: apt_preferences.5.xml:399
5177 "The <filename>Packages</filename> file is normally found in the directory "
5178 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
5180 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
5181 "consists of a series of multi-line records, one for each package available "
5182 "in that directory. Only two lines in each record are relevant for setting "
5183 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
5186 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5187 #: apt_preferences.5.xml:428
5188 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
5191 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5192 #: apt_preferences.5.xml:429
5194 "names the archive to which all the packages in the directory tree belong. "
5195 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
5196 "that all of the packages in the directory tree below the parent of the "
5197 "<filename>Release</filename> file are in a <literal>stable</literal> "
5198 "archive. Specifying this value in the APT preferences file would require "
5202 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5203 #: apt_preferences.5.xml:439
5205 msgid "Pin: release a=stable\n"
5208 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5209 #: apt_preferences.5.xml:445
5210 msgid "the <literal>Codename:</literal> line"
5213 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5214 #: apt_preferences.5.xml:446
5216 "names the codename to which all the packages in the directory tree belong. "
5217 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
5218 "the packages in the directory tree below the parent of the "
5219 "<filename>Release</filename> file belong to a version named "
5220 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
5221 "preferences file would require the line:"
5224 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5225 #: apt_preferences.5.xml:455
5227 msgid "Pin: release n=&testing-codename;\n"
5230 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5231 #: apt_preferences.5.xml:462
5233 "names the release version. For example, the packages in the tree might "
5234 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
5235 "no version number for the <literal>testing</literal> and "
5236 "<literal>unstable</literal> distributions because they have not been "
5237 "released yet. Specifying this in the APT preferences file would require one "
5238 "of the following lines."
5241 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5242 #: apt_preferences.5.xml:471
5245 "Pin: release v=3.0\n"
5246 "Pin: release a=stable, v=3.0\n"
5247 "Pin: release 3.0\n"
5250 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5251 #: apt_preferences.5.xml:480
5252 msgid "the <literal>Component:</literal> line"
5255 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5256 #: apt_preferences.5.xml:481
5258 "names the licensing component associated with the packages in the directory "
5259 "tree of the <filename>Release</filename> file. For example, the line "
5260 "\"Component: main\" specifies that all the packages in the directory tree "
5261 "are from the <literal>main</literal> component, which entails that they are "
5262 "licensed under terms listed in the Debian Free Software Guidelines. "
5263 "Specifying this component in the APT preferences file would require the "
5267 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5268 #: apt_preferences.5.xml:490
5270 msgid "Pin: release c=main\n"
5273 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5274 #: apt_preferences.5.xml:496
5275 msgid "the <literal>Origin:</literal> line"
5278 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5279 #: apt_preferences.5.xml:497
5281 "names the originator of the packages in the directory tree of the "
5282 "<filename>Release</filename> file. Most commonly, this is "
5283 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
5284 "file would require the line:"
5287 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5288 #: apt_preferences.5.xml:503
5290 msgid "Pin: release o=Debian\n"
5293 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5294 #: apt_preferences.5.xml:509
5295 msgid "the <literal>Label:</literal> line"
5298 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5299 #: apt_preferences.5.xml:510
5301 "names the label of the packages in the directory tree of the "
5302 "<filename>Release</filename> file. Most commonly, this is "
5303 "<literal>Debian</literal>. Specifying this label in the APT preferences "
5304 "file would require the line:"
5307 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5308 #: apt_preferences.5.xml:516
5310 msgid "Pin: release l=Debian\n"
5313 #. type: Content of: <refentry><refsect1><refsect2><para>
5314 #: apt_preferences.5.xml:417
5316 "The <filename>Release</filename> file is normally found in the directory "
5317 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
5318 "example, <filename>.../dists/stable/Release</filename>, or "
5319 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
5320 "single multi-line record which applies to <emphasis>all</emphasis> of the "
5321 "packages in the directory tree below its parent. Unlike the "
5322 "<filename>Packages</filename> file, nearly all of the lines in a "
5323 "<filename>Release</filename> file are relevant for setting APT priorities: "
5324 "<placeholder type=\"variablelist\" id=\"0\"/>"
5327 #. type: Content of: <refentry><refsect1><refsect2><para>
5328 #: apt_preferences.5.xml:523
5330 "All of the <filename>Packages</filename> and <filename>Release</filename> "
5331 "files retrieved from locations listed in the &sources-list; file are stored "
5332 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
5333 "named by the variable <literal>Dir::State::Lists</literal> in the "
5334 "<filename>apt.conf</filename> file. For example, the file "
5335 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
5336 "contains the <filename>Release</filename> file retrieved from the site "
5337 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5338 "architecture files from the <literal>contrib</literal> component of the "
5339 "<literal>unstable</literal> distribution."
5342 #. type: Content of: <refentry><refsect1><refsect2><title>
5343 #: apt_preferences.5.xml:536
5344 msgid "Optional Lines in an APT Preferences Record"
5347 #. type: Content of: <refentry><refsect1><refsect2><para>
5348 #: apt_preferences.5.xml:538
5350 "Each record in the APT preferences file can optionally begin with one or "
5351 "more lines beginning with the word <literal>Explanation:</literal>. This "
5352 "provides a place for comments."
5355 #. type: Content of: <refentry><refsect1><refsect2><title>
5356 #: apt_preferences.5.xml:547
5357 msgid "Tracking Stable"
5360 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5361 #: apt_preferences.5.xml:555
5364 "Explanation: Uninstall or do not install any Debian-originated\n"
5365 "Explanation: package versions other than those in the stable distro\n"
5367 "Pin: release a=stable\n"
5368 "Pin-Priority: 900\n"
5371 "Pin: release o=Debian\n"
5372 "Pin-Priority: -10\n"
5375 #. type: Content of: <refentry><refsect1><refsect2><para>
5376 #: apt_preferences.5.xml:549
5378 "The following APT preferences file will cause APT to assign a priority "
5379 "higher than the default (500) to all package versions belonging to a "
5380 "<literal>stable</literal> distribution and a prohibitively low priority to "
5381 "package versions belonging to other <literal>Debian</literal> "
5382 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5385 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5386 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
5389 "apt-get install <replaceable>package-name</replaceable>\n"
5391 "apt-get dist-upgrade\n"
5394 #. type: Content of: <refentry><refsect1><refsect2><para>
5395 #: apt_preferences.5.xml:567
5397 "With a suitable &sources-list; file and the above preferences file, any of "
5398 "the following commands will cause APT to upgrade to the latest "
5399 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5403 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5404 #: apt_preferences.5.xml:584
5406 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5409 #. type: Content of: <refentry><refsect1><refsect2><para>
5410 #: apt_preferences.5.xml:578
5412 "The following command will cause APT to upgrade the specified package to the "
5413 "latest version from the <literal>testing</literal> distribution; the package "
5414 "will not be upgraded again unless this command is given again. <placeholder "
5415 "type=\"programlisting\" id=\"0\"/>"
5418 #. type: Content of: <refentry><refsect1><refsect2><title>
5419 #: apt_preferences.5.xml:590
5420 msgid "Tracking Testing or Unstable"
5423 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5424 #: apt_preferences.5.xml:599
5428 "Pin: release a=testing\n"
5429 "Pin-Priority: 900\n"
5432 "Pin: release a=unstable\n"
5433 "Pin-Priority: 800\n"
5436 "Pin: release o=Debian\n"
5437 "Pin-Priority: -10\n"
5440 #. type: Content of: <refentry><refsect1><refsect2><para>
5441 #: apt_preferences.5.xml:592
5443 "The following APT preferences file will cause APT to assign a high priority "
5444 "to package versions from the <literal>testing</literal> distribution, a "
5445 "lower priority to package versions from the <literal>unstable</literal> "
5446 "distribution, and a prohibitively low priority to package versions from "
5447 "other <literal>Debian</literal> distributions. <placeholder "
5448 "type=\"programlisting\" id=\"0\"/>"
5451 #. type: Content of: <refentry><refsect1><refsect2><para>
5452 #: apt_preferences.5.xml:613
5454 "With a suitable &sources-list; file and the above preferences file, any of "
5455 "the following commands will cause APT to upgrade to the latest "
5456 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5460 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5461 #: apt_preferences.5.xml:633
5463 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5466 #. type: Content of: <refentry><refsect1><refsect2><para>
5467 #: apt_preferences.5.xml:624
5469 "The following command will cause APT to upgrade the specified package to the "
5470 "latest version from the <literal>unstable</literal> distribution. "
5471 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5472 "the most recent <literal>testing</literal> version if that is more recent "
5473 "than the installed version, otherwise, to the most recent "
5474 "<literal>unstable</literal> version if that is more recent than the "
5475 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5478 #. type: Content of: <refentry><refsect1><refsect2><title>
5479 #: apt_preferences.5.xml:640
5480 msgid "Tracking the evolution of a codename release"
5483 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5484 #: apt_preferences.5.xml:654
5487 "Explanation: Uninstall or do not install any Debian-originated package "
5489 "Explanation: other than those in the distribution codenamed with "
5490 "&testing-codename; or sid\n"
5492 "Pin: release n=&testing-codename;\n"
5493 "Pin-Priority: 900\n"
5495 "Explanation: Debian unstable is always codenamed with sid\n"
5497 "Pin: release n=sid\n"
5498 "Pin-Priority: 800\n"
5501 "Pin: release o=Debian\n"
5502 "Pin-Priority: -10\n"
5505 #. type: Content of: <refentry><refsect1><refsect2><para>
5506 #: apt_preferences.5.xml:642
5508 "The following APT preferences file will cause APT to assign a priority "
5509 "higher than the default (500) to all package versions belonging to a "
5510 "specified codename of a distribution and a prohibitively low priority to "
5511 "package versions belonging to other <literal>Debian</literal> distributions, "
5512 "codenames and archives. Note that with this APT preference APT will follow "
5513 "the migration of a release from the archive <literal>testing</literal> to "
5514 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5515 "want to follow for example the progress in <literal>testing</literal> "
5516 "notwithstanding the codename changes you should use the example "
5517 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5520 #. type: Content of: <refentry><refsect1><refsect2><para>
5521 #: apt_preferences.5.xml:671
5523 "With a suitable &sources-list; file and the above preferences file, any of "
5524 "the following commands will cause APT to upgrade to the latest version(s) in "
5525 "the release codenamed with <literal>&testing-codename;</literal>. "
5526 "<placeholder type=\"programlisting\" id=\"0\"/>"
5529 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5530 #: apt_preferences.5.xml:691
5532 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5535 #. type: Content of: <refentry><refsect1><refsect2><para>
5536 #: apt_preferences.5.xml:682
5538 "The following command will cause APT to upgrade the specified package to the "
5539 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5540 "<command>apt-get upgrade</command> will upgrade the package to the most "
5541 "recent <literal>&testing-codename;</literal> version if that is more recent "
5542 "than the installed version, otherwise, to the most recent "
5543 "<literal>sid</literal> version if that is more recent than the installed "
5544 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5547 #. type: Content of: <refentry><refsect1><variablelist>
5548 #: apt_preferences.5.xml:700
5549 msgid "&file-preferences;"
5552 #. type: Content of: <refentry><refsect1><para>
5553 #: apt_preferences.5.xml:706
5554 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5557 #. type: Content of: <refentry><refnamediv><refpurpose>
5558 #: sources.list.5.xml:33
5559 msgid "Package resource list for APT"
5562 #. type: Content of: <refentry><refsect1><para>
5563 #: sources.list.5.xml:37
5565 "The package resource list is used to locate archives of the package "
5566 "distribution system in use on the system. At this time, this manual page "
5567 "documents only the packaging system used by the Debian GNU/Linux system. "
5568 "This control file is <filename>/etc/apt/sources.list</filename>."
5571 #. type: Content of: <refentry><refsect1><para>
5572 #: sources.list.5.xml:42
5574 "The source list is designed to support any number of active sources and a "
5575 "variety of source media. The file lists one source per line, with the most "
5576 "preferred source listed first. The format of each line is: <literal>type uri "
5577 "args</literal> The first item, <literal>type</literal> determines the format "
5578 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
5579 "Identifier (URI), which is a superset of the more specific and well-known "
5580 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
5581 "comment by using a #."
5584 #. type: Content of: <refentry><refsect1><title>
5585 #: sources.list.5.xml:53
5586 msgid "sources.list.d"
5589 #. type: Content of: <refentry><refsect1><para>
5590 #: sources.list.5.xml:54
5592 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5593 "add sources.list entries in separate files. The format is the same as for "
5594 "the regular <filename>sources.list</filename> file. File names need to end "
5595 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
5596 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
5597 "Otherwise APT will print a notice that it has ignored a file if the file "
5598 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5599 "configuration list - in this case it will be silently ignored."
5602 #. type: Content of: <refentry><refsect1><title>
5603 #: sources.list.5.xml:65
5604 msgid "The deb and deb-src types"
5607 #. type: Content of: <refentry><refsect1><para>
5608 #: sources.list.5.xml:66
5610 "The <literal>deb</literal> type describes a typical two-level Debian "
5611 "archive, <filename>distribution/component</filename>. Typically, "
5612 "<literal>distribution</literal> is generally an archivename like "
5613 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5614 "<literal>&stable-codename;</literal> or "
5615 "<literal>&testing-codename;</literal> while component is one of "
5616 "<literal>main</literal> <literal>contrib</literal> or "
5617 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
5618 "debian distribution's source code in the same form as the "
5619 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5620 "to fetch source indexes."
5623 #. type: Content of: <refentry><refsect1><para>
5624 #: sources.list.5.xml:78
5626 "The format for a <filename>sources.list</filename> entry using the "
5627 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
5630 #. type: Content of: <refentry><refsect1><literallayout>
5631 #: sources.list.5.xml:81
5633 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
5636 #. type: Content of: <refentry><refsect1><para>
5637 #: sources.list.5.xml:83
5639 "The URI for the <literal>deb</literal> type must specify the base of the "
5640 "Debian distribution, from which APT will find the information it needs. "
5641 "<literal>distribution</literal> can specify an exact path, in which case the "
5642 "components must be omitted and <literal>distribution</literal> must end with "
5643 "a slash (/). This is useful for when the case only a particular sub-section "
5644 "of the archive denoted by the URI is of interest. If "
5645 "<literal>distribution</literal> does not specify an exact path, at least one "
5646 "<literal>component</literal> must be present."
5649 #. type: Content of: <refentry><refsect1><para>
5650 #: sources.list.5.xml:92
5652 "<literal>distribution</literal> may also contain a variable, "
5653 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
5654 "m68k, powerpc, ...) used on the system. This permits "
5655 "architecture-independent <filename>sources.list</filename> files to be "
5656 "used. In general this is only of interest when specifying an exact path, "
5657 "<literal>APT</literal> will automatically generate a URI with the current "
5658 "architecture otherwise."
5661 #. type: Content of: <refentry><refsect1><para>
5662 #: sources.list.5.xml:100
5664 "Since only one distribution can be specified per line it may be necessary to "
5665 "have multiple lines for the same URI, if a subset of all available "
5666 "distributions or components at that location is desired. APT will sort the "
5667 "URI list after it has generated a complete set internally, and will collapse "
5668 "multiple references to the same Internet host, for instance, into a single "
5669 "connection, so that it does not inefficiently establish an FTP connection, "
5670 "close it, do something else, and then re-establish a connection to that same "
5671 "host. This feature is useful for accessing busy FTP sites with limits on the "
5672 "number of simultaneous anonymous users. APT also parallelizes connections to "
5673 "different hosts to more effectively deal with sites with low bandwidth."
5676 #. type: Content of: <refentry><refsect1><para>
5677 #: sources.list.5.xml:112
5679 "<literal>options</literal> is always optional and needs to be surounded by "
5680 "square brackets. It can consist of multiple settings in the form "
5681 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
5682 "Multiple settings are separated by spaces. The following settings are "
5683 "supported by APT, note though that unsupported settings will be ignored "
5687 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5688 #: sources.list.5.xml:117
5690 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
5691 "can be used to specify for which architectures packages information should "
5692 "be downloaded. If this option is not set all architectures defined by the "
5693 "<literal>APT::Architectures</literal> option will be downloaded."
5696 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5697 #: sources.list.5.xml:121
5699 "<literal>trusted=yes</literal> can be set to indicate that packages from "
5700 "this source are always authenticated even if the "
5701 "<filename>Release</filename> file is not signed or the signature can't be "
5702 "checked. This disables parts of &apt-secure; and should therefore only be "
5703 "used in a local and trusted context. <literal>trusted=no</literal> is the "
5704 "opposite which handles even correctly authenticated sources as not "
5708 #. type: Content of: <refentry><refsect1><para>
5709 #: sources.list.5.xml:128
5711 "It is important to list sources in order of preference, with the most "
5712 "preferred source listed first. Typically this will result in sorting by "
5713 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5714 "followed by distant Internet hosts, for example)."
5717 #. type: Content of: <refentry><refsect1><para>
5718 #: sources.list.5.xml:133
5719 msgid "Some examples:"
5722 #. type: Content of: <refentry><refsect1><literallayout>
5723 #: sources.list.5.xml:135
5726 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5727 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5732 #. type: Content of: <refentry><refsect1><title>
5733 #: sources.list.5.xml:141
5734 msgid "URI specification"
5737 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5738 #: sources.list.5.xml:146
5742 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5743 #: sources.list.5.xml:148
5745 "The file scheme allows an arbitrary directory in the file system to be "
5746 "considered an archive. This is useful for NFS mounts and local mirrors or "
5750 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5751 #: sources.list.5.xml:153
5755 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5756 #: sources.list.5.xml:155
5758 "The cdrom scheme allows APT to use a local CDROM drive with media "
5759 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5763 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5764 #: sources.list.5.xml:160
5768 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5769 #: sources.list.5.xml:162
5771 "The http scheme specifies an HTTP server for the archive. If an environment "
5772 "variable <envar>http_proxy</envar> is set with the format "
5773 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5774 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5775 "the format http://user:pass@server:port/. Note that this is an insecure "
5776 "method of authentication."
5779 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5780 #: sources.list.5.xml:171
5784 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5785 #: sources.list.5.xml:173
5787 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5788 "is highly configurable; for more information see the &apt-conf; manual "
5789 "page. Please note that a ftp proxy can be specified by using the "
5790 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
5791 "http proxy (http proxy servers often understand ftp urls) using this method "
5792 "and ONLY this method. ftp proxies using http specified in the configuration "
5793 "file will be ignored."
5796 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5797 #: sources.list.5.xml:182
5801 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5802 #: sources.list.5.xml:184
5804 "The copy scheme is identical to the file scheme except that packages are "
5805 "copied into the cache directory instead of used directly at their location. "
5806 "This is useful for people using a zip disk to copy files around with APT."
5809 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5810 #: sources.list.5.xml:189
5814 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5815 #: sources.list.5.xml:189
5819 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5820 #: sources.list.5.xml:191
5822 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
5823 "user and access the files. It is a good idea to do prior arrangements with "
5824 "RSA keys or rhosts. Access to files on the remote uses standard "
5825 "<command>find</command> and <command>dd</command> commands to perform the "
5826 "file transfers from the remote."
5829 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5830 #: sources.list.5.xml:199
5831 msgid "more recognizable URI types"
5834 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5835 #: sources.list.5.xml:201
5837 "APT can be extended with more methods shipped in other optional packages "
5838 "which should follow the nameing scheme "
5839 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
5840 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
5841 "which provides access methods for https-URIs with features similar to the "
5842 "http method, but other methods for using e.g. debtorrent are also available, "
5843 "see <citerefentry> "
5844 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
5845 "<manvolnum>1</manvolnum></citerefentry>."
5848 #. type: Content of: <refentry><refsect1><para>
5849 #: sources.list.5.xml:143
5851 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
5852 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
5855 #. type: Content of: <refentry><refsect1><para>
5856 #: sources.list.5.xml:215
5858 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5859 "stable/main, stable/contrib, and stable/non-free."
5862 #. type: Content of: <refentry><refsect1><literallayout>
5863 #: sources.list.5.xml:217
5865 msgid "deb file:/home/jason/debian stable main contrib non-free"
5868 #. type: Content of: <refentry><refsect1><para>
5869 #: sources.list.5.xml:219
5870 msgid "As above, except this uses the unstable (development) distribution."
5873 #. type: Content of: <refentry><refsect1><literallayout>
5874 #: sources.list.5.xml:220
5876 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5879 #. type: Content of: <refentry><refsect1><para>
5880 #: sources.list.5.xml:222
5881 msgid "Source line for the above"
5884 #. type: Content of: <refentry><refsect1><literallayout>
5885 #: sources.list.5.xml:223
5887 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5890 #. type: Content of: <refentry><refsect1><para>
5891 #: sources.list.5.xml:225
5893 "The first line gets package information for the architectures in "
5894 "<literal>APT::Architectures</literal> while the second always retrieves "
5895 "<literal>amd64</literal> and <literal>armel</literal>."
5898 #. type: Content of: <refentry><refsect1><literallayout>
5899 #: sources.list.5.xml:227
5902 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5903 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5906 #. type: Content of: <refentry><refsect1><para>
5907 #: sources.list.5.xml:230
5909 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5913 #. type: Content of: <refentry><refsect1><literallayout>
5914 #: sources.list.5.xml:232
5916 msgid "deb http://archive.debian.org/debian-archive hamm main"
5919 #. type: Content of: <refentry><refsect1><para>
5920 #: sources.list.5.xml:234
5922 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5923 "directory, and uses only the &stable-codename;/contrib area."
5926 #. type: Content of: <refentry><refsect1><literallayout>
5927 #: sources.list.5.xml:236
5929 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5932 #. type: Content of: <refentry><refsect1><para>
5933 #: sources.list.5.xml:238
5935 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5936 "directory, and uses only the unstable/contrib area. If this line appears as "
5937 "well as the one in the previous example in <filename>sources.list</filename> "
5938 "a single FTP session will be used for both resource lines."
5941 #. type: Content of: <refentry><refsect1><literallayout>
5942 #: sources.list.5.xml:242
5944 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5947 #. type: Content of: <refentry><refsect1><para><literallayout>
5948 #: sources.list.5.xml:251
5950 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5953 #. type: Content of: <refentry><refsect1><para>
5954 #: sources.list.5.xml:244
5956 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5957 "directory, and uses only files found under "
5958 "<filename>unstable/binary-i386</filename> on i386 machines, "
5959 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5960 "supported architectures. [Note this example only illustrates how to use the "
5961 "substitution variable; official debian archives are not structured like "
5962 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5965 #. type: Content of: <refentry><refsect1><para>
5966 #: sources.list.5.xml:256
5967 msgid "&apt-cache; &apt-conf;"
5970 #. type: <title></title>
5972 msgid "APT User's Guide"
5975 #. type: <author></author>
5976 #: guide.sgml:6 offline.sgml:6
5977 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5980 #. type: <version></version>
5982 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5985 #. type: <abstract></abstract>
5988 "This document provides an overview of how to use the the APT package "
5992 #. type: <copyrightsummary></copyrightsummary>
5994 msgid "Copyright © Jason Gunthorpe, 1998."
5998 #: guide.sgml:21 offline.sgml:22
6000 "\"APT\" and this document are free software; you can redistribute them "
6001 "and/or modify them under the terms of the GNU General Public License as "
6002 "published by the Free Software Foundation; either version 2 of the License, "
6003 "or (at your option) any later version."
6007 #: guide.sgml:24 offline.sgml:25
6009 "For more details, on Debian GNU/Linux systems, see the file "
6010 "/usr/share/common-licenses/GPL for the full license."
6013 #. type: <heading></heading>
6021 "The APT package currently contains two sections, the APT "
6022 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
6023 "interface. Both provide a way to install and remove packages as well as "
6024 "download new packages from the Internet."
6027 #. type: <heading></heading>
6029 msgid "Anatomy of the Package System"
6035 "The Debian packaging system has a large amount of information associated "
6036 "with each package to help assure that it integrates cleanly and easily into "
6037 "the system. The most prominent of its features is the dependency system."
6043 "The dependency system allows individual programs to make use of shared "
6044 "elements in the system such as libraries. It simplifies placing infrequently "
6045 "used portions of a program in separate packages to reduce the number of "
6046 "things the average user is required to install. Also, it allows for choices "
6047 "in mail transport agents, X servers and so on."
6053 "The first step to understanding the dependency system is to grasp the "
6054 "concept of a simple dependency. The meaning of a simple dependency is that a "
6055 "package requires another package to be installed at the same time to work "
6062 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6063 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6064 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6065 "simple dependency on emacs, without emacs it is completely useless."
6071 "The other important dependency to understand is a conflicting dependency. It "
6072 "means that a package, when installed with another package, will not work and "
6073 "may possibly be extremely harmful to the system. As an example consider a "
6074 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6075 "have two mail transport agents installed because both need to listen to the "
6076 "network to receive mail. Attempting to install two will seriously damage the "
6077 "system so all mail transport agents have a conflicting dependency with all "
6078 "other mail transport agents."
6084 "As an added complication there is the possibility for a package to pretend "
6085 "to be another package. Consider that exim and sendmail for many intents are "
6086 "identical, they both deliver mail and understand a common interface. Hence, "
6087 "the package system has a way for them to declare that they are both "
6088 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6089 "a mail-transport-agent and other packages that need a mail transport agent "
6090 "depend on mail-transport-agent. This can add a great deal of confusion when "
6091 "trying to manually fix packages."
6097 "At any given time a single dependency may be met by packages that are "
6098 "already installed or it may not be. APT attempts to help resolve dependency "
6099 "issues by providing a number of automatic algorithms that help in selecting "
6100 "packages for installation."
6103 #. type: <heading></heading>
6111 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6112 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6113 "understand .deb files, it works with the package's proper name and can only "
6114 "install .deb archives from a <em>Source</em>."
6120 "The first <footnote><p>If you are using an http proxy server you must set "
6121 "the http_proxy environment variable first, see "
6122 "sources.list(5)</p></footnote> thing that should be done before using "
6123 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6124 "so that it knows what packages are available. This is done with <tt>apt-get "
6125 "update</tt>. For instance,"
6128 #. type: <example></example>
6132 "# apt-get update\n"
6133 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6134 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6135 "Reading Package Lists... Done\n"
6136 "Building Dependency Tree... Done"
6139 #. type: <p><taglist>
6141 msgid "Once updated there are several commands that can be used:"
6144 #. type: <tag></tag>
6152 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6153 "install a new package or remove an existing package, nor will it ever "
6154 "upgrade a package that might cause some other package to break. This can be "
6155 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6156 "the packages that it could not upgrade, this usually means that they depend "
6157 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6158 "<tt>apt-get install</tt> can be used to force these packages to install."
6161 #. type: <tag></tag>
6169 "Install is used to install packages by name. The package is automatically "
6170 "fetched and installed. This can be useful if you already know the name of "
6171 "the package to install and do not want to go into a GUI to select it. Any "
6172 "number of packages may be passed to install, they will all be "
6173 "fetched. Install automatically attempts to resolve dependency problems with "
6174 "the listed packages and will print a summary and ask for confirmation if "
6175 "anything other than its arguments are changed."
6178 #. type: <tag></tag>
6180 msgid "dist-upgrade"
6186 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6187 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6188 "set of packages to install, upgrade and remove to get as much of the system "
6189 "to the newest release. In some situations it may be desired to use "
6190 "dist-upgrade rather than spend the time manually resolving dependencies in "
6191 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6192 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6199 "It is important to closely look at what dist-upgrade is going to do, its "
6200 "decisions may sometimes be quite surprising."
6206 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6207 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6208 "option is <tt>-d</tt> which does not install the fetched files. If the "
6209 "system has to download a large number of package it would be undesired to "
6210 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6211 "the downloaded archives can be installed by simply running the command that "
6212 "caused them to be downloaded again without <tt>-d</tt>."
6215 #. type: <heading></heading>
6223 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6224 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6225 "to select the packages to be installed or removed and APT actually installs "
6232 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6233 "and then choose the APT method. You will be prompted for a set of "
6234 "<em>Sources</em> which are places to fetch archives from. These can be "
6235 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
6236 "provide a fragment of the total Debian archive, APT will automatically "
6237 "combine them to form a complete set of packages. If you have a CDROM then it "
6238 "is a good idea to specify it first and then specify a mirror so that you "
6239 "have access to the latest bug fixes. APT will automatically use packages on "
6240 "your CDROM before downloading from the Internet."
6243 #. type: <example></example>
6247 " Set up a list of distribution source locations\n"
6249 " Please give the base URL of the debian distribution.\n"
6250 " The access schemes I know about are: http file\n"
6253 " file:/mnt/debian,\n"
6254 " ftp://ftp.debian.org/debian,\n"
6255 " http://ftp.de.debian.org/debian,\n"
6258 " URL [http://llug.sep.bnl.gov/debian]:"
6264 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6265 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6269 #. type: <example></example>
6273 " Please give the distribution tag to get or a path to the\n"
6274 " package file ending in a /. The distribution\n"
6275 " tags are typically something like: stable unstable testing non-US\n"
6277 " Distribution [stable]:"
6283 "The distribution refers to the Debian version in the archive, "
6284 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6285 "refers to the developmental version. <em>non-US</em> is only available on "
6286 "some mirrors and refers to packages that contain encryption technology or "
6287 "other things that cannot be exported from the United States. Importing these "
6288 "packages into the US is legal however."
6291 #. type: <example></example>
6295 " Please give the components to get\n"
6296 " The components are typically something like: main contrib non-free\n"
6298 " Components [main contrib non-free]:"
6304 "The components list refers to the list of sub distributions to fetch. The "
6305 "distribution is split up based on software licenses, main being DFSG free "
6306 "packages while contrib and non-free contain things that have various "
6307 "restrictions placed on their use and distribution."
6313 "Any number of sources can be added, the setup script will continue to prompt "
6314 "until you have specified all that you want."
6320 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6321 "available list by selecting [U]pdate from the menu. This is a superset of "
6322 "<tt>apt-get update</tt> that makes the fetched information available to "
6323 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6324 "update</tt> has been run before."
6330 "You can then go on and make your selections using [S]elect and then perform "
6331 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6332 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6339 "By default APT will automatically remove the package (.deb) files once they "
6340 "have been successfully installed. To change this behavior place "
6341 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6344 #. type: <heading></heading>
6346 msgid "The Interface"
6352 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6353 "same interface. It is a simple system that generally tells you what it will "
6354 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6355 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6356 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6357 "alone.</p></footnote> After printing out a summary of what will happen APT "
6358 "then will print out some informative status messages so that you can "
6359 "estimate how far along it is and how much is left to do."
6362 #. type: <heading></heading>
6370 "Before all operations except update, APT performs a number of actions to "
6371 "prepare its internal state. It also does some checks of the system's "
6372 "state. At any time these operations can be performed by running <tt>apt-get "
6376 #. type: <example></example>
6381 "Reading Package Lists... Done\n"
6382 "Building Dependency Tree... Done"
6388 "The first thing it does is read all the package files into memory. APT uses "
6389 "a caching scheme so this operation will be faster the second time it is "
6390 "run. If some of the package files are not found then they will be ignored "
6391 "and a warning will be printed when apt-get exits."
6397 "The final operation performs a detailed analysis of the system's "
6398 "dependencies. It checks every dependency of every installed or unpacked "
6399 "package and considers if it is OK. Should this find a problem then a report "
6400 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6403 #. type: <example></example>
6408 "Reading Package Lists... Done\n"
6409 "Building Dependency Tree... Done\n"
6410 "You might want to run apt-get -f install' to correct these.\n"
6411 "Sorry, but the following packages have unmet dependencies:\n"
6412 " 9fonts: Depends: xlib6g but it is not installed\n"
6413 " uucp: Depends: mailx but it is not installed\n"
6414 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6415 " adduser: Depends: perl-base but it is not installed\n"
6416 " aumix: Depends: libgpmg1 but it is not installed\n"
6417 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6418 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6419 " cthugha: Depends: svgalibg1 but it is not installed\n"
6420 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6421 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6427 "In this example the system has many problems, including a serious problem "
6428 "with libreadlineg2. For each package that has unmet dependencies a line is "
6429 "printed out indicating the package with the problem and the dependencies "
6430 "that are unmet. A short explanation of why the package has a dependency "
6431 "problem is also included."
6437 "There are two ways a system can get into a broken state like this. The first "
6438 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6439 "packages when performing upgrades. <footnote><p>APT however considers all "
6440 "known dependencies and attempts to prevent broken "
6441 "packages</p></footnote>. The second is if a package installation fails "
6442 "during an operation. In this situation a package may have been unpacked "
6443 "without its dependents being installed."
6449 "The second situation is much less serious than the first because APT places "
6450 "certain constraints on the order that packages are installed. In both cases "
6451 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6452 "deduce a possible solution to the problem and then continue on. The APT "
6453 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6454 "for easy continuation of failed maintainer scripts."
6460 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6461 "system caused by the first case then it is possible that it will either fail "
6462 "immediately or the installation sequence will fail. In either case it is "
6463 "necessary to manually use dpkg (possibly with forcing options) to correct "
6464 "the situation enough to allow APT to proceed."
6467 #. type: <heading></heading>
6469 msgid "The Status Report"
6475 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6476 "happen. Generally the report reflects the type of operation being performed "
6477 "but there are several common elements. In all cases the lists reflect the "
6478 "final state of things, taking into account the <tt>-f</tt> option and any "
6479 "other relevant activities to the command being executed."
6482 #. type: <heading></heading>
6484 msgid "The Extra Package list"
6487 #. type: <example></example>
6491 "The following extra packages will be installed:\n"
6492 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6493 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6494 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6495 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6502 "The Extra Package list shows all of the packages that will be installed or "
6503 "upgraded in excess of the ones mentioned on the command line. It is only "
6504 "generated for an <tt>install</tt> command. The listed packages are often the "
6505 "result of an Auto Install."
6508 #. type: <heading></heading>
6510 msgid "The Packages to Remove"
6513 #. type: <example></example>
6517 "The following packages will be REMOVED:\n"
6518 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6519 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6520 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6527 "The Packages to Remove list shows all of the packages that will be removed "
6528 "from the system. It can be shown for any of the operations and should be "
6529 "given a careful inspection to ensure nothing important is to be taken "
6530 "off. The <tt>-f</tt> option is especially good at generating packages to "
6531 "remove so extreme care should be used in that case. The list may contain "
6532 "packages that are going to be removed because they are only partially "
6533 "installed, possibly due to an aborted installation."
6536 #. type: <heading></heading>
6538 msgid "The New Packages list"
6541 #. type: <example></example>
6545 "The following NEW packages will installed:\n"
6546 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6552 "The New Packages list is simply a reminder of what will happen. The packages "
6553 "listed are not presently installed in the system but will be when APT is "
6557 #. type: <heading></heading>
6559 msgid "The Kept Back list"
6562 #. type: <example></example>
6566 "The following packages have been kept back\n"
6567 " compface man-db tetex-base msql libpaper svgalib1\n"
6568 " gs snmp arena lynx xpat2 groff xscreensaver"
6574 "Whenever the whole system is being upgraded there is the possibility that "
6575 "new versions of packages cannot be installed because they require new things "
6576 "or conflict with already installed things. In this case the package will "
6577 "appear in the Kept Back list. The best way to convince packages listed there "
6578 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6579 "to resolve their problems."
6582 #. type: <heading></heading>
6584 msgid "Held Packages warning"
6587 #. type: <example></example>
6591 "The following held packages will be changed:\n"
6598 "Sometimes you can ask APT to install a package that is on hold, in such a "
6599 "case it prints out a warning that the held package is going to be "
6600 "changed. This should only happen during dist-upgrade or install."
6603 #. type: <heading></heading>
6605 msgid "Final summary"
6610 msgid "Finally, APT will print out a summary of all the changes that will occur."
6613 #. type: <example></example>
6617 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6619 "12 packages not fully installed or removed.\n"
6620 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6626 "The first line of the summary simply is a reduced version of all of the "
6627 "lists and includes the number of upgrades - that is packages already "
6628 "installed that have new versions available. The second line indicates the "
6629 "number of poorly configured packages, possibly the result of an aborted "
6630 "installation. The final line shows the space requirements that the "
6631 "installation needs. The first pair of numbers refer to the size of the "
6632 "archive files. The first number indicates the number of bytes that must be "
6633 "fetched from remote locations and the second indicates the total size of all "
6634 "the archives required. The next number indicates the size difference between "
6635 "the presently installed packages and the newly installed packages. It is "
6636 "roughly equivalent to the space required in /usr after everything is "
6637 "done. If a large number of packages are being removed then the value may "
6638 "indicate the amount of space that will be freed."
6644 "Some other reports can be generated by using the -u option to show packages "
6645 "to upgrade, they are similar to the previous examples."
6648 #. type: <heading></heading>
6650 msgid "The Status Display"
6656 "During the download of archives and package files APT prints out a series of "
6660 #. type: <example></example>
6664 "# apt-get update\n"
6665 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6666 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6667 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6668 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6670 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6671 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6677 "The lines starting with <em>Get</em> are printed out when APT begins to "
6678 "fetch a file while the last line indicates the progress of the download. The "
6679 "first percent value on the progress line indicates the total percent done of "
6680 "all files. Unfortunately since the size of the Package files is unknown "
6681 "<tt>apt-get update</tt> estimates the percent done which causes some "
6688 "The next section of the status line is repeated once for each download "
6689 "thread and indicates the operation being performed and some useful "
6690 "information about what is happening. Sometimes this section will simply read "
6691 "<em>Forking</em> which means the OS is loading the download module. The "
6692 "first word after the [ is the fetch number as shown on the history "
6693 "lines. The next word is the short form name of the object being "
6694 "downloaded. For archives it will contain the name of the package that is "
6701 "Inside of the single quote is an informative string indicating the progress "
6702 "of the negotiation phase of the download. Typically it progresses from "
6703 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6704 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6705 "the remote site. Once the download begins this is represented as "
6706 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6707 "kilobytes is expected. The total size is always shown in 4 figure notation "
6708 "to preserve space. After the size display is a percent meter for the file "
6709 "itself. The second last element is the instantaneous average speed. This "
6710 "values is updated every 5 seconds and reflects the rate of data transfer for "
6711 "that period. Finally is shown the estimated transfer time. This is updated "
6712 "regularly and reflects the time to complete everything at the shown transfer "
6719 "The status display updates every half second to provide a constant feedback "
6720 "on the download progress while the Get lines scroll back whenever a new file "
6721 "is started. Since the status display is constantly updated it is unsuitable "
6722 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6726 #. type: <heading></heading>
6734 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6735 "to the <prgn>dpkg</prgn> interface once downloading is "
6736 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6737 "processes the packages and the packages themselves may also ask several "
6738 "questions. Before each question there is usually a description of what it is "
6739 "asking and the questions are too varied to discuss completely here."
6742 #. type: <title></title>
6744 msgid "Using APT Offline"
6747 #. type: <version></version>
6749 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6752 #. type: <abstract></abstract>
6755 "This document describes how to use APT in a non-networked environment, "
6756 "specifically a 'sneaker-net' approach for performing upgrades."
6759 #. type: <copyrightsummary></copyrightsummary>
6761 msgid "Copyright © Jason Gunthorpe, 1999."
6764 #. type: <heading></heading>
6766 msgid "Introduction"
6769 #. type: <heading></heading>
6770 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6777 "Normally APT requires direct access to a Debian archive, either from a local "
6778 "media or through a network. Another common complaint is that a Debian "
6779 "machine is on a slow link, such as a modem and another machine has a very "
6780 "fast connection but they are physically distant."
6786 "The solution to this is to use large removable media such as a Zip disc or a "
6787 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6788 "archive but can easily fit a subset large enough for most users. The idea is "
6789 "to use APT to generate a list of packages that are required and then fetch "
6790 "them onto the disc using another machine with good connectivity. It is even "
6791 "possible to use another Debian machine with APT or to use a completely "
6792 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6793 "the machine downloading the packages, and <em>target host</em> the one with "
6794 "bad or no connection."
6800 "This is achieved by creatively manipulating the APT configuration file. The "
6801 "essential premise to tell APT to look on a disc for it's archive files. Note "
6802 "that the disc should be formated with a filesystem that can handle long file "
6803 "names such as ext2, fat32 or vfat."
6806 #. type: <heading></heading>
6808 msgid "Using APT on both machines"
6811 #. type: <p><example>
6814 "APT being available on both machines gives the simplest configuration. The "
6815 "basic idea is to place a copy of the status file on the disc and use the "
6816 "remote machine to fetch the latest package files and decide which packages "
6817 "to download. The disk directory structure should look like:"
6820 #. type: <example></example>
6834 #. type: <heading></heading>
6836 msgid "The configuration file"
6842 "The configuration file should tell APT to store its files on the disc and to "
6843 "use the configuration files on the disc as well. The sources.list should "
6844 "contain the proper sites that you wish to use from the remote machine, and "
6845 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6846 "<em>target host</em>. Please note, if you are using a local archive you must "
6847 "use copy URIs, the syntax is identical to file URIs."
6850 #. type: <p><example>
6853 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6857 #. type: <example></example>
6863 " /* This is not necessary if the two machines are the same arch, it "
6865 " the remote APT what architecture the target machine is */\n"
6866 " Architecture \"i386\";\n"
6868 " Get::Download-Only \"true\";\n"
6873 " /* Use the disc for state information and redirect the status file from\n"
6874 " the /var/lib/dpkg default */\n"
6875 " State \"/disc/\";\n"
6876 " State::status \"status\";\n"
6878 " // Binary caches will be stored locally\n"
6879 " Cache::archives \"/disc/archives/\";\n"
6880 " Cache \"/tmp/\";\n"
6882 " // Location of the source list.\n"
6883 " Etc \"/disc/\";\n"
6887 #. type: </example></p>
6890 "More details can be seen by examining the apt.conf man page and the sample "
6891 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6894 #. type: <p><example>
6897 "On the target machine the first thing to do is mount the disc and copy "
6898 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6899 "directories outlined in the Overview, <em>archives/partial/</em> and "
6900 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6901 "configure the sources.list. On the remote machine execute the following:"
6904 #. type: <example></example>
6908 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6909 " # apt-get update\n"
6910 " [ APT fetches the package files ]\n"
6911 " # apt-get dist-upgrade\n"
6912 " [ APT fetches all the packages needed to upgrade the target machine ]"
6915 #. type: </example></p>
6918 "The dist-upgrade command can be replaced with any other standard APT "
6919 "commands, particularly dselect-upgrade. You can even use an APT front end "
6920 "such as <em>dselect</em>. However this presents a problem in communicating "
6921 "your selections back to the local computer."
6924 #. type: <p><example>
6927 "Now the disc contains all of the index files and archives needed to upgrade "
6928 "the target machine. Take the disc back and run:"
6931 #. type: <example></example>
6935 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6936 " # apt-get check\n"
6937 " [ APT generates a local copy of the cache files ]\n"
6938 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6939 " [ Or any other APT command ]"
6945 "It is necessary for proper function to re-specify the status file to be the "
6946 "local one. This is very important!"
6952 "If you are using dselect you can do the very risky operation of copying "
6953 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6954 "remote machine are updated. I highly recommend that people only make "
6955 "selections on the local machine - but this may not always be possible. DO "
6956 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6959 #. type: <heading></heading>
6961 msgid "Using APT and wget"
6967 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6968 "any machine. Unlike the method above this requires that the Debian machine "
6969 "already has a list of available packages."
6975 "The basic idea is to create a disc that has only the archive files "
6976 "downloaded from the remote site. This is done by using the --print-uris "
6977 "option to apt-get and then preparing a wget script to actually fetch the "
6981 #. type: <heading></heading>
6986 #. type: <p><example>
6989 "Unlike the previous technique no special configuration files are "
6990 "required. We merely use the standard APT commands to generate the file list."
6993 #. type: <example></example>
6997 " # apt-get dist-upgrade \n"
6998 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6999 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7000 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
7003 #. type: </example></p>
7006 "Any command other than dist-upgrade could be used here, including "
7013 "The /disc/wget-script file will now contain a list of wget commands to "
7014 "execute in order to fetch the necessary archives. This script should be run "
7015 "with the current directory as the disc's mount point so as to save the "
7016 "output on the disc."
7019 #. type: <p><example>
7021 msgid "The remote machine would do something like"
7024 #. type: <example></example>
7029 " # sh -x ./wget-script\n"
7033 #. type: </example><example>
7036 "Once the archives are downloaded and the disc returned to the Debian machine "
7037 "installation can proceed using,"
7040 #. type: <example></example>
7043 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
7046 #. type: </example></p>
7048 msgid "Which will use the already fetched archives on the disc."