1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the apt-doc package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: apt-doc 0.9.5.1\n"
10 "Report-Msgid-Bugs-To: APT Development Team <deity@lists.debian.org>\n"
11 "POT-Creation-Date: 2012-05-29 16:11+0300\n"
12 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
13 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
14 "Language-Team: LANGUAGE <LL@li.org>\n"
17 "Content-Type: text/plain; charset=UTF-8\n"
18 "Content-Transfer-Encoding: 8bit\n"
46 msgid "apt - Advanced Package Tool"
69 "APT is a management system for software packages. For normal day to day "
70 "package management there are several frontends available, such as "
71 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
72 "System. Some options are only implemented in B<apt-get>(8) though."
84 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
85 "B<apt_preferences>(5), B<apt-secure>(8)"
96 msgid "apt returns zero on normal operation, decimal 100 on error."
107 msgid "This manpage isn't even started."
113 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
114 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
115 "B<reportbug>(1) command."
126 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
133 "<!ENTITY apt-author.team \"\n"
135 " <othername>APT team</othername>\n"
136 " <contrib></contrib>\n"
145 "<!ENTITY apt-qapage \"\n"
147 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
156 "<!-- Boiler plate Bug reporting section -->\n"
157 "<!ENTITY manbugs \"\n"
158 " <refsect1><title>Bugs</title>\n"
159 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
160 " If you wish to report a bug in APT, please see\n"
161 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
162 " &reportbug; command.\n"
172 "<!-- Boiler plate Author section -->\n"
173 "<!ENTITY manauthor \"\n"
174 " <refsect1><title>Author</title>\n"
175 " <para>APT was written by the APT team "
176 "<email>apt@packages.debian.org</email>.\n"
186 "<!-- Should be used within the option section of the text to\n"
187 " put in the blurb about -h, -v, -c and -o -->\n"
188 "<!ENTITY apt-commonoptions \"\n"
189 " <varlistentry><term><option>-h</option></term>\n"
190 " <term><option>--help</option></term>\n"
191 " <listitem><para>Show a short usage summary.\n"
202 " <term><option>-v</option></term>\n"
203 " <term><option>--version</option></term>\n"
204 " <listitem><para>Show the program version.\n"
215 " <term><option>-c</option></term>\n"
216 " <term><option>--config-file</option></term>\n"
217 " <listitem><para>Configuration File; Specify a configuration file to "
219 " The program will read the default configuration file and then this \n"
220 " configuration file. If configuration settings need to be set before "
222 " default configuration files are parsed specify a file with the "
223 "<envar>APT_CONFIG</envar>\n"
224 " environment variable. See &apt-conf; for syntax information.\n"
235 " <term><option>-o</option></term>\n"
236 " <term><option>--option</option></term>\n"
237 " <listitem><para>Set a Configuration Option; This will set an "
239 " configuration option. The syntax is <option>-o "
240 "Foo::Bar=bar</option>.\n"
241 " <option>-o</option> and <option>--option</option> can be used "
243 " times to set different options.\n"
254 "<!-- Should be used within the option section of the text to\n"
255 " put in the blurb about -h, -v, -c and -o -->\n"
256 "<!ENTITY apt-cmdblurb \"\n"
257 " <para>All command line options may be set using the configuration file, "
259 " descriptions indicate the configuration option to set. For boolean\n"
260 " options you can override the config file by using something like \n"
261 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
262 " or several other variations.\n"
271 "<!ENTITY file-aptconf \"\n"
272 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
273 " <listitem><para>APT configuration file.\n"
274 " Configuration Item: "
275 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
283 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
284 " <listitem><para>APT configuration file fragments.\n"
285 " Configuration Item: "
286 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
295 "<!ENTITY file-cachearchives \"\n"
296 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
297 " <listitem><para>Storage area for retrieved package files.\n"
298 " Configuration Item: "
299 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
308 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
309 " <listitem><para>Storage area for package files in transit.\n"
310 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
311 "(<filename>partial</filename> will be implicitly "
312 "appended)</para></listitem>\n"
321 "<!ENTITY file-preferences \"\n"
322 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
323 " <listitem><para>Version preferences file.\n"
324 " This is where you would specify "pinning",\n"
325 " i.e. a preference to get certain packages\n"
326 " from a separate source\n"
327 " or from a different version of a distribution.\n"
328 " Configuration Item: "
329 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
338 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
339 " <listitem><para>File fragments for the version preferences.\n"
340 " Configuration Item: "
341 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
350 "<!ENTITY file-sourceslist \"\n"
351 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
352 " <listitem><para>Locations to fetch packages from.\n"
353 " Configuration Item: "
354 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
363 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
364 " <listitem><para>File fragments for locations to fetch packages from.\n"
365 " Configuration Item: "
366 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
375 "<!ENTITY file-statelists \"\n"
376 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
377 " <listitem><para>Storage area for state information for each package "
378 "resource specified in\n"
380 " Configuration Item: "
381 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
390 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
391 " <listitem><para>Storage area for state information in transit.\n"
392 " Configuration Item: <literal>Dir::State::Lists</literal> "
393 "(<filename>partial</filename> will be implicitly "
394 "appended)</para></listitem>\n"
403 "<!ENTITY file-trustedgpg \"\n"
404 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
405 " <listitem><para>Keyring of local trusted keys, new keys will be added "
407 " Configuration Item: "
408 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
417 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
418 " <listitem><para>File fragments for the trusted keys, additional "
420 " be stored here (by other packages or the administrator).\n"
421 " Configuration Item "
422 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
431 "<!ENTITY file-extended_states \"\n"
433 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
434 " <listitem><para>Status list of auto-installed packages.\n"
435 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
436 " </para></listitem>\n"
445 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
447 " to the other headers like NAME and DESCRIPTION and should therefore be "
449 "<!ENTITY translation-title \"TRANSLATION\">\n"
456 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
458 " to the translation in the past, who is responsible now and maybe "
459 "further information\n"
460 " specially related to your translation. -->\n"
461 "<!ENTITY translation-holder \"\n"
462 " The english translation was done by John Doe "
463 "<email>john@doe.org</email> in 2009,\n"
464 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
466 " Debian Dummy l10n Team "
467 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
475 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
476 "untranslated/fuzzy strings\n"
477 " in a shipped manpage newer/modified paragraphs will maybe appear in "
479 " the generated manpage. This sentence is therefore here to tell the "
481 " is not a mistake by the translator - obviously the target is that at "
483 " releases this sentence is not needed. :) -->\n"
484 "<!ENTITY translation-english \"\n"
485 " Note that this translated document may contain untranslated parts.\n"
486 " This is done on purpose, to avoid losing content when the\n"
487 " translation is lagging behind the original content.\n"
494 "<!-- TRANSLATOR: used as in -o=config_string "
495 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
502 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
503 "synopsis-config-file \"config_file\">"
509 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
510 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
511 "\"target_release\">"
517 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
518 "synopsis-architecture \"architecture\">"
524 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
525 "--> <!ENTITY synopsis-pkg \"pkg\">"
531 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
532 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
538 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
539 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
545 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
546 "awesome --> <!ENTITY synopsis-regex \"regex\">"
552 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
553 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
559 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
560 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
561 "\"temporary_directory\">"
567 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
568 "synopsis-filename \"filename\">"
574 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
575 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
581 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
582 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
589 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
590 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
597 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
598 "generate section --> <!ENTITY synopsis-section \"section\">"
604 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
605 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
608 #. type: Content of: <refentry><refmeta><manvolnum>
609 #: apt-cache.8.xml:26 apt-cdrom.8.xml:25 apt-config.8.xml:26 apt-get.8.xml:26 apt-key.8.xml:25 apt-mark.8.xml:26 apt-secure.8.xml:25
613 #. type: Content of: <refentry><refmeta><refmiscinfo>
614 #: apt-cache.8.xml:27 apt-cdrom.8.xml:26 apt-config.8.xml:27 apt-extracttemplates.1.xml:27 apt-ftparchive.1.xml:27 apt-get.8.xml:27 apt-key.8.xml:26 apt-mark.8.xml:27 apt-secure.8.xml:26 apt-sortpkgs.1.xml:27 apt.conf.5.xml:32 apt_preferences.5.xml:26 sources.list.5.xml:27
618 #. type: Content of: <refentry><refnamediv><refpurpose>
619 #: apt-cache.8.xml:33
620 msgid "query the APT cache"
623 #. type: Content of: <refentry><refsect1><title>
624 #: apt-cache.8.xml:38 apt-cdrom.8.xml:37 apt-config.8.xml:38 apt-extracttemplates.1.xml:38 apt-ftparchive.1.xml:38 apt-get.8.xml:38 apt-key.8.xml:37 apt-mark.8.xml:38 apt-secure.8.xml:50 apt-sortpkgs.1.xml:38 apt.conf.5.xml:41 apt_preferences.5.xml:36 sources.list.5.xml:36
628 #. type: Content of: <refentry><refsect1><para>
629 #: apt-cache.8.xml:39
631 "<command>apt-cache</command> performs a variety of operations on APT's "
632 "package cache. <command>apt-cache</command> does not manipulate the state of "
633 "the system but does provide operations to search and generate interesting "
634 "output from the package metadata."
637 #. type: Content of: <refentry><refsect1><para>
638 #: apt-cache.8.xml:44 apt-cdrom.8.xml:51 apt-config.8.xml:44 apt-ftparchive.1.xml:54 apt-get.8.xml:44
640 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
641 "one of the commands below must be present."
644 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
645 #: apt-cache.8.xml:49
647 "<literal>gencaches</literal> creates APT's package cache. This is done "
648 "implicitly by all commands needing this cache if it is missing or outdated."
651 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
652 #: apt-cache.8.xml:53 apt-cache.8.xml:142 apt-cache.8.xml:163 apt-cache.8.xml:185 apt-cache.8.xml:190 apt-cache.8.xml:206 apt-cache.8.xml:224 apt-cache.8.xml:236
653 msgid "&synopsis-pkg;"
656 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
657 #: apt-cache.8.xml:54
659 "<literal>showpkg</literal> displays information about the packages listed on "
660 "the command line. Remaining arguments are package names. The available "
661 "versions and reverse dependencies of each package listed are listed, as well "
662 "as forward dependencies for each version. Forward (normal) dependencies are "
663 "those packages upon which the package in question depends; reverse "
664 "dependencies are those packages that depend upon the package in "
665 "question. Thus, forward dependencies must be satisfied for a package, but "
666 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
667 "libreadline2</command> would produce output similar to the following:"
670 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
671 #: apt-cache.8.xml:66
674 "Package: libreadline2\n"
675 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
676 "Reverse Depends: \n"
677 " libreadlineg2,libreadline2\n"
678 " libreadline2-altdev,libreadline2\n"
680 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
683 "Reverse Provides: \n"
686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
687 #: apt-cache.8.xml:78
689 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
690 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
691 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
692 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
693 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
694 "installed. For the specific meaning of the remainder of the output it is "
695 "best to consult the apt source code."
698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
699 #: apt-cache.8.xml:87
701 "<literal>stats</literal> displays some statistics about the cache. No "
702 "further arguments are expected. Statistics reported are:"
705 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
706 #: apt-cache.8.xml:90
708 "<literal>Total package names</literal> is the number of package names found "
712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
713 #: apt-cache.8.xml:94
715 "<literal>Normal packages</literal> is the number of regular, ordinary "
716 "package names; these are packages that bear a one-to-one correspondence "
717 "between their names and the names used by other packages for them in "
718 "dependencies. The majority of packages fall into this category."
721 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
722 #: apt-cache.8.xml:100
724 "<literal>Pure virtual packages</literal> is the number of packages that "
725 "exist only as a virtual package name; that is, packages only \"provide\" the "
726 "virtual package name, and no package actually uses the name. For instance, "
727 "\"mail-transport-agent\" in the Debian system is a pure virtual package; "
728 "several packages provide \"mail-transport-agent\", but there is no package "
729 "named \"mail-transport-agent\"."
732 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
733 #: apt-cache.8.xml:108
735 "<literal>Single virtual packages</literal> is the number of packages with "
736 "only one package providing a particular virtual package. For example, in the "
737 "Debian system, \"X11-text-viewer\" is a virtual package, but only one "
738 "package, xless, provides \"X11-text-viewer\"."
741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
742 #: apt-cache.8.xml:114
744 "<literal>Mixed virtual packages</literal> is the number of packages that "
745 "either provide a particular virtual package or have the virtual package name "
746 "as the package name. For instance, in the Debian system, \"debconf\" is both "
747 "an actual package, and provided by the debconf-tiny package."
750 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
751 #: apt-cache.8.xml:121
753 "<literal>Missing</literal> is the number of package names that were "
754 "referenced in a dependency but were not provided by any package. Missing "
755 "packages may be an evidence if a full distribution is not accessed, or if a "
756 "package (real or virtual) has been dropped from the distribution. Usually "
757 "they are referenced from Conflicts or Breaks statements."
760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
761 #: apt-cache.8.xml:128
763 "<literal>Total distinct</literal> versions is the number of package versions "
764 "found in the cache; this value is therefore at least equal to the number of "
765 "total package names. If more than one distribution is being accessed (for "
766 "instance, \"stable\" and \"unstable\"), this value can be considerably "
767 "larger than the number of total package names."
770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
771 #: apt-cache.8.xml:135
773 "<literal>Total dependencies</literal> is the number of dependency "
774 "relationships claimed by all of the packages in the cache."
777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
778 #: apt-cache.8.xml:143
780 "<literal>showsrc</literal> displays all the source package records that "
781 "match the given package names. All versions are shown, as well as all "
782 "records that declare the name to be a binary package."
785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
786 #: apt-cache.8.xml:149
788 "<literal>dump</literal> shows a short listing of every package in the "
789 "cache. It is primarily for debugging."
792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
793 #: apt-cache.8.xml:154
795 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
796 "suitable for use with &dpkg; and is used by the &dselect; method."
799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
800 #: apt-cache.8.xml:159
802 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
807 #: apt-cache.8.xml:164
809 "<literal>show</literal> performs a function similar to <command>dpkg "
810 "--print-avail</command>; it displays the package records for the named "
814 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
815 #: apt-cache.8.xml:169
816 msgid "&synopsis-regex;"
819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
820 #: apt-cache.8.xml:170
822 "<literal>search</literal> performs a full text search on all available "
823 "package lists for the POSIX regex pattern given, see ®ex;. It searches "
824 "the package names and the descriptions for an occurrence of the regular "
825 "expression and prints out the package name and the short description, "
826 "including virtual package names. If <option>--full</option> is given then "
827 "output identical to <literal>show</literal> is produced for each matched "
828 "package, and if <option>--names-only</option> is given then the long "
829 "description is not searched, only the package name is."
832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
833 #: apt-cache.8.xml:181
835 "Separate arguments can be used to specify multiple search patterns that are "
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
840 #: apt-cache.8.xml:186
842 "<literal>depends</literal> shows a listing of each dependency a package has "
843 "and all the possible other packages that can fulfill that dependency."
846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
847 #: apt-cache.8.xml:191
849 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
853 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
854 #: apt-cache.8.xml:195
855 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
859 #: apt-cache.8.xml:196
861 "This command prints the name of each package APT knows. The optional "
862 "argument is a prefix match to filter the name list. The output is suitable "
863 "for use in a shell tab complete function and the output is generated "
864 "extremely quickly. This command is best used with the "
865 "<option>--generate</option> option."
868 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
869 #: apt-cache.8.xml:201
871 "Note that a package which APT knows of is not necessarily available to "
872 "download, installable or installed, e.g. virtual packages are also listed in "
873 "the generated list."
876 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
877 #: apt-cache.8.xml:207
879 "<literal>dotty</literal> takes a list of packages on the command line and "
880 "generates output suitable for use by dotty from the <ulink "
881 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
882 "package. The result will be a set of nodes and edges representing the "
883 "relationships between the packages. By default the given packages will trace "
884 "out all dependent packages; this can produce a very large graph. To limit "
885 "the output to only the packages listed on the command line, set the "
886 "<literal>APT::Cache::GivenOnly</literal> option."
889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
890 #: apt-cache.8.xml:216
892 "The resulting nodes will have several shapes; normal packages are boxes, "
893 "pure virtual packages are triangles, mixed virtual packages are diamonds, "
894 "missing packages are hexagons. Orange boxes mean recursion was stopped (leaf "
895 "packages), blue lines are pre-depends, green lines are conflicts."
898 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
899 #: apt-cache.8.xml:221
900 msgid "Caution, dotty cannot graph larger sets of packages."
903 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
904 #: apt-cache.8.xml:225
906 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
907 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
912 #: apt-cache.8.xml:229
913 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
916 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
917 #: apt-cache.8.xml:230
919 "<literal>policy</literal> is meant to help debug issues relating to the "
920 "preferences file. With no arguments it will print out the priorities of each "
921 "source. Otherwise it prints out detailed information about the priority "
922 "selection of the named package."
925 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
926 #: apt-cache.8.xml:237
928 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
929 "to mimic the output format and a subset of the functionality of the Debian "
930 "archive management tool, <literal>madison</literal>. It displays available "
931 "versions of a package in a tabular format. Unlike the original "
932 "<literal>madison</literal>, it can only display information for the "
933 "architecture for which APT has retrieved package lists "
934 "(<literal>APT::Architecture</literal>)."
937 #. type: Content of: <refentry><refsect1><title>
938 #: apt-cache.8.xml:248 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
942 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
943 #: apt-cache.8.xml:253
945 "Select the file to store the package cache. The package cache is the primary "
946 "cache used by all operations. Configuration Item: "
947 "<literal>Dir::Cache::pkgcache</literal>."
950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
951 #: apt-cache.8.xml:259
953 "Select the file to store the source cache. The source is used only by "
954 "<literal>gencaches</literal> and it stores a parsed version of the package "
955 "information from remote sources. When building the package cache the source "
956 "cache is used to avoid reparsing all of the package files. Configuration "
957 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
961 #: apt-cache.8.xml:267
963 "Quiet; produces output suitable for logging, omitting progress indicators. "
964 "More q's will produce more quietness up to a maximum of 2. You can also use "
965 "<option>-q=#</option> to set the quietness level, overriding the "
966 "configuration file. Configuration Item: <literal>quiet</literal>."
969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
970 #: apt-cache.8.xml:274
972 "Print only important dependencies; for use with <literal>unmet</literal> and "
973 "<literal>depends</literal>. Causes only Depends and Pre-Depends relations to "
974 "be printed. Configuration Item: <literal>APT::Cache::Important</literal>."
977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
978 #: apt-cache.8.xml:288
980 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
981 "print all dependencies. This can be tweaked with these flags which will omit "
982 "the specified dependency type. Configuration Item: "
983 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
984 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
987 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
988 #: apt-cache.8.xml:295
990 "Print full package records when searching. Configuration Item: "
991 "<literal>APT::Cache::ShowFull</literal>."
994 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
995 #: apt-cache.8.xml:300
997 "Print full records for all available versions. This is the default; to turn "
998 "it off, use <option>--no-all-versions</option>. If "
999 "<option>--no-all-versions</option> is specified, only the candidate version "
1000 "will be displayed (the one which would be selected for installation). This "
1001 "option is only applicable to the <literal>show</literal> command. "
1002 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1005 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1006 #: apt-cache.8.xml:309
1008 "Perform automatic package cache regeneration, rather than use the cache as "
1009 "it is. This is the default; to turn it off, use "
1010 "<option>--no-generate</option>. Configuration Item: "
1011 "<literal>APT::Cache::Generate</literal>."
1014 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1015 #: apt-cache.8.xml:315
1017 "Only search on the package names, not the long descriptions. Configuration "
1018 "Item: <literal>APT::Cache::NamesOnly</literal>."
1021 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1022 #: apt-cache.8.xml:320
1024 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1025 "and missing dependencies. Configuration Item: "
1026 "<literal>APT::Cache::AllNames</literal>."
1029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1030 #: apt-cache.8.xml:326
1032 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1033 "that all packages mentioned are printed once. Configuration Item: "
1034 "<literal>APT::Cache::RecurseDepends</literal>."
1037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1038 #: apt-cache.8.xml:333
1040 "Limit the output of <literal>depends</literal> and "
1041 "<literal>rdepends</literal> to packages which are currently installed. "
1042 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1045 #. type: Content of: <refentry><refsect1><title>
1046 #: apt-cache.8.xml:343 apt-get.8.xml:519 apt-key.8.xml:174 apt-mark.8.xml:125 apt.conf.5.xml:1118 apt_preferences.5.xml:698
1050 #. type: Content of: <refentry><refsect1><title>
1051 #: apt-cache.8.xml:350 apt-cdrom.8.xml:144 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:131 apt-secure.8.xml:192 apt-sortpkgs.1.xml:63 apt.conf.5.xml:1124 apt_preferences.5.xml:705 sources.list.5.xml:252
1055 #. type: Content of: <refentry><refsect1><para>
1056 #: apt-cache.8.xml:351
1057 msgid "&apt-conf;, &sources-list;, &apt-get;"
1060 #. type: Content of: <refentry><refsect1><title>
1061 #: apt-cache.8.xml:355 apt-cdrom.8.xml:149 apt-config.8.xml:114 apt-extracttemplates.1.xml:74 apt-ftparchive.1.xml:611 apt-get.8.xml:535 apt-mark.8.xml:135 apt-sortpkgs.1.xml:67
1065 #. type: Content of: <refentry><refsect1><para>
1066 #: apt-cache.8.xml:356
1068 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1072 #. type: Content of: <refentry><refnamediv><refpurpose>
1073 #: apt-cdrom.8.xml:32
1074 msgid "APT CD-ROM management utility"
1077 #. type: Content of: <refentry><refsect1><para>
1078 #: apt-cdrom.8.xml:38
1080 "<command>apt-cdrom</command> is used to add a new CD-ROM to APT's list of "
1081 "available sources. <command>apt-cdrom</command> takes care of determining "
1082 "the structure of the disc as well as correcting for several possible "
1083 "mis-burns and verifying the index files."
1086 #. type: Content of: <refentry><refsect1><para>
1087 #: apt-cdrom.8.xml:45
1089 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1090 "system; it cannot be done by hand. Furthermore each disc in a multi-CD set "
1091 "must be inserted and scanned separately to account for possible mis-burns."
1094 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1095 #: apt-cdrom.8.xml:56
1097 "<literal>add</literal> is used to add a new disc to the source list. It will "
1098 "unmount the CD-ROM device, prompt for a disc to be inserted and then proceed "
1099 "to scan it and copy the index files. If the disc does not have a proper "
1100 "<filename>.disk</filename> directory you will be prompted for a descriptive "
1104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1105 #: apt-cdrom.8.xml:64
1107 "APT uses a CD-ROM ID to track which disc is currently in the drive and "
1108 "maintains a database of these IDs in "
1109 "<filename>&statedir;/cdroms.list</filename>"
1112 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1113 #: apt-cdrom.8.xml:72
1115 "A debugging tool to report the identity of the current disc as well as the "
1119 #. type: Content of: <refentry><refsect1><title>
1120 #: apt-cdrom.8.xml:80 apt-key.8.xml:160
1124 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1125 #: apt-cdrom.8.xml:85
1127 "Mount point; specify the location to mount the CD-ROM. This mount point must "
1128 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1129 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1133 #: apt-cdrom.8.xml:94
1135 "Rename a disc; change the label of a disc or override the disc's given "
1136 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1137 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1140 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1141 #: apt-cdrom.8.xml:103
1143 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1144 "unmounting the mount point. Configuration Item: "
1145 "<literal>APT::CDROM::NoMount</literal>."
1148 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1149 #: apt-cdrom.8.xml:111
1151 "Fast Copy; Assume the package files are valid and do not check every "
1152 "package. This option should be used only if <command>apt-cdrom</command> has "
1153 "been run on this disc before and did not detect any errors. Configuration "
1154 "Item: <literal>APT::CDROM::Fast</literal>."
1157 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1158 #: apt-cdrom.8.xml:121
1160 "Thorough Package Scan; This option may be needed with some old Debian "
1161 "1.1/1.2 discs that have Package files in strange places. It takes much "
1162 "longer to scan the CD but will pick them all up."
1165 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1166 #: apt-cdrom.8.xml:132
1168 "No Changes; Do not change the &sources-list; file and do not write index "
1169 "files. Everything is still checked however. Configuration Item: "
1170 "<literal>APT::CDROM::NoAct</literal>."
1173 #. type: Content of: <refentry><refsect1><para>
1174 #: apt-cdrom.8.xml:145
1175 msgid "&apt-conf;, &apt-get;, &sources-list;"
1178 #. type: Content of: <refentry><refsect1><para>
1179 #: apt-cdrom.8.xml:150
1181 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1185 #. type: Content of: <refentry><refnamediv><refpurpose>
1186 #: apt-config.8.xml:33
1187 msgid "APT Configuration Query program"
1190 #. type: Content of: <refentry><refsect1><para>
1191 #: apt-config.8.xml:39
1193 "<command>apt-config</command> is an internal program used by various "
1194 "portions of the APT suite to provide consistent configurability. It accesses "
1195 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1196 "manner that is easy to use for scripted applications."
1199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1200 #: apt-config.8.xml:51
1202 "shell is used to access the configuration information from a shell "
1203 "script. It is given pairs of arguments, the first being a shell variable and "
1204 "the second the configuration value to query. As output it lists shell "
1205 "assignment commands for each value present. In a shell script it should be "
1209 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1210 #: apt-config.8.xml:59
1214 "RES=`apt-config shell OPTS MyApp::options`\n"
1218 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1219 #: apt-config.8.xml:64
1221 "This will set the shell environment variable $OPTS to the value of "
1222 "MyApp::options with a default of <option>-f</option>."
1225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1226 #: apt-config.8.xml:68
1228 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1229 "names, d returns directories, b returns true or false and i returns an "
1230 "integer. Each of the returns is normalized and verified internally."
1233 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1234 #: apt-config.8.xml:77
1235 msgid "Just show the contents of the configuration space."
1238 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1239 #: apt-config.8.xml:90
1241 "Include options which have an empty value. This is the default, so use "
1242 "--no-empty to remove them from the output."
1245 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1246 #: apt-config.8.xml:95
1247 msgid "%f "%v";%n"
1250 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1251 #: apt-config.8.xml:96
1253 "Defines the output of each config option. %t will be replaced with "
1254 "its individual name, %f with its full hierarchical name and %v "
1255 "with its value. Use uppercase letters and special characters in the value "
1256 "will be encoded to ensure that it can e.g. be safely used in a quoted-string "
1257 "as defined by RFC822. Additionally %n will be replaced by a newline, "
1258 "and %N by a tab. A % can be printed by using %%."
1261 #. type: Content of: <refentry><refsect1><para>
1262 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1266 #. type: Content of: <refentry><refsect1><para>
1267 #: apt-config.8.xml:115
1269 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1273 #. type: Content of: <refentry><refmeta><manvolnum>
1274 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1278 #. type: Content of: <refentry><refnamediv><refpurpose>
1279 #: apt-extracttemplates.1.xml:33
1281 "Utility to extract <command>debconf</command> config and templates from "
1285 #. type: Content of: <refentry><refsect1><para>
1286 #: apt-extracttemplates.1.xml:39
1288 "<command>apt-extracttemplates</command> will take one or more Debian package "
1289 "files as input and write out (to a temporary directory) all associated "
1290 "config scripts and template files. For each passed in package that contains "
1291 "config scripts and templates, one line of output will be generated in the "
1295 #. type: Content of: <refentry><refsect1><para>
1296 #: apt-extracttemplates.1.xml:44
1297 msgid "package version template-file config-script"
1300 #. type: Content of: <refentry><refsect1><para>
1301 #: apt-extracttemplates.1.xml:45
1303 "template-file and config-script are written to the temporary directory "
1304 "specified by the <option>-t</option> or <option>--tempdir</option> "
1305 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1306 "filenames of the form <filename>package.template.XXXX</filename> and "
1307 "<filename>package.config.XXXX</filename>"
1310 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1311 #: apt-extracttemplates.1.xml:58
1313 "Temporary directory in which to write extracted <command>debconf</command> "
1314 "template files and config scripts. Configuration Item: "
1315 "<literal>APT::ExtractTemplates::TempDir</literal>"
1318 #. type: Content of: <refentry><refsect1><para>
1319 #: apt-extracttemplates.1.xml:75
1321 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1322 "decimal 100 on error."
1325 #. type: Content of: <refentry><refnamediv><refpurpose>
1326 #: apt-ftparchive.1.xml:33
1327 msgid "Utility to generate index files"
1330 #. type: Content of: <refentry><refsect1><para>
1331 #: apt-ftparchive.1.xml:39
1333 "<command>apt-ftparchive</command> is the command line tool that generates "
1334 "the index files that APT uses to access a distribution source. The index "
1335 "files should be generated on the origin site based on the content of that "
1339 #. type: Content of: <refentry><refsect1><para>
1340 #: apt-ftparchive.1.xml:43
1342 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1343 "program, incorporating its entire functionality via the "
1344 "<literal>packages</literal> command. It also contains a contents file "
1345 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1346 "the generation process for a complete archive."
1349 #. type: Content of: <refentry><refsect1><para>
1350 #: apt-ftparchive.1.xml:49
1352 "Internally <command>apt-ftparchive</command> can make use of binary "
1353 "databases to cache the contents of a .deb file and it does not rely on any "
1354 "external programs aside from &gzip;. When doing a full generate it "
1355 "automatically performs file-change checks and builds the desired compressed "
1359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1360 #: apt-ftparchive.1.xml:60
1362 "The packages command generates a package file from a directory tree. It "
1363 "takes the given directory and recursively searches it for .deb files, "
1364 "emitting a package record to stdout for each. This command is approximately "
1365 "equivalent to &dpkg-scanpackages;."
1368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1369 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1370 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1373 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1374 #: apt-ftparchive.1.xml:70
1376 "The <literal>sources</literal> command generates a source index file from a "
1377 "directory tree. It takes the given directory and recursively searches it "
1378 "for .dsc files, emitting a source record to stdout for each. This command is "
1379 "approximately equivalent to &dpkg-scansources;."
1382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1383 #: apt-ftparchive.1.xml:75
1385 "If an override file is specified then a source override file will be looked "
1386 "for with an extension of .src. The --source-override option can be used to "
1387 "change the source override file that will be used."
1390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1391 #: apt-ftparchive.1.xml:82
1393 "The <literal>contents</literal> command generates a contents file from a "
1394 "directory tree. It takes the given directory and recursively searches it for "
1395 ".deb files, and reads the file list from each file. It then sorts and writes "
1396 "to stdout the list of files matched to packages. Directories are not written "
1397 "to the output. If multiple packages own the same file then each package is "
1398 "separated by a comma in the output."
1401 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1402 #: apt-ftparchive.1.xml:94
1404 "The <literal>release</literal> command generates a Release file from a "
1405 "directory tree. It recursively searches the given directory for uncompressed "
1406 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1407 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1408 "<command>lzma</command> as well as <filename>Release</filename> and "
1409 "<filename>md5sum.txt</filename> files by default "
1410 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1411 "filename patterns can be added by listing them in "
1412 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1413 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1418 #: apt-ftparchive.1.xml:104
1420 "Values for the additional metadata fields in the Release file are taken from "
1421 "the corresponding variables under "
1422 "<literal>APT::FTPArchive::Release</literal>, "
1423 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1424 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1425 "<literal>Suite</literal>, <literal>Version</literal>, "
1426 "<literal>Codename</literal>, <literal>Date</literal>, "
1427 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1428 "<literal>Components</literal>, <literal>Description</literal>."
1431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1432 #: apt-ftparchive.1.xml:117
1434 "The <literal>generate</literal> command is designed to be runnable from a "
1435 "cron script and builds indexes according to the given config file. The "
1436 "config language provides a flexible means of specifying which index files "
1437 "are built from which directories, as well as providing a simple means of "
1438 "maintaining the required settings."
1441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1442 #: apt-ftparchive.1.xml:126
1444 "The <literal>clean</literal> command tidies the databases used by the given "
1445 "configuration file by removing any records that are no longer necessary."
1448 #. type: Content of: <refentry><refsect1><title>
1449 #: apt-ftparchive.1.xml:132
1450 msgid "The Generate Configuration"
1453 #. type: Content of: <refentry><refsect1><para>
1454 #: apt-ftparchive.1.xml:134
1456 "The <literal>generate</literal> command uses a configuration file to "
1457 "describe the archives that are going to be generated. It follows the typical "
1458 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1459 "&apt-conf; contains a description of the syntax. Note that the generate "
1460 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1461 "tree manner. This only effects how the scope tag is handled."
1464 #. type: Content of: <refentry><refsect1><para>
1465 #: apt-ftparchive.1.xml:142
1466 msgid "The generate configuration has 4 separate sections, each described below."
1469 #. type: Content of: <refentry><refsect1><refsect2><title>
1470 #: apt-ftparchive.1.xml:144
1471 msgid "<literal>Dir</literal> Section"
1474 #. type: Content of: <refentry><refsect1><refsect2><para>
1475 #: apt-ftparchive.1.xml:146
1477 "The <literal>Dir</literal> section defines the standard directories needed "
1478 "to locate the files required during the generation process. These "
1479 "directories are prepended certain relative paths defined in later sections "
1480 "to produce a complete an absolute path."
1483 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1484 #: apt-ftparchive.1.xml:153
1486 "Specifies the root of the FTP archive, in a standard Debian configuration "
1487 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1491 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1492 #: apt-ftparchive.1.xml:160
1493 msgid "Specifies the location of the override files."
1496 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1497 #: apt-ftparchive.1.xml:165
1498 msgid "Specifies the location of the cache files"
1501 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1502 #: apt-ftparchive.1.xml:170
1504 "Specifies the location of the file list files, if the "
1505 "<literal>FileList</literal> setting is used below."
1508 #. type: Content of: <refentry><refsect1><refsect2><title>
1509 #: apt-ftparchive.1.xml:176
1510 msgid "<literal>Default</literal> Section"
1513 #. type: Content of: <refentry><refsect1><refsect2><para>
1514 #: apt-ftparchive.1.xml:178
1516 "The <literal>Default</literal> section specifies default values, and "
1517 "settings that control the operation of the generator. Other sections may "
1518 "override these defaults with a per-section setting."
1521 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1522 #: apt-ftparchive.1.xml:184
1524 "Sets the default compression schemes to use for the Package index files. It "
1525 "is a string that contains a space separated list of at least one of: '.' (no "
1526 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1530 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1531 #: apt-ftparchive.1.xml:192
1533 "Sets the default list of file extensions that are package files. This "
1534 "defaults to '.deb'."
1537 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1538 #: apt-ftparchive.1.xml:198
1540 "This is similar to <literal>Packages::Compress</literal> except that it "
1541 "controls the compression for the Sources files."
1544 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1545 #: apt-ftparchive.1.xml:204
1547 "Sets the default list of file extensions that are source files. This "
1548 "defaults to '.dsc'."
1551 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1552 #: apt-ftparchive.1.xml:210
1554 "This is similar to <literal>Packages::Compress</literal> except that it "
1555 "controls the compression for the Contents files."
1558 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1559 #: apt-ftparchive.1.xml:216
1561 "This is similar to <literal>Packages::Compress</literal> except that it "
1562 "controls the compression for the Translation-en master file."
1565 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1566 #: apt-ftparchive.1.xml:222
1568 "Specifies the number of kilobytes to delink (and replace with hard links) "
1569 "per run. This is used in conjunction with the per-section "
1570 "<literal>External-Links</literal> setting."
1573 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1574 #: apt-ftparchive.1.xml:229
1576 "Specifies the mode of all created index files. It defaults to 0644. All "
1577 "index files are set to this mode with no regard to the umask."
1580 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1581 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
1583 "Sets if long descriptions should be included in the Packages file or split "
1584 "out into a master Translation-en file."
1587 #. type: Content of: <refentry><refsect1><refsect2><title>
1588 #: apt-ftparchive.1.xml:242
1589 msgid "<literal>TreeDefault</literal> Section"
1592 #. type: Content of: <refentry><refsect1><refsect2><para>
1593 #: apt-ftparchive.1.xml:244
1595 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
1596 "variables are substitution variables and have the strings $(DIST), "
1597 "$(SECTION) and $(ARCH) replaced with their respective values."
1600 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1601 #: apt-ftparchive.1.xml:251
1603 "Sets the number of kilobytes of contents files that are generated each "
1604 "day. The contents files are round-robined so that over several days they "
1605 "will all be rebuilt."
1608 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1609 #: apt-ftparchive.1.xml:258
1611 "Controls the number of days a contents file is allowed to be checked without "
1612 "changing. If this limit is passed the mtime of the contents file is "
1613 "updated. This case can occur if the package file is changed in such a way "
1614 "that does not result in a new contents file [override edit for instance]. A "
1615 "hold off is allowed in hopes that new .debs will be installed, requiring a "
1616 "new file anyhow. The default is 10, the units are in days."
1619 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1620 #: apt-ftparchive.1.xml:269
1622 "Sets the top of the .deb directory tree. Defaults to "
1623 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
1626 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1627 #: apt-ftparchive.1.xml:275
1629 "Sets the top of the source package directory tree. Defaults to "
1630 "<filename>$(DIST)/$(SECTION)/source/</filename>"
1633 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1634 #: apt-ftparchive.1.xml:281
1636 "Sets the output Packages file. Defaults to "
1637 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
1640 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1641 #: apt-ftparchive.1.xml:287
1643 "Sets the output Sources file. Defaults to "
1644 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
1647 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1648 #: apt-ftparchive.1.xml:293
1650 "Set the output Translation-en master file with the long descriptions if they "
1651 "should be not included in the Packages file. Defaults to "
1652 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
1655 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1656 #: apt-ftparchive.1.xml:300
1658 "Sets the path prefix that causes a symlink to be considered an internal link "
1659 "instead of an external link. Defaults to "
1660 "<filename>$(DIST)/$(SECTION)/</filename>"
1663 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1664 #: apt-ftparchive.1.xml:307
1666 "Sets the output Contents file. Defaults to "
1667 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
1668 "multiple Packages files to map onto a single Contents file (such as the "
1669 "default) then <command>apt-ftparchive</command> will integrate those "
1670 "package files together automatically."
1673 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1674 #: apt-ftparchive.1.xml:316
1675 msgid "Sets header file to prepend to the contents output."
1678 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1679 #: apt-ftparchive.1.xml:321
1681 "Sets the binary cache database to use for this section. Multiple sections "
1682 "can share the same database."
1685 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1686 #: apt-ftparchive.1.xml:327
1688 "Specifies that instead of walking the directory tree, "
1689 "<command>apt-ftparchive</command> should read the list of files from the "
1690 "given file. Relative files names are prefixed with the archive directory."
1693 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1694 #: apt-ftparchive.1.xml:334
1696 "Specifies that instead of walking the directory tree, "
1697 "<command>apt-ftparchive</command> should read the list of files from the "
1698 "given file. Relative files names are prefixed with the archive directory. "
1699 "This is used when processing source indexes."
1702 #. type: Content of: <refentry><refsect1><refsect2><title>
1703 #: apt-ftparchive.1.xml:342
1704 msgid "<literal>Tree</literal> Section"
1707 #. type: Content of: <refentry><refsect1><refsect2><para>
1708 #: apt-ftparchive.1.xml:344
1710 "The <literal>Tree</literal> section defines a standard Debian file tree "
1711 "which consists of a base directory, then multiple sections in that base "
1712 "directory and finally multiple Architectures in each section. The exact "
1713 "pathing used is defined by the <literal>Directory</literal> substitution "
1717 #. type: Content of: <refentry><refsect1><refsect2><para>
1718 #: apt-ftparchive.1.xml:349
1720 "The <literal>Tree</literal> section takes a scope tag which sets the "
1721 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
1722 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
1723 "setting such as <filename>dists/&stable-codename;</filename>."
1726 #. type: Content of: <refentry><refsect1><refsect2><para>
1727 #: apt-ftparchive.1.xml:354
1729 "All of the settings defined in the <literal>TreeDefault</literal> section "
1730 "can be use in a <literal>Tree</literal> section as well as three new "
1734 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
1735 #: apt-ftparchive.1.xml:360
1738 "for i in Sections do \n"
1739 " for j in Architectures do\n"
1740 " Generate for DIST=scope SECTION=i ARCH=j\n"
1744 #. type: Content of: <refentry><refsect1><refsect2><para>
1745 #: apt-ftparchive.1.xml:357
1747 "When processing a <literal>Tree</literal> section "
1748 "<command>apt-ftparchive</command> performs an operation similar to: "
1749 "<placeholder type=\"programlisting\" id=\"0\"/>"
1752 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1753 #: apt-ftparchive.1.xml:368
1755 "This is a space separated list of sections which appear under the "
1756 "distribution, typically this is something like <literal>main contrib "
1757 "non-free</literal>"
1760 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1761 #: apt-ftparchive.1.xml:375
1763 "This is a space separated list of all the architectures that appear under "
1764 "search section. The special architecture 'source' is used to indicate that "
1765 "this tree has a source archive."
1768 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1769 #: apt-ftparchive.1.xml:388
1771 "Sets the binary override file. The override file contains section, priority "
1772 "and maintainer address information."
1775 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1776 #: apt-ftparchive.1.xml:394
1778 "Sets the source override file. The override file contains section "
1782 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1783 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
1784 msgid "Sets the binary extra override file."
1787 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1788 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
1789 msgid "Sets the source extra override file."
1792 #. type: Content of: <refentry><refsect1><refsect2><title>
1793 #: apt-ftparchive.1.xml:410
1794 msgid "<literal>BinDirectory</literal> Section"
1797 #. type: Content of: <refentry><refsect1><refsect2><para>
1798 #: apt-ftparchive.1.xml:412
1800 "The <literal>bindirectory</literal> section defines a binary directory tree "
1801 "with no special structure. The scope tag specifies the location of the "
1802 "binary directory and the settings are similar to the <literal>Tree</literal> "
1803 "section with no substitution variables or "
1804 "<literal>Section</literal><literal>Architecture</literal> settings."
1807 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1808 #: apt-ftparchive.1.xml:420
1809 msgid "Sets the Packages file output."
1812 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1813 #: apt-ftparchive.1.xml:425
1815 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
1816 "<literal>Sources</literal> is required."
1819 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1820 #: apt-ftparchive.1.xml:431
1821 msgid "Sets the Contents file output. (optional)"
1824 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1825 #: apt-ftparchive.1.xml:436
1826 msgid "Sets the binary override file."
1829 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1830 #: apt-ftparchive.1.xml:441
1831 msgid "Sets the source override file."
1834 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1835 #: apt-ftparchive.1.xml:456
1836 msgid "Sets the cache DB."
1839 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1840 #: apt-ftparchive.1.xml:461
1841 msgid "Appends a path to all the output paths."
1844 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1845 #: apt-ftparchive.1.xml:466
1846 msgid "Specifies the file list file."
1849 #. type: Content of: <refentry><refsect1><title>
1850 #: apt-ftparchive.1.xml:473
1851 msgid "The Binary Override File"
1854 #. type: Content of: <refentry><refsect1><para>
1855 #: apt-ftparchive.1.xml:474
1857 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
1858 "contains 4 fields separated by spaces. The first field is the package name, "
1859 "the second is the priority to force that package to, the third is the the "
1860 "section to force that package to and the final field is the maintainer "
1861 "permutation field."
1864 #. type: Content of: <refentry><refsect1><para><literallayout>
1865 #: apt-ftparchive.1.xml:480
1867 msgid "old [// oldn]* => new"
1870 #. type: Content of: <refentry><refsect1><para><literallayout>
1871 #: apt-ftparchive.1.xml:482
1876 #. type: Content of: <refentry><refsect1><para>
1877 #: apt-ftparchive.1.xml:479
1879 "The general form of the maintainer field is: <placeholder "
1880 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
1881 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
1882 "separated list of old email addresses to be specified. If any of those are "
1883 "found then new is substituted for the maintainer field. The second form "
1884 "unconditionally substitutes the maintainer field."
1887 #. type: Content of: <refentry><refsect1><title>
1888 #: apt-ftparchive.1.xml:490
1889 msgid "The Source Override File"
1892 #. type: Content of: <refentry><refsect1><para>
1893 #: apt-ftparchive.1.xml:492
1895 "The source override file is fully compatible with &dpkg-scansources;. It "
1896 "contains 2 fields separated by spaces. The first fields is the source "
1897 "package name, the second is the section to assign it."
1900 #. type: Content of: <refentry><refsect1><title>
1901 #: apt-ftparchive.1.xml:497
1902 msgid "The Extra Override File"
1905 #. type: Content of: <refentry><refsect1><para>
1906 #: apt-ftparchive.1.xml:499
1908 "The extra override file allows any arbitrary tag to be added or replaced in "
1909 "the output. It has 3 columns, the first is the package, the second is the "
1910 "tag and the remainder of the line is the new value."
1913 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1914 #: apt-ftparchive.1.xml:510
1916 "Generate the given checksum. These options default to on, when turned off "
1917 "the generated index files will not have the checksum fields where possible. "
1918 "Configuration Items: "
1919 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
1920 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
1921 "where <literal><replaceable>Index</replaceable></literal> can be "
1922 "<literal>Packages</literal>, <literal>Sources</literal> or "
1923 "<literal>Release</literal> and "
1924 "<literal><replaceable>Checksum</replaceable></literal> can be "
1925 "<literal>MD5</literal>, <literal>SHA1</literal> or "
1926 "<literal>SHA256</literal>."
1929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1930 #: apt-ftparchive.1.xml:521
1932 "Use a binary caching DB. This has no effect on the generate command. "
1933 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
1936 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1937 #: apt-ftparchive.1.xml:527
1939 "Quiet; produces output suitable for logging, omitting progress indicators. "
1940 "More q's will produce more quiet up to a maximum of 2. You can also use "
1941 "<option>-q=#</option> to set the quiet level, overriding the configuration "
1942 "file. Configuration Item: <literal>quiet</literal>."
1945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1946 #: apt-ftparchive.1.xml:535
1948 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
1949 "then this option actually enables delinking of the files. It defaults to on "
1950 "and can be turned off with <option>--no-delink</option>. Configuration "
1951 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
1954 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1955 #: apt-ftparchive.1.xml:543
1957 "Perform contents generation. When this option is set and package indexes are "
1958 "being generated with a cache DB then the file listing will also be extracted "
1959 "and stored in the DB for later use. When using the generate command this "
1960 "option also allows the creation of any Contents files. The default is on. "
1961 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
1964 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1965 #: apt-ftparchive.1.xml:553
1967 "Select the source override file to use with the <literal>sources</literal> "
1968 "command. Configuration Item: "
1969 "<literal>APT::FTPArchive::SourceOverride</literal>."
1972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1973 #: apt-ftparchive.1.xml:559
1975 "Make the caching databases read only. Configuration Item: "
1976 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
1979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1980 #: apt-ftparchive.1.xml:564
1982 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
1983 "commands only package files matching <literal>*_arch.deb</literal> or "
1984 "<literal>*_all.deb</literal> instead of all package files in the given "
1985 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
1988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1989 #: apt-ftparchive.1.xml:572
1991 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
1992 "packages are recompiled and/or republished with the same version again, this "
1993 "will lead to problems as the now outdated cached metadata like size and "
1994 "checksums will be used. With this option enabled this will no longer happen "
1995 "as it will be checked if the file was changed. Note that this option is set "
1996 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
1997 "multiply versions/builds of a package with the same versionnumber, so in "
1998 "theory nobody will have these problems and therefore all these extra checks "
2002 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2003 #: apt-ftparchive.1.xml:584
2005 "This configuration option defaults to \"<literal>true</literal>\" and should "
2006 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2007 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2008 "that the <filename>Translation-en</filename> master file can only be created "
2009 "in the generate command."
2012 #. type: Content of: <refentry><refsect1><title>
2013 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1112 apt_preferences.5.xml:545 sources.list.5.xml:211
2017 #. type: Content of: <refentry><refsect1><para><programlisting>
2018 #: apt-ftparchive.1.xml:602
2021 "<command>apt-ftparchive</command> packages "
2022 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2023 "<filename>Packages.gz</filename>\n"
2026 #. type: Content of: <refentry><refsect1><para>
2027 #: apt-ftparchive.1.xml:598
2029 "To create a compressed Packages file for a directory containing binary "
2030 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2033 #. type: Content of: <refentry><refsect1><para>
2034 #: apt-ftparchive.1.xml:612
2036 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2040 #. type: Content of: <refentry><refnamediv><refpurpose>
2042 msgid "APT package handling utility -- command-line interface"
2045 #. type: Content of: <refentry><refsect1><para>
2048 "<command>apt-get</command> is the command-line tool for handling packages, "
2049 "and may be considered the user's \"back-end\" to other tools using the APT "
2050 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2051 "&aptitude;, &synaptic; and &wajig;."
2054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2057 "<literal>update</literal> is used to resynchronize the package index files "
2058 "from their sources. The indexes of available packages are fetched from the "
2059 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2060 "example, when using a Debian archive, this command retrieves and scans the "
2061 "<filename>Packages.gz</filename> files, so that information about new and "
2062 "updated packages is available. An <literal>update</literal> should always be "
2063 "performed before an <literal>upgrade</literal> or "
2064 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2065 "meter will be incorrect as the size of the package files cannot be known in "
2069 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2072 "<literal>upgrade</literal> is used to install the newest versions of all "
2073 "packages currently installed on the system from the sources enumerated in "
2074 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2075 "with new versions available are retrieved and upgraded; under no "
2076 "circumstances are currently installed packages removed, or packages not "
2077 "already installed retrieved and installed. New versions of currently "
2078 "installed packages that cannot be upgraded without changing the install "
2079 "status of another package will be left at their current version. An "
2080 "<literal>update</literal> must be performed first so that "
2081 "<command>apt-get</command> knows that new versions of packages are "
2085 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2088 "<literal>dist-upgrade</literal> in addition to performing the function of "
2089 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2090 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2091 "conflict resolution system, and it will attempt to upgrade the most "
2092 "important packages at the expense of less important ones if necessary. The "
2093 "<literal>dist-upgrade</literal> command may therefore remove some packages. "
2094 "The <filename>/etc/apt/sources.list</filename> file contains a list of "
2095 "locations from which to retrieve desired package files. See also "
2096 "&apt-preferences; for a mechanism for overriding the general settings for "
2097 "individual packages."
2100 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2103 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2104 "traditional Debian packaging front-end, "
2105 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2106 "&dselect; to the <literal>Status</literal> field of available packages, and "
2107 "performs the actions necessary to realize that state (for instance, the "
2108 "removal of old and the installation of new packages)."
2111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2114 "<literal>install</literal> is followed by one or more packages desired for "
2115 "installation or upgrading. Each package is a package name, not a fully "
2116 "qualified filename (for instance, in a Debian system, "
2117 "<package>apt-utils</package> would be the argument provided, not "
2118 "<filename>apt-utils_&apt-product-version;_amd64.deb</filename>). All "
2119 "packages required by the package(s) specified for installation will also be "
2120 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2121 "file is used to locate the desired packages. If a hyphen is appended to the "
2122 "package name (with no intervening space), the identified package will be "
2123 "removed if it is installed. Similarly a plus sign can be used to designate "
2124 "a package to install. These latter features may be used to override "
2125 "decisions made by apt-get's conflict resolution system."
2128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2129 #: apt-get.8.xml:116
2131 "A specific version of a package can be selected for installation by "
2132 "following the package name with an equals and the version of the package to "
2133 "select. This will cause that version to be located and selected for "
2134 "install. Alternatively a specific distribution can be selected by following "
2135 "the package name with a slash and the version of the distribution or the "
2136 "Archive name (stable, testing, unstable)."
2139 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2140 #: apt-get.8.xml:123
2142 "Both of the version selection mechanisms can downgrade packages and must be "
2146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2147 #: apt-get.8.xml:126
2149 "This is also the target to use if you want to upgrade one or more "
2150 "already-installed packages without upgrading every package you have on your "
2151 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2152 "all currently installed packages, \"install\" will install the newest "
2153 "version of only the package(s) specified. Simply provide the name of the "
2154 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2155 "its dependencies, as described above) will be downloaded and installed."
2158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2159 #: apt-get.8.xml:137
2161 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2162 "installation policy for individual packages."
2165 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2166 #: apt-get.8.xml:141
2168 "If no package matches the given expression and the expression contains one "
2169 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2170 "it is applied to all package names in the database. Any matches are then "
2171 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2172 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2173 "expression with a '^' or '$' character, or create a more specific regular "
2177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2178 #: apt-get.8.xml:151
2180 "<literal>remove</literal> is identical to <literal>install</literal> except "
2181 "that packages are removed instead of installed. Note the removing a package "
2182 "leaves its configuration files in system. If a plus sign is appended to the "
2183 "package name (with no intervening space), the identified package will be "
2184 "installed instead of removed."
2187 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2188 #: apt-get.8.xml:159
2190 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2191 "that packages are removed and purged (any configuration files are deleted "
2195 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2196 #: apt-get.8.xml:164
2198 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2199 "packages. APT will examine the available packages to decide which source "
2200 "package to fetch. It will then find and download into the current directory "
2201 "the newest available version of that source package while respecting the "
2202 "default release, set with the option "
2203 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2204 "per package with the <literal>pkg/release</literal> syntax, if possible."
2207 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2208 #: apt-get.8.xml:172
2210 "Source packages are tracked separately from binary packages via "
2211 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2212 "that you will need to add such a line for each repository you want to get "
2213 "sources from. If you don't do this you will properly get another (newer, "
2214 "older or none) source version than the one you have installed or could "
2218 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2219 #: apt-get.8.xml:179
2221 "If the <option>--compile</option> option is specified then the package will "
2222 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2223 "the architecture as defined by the <command>--host-architecture</command> "
2224 "option. If <option>--download-only</option> is specified then the source "
2225 "package will not be unpacked."
2228 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2229 #: apt-get.8.xml:186
2231 "A specific source version can be retrieved by postfixing the source name "
2232 "with an equals and then the version to fetch, similar to the mechanism used "
2233 "for the package files. This enables exact matching of the source package "
2234 "name and version, implicitly enabling the "
2235 "<literal>APT::Get::Only-Source</literal> option."
2238 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2239 #: apt-get.8.xml:192
2241 "Note that source packages are not tracked like binary packages, they exist "
2242 "only in the current directory and are similar to downloading source tar "
2246 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2247 #: apt-get.8.xml:198
2249 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2250 "attempt to satisfy the build dependencies for a source package. By default "
2251 "the dependencies are satisfied to build the package natively. If desired a "
2252 "host-architecture can be specified with the "
2253 "<option>--host-architecture</option> option instead."
2256 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2257 #: apt-get.8.xml:205
2259 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2260 "and checks for broken dependencies."
2263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2264 #: apt-get.8.xml:210
2266 "<literal>download</literal> will download the given binary package into the "
2267 "current directory."
2270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2271 #: apt-get.8.xml:216
2273 "<literal>clean</literal> clears out the local repository of retrieved "
2274 "package files. It removes everything but the lock file from "
2275 "<filename>&cachedir;/archives/</filename> and "
2276 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2277 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2278 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2279 "from time to time to free up disk space."
2282 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2283 #: apt-get.8.xml:226
2285 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2286 "local repository of retrieved package files. The difference is that it only "
2287 "removes package files that can no longer be downloaded, and are largely "
2288 "useless. This allows a cache to be maintained over a long period without it "
2289 "growing out of control. The configuration option "
2290 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2291 "being erased if it is set to off."
2294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2295 #: apt-get.8.xml:236
2297 "<literal>autoremove</literal> is used to remove packages that were "
2298 "automatically installed to satisfy dependencies for other packages and are "
2299 "now no longer needed."
2302 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2303 #: apt-get.8.xml:241
2305 "<literal>changelog</literal> downloads a package changelog and displays it "
2306 "through <command>sensible-pager</command>. The server name and base "
2307 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2308 "variable (e. g. <ulink "
2309 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
2310 "for Debian or <ulink "
2311 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
2312 "for Ubuntu). By default it displays the changelog for the version that is "
2313 "installed. However, you can specify the same options as for the "
2314 "<option>install</option> command."
2317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2318 #: apt-get.8.xml:264
2320 "Do not consider recommended packages as a dependency for installing. "
2321 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2324 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2325 #: apt-get.8.xml:269
2327 "Consider suggested packages as a dependency for installing. Configuration "
2328 "Item: <literal>APT::Install-Suggests</literal>."
2331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2332 #: apt-get.8.xml:274
2334 "Download only; package files are only retrieved, not unpacked or installed. "
2335 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
2338 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2339 #: apt-get.8.xml:279
2341 "Fix; attempt to correct a system with broken dependencies in place. This "
2342 "option, when used with install/remove, can omit any packages to permit APT "
2343 "to deduce a likely solution. If packages are specified, these have to "
2344 "completely correct the problem. The option is sometimes necessary when "
2345 "running APT for the first time; APT itself does not allow broken package "
2346 "dependencies to exist on a system. It is possible that a system's dependency "
2347 "structure can be so corrupt as to require manual intervention (which usually "
2348 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
2349 "of the offending packages). Use of this option together with "
2350 "<option>-m</option> may produce an error in some situations. Configuration "
2351 "Item: <literal>APT::Get::Fix-Broken</literal>."
2354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2355 #: apt-get.8.xml:294
2357 "Ignore missing packages; If packages cannot be retrieved or fail the "
2358 "integrity check after retrieval (corrupted package files), hold back those "
2359 "packages and handle the result. Use of this option together with "
2360 "<option>-f</option> may produce an error in some situations. If a package is "
2361 "selected for installation (particularly if it is mentioned on the command "
2362 "line) and it could not be downloaded then it will be silently held back. "
2363 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
2366 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2367 #: apt-get.8.xml:305
2369 "Disables downloading of packages. This is best used with "
2370 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
2371 "already downloaded. Configuration Item: "
2372 "<literal>APT::Get::Download</literal>."
2375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2376 #: apt-get.8.xml:312
2378 "Quiet; produces output suitable for logging, omitting progress indicators. "
2379 "More q's will produce more quiet up to a maximum of 2. You can also use "
2380 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2381 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
2382 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
2383 "may decided to do something you did not expect. Configuration Item: "
2384 "<literal>quiet</literal>."
2387 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2388 #: apt-get.8.xml:327
2390 "No action; perform a simulation of events that would occur but do not "
2391 "actually change the system. Configuration Item: "
2392 "<literal>APT::Get::Simulate</literal>."
2395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2396 #: apt-get.8.xml:331
2398 "Simulation run as user will deactivate locking "
2399 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
2400 "displayed indicating that this is only a simulation, if the option "
2401 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
2402 "true). Neither NoLocking nor the notice will be triggered if run as root "
2403 "(root should know what he is doing without further warnings by "
2404 "<literal>apt-get</literal>)."
2407 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2408 #: apt-get.8.xml:337
2410 "Simulate prints out a series of lines each one representing a dpkg "
2411 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
2412 "indicate broken packages and empty set of square brackets meaning breaks "
2413 "that are of no consequence (rare)."
2416 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2417 #: apt-get.8.xml:346
2419 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
2420 "non-interactively. If an undesirable situation, such as changing a held "
2421 "package, trying to install a unauthenticated package or removing an "
2422 "essential package occurs then <literal>apt-get</literal> will abort. "
2423 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
2426 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2427 #: apt-get.8.xml:354
2429 "Automatic \"no\" to all prompts. Configuration Item: "
2430 "<literal>APT::Get::Assume-No</literal>."
2433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2434 #: apt-get.8.xml:359
2436 "Show upgraded packages; Print out a list of all packages that are to be "
2437 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
2440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2441 #: apt-get.8.xml:365
2443 "Show full versions for upgraded and installed packages. Configuration Item: "
2444 "<literal>APT::Get::Show-Versions</literal>."
2447 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2448 #: apt-get.8.xml:371
2450 "This option controls the architecture packages are built for by "
2451 "<command>apt-get source --compile</command> and how cross-builddependencies "
2452 "are satisfied. By default is it not set which means that the host "
2453 "architecture is the same as the build architecture (which is defined by "
2454 "<literal>APT::Architecture</literal>). Configuration Item: "
2455 "<literal>APT::Get::Host-Architecture</literal>"
2458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2459 #: apt-get.8.xml:381
2461 "Compile source packages after downloading them. Configuration Item: "
2462 "<literal>APT::Get::Compile</literal>."
2465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2466 #: apt-get.8.xml:386
2468 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
2469 "hold placed on a package. This may be useful in conjunction with "
2470 "<literal>dist-upgrade</literal> to override a large number of undesired "
2471 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
2474 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2475 #: apt-get.8.xml:393
2477 "Do not upgrade packages; When used in conjunction with "
2478 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
2479 "packages on the command line from being upgraded if they are already "
2480 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
2483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2484 #: apt-get.8.xml:400
2486 "Do not install new packages; When used in conjunction with "
2487 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
2488 "upgrades for already installed packages only and ignore requests to install "
2489 "new packages. Configuration Item: "
2490 "<literal>APT::Get::Only-Upgrade</literal>."
2493 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2494 #: apt-get.8.xml:408
2496 "Force yes; This is a dangerous option that will cause apt to continue "
2497 "without prompting if it is doing something potentially harmful. It should "
2498 "not be used except in very special situations. Using "
2499 "<literal>force-yes</literal> can potentially destroy your system! "
2500 "Configuration Item: <literal>APT::Get::force-yes</literal>."
2503 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2504 #: apt-get.8.xml:416
2506 "Instead of fetching the files to install their URIs are printed. Each URI "
2507 "will have the path, the destination file name, the size and the expected md5 "
2508 "hash. Note that the file name to write to will not always match the file "
2509 "name on the remote site! This also works with the <literal>source</literal> "
2510 "and <literal>update</literal> commands. When used with the "
2511 "<literal>update</literal> command the MD5 and size are not included, and it "
2512 "is up to the user to decompress any compressed files. Configuration Item: "
2513 "<literal>APT::Get::Print-URIs</literal>."
2516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2517 #: apt-get.8.xml:427
2519 "Use purge instead of remove for anything that would be removed. An asterisk "
2520 "(\"*\") will be displayed next to packages which are scheduled to be "
2521 "purged. <option>remove --purge</option> is equivalent to the "
2522 "<option>purge</option> command. Configuration Item: "
2523 "<literal>APT::Get::Purge</literal>."
2526 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2527 #: apt-get.8.xml:435
2529 "Re-Install packages that are already installed and at the newest version. "
2530 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
2533 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2534 #: apt-get.8.xml:440
2536 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
2537 "it off. When on <command>apt-get</command> will automatically manage the "
2538 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
2539 "files are erased. The only reason to turn it off is if you frequently "
2540 "change your source list. Configuration Item: "
2541 "<literal>APT::Get::List-Cleanup</literal>."
2544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2545 #: apt-get.8.xml:451
2547 "This option controls the default input to the policy engine, it creates a "
2548 "default pin at priority 990 using the specified release string. This "
2549 "overrides the general settings in "
2550 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
2551 "not affected by the value of this option. In short, this option lets you "
2552 "have simple control over which distribution packages will be retrieved "
2553 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
2554 "unstable</option> or <option>-t sid</option>. Configuration Item: "
2555 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
2559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2560 #: apt-get.8.xml:466
2562 "Only perform operations that are 'trivial'. Logically this can be considered "
2563 "related to <option>--assume-yes</option>, where "
2564 "<option>--assume-yes</option> will answer yes to any prompt, "
2565 "<option>--trivial-only</option> will answer no. Configuration Item: "
2566 "<literal>APT::Get::Trivial-Only</literal>."
2569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2570 #: apt-get.8.xml:473
2572 "If any packages are to be removed apt-get immediately aborts without "
2573 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
2576 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2577 #: apt-get.8.xml:479
2579 "If the command is either <literal>install</literal> or "
2580 "<literal>remove</literal>, then this option acts like running "
2581 "<literal>autoremove</literal> command, removing the unused dependency "
2582 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
2585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2586 #: apt-get.8.xml:486
2588 "Only has meaning for the <literal>source</literal> and "
2589 "<literal>build-dep</literal> commands. Indicates that the given source "
2590 "names are not to be mapped through the binary table. This means that if "
2591 "this option is specified, these commands will only accept source package "
2592 "names as arguments, rather than accepting binary package names and looking "
2593 "up the corresponding source package. Configuration Item: "
2594 "<literal>APT::Get::Only-Source</literal>."
2597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2598 #: apt-get.8.xml:497
2600 "Download only the diff, dsc, or tar file of a source archive. Configuration "
2601 "Item: <literal>APT::Get::Diff-Only</literal>, "
2602 "<literal>APT::Get::Dsc-Only</literal>, and "
2603 "<literal>APT::Get::Tar-Only</literal>."
2606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2607 #: apt-get.8.xml:503
2609 "Only process architecture-dependent build-dependencies. Configuration Item: "
2610 "<literal>APT::Get::Arch-Only</literal>."
2613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2614 #: apt-get.8.xml:508
2616 "Ignore if packages can't be authenticated and don't prompt about it. This "
2617 "is useful for tools like pbuilder. Configuration Item: "
2618 "<literal>APT::Get::AllowUnauthenticated</literal>."
2621 #. type: Content of: <refentry><refsect1><para>
2622 #: apt-get.8.xml:530
2624 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
2625 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
2626 "&apt-preferences;, the APT Howto."
2629 #. type: Content of: <refentry><refsect1><para>
2630 #: apt-get.8.xml:536
2632 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
2636 #. type: Content of: <refentry><refnamediv><refpurpose>
2638 msgid "APT key management utility"
2641 #. type: Content of: <refentry><refsect1><para>
2644 "<command>apt-key</command> is used to manage the list of keys used by apt to "
2645 "authenticate packages. Packages which have been authenticated using these "
2646 "keys will be considered trusted."
2649 #. type: Content of: <refentry><refsect1><title>
2654 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2657 "Add a new key to the list of trusted keys. The key is read from the "
2658 "filename given with the parameter &synopsis-param-filename; or if the "
2659 "filename is <literal>-</literal> from standard input."
2662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2664 msgid "Remove a key from the list of trusted keys."
2667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2669 msgid "Output the key &synopsis-param-keyid; to standard output."
2672 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2674 msgid "Output all trusted keys to standard output."
2677 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2679 msgid "List trusted keys."
2682 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2683 #: apt-key.8.xml:107
2684 msgid "List fingerprints of trusted keys."
2687 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2688 #: apt-key.8.xml:118
2690 "Pass advanced options to gpg. With adv --recv-key you can download the "
2694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2695 #: apt-key.8.xml:130
2697 "Update the local keyring with the archive keyring and remove from the local "
2698 "keyring the archive keys which are no longer valid. The archive keyring is "
2699 "shipped in the <literal>archive-keyring</literal> package of your "
2700 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
2704 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2705 #: apt-key.8.xml:144
2707 "Work similar to the <command>update</command> command above, but get the "
2708 "archive keyring from an URI instead and validate it against a master key. "
2709 "This requires an installed &wget; and an APT build configured to have a "
2710 "server to fetch from and a master keyring to validate. APT in Debian does "
2711 "not support this command and relies on <command>update</command> instead, "
2712 "but Ubuntu's APT does."
2715 #. type: Content of: <refentry><refsect1><para>
2716 #: apt-key.8.xml:161
2718 "Note that options need to be defined before the commands described in the "
2722 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2723 #: apt-key.8.xml:164
2725 "With this option it is possible to specify a specific keyring file the "
2726 "command should operate on. The default is that a command is executed on the "
2727 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2728 "<filename>trusted.gpg.d</filename> directory, though "
2729 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2730 "e.g. new keys are added to this one."
2733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2734 #: apt-key.8.xml:179
2735 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
2738 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2739 #: apt-key.8.xml:180
2740 msgid "Local trust database of archive keys."
2743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2744 #: apt-key.8.xml:183
2745 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
2748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2749 #: apt-key.8.xml:184
2750 msgid "Keyring of Debian archive trusted keys."
2753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2754 #: apt-key.8.xml:187
2755 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
2758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2759 #: apt-key.8.xml:188
2760 msgid "Keyring of Debian archive removed trusted keys."
2763 #. type: Content of: <refentry><refsect1><para>
2764 #: apt-key.8.xml:197
2765 msgid "&apt-get;, &apt-secure;"
2768 #. type: Content of: <refentry><refnamediv><refpurpose>
2769 #: apt-mark.8.xml:33
2770 msgid "mark/unmark a package as being automatically-installed"
2773 #. type: Content of: <refentry><refsect1><para>
2774 #: apt-mark.8.xml:39
2776 "<command>apt-mark</command> will change whether a package has been marked as "
2777 "being automatically installed."
2780 #. type: Content of: <refentry><refsect1><para>
2781 #: apt-mark.8.xml:43
2783 "When you request that a package is installed, and as a result other packages "
2784 "are installed to satisfy its dependencies, the dependencies are marked as "
2785 "being automatically installed. Once these automatically installed packages "
2786 "are no longer depended on by any manually installed packages, they will be "
2787 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
2790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2791 #: apt-mark.8.xml:52
2793 "<literal>auto</literal> is used to mark a package as being automatically "
2794 "installed, which will cause the package to be removed when no more manually "
2795 "installed packages depend on this package."
2798 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2799 #: apt-mark.8.xml:60
2801 "<literal>manual</literal> is used to mark a package as being manually "
2802 "installed, which will prevent the package from being automatically removed "
2803 "if no other packages depend on it."
2806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2807 #: apt-mark.8.xml:68
2809 "<literal>hold</literal> is used to mark a package as hold back, which will "
2810 "prevent the package from being automatically installed, upgraded or "
2811 "removed. The command is only a wrapper around <command>dpkg "
2812 "--set-selections</command> and the state is therefore maintained by &dpkg; "
2813 "and not effected by the <option>--filename</option> option."
2816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2817 #: apt-mark.8.xml:78
2819 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2820 "package to allow all actions again."
2823 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2824 #: apt-mark.8.xml:84
2826 "<literal>showauto</literal> is used to print a list of automatically "
2827 "installed packages with each package on a new line. All automatically "
2828 "installed packages will be listed if no package is given. If packages are "
2829 "given only those which are automatically installed will be shown."
2832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2833 #: apt-mark.8.xml:92
2835 "<literal>showmanual</literal> can be used in the same way as "
2836 "<literal>showauto</literal> except that it will print a list of manually "
2837 "installed packages instead."
2840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2841 #: apt-mark.8.xml:99
2843 "<literal>showhold</literal> is used to print a list of packages on hold in "
2844 "the same way as for the other show commands."
2847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2848 #: apt-mark.8.xml:115
2850 "Read/Write package stats from the filename given with the parameter "
2851 "&synopsis-param-filename; instead of from the default location, which is "
2852 "<filename>extended_status</filename> in the directory defined by the "
2853 "Configuration Item: <literal>Dir::State</literal>."
2856 #. type: Content of: <refentry><refsect1><para>
2857 #: apt-mark.8.xml:136
2859 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
2863 #. type: Content of: <refentry><refnamediv><refpurpose>
2864 #: apt-secure.8.xml:47
2865 msgid "Archive authentication support for APT"
2868 #. type: Content of: <refentry><refsect1><para>
2869 #: apt-secure.8.xml:52
2871 "Starting with version 0.6, <command>apt</command> contains code that does "
2872 "signature checking of the Release file for all archives. This ensures that "
2873 "packages in the archive can't be modified by people who have no access to "
2874 "the Release file signing key."
2877 #. type: Content of: <refentry><refsect1><para>
2878 #: apt-secure.8.xml:60
2880 "If a package comes from a archive without a signature or with a signature "
2881 "that apt does not have a key for that package is considered untrusted and "
2882 "installing it will result in a big warning. <command>apt-get</command> will "
2883 "currently only warn for unsigned archives, future releases might force all "
2884 "sources to be verified before downloading packages from them."
2887 #. type: Content of: <refentry><refsect1><para>
2888 #: apt-secure.8.xml:69
2890 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
2891 "authentication feature."
2894 #. type: Content of: <refentry><refsect1><title>
2895 #: apt-secure.8.xml:74
2896 msgid "Trusted archives"
2899 #. type: Content of: <refentry><refsect1><para>
2900 #: apt-secure.8.xml:77
2902 "The chain of trust from an apt archive to the end user is made up of "
2903 "different steps. <command>apt-secure</command> is the last step in this "
2904 "chain, trusting an archive does not mean that the packages that you trust it "
2905 "do not contain malicious code but means that you trust the archive "
2906 "maintainer. It's the archive maintainer responsibility to ensure that the "
2907 "archive integrity is correct."
2910 #. type: Content of: <refentry><refsect1><para>
2911 #: apt-secure.8.xml:85
2913 "apt-secure does not review signatures at a package level. If you require "
2914 "tools to do this you should look at <command>debsig-verify</command> and "
2915 "<command>debsign</command> (provided in the debsig-verify and devscripts "
2916 "packages respectively)."
2919 #. type: Content of: <refentry><refsect1><para>
2920 #: apt-secure.8.xml:92
2922 "The chain of trust in Debian starts when a maintainer uploads a new package "
2923 "or a new version of a package to the Debian archive. This upload in order to "
2924 "become effective needs to be signed by a key of a maintainer within the "
2925 "Debian maintainer's keyring (available in the debian-keyring "
2926 "package). Maintainer's keys are signed by other maintainers following "
2927 "pre-established procedures to ensure the identity of the key holder."
2930 #. type: Content of: <refentry><refsect1><para>
2931 #: apt-secure.8.xml:102
2933 "Once the uploaded package is verified and included in the archive, the "
2934 "maintainer signature is stripped off, an MD5 sum of the package is computed "
2935 "and put in the Packages file. The MD5 sum of all of the packages files are "
2936 "then computed and put into the Release file. The Release file is then signed "
2937 "by the archive key (which is created once a year) and distributed through "
2938 "the FTP server. This key is also on the Debian keyring."
2941 #. type: Content of: <refentry><refsect1><para>
2942 #: apt-secure.8.xml:112
2944 "Any end user can check the signature of the Release file, extract the MD5 "
2945 "sum of a package from it and compare it with the MD5 sum of the package he "
2946 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
2947 "package was checked. Now both the MD5 sum and the signature of the Release "
2951 #. type: Content of: <refentry><refsect1><para>
2952 #: apt-secure.8.xml:119
2954 "Notice that this is distinct from checking signatures on a per package "
2955 "basis. It is designed to prevent two possible attacks:"
2958 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2959 #: apt-secure.8.xml:124
2961 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
2962 "checking, a malicious agent can introduce himself in the package download "
2963 "process and provide malicious software either by controlling a network "
2964 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
2965 "(through arp or DNS spoofing attacks)."
2968 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
2969 #: apt-secure.8.xml:132
2971 "<literal>Mirror network compromise</literal>. Without signature checking, a "
2972 "malicious agent can compromise a mirror host and modify the files in it to "
2973 "propagate malicious software to all users downloading packages from that "
2977 #. type: Content of: <refentry><refsect1><para>
2978 #: apt-secure.8.xml:139
2980 "However, it does not defend against a compromise of the Debian master server "
2981 "itself (which signs the packages) or against a compromise of the key used to "
2982 "sign the Release files. In any case, this mechanism can complement a "
2983 "per-package signature."
2986 #. type: Content of: <refentry><refsect1><title>
2987 #: apt-secure.8.xml:145
2988 msgid "User configuration"
2991 #. type: Content of: <refentry><refsect1><para>
2992 #: apt-secure.8.xml:147
2994 "<command>apt-key</command> is the program that manages the list of keys used "
2995 "by apt. It can be used to add or remove keys although an installation of "
2996 "this release will automatically provide the default Debian archive signing "
2997 "keys used in the Debian package repositories."
3000 #. type: Content of: <refentry><refsect1><para>
3001 #: apt-secure.8.xml:154
3003 "In order to add a new key you need to first download it (you should make "
3004 "sure you are using a trusted communication channel when retrieving it), add "
3005 "it with <command>apt-key</command> and then run <command>apt-get "
3006 "update</command> so that apt can download and verify the "
3007 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3008 "from the archives you have configured."
3011 #. type: Content of: <refentry><refsect1><title>
3012 #: apt-secure.8.xml:163
3013 msgid "Archive configuration"
3016 #. type: Content of: <refentry><refsect1><para>
3017 #: apt-secure.8.xml:165
3019 "If you want to provide archive signatures in an archive under your "
3020 "maintenance you have to:"
3023 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3024 #: apt-secure.8.xml:170
3026 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3027 "already. You can do this by running <command>apt-ftparchive "
3028 "release</command> (provided in apt-utils)."
3031 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3032 #: apt-secure.8.xml:175
3034 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
3035 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
3036 "Release.gpg Release</command>."
3039 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3040 #: apt-secure.8.xml:179
3042 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
3043 "know what key they need to import in order to authenticate the files in the "
3047 #. type: Content of: <refentry><refsect1><para>
3048 #: apt-secure.8.xml:186
3050 "Whenever the contents of the archive changes (new packages are added or "
3051 "removed) the archive maintainer has to follow the first two steps previously "
3055 #. type: Content of: <refentry><refsect1><para>
3056 #: apt-secure.8.xml:194
3058 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
3059 "&debsign; &debsig-verify;, &gpg;"
3062 #. type: Content of: <refentry><refsect1><para>
3063 #: apt-secure.8.xml:198
3065 "For more background information you might want to review the <ulink "
3066 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
3067 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
3068 "(available also in the harden-doc package) and the <ulink "
3069 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
3070 "Distribution HOWTO</ulink> by V. Alex Brennen."
3073 #. type: Content of: <refentry><refsect1><title>
3074 #: apt-secure.8.xml:211
3075 msgid "Manpage Authors"
3078 #. type: Content of: <refentry><refsect1><para>
3079 #: apt-secure.8.xml:213
3081 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
3082 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
3085 #. type: Content of: <refentry><refnamediv><refpurpose>
3086 #: apt-sortpkgs.1.xml:33
3087 msgid "Utility to sort package index files"
3090 #. type: Content of: <refentry><refsect1><para>
3091 #: apt-sortpkgs.1.xml:39
3093 "<command>apt-sortpkgs</command> will take an index file (Source index or "
3094 "Package index) and sort the records so that they are ordered by the package "
3095 "name. It will also sort the internal fields of each record according to the "
3096 "internal sorting rules."
3099 #. type: Content of: <refentry><refsect1><para>
3100 #: apt-sortpkgs.1.xml:45
3101 msgid "All output is sent to stdout, the input must be a seekable file."
3104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3105 #: apt-sortpkgs.1.xml:54
3107 "Use Source index field ordering. Configuration Item: "
3108 "<literal>APT::SortPkgs::Source</literal>."
3111 #. type: Content of: <refentry><refsect1><para>
3112 #: apt-sortpkgs.1.xml:68
3114 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
3118 #. type: Content of: <refentry><refentryinfo><author><contrib>
3119 #: apt.conf.5.xml:20
3120 msgid "Initial documentation of Debug::*."
3123 #. type: Content of: <refentry><refentryinfo><author><email>
3124 #: apt.conf.5.xml:21
3125 msgid "dburrows@debian.org"
3128 #. type: Content of: <refentry><refmeta><manvolnum>
3129 #: apt.conf.5.xml:31 apt_preferences.5.xml:25 sources.list.5.xml:26
3133 #. type: Content of: <refentry><refnamediv><refpurpose>
3134 #: apt.conf.5.xml:38
3135 msgid "Configuration file for APT"
3138 #. type: Content of: <refentry><refsect1><para>
3139 #: apt.conf.5.xml:42
3141 "<filename>apt.conf</filename> is the main configuration file for the APT "
3142 "suite of tools, but by far not the only place changes to options can be "
3143 "made. All tools therefore share the configuration files and also use a "
3144 "common command line parser to provide a uniform environment."
3147 #. type: Content of: <refentry><refsect1><orderedlist><para>
3148 #: apt.conf.5.xml:47
3150 "When an APT tool starts up it will read the configuration files in the "
3154 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3155 #: apt.conf.5.xml:49
3157 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
3161 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3162 #: apt.conf.5.xml:51
3164 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
3165 "order which have either no or \"<literal>conf</literal>\" as filename "
3166 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
3167 "and period (.) characters. Otherwise APT will print a notice that it has "
3168 "ignored a file if the file doesn't match a pattern in the "
3169 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
3170 "case it will be silently ignored."
3173 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3174 #: apt.conf.5.xml:58
3175 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
3178 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3179 #: apt.conf.5.xml:60
3181 "the command line options are applied to override the configuration "
3182 "directives or to load even more configuration files."
3185 #. type: Content of: <refentry><refsect1><title>
3186 #: apt.conf.5.xml:64
3190 #. type: Content of: <refentry><refsect1><para>
3191 #: apt.conf.5.xml:65
3193 "The configuration file is organized in a tree with options organized into "
3194 "functional groups. Option specification is given with a double colon "
3195 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
3196 "within the APT tool group, for the Get tool. Options do not inherit from "
3197 "their parent groups."
3200 #. type: Content of: <refentry><refsect1><para>
3201 #: apt.conf.5.xml:71
3203 "Syntactically the configuration language is modeled after what the ISC tools "
3204 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
3205 "treated as comments (ignored), as well as all text between "
3206 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
3207 "Each line is of the form <literal>APT::Get::Assume-Yes "
3208 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
3209 "value must be on one line, and there is no kind of string concatenation. It "
3210 "must not include inside quotes. The behavior of the backslash \"\\\" and "
3211 "escaped characters inside a value is undefined and it should not be used. An "
3212 "option name may include alphanumerical characters and the \"/-:._+\" "
3213 "characters. A new scope can be opened with curly braces, like:"
3216 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3217 #: apt.conf.5.xml:85
3222 " Assume-Yes \"true\";\n"
3223 " Fix-Broken \"true\";\n"
3228 #. type: Content of: <refentry><refsect1><para>
3229 #: apt.conf.5.xml:93
3231 "with newlines placed to make it more readable. Lists can be created by "
3232 "opening a scope and including a single string enclosed in quotes followed by "
3233 "a semicolon. Multiple entries can be included, each separated by a "
3237 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3238 #: apt.conf.5.xml:98
3240 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
3243 #. type: Content of: <refentry><refsect1><para>
3244 #: apt.conf.5.xml:101
3246 "In general the sample configuration file in "
3247 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
3248 "guide for how it should look."
3251 #. type: Content of: <refentry><refsect1><para>
3252 #: apt.conf.5.xml:105
3254 "The names of the configuration items are not case-sensitive. So in the "
3255 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
3258 #. type: Content of: <refentry><refsect1><para>
3259 #: apt.conf.5.xml:108
3261 "Names for the configuration items are optional if a list is defined as it "
3262 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
3263 "above. If you don't specify a name a new entry will simply add a new option "
3264 "to the list. If you specify a name you can override the option as every "
3265 "other option by reassigning a new value to the option."
3268 #. type: Content of: <refentry><refsect1><para>
3269 #: apt.conf.5.xml:113
3271 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
3272 "and not supported by alternative implementations) and "
3273 "<literal>#clear</literal>: <literal>#include</literal> will include the "
3274 "given file, unless the filename ends in a slash, then the whole directory is "
3275 "included. <literal>#clear</literal> is used to erase a part of the "
3276 "configuration tree. The specified element and all its descendants are "
3277 "erased. (Note that these lines also need to end with a semicolon.)"
3280 #. type: Content of: <refentry><refsect1><para>
3281 #: apt.conf.5.xml:121
3283 "The #clear command is the only way to delete a list or a complete scope. "
3284 "Reopening a scope or the ::-style described below will "
3285 "<emphasis>not</emphasis> override previously written entries. Only options "
3286 "can be overridden by addressing a new value to it - lists and scopes can't "
3287 "be overridden, only cleared."
3290 #. type: Content of: <refentry><refsect1><para>
3291 #: apt.conf.5.xml:126
3293 "All of the APT tools take a -o option which allows an arbitrary "
3294 "configuration directive to be specified on the command line. The syntax is a "
3295 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
3296 "followed by an equals sign then the new value of the option. To append a new "
3297 "element to a list, add a trailing :: to the name of the list. (As you might "
3298 "suspect: The scope syntax can't be used on the command line.)"
3301 #. type: Content of: <refentry><refsect1><para>
3302 #: apt.conf.5.xml:133
3304 "Note that you can use :: only for appending one item per line to a list and "
3305 "that you should not use it in combination with the scope syntax. (The scope "
3306 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
3307 "which some users unfortunately depend on: An option with the unusual name "
3308 "\"<literal>::</literal>\" which acts like every other option with a "
3309 "name. These introduces many problems including that a user who writes "
3310 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
3311 "append to a list will gain the opposite as only the last assignment for this "
3312 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
3313 "raise errors and will stop working if they encounter this misuse, so please "
3314 "correct such statements now as long as APT doesn't complain explicit about "
3318 #. type: Content of: <refentry><refsect1><title>
3319 #: apt.conf.5.xml:145
3320 msgid "The APT Group"
3323 #. type: Content of: <refentry><refsect1><para>
3324 #: apt.conf.5.xml:146
3326 "This group of options controls general APT behavior as well as holding the "
3327 "options for all of the tools."
3330 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3331 #: apt.conf.5.xml:151
3333 "System Architecture; sets the architecture to use when fetching files and "
3334 "parsing package lists. The internal default is the architecture apt was "
3338 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3339 #: apt.conf.5.xml:157
3341 "All Architectures the system supports. Processors implementing the "
3342 "<literal>amd64</literal> (also called <literal>x86-64</literal>) instruction "
3343 "set are e.g. also able to execute binaries compiled for the "
3344 "<literal>i386</literal> (<literal>x86</literal>) instruction set; This list "
3345 "is use when fetching files and parsing package lists. The internal default "
3346 "is always the native architecture (<literal>APT::Architecture</literal>) "
3347 "and all foreign architectures it can retrieve by calling <command>dpkg "
3348 "--print-foreign-architectures</command>."
3351 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3352 #: apt.conf.5.xml:167
3354 "Default release to install packages from if more than one version "
3355 "available. Contains release name, codename or release version. Examples: "
3356 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
3357 "'4.0', '5.0*'. See also &apt-preferences;."
3360 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3361 #: apt.conf.5.xml:173
3363 "Ignore Held packages; This global option causes the problem resolver to "
3364 "ignore held packages in its decision making."
3367 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3368 #: apt.conf.5.xml:178
3370 "Defaults to on. When turned on the autoclean feature will remove any "
3371 "packages which can no longer be downloaded from the cache. If turned off "
3372 "then packages that are locally installed are also excluded from cleaning - "
3373 "but note that APT provides no direct means to reinstall them."
3376 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3377 #: apt.conf.5.xml:185
3379 "Defaults to on which will cause APT to install essential and important "
3380 "packages as fast as possible in the install/upgrade operation. This is done "
3381 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
3382 "does treat an important package in the same way as an extra package: Between "
3383 "the unpacking of the important package A and his configuration can then be "
3384 "many other unpack or configuration calls, e.g. for package B which has no "
3385 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
3386 "script of package B generates an error) which results in a system state in "
3387 "which package A is unpacked but unconfigured - each package depending on A "
3388 "is now no longer guaranteed to work as their dependency on A is not longer "
3389 "satisfied. The immediate configuration marker is also applied to all "
3390 "dependencies which can generate a problem if the dependencies e.g. form a "
3391 "circle as a dependency with the immediate flag is comparable with a "
3392 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
3393 "in which it is unable to perform immediate configuration, errors out and "
3394 "refers to this option so the user can deactivate the immediate configuration "
3395 "temporarily to be able to perform an install/upgrade again. Note the use of "
3396 "the word \"theory\" here as this problem was only encountered by now in real "
3397 "world a few times in non-stable distribution versions and was caused by "
3398 "wrong dependencies of the package in question or by a system in an already "
3399 "broken state, so you should not blindly disable this option as the mentioned "
3400 "scenario above is not the only problem immediate configuration can help to "
3401 "prevent in the first place. Before a big operation like "
3402 "<literal>dist-upgrade</literal> is run with this option disabled it should "
3403 "be tried to explicitly <literal>install</literal> the package APT is unable "
3404 "to configure immediately, but please make sure to report your problem also "
3405 "to your distribution and to the APT team with the buglink below so they can "
3406 "work on improving or correcting the upgrade process."
3409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3410 #: apt.conf.5.xml:208
3412 "Never Enable this option unless you -really- know what you are doing. It "
3413 "permits APT to temporarily remove an essential package to break a "
3414 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
3415 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
3416 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
3417 "anything that those packages depend on."
3420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3421 #: apt.conf.5.xml:217
3423 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3424 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
3425 "to which size the Cache will grow and is therefore the amount of memory APT "
3426 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3427 "that this amount of space needs to be available for APT otherwise it will "
3428 "likely fail ungracefully, so for memory restricted devices this value should "
3429 "be lowered while on systems with a lot of configured sources it should be "
3430 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3431 "of 1048576 (~1 MB) how much the Cache size will be increased in the event "
3432 "the space defined by <literal>Cache-Start</literal> is not enough. These "
3433 "value will be applied again and again until either the cache is big enough "
3434 "to store all information or the size of the cache reaches the "
3435 "<literal>Cache-Limit</literal>. The default of "
3436 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3437 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
3441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3442 #: apt.conf.5.xml:233
3443 msgid "Defines which package(s) are considered essential build dependencies."
3446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3447 #: apt.conf.5.xml:237
3449 "The Get subsection controls the &apt-get; tool, please see its documentation "
3450 "for more information about the options here."
3453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3454 #: apt.conf.5.xml:242
3456 "The Cache subsection controls the &apt-cache; tool, please see its "
3457 "documentation for more information about the options here."
3460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3461 #: apt.conf.5.xml:247
3463 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
3464 "documentation for more information about the options here."
3467 #. type: Content of: <refentry><refsect1><title>
3468 #: apt.conf.5.xml:253
3469 msgid "The Acquire Group"
3472 #. type: Content of: <refentry><refsect1><para>
3473 #: apt.conf.5.xml:254
3475 "The <literal>Acquire</literal> group of options controls the download of "
3476 "packages and the URI handlers."
3479 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3480 #: apt.conf.5.xml:259
3482 "Security related option defaulting to true as an expiring validation for a "
3483 "Release file prevents longtime replay attacks and can e.g. also help users "
3484 "to identify no longer updated mirrors - but the feature depends on the "
3485 "correctness of the time on the user system. Archive maintainers are "
3486 "encouraged to create Release files with the <literal>Valid-Until</literal> "
3487 "header, but if they don't or a stricter value is volitional the following "
3488 "<literal>Max-ValidTime</literal> option can be used."
3491 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3492 #: apt.conf.5.xml:270
3494 "Seconds the Release file should be considered valid after it was created "
3495 "(indicated by the <literal>Date</literal> header). If the Release file "
3496 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
3497 "the two is used as the expiration date. The default value is "
3498 "<literal>0</literal> which stands for \"for ever valid\". Archive specific "
3499 "settings can be made by appending the label of the archive to the option "
3503 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3504 #: apt.conf.5.xml:281
3506 "Minimum of seconds the Release file should be considered valid after it was "
3507 "created (indicated by the <literal>Date</literal> header). Use this if you "
3508 "need to use a seldomly updated (local) mirror of a more regular updated "
3509 "archive with a <literal>Valid-Until</literal> header instead of completely "
3510 "disabling the expiration date checking. Archive specific settings can and "
3511 "should be used by appending the label of the archive to the option name."
3514 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3515 #: apt.conf.5.xml:292
3517 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
3518 "Sources files instead of downloading whole ones. True by default."
3521 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3522 #: apt.conf.5.xml:295
3524 "Two sub-options to limit the use of PDiffs are also available: With "
3525 "<literal>FileLimit</literal> can be specified how many PDiff files are "
3526 "downloaded at most to update a file. <literal>SizeLimit</literal> on the "
3527 "other hand is the maximum percentage of the size of all patches compared to "
3528 "the size of the targeted file. If one of these limits is exceeded the "
3529 "complete file is downloaded instead of the patches."
3532 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3533 #: apt.conf.5.xml:305
3535 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3536 "<literal>host</literal> or <literal>access</literal> which determines how "
3537 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3538 "one connection per target host will be opened, <literal>access</literal> "
3539 "means that one connection per URI type will be opened."
3542 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3543 #: apt.conf.5.xml:313
3545 "Number of retries to perform. If this is non-zero APT will retry failed "
3546 "files the given number of times."
3549 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3550 #: apt.conf.5.xml:318
3552 "Use symlinks for source archives. If set to true then source archives will "
3553 "be symlinked when possible instead of copying. True is the default."
3556 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3557 #: apt.conf.5.xml:323
3559 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
3560 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
3561 "host proxies can also be specified by using the form "
3562 "<literal>http::Proxy::<host></literal> with the special keyword "
3563 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3564 "settings is specified, <envar>http_proxy</envar> environment variable will "
3568 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3569 #: apt.conf.5.xml:331
3571 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3572 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
3573 "response under any circumstances, <literal>Max-Age</literal> is sent only "
3574 "for index files and tells the cache to refresh its object if it is older "
3575 "than the given number of seconds. Debian updates its index files daily so "
3576 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
3577 "should never store this request, it is only set for archive files. This may "
3578 "be useful to prevent polluting a proxy cache with very large .deb "
3579 "files. Note: Squid 2.0.2 does not support any of these options."
3582 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3583 #: apt.conf.5.xml:341 apt.conf.5.xml:407
3585 "The option <literal>timeout</literal> sets the timeout timer used by the "
3586 "method, this applies to all things including connection timeout and data "
3590 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3591 #: apt.conf.5.xml:344
3593 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3594 "enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial "
3595 "e.g. on high-latency connections. It specifies how many requests are send in "
3596 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
3597 "the default value is now 0 (= disabled) to avoid problems with the "
3598 "ever-growing amount of webservers and proxies which choose to not conform to "
3599 "the HTTP/1.1 specification."
3602 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3603 #: apt.conf.5.xml:351
3605 "<literal>Acquire::http::AllowRedirect</literal> controls if APT will follow "
3606 "redirects, which is enabled by default."
3609 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3610 #: apt.conf.5.xml:354
3612 "The used bandwidth can be limited with "
3613 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3614 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
3615 "as much as possible of the bandwidth (Note that this option implicit "
3616 "deactivates the download from multiple servers at the same time.)"
3619 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3620 #: apt.conf.5.xml:359
3622 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3623 "User-Agent for the http download method as some proxies allow access for "
3624 "clients only if the client uses a known identifier."
3627 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3628 #: apt.conf.5.xml:366
3630 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
3631 "options are the same as for <literal>http</literal> method and will also "
3632 "default to the options from the <literal>http</literal> method if they are "
3633 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
3634 "not supported yet."
3637 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3638 #: apt.conf.5.xml:372
3640 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3641 "about trusted certificates. <literal><host>::CaInfo</literal> is "
3642 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3643 "suboption determines whether verify server's host certificate against "
3644 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
3645 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
3646 "suboption determines whether verify server's hostname or not. "
3647 "<literal><host>::Verify-Host</literal> is corresponding per-host "
3648 "option. <literal>SslCert</literal> determines what certificate to use for "
3649 "client authentication. <literal><host>::SslCert</literal> is "
3650 "corresponding per-host option. <literal>SslKey</literal> determines what "
3651 "private key to use for client "
3652 "authentication. <literal><host>::SslKey</literal> is corresponding "
3653 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3654 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
3655 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
3659 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3660 #: apt.conf.5.xml:391
3662 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
3663 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
3664 "proxies can also be specified by using the form "
3665 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3666 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3667 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3668 "used. To use a ftp proxy you will have to set the "
3669 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3670 "entry specifies the commands to send to tell the proxy server what to "
3671 "connect to. Please see &configureindex; for an example of how to do "
3672 "this. The substitution variables available are "
3673 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
3674 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
3675 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
3676 "from it's respective URI component."
3679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3680 #: apt.conf.5.xml:410
3682 "Several settings are provided to control passive mode. Generally it is safe "
3683 "to leave passive mode on, it works in nearly every environment. However "
3684 "some situations require that passive mode be disabled and port mode ftp used "
3685 "instead. This can be done globally, for connections that go through a proxy "
3686 "or for a specific host (See the sample config file for examples)."
3689 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3690 #: apt.conf.5.xml:417
3692 "It is possible to proxy FTP over HTTP by setting the "
3693 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
3694 "discussion of the http method above for syntax. You cannot set this in the "
3695 "configuration file and it is not recommended to use FTP over HTTP due to its "
3699 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3700 #: apt.conf.5.xml:422
3702 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3703 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3704 "false, which means these commands are only used if the control connection is "
3705 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3706 "that most FTP servers do not support RFC2428."
3709 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3710 #: apt.conf.5.xml:435
3712 msgid "/cdrom/::Mount \"foo\";"
3715 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3716 #: apt.conf.5.xml:430
3718 "CD-ROM URIs; the only setting for CD-ROM URIs is the mount point, "
3719 "<literal>cdrom::Mount</literal> which must be the mount point for the CD-ROM "
3720 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
3721 "provide alternate mount and unmount commands if your mount point cannot be "
3722 "listed in the fstab (such as an SMB mount and old mount packages). The "
3723 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3724 "cdrom block. It is important to have the trailing slash. Unmount commands "
3725 "can be specified using UMount."
3728 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3729 #: apt.conf.5.xml:441
3731 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
3732 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
3736 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3737 #: apt.conf.5.xml:452
3740 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3741 "\"<replaceable>Methodname</replaceable>\";"
3744 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3745 #: apt.conf.5.xml:447
3747 "List of compression types which are understood by the acquire methods. "
3748 "Files like <filename>Packages</filename> can be available in various "
3749 "compression formats. Per default the acquire methods can decompress "
3750 "<command>bzip2</command>, <command>lzma</command> and "
3751 "<command>gzip</command> compressed files, with this setting more formats can "
3752 "be added on the fly or the used method can be changed. The syntax for this "
3753 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3756 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3757 #: apt.conf.5.xml:457
3759 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3762 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3763 #: apt.conf.5.xml:460
3765 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3768 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3769 #: apt.conf.5.xml:453
3771 "Also the <literal>Order</literal> subgroup can be used to define in which "
3772 "order the acquire system will try to download the compressed files. The "
3773 "acquire system will try the first and proceed with the next compression type "
3774 "in this list on error, so to prefer one over the other type simple add the "
3775 "preferred type at first - not already added default types will be added at "
3776 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3777 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3778 "over <command>bzip2</command> and <command>lzma</command>. If "
3779 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3780 "<command>bzip2</command> the configure setting should look like this "
3781 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3782 "<literal>bz2</literal> explicit to the list as it will be added automatic."
3785 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3786 #: apt.conf.5.xml:464
3788 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3791 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3792 #: apt.conf.5.xml:462
3794 "Note that at run time the "
3795 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3796 "checked: If this setting exists the method will only be used if this file "
3797 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
3798 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
3799 "the command line will be added at the end of the list specified in the "
3800 "configuration files, but before the default entries. To prefer a type in "
3801 "this case over the ones specified in the configuration files you can set the "
3802 "option direct - not in list style. This will not override the defined list, "
3803 "it will only prefix the list with this type."
3806 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3807 #: apt.conf.5.xml:469
3809 "The special type <literal>uncompressed</literal> can be used to give "
3810 "uncompressed files a preference, but note that most archives don't provide "
3811 "uncompressed files so this is mostly only useable for local mirrors."
3814 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3815 #: apt.conf.5.xml:476
3817 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3818 "Sources, or Translations), keep them gzip compressed locally instead of "
3819 "unpacking them. This saves quite a lot of disk space at the expense of more "
3820 "CPU requirements when building the local package caches. False by default."
3823 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3824 #: apt.conf.5.xml:484
3826 "The Languages subsection controls which <filename>Translation</filename> "
3827 "files are downloaded and in which order APT tries to display the "
3828 "Description-Translations. APT will try to display the first available "
3829 "Description in the Language which is listed at first. Languages can be "
3830 "defined with their short or long Languagecodes. Note that not all archives "
3831 "provide <filename>Translation</filename> files for every Language - "
3832 "especially the long Languagecodes are rare, so please inform you which ones "
3833 "are available before you set here impossible values."
3836 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
3837 #: apt.conf.5.xml:500
3839 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3842 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3843 #: apt.conf.5.xml:490
3845 "The default list includes \"environment\" and "
3846 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
3847 "will be replaced at runtime with the languagecodes extracted from the "
3848 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3849 "that these codes are not included twice in the list. If "
3850 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3851 "<filename>Translation-en</filename> file (if available) will be used. To "
3852 "force apt to use no Translation file use the setting "
3853 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3854 "another special meaning code which will stop the search for a fitting "
3855 "<filename>Translation</filename> file. This can be used by the system "
3856 "administrator to let APT know that it should download also this files "
3857 "without actually use them if the environment doesn't specify this "
3858 "languages. So the following example configuration will result in the order "
3859 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
3860 "that \"fr\" is downloaded, but not used if APT is not used in a french "
3861 "localization, in such an environment the order would be \"fr, de, en\". "
3862 "<placeholder type=\"programlisting\" id=\"0\"/>"
3865 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3866 #: apt.conf.5.xml:501
3868 "Note: To prevent problems resulting from APT being executed in different "
3869 "environments (e.g. by different users or by other programs) all Translation "
3870 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
3871 "added to the end of the list (after an implicit "
3872 "\"<literal>none</literal>\")."
3875 #. type: Content of: <refentry><refsect1><title>
3876 #: apt.conf.5.xml:512
3880 #. type: Content of: <refentry><refsect1><para>
3881 #: apt.conf.5.xml:514
3883 "The <literal>Dir::State</literal> section has directories that pertain to "
3884 "local state information. <literal>lists</literal> is the directory to place "
3885 "downloaded package lists in and <literal>status</literal> is the name of the "
3886 "dpkg status file. <literal>preferences</literal> is the name of the APT "
3887 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
3888 "contains the default directory to prefix on all sub items if they do not "
3889 "start with <filename>/</filename> or <filename>./</filename>."
3892 #. type: Content of: <refentry><refsect1><para>
3893 #: apt.conf.5.xml:521
3895 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
3896 "information, such as the two package caches <literal>srcpkgcache</literal> "
3897 "and <literal>pkgcache</literal> as well as the location to place downloaded "
3898 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
3899 "be turned off by setting their names to be blank. This will slow down "
3900 "startup but save disk space. It is probably preferred to turn off the "
3901 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
3902 "default directory is contained in <literal>Dir::Cache</literal>"
3905 #. type: Content of: <refentry><refsect1><para>
3906 #: apt.conf.5.xml:530
3908 "<literal>Dir::Etc</literal> contains the location of configuration files, "
3909 "<literal>sourcelist</literal> gives the location of the sourcelist and "
3910 "<literal>main</literal> is the default configuration file (setting has no "
3911 "effect, unless it is done from the config file specified by "
3912 "<envar>APT_CONFIG</envar>)."
3915 #. type: Content of: <refentry><refsect1><para>
3916 #: apt.conf.5.xml:536
3918 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
3919 "in lexical order from the directory specified. After this is done then the "
3920 "main config file is loaded."
3923 #. type: Content of: <refentry><refsect1><para>
3924 #: apt.conf.5.xml:540
3926 "Binary programs are pointed to by "
3927 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
3928 "the location of the method handlers and <literal>gzip</literal>, "
3929 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
3930 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
3931 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
3932 "specify the location of the respective programs."
3935 #. type: Content of: <refentry><refsect1><para>
3936 #: apt.conf.5.xml:548
3938 "The configuration item <literal>RootDir</literal> has a special meaning. If "
3939 "set, all paths in <literal>Dir::</literal> will be relative to "
3940 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
3941 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
3942 "set to <filename>/tmp/staging</filename> and "
3943 "<literal>Dir::State::status</literal> is set to "
3944 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
3945 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
3948 #. type: Content of: <refentry><refsect1><para>
3949 #: apt.conf.5.xml:561
3951 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
3952 "which files APT should silently ignore while parsing the files in the "
3953 "fragment directories. Per default a file which end with "
3954 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
3955 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
3956 "default value these patterns can use regular expression syntax."
3959 #. type: Content of: <refentry><refsect1><title>
3960 #: apt.conf.5.xml:570
3961 msgid "APT in DSelect"
3964 #. type: Content of: <refentry><refsect1><para>
3965 #: apt.conf.5.xml:572
3967 "When APT is used as a &dselect; method several configuration directives "
3968 "control the default behaviour. These are in the <literal>DSelect</literal> "
3972 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3973 #: apt.conf.5.xml:577
3975 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
3976 "and never. always and prompt will remove all packages from the cache after "
3977 "upgrading, prompt (the default) does so conditionally. auto removes only "
3978 "those packages which are no longer downloadable (replaced with a new version "
3979 "for instance). pre-auto performs this action before downloading new "
3983 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3984 #: apt.conf.5.xml:586
3986 "The contents of this variable is passed to &apt-get; as command line options "
3987 "when it is run for the install phase."
3990 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3991 #: apt.conf.5.xml:591
3993 "The contents of this variable is passed to &apt-get; as command line options "
3994 "when it is run for the update phase."
3997 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3998 #: apt.conf.5.xml:596
4000 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
4001 "The default is to prompt only on error."
4004 #. type: Content of: <refentry><refsect1><title>
4005 #: apt.conf.5.xml:602
4006 msgid "How APT calls dpkg"
4009 #. type: Content of: <refentry><refsect1><para>
4010 #: apt.conf.5.xml:603
4012 "Several configuration directives control how APT invokes &dpkg;. These are "
4013 "in the <literal>DPkg</literal> section."
4016 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4017 #: apt.conf.5.xml:608
4019 "This is a list of options to pass to dpkg. The options must be specified "
4020 "using the list notation and each list item is passed as a single argument to "
4024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4025 #: apt.conf.5.xml:614
4027 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
4028 "<literal>options</literal> this must be specified in list notation. The "
4029 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4030 "fail APT will abort."
4033 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4034 #: apt.conf.5.xml:621
4036 "This is a list of shell commands to run before invoking dpkg. Like "
4037 "<literal>options</literal> this must be specified in list notation. The "
4038 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4039 "fail APT will abort. APT will pass to the commands on standard input the "
4040 "filenames of all .deb files it is going to install, one per line."
4043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4044 #: apt.conf.5.xml:627
4046 "Version 2 of this protocol dumps more information, including the protocol "
4047 "version, the APT configuration space and the packages, files and versions "
4048 "being changed. Version 2 is enabled by setting "
4049 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
4050 "2. <literal>cmd</literal> is a command given to "
4051 "<literal>Pre-Install-Pkgs</literal>."
4054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4055 #: apt.conf.5.xml:635
4057 "APT chdirs to this directory before invoking dpkg, the default is "
4058 "<filename>/</filename>."
4061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4062 #: apt.conf.5.xml:640
4064 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
4065 "default is to disable signing and produce all binaries."
4068 #. type: Content of: <refentry><refsect1><refsect2><title>
4069 #: apt.conf.5.xml:645
4070 msgid "dpkg trigger usage (and related options)"
4073 #. type: Content of: <refentry><refsect1><refsect2><para>
4074 #: apt.conf.5.xml:646
4076 "APT can call dpkg in a way so it can make aggressive use of triggers over "
4077 "multiple calls of dpkg. Without further options dpkg will use triggers only "
4078 "in between his own run. Activating these options can therefore decrease the "
4079 "time needed to perform the install / upgrade. Note that it is intended to "
4080 "activate these options per default in the future, but as it changes the way "
4081 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
4082 "options are therefore currently experimental and should not be used in "
4083 "productive environments.</emphasis> Also it breaks the progress reporting so "
4084 "all frontends will currently stay around half (or more) of the time in the "
4085 "100% state while it actually configures all packages."
4088 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
4089 #: apt.conf.5.xml:661
4092 "DPkg::NoTriggers \"true\";\n"
4093 "PackageManager::Configure \"smart\";\n"
4094 "DPkg::ConfigurePending \"true\";\n"
4095 "DPkg::TriggersPending \"true\";"
4098 #. type: Content of: <refentry><refsect1><refsect2><para>
4099 #: apt.conf.5.xml:655
4101 "Note that it is not guaranteed that APT will support these options or that "
4102 "these options will not cause (big) trouble in the future. If you have "
4103 "understand the current risks and problems with these options, but are brave "
4104 "enough to help testing them create a new configuration file and test a "
4105 "combination of options. Please report any bugs, problems and improvements "
4106 "you encounter and make sure to note which options you have used in your "
4107 "reports. Asking dpkg for help could also be useful for debugging proposes, "
4108 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
4109 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
4112 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4113 #: apt.conf.5.xml:668
4115 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
4116 "call). See &dpkg; if you are interested in what this actually means. In "
4117 "short: dpkg will not run the triggers when this flag is present unless it is "
4118 "explicitly called to do so in an extra call. Note that this option exists "
4119 "(undocumented) also in older apt versions with a slightly different meaning: "
4120 "Previously these option only append --no-triggers to the configure calls to "
4121 "dpkg - now apt will add these flag also to the unpack and remove calls."
4124 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4125 #: apt.conf.5.xml:676
4127 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
4128 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
4129 "value and causes APT to configure all packages explicit. The "
4130 "\"<literal>smart</literal>\" way is it to configure only packages which need "
4131 "to be configured before another package can be unpacked (Pre-Depends) and "
4132 "let the rest configure by dpkg with a call generated by the next "
4133 "option. \"<literal>no</literal>\" on the other hand will not configure "
4134 "anything and totally rely on dpkg for configuration (which will at the "
4135 "moment fail if a Pre-Depends is encountered). Setting this option to "
4136 "another than the all value will implicitly activate also the next option per "
4137 "default as otherwise the system could end in an unconfigured status which "
4138 "could be unbootable!"
4141 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4142 #: apt.conf.5.xml:687
4144 "If this option is set apt will call <command>dpkg --configure "
4145 "--pending</command> to let dpkg handle all required configurations and "
4146 "triggers. This option is activated automatic per default if the previous "
4147 "option is not set to <literal>all</literal>, but deactivating could be "
4148 "useful if you want to run APT multiple times in a row - e.g. in an "
4149 "installer. In these sceneries you could deactivate this option in all but "
4153 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4154 #: apt.conf.5.xml:694
4156 "Useful for <literal>smart</literal> configuration as a package which has "
4157 "pending triggers is not considered as <literal>installed</literal> and dpkg "
4158 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
4159 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
4160 "triggers, not only the triggers needed to configure this package."
4163 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4164 #: apt.conf.5.xml:700
4166 "As the configuration can be deferred to be done at the end by dpkg it can be "
4167 "tried to order the unpack series only by critical needs, e.g. by "
4168 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
4169 "various steps by everything. While both method were present in earlier APT "
4170 "versions the <literal>OrderCritical</literal> method was unused, so this "
4171 "method is very experimental and needs further improvements before becoming "
4175 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
4176 #: apt.conf.5.xml:715
4179 "OrderList::Score {\n"
4181 "\tEssential 200;\n"
4183 "\tPreDepends 50;\n"
4187 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4188 #: apt.conf.5.xml:708
4190 "Essential packages (and there dependencies) should be configured immediately "
4191 "after unpacking. It will be a good idea to do this quite early in the "
4192 "upgrade process as these these configure calls require currently also "
4193 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
4194 "(which maybe not needed). Essentials get per default a high score but the "
4195 "immediate flag is relatively low (a package which has a Pre-Depends is "
4196 "higher rated). These option and the others in the same group can be used to "
4197 "change the scoring. The following example shows the settings with there "
4198 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
4201 #. type: Content of: <refentry><refsect1><title>
4202 #: apt.conf.5.xml:728
4203 msgid "Periodic and Archives options"
4206 #. type: Content of: <refentry><refsect1><para>
4207 #: apt.conf.5.xml:729
4209 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
4210 "of options configure behavior of apt periodic updates, which is done by "
4211 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
4212 "the brief documentation of these options."
4215 #. type: Content of: <refentry><refsect1><title>
4216 #: apt.conf.5.xml:737
4217 msgid "Debug options"
4220 #. type: Content of: <refentry><refsect1><para>
4221 #: apt.conf.5.xml:739
4223 "Enabling options in the <literal>Debug::</literal> section will cause "
4224 "debugging information to be sent to the standard error stream of the program "
4225 "utilizing the <literal>apt</literal> libraries, or enable special program "
4226 "modes that are primarily useful for debugging the behavior of "
4227 "<literal>apt</literal>. Most of these options are not interesting to a "
4228 "normal user, but a few may be:"
4231 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4232 #: apt.conf.5.xml:750
4234 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
4235 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
4239 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4240 #: apt.conf.5.xml:758
4242 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
4243 "used to run some operations (for instance, <literal>apt-get -s "
4244 "install</literal>) as a non-root user."
4247 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4248 #: apt.conf.5.xml:767
4250 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
4251 "time that <literal>apt</literal> invokes &dpkg;."
4255 #. motivating example, except I haven't a clue why you'd want
4257 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4258 #: apt.conf.5.xml:775
4260 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
4264 #. type: Content of: <refentry><refsect1><para>
4265 #: apt.conf.5.xml:785
4266 msgid "A full list of debugging options to apt follows."
4269 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4270 #: apt.conf.5.xml:794
4271 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
4274 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4275 #: apt.conf.5.xml:805
4276 msgid "Print information related to downloading packages using FTP."
4279 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4280 #: apt.conf.5.xml:816
4281 msgid "Print information related to downloading packages using HTTP."
4284 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4285 #: apt.conf.5.xml:827
4286 msgid "Print information related to downloading packages using HTTPS."
4289 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4290 #: apt.conf.5.xml:838
4292 "Print information related to verifying cryptographic signatures using "
4293 "<literal>gpg</literal>."
4296 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4297 #: apt.conf.5.xml:849
4299 "Output information about the process of accessing collections of packages "
4300 "stored on CD-ROMs."
4303 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4304 #: apt.conf.5.xml:859
4305 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4308 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4309 #: apt.conf.5.xml:869
4311 "Output each cryptographic hash that is generated by the "
4312 "<literal>apt</literal> libraries."
4315 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4316 #: apt.conf.5.xml:879
4318 "Do not include information from <literal>statfs</literal>, namely the number "
4319 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4323 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4324 #: apt.conf.5.xml:890
4326 "Disable all file locking. For instance, this will allow two instances of "
4327 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4330 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4331 #: apt.conf.5.xml:902
4332 msgid "Log when items are added to or removed from the global download queue."
4335 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4336 #: apt.conf.5.xml:912
4338 "Output status messages and errors related to verifying checksums and "
4339 "cryptographic signatures of downloaded files."
4342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4343 #: apt.conf.5.xml:922
4345 "Output information about downloading and applying package index list diffs, "
4346 "and errors relating to package index list diffs."
4349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4350 #: apt.conf.5.xml:934
4352 "Output information related to patching apt package lists when downloading "
4353 "index diffs instead of full indices."
4356 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4357 #: apt.conf.5.xml:945
4358 msgid "Log all interactions with the sub-processes that actually perform downloads."
4361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4362 #: apt.conf.5.xml:956
4364 "Log events related to the automatically-installed status of packages and to "
4365 "the removal of unused packages."
4368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4369 #: apt.conf.5.xml:966
4371 "Generate debug messages describing which packages are being automatically "
4372 "installed to resolve dependencies. This corresponds to the initial "
4373 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4374 "and not to the full <literal>apt</literal> dependency resolver; see "
4375 "<literal>Debug::pkgProblemResolver</literal> for that."
4378 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4379 #: apt.conf.5.xml:980
4381 "Generate debug messages describing which package is marked as "
4382 "keep/install/remove while the ProblemResolver does his work. Each addition "
4383 "or deletion may trigger additional actions; they are shown indented two "
4384 "additional space under the original entry. The format for each line is "
4385 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4386 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4387 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4388 "is the current version of the package, <literal>d.e.f</literal> is the "
4389 "version considered for installation and <literal>x.y.z</literal> is a newer "
4390 "version, but not considered for installation (because of a low pin "
4391 "score). The later two can be omitted if there is none or if it is the same "
4392 "version as the installed. <literal>section</literal> is the name of the "
4393 "section the package appears in."
4396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4397 #: apt.conf.5.xml:1002
4398 msgid "Dump the default configuration to standard error on startup."
4401 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4402 #: apt.conf.5.xml:1012
4404 "When invoking &dpkg;, output the precise command line with which it is being "
4405 "invoked, with arguments separated by a single space character."
4408 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4409 #: apt.conf.5.xml:1023
4411 "Output all the data received from &dpkg; on the status file descriptor and "
4412 "any errors encountered while parsing it."
4415 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4416 #: apt.conf.5.xml:1034
4418 "Generate a trace of the algorithm that decides the order in which "
4419 "<literal>apt</literal> should pass packages to &dpkg;."
4422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4423 #: apt.conf.5.xml:1046
4424 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4427 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4428 #: apt.conf.5.xml:1057
4429 msgid "Output the priority of each package list on startup."
4432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4433 #: apt.conf.5.xml:1067
4435 "Trace the execution of the dependency resolver (this applies only to what "
4436 "happens when a complex dependency problem is encountered)."
4439 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4440 #: apt.conf.5.xml:1078
4442 "Display a list of all installed packages with their calculated score used by "
4443 "the pkgProblemResolver. The description of the package is the same as "
4444 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4447 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4448 #: apt.conf.5.xml:1090
4450 "Print information about the vendors read from "
4451 "<filename>/etc/apt/vendors.list</filename>."
4454 #. type: Content of: <refentry><refsect1><para>
4455 #: apt.conf.5.xml:1113
4457 "&configureindex; is a configuration file showing example values for all "
4461 #. ? reading apt.conf
4462 #. type: Content of: <refentry><refsect1><para>
4463 #: apt.conf.5.xml:1125
4464 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4467 #. type: Content of: <refentry><refnamediv><refpurpose>
4468 #: apt_preferences.5.xml:32
4469 msgid "Preference control file for APT"
4472 #. type: Content of: <refentry><refsect1><para>
4473 #: apt_preferences.5.xml:37
4475 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4476 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4477 "can be used to control which versions of packages will be selected for "
4481 #. type: Content of: <refentry><refsect1><para>
4482 #: apt_preferences.5.xml:42
4484 "Several versions of a package may be available for installation when the "
4485 "&sources-list; file contains references to more than one distribution (for "
4486 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4487 "assigns a priority to each version that is available. Subject to dependency "
4488 "constraints, <command>apt-get</command> selects the version with the highest "
4489 "priority for installation. The APT preferences file overrides the "
4490 "priorities that APT assigns to package versions by default, thus giving the "
4491 "user control over which one is selected for installation."
4494 #. type: Content of: <refentry><refsect1><para>
4495 #: apt_preferences.5.xml:52
4497 "Several instances of the same version of a package may be available when the "
4498 "&sources-list; file contains references to more than one source. In this "
4499 "case <command>apt-get</command> downloads the instance listed earliest in "
4500 "the &sources-list; file. The APT preferences file does not affect the "
4501 "choice of instance, only the choice of version."
4504 #. type: Content of: <refentry><refsect1><para>
4505 #: apt_preferences.5.xml:59
4507 "Preferences are a strong power in the hands of a system administrator but "
4508 "they can become also their biggest nightmare if used without care! APT will "
4509 "not questioning the preferences so wrong settings will therefore lead to "
4510 "uninstallable packages or wrong decisions while upgrading packages. Even "
4511 "more problems will arise if multiply distribution releases are mixed without "
4512 "a good understanding of the following paragraphs. Packages included in a "
4513 "specific release aren't tested in and therefore doesn't always work as "
4514 "expected in older or newer releases or together with other packages from "
4515 "different releases. You have been warned."
4518 #. type: Content of: <refentry><refsect1><para>
4519 #: apt_preferences.5.xml:70
4521 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4522 "directory are parsed in alphanumeric ascending order and need to obey the "
4523 "following naming convention: The files have either no or "
4524 "\"<literal>pref</literal>\" as filename extension and only contain "
4525 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4526 "Otherwise APT will print a notice that it has ignored a file if the file "
4527 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4528 "configuration list - in this case it will be silently ignored."
4531 #. type: Content of: <refentry><refsect1><refsect2><title>
4532 #: apt_preferences.5.xml:79
4533 msgid "APT's Default Priority Assignments"
4536 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4537 #: apt_preferences.5.xml:94
4540 "<command>apt-get install -t testing "
4541 "<replaceable>some-package</replaceable></command>\n"
4544 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4545 #: apt_preferences.5.xml:97
4547 msgid "APT::Default-Release \"stable\";\n"
4550 #. type: Content of: <refentry><refsect1><refsect2><para>
4551 #: apt_preferences.5.xml:81
4553 "If there is no preferences file or if there is no entry in the file that "
4554 "applies to a particular version then the priority assigned to that version "
4555 "is the priority of the distribution to which that version belongs. It is "
4556 "possible to single out a distribution, \"the target release\", which "
4557 "receives a higher priority than other distributions do by default. The "
4558 "target release can be set on the <command>apt-get</command> command line or "
4559 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4560 "that this has precedence over any general priority you set in the "
4561 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4562 "specifically pinned packages. For example, <placeholder "
4563 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4567 #. type: Content of: <refentry><refsect1><refsect2><para>
4568 #: apt_preferences.5.xml:101
4570 "If the target release has been specified then APT uses the following "
4571 "algorithm to set the priorities of the versions of a package. Assign:"
4574 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4575 #: apt_preferences.5.xml:106
4579 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4580 #: apt_preferences.5.xml:107
4582 "to the versions coming from archives which in their "
4583 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4584 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
4585 "<literal>experimental</literal> archive."
4588 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4589 #: apt_preferences.5.xml:113
4590 msgid "priority 100"
4593 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4594 #: apt_preferences.5.xml:114
4596 "to the version that is already installed (if any) and to the versions coming "
4597 "from archives which in their <filename>Release</filename> files are marked "
4598 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
4599 "backports archive since <literal>squeeze-backports</literal>."
4602 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4603 #: apt_preferences.5.xml:121
4604 msgid "priority 500"
4607 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4608 #: apt_preferences.5.xml:122
4610 "to the versions that are not installed and do not belong to the target "
4614 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4615 #: apt_preferences.5.xml:126
4616 msgid "priority 990"
4619 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4620 #: apt_preferences.5.xml:127
4621 msgid "to the versions that are not installed and belong to the target release."
4624 #. type: Content of: <refentry><refsect1><refsect2><para>
4625 #: apt_preferences.5.xml:132
4627 "If the target release has not been specified then APT simply assigns "
4628 "priority 100 to all installed package versions and priority 500 to all "
4629 "uninstalled package versions, except versions coming from archives which in "
4630 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4631 "- these versions get the priority 1 or priority 100 if it is additionally "
4632 "marked as \"ButAutomaticUpgrades: yes\"."
4635 #. type: Content of: <refentry><refsect1><refsect2><para>
4636 #: apt_preferences.5.xml:139
4638 "APT then applies the following rules, listed in order of precedence, to "
4639 "determine which version of a package to install."
4642 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4643 #: apt_preferences.5.xml:142
4645 "Never downgrade unless the priority of an available version exceeds 1000. "
4646 "(\"Downgrading\" is installing a less recent version of a package in place "
4647 "of a more recent version. Note that none of APT's default priorities "
4648 "exceeds 1000; such high priorities can only be set in the preferences file. "
4649 "Note also that downgrading a package can be risky.)"
4652 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4653 #: apt_preferences.5.xml:148
4654 msgid "Install the highest priority version."
4657 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4658 #: apt_preferences.5.xml:149
4660 "If two or more versions have the same priority, install the most recent one "
4661 "(that is, the one with the higher version number)."
4664 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4665 #: apt_preferences.5.xml:152
4667 "If two or more versions have the same priority and version number but either "
4668 "the packages differ in some of their metadata or the "
4669 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4672 #. type: Content of: <refentry><refsect1><refsect2><para>
4673 #: apt_preferences.5.xml:158
4675 "In a typical situation, the installed version of a package (priority 100) "
4676 "is not as recent as one of the versions available from the sources listed in "
4677 "the &sources-list; file (priority 500 or 990). Then the package will be "
4678 "upgraded when <command>apt-get install "
4679 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4680 "upgrade</command> is executed."
4683 #. type: Content of: <refentry><refsect1><refsect2><para>
4684 #: apt_preferences.5.xml:165
4686 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4687 "recent than any of the other available versions. The package will not be "
4688 "downgraded when <command>apt-get install "
4689 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4690 "upgrade</command> is executed."
4693 #. type: Content of: <refentry><refsect1><refsect2><para>
4694 #: apt_preferences.5.xml:170
4696 "Sometimes the installed version of a package is more recent than the version "
4697 "belonging to the target release, but not as recent as a version belonging to "
4698 "some other distribution. Such a package will indeed be upgraded when "
4699 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4700 "or <command>apt-get upgrade</command> is executed, because at least "
4701 "<emphasis>one</emphasis> of the available versions has a higher priority "
4702 "than the installed version."
4705 #. type: Content of: <refentry><refsect1><refsect2><title>
4706 #: apt_preferences.5.xml:179
4707 msgid "The Effect of APT Preferences"
4710 #. type: Content of: <refentry><refsect1><refsect2><para>
4711 #: apt_preferences.5.xml:181
4713 "The APT preferences file allows the system administrator to control the "
4714 "assignment of priorities. The file consists of one or more multi-line "
4715 "records separated by blank lines. Records can have one of two forms, a "
4716 "specific form and a general form."
4719 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4720 #: apt_preferences.5.xml:187
4722 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4723 "specified packages and specified version or version range. For example, the "
4724 "following record assigns a high priority to all versions of the "
4725 "<filename>perl</filename> package whose version number begins with "
4726 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
4729 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4730 #: apt_preferences.5.xml:194
4734 "Pin: version 5.8*\n"
4735 "Pin-Priority: 1001\n"
4738 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4739 #: apt_preferences.5.xml:200
4741 "The general form assigns a priority to all of the package versions in a "
4742 "given distribution (that is, to all the versions of packages that are listed "
4743 "in a certain <filename>Release</filename> file) or to all of the package "
4744 "versions coming from a particular Internet site, as identified by the site's "
4745 "fully qualified domain name."
4748 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4749 #: apt_preferences.5.xml:206
4751 "This general-form entry in the APT preferences file applies only to groups "
4752 "of packages. For example, the following record assigns a high priority to "
4753 "all package versions available from the local site."
4756 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4757 #: apt_preferences.5.xml:211
4761 "Pin: origin \"\"\n"
4762 "Pin-Priority: 999\n"
4765 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4766 #: apt_preferences.5.xml:216
4768 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4769 "which can be used to match a hostname. The following record will assign a "
4770 "high priority to all versions available from the server identified by the "
4771 "hostname \"ftp.de.debian.org\""
4774 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4775 #: apt_preferences.5.xml:220
4779 "Pin: origin \"ftp.de.debian.org\"\n"
4780 "Pin-Priority: 999\n"
4783 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4784 #: apt_preferences.5.xml:224
4786 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4787 "distribution as specified in a <filename>Release</filename> file. What "
4788 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4789 "Internet address but an author or vendor name, such as \"Debian\" or "
4793 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4794 #: apt_preferences.5.xml:229
4796 "The following record assigns a low priority to all package versions "
4797 "belonging to any distribution whose Archive name is "
4798 "\"<literal>unstable</literal>\"."
4801 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4802 #: apt_preferences.5.xml:233
4806 "Pin: release a=unstable\n"
4807 "Pin-Priority: 50\n"
4810 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4811 #: apt_preferences.5.xml:238
4813 "The following record assigns a high priority to all package versions "
4814 "belonging to any distribution whose Codename is "
4815 "\"<literal>&testing-codename;</literal>\"."
4818 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4819 #: apt_preferences.5.xml:242
4823 "Pin: release n=&testing-codename;\n"
4824 "Pin-Priority: 900\n"
4827 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4828 #: apt_preferences.5.xml:247
4830 "The following record assigns a high priority to all package versions "
4831 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4832 "and whose release Version number is \"<literal>3.0</literal>\"."
4835 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4836 #: apt_preferences.5.xml:252
4840 "Pin: release a=stable, v=3.0\n"
4841 "Pin-Priority: 500\n"
4844 #. type: Content of: <refentry><refsect1><refsect2><title>
4845 #: apt_preferences.5.xml:262
4846 msgid "Regular expressions and glob() syntax"
4849 #. type: Content of: <refentry><refsect1><refsect2><para>
4850 #: apt_preferences.5.xml:264
4852 "APT also supports pinning by glob() expressions and regular expressions "
4853 "surrounded by /. For example, the following example assigns the priority 500 "
4854 "to all packages from experimental where the name starts with gnome (as a "
4855 "glob()-like expression) or contains the word kde (as a POSIX extended "
4856 "regular expression surrounded by slashes)."
4859 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4860 #: apt_preferences.5.xml:273
4863 "Package: gnome* /kde/\n"
4864 "Pin: release n=experimental\n"
4865 "Pin-Priority: 500\n"
4868 #. type: Content of: <refentry><refsect1><refsect2><para>
4869 #: apt_preferences.5.xml:279
4871 "The rule for those expressions is that they can occur anywhere where a "
4872 "string can occur. Thus, the following pin assigns the priority 990 to all "
4873 "packages from a release starting with karmic."
4876 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4877 #: apt_preferences.5.xml:285
4881 "Pin: release n=karmic*\n"
4882 "Pin-Priority: 990\n"
4885 #. type: Content of: <refentry><refsect1><refsect2><para>
4886 #: apt_preferences.5.xml:291
4888 "If a regular expression occurs in a <literal>Package</literal> field, the "
4889 "behavior is the same as if this regular expression were replaced with a list "
4890 "of all package names it matches. It is undecided whether this will change in "
4891 "the future, thus you should always list wild-card pins first, so later "
4892 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
4893 "Package field is not considered a glob() expression in itself."
4896 #. type: Content of: <refentry><refsect1><refsect2><title>
4897 #: apt_preferences.5.xml:307
4898 msgid "How APT Interprets Priorities"
4901 #. type: Content of: <refentry><refsect1><refsect2><para>
4902 #: apt_preferences.5.xml:310
4904 "Priorities (P) assigned in the APT preferences file must be positive or "
4905 "negative integers. They are interpreted as follows (roughly speaking):"
4908 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4909 #: apt_preferences.5.xml:315
4913 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4914 #: apt_preferences.5.xml:316
4916 "causes a version to be installed even if this constitutes a downgrade of the "
4920 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4921 #: apt_preferences.5.xml:320
4922 msgid "990 < P <=1000"
4925 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4926 #: apt_preferences.5.xml:321
4928 "causes a version to be installed even if it does not come from the target "
4929 "release, unless the installed version is more recent"
4932 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4933 #: apt_preferences.5.xml:326
4934 msgid "500 < P <=990"
4937 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4938 #: apt_preferences.5.xml:327
4940 "causes a version to be installed unless there is a version available "
4941 "belonging to the target release or the installed version is more recent"
4944 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4945 #: apt_preferences.5.xml:332
4946 msgid "100 < P <=500"
4949 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4950 #: apt_preferences.5.xml:333
4952 "causes a version to be installed unless there is a version available "
4953 "belonging to some other distribution or the installed version is more recent"
4956 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4957 #: apt_preferences.5.xml:338
4958 msgid "0 < P <=100"
4961 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4962 #: apt_preferences.5.xml:339
4964 "causes a version to be installed only if there is no installed version of "
4968 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4969 #: apt_preferences.5.xml:343
4973 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4974 #: apt_preferences.5.xml:344
4975 msgid "prevents the version from being installed"
4978 #. type: Content of: <refentry><refsect1><refsect2><para>
4979 #: apt_preferences.5.xml:349
4981 "If any specific-form records match an available package version then the "
4982 "first such record determines the priority of the package version. Failing "
4983 "that, if any general-form records match an available package version then "
4984 "the first such record determines the priority of the package version."
4987 #. type: Content of: <refentry><refsect1><refsect2><para>
4988 #: apt_preferences.5.xml:355
4990 "For example, suppose the APT preferences file contains the three records "
4991 "presented earlier:"
4994 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
4995 #: apt_preferences.5.xml:359
4999 "Pin: version 5.8*\n"
5000 "Pin-Priority: 1001\n"
5003 "Pin: origin \"\"\n"
5004 "Pin-Priority: 999\n"
5007 "Pin: release unstable\n"
5008 "Pin-Priority: 50\n"
5011 #. type: Content of: <refentry><refsect1><refsect2><para>
5012 #: apt_preferences.5.xml:372
5016 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5017 #: apt_preferences.5.xml:374
5019 "The most recent available version of the <literal>perl</literal> package "
5020 "will be installed, so long as that version's version number begins with "
5021 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
5022 "<literal>perl</literal> is available and the installed version is 5.9*, then "
5023 "<literal>perl</literal> will be downgraded."
5026 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5027 #: apt_preferences.5.xml:379
5029 "A version of any package other than <literal>perl</literal> that is "
5030 "available from the local system has priority over other versions, even "
5031 "versions belonging to the target release."
5034 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5035 #: apt_preferences.5.xml:383
5037 "A version of a package whose origin is not the local system but some other "
5038 "site listed in &sources-list; and which belongs to an "
5039 "<literal>unstable</literal> distribution is only installed if it is selected "
5040 "for installation and no version of the package is already installed."
5043 #. type: Content of: <refentry><refsect1><refsect2><title>
5044 #: apt_preferences.5.xml:393
5045 msgid "Determination of Package Version and Distribution Properties"
5048 #. type: Content of: <refentry><refsect1><refsect2><para>
5049 #: apt_preferences.5.xml:395
5051 "The locations listed in the &sources-list; file should provide "
5052 "<filename>Packages</filename> and <filename>Release</filename> files to "
5053 "describe the packages available at that location."
5056 #. type: Content of: <refentry><refsect1><refsect2><para>
5057 #: apt_preferences.5.xml:399
5059 "The <filename>Packages</filename> file is normally found in the directory "
5060 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
5062 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
5063 "consists of a series of multi-line records, one for each package available "
5064 "in that directory. Only two lines in each record are relevant for setting "
5068 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5069 #: apt_preferences.5.xml:407
5070 msgid "the <literal>Package:</literal> line"
5073 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5074 #: apt_preferences.5.xml:408
5075 msgid "gives the package name"
5078 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5079 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
5080 msgid "the <literal>Version:</literal> line"
5083 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5084 #: apt_preferences.5.xml:412
5085 msgid "gives the version number for the named package"
5088 #. type: Content of: <refentry><refsect1><refsect2><para>
5089 #: apt_preferences.5.xml:417
5091 "The <filename>Release</filename> file is normally found in the directory "
5092 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
5093 "example, <filename>.../dists/stable/Release</filename>, or "
5094 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
5095 "single multi-line record which applies to <emphasis>all</emphasis> of the "
5096 "packages in the directory tree below its parent. Unlike the "
5097 "<filename>Packages</filename> file, nearly all of the lines in a "
5098 "<filename>Release</filename> file are relevant for setting APT priorities:"
5101 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5102 #: apt_preferences.5.xml:428
5103 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
5106 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5107 #: apt_preferences.5.xml:429
5109 "names the archive to which all the packages in the directory tree belong. "
5110 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
5111 "that all of the packages in the directory tree below the parent of the "
5112 "<filename>Release</filename> file are in a <literal>stable</literal> "
5113 "archive. Specifying this value in the APT preferences file would require "
5117 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5118 #: apt_preferences.5.xml:439
5120 msgid "Pin: release a=stable\n"
5123 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5124 #: apt_preferences.5.xml:445
5125 msgid "the <literal>Codename:</literal> line"
5128 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5129 #: apt_preferences.5.xml:446
5131 "names the codename to which all the packages in the directory tree belong. "
5132 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
5133 "the packages in the directory tree below the parent of the "
5134 "<filename>Release</filename> file belong to a version named "
5135 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
5136 "preferences file would require the line:"
5139 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5140 #: apt_preferences.5.xml:455
5142 msgid "Pin: release n=&testing-codename;\n"
5145 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5146 #: apt_preferences.5.xml:462
5148 "names the release version. For example, the packages in the tree might "
5149 "belong to Debian release version 3.0. Note that there is normally no "
5150 "version number for the <literal>testing</literal> and "
5151 "<literal>unstable</literal> distributions because they have not been "
5152 "released yet. Specifying this in the APT preferences file would require one "
5153 "of the following lines."
5156 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5157 #: apt_preferences.5.xml:471
5160 "Pin: release v=3.0\n"
5161 "Pin: release a=stable, v=3.0\n"
5162 "Pin: release 3.0\n"
5165 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5166 #: apt_preferences.5.xml:480
5167 msgid "the <literal>Component:</literal> line"
5170 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5171 #: apt_preferences.5.xml:481
5173 "names the licensing component associated with the packages in the directory "
5174 "tree of the <filename>Release</filename> file. For example, the line "
5175 "\"Component: main\" specifies that all the packages in the directory tree "
5176 "are from the <literal>main</literal> component, which entails that they are "
5177 "licensed under terms listed in the Debian Free Software Guidelines. "
5178 "Specifying this component in the APT preferences file would require the "
5182 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5183 #: apt_preferences.5.xml:490
5185 msgid "Pin: release c=main\n"
5188 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5189 #: apt_preferences.5.xml:496
5190 msgid "the <literal>Origin:</literal> line"
5193 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5194 #: apt_preferences.5.xml:497
5196 "names the originator of the packages in the directory tree of the "
5197 "<filename>Release</filename> file. Most commonly, this is "
5198 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
5199 "file would require the line:"
5202 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5203 #: apt_preferences.5.xml:503
5205 msgid "Pin: release o=Debian\n"
5208 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5209 #: apt_preferences.5.xml:509
5210 msgid "the <literal>Label:</literal> line"
5213 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5214 #: apt_preferences.5.xml:510
5216 "names the label of the packages in the directory tree of the "
5217 "<filename>Release</filename> file. Most commonly, this is "
5218 "<literal>Debian</literal>. Specifying this label in the APT preferences "
5219 "file would require the line:"
5222 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5223 #: apt_preferences.5.xml:516
5225 msgid "Pin: release l=Debian\n"
5228 #. type: Content of: <refentry><refsect1><refsect2><para>
5229 #: apt_preferences.5.xml:523
5231 "All of the <filename>Packages</filename> and <filename>Release</filename> "
5232 "files retrieved from locations listed in the &sources-list; file are stored "
5233 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
5234 "named by the variable <literal>Dir::State::Lists</literal> in the "
5235 "<filename>apt.conf</filename> file. For example, the file "
5236 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
5237 "contains the <filename>Release</filename> file retrieved from the site "
5238 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5239 "architecture files from the <literal>contrib</literal> component of the "
5240 "<literal>unstable</literal> distribution."
5243 #. type: Content of: <refentry><refsect1><refsect2><title>
5244 #: apt_preferences.5.xml:536
5245 msgid "Optional Lines in an APT Preferences Record"
5248 #. type: Content of: <refentry><refsect1><refsect2><para>
5249 #: apt_preferences.5.xml:538
5251 "Each record in the APT preferences file can optionally begin with one or "
5252 "more lines beginning with the word <literal>Explanation:</literal>. This "
5253 "provides a place for comments."
5256 #. type: Content of: <refentry><refsect1><refsect2><title>
5257 #: apt_preferences.5.xml:547
5258 msgid "Tracking Stable"
5261 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5262 #: apt_preferences.5.xml:555
5265 "Explanation: Uninstall or do not install any Debian-originated\n"
5266 "Explanation: package versions other than those in the stable distro\n"
5268 "Pin: release a=stable\n"
5269 "Pin-Priority: 900\n"
5272 "Pin: release o=Debian\n"
5273 "Pin-Priority: -10\n"
5276 #. type: Content of: <refentry><refsect1><refsect2><para>
5277 #: apt_preferences.5.xml:549
5279 "The following APT preferences file will cause APT to assign a priority "
5280 "higher than the default (500) to all package versions belonging to a "
5281 "<literal>stable</literal> distribution and a prohibitively low priority to "
5282 "package versions belonging to other <literal>Debian</literal> "
5283 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5286 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5287 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
5290 "apt-get install <replaceable>package-name</replaceable>\n"
5292 "apt-get dist-upgrade\n"
5295 #. type: Content of: <refentry><refsect1><refsect2><para>
5296 #: apt_preferences.5.xml:567
5298 "With a suitable &sources-list; file and the above preferences file, any of "
5299 "the following commands will cause APT to upgrade to the latest "
5300 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5304 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5305 #: apt_preferences.5.xml:584
5307 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5310 #. type: Content of: <refentry><refsect1><refsect2><para>
5311 #: apt_preferences.5.xml:578
5313 "The following command will cause APT to upgrade the specified package to the "
5314 "latest version from the <literal>testing</literal> distribution; the package "
5315 "will not be upgraded again unless this command is given again. <placeholder "
5316 "type=\"programlisting\" id=\"0\"/>"
5319 #. type: Content of: <refentry><refsect1><refsect2><title>
5320 #: apt_preferences.5.xml:590
5321 msgid "Tracking Testing or Unstable"
5324 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5325 #: apt_preferences.5.xml:599
5329 "Pin: release a=testing\n"
5330 "Pin-Priority: 900\n"
5333 "Pin: release a=unstable\n"
5334 "Pin-Priority: 800\n"
5337 "Pin: release o=Debian\n"
5338 "Pin-Priority: -10\n"
5341 #. type: Content of: <refentry><refsect1><refsect2><para>
5342 #: apt_preferences.5.xml:592
5344 "The following APT preferences file will cause APT to assign a high priority "
5345 "to package versions from the <literal>testing</literal> distribution, a "
5346 "lower priority to package versions from the <literal>unstable</literal> "
5347 "distribution, and a prohibitively low priority to package versions from "
5348 "other <literal>Debian</literal> distributions. <placeholder "
5349 "type=\"programlisting\" id=\"0\"/>"
5352 #. type: Content of: <refentry><refsect1><refsect2><para>
5353 #: apt_preferences.5.xml:613
5355 "With a suitable &sources-list; file and the above preferences file, any of "
5356 "the following commands will cause APT to upgrade to the latest "
5357 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5361 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5362 #: apt_preferences.5.xml:633
5364 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5367 #. type: Content of: <refentry><refsect1><refsect2><para>
5368 #: apt_preferences.5.xml:624
5370 "The following command will cause APT to upgrade the specified package to the "
5371 "latest version from the <literal>unstable</literal> distribution. "
5372 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5373 "the most recent <literal>testing</literal> version if that is more recent "
5374 "than the installed version, otherwise, to the most recent "
5375 "<literal>unstable</literal> version if that is more recent than the "
5376 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5379 #. type: Content of: <refentry><refsect1><refsect2><title>
5380 #: apt_preferences.5.xml:640
5381 msgid "Tracking the evolution of a codename release"
5384 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5385 #: apt_preferences.5.xml:654
5388 "Explanation: Uninstall or do not install any Debian-originated package "
5390 "Explanation: other than those in the distribution codenamed with "
5391 "&testing-codename; or sid\n"
5393 "Pin: release n=&testing-codename;\n"
5394 "Pin-Priority: 900\n"
5396 "Explanation: Debian unstable is always codenamed with sid\n"
5398 "Pin: release n=sid\n"
5399 "Pin-Priority: 800\n"
5402 "Pin: release o=Debian\n"
5403 "Pin-Priority: -10\n"
5406 #. type: Content of: <refentry><refsect1><refsect2><para>
5407 #: apt_preferences.5.xml:642
5409 "The following APT preferences file will cause APT to assign a priority "
5410 "higher than the default (500) to all package versions belonging to a "
5411 "specified codename of a distribution and a prohibitively low priority to "
5412 "package versions belonging to other <literal>Debian</literal> distributions, "
5413 "codenames and archives. Note that with this APT preference APT will follow "
5414 "the migration of a release from the archive <literal>testing</literal> to "
5415 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5416 "want to follow for example the progress in <literal>testing</literal> "
5417 "notwithstanding the codename changes you should use the example "
5418 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5421 #. type: Content of: <refentry><refsect1><refsect2><para>
5422 #: apt_preferences.5.xml:671
5424 "With a suitable &sources-list; file and the above preferences file, any of "
5425 "the following commands will cause APT to upgrade to the latest version(s) in "
5426 "the release codenamed with <literal>&testing-codename;</literal>. "
5427 "<placeholder type=\"programlisting\" id=\"0\"/>"
5430 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5431 #: apt_preferences.5.xml:691
5433 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5436 #. type: Content of: <refentry><refsect1><refsect2><para>
5437 #: apt_preferences.5.xml:682
5439 "The following command will cause APT to upgrade the specified package to the "
5440 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5441 "<command>apt-get upgrade</command> will upgrade the package to the most "
5442 "recent <literal>&testing-codename;</literal> version if that is more recent "
5443 "than the installed version, otherwise, to the most recent "
5444 "<literal>sid</literal> version if that is more recent than the installed "
5445 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5448 #. type: Content of: <refentry><refsect1><para>
5449 #: apt_preferences.5.xml:706
5450 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5453 #. type: Content of: <refentry><refnamediv><refpurpose>
5454 #: sources.list.5.xml:33
5455 msgid "Package resource list for APT"
5458 #. type: Content of: <refentry><refsect1><para>
5459 #: sources.list.5.xml:37
5461 "The package resource list is used to locate archives of the package "
5462 "distribution system in use on the system. At this time, this manual page "
5463 "documents only the packaging system used by the Debian system. This control "
5464 "file is <filename>/etc/apt/sources.list</filename>."
5467 #. type: Content of: <refentry><refsect1><para>
5468 #: sources.list.5.xml:42
5470 "The source list is designed to support any number of active sources and a "
5471 "variety of source media. The file lists one source per line, with the most "
5472 "preferred source listed first. The format of each line is: <literal>type uri "
5473 "args</literal> The first item, <literal>type</literal> determines the format "
5474 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
5475 "Identifier (URI), which is a superset of the more specific and well-known "
5476 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
5477 "comment by using a #."
5480 #. type: Content of: <refentry><refsect1><title>
5481 #: sources.list.5.xml:53
5482 msgid "sources.list.d"
5485 #. type: Content of: <refentry><refsect1><para>
5486 #: sources.list.5.xml:54
5488 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5489 "add sources.list entries in separate files. The format is the same as for "
5490 "the regular <filename>sources.list</filename> file. File names need to end "
5491 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
5492 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
5493 "Otherwise APT will print a notice that it has ignored a file if the file "
5494 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5495 "configuration list - in this case it will be silently ignored."
5498 #. type: Content of: <refentry><refsect1><title>
5499 #: sources.list.5.xml:65
5500 msgid "The deb and deb-src types"
5503 #. type: Content of: <refentry><refsect1><para>
5504 #: sources.list.5.xml:66
5506 "The <literal>deb</literal> type describes a typical two-level Debian "
5507 "archive, <filename>distribution/component</filename>. Typically, "
5508 "<literal>distribution</literal> is generally an archivename like "
5509 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5510 "<literal>&stable-codename;</literal> or "
5511 "<literal>&testing-codename;</literal> while component is one of "
5512 "<literal>main</literal> <literal>contrib</literal> or "
5513 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
5514 "debian distribution's source code in the same form as the "
5515 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5516 "to fetch source indexes."
5519 #. type: Content of: <refentry><refsect1><para>
5520 #: sources.list.5.xml:78
5522 "The format for a <filename>sources.list</filename> entry using the "
5523 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
5526 #. type: Content of: <refentry><refsect1><literallayout>
5527 #: sources.list.5.xml:81
5529 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
5532 #. type: Content of: <refentry><refsect1><para>
5533 #: sources.list.5.xml:83
5535 "The URI for the <literal>deb</literal> type must specify the base of the "
5536 "Debian distribution, from which APT will find the information it needs. "
5537 "<literal>distribution</literal> can specify an exact path, in which case the "
5538 "components must be omitted and <literal>distribution</literal> must end with "
5539 "a slash (/). This is useful for when the case only a particular sub-section "
5540 "of the archive denoted by the URI is of interest. If "
5541 "<literal>distribution</literal> does not specify an exact path, at least one "
5542 "<literal>component</literal> must be present."
5545 #. type: Content of: <refentry><refsect1><para>
5546 #: sources.list.5.xml:92
5548 "<literal>distribution</literal> may also contain a variable, "
5549 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
5550 "m68k, powerpc, ...) used on the system. This permits "
5551 "architecture-independent <filename>sources.list</filename> files to be "
5552 "used. In general this is only of interest when specifying an exact path, "
5553 "<literal>APT</literal> will automatically generate a URI with the current "
5554 "architecture otherwise."
5557 #. type: Content of: <refentry><refsect1><para>
5558 #: sources.list.5.xml:100
5560 "Since only one distribution can be specified per line it may be necessary to "
5561 "have multiple lines for the same URI, if a subset of all available "
5562 "distributions or components at that location is desired. APT will sort the "
5563 "URI list after it has generated a complete set internally, and will collapse "
5564 "multiple references to the same Internet host, for instance, into a single "
5565 "connection, so that it does not inefficiently establish an FTP connection, "
5566 "close it, do something else, and then re-establish a connection to that same "
5567 "host. This feature is useful for accessing busy FTP sites with limits on the "
5568 "number of simultaneous anonymous users. APT also parallelizes connections to "
5569 "different hosts to more effectively deal with sites with low bandwidth."
5572 #. type: Content of: <refentry><refsect1><para>
5573 #: sources.list.5.xml:112
5575 "<literal>options</literal> is always optional and needs to be surounded by "
5576 "square brackets. It can consist of multiple settings in the form "
5577 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
5578 "Multiple settings are separated by spaces. The following settings are "
5579 "supported by APT, note though that unsupported settings will be ignored "
5583 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5584 #: sources.list.5.xml:117
5586 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
5587 "can be used to specify for which architectures packages information should "
5588 "be downloaded. If this option is not set all architectures defined by the "
5589 "<literal>APT::Architectures</literal> option will be downloaded."
5592 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5593 #: sources.list.5.xml:121
5595 "<literal>trusted=yes</literal> can be set to indicate that packages from "
5596 "this source are always authenticated even if the "
5597 "<filename>Release</filename> file is not signed or the signature can't be "
5598 "checked. This disables parts of &apt-secure; and should therefore only be "
5599 "used in a local and trusted context. <literal>trusted=no</literal> is the "
5600 "opposite which handles even correctly authenticated sources as not "
5604 #. type: Content of: <refentry><refsect1><para>
5605 #: sources.list.5.xml:128
5607 "It is important to list sources in order of preference, with the most "
5608 "preferred source listed first. Typically this will result in sorting by "
5609 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5610 "followed by distant Internet hosts, for example)."
5613 #. type: Content of: <refentry><refsect1><para>
5614 #: sources.list.5.xml:133
5615 msgid "Some examples:"
5618 #. type: Content of: <refentry><refsect1><literallayout>
5619 #: sources.list.5.xml:135
5622 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5623 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5628 #. type: Content of: <refentry><refsect1><title>
5629 #: sources.list.5.xml:141
5630 msgid "URI specification"
5633 #. type: Content of: <refentry><refsect1><para>
5634 #: sources.list.5.xml:143
5635 msgid "The currently recognized URI types are:"
5638 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5639 #: sources.list.5.xml:147
5641 "The file scheme allows an arbitrary directory in the file system to be "
5642 "considered an archive. This is useful for NFS mounts and local mirrors or "
5646 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5647 #: sources.list.5.xml:154
5649 "The cdrom scheme allows APT to use a local CD-ROM drive with media "
5650 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5654 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5655 #: sources.list.5.xml:161
5657 "The http scheme specifies an HTTP server for the archive. If an environment "
5658 "variable <envar>http_proxy</envar> is set with the format "
5659 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5660 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5661 "the format http://user:pass@server:port/. Note that this is an insecure "
5662 "method of authentication."
5665 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5666 #: sources.list.5.xml:172
5668 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5669 "is highly configurable; for more information see the &apt-conf; manual "
5670 "page. Please note that a ftp proxy can be specified by using the "
5671 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
5672 "http proxy (http proxy servers often understand ftp urls) using this method "
5673 "and ONLY this method. ftp proxies using http specified in the configuration "
5674 "file will be ignored."
5677 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5678 #: sources.list.5.xml:183
5680 "The copy scheme is identical to the file scheme except that packages are "
5681 "copied into the cache directory instead of used directly at their location. "
5682 "This is useful for people using a zip disk to copy files around with APT."
5685 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5686 #: sources.list.5.xml:190
5688 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
5689 "user and access the files. It is a good idea to do prior arrangements with "
5690 "RSA keys or rhosts. Access to files on the remote uses standard "
5691 "<command>find</command> and <command>dd</command> commands to perform the "
5692 "file transfers from the remote."
5695 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5696 #: sources.list.5.xml:198
5697 msgid "adding more recognizable URI types"
5700 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5701 #: sources.list.5.xml:200
5703 "APT can be extended with more methods shipped in other optional packages "
5704 "which should follow the nameing scheme "
5705 "<package>apt-transport-<replaceable>method</replaceable></package>. The APT "
5706 "team e.g. maintains also the <package>apt-transport-https</package> package "
5707 "which provides access methods for https-URIs with features similar to the "
5708 "http method, but other methods for using e.g. debtorrent are also available, "
5709 "see &apt-transport-debtorrent;."
5712 #. type: Content of: <refentry><refsect1><para>
5713 #: sources.list.5.xml:212
5715 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5716 "stable/main, stable/contrib, and stable/non-free."
5719 #. type: Content of: <refentry><refsect1><literallayout>
5720 #: sources.list.5.xml:214
5722 msgid "deb file:/home/jason/debian stable main contrib non-free"
5725 #. type: Content of: <refentry><refsect1><para>
5726 #: sources.list.5.xml:216
5727 msgid "As above, except this uses the unstable (development) distribution."
5730 #. type: Content of: <refentry><refsect1><literallayout>
5731 #: sources.list.5.xml:217
5733 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5736 #. type: Content of: <refentry><refsect1><para>
5737 #: sources.list.5.xml:219
5738 msgid "Source line for the above"
5741 #. type: Content of: <refentry><refsect1><literallayout>
5742 #: sources.list.5.xml:220
5744 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5747 #. type: Content of: <refentry><refsect1><para>
5748 #: sources.list.5.xml:222
5750 "The first line gets package information for the architectures in "
5751 "<literal>APT::Architectures</literal> while the second always retrieves "
5752 "<literal>amd64</literal> and <literal>armel</literal>."
5755 #. type: Content of: <refentry><refsect1><literallayout>
5756 #: sources.list.5.xml:224
5759 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5760 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5763 #. type: Content of: <refentry><refsect1><para>
5764 #: sources.list.5.xml:227
5766 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5770 #. type: Content of: <refentry><refsect1><literallayout>
5771 #: sources.list.5.xml:229
5773 msgid "deb http://archive.debian.org/debian-archive hamm main"
5776 #. type: Content of: <refentry><refsect1><para>
5777 #: sources.list.5.xml:231
5779 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5780 "directory, and uses only the &stable-codename;/contrib area."
5783 #. type: Content of: <refentry><refsect1><literallayout>
5784 #: sources.list.5.xml:233
5786 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5789 #. type: Content of: <refentry><refsect1><para>
5790 #: sources.list.5.xml:235
5792 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5793 "directory, and uses only the unstable/contrib area. If this line appears as "
5794 "well as the one in the previous example in <filename>sources.list</filename> "
5795 "a single FTP session will be used for both resource lines."
5798 #. type: Content of: <refentry><refsect1><literallayout>
5799 #: sources.list.5.xml:239
5801 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
5804 #. type: Content of: <refentry><refsect1><para><literallayout>
5805 #: sources.list.5.xml:248
5807 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
5810 #. type: Content of: <refentry><refsect1><para>
5811 #: sources.list.5.xml:241
5813 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
5814 "directory, and uses only files found under "
5815 "<filename>unstable/binary-i386</filename> on i386 machines, "
5816 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
5817 "supported architectures. [Note this example only illustrates how to use the "
5818 "substitution variable; official debian archives are not structured like "
5819 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
5822 #. type: Content of: <refentry><refsect1><para>
5823 #: sources.list.5.xml:253
5824 msgid "&apt-cache; &apt-conf;"
5827 #. type: <title></title>
5829 msgid "APT User's Guide"
5832 #. type: <author></author>
5833 #: guide.sgml:6 offline.sgml:6
5834 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
5837 #. type: <version></version>
5839 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
5842 #. type: <abstract></abstract>
5845 "This document provides an overview of how to use the the APT package "
5849 #. type: <copyrightsummary></copyrightsummary>
5851 msgid "Copyright © Jason Gunthorpe, 1998."
5855 #: guide.sgml:21 offline.sgml:22
5857 "\"APT\" and this document are free software; you can redistribute them "
5858 "and/or modify them under the terms of the GNU General Public License as "
5859 "published by the Free Software Foundation; either version 2 of the License, "
5860 "or (at your option) any later version."
5864 #: guide.sgml:24 offline.sgml:25
5866 "For more details, on Debian systems, see the file "
5867 "/usr/share/common-licenses/GPL for the full license."
5870 #. type: <heading></heading>
5878 "The APT package currently contains two sections, the APT "
5879 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
5880 "interface. Both provide a way to install and remove packages as well as "
5881 "download new packages from the Internet."
5884 #. type: <heading></heading>
5886 msgid "Anatomy of the Package System"
5892 "The Debian packaging system has a large amount of information associated "
5893 "with each package to help assure that it integrates cleanly and easily into "
5894 "the system. The most prominent of its features is the dependency system."
5900 "The dependency system allows individual programs to make use of shared "
5901 "elements in the system such as libraries. It simplifies placing infrequently "
5902 "used portions of a program in separate packages to reduce the number of "
5903 "things the average user is required to install. Also, it allows for choices "
5904 "in mail transport agents, X servers and so on."
5910 "The first step to understanding the dependency system is to grasp the "
5911 "concept of a simple dependency. The meaning of a simple dependency is that a "
5912 "package requires another package to be installed at the same time to work "
5919 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
5920 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
5921 "simple dependency on GPG. Also, because it is an emacs extension it has a "
5922 "simple dependency on emacs, without emacs it is completely useless."
5928 "The other important dependency to understand is a conflicting dependency. It "
5929 "means that a package, when installed with another package, will not work and "
5930 "may possibly be extremely harmful to the system. As an example consider a "
5931 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
5932 "have two mail transport agents installed because both need to listen to the "
5933 "network to receive mail. Attempting to install two will seriously damage the "
5934 "system so all mail transport agents have a conflicting dependency with all "
5935 "other mail transport agents."
5941 "As an added complication there is the possibility for a package to pretend "
5942 "to be another package. Consider that exim and sendmail for many intents are "
5943 "identical, they both deliver mail and understand a common interface. Hence, "
5944 "the package system has a way for them to declare that they are both "
5945 "mail-transport-agents. So, exim and sendmail both declare that they provide "
5946 "a mail-transport-agent and other packages that need a mail transport agent "
5947 "depend on mail-transport-agent. This can add a great deal of confusion when "
5948 "trying to manually fix packages."
5954 "At any given time a single dependency may be met by packages that are "
5955 "already installed or it may not be. APT attempts to help resolve dependency "
5956 "issues by providing a number of automatic algorithms that help in selecting "
5957 "packages for installation."
5960 #. type: <heading></heading>
5968 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
5969 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
5970 "understand .deb files, it works with the package's proper name and can only "
5971 "install .deb archives from a <em>Source</em>."
5977 "The first <footnote><p>If you are using an http proxy server you must set "
5978 "the http_proxy environment variable first, see "
5979 "sources.list(5)</p></footnote> thing that should be done before using "
5980 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
5981 "so that it knows what packages are available. This is done with <tt>apt-get "
5982 "update</tt>. For instance,"
5985 #. type: <example></example>
5989 "# apt-get update\n"
5990 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
5991 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
5992 "Reading Package Lists... Done\n"
5993 "Building Dependency Tree... Done"
5996 #. type: <p><taglist>
5998 msgid "Once updated there are several commands that can be used:"
6001 #. type: <tag></tag>
6009 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6010 "install a new package or remove an existing package, nor will it ever "
6011 "upgrade a package that might cause some other package to break. This can be "
6012 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6013 "the packages that it could not upgrade, this usually means that they depend "
6014 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6015 "<tt>apt-get install</tt> can be used to force these packages to install."
6018 #. type: <tag></tag>
6026 "Install is used to install packages by name. The package is automatically "
6027 "fetched and installed. This can be useful if you already know the name of "
6028 "the package to install and do not want to go into a GUI to select it. Any "
6029 "number of packages may be passed to install, they will all be "
6030 "fetched. Install automatically attempts to resolve dependency problems with "
6031 "the listed packages and will print a summary and ask for confirmation if "
6032 "anything other than its arguments are changed."
6035 #. type: <tag></tag>
6037 msgid "dist-upgrade"
6043 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6044 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6045 "set of packages to install, upgrade and remove to get as much of the system "
6046 "to the newest release. In some situations it may be desired to use "
6047 "dist-upgrade rather than spend the time manually resolving dependencies in "
6048 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6049 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6056 "It is important to closely look at what dist-upgrade is going to do, its "
6057 "decisions may sometimes be quite surprising."
6063 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6064 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6065 "option is <tt>-d</tt> which does not install the fetched files. If the "
6066 "system has to download a large number of package it would be undesired to "
6067 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6068 "the downloaded archives can be installed by simply running the command that "
6069 "caused them to be downloaded again without <tt>-d</tt>."
6072 #. type: <heading></heading>
6080 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6081 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6082 "to select the packages to be installed or removed and APT actually installs "
6089 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6090 "and then choose the APT method. You will be prompted for a set of "
6091 "<em>Sources</em> which are places to fetch archives from. These can be "
6092 "remote Internet sites, local Debian mirrors or CD-ROMs. Each source can "
6093 "provide a fragment of the total Debian archive, APT will automatically "
6094 "combine them to form a complete set of packages. If you have a CD-ROM then "
6095 "it is a good idea to specify it first and then specify a mirror so that you "
6096 "have access to the latest bug fixes. APT will automatically use packages on "
6097 "your CD-ROM before downloading from the Internet."
6100 #. type: <example></example>
6104 " Set up a list of distribution source locations\n"
6106 " Please give the base URL of the debian distribution.\n"
6107 " The access schemes I know about are: http file\n"
6110 " file:/mnt/debian,\n"
6111 " ftp://ftp.debian.org/debian,\n"
6112 " http://ftp.de.debian.org/debian,\n"
6115 " URL [http://llug.sep.bnl.gov/debian]:"
6121 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6122 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6126 #. type: <example></example>
6130 " Please give the distribution tag to get or a path to the\n"
6131 " package file ending in a /. The distribution\n"
6132 " tags are typically something like: stable unstable testing non-US\n"
6134 " Distribution [stable]:"
6140 "The distribution refers to the Debian version in the archive, "
6141 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6142 "refers to the developmental version. <em>non-US</em> is only available on "
6143 "some mirrors and refers to packages that contain encryption technology or "
6144 "other things that cannot be exported from the United States. Importing these "
6145 "packages into the US is legal however."
6148 #. type: <example></example>
6152 " Please give the components to get\n"
6153 " The components are typically something like: main contrib non-free\n"
6155 " Components [main contrib non-free]:"
6161 "The components list refers to the list of sub distributions to fetch. The "
6162 "distribution is split up based on software licenses, main being DFSG free "
6163 "packages while contrib and non-free contain things that have various "
6164 "restrictions placed on their use and distribution."
6170 "Any number of sources can be added, the setup script will continue to prompt "
6171 "until you have specified all that you want."
6177 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6178 "available list by selecting [U]pdate from the menu. This is a superset of "
6179 "<tt>apt-get update</tt> that makes the fetched information available to "
6180 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6181 "update</tt> has been run before."
6187 "You can then go on and make your selections using [S]elect and then perform "
6188 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6189 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6196 "By default APT will automatically remove the package (.deb) files once they "
6197 "have been successfully installed. To change this behavior place "
6198 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6201 #. type: <heading></heading>
6203 msgid "The Interface"
6209 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6210 "same interface. It is a simple system that generally tells you what it will "
6211 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6212 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6213 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6214 "alone.</p></footnote> After printing out a summary of what will happen APT "
6215 "then will print out some informative status messages so that you can "
6216 "estimate how far along it is and how much is left to do."
6219 #. type: <heading></heading>
6227 "Before all operations except update, APT performs a number of actions to "
6228 "prepare its internal state. It also does some checks of the system's "
6229 "state. At any time these operations can be performed by running <tt>apt-get "
6233 #. type: <example></example>
6238 "Reading Package Lists... Done\n"
6239 "Building Dependency Tree... Done"
6245 "The first thing it does is read all the package files into memory. APT uses "
6246 "a caching scheme so this operation will be faster the second time it is "
6247 "run. If some of the package files are not found then they will be ignored "
6248 "and a warning will be printed when apt-get exits."
6254 "The final operation performs a detailed analysis of the system's "
6255 "dependencies. It checks every dependency of every installed or unpacked "
6256 "package and considers if it is OK. Should this find a problem then a report "
6257 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6260 #. type: <example></example>
6265 "Reading Package Lists... Done\n"
6266 "Building Dependency Tree... Done\n"
6267 "You might want to run apt-get -f install' to correct these.\n"
6268 "Sorry, but the following packages have unmet dependencies:\n"
6269 " 9fonts: Depends: xlib6g but it is not installed\n"
6270 " uucp: Depends: mailx but it is not installed\n"
6271 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6272 " adduser: Depends: perl-base but it is not installed\n"
6273 " aumix: Depends: libgpmg1 but it is not installed\n"
6274 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6275 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6276 " cthugha: Depends: svgalibg1 but it is not installed\n"
6277 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6278 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6284 "In this example the system has many problems, including a serious problem "
6285 "with libreadlineg2. For each package that has unmet dependencies a line is "
6286 "printed out indicating the package with the problem and the dependencies "
6287 "that are unmet. A short explanation of why the package has a dependency "
6288 "problem is also included."
6294 "There are two ways a system can get into a broken state like this. The first "
6295 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6296 "packages when performing upgrades. <footnote><p>APT however considers all "
6297 "known dependencies and attempts to prevent broken "
6298 "packages</p></footnote>. The second is if a package installation fails "
6299 "during an operation. In this situation a package may have been unpacked "
6300 "without its dependents being installed."
6306 "The second situation is much less serious than the first because APT places "
6307 "certain constraints on the order that packages are installed. In both cases "
6308 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6309 "deduce a possible solution to the problem and then continue on. The APT "
6310 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6311 "for easy continuation of failed maintainer scripts."
6317 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6318 "system caused by the first case then it is possible that it will either fail "
6319 "immediately or the installation sequence will fail. In either case it is "
6320 "necessary to manually use dpkg (possibly with forcing options) to correct "
6321 "the situation enough to allow APT to proceed."
6324 #. type: <heading></heading>
6326 msgid "The Status Report"
6332 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6333 "happen. Generally the report reflects the type of operation being performed "
6334 "but there are several common elements. In all cases the lists reflect the "
6335 "final state of things, taking into account the <tt>-f</tt> option and any "
6336 "other relevant activities to the command being executed."
6339 #. type: <heading></heading>
6341 msgid "The Extra Package list"
6344 #. type: <example></example>
6348 "The following extra packages will be installed:\n"
6349 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6350 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6351 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6352 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6359 "The Extra Package list shows all of the packages that will be installed or "
6360 "upgraded in excess of the ones mentioned on the command line. It is only "
6361 "generated for an <tt>install</tt> command. The listed packages are often the "
6362 "result of an Auto Install."
6365 #. type: <heading></heading>
6367 msgid "The Packages to Remove"
6370 #. type: <example></example>
6374 "The following packages will be REMOVED:\n"
6375 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6376 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6377 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6384 "The Packages to Remove list shows all of the packages that will be removed "
6385 "from the system. It can be shown for any of the operations and should be "
6386 "given a careful inspection to ensure nothing important is to be taken "
6387 "off. The <tt>-f</tt> option is especially good at generating packages to "
6388 "remove so extreme care should be used in that case. The list may contain "
6389 "packages that are going to be removed because they are only partially "
6390 "installed, possibly due to an aborted installation."
6393 #. type: <heading></heading>
6395 msgid "The New Packages list"
6398 #. type: <example></example>
6402 "The following NEW packages will installed:\n"
6403 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6409 "The New Packages list is simply a reminder of what will happen. The packages "
6410 "listed are not presently installed in the system but will be when APT is "
6414 #. type: <heading></heading>
6416 msgid "The Kept Back list"
6419 #. type: <example></example>
6423 "The following packages have been kept back\n"
6424 " compface man-db tetex-base msql libpaper svgalib1\n"
6425 " gs snmp arena lynx xpat2 groff xscreensaver"
6431 "Whenever the whole system is being upgraded there is the possibility that "
6432 "new versions of packages cannot be installed because they require new things "
6433 "or conflict with already installed things. In this case the package will "
6434 "appear in the Kept Back list. The best way to convince packages listed there "
6435 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6436 "to resolve their problems."
6439 #. type: <heading></heading>
6441 msgid "Held Packages warning"
6444 #. type: <example></example>
6448 "The following held packages will be changed:\n"
6455 "Sometimes you can ask APT to install a package that is on hold, in such a "
6456 "case it prints out a warning that the held package is going to be "
6457 "changed. This should only happen during dist-upgrade or install."
6460 #. type: <heading></heading>
6462 msgid "Final summary"
6467 msgid "Finally, APT will print out a summary of all the changes that will occur."
6470 #. type: <example></example>
6474 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6476 "12 packages not fully installed or removed.\n"
6477 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6483 "The first line of the summary simply is a reduced version of all of the "
6484 "lists and includes the number of upgrades - that is packages already "
6485 "installed that have new versions available. The second line indicates the "
6486 "number of poorly configured packages, possibly the result of an aborted "
6487 "installation. The final line shows the space requirements that the "
6488 "installation needs. The first pair of numbers refer to the size of the "
6489 "archive files. The first number indicates the number of bytes that must be "
6490 "fetched from remote locations and the second indicates the total size of all "
6491 "the archives required. The next number indicates the size difference between "
6492 "the presently installed packages and the newly installed packages. It is "
6493 "roughly equivalent to the space required in /usr after everything is "
6494 "done. If a large number of packages are being removed then the value may "
6495 "indicate the amount of space that will be freed."
6501 "Some other reports can be generated by using the -u option to show packages "
6502 "to upgrade, they are similar to the previous examples."
6505 #. type: <heading></heading>
6507 msgid "The Status Display"
6513 "During the download of archives and package files APT prints out a series of "
6517 #. type: <example></example>
6521 "# apt-get update\n"
6522 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6523 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6524 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6525 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6527 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6528 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6534 "The lines starting with <em>Get</em> are printed out when APT begins to "
6535 "fetch a file while the last line indicates the progress of the download. The "
6536 "first percent value on the progress line indicates the total percent done of "
6537 "all files. Unfortunately since the size of the Package files is unknown "
6538 "<tt>apt-get update</tt> estimates the percent done which causes some "
6545 "The next section of the status line is repeated once for each download "
6546 "thread and indicates the operation being performed and some useful "
6547 "information about what is happening. Sometimes this section will simply read "
6548 "<em>Forking</em> which means the OS is loading the download module. The "
6549 "first word after the [ is the fetch number as shown on the history "
6550 "lines. The next word is the short form name of the object being "
6551 "downloaded. For archives it will contain the name of the package that is "
6558 "Inside of the single quote is an informative string indicating the progress "
6559 "of the negotiation phase of the download. Typically it progresses from "
6560 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6561 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6562 "the remote site. Once the download begins this is represented as "
6563 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6564 "kilobytes is expected. The total size is always shown in 4 figure notation "
6565 "to preserve space. After the size display is a percent meter for the file "
6566 "itself. The second last element is the instantaneous average speed. This "
6567 "values is updated every 5 seconds and reflects the rate of data transfer for "
6568 "that period. Finally is shown the estimated transfer time. This is updated "
6569 "regularly and reflects the time to complete everything at the shown transfer "
6576 "The status display updates every half second to provide a constant feedback "
6577 "on the download progress while the Get lines scroll back whenever a new file "
6578 "is started. Since the status display is constantly updated it is unsuitable "
6579 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6583 #. type: <heading></heading>
6591 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6592 "to the <prgn>dpkg</prgn> interface once downloading is "
6593 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6594 "processes the packages and the packages themselves may also ask several "
6595 "questions. Before each question there is usually a description of what it is "
6596 "asking and the questions are too varied to discuss completely here."
6599 #. type: <title></title>
6601 msgid "Using APT Offline"
6604 #. type: <version></version>
6606 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6609 #. type: <abstract></abstract>
6612 "This document describes how to use APT in a non-networked environment, "
6613 "specifically a 'sneaker-net' approach for performing upgrades."
6616 #. type: <copyrightsummary></copyrightsummary>
6618 msgid "Copyright © Jason Gunthorpe, 1999."
6621 #. type: <heading></heading>
6623 msgid "Introduction"
6626 #. type: <heading></heading>
6627 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6634 "Normally APT requires direct access to a Debian archive, either from a local "
6635 "media or through a network. Another common complaint is that a Debian "
6636 "machine is on a slow link, such as a modem and another machine has a very "
6637 "fast connection but they are physically distant."
6643 "The solution to this is to use large removable media such as a Zip disc or a "
6644 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6645 "archive but can easily fit a subset large enough for most users. The idea is "
6646 "to use APT to generate a list of packages that are required and then fetch "
6647 "them onto the disc using another machine with good connectivity. It is even "
6648 "possible to use another Debian machine with APT or to use a completely "
6649 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6650 "the machine downloading the packages, and <em>target host</em> the one with "
6651 "bad or no connection."
6657 "This is achieved by creatively manipulating the APT configuration file. The "
6658 "essential premise to tell APT to look on a disc for it's archive files. Note "
6659 "that the disc should be formated with a filesystem that can handle long file "
6660 "names such as ext2, fat32 or vfat."
6663 #. type: <heading></heading>
6665 msgid "Using APT on both machines"
6668 #. type: <p><example>
6671 "APT being available on both machines gives the simplest configuration. The "
6672 "basic idea is to place a copy of the status file on the disc and use the "
6673 "remote machine to fetch the latest package files and decide which packages "
6674 "to download. The disk directory structure should look like:"
6677 #. type: <example></example>
6691 #. type: <heading></heading>
6693 msgid "The configuration file"
6699 "The configuration file should tell APT to store its files on the disc and to "
6700 "use the configuration files on the disc as well. The sources.list should "
6701 "contain the proper sites that you wish to use from the remote machine, and "
6702 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6703 "<em>target host</em>. Please note, if you are using a local archive you must "
6704 "use copy URIs, the syntax is identical to file URIs."
6707 #. type: <p><example>
6710 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6714 #. type: <example></example>
6720 " /* This is not necessary if the two machines are the same arch, it "
6722 " the remote APT what architecture the target machine is */\n"
6723 " Architecture \"i386\";\n"
6725 " Get::Download-Only \"true\";\n"
6730 " /* Use the disc for state information and redirect the status file from\n"
6731 " the /var/lib/dpkg default */\n"
6732 " State \"/disc/\";\n"
6733 " State::status \"status\";\n"
6735 " // Binary caches will be stored locally\n"
6736 " Cache::archives \"/disc/archives/\";\n"
6737 " Cache \"/tmp/\";\n"
6739 " // Location of the source list.\n"
6740 " Etc \"/disc/\";\n"
6744 #. type: </example></p>
6747 "More details can be seen by examining the apt.conf man page and the sample "
6748 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6751 #. type: <p><example>
6754 "On the target machine the first thing to do is mount the disc and copy "
6755 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6756 "directories outlined in the Overview, <em>archives/partial/</em> and "
6757 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6758 "configure the sources.list. On the remote machine execute the following:"
6761 #. type: <example></example>
6765 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6766 " # apt-get update\n"
6767 " [ APT fetches the package files ]\n"
6768 " # apt-get dist-upgrade\n"
6769 " [ APT fetches all the packages needed to upgrade the target machine ]"
6772 #. type: </example></p>
6775 "The dist-upgrade command can be replaced with any other standard APT "
6776 "commands, particularly dselect-upgrade. You can even use an APT front end "
6777 "such as <em>dselect</em>. However this presents a problem in communicating "
6778 "your selections back to the local computer."
6781 #. type: <p><example>
6784 "Now the disc contains all of the index files and archives needed to upgrade "
6785 "the target machine. Take the disc back and run:"
6788 #. type: <example></example>
6792 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6793 " # apt-get check\n"
6794 " [ APT generates a local copy of the cache files ]\n"
6795 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6796 " [ Or any other APT command ]"
6802 "It is necessary for proper function to re-specify the status file to be the "
6803 "local one. This is very important!"
6809 "If you are using dselect you can do the very risky operation of copying "
6810 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
6811 "remote machine are updated. I highly recommend that people only make "
6812 "selections on the local machine - but this may not always be possible. DO "
6813 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
6816 #. type: <heading></heading>
6818 msgid "Using APT and wget"
6824 "<em>wget</em> is a popular and portable download tool that can run on nearly "
6825 "any machine. Unlike the method above this requires that the Debian machine "
6826 "already has a list of available packages."
6832 "The basic idea is to create a disc that has only the archive files "
6833 "downloaded from the remote site. This is done by using the --print-uris "
6834 "option to apt-get and then preparing a wget script to actually fetch the "
6838 #. type: <heading></heading>
6843 #. type: <p><example>
6846 "Unlike the previous technique no special configuration files are "
6847 "required. We merely use the standard APT commands to generate the file list."
6850 #. type: <example></example>
6854 " # apt-get dist-upgrade \n"
6855 " [ Press no when prompted, make sure you are happy with the actions ]\n"
6856 " # apt-get -qq --print-uris dist-upgrade > uris\n"
6857 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
6860 #. type: </example></p>
6863 "Any command other than dist-upgrade could be used here, including "
6870 "The /disc/wget-script file will now contain a list of wget commands to "
6871 "execute in order to fetch the necessary archives. This script should be run "
6872 "with the current directory as the disc's mount point so as to save the "
6873 "output on the disc."
6876 #. type: <p><example>
6878 msgid "The remote machine would do something like"
6881 #. type: <example></example>
6886 " # sh -x ./wget-script\n"
6890 #. type: </example><example>
6893 "Once the archives are downloaded and the disc returned to the Debian machine "
6894 "installation can proceed using,"
6897 #. type: <example></example>
6900 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
6903 #. type: </example></p>
6905 msgid "Which will use the already fetched archives on the disc."