1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2012-05-21 04:50+0300\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
34 msgid "Debian GNU/Linux"
45 msgid "apt - Advanced Package Tool"
68 "APT is a management system for software packages. For normal day to day "
69 "package management there are several frontends available, such as "
70 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
71 "System. Some options are only implemented in B<apt-get>(8) though."
83 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
84 "B<apt_preferences>(5), B<apt-secure>(8)"
95 msgid "apt returns zero on normal operation, decimal 100 on error."
106 msgid "This manpage isn't even started."
112 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
113 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
114 "B<reportbug>(1) command."
125 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
130 msgid "<!-- -*- mode: sgml; mode: fold -*- -->"
137 "<!-- Boiler plate docinfo section -->\n"
138 "<!ENTITY apt-docinfo \"\n"
140 " <address><email>apt@packages.debian.org</email></address>\n"
142 " <firstname>Jason</firstname> <surname>Gunthorpe</surname>\n"
143 " <contrib></contrib>\n"
145 " <copyright><year>1998-2001</year> <holder>Jason "
146 "Gunthorpe</holder></copyright>\n"
147 " <date>28 October 2008</date>\n"
148 " <productname>Linux</productname>\n"
157 "<!ENTITY apt-author.team \"\n"
159 " <othername>APT team</othername>\n"
160 " <contrib></contrib>\n"
169 "<!ENTITY apt-qapage \"\n"
171 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
180 "<!-- Boiler plate Bug reporting section -->\n"
181 "<!ENTITY manbugs \"\n"
182 " <refsect1><title>Bugs</title>\n"
183 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
184 " If you wish to report a bug in APT, please see\n"
185 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
186 " &reportbug; command.\n"
196 "<!-- Boiler plate Author section -->\n"
197 "<!ENTITY manauthor \"\n"
198 " <refsect1><title>Author</title>\n"
199 " <para>APT was written by the APT team "
200 "<email>apt@packages.debian.org</email>.\n"
210 "<!-- Should be used within the option section of the text to\n"
211 " put in the blurb about -h, -v, -c and -o -->\n"
212 "<!ENTITY apt-commonoptions \"\n"
213 " <varlistentry><term><option>-h</option></term>\n"
214 " <term><option>--help</option></term>\n"
215 " <listitem><para>Show a short usage summary.\n"
226 " <term><option>-v</option></term>\n"
227 " <term><option>--version</option></term>\n"
228 " <listitem><para>Show the program version.\n"
239 " <term><option>-c</option></term>\n"
240 " <term><option>--config-file</option></term>\n"
241 " <listitem><para>Configuration File; Specify a configuration file to "
243 " The program will read the default configuration file and then this \n"
244 " configuration file. If configuration settings need to be set before "
246 " default configuration files are parsed specify a file with the "
247 "<envar>APT_CONFIG</envar>\n"
248 " environment variable. See &apt-conf; for syntax information.\n"
259 " <term><option>-o</option></term>\n"
260 " <term><option>--option</option></term>\n"
261 " <listitem><para>Set a Configuration Option; This will set an "
263 " configuration option. The syntax is <option>-o "
264 "Foo::Bar=bar</option>.\n"
265 " <option>-o</option> and <option>--option</option> can be used "
267 " times to set different options.\n"
278 "<!-- Should be used within the option section of the text to\n"
279 " put in the blurb about -h, -v, -c and -o -->\n"
280 "<!ENTITY apt-cmdblurb \"\n"
281 " <para>All command line options may be set using the configuration file, "
283 " descriptions indicate the configuration option to set. For boolean\n"
284 " options you can override the config file by using something like \n"
285 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
286 " or several other variations.\n"
295 "<!ENTITY file-aptconf \"\n"
296 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
297 " <listitem><para>APT configuration file.\n"
298 " Configuration Item: "
299 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
307 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
308 " <listitem><para>APT configuration file fragments.\n"
309 " Configuration Item: "
310 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
319 "<!ENTITY file-cachearchives \"\n"
320 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
321 " <listitem><para>Storage area for retrieved package files.\n"
322 " Configuration Item: "
323 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
332 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
333 " <listitem><para>Storage area for package files in transit.\n"
334 " Configuration Item: <literal>Dir::Cache::Archives</literal> "
335 "(<filename>partial</filename> will be implicitly "
336 "appended). </para></listitem>\n"
345 "<!ENTITY file-preferences \"\n"
346 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
347 " <listitem><para>Version preferences file.\n"
348 " This is where you would specify "pinning",\n"
349 " i.e. a preference to get certain packages\n"
350 " from a separate source\n"
351 " or from a different version of a distribution.\n"
352 " Configuration Item: "
353 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
362 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
363 " <listitem><para>File fragments for the version preferences.\n"
364 " Configuration Item: "
365 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
374 "<!ENTITY file-sourceslist \"\n"
375 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
376 " <listitem><para>Locations to fetch packages from.\n"
377 " Configuration Item: "
378 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
387 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
388 " <listitem><para>File fragments for locations to fetch packages from.\n"
389 " Configuration Item: "
390 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
399 "<!ENTITY file-statelists \"\n"
400 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
401 " <listitem><para>Storage area for state information for each package "
402 "resource specified in\n"
404 " Configuration Item: "
405 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
414 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
415 " <listitem><para>Storage area for state information in transit.\n"
416 " Configuration Item: <literal>Dir::State::Lists</literal> "
417 "(<filename>partial</filename> will be implicitly "
418 "appended).</para></listitem>\n"
427 "<!ENTITY file-trustedgpg \"\n"
428 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
429 " <listitem><para>Keyring of local trusted keys, new keys will be added "
431 " Configuration Item: "
432 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
441 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
442 " <listitem><para>File fragments for the trusted keys, additional "
444 " be stored here (by other packages or the administrator).\n"
445 " Configuration Item "
446 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
455 "<!ENTITY file-extended_states \"\n"
457 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
458 " <listitem><para>Status list of auto-installed packages.\n"
459 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
460 " </para></listitem>\n"
469 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
471 " to the other headers like NAME and DESCRIPTION and should therefore be "
473 "<!ENTITY translation-title \"TRANSLATION\">\n"
480 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
482 " to the translation in the past, who is responsible now and maybe "
483 "further information\n"
484 " specially related to your translation. -->\n"
485 "<!ENTITY translation-holder \"\n"
486 " The english translation was done by John Doe "
487 "<email>john@doe.org</email> in 2009,\n"
488 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
490 " Debian Dummy l10n Team "
491 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
499 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
500 "untranslated/fuzzy strings\n"
501 " in a shipped manpage newer/modified paragraphs will maybe appear in "
503 " the generated manpage. This sentence is therefore here to tell the "
505 " is not a mistake by the translator - obviously the target is that at "
507 " releases this sentence is not needed. :) -->\n"
508 "<!ENTITY translation-english \"\n"
509 " Note that this translated document may contain untranslated parts.\n"
510 " This is done on purpose, to avoid losing content when the\n"
511 " translation is lagging behind the original content.\n"
518 "<!-- TRANSLATOR: used as in -o=config_string "
519 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
526 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
527 "synopsis-config-file \"config_file\">"
533 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
534 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
535 "\"target_release\">"
541 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
542 "synopsis-architecture \"architecture\">"
548 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
549 "--> <!ENTITY synopsis-pkg \"pkg\">"
555 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
556 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
562 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
563 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
569 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
570 "awesome --> <!ENTITY synopsis-regex \"regex\">"
576 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
577 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
583 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
584 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
585 "\"temporary_directory\">"
591 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
592 "synopsis-filename \"filename\">"
598 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
599 "packages path override-file pathprefix --> <!ENTITY synopsis-path \"path\">"
605 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
606 "packages path override-file pathprefix --> <!ENTITY synopsis-override "
613 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
614 "packages path override-file pathprefix --> <!ENTITY synopsis-pathprefix "
621 "<!-- TRANSLATOR: used as parameter for apt-ftparchive e.g. apt-ftparchive "
622 "generate section --> <!ENTITY synopsis-section \"section\">"
628 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
629 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
632 #. The last update date
633 #. type: Content of: <refentry><refentryinfo>
634 #: apt-cache.8.xml:16
636 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>04 "
637 "February 2011</date>"
640 #. type: Content of: <refentry><refmeta><manvolnum>
641 #: apt-cache.8.xml:26 apt-cdrom.8.xml:25 apt-config.8.xml:26 apt-get.8.xml:26 apt-key.8.xml:18 apt-mark.8.xml:26 apt-secure.8.xml:18
645 #. type: Content of: <refentry><refmeta><refmiscinfo>
646 #: 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:19 apt-mark.8.xml:27 apt-secure.8.xml:19 apt-sortpkgs.1.xml:27 apt.conf.5.xml:33 apt_preferences.5.xml:26 sources.list.5.xml:27
650 #. type: Content of: <refentry><refnamediv><refpurpose>
651 #: apt-cache.8.xml:33
652 msgid "query the APT cache"
655 #. type: Content of: <refentry><refsect1><title>
656 #: 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:30 apt-mark.8.xml:38 apt-secure.8.xml:43 apt-sortpkgs.1.xml:38 apt.conf.5.xml:42 apt_preferences.5.xml:36 sources.list.5.xml:36
660 #. type: Content of: <refentry><refsect1><para>
661 #: apt-cache.8.xml:39
663 "<command>apt-cache</command> performs a variety of operations on APT's "
664 "package cache. <command>apt-cache</command> does not manipulate the state of "
665 "the system but does provide operations to search and generate interesting "
666 "output from the package metadata."
669 #. type: Content of: <refentry><refsect1><para>
670 #: apt-cache.8.xml:44 apt-get.8.xml:44
672 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
673 "one of the commands below must be present."
676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
677 #: apt-cache.8.xml:49
679 "<literal>gencaches</literal> creates APT's package cache. This is done "
680 "implicitly by all commands needing this cache if it is missing or outdated."
683 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
684 #: apt-cache.8.xml:53 apt-cache.8.xml:142 apt-cache.8.xml:163 apt-cache.8.xml:187 apt-cache.8.xml:192 apt-cache.8.xml:208 apt-cache.8.xml:226 apt-cache.8.xml:238
685 msgid "&synopsis-pkg;"
688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
689 #: apt-cache.8.xml:54
691 "<literal>showpkg</literal> displays information about the packages listed on "
692 "the command line. Remaining arguments are package names. The available "
693 "versions and reverse dependencies of each package listed are listed, as well "
694 "as forward dependencies for each version. Forward (normal) dependencies are "
695 "those packages upon which the package in question depends; reverse "
696 "dependencies are those packages that depend upon the package in "
697 "question. Thus, forward dependencies must be satisfied for a package, but "
698 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
699 "libreadline2</command> would produce output similar to the following:"
702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
703 #: apt-cache.8.xml:66
706 "Package: libreadline2\n"
707 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
708 "Reverse Depends: \n"
709 " libreadlineg2,libreadline2\n"
710 " libreadline2-altdev,libreadline2\n"
712 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
715 "Reverse Provides: \n"
718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
719 #: apt-cache.8.xml:78
721 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
722 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
723 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
724 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
725 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
726 "installed. For the specific meaning of the remainder of the output it is "
727 "best to consult the apt source code."
730 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
731 #: apt-cache.8.xml:87
733 "<literal>stats</literal> displays some statistics about the cache. No "
734 "further arguments are expected. Statistics reported are:"
737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
738 #: apt-cache.8.xml:90
740 "<literal>Total package names</literal> is the number of package names found "
744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
745 #: apt-cache.8.xml:94
747 "<literal>Normal packages</literal> is the number of regular, ordinary "
748 "package names; these are packages that bear a one-to-one correspondence "
749 "between their names and the names used by other packages for them in "
750 "dependencies. The majority of packages fall into this category."
753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
754 #: apt-cache.8.xml:100
756 "<literal>Pure virtual packages</literal> is the number of packages that "
757 "exist only as a virtual package name; that is, packages only \"provide\" the "
758 "virtual package name, and no package actually uses the name. For instance, "
759 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
760 "package; several packages provide \"mail-transport-agent\", but there is no "
761 "package named \"mail-transport-agent\"."
764 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
765 #: apt-cache.8.xml:108
767 "<literal>Single virtual packages</literal> is the number of packages with "
768 "only one package providing a particular virtual package. For example, in the "
769 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
770 "one package, xless, provides \"X11-text-viewer\"."
773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
774 #: apt-cache.8.xml:114
776 "<literal>Mixed virtual packages</literal> is the number of packages that "
777 "either provide a particular virtual package or have the virtual package name "
778 "as the package name. For instance, in the Debian GNU/Linux system, "
779 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
784 #: apt-cache.8.xml:121
786 "<literal>Missing</literal> is the number of package names that were "
787 "referenced in a dependency but were not provided by any package. Missing "
788 "packages may be an evidence if a full distribution is not accessed, or if a "
789 "package (real or virtual) has been dropped from the distribution. Usually "
790 "they are referenced from Conflicts or Breaks statements."
793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
794 #: apt-cache.8.xml:128
796 "<literal>Total distinct</literal> versions is the number of package versions "
797 "found in the cache; this value is therefore at least equal to the number of "
798 "total package names. If more than one distribution (both \"stable\" and "
799 "\"unstable\", for instance), is being accessed, this value can be "
800 "considerably larger than the number of total package names."
803 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
804 #: apt-cache.8.xml:135
806 "<literal>Total dependencies</literal> is the number of dependency "
807 "relationships claimed by all of the packages in the cache."
810 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
811 #: apt-cache.8.xml:143
813 "<literal>showsrc</literal> displays all the source package records that "
814 "match the given package names. All versions are shown, as well as all "
815 "records that declare the name to be a Binary."
818 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
819 #: apt-cache.8.xml:149
821 "<literal>dump</literal> shows a short listing of every package in the "
822 "cache. It is primarily for debugging."
825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
826 #: apt-cache.8.xml:154
828 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
829 "suitable for use with &dpkg; and is used by the &dselect; method."
832 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
833 #: apt-cache.8.xml:159
835 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
840 #: apt-cache.8.xml:164
842 "<literal>show</literal> performs a function similar to <command>dpkg "
843 "--print-avail</command>; it displays the package records for the named "
847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
848 #: apt-cache.8.xml:169
849 msgid "&synopsis-regex;"
852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
853 #: apt-cache.8.xml:170
855 "<literal>search</literal> performs a full text search on all available "
856 "package lists for the POSIX regex pattern given, see "
857 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
858 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
859 "the descriptions for an occurrence of the regular expression and prints out "
860 "the package name and the short description, including virtual package "
861 "names. If <option>--full</option> is given then output identical to "
862 "<literal>show</literal> is produced for each matched package, and if "
863 "<option>--names-only</option> is given then the long description is not "
864 "searched, only the package name is."
867 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
868 #: apt-cache.8.xml:183
870 "Separate arguments can be used to specify multiple search patterns that are "
874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
875 #: apt-cache.8.xml:188
877 "<literal>depends</literal> shows a listing of each dependency a package has "
878 "and all the possible other packages that can fulfill that dependency."
881 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
882 #: apt-cache.8.xml:193
884 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
889 #: apt-cache.8.xml:197
890 msgid "<optional><replaceable>&synopsis-prefix;</replaceable></optional>"
893 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
894 #: apt-cache.8.xml:198
896 "This command prints the name of each package APT knows. The optional "
897 "argument is a prefix match to filter the name list. The output is suitable "
898 "for use in a shell tab complete function and the output is generated "
899 "extremely quickly. This command is best used with the "
900 "<option>--generate</option> option."
903 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
904 #: apt-cache.8.xml:203
906 "Note that a package which APT knows of is not necessarily available to "
907 "download, installable or installed, e.g. virtual packages are also listed in "
908 "the generated list."
911 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
912 #: apt-cache.8.xml:209
914 "<literal>dotty</literal> takes a list of packages on the command line and "
915 "generates output suitable for use by dotty from the <ulink "
916 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
917 "package. The result will be a set of nodes and edges representing the "
918 "relationships between the packages. By default the given packages will trace "
919 "out all dependent packages; this can produce a very large graph. To limit "
920 "the output to only the packages listed on the command line, set the "
921 "<literal>APT::Cache::GivenOnly</literal> option."
924 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
925 #: apt-cache.8.xml:218
927 "The resulting nodes will have several shapes; normal packages are boxes, "
928 "pure provides are triangles, mixed provides are diamonds, missing packages "
929 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
930 "lines are pre-depends, green lines are conflicts."
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
934 #: apt-cache.8.xml:223
935 msgid "Caution, dotty cannot graph larger sets of packages."
938 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
939 #: apt-cache.8.xml:227
941 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
942 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
947 #: apt-cache.8.xml:231
948 msgid "<optional><replaceable>&synopsis-pkg;</replaceable>…</optional>"
951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
952 #: apt-cache.8.xml:232
954 "<literal>policy</literal> is meant to help debug issues relating to the "
955 "preferences file. With no arguments it will print out the priorities of each "
956 "source. Otherwise it prints out detailed information about the priority "
957 "selection of the named package."
960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
961 #: apt-cache.8.xml:239
963 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
964 "to mimic the output format and a subset of the functionality of the Debian "
965 "archive management tool, <literal>madison</literal>. It displays available "
966 "versions of a package in a tabular format. Unlike the original "
967 "<literal>madison</literal>, it can only display information for the "
968 "architecture for which APT has retrieved package lists "
969 "(<literal>APT::Architecture</literal>)."
972 #. type: Content of: <refentry><refsect1><title>
973 #: apt-cache.8.xml:250 apt-config.8.xml:84 apt-extracttemplates.1.xml:52 apt-ftparchive.1.xml:504 apt-get.8.xml:259 apt-mark.8.xml:108 apt-sortpkgs.1.xml:48
977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
978 #: apt-cache.8.xml:255
980 "Select the file to store the package cache. The package cache is the primary "
981 "cache used by all operations. Configuration Item: "
982 "<literal>Dir::Cache::pkgcache</literal>."
985 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
986 #: apt-cache.8.xml:261
988 "Select the file to store the source cache. The source is used only by "
989 "<literal>gencaches</literal> and it stores a parsed version of the package "
990 "information from remote sources. When building the package cache the source "
991 "cache is used to avoid reparsing all of the package files. Configuration "
992 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
996 #: apt-cache.8.xml:269
998 "Quiet; produces output suitable for logging, omitting progress indicators. "
999 "More q's will produce more quietness up to a maximum of 2. You can also use "
1000 "<option>-q=#</option> to set the quietness level, overriding the "
1001 "configuration file. Configuration Item: <literal>quiet</literal>."
1004 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1005 #: apt-cache.8.xml:276
1007 "Print only important dependencies; for use with unmet and depends. Causes "
1008 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
1009 "<literal>APT::Cache::Important</literal>."
1012 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1013 #: apt-cache.8.xml:289
1015 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1016 "print all dependencies. This can be tweaked with these flags which will omit "
1017 "the specified dependency type. Configuration Item: "
1018 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1019 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1022 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1023 #: apt-cache.8.xml:296
1025 "Print full package records when searching. Configuration Item: "
1026 "<literal>APT::Cache::ShowFull</literal>."
1029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1030 #: apt-cache.8.xml:301
1032 "Print full records for all available versions. This is the default; to turn "
1033 "it off, use <option>--no-all-versions</option>. If "
1034 "<option>--no-all-versions</option> is specified, only the candidate version "
1035 "will displayed (the one which would be selected for installation). This "
1036 "option is only applicable to the <literal>show</literal> command. "
1037 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1041 #: apt-cache.8.xml:310
1043 "Perform automatic package cache regeneration, rather than use the cache as "
1044 "it is. This is the default; to turn it off, use "
1045 "<option>--no-generate</option>. Configuration Item: "
1046 "<literal>APT::Cache::Generate</literal>."
1049 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1050 #: apt-cache.8.xml:316
1052 "Only search on the package names, not the long descriptions. Configuration "
1053 "Item: <literal>APT::Cache::NamesOnly</literal>."
1056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1057 #: apt-cache.8.xml:321
1059 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1060 "and missing dependencies. Configuration Item: "
1061 "<literal>APT::Cache::AllNames</literal>."
1064 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1065 #: apt-cache.8.xml:327
1067 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1068 "that all packages mentioned are printed once. Configuration Item: "
1069 "<literal>APT::Cache::RecurseDepends</literal>."
1072 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1073 #: apt-cache.8.xml:334
1075 "Limit the output of <literal>depends</literal> and "
1076 "<literal>rdepends</literal> to packages which are currently installed. "
1077 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1080 #. type: Content of: <refentry><refsect1><variablelist>
1081 #: apt-cache.8.xml:339 apt-cdrom.8.xml:140 apt-config.8.xml:104 apt-extracttemplates.1.xml:63 apt-ftparchive.1.xml:591 apt-get.8.xml:514 apt-mark.8.xml:122 apt-sortpkgs.1.xml:58
1082 msgid "&apt-commonoptions;"
1085 #. type: Content of: <refentry><refsect1><title>
1086 #: apt-cache.8.xml:344 apt-get.8.xml:519 apt-key.8.xml:167 apt-mark.8.xml:126 apt.conf.5.xml:1119 apt_preferences.5.xml:698
1090 #. type: Content of: <refentry><refsect1><variablelist>
1091 #: apt-cache.8.xml:346
1092 msgid "&file-sourceslist; &file-statelists;"
1095 #. type: Content of: <refentry><refsect1><title>
1096 #: apt-cache.8.xml:351 apt-cdrom.8.xml:145 apt-config.8.xml:109 apt-extracttemplates.1.xml:70 apt-ftparchive.1.xml:607 apt-get.8.xml:529 apt-key.8.xml:188 apt-mark.8.xml:132 apt-secure.8.xml:185 apt-sortpkgs.1.xml:63 apt.conf.5.xml:1125 apt_preferences.5.xml:705 sources.list.5.xml:255
1100 #. type: Content of: <refentry><refsect1><para>
1101 #: apt-cache.8.xml:352
1102 msgid "&apt-conf;, &sources-list;, &apt-get;"
1105 #. type: Content of: <refentry><refsect1><title>
1106 #: apt-cache.8.xml:356 apt-cdrom.8.xml:150 apt-config.8.xml:114 apt-extracttemplates.1.xml:74 apt-ftparchive.1.xml:611 apt-get.8.xml:535 apt-mark.8.xml:136 apt-sortpkgs.1.xml:67
1110 #. type: Content of: <refentry><refsect1><para>
1111 #: apt-cache.8.xml:357
1113 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1117 #. type: Content of: <refentry><refentryinfo>
1118 #: apt-cdrom.8.xml:16
1120 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>14 "
1121 "February 2004</date>"
1124 #. type: Content of: <refentry><refnamediv><refpurpose>
1125 #: apt-cdrom.8.xml:32
1126 msgid "APT CDROM management utility"
1129 #. type: Content of: <refentry><refsect1><para>
1130 #: apt-cdrom.8.xml:38
1132 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1133 "available sources. <command>apt-cdrom</command> takes care of determining "
1134 "the structure of the disc as well as correcting for several possible "
1135 "mis-burns and verifying the index files."
1138 #. type: Content of: <refentry><refsect1><para>
1139 #: apt-cdrom.8.xml:45
1141 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1142 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1143 "must be inserted and scanned separately to account for possible mis-burns."
1146 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1147 #: apt-cdrom.8.xml:56
1149 "<literal>add</literal> is used to add a new disc to the source list. It will "
1150 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1151 "to scan it and copy the index files. If the disc does not have a proper "
1152 "<filename>disk</filename> directory you will be prompted for a descriptive "
1156 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1157 #: apt-cdrom.8.xml:64
1159 "APT uses a CDROM ID to track which disc is currently in the drive and "
1160 "maintains a database of these IDs in "
1161 "<filename>&statedir;/cdroms.list</filename>"
1164 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1165 #: apt-cdrom.8.xml:72
1167 "A debugging tool to report the identity of the current disc as well as the "
1171 #. type: Content of: <refentry><refsect1><para>
1172 #: apt-cdrom.8.xml:51
1174 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1175 "one of the commands below must be present. <placeholder "
1176 "type=\"variablelist\" id=\"0\"/>"
1179 #. type: Content of: <refentry><refsect1><title>
1180 #: apt-cdrom.8.xml:81 apt-key.8.xml:153
1184 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1185 #: apt-cdrom.8.xml:86
1187 "Mount point; specify the location to mount the cdrom. This mount point must "
1188 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1189 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1192 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1193 #: apt-cdrom.8.xml:95
1195 "Rename a disc; change the label of a disk or override the disks given "
1196 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1197 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1200 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1201 #: apt-cdrom.8.xml:104
1203 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1204 "unmounting the mount point. Configuration Item: "
1205 "<literal>APT::CDROM::NoMount</literal>."
1208 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1209 #: apt-cdrom.8.xml:112
1211 "Fast Copy; Assume the package files are valid and do not check every "
1212 "package. This option should be used only if <command>apt-cdrom</command> has "
1213 "been run on this disc before and did not detect any errors. Configuration "
1214 "Item: <literal>APT::CDROM::Fast</literal>."
1217 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1218 #: apt-cdrom.8.xml:122
1220 "Thorough Package Scan; This option may be needed with some old Debian "
1221 "1.1/1.2 discs that have Package files in strange places. It takes much "
1222 "longer to scan the CD but will pick them all up."
1225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1226 #: apt-cdrom.8.xml:133
1228 "No Changes; Do not change the &sources-list; file and do not write index "
1229 "files. Everything is still checked however. Configuration Item: "
1230 "<literal>APT::CDROM::NoAct</literal>."
1233 #. type: Content of: <refentry><refsect1><para>
1234 #: apt-cdrom.8.xml:146
1235 msgid "&apt-conf;, &apt-get;, &sources-list;"
1238 #. type: Content of: <refentry><refsect1><para>
1239 #: apt-cdrom.8.xml:151
1241 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1245 #. The last update date
1246 #. type: Content of: <refentry><refentryinfo>
1247 #: apt-config.8.xml:16 apt-extracttemplates.1.xml:16 apt-sortpkgs.1.xml:16 sources.list.5.xml:16
1249 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>29 "
1250 "February 2004</date>"
1253 #. type: Content of: <refentry><refnamediv><refpurpose>
1254 #: apt-config.8.xml:33
1255 msgid "APT Configuration Query program"
1258 #. type: Content of: <refentry><refsect1><para>
1259 #: apt-config.8.xml:39
1261 "<command>apt-config</command> is an internal program used by various "
1262 "portions of the APT suite to provide consistent configurability. It accesses "
1263 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1264 "manner that is easy to use by scripted applications."
1267 #. type: Content of: <refentry><refsect1><para>
1268 #: apt-config.8.xml:44 apt-ftparchive.1.xml:54
1270 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1271 "one of the commands below must be present."
1274 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1275 #: apt-config.8.xml:51
1277 "shell is used to access the configuration information from a shell "
1278 "script. It is given pairs of arguments, the first being a shell variable and "
1279 "the second the configuration value to query. As output it lists a series of "
1280 "shell assignments commands for each present value. In a shell script it "
1281 "should be used like:"
1284 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1285 #: apt-config.8.xml:59
1289 "RES=`apt-config shell OPTS MyApp::options`\n"
1293 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1294 #: apt-config.8.xml:64
1296 "This will set the shell environment variable $OPTS to the value of "
1297 "MyApp::options with a default of <option>-f</option>."
1300 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1301 #: apt-config.8.xml:68
1303 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1304 "names, d returns directories, b returns true or false and i returns an "
1305 "integer. Each of the returns is normalized and verified internally."
1308 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1309 #: apt-config.8.xml:77
1310 msgid "Just show the contents of the configuration space."
1313 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1314 #: apt-config.8.xml:90
1316 "Include options which have an empty value. This is the default, so use "
1317 "--no-empty to remove them from the output."
1320 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><replaceable>
1321 #: apt-config.8.xml:95
1322 msgid "%f "%v";%n"
1325 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1326 #: apt-config.8.xml:96
1328 "Defines the output of each config option. %t will be replaced with "
1329 "the name of the option, %f with the complete optionname and %v "
1330 "with the value of the option. Use uppercase letters and special characters "
1331 "in the value will be encoded to ensure that it can e.g. be savely used in a "
1332 "quoted-string as defined by RFC822. Additionally %n will be replaced "
1333 "by a newline, %N by a tab. A % can be printed by using "
1337 #. type: Content of: <refentry><refsect1><para>
1338 #: apt-config.8.xml:110 apt-extracttemplates.1.xml:71 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1342 #. type: Content of: <refentry><refsect1><para>
1343 #: apt-config.8.xml:115
1345 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1349 #. type: Content of: <refentry><refmeta><manvolnum>
1350 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1354 #. type: Content of: <refentry><refnamediv><refpurpose>
1355 #: apt-extracttemplates.1.xml:33
1356 msgid "Utility to extract DebConf config and templates from Debian packages"
1359 #. type: Content of: <refentry><refsect1><para>
1360 #: apt-extracttemplates.1.xml:39
1362 "<command>apt-extracttemplates</command> will take one or more Debian package "
1363 "files as input and write out (to a temporary directory) all associated "
1364 "config scripts and template files. For each passed in package that contains "
1365 "config scripts and templates, one line of output will be generated in the "
1369 #. type: Content of: <refentry><refsect1><para>
1370 #: apt-extracttemplates.1.xml:44
1371 msgid "package version template-file config-script"
1374 #. type: Content of: <refentry><refsect1><para>
1375 #: apt-extracttemplates.1.xml:45
1377 "template-file and config-script are written to the temporary directory "
1378 "specified by the <option>-t</option> or <option>--tempdir</option> "
1379 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1380 "filenames of the form <filename>package.template.XXXX</filename> and "
1381 "<filename>package.config.XXXX</filename>"
1384 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1385 #: apt-extracttemplates.1.xml:58
1387 "Temporary directory in which to write extracted debconf template files and "
1388 "config scripts. Configuration Item: "
1389 "<literal>APT::ExtractTemplates::TempDir</literal>"
1392 #. type: Content of: <refentry><refsect1><para>
1393 #: apt-extracttemplates.1.xml:75
1395 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1396 "decimal 100 on error."
1399 #. The last update date
1400 #. type: Content of: <refentry><refentryinfo>
1401 #: apt-ftparchive.1.xml:16
1403 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>17 "
1404 "August 2009</date>"
1407 #. type: Content of: <refentry><refnamediv><refpurpose>
1408 #: apt-ftparchive.1.xml:33
1409 msgid "Utility to generate index files"
1412 #. type: Content of: <refentry><refsect1><para>
1413 #: apt-ftparchive.1.xml:39
1415 "<command>apt-ftparchive</command> is the command line tool that generates "
1416 "the index files that APT uses to access a distribution source. The index "
1417 "files should be generated on the origin site based on the content of that "
1421 #. type: Content of: <refentry><refsect1><para>
1422 #: apt-ftparchive.1.xml:43
1424 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1425 "program, incorporating its entire functionality via the "
1426 "<literal>packages</literal> command. It also contains a contents file "
1427 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1428 "the generation process for a complete archive."
1431 #. type: Content of: <refentry><refsect1><para>
1432 #: apt-ftparchive.1.xml:49
1434 "Internally <command>apt-ftparchive</command> can make use of binary "
1435 "databases to cache the contents of a .deb file and it does not rely on any "
1436 "external programs aside from &gzip;. When doing a full generate it "
1437 "automatically performs file-change checks and builds the desired compressed "
1441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1442 #: apt-ftparchive.1.xml:60
1444 "The packages command generates a package file from a directory tree. It "
1445 "takes the given directory and recursively searches it for .deb files, "
1446 "emitting a package record to stdout for each. This command is approximately "
1447 "equivalent to &dpkg-scanpackages;."
1450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1451 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1452 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1456 #: apt-ftparchive.1.xml:70
1458 "The <literal>sources</literal> command generates a source index file from a "
1459 "directory tree. It takes the given directory and recursively searches it "
1460 "for .dsc files, emitting a source record to stdout for each. This command is "
1461 "approximately equivalent to &dpkg-scansources;."
1464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1465 #: apt-ftparchive.1.xml:75
1467 "If an override file is specified then a source override file will be looked "
1468 "for with an extension of .src. The --source-override option can be used to "
1469 "change the source override file that will be used."
1472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1473 #: apt-ftparchive.1.xml:82
1475 "The <literal>contents</literal> command generates a contents file from a "
1476 "directory tree. It takes the given directory and recursively searches it for "
1477 ".deb files, and reads the file list from each file. It then sorts and writes "
1478 "to stdout the list of files matched to packages. Directories are not written "
1479 "to the output. If multiple packages own the same file then each package is "
1480 "separated by a comma in the output."
1483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1484 #: apt-ftparchive.1.xml:94
1486 "The <literal>release</literal> command generates a Release file from a "
1487 "directory tree. It recursively searches the given directory for uncompressed "
1488 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1489 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1490 "<command>lzma</command> as well as <filename>Release</filename> and "
1491 "<filename>md5sum.txt</filename> files by default "
1492 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1493 "filename patterns can be added by listing them in "
1494 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1495 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1500 #: apt-ftparchive.1.xml:104
1502 "Values for the additional metadata fields in the Release file are taken from "
1503 "the corresponding variables under "
1504 "<literal>APT::FTPArchive::Release</literal>, "
1505 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1506 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1507 "<literal>Suite</literal>, <literal>Version</literal>, "
1508 "<literal>Codename</literal>, <literal>Date</literal>, "
1509 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1510 "<literal>Components</literal>, <literal>Description</literal>."
1513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1514 #: apt-ftparchive.1.xml:117
1516 "The <literal>generate</literal> command is designed to be runnable from a "
1517 "cron script and builds indexes according to the given config file. The "
1518 "config language provides a flexible means of specifying which index files "
1519 "are built from which directories, as well as providing a simple means of "
1520 "maintaining the required settings."
1523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1524 #: apt-ftparchive.1.xml:126
1526 "The <literal>clean</literal> command tidies the databases used by the given "
1527 "configuration file by removing any records that are no longer necessary."
1530 #. type: Content of: <refentry><refsect1><title>
1531 #: apt-ftparchive.1.xml:132
1532 msgid "The Generate Configuration"
1535 #. type: Content of: <refentry><refsect1><para>
1536 #: apt-ftparchive.1.xml:134
1538 "The <literal>generate</literal> command uses a configuration file to "
1539 "describe the archives that are going to be generated. It follows the typical "
1540 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1541 "&apt-conf; contains a description of the syntax. Note that the generate "
1542 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1543 "tree manner. This only effects how the scope tag is handled."
1546 #. type: Content of: <refentry><refsect1><para>
1547 #: apt-ftparchive.1.xml:142
1548 msgid "The generate configuration has 4 separate sections, each described below."
1551 #. type: Content of: <refentry><refsect1><refsect2><title>
1552 #: apt-ftparchive.1.xml:144
1556 #. type: Content of: <refentry><refsect1><refsect2><para>
1557 #: apt-ftparchive.1.xml:146
1559 "The <literal>Dir</literal> section defines the standard directories needed "
1560 "to locate the files required during the generation process. These "
1561 "directories are prepended certain relative paths defined in later sections "
1562 "to produce a complete an absolute path."
1565 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1566 #: apt-ftparchive.1.xml:153
1568 "Specifies the root of the FTP archive, in a standard Debian configuration "
1569 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1573 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1574 #: apt-ftparchive.1.xml:160
1575 msgid "Specifies the location of the override files."
1578 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1579 #: apt-ftparchive.1.xml:165
1580 msgid "Specifies the location of the cache files"
1583 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1584 #: apt-ftparchive.1.xml:170
1586 "Specifies the location of the file list files, if the "
1587 "<literal>FileList</literal> setting is used below."
1590 #. type: Content of: <refentry><refsect1><refsect2><title>
1591 #: apt-ftparchive.1.xml:176
1592 msgid "Default Section"
1595 #. type: Content of: <refentry><refsect1><refsect2><para>
1596 #: apt-ftparchive.1.xml:178
1598 "The <literal>Default</literal> section specifies default values, and "
1599 "settings that control the operation of the generator. Other sections may "
1600 "override these defaults with a per-section setting."
1603 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1604 #: apt-ftparchive.1.xml:184
1606 "Sets the default compression schemes to use for the Package index files. It "
1607 "is a string that contains a space separated list of at least one of: '.' (no "
1608 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1612 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1613 #: apt-ftparchive.1.xml:192
1615 "Sets the default list of file extensions that are package files. This "
1616 "defaults to '.deb'."
1619 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1620 #: apt-ftparchive.1.xml:198
1622 "This is similar to <literal>Packages::Compress</literal> except that it "
1623 "controls the compression for the Sources files."
1626 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1627 #: apt-ftparchive.1.xml:204
1629 "Sets the default list of file extensions that are source files. This "
1630 "defaults to '.dsc'."
1633 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1634 #: apt-ftparchive.1.xml:210
1636 "This is similar to <literal>Packages::Compress</literal> except that it "
1637 "controls the compression for the Contents files."
1640 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1641 #: apt-ftparchive.1.xml:216
1643 "This is similar to <literal>Packages::Compress</literal> except that it "
1644 "controls the compression for the Translation-en master file."
1647 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1648 #: apt-ftparchive.1.xml:222
1650 "Specifies the number of kilobytes to delink (and replace with hard links) "
1651 "per run. This is used in conjunction with the per-section "
1652 "<literal>External-Links</literal> setting."
1655 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1656 #: apt-ftparchive.1.xml:229
1658 "Specifies the mode of all created index files. It defaults to 0644. All "
1659 "index files are set to this mode with no regard to the umask."
1662 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1663 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
1665 "Sets if long descriptions should be included in the Packages file or split "
1666 "out into a master Translation-en file."
1669 #. type: Content of: <refentry><refsect1><refsect2><title>
1670 #: apt-ftparchive.1.xml:242
1671 msgid "TreeDefault Section"
1674 #. type: Content of: <refentry><refsect1><refsect2><para>
1675 #: apt-ftparchive.1.xml:244
1677 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
1678 "variables are substitution variables and have the strings $(DIST), "
1679 "$(SECTION) and $(ARCH) replaced with their respective values."
1682 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1683 #: apt-ftparchive.1.xml:251
1685 "Sets the number of kilobytes of contents files that are generated each "
1686 "day. The contents files are round-robined so that over several days they "
1687 "will all be rebuilt."
1690 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1691 #: apt-ftparchive.1.xml:258
1693 "Controls the number of days a contents file is allowed to be checked without "
1694 "changing. If this limit is passed the mtime of the contents file is "
1695 "updated. This case can occur if the package file is changed in such a way "
1696 "that does not result in a new contents file [override edit for instance]. A "
1697 "hold off is allowed in hopes that new .debs will be installed, requiring a "
1698 "new file anyhow. The default is 10, the units are in days."
1701 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1702 #: apt-ftparchive.1.xml:269
1704 "Sets the top of the .deb directory tree. Defaults to "
1705 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
1708 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1709 #: apt-ftparchive.1.xml:275
1711 "Sets the top of the source package directory tree. Defaults to "
1712 "<filename>$(DIST)/$(SECTION)/source/</filename>"
1715 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1716 #: apt-ftparchive.1.xml:281
1718 "Sets the output Packages file. Defaults to "
1719 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
1722 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1723 #: apt-ftparchive.1.xml:287
1725 "Sets the output Sources file. Defaults to "
1726 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
1729 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1730 #: apt-ftparchive.1.xml:293
1732 "Set the output Translation-en master file with the long descriptions if they "
1733 "should be not included in the Packages file. Defaults to "
1734 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
1737 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1738 #: apt-ftparchive.1.xml:300
1740 "Sets the path prefix that causes a symlink to be considered an internal link "
1741 "instead of an external link. Defaults to "
1742 "<filename>$(DIST)/$(SECTION)/</filename>"
1745 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1746 #: apt-ftparchive.1.xml:307
1748 "Sets the output Contents file. Defaults to "
1749 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
1750 "multiple Packages files to map onto a single Contents file (such as the "
1751 "default) then <command>apt-ftparchive</command> will integrate those "
1752 "package files together automatically."
1755 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1756 #: apt-ftparchive.1.xml:316
1757 msgid "Sets header file to prepend to the contents output."
1760 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1761 #: apt-ftparchive.1.xml:321
1763 "Sets the binary cache database to use for this section. Multiple sections "
1764 "can share the same database."
1767 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1768 #: apt-ftparchive.1.xml:327
1770 "Specifies that instead of walking the directory tree, "
1771 "<command>apt-ftparchive</command> should read the list of files from the "
1772 "given file. Relative files names are prefixed with the archive directory."
1775 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1776 #: apt-ftparchive.1.xml:334
1778 "Specifies that instead of walking the directory tree, "
1779 "<command>apt-ftparchive</command> should read the list of files from the "
1780 "given file. Relative files names are prefixed with the archive directory. "
1781 "This is used when processing source indexes."
1784 #. type: Content of: <refentry><refsect1><refsect2><title>
1785 #: apt-ftparchive.1.xml:342
1786 msgid "Tree Section"
1789 #. type: Content of: <refentry><refsect1><refsect2><para>
1790 #: apt-ftparchive.1.xml:344
1792 "The <literal>Tree</literal> section defines a standard Debian file tree "
1793 "which consists of a base directory, then multiple sections in that base "
1794 "directory and finally multiple Architectures in each section. The exact "
1795 "pathing used is defined by the <literal>Directory</literal> substitution "
1799 #. type: Content of: <refentry><refsect1><refsect2><para>
1800 #: apt-ftparchive.1.xml:349
1802 "The <literal>Tree</literal> section takes a scope tag which sets the "
1803 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
1804 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
1805 "setting such as <filename>dists/&stable-codename;</filename>."
1808 #. type: Content of: <refentry><refsect1><refsect2><para>
1809 #: apt-ftparchive.1.xml:354
1811 "All of the settings defined in the <literal>TreeDefault</literal> section "
1812 "can be use in a <literal>Tree</literal> section as well as three new "
1816 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
1817 #: apt-ftparchive.1.xml:360
1820 "for i in Sections do \n"
1821 " for j in Architectures do\n"
1822 " Generate for DIST=scope SECTION=i ARCH=j\n"
1826 #. type: Content of: <refentry><refsect1><refsect2><para>
1827 #: apt-ftparchive.1.xml:357
1829 "When processing a <literal>Tree</literal> section "
1830 "<command>apt-ftparchive</command> performs an operation similar to: "
1831 "<placeholder type=\"programlisting\" id=\"0\"/>"
1834 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1835 #: apt-ftparchive.1.xml:368
1837 "This is a space separated list of sections which appear under the "
1838 "distribution, typically this is something like <literal>main contrib "
1839 "non-free</literal>"
1842 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1843 #: apt-ftparchive.1.xml:375
1845 "This is a space separated list of all the architectures that appear under "
1846 "search section. The special architecture 'source' is used to indicate that "
1847 "this tree has a source archive."
1850 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1851 #: apt-ftparchive.1.xml:388
1853 "Sets the binary override file. The override file contains section, priority "
1854 "and maintainer address information."
1857 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1858 #: apt-ftparchive.1.xml:394
1860 "Sets the source override file. The override file contains section "
1864 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1865 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
1866 msgid "Sets the binary extra override file."
1869 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1870 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
1871 msgid "Sets the source extra override file."
1874 #. type: Content of: <refentry><refsect1><refsect2><title>
1875 #: apt-ftparchive.1.xml:410
1876 msgid "BinDirectory Section"
1879 #. type: Content of: <refentry><refsect1><refsect2><para>
1880 #: apt-ftparchive.1.xml:412
1882 "The <literal>bindirectory</literal> section defines a binary directory tree "
1883 "with no special structure. The scope tag specifies the location of the "
1884 "binary directory and the settings are similar to the <literal>Tree</literal> "
1885 "section with no substitution variables or "
1886 "<literal>Section</literal><literal>Architecture</literal> settings."
1889 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1890 #: apt-ftparchive.1.xml:420
1891 msgid "Sets the Packages file output."
1894 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1895 #: apt-ftparchive.1.xml:425
1897 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
1898 "<literal>Sources</literal> is required."
1901 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1902 #: apt-ftparchive.1.xml:431
1903 msgid "Sets the Contents file output. (optional)"
1906 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1907 #: apt-ftparchive.1.xml:436
1908 msgid "Sets the binary override file."
1911 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1912 #: apt-ftparchive.1.xml:441
1913 msgid "Sets the source override file."
1916 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1917 #: apt-ftparchive.1.xml:456
1918 msgid "Sets the cache DB."
1921 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1922 #: apt-ftparchive.1.xml:461
1923 msgid "Appends a path to all the output paths."
1926 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1927 #: apt-ftparchive.1.xml:466
1928 msgid "Specifies the file list file."
1931 #. type: Content of: <refentry><refsect1><title>
1932 #: apt-ftparchive.1.xml:473
1933 msgid "The Binary Override File"
1936 #. type: Content of: <refentry><refsect1><para>
1937 #: apt-ftparchive.1.xml:474
1939 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
1940 "contains 4 fields separated by spaces. The first field is the package name, "
1941 "the second is the priority to force that package to, the third is the the "
1942 "section to force that package to and the final field is the maintainer "
1943 "permutation field."
1946 #. type: Content of: <refentry><refsect1><para><literallayout>
1947 #: apt-ftparchive.1.xml:480
1949 msgid "old [// oldn]* => new"
1952 #. type: Content of: <refentry><refsect1><para><literallayout>
1953 #: apt-ftparchive.1.xml:482
1958 #. type: Content of: <refentry><refsect1><para>
1959 #: apt-ftparchive.1.xml:479
1961 "The general form of the maintainer field is: <placeholder "
1962 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
1963 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
1964 "separated list of old email addresses to be specified. If any of those are "
1965 "found then new is substituted for the maintainer field. The second form "
1966 "unconditionally substitutes the maintainer field."
1969 #. type: Content of: <refentry><refsect1><title>
1970 #: apt-ftparchive.1.xml:490
1971 msgid "The Source Override File"
1974 #. type: Content of: <refentry><refsect1><para>
1975 #: apt-ftparchive.1.xml:492
1977 "The source override file is fully compatible with &dpkg-scansources;. It "
1978 "contains 2 fields separated by spaces. The first fields is the source "
1979 "package name, the second is the section to assign it."
1982 #. type: Content of: <refentry><refsect1><title>
1983 #: apt-ftparchive.1.xml:497
1984 msgid "The Extra Override File"
1987 #. type: Content of: <refentry><refsect1><para>
1988 #: apt-ftparchive.1.xml:499
1990 "The extra override file allows any arbitrary tag to be added or replaced in "
1991 "the output. It has 3 columns, the first is the package, the second is the "
1992 "tag and the remainder of the line is the new value."
1995 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1996 #: apt-ftparchive.1.xml:510
1998 "Generate the given checksum. These options default to on, when turned off "
1999 "the generated index files will not have the checksum fields where possible. "
2000 "Configuration Items: "
2001 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
2002 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
2003 "where <literal><replaceable>Index</replaceable></literal> can be "
2004 "<literal>Packages</literal>, <literal>Sources</literal> or "
2005 "<literal>Release</literal> and "
2006 "<literal><replaceable>Checksum</replaceable></literal> can be "
2007 "<literal>MD5</literal>, <literal>SHA1</literal> or "
2008 "<literal>SHA256</literal>."
2011 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2012 #: apt-ftparchive.1.xml:521
2014 "Use a binary caching DB. This has no effect on the generate command. "
2015 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
2018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2019 #: apt-ftparchive.1.xml:527
2021 "Quiet; produces output suitable for logging, omitting progress indicators. "
2022 "More q's will produce more quiet up to a maximum of 2. You can also use "
2023 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2024 "file. Configuration Item: <literal>quiet</literal>."
2027 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2028 #: apt-ftparchive.1.xml:535
2030 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
2031 "then this option actually enables delinking of the files. It defaults to on "
2032 "and can be turned off with <option>--no-delink</option>. Configuration "
2033 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
2036 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2037 #: apt-ftparchive.1.xml:543
2039 "Perform contents generation. When this option is set and package indexes are "
2040 "being generated with a cache DB then the file listing will also be extracted "
2041 "and stored in the DB for later use. When using the generate command this "
2042 "option also allows the creation of any Contents files. The default is on. "
2043 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
2046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2047 #: apt-ftparchive.1.xml:553
2049 "Select the source override file to use with the <literal>sources</literal> "
2050 "command. Configuration Item: "
2051 "<literal>APT::FTPArchive::SourceOverride</literal>."
2054 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2055 #: apt-ftparchive.1.xml:559
2057 "Make the caching databases read only. Configuration Item: "
2058 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2062 #: apt-ftparchive.1.xml:564
2064 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2065 "commands only package files matching <literal>*_arch.deb</literal> or "
2066 "<literal>*_all.deb</literal> instead of all package files in the given "
2067 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2070 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2071 #: apt-ftparchive.1.xml:572
2073 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2074 "packages are recompiled and/or republished with the same version again, this "
2075 "will lead to problems as the now outdated cached metadata like size and "
2076 "checksums will be used. With this option enabled this will no longer happen "
2077 "as it will be checked if the file was changed. Note that this option is set "
2078 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2079 "multiply versions/builds of a package with the same versionnumber, so in "
2080 "theory nobody will have these problems and therefore all these extra checks "
2084 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2085 #: apt-ftparchive.1.xml:584
2087 "This configuration option defaults to \"<literal>true</literal>\" and should "
2088 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2089 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2090 "that the <filename>Translation-en</filename> master file can only be created "
2091 "in the generate command."
2094 #. type: Content of: <refentry><refsect1><title>
2095 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1113 apt_preferences.5.xml:545 sources.list.5.xml:214
2099 #. type: Content of: <refentry><refsect1><para><programlisting>
2100 #: apt-ftparchive.1.xml:602
2103 "<command>apt-ftparchive</command> packages "
2104 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2105 "<filename>Packages.gz</filename>\n"
2108 #. type: Content of: <refentry><refsect1><para>
2109 #: apt-ftparchive.1.xml:598
2111 "To create a compressed Packages file for a directory containing binary "
2112 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2115 #. type: Content of: <refentry><refsect1><para>
2116 #: apt-ftparchive.1.xml:612
2118 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2122 #. The last update date
2123 #. type: Content of: <refentry><refentryinfo>
2126 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>08 "
2127 "November 2008</date>"
2130 #. type: Content of: <refentry><refnamediv><refpurpose>
2132 msgid "APT package handling utility -- command-line interface"
2135 #. type: Content of: <refentry><refsect1><para>
2138 "<command>apt-get</command> is the command-line tool for handling packages, "
2139 "and may be considered the user's \"back-end\" to other tools using the APT "
2140 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2141 "&aptitude;, &synaptic; and &wajig;."
2144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2147 "<literal>update</literal> is used to resynchronize the package index files "
2148 "from their sources. The indexes of available packages are fetched from the "
2149 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2150 "example, when using a Debian archive, this command retrieves and scans the "
2151 "<filename>Packages.gz</filename> files, so that information about new and "
2152 "updated packages is available. An <literal>update</literal> should always be "
2153 "performed before an <literal>upgrade</literal> or "
2154 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2155 "meter will be incorrect as the size of the package files cannot be known in "
2159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2162 "<literal>upgrade</literal> is used to install the newest versions of all "
2163 "packages currently installed on the system from the sources enumerated in "
2164 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2165 "with new versions available are retrieved and upgraded; under no "
2166 "circumstances are currently installed packages removed, or packages not "
2167 "already installed retrieved and installed. New versions of currently "
2168 "installed packages that cannot be upgraded without changing the install "
2169 "status of another package will be left at their current version. An "
2170 "<literal>update</literal> must be performed first so that "
2171 "<command>apt-get</command> knows that new versions of packages are "
2175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2178 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2179 "traditional Debian packaging front-end, "
2180 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2181 "&dselect; to the <literal>Status</literal> field of available packages, and "
2182 "performs the actions necessary to realize that state (for instance, the "
2183 "removal of old and the installation of new packages)."
2186 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2189 "<literal>dist-upgrade</literal> in addition to performing the function of "
2190 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2191 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2192 "conflict resolution system, and it will attempt to upgrade the most "
2193 "important packages at the expense of less important ones if necessary. So, "
2194 "<literal>dist-upgrade</literal> command may remove some packages. The "
2195 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2196 "from which to retrieve desired package files. See also &apt-preferences; "
2197 "for a mechanism for overriding the general settings for individual packages."
2200 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2203 "<literal>install</literal> is followed by one or more packages desired for "
2204 "installation or upgrading. Each package is a package name, not a fully "
2205 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2206 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2207 "packages required by the package(s) specified for installation will also be "
2208 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2209 "file is used to locate the desired packages. If a hyphen is appended to the "
2210 "package name (with no intervening space), the identified package will be "
2211 "removed if it is installed. Similarly a plus sign can be used to designate "
2212 "a package to install. These latter features may be used to override "
2213 "decisions made by apt-get's conflict resolution system."
2216 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2217 #: apt-get.8.xml:116
2219 "A specific version of a package can be selected for installation by "
2220 "following the package name with an equals and the version of the package to "
2221 "select. This will cause that version to be located and selected for "
2222 "install. Alternatively a specific distribution can be selected by following "
2223 "the package name with a slash and the version of the distribution or the "
2224 "Archive name (stable, testing, unstable)."
2227 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2228 #: apt-get.8.xml:123
2230 "Both of the version selection mechanisms can downgrade packages and must be "
2234 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2235 #: apt-get.8.xml:126
2237 "This is also the target to use if you want to upgrade one or more "
2238 "already-installed packages without upgrading every package you have on your "
2239 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2240 "all currently installed packages, \"install\" will install the newest "
2241 "version of only the package(s) specified. Simply provide the name of the "
2242 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2243 "its dependencies, as described above) will be downloaded and installed."
2246 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2247 #: apt-get.8.xml:137
2249 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2250 "installation policy for individual packages."
2253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2254 #: apt-get.8.xml:141
2256 "If no package matches the given expression and the expression contains one "
2257 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2258 "it is applied to all package names in the database. Any matches are then "
2259 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2260 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2261 "expression with a '^' or '$' character, or create a more specific regular "
2265 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2266 #: apt-get.8.xml:151
2268 "<literal>remove</literal> is identical to <literal>install</literal> except "
2269 "that packages are removed instead of installed. Note the removing a package "
2270 "leaves its configuration files in system. If a plus sign is appended to the "
2271 "package name (with no intervening space), the identified package will be "
2272 "installed instead of removed."
2275 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2276 #: apt-get.8.xml:159
2278 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2279 "that packages are removed and purged (any configuration files are deleted "
2283 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2284 #: apt-get.8.xml:164
2286 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2287 "packages. APT will examine the available packages to decide which source "
2288 "package to fetch. It will then find and download into the current directory "
2289 "the newest available version of that source package while respecting the "
2290 "default release, set with the option "
2291 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2292 "per package with the <literal>pkg/release</literal> syntax, if possible."
2295 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2296 #: apt-get.8.xml:172
2298 "Source packages are tracked separately from binary packages via "
2299 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2300 "that you will need to add such a line for each repository you want to get "
2301 "sources from. If you don't do this you will properly get another (newer, "
2302 "older or none) source version than the one you have installed or could "
2306 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2307 #: apt-get.8.xml:179
2309 "If the <option>--compile</option> option is specified then the package will "
2310 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2311 "the architecture as defined by the <command>--host-architecture</command> "
2312 "option. If <option>--download-only</option> is specified then the source "
2313 "package will not be unpacked."
2316 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2317 #: apt-get.8.xml:186
2319 "A specific source version can be retrieved by postfixing the source name "
2320 "with an equals and then the version to fetch, similar to the mechanism used "
2321 "for the package files. This enables exact matching of the source package "
2322 "name and version, implicitly enabling the "
2323 "<literal>APT::Get::Only-Source</literal> option."
2326 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2327 #: apt-get.8.xml:192
2329 "Note that source packages are not tracked like binary packages, they exist "
2330 "only in the current directory and are similar to downloading source tar "
2334 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2335 #: apt-get.8.xml:198
2337 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2338 "attempt to satisfy the build dependencies for a source package. By default "
2339 "the dependencies are satisfied to build the package natively. If desired a "
2340 "host-architecture can be specified with the "
2341 "<option>--host-architecture</option> option instead."
2344 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2345 #: apt-get.8.xml:205
2347 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2348 "and checks for broken dependencies."
2351 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2352 #: apt-get.8.xml:210
2354 "<literal>download</literal> will download the given binary package into the "
2355 "current directory."
2358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2359 #: apt-get.8.xml:216
2361 "<literal>clean</literal> clears out the local repository of retrieved "
2362 "package files. It removes everything but the lock file from "
2363 "<filename>&cachedir;/archives/</filename> and "
2364 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2365 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2366 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2367 "from time to time to free up disk space."
2370 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2371 #: apt-get.8.xml:226
2373 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2374 "local repository of retrieved package files. The difference is that it only "
2375 "removes package files that can no longer be downloaded, and are largely "
2376 "useless. This allows a cache to be maintained over a long period without it "
2377 "growing out of control. The configuration option "
2378 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2379 "being erased if it is set to off."
2382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2383 #: apt-get.8.xml:236
2385 "<literal>autoremove</literal> is used to remove packages that were "
2386 "automatically installed to satisfy dependencies for other packages and are "
2387 "now no longer needed."
2390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2391 #: apt-get.8.xml:241
2393 "<literal>changelog</literal> downloads a package changelog and displays it "
2394 "through <command>sensible-pager</command>. The server name and base "
2395 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2396 "variable (e. g. <ulink "
2397 "url=\"http://packages.debian.org/changelogs\">packages.debian.org/changelogs</ulink> "
2398 "for Debian or <ulink "
2399 "url=\"http://changelogs.ubuntu.com/changelogs\">changelogs.ubuntu.com/changelogs</ulink> "
2400 "for Ubuntu). By default it displays the changelog for the version that is "
2401 "installed. However, you can specify the same options as for the "
2402 "<option>install</option> command."
2405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2406 #: apt-get.8.xml:264
2408 "Do not consider recommended packages as a dependency for installing. "
2409 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2412 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2413 #: apt-get.8.xml:269
2415 "Consider suggested packages as a dependency for installing. Configuration "
2416 "Item: <literal>APT::Install-Suggests</literal>."
2419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2420 #: apt-get.8.xml:274
2422 "Download only; package files are only retrieved, not unpacked or installed. "
2423 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
2426 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2427 #: apt-get.8.xml:279
2429 "Fix; attempt to correct a system with broken dependencies in place. This "
2430 "option, when used with install/remove, can omit any packages to permit APT "
2431 "to deduce a likely solution. If packages are specified, these have to "
2432 "completely correct the problem. The option is sometimes necessary when "
2433 "running APT for the first time; APT itself does not allow broken package "
2434 "dependencies to exist on a system. It is possible that a system's dependency "
2435 "structure can be so corrupt as to require manual intervention (which usually "
2436 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
2437 "of the offending packages). Use of this option together with "
2438 "<option>-m</option> may produce an error in some situations. Configuration "
2439 "Item: <literal>APT::Get::Fix-Broken</literal>."
2442 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2443 #: apt-get.8.xml:294
2445 "Ignore missing packages; If packages cannot be retrieved or fail the "
2446 "integrity check after retrieval (corrupted package files), hold back those "
2447 "packages and handle the result. Use of this option together with "
2448 "<option>-f</option> may produce an error in some situations. If a package is "
2449 "selected for installation (particularly if it is mentioned on the command "
2450 "line) and it could not be downloaded then it will be silently held back. "
2451 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
2454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2455 #: apt-get.8.xml:305
2457 "Disables downloading of packages. This is best used with "
2458 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
2459 "already downloaded. Configuration Item: "
2460 "<literal>APT::Get::Download</literal>."
2463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2464 #: apt-get.8.xml:312
2466 "Quiet; produces output suitable for logging, omitting progress indicators. "
2467 "More q's will produce more quiet up to a maximum of 2. You can also use "
2468 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2469 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
2470 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
2471 "may decided to do something you did not expect. Configuration Item: "
2472 "<literal>quiet</literal>."
2475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2476 #: apt-get.8.xml:327
2478 "No action; perform a simulation of events that would occur but do not "
2479 "actually change the system. Configuration Item: "
2480 "<literal>APT::Get::Simulate</literal>."
2483 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2484 #: apt-get.8.xml:331
2486 "Simulation run as user will deactivate locking "
2487 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
2488 "displayed indicating that this is only a simulation, if the option "
2489 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
2490 "true). Neither NoLocking nor the notice will be triggered if run as root "
2491 "(root should know what he is doing without further warnings by "
2492 "<literal>apt-get</literal>)."
2495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2496 #: apt-get.8.xml:337
2498 "Simulate prints out a series of lines each one representing a dpkg "
2499 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
2500 "indicate broken packages and empty set of square brackets meaning breaks "
2501 "that are of no consequence (rare)."
2504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2505 #: apt-get.8.xml:346
2507 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
2508 "non-interactively. If an undesirable situation, such as changing a held "
2509 "package, trying to install a unauthenticated package or removing an "
2510 "essential package occurs then <literal>apt-get</literal> will abort. "
2511 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
2514 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2515 #: apt-get.8.xml:354
2517 "Automatic \"no\" to all prompts. Configuration Item: "
2518 "<literal>APT::Get::Assume-No</literal>."
2521 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2522 #: apt-get.8.xml:359
2524 "Show upgraded packages; Print out a list of all packages that are to be "
2525 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
2528 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2529 #: apt-get.8.xml:365
2531 "Show full versions for upgraded and installed packages. Configuration Item: "
2532 "<literal>APT::Get::Show-Versions</literal>."
2535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2536 #: apt-get.8.xml:371
2538 "This option controls the architecture packages are built for by "
2539 "<command>apt-get source --compile</command> and how cross-builddependencies "
2540 "are satisfied. By default is it not set which means that the host "
2541 "architecture is the same as the build architecture (which is defined by "
2542 "<literal>APT::Architecture</literal>). Configuration Item: "
2543 "<literal>APT::Get::Host-Architecture</literal>"
2546 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2547 #: apt-get.8.xml:381
2549 "Compile source packages after downloading them. Configuration Item: "
2550 "<literal>APT::Get::Compile</literal>."
2553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2554 #: apt-get.8.xml:386
2556 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
2557 "hold placed on a package. This may be useful in conjunction with "
2558 "<literal>dist-upgrade</literal> to override a large number of undesired "
2559 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
2562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2563 #: apt-get.8.xml:393
2565 "Do not upgrade packages; When used in conjunction with "
2566 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
2567 "packages on the command line from being upgraded if they are already "
2568 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
2571 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2572 #: apt-get.8.xml:400
2574 "Do not install new packages; When used in conjunction with "
2575 "<literal>install</literal>, <literal>only-upgrade</literal> will install "
2576 "upgrades for already installed packages only and ignore requests to install "
2577 "new packages. Configuration Item: "
2578 "<literal>APT::Get::Only-Upgrade</literal>."
2581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2582 #: apt-get.8.xml:408
2584 "Force yes; This is a dangerous option that will cause apt to continue "
2585 "without prompting if it is doing something potentially harmful. It should "
2586 "not be used except in very special situations. Using "
2587 "<literal>force-yes</literal> can potentially destroy your system! "
2588 "Configuration Item: <literal>APT::Get::force-yes</literal>."
2591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2592 #: apt-get.8.xml:416
2594 "Instead of fetching the files to install their URIs are printed. Each URI "
2595 "will have the path, the destination file name, the size and the expected md5 "
2596 "hash. Note that the file name to write to will not always match the file "
2597 "name on the remote site! This also works with the <literal>source</literal> "
2598 "and <literal>update</literal> commands. When used with the "
2599 "<literal>update</literal> command the MD5 and size are not included, and it "
2600 "is up to the user to decompress any compressed files. Configuration Item: "
2601 "<literal>APT::Get::Print-URIs</literal>."
2604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2605 #: apt-get.8.xml:427
2607 "Use purge instead of remove for anything that would be removed. An asterisk "
2608 "(\"*\") will be displayed next to packages which are scheduled to be "
2609 "purged. <option>remove --purge</option> is equivalent to the "
2610 "<option>purge</option> command. Configuration Item: "
2611 "<literal>APT::Get::Purge</literal>."
2614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2615 #: apt-get.8.xml:435
2617 "Re-Install packages that are already installed and at the newest version. "
2618 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
2621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2622 #: apt-get.8.xml:440
2624 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
2625 "it off. When on <command>apt-get</command> will automatically manage the "
2626 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
2627 "files are erased. The only reason to turn it off is if you frequently "
2628 "change your source list. Configuration Item: "
2629 "<literal>APT::Get::List-Cleanup</literal>."
2632 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2633 #: apt-get.8.xml:451
2635 "This option controls the default input to the policy engine, it creates a "
2636 "default pin at priority 990 using the specified release string. This "
2637 "overrides the general settings in "
2638 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
2639 "not affected by the value of this option. In short, this option lets you "
2640 "have simple control over which distribution packages will be retrieved "
2641 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
2642 "unstable</option> or <option>-t sid</option>. Configuration Item: "
2643 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
2647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2648 #: apt-get.8.xml:466
2650 "Only perform operations that are 'trivial'. Logically this can be considered "
2651 "related to <option>--assume-yes</option>, where "
2652 "<option>--assume-yes</option> will answer yes to any prompt, "
2653 "<option>--trivial-only</option> will answer no. Configuration Item: "
2654 "<literal>APT::Get::Trivial-Only</literal>."
2657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2658 #: apt-get.8.xml:473
2660 "If any packages are to be removed apt-get immediately aborts without "
2661 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
2664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2665 #: apt-get.8.xml:479
2667 "If the command is either <literal>install</literal> or "
2668 "<literal>remove</literal>, then this option acts like running "
2669 "<literal>autoremove</literal> command, removing the unused dependency "
2670 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
2673 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2674 #: apt-get.8.xml:486
2676 "Only has meaning for the <literal>source</literal> and "
2677 "<literal>build-dep</literal> commands. Indicates that the given source "
2678 "names are not to be mapped through the binary table. This means that if "
2679 "this option is specified, these commands will only accept source package "
2680 "names as arguments, rather than accepting binary package names and looking "
2681 "up the corresponding source package. Configuration Item: "
2682 "<literal>APT::Get::Only-Source</literal>."
2685 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2686 #: apt-get.8.xml:497
2688 "Download only the diff, dsc, or tar file of a source archive. Configuration "
2689 "Item: <literal>APT::Get::Diff-Only</literal>, "
2690 "<literal>APT::Get::Dsc-Only</literal>, and "
2691 "<literal>APT::Get::Tar-Only</literal>."
2694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2695 #: apt-get.8.xml:503
2697 "Only process architecture-dependent build-dependencies. Configuration Item: "
2698 "<literal>APT::Get::Arch-Only</literal>."
2701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2702 #: apt-get.8.xml:508
2704 "Ignore if packages can't be authenticated and don't prompt about it. This "
2705 "is useful for tools like pbuilder. Configuration Item: "
2706 "<literal>APT::Get::AllowUnauthenticated</literal>."
2709 #. type: Content of: <refentry><refsect1><variablelist>
2710 #: apt-get.8.xml:521
2712 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
2716 #. type: Content of: <refentry><refsect1><para>
2717 #: apt-get.8.xml:530
2719 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
2720 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
2721 "&apt-preferences;, the APT Howto."
2724 #. type: Content of: <refentry><refsect1><para>
2725 #: apt-get.8.xml:536
2727 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
2731 #. type: Content of: <refentry><refsect1><title>
2732 #: apt-get.8.xml:539
2733 msgid "ORIGINAL AUTHORS"
2736 #. type: Content of: <refentry><refsect1><para>
2737 #: apt-get.8.xml:540
2738 msgid "&apt-author.jgunthorpe;"
2741 #. type: Content of: <refentry><refsect1><title>
2742 #: apt-get.8.xml:543
2743 msgid "CURRENT AUTHORS"
2746 #. type: Content of: <refentry><refsect1><para>
2747 #: apt-get.8.xml:545
2748 msgid "&apt-author.team;"
2751 #. type: Content of: <refentry><refnamediv><refpurpose>
2753 msgid "APT key management utility"
2756 #. type: Content of: <refentry><refsect1><para>
2759 "<command>apt-key</command> is used to manage the list of keys used by apt to "
2760 "authenticate packages. Packages which have been authenticated using these "
2761 "keys will be considered trusted."
2764 #. type: Content of: <refentry><refsect1><title>
2769 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2772 "Add a new key to the list of trusted keys. The key is read from the "
2773 "filename given with the parameter &synopsis-param-filename; or if the "
2774 "filename is <literal>-</literal> from standard input."
2777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2779 msgid "Remove a key from the list of trusted keys."
2782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2784 msgid "Output the key &synopsis-param-keyid; to standard output."
2787 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2789 msgid "Output all trusted keys to standard output."
2792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2794 msgid "List trusted keys."
2797 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2798 #: apt-key.8.xml:100
2799 msgid "List fingerprints of trusted keys."
2802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2803 #: apt-key.8.xml:111
2805 "Pass advanced options to gpg. With adv --recv-key you can download the "
2809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2810 #: apt-key.8.xml:123
2812 "Update the local keyring with the archive keyring and remove from the local "
2813 "keyring the archive keys which are no longer valid. The archive keyring is "
2814 "shipped in the <literal>archive-keyring</literal> package of your "
2815 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
2819 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2820 #: apt-key.8.xml:137
2822 "Work similar to the <command>update</command> command above, but get the "
2823 "archive keyring from an URI instead and validate it against a master key. "
2824 "This requires an installed &wget; and an APT build configured to have a "
2825 "server to fetch from and a master keyring to validate. APT in Debian does "
2826 "not support this command and relies on <command>update</command> instead, "
2827 "but Ubuntu's APT does."
2830 #. type: Content of: <refentry><refsect1><para>
2831 #: apt-key.8.xml:154
2833 "Note that options need to be defined before the commands described in the "
2837 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2838 #: apt-key.8.xml:157
2840 "With this option it is possible to specify a specific keyring file the "
2841 "command should operate on. The default is that a command is executed on the "
2842 "<filename>trusted.gpg</filename> file as well as on all parts in the "
2843 "<filename>trusted.gpg.d</filename> directory, though "
2844 "<filename>trusted.gpg</filename> is the primary keyring which means that "
2845 "e.g. new keys are added to this one."
2848 #. type: Content of: <refentry><refsect1><variablelist>
2849 #: apt-key.8.xml:170
2850 msgid "&file-trustedgpg;"
2853 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2854 #: apt-key.8.xml:172
2855 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2859 #: apt-key.8.xml:173
2860 msgid "Local trust database of archive keys."
2863 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2864 #: apt-key.8.xml:176
2865 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
2868 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2869 #: apt-key.8.xml:177
2870 msgid "Keyring of Debian archive trusted keys."
2873 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2874 #: apt-key.8.xml:180
2875 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
2878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2879 #: apt-key.8.xml:181
2880 msgid "Keyring of Debian archive removed trusted keys."
2883 #. type: Content of: <refentry><refsect1><para>
2884 #: apt-key.8.xml:190
2885 msgid "&apt-get;, &apt-secure;"
2888 #. The last update date
2889 #. type: Content of: <refentry><refentryinfo>
2890 #: apt-mark.8.xml:16
2892 "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product; <date>21 "
2896 #. type: Content of: <refentry><refnamediv><refpurpose>
2897 #: apt-mark.8.xml:33
2898 msgid "mark/unmark a package as being automatically-installed"
2901 #. type: Content of: <refentry><refsect1><para>
2902 #: apt-mark.8.xml:39
2904 "<command>apt-mark</command> will change whether a package has been marked as "
2905 "being automatically installed."
2908 #. type: Content of: <refentry><refsect1><para>
2909 #: apt-mark.8.xml:43
2911 "When you request that a package is installed, and as a result other packages "
2912 "are installed to satisfy its dependencies, the dependencies are marked as "
2913 "being automatically installed. Once these automatically installed packages "
2914 "are no longer depended on by any manually installed packages, they will be "
2915 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
2918 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2919 #: apt-mark.8.xml:52
2921 "<literal>auto</literal> is used to mark a package as being automatically "
2922 "installed, which will cause the package to be removed when no more manually "
2923 "installed packages depend on this package."
2926 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2927 #: apt-mark.8.xml:60
2929 "<literal>manual</literal> is used to mark a package as being manually "
2930 "installed, which will prevent the package from being automatically removed "
2931 "if no other packages depend on it."
2934 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2935 #: apt-mark.8.xml:68
2937 "<literal>hold</literal> is used to mark a package as hold back, which will "
2938 "prevent the package from being automatically installed, upgraded or "
2939 "removed. The command is only a wrapper around <command>dpkg "
2940 "--set-selections</command> and the state is therefore maintained by &dpkg; "
2941 "and not effected by the <option>--filename</option> option."
2944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2945 #: apt-mark.8.xml:78
2947 "<literal>unhold</literal> is used to cancel a previously set hold on a "
2948 "package to allow all actions again."
2951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2952 #: apt-mark.8.xml:84
2954 "<literal>showauto</literal> is used to print a list of automatically "
2955 "installed packages with each package on a new line. All automatically "
2956 "installed packages will be listed if no package is given. If packages are "
2957 "given only those which are automatically installed will be shown."
2960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2961 #: apt-mark.8.xml:92
2963 "<literal>showmanual</literal> can be used in the same way as "
2964 "<literal>showauto</literal> except that it will print a list of manually "
2965 "installed packages instead."
2968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2969 #: apt-mark.8.xml:99
2971 "<literal>showhold</literal> is used to print a list of packages on hold in "
2972 "the same way as for the other show commands."
2975 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term><option><filename>
2976 #: apt-mark.8.xml:112 apt-mark.8.xml:113
2977 msgid "<replaceable>&synopsis-filename;</replaceable>"
2980 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2981 #: apt-mark.8.xml:115
2983 "Read/Write package stats from the filename given with the parameter "
2984 "<filename><replaceable>&synopsis-filename;</replaceable></filename> instead "
2985 "of from the default location, which is <filename>extended_status</filename> "
2986 "in the directory defined by the Configuration Item: "
2987 "<literal>Dir::State</literal>."
2990 #. type: Content of: <refentry><refsect1><variablelist>
2991 #: apt-mark.8.xml:128
2992 msgid " &file-extended_states;"
2995 #. type: Content of: <refentry><refsect1><para>
2996 #: apt-mark.8.xml:133
2997 msgid "&apt-get;,&aptitude;,&apt-conf;"
3000 #. type: Content of: <refentry><refsect1><para>
3001 #: apt-mark.8.xml:137
3003 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
3007 #. type: Content of: <refentry><refnamediv><refpurpose>
3008 #: apt-secure.8.xml:40
3009 msgid "Archive authentication support for APT"
3012 #. type: Content of: <refentry><refsect1><para>
3013 #: apt-secure.8.xml:45
3015 "Starting with version 0.6, <command>apt</command> contains code that does "
3016 "signature checking of the Release file for all archives. This ensures that "
3017 "packages in the archive can't be modified by people who have no access to "
3018 "the Release file signing key."
3021 #. type: Content of: <refentry><refsect1><para>
3022 #: apt-secure.8.xml:53
3024 "If a package comes from a archive without a signature or with a signature "
3025 "that apt does not have a key for that package is considered untrusted and "
3026 "installing it will result in a big warning. <command>apt-get</command> will "
3027 "currently only warn for unsigned archives, future releases might force all "
3028 "sources to be verified before downloading packages from them."
3031 #. type: Content of: <refentry><refsect1><para>
3032 #: apt-secure.8.xml:62
3034 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
3035 "authentication feature."
3038 #. type: Content of: <refentry><refsect1><title>
3039 #: apt-secure.8.xml:67
3040 msgid "Trusted archives"
3043 #. type: Content of: <refentry><refsect1><para>
3044 #: apt-secure.8.xml:70
3046 "The chain of trust from an apt archive to the end user is made up of "
3047 "different steps. <command>apt-secure</command> is the last step in this "
3048 "chain, trusting an archive does not mean that the packages that you trust it "
3049 "do not contain malicious code but means that you trust the archive "
3050 "maintainer. It's the archive maintainer responsibility to ensure that the "
3051 "archive integrity is correct."
3054 #. type: Content of: <refentry><refsect1><para>
3055 #: apt-secure.8.xml:78
3057 "apt-secure does not review signatures at a package level. If you require "
3058 "tools to do this you should look at <command>debsig-verify</command> and "
3059 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3060 "packages respectively)."
3063 #. type: Content of: <refentry><refsect1><para>
3064 #: apt-secure.8.xml:85
3066 "The chain of trust in Debian starts when a maintainer uploads a new package "
3067 "or a new version of a package to the Debian archive. This upload in order to "
3068 "become effective needs to be signed by a key of a maintainer within the "
3069 "Debian maintainer's keyring (available in the debian-keyring "
3070 "package). Maintainer's keys are signed by other maintainers following "
3071 "pre-established procedures to ensure the identity of the key holder."
3074 #. type: Content of: <refentry><refsect1><para>
3075 #: apt-secure.8.xml:95
3077 "Once the uploaded package is verified and included in the archive, the "
3078 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3079 "and put in the Packages file. The MD5 sum of all of the packages files are "
3080 "then computed and put into the Release file. The Release file is then signed "
3081 "by the archive key (which is created once a year) and distributed through "
3082 "the FTP server. This key is also on the Debian keyring."
3085 #. type: Content of: <refentry><refsect1><para>
3086 #: apt-secure.8.xml:105
3088 "Any end user can check the signature of the Release file, extract the MD5 "
3089 "sum of a package from it and compare it with the MD5 sum of the package he "
3090 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3091 "package was checked. Now both the MD5 sum and the signature of the Release "
3095 #. type: Content of: <refentry><refsect1><para>
3096 #: apt-secure.8.xml:112
3098 "Notice that this is distinct from checking signatures on a per package "
3099 "basis. It is designed to prevent two possible attacks:"
3102 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3103 #: apt-secure.8.xml:117
3105 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3106 "checking, a malicious agent can introduce himself in the package download "
3107 "process and provide malicious software either by controlling a network "
3108 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3109 "(through arp or DNS spoofing attacks)."
3112 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3113 #: apt-secure.8.xml:125
3115 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3116 "malicious agent can compromise a mirror host and modify the files in it to "
3117 "propagate malicious software to all users downloading packages from that "
3121 #. type: Content of: <refentry><refsect1><para>
3122 #: apt-secure.8.xml:132
3124 "However, it does not defend against a compromise of the Debian master server "
3125 "itself (which signs the packages) or against a compromise of the key used to "
3126 "sign the Release files. In any case, this mechanism can complement a "
3127 "per-package signature."
3130 #. type: Content of: <refentry><refsect1><title>
3131 #: apt-secure.8.xml:138
3132 msgid "User configuration"
3135 #. type: Content of: <refentry><refsect1><para>
3136 #: apt-secure.8.xml:140
3138 "<command>apt-key</command> is the program that manages the list of keys used "
3139 "by apt. It can be used to add or remove keys although an installation of "
3140 "this release will automatically provide the default Debian archive signing "
3141 "keys used in the Debian package repositories."
3144 #. type: Content of: <refentry><refsect1><para>
3145 #: apt-secure.8.xml:147
3147 "In order to add a new key you need to first download it (you should make "
3148 "sure you are using a trusted communication channel when retrieving it), add "
3149 "it with <command>apt-key</command> and then run <command>apt-get "
3150 "update</command> so that apt can download and verify the "
3151 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3152 "from the archives you have configured."
3155 #. type: Content of: <refentry><refsect1><title>
3156 #: apt-secure.8.xml:156
3157 msgid "Archive configuration"
3160 #. type: Content of: <refentry><refsect1><para>
3161 #: apt-secure.8.xml:158
3163 "If you want to provide archive signatures in an archive under your "
3164 "maintenance you have to:"
3167 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3168 #: apt-secure.8.xml:163
3170 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3171 "already. You can do this by running <command>apt-ftparchive "
3172 "release</command> (provided in apt-utils)."
3175 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3176 #: apt-secure.8.xml:168
3178 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
3179 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
3180 "Release.gpg Release</command>."
3183 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3184 #: apt-secure.8.xml:172
3186 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
3187 "know what key they need to import in order to authenticate the files in the "
3191 #. type: Content of: <refentry><refsect1><para>
3192 #: apt-secure.8.xml:179
3194 "Whenever the contents of the archive changes (new packages are added or "
3195 "removed) the archive maintainer has to follow the first two steps previously "
3199 #. type: Content of: <refentry><refsect1><para>
3200 #: apt-secure.8.xml:187
3202 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
3203 "&debsign; &debsig-verify;, &gpg;"
3206 #. type: Content of: <refentry><refsect1><para>
3207 #: apt-secure.8.xml:191
3209 "For more background information you might want to review the <ulink "
3210 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
3211 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
3212 "(available also in the harden-doc package) and the <ulink "
3213 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
3214 "Distribution HOWTO</ulink> by V. Alex Brennen."
3217 #. type: Content of: <refentry><refsect1><title>
3218 #: apt-secure.8.xml:204
3219 msgid "Manpage Authors"
3222 #. type: Content of: <refentry><refsect1><para>
3223 #: apt-secure.8.xml:206
3225 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
3226 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
3229 #. type: Content of: <refentry><refnamediv><refpurpose>
3230 #: apt-sortpkgs.1.xml:33
3231 msgid "Utility to sort package index files"
3234 #. type: Content of: <refentry><refsect1><para>
3235 #: apt-sortpkgs.1.xml:39
3237 "<command>apt-sortpkgs</command> will take an index file (Source index or "
3238 "Package index) and sort the records so that they are ordered by the package "
3239 "name. It will also sort the internal fields of each record according to the "
3240 "internal sorting rules."
3243 #. type: Content of: <refentry><refsect1><para>
3244 #: apt-sortpkgs.1.xml:45
3245 msgid "All output is sent to stdout, the input must be a seekable file."
3248 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3249 #: apt-sortpkgs.1.xml:54
3251 "Use Source index field ordering. Configuration Item: "
3252 "<literal>APT::SortPkgs::Source</literal>."
3255 #. type: Content of: <refentry><refsect1><para>
3256 #: apt-sortpkgs.1.xml:68
3258 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
3262 #. The last update date
3263 #. type: Content of: <refentry><refentryinfo>
3264 #: apt.conf.5.xml:16
3266 "&apt-author.jgunthorpe; &apt-author.team; <author> "
3267 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
3268 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
3269 "</author> &apt-email; &apt-product; <date>16 January 2010</date>"
3272 #. type: Content of: <refentry><refmeta><manvolnum>
3273 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
3277 #. type: Content of: <refentry><refnamediv><refpurpose>
3278 #: apt.conf.5.xml:39
3279 msgid "Configuration file for APT"
3282 #. type: Content of: <refentry><refsect1><para>
3283 #: apt.conf.5.xml:43
3285 "<filename>apt.conf</filename> is the main configuration file for the APT "
3286 "suite of tools, but by far not the only place changes to options can be "
3287 "made. All tools therefore share the configuration files and also use a "
3288 "common command line parser to provide a uniform environment."
3291 #. type: Content of: <refentry><refsect1><orderedlist><para>
3292 #: apt.conf.5.xml:48
3294 "When an APT tool starts up it will read the configuration files in the "
3298 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3299 #: apt.conf.5.xml:50
3301 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
3305 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3306 #: apt.conf.5.xml:52
3308 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
3309 "order which have either no or \"<literal>conf</literal>\" as filename "
3310 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
3311 "and period (.) characters. Otherwise APT will print a notice that it has "
3312 "ignored a file if the file doesn't match a pattern in the "
3313 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
3314 "case it will be silently ignored."
3317 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3318 #: apt.conf.5.xml:59
3319 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
3322 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
3323 #: apt.conf.5.xml:61
3325 "the command line options are applied to override the configuration "
3326 "directives or to load even more configuration files."
3329 #. type: Content of: <refentry><refsect1><title>
3330 #: apt.conf.5.xml:65
3334 #. type: Content of: <refentry><refsect1><para>
3335 #: apt.conf.5.xml:66
3337 "The configuration file is organized in a tree with options organized into "
3338 "functional groups. Option specification is given with a double colon "
3339 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
3340 "within the APT tool group, for the Get tool. Options do not inherit from "
3341 "their parent groups."
3344 #. type: Content of: <refentry><refsect1><para>
3345 #: apt.conf.5.xml:72
3347 "Syntactically the configuration language is modeled after what the ISC tools "
3348 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
3349 "treated as comments (ignored), as well as all text between "
3350 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
3351 "Each line is of the form <literal>APT::Get::Assume-Yes "
3352 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
3353 "value must be on one line, and there is no kind of string concatenation. It "
3354 "must not include inside quotes. The behavior of the backslash \"\\\" and "
3355 "escaped characters inside a value is undefined and it should not be used. An "
3356 "option name may include alphanumerical characters and the \"/-:._+\" "
3357 "characters. A new scope can be opened with curly braces, like:"
3360 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3361 #: apt.conf.5.xml:86
3366 " Assume-Yes \"true\";\n"
3367 " Fix-Broken \"true\";\n"
3372 #. type: Content of: <refentry><refsect1><para>
3373 #: apt.conf.5.xml:94
3375 "with newlines placed to make it more readable. Lists can be created by "
3376 "opening a scope and including a single string enclosed in quotes followed by "
3377 "a semicolon. Multiple entries can be included, each separated by a "
3381 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
3382 #: apt.conf.5.xml:99
3384 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
3387 #. type: Content of: <refentry><refsect1><para>
3388 #: apt.conf.5.xml:102
3390 "In general the sample configuration file in "
3391 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
3392 "guide for how it should look."
3395 #. type: Content of: <refentry><refsect1><para>
3396 #: apt.conf.5.xml:106
3398 "The names of the configuration items are not case-sensitive. So in the "
3399 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
3402 #. type: Content of: <refentry><refsect1><para>
3403 #: apt.conf.5.xml:109
3405 "Names for the configuration items are optional if a list is defined as it "
3406 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
3407 "above. If you don't specify a name a new entry will simply add a new option "
3408 "to the list. If you specify a name you can override the option as every "
3409 "other option by reassigning a new value to the option."
3412 #. type: Content of: <refentry><refsect1><para>
3413 #: apt.conf.5.xml:114
3415 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
3416 "and not supported by alternative implementations) and "
3417 "<literal>#clear</literal>: <literal>#include</literal> will include the "
3418 "given file, unless the filename ends in a slash, then the whole directory is "
3419 "included. <literal>#clear</literal> is used to erase a part of the "
3420 "configuration tree. The specified element and all its descendants are "
3421 "erased. (Note that these lines also need to end with a semicolon.)"
3424 #. type: Content of: <refentry><refsect1><para>
3425 #: apt.conf.5.xml:122
3427 "The #clear command is the only way to delete a list or a complete scope. "
3428 "Reopening a scope or the ::-style described below will "
3429 "<emphasis>not</emphasis> override previously written entries. Only options "
3430 "can be overridden by addressing a new value to it - lists and scopes can't "
3431 "be overridden, only cleared."
3434 #. type: Content of: <refentry><refsect1><para>
3435 #: apt.conf.5.xml:127
3437 "All of the APT tools take a -o option which allows an arbitrary "
3438 "configuration directive to be specified on the command line. The syntax is a "
3439 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
3440 "followed by an equals sign then the new value of the option. To append a new "
3441 "element to a list, add a trailing :: to the name of the list. (As you might "
3442 "suspect: The scope syntax can't be used on the command line.)"
3445 #. type: Content of: <refentry><refsect1><para>
3446 #: apt.conf.5.xml:134
3448 "Note that you can use :: only for appending one item per line to a list and "
3449 "that you should not use it in combination with the scope syntax. (The scope "
3450 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
3451 "which some users unfortunately depend on: An option with the unusual name "
3452 "\"<literal>::</literal>\" which acts like every other option with a "
3453 "name. These introduces many problems including that a user who writes "
3454 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
3455 "append to a list will gain the opposite as only the last assignment for this "
3456 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
3457 "raise errors and will stop working if they encounter this misuse, so please "
3458 "correct such statements now as long as APT doesn't complain explicit about "
3462 #. type: Content of: <refentry><refsect1><title>
3463 #: apt.conf.5.xml:146
3464 msgid "The APT Group"
3467 #. type: Content of: <refentry><refsect1><para>
3468 #: apt.conf.5.xml:147
3470 "This group of options controls general APT behavior as well as holding the "
3471 "options for all of the tools."
3474 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3475 #: apt.conf.5.xml:152
3477 "System Architecture; sets the architecture to use when fetching files and "
3478 "parsing package lists. The internal default is the architecture apt was "
3482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3483 #: apt.conf.5.xml:158
3485 "All Architectures the system supports. Processors implementing the "
3486 "<literal>amd64</literal> (also called <literal>x86-64</literal>) instruction "
3487 "set are e.g. also able to execute binaries compiled for the "
3488 "<literal>i386</literal> (<literal>x86</literal>) instruction set; This list "
3489 "is use when fetching files and parsing package lists. The internal default "
3490 "is always the native architecture (<literal>APT::Architecture</literal>) "
3491 "and all foreign architectures it can retrieve by calling <command>dpkg "
3492 "--print-foreign-architectures</command>."
3495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3496 #: apt.conf.5.xml:168
3498 "Default release to install packages from if more than one version "
3499 "available. Contains release name, codename or release version. Examples: "
3500 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
3501 "'4.0', '5.0*'. See also &apt-preferences;."
3504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3505 #: apt.conf.5.xml:174
3507 "Ignore Held packages; This global option causes the problem resolver to "
3508 "ignore held packages in its decision making."
3511 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3512 #: apt.conf.5.xml:179
3514 "Defaults to on. When turned on the autoclean feature will remove any "
3515 "packages which can no longer be downloaded from the cache. If turned off "
3516 "then packages that are locally installed are also excluded from cleaning - "
3517 "but note that APT provides no direct means to reinstall them."
3520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3521 #: apt.conf.5.xml:186
3523 "Defaults to on which will cause APT to install essential and important "
3524 "packages as fast as possible in the install/upgrade operation. This is done "
3525 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
3526 "does treat an important package in the same way as an extra package: Between "
3527 "the unpacking of the important package A and his configuration can then be "
3528 "many other unpack or configuration calls, e.g. for package B which has no "
3529 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
3530 "script of package B generates an error) which results in a system state in "
3531 "which package A is unpacked but unconfigured - each package depending on A "
3532 "is now no longer guaranteed to work as their dependency on A is not longer "
3533 "satisfied. The immediate configuration marker is also applied to all "
3534 "dependencies which can generate a problem if the dependencies e.g. form a "
3535 "circle as a dependency with the immediate flag is comparable with a "
3536 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
3537 "in which it is unable to perform immediate configuration, errors out and "
3538 "refers to this option so the user can deactivate the immediate configuration "
3539 "temporarily to be able to perform an install/upgrade again. Note the use of "
3540 "the word \"theory\" here as this problem was only encountered by now in real "
3541 "world a few times in non-stable distribution versions and was caused by "
3542 "wrong dependencies of the package in question or by a system in an already "
3543 "broken state, so you should not blindly disable this option as the mentioned "
3544 "scenario above is not the only problem immediate configuration can help to "
3545 "prevent in the first place. Before a big operation like "
3546 "<literal>dist-upgrade</literal> is run with this option disabled it should "
3547 "be tried to explicitly <literal>install</literal> the package APT is unable "
3548 "to configure immediately, but please make sure to report your problem also "
3549 "to your distribution and to the APT team with the buglink below so they can "
3550 "work on improving or correcting the upgrade process."
3553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3554 #: apt.conf.5.xml:209
3556 "Never Enable this option unless you -really- know what you are doing. It "
3557 "permits APT to temporarily remove an essential package to break a "
3558 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
3559 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
3560 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
3561 "anything that those packages depend on."
3564 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3565 #: apt.conf.5.xml:218
3567 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
3568 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
3569 "to which size the Cache will grow and is therefore the amount of memory APT "
3570 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
3571 "that this amount of space needs to be available for APT otherwise it will "
3572 "likely fail ungracefully, so for memory restricted devices this value should "
3573 "be lowered while on systems with a lot of configured sources it should be "
3574 "increased. <literal>Cache-Grow</literal> defines in bytes with the default "
3575 "of 1048576 (~1 MB) how much the Cache size will be increased in the event "
3576 "the space defined by <literal>Cache-Start</literal> is not enough. These "
3577 "value will be applied again and again until either the cache is big enough "
3578 "to store all information or the size of the cache reaches the "
3579 "<literal>Cache-Limit</literal>. The default of "
3580 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
3581 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
3585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3586 #: apt.conf.5.xml:234
3587 msgid "Defines which package(s) are considered essential build dependencies."
3590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3591 #: apt.conf.5.xml:238
3593 "The Get subsection controls the &apt-get; tool, please see its documentation "
3594 "for more information about the options here."
3597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3598 #: apt.conf.5.xml:243
3600 "The Cache subsection controls the &apt-cache; tool, please see its "
3601 "documentation for more information about the options here."
3604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3605 #: apt.conf.5.xml:248
3607 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
3608 "documentation for more information about the options here."
3611 #. type: Content of: <refentry><refsect1><title>
3612 #: apt.conf.5.xml:254
3613 msgid "The Acquire Group"
3616 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3617 #: apt.conf.5.xml:260
3619 "Security related option defaulting to true as an expiring validation for a "
3620 "Release file prevents longtime replay attacks and can e.g. also help users "
3621 "to identify no longer updated mirrors - but the feature depends on the "
3622 "correctness of the time on the user system. Archive maintainers are "
3623 "encouraged to create Release files with the <literal>Valid-Until</literal> "
3624 "header, but if they don't or a stricter value is volitional the following "
3625 "<literal>Max-ValidTime</literal> option can be used."
3628 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3629 #: apt.conf.5.xml:271
3631 "Seconds the Release file should be considered valid after it was created "
3632 "(indicated by the <literal>Date</literal> header). If the Release file "
3633 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
3634 "the two is used as the expiration date. The default value is "
3635 "<literal>0</literal> which stands for \"for ever valid\". Archive specific "
3636 "settings can be made by appending the label of the archive to the option "
3640 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3641 #: apt.conf.5.xml:282
3643 "Minimum of seconds the Release file should be considered valid after it was "
3644 "created (indicated by the <literal>Date</literal> header). Use this if you "
3645 "need to use a seldomly updated (local) mirror of a more regular updated "
3646 "archive with a <literal>Valid-Until</literal> header instead of completely "
3647 "disabling the expiration date checking. Archive specific settings can and "
3648 "should be used by appending the label of the archive to the option name."
3651 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3652 #: apt.conf.5.xml:293
3654 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
3655 "Sources files instead of downloading whole ones. True by default."
3658 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3659 #: apt.conf.5.xml:296
3661 "Two sub-options to limit the use of PDiffs are also available: With "
3662 "<literal>FileLimit</literal> can be specified how many PDiff files are "
3663 "downloaded at most to update a file. <literal>SizeLimit</literal> on the "
3664 "other hand is the maximum percentage of the size of all patches compared to "
3665 "the size of the targeted file. If one of these limits is exceeded the "
3666 "complete file is downloaded instead of the patches."
3669 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3670 #: apt.conf.5.xml:306
3672 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
3673 "<literal>host</literal> or <literal>access</literal> which determines how "
3674 "APT parallelizes outgoing connections. <literal>host</literal> means that "
3675 "one connection per target host will be opened, <literal>access</literal> "
3676 "means that one connection per URI type will be opened."
3679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3680 #: apt.conf.5.xml:314
3682 "Number of retries to perform. If this is non-zero APT will retry failed "
3683 "files the given number of times."
3686 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3687 #: apt.conf.5.xml:319
3689 "Use symlinks for source archives. If set to true then source archives will "
3690 "be symlinked when possible instead of copying. True is the default."
3693 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3694 #: apt.conf.5.xml:324
3696 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
3697 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
3698 "host proxies can also be specified by using the form "
3699 "<literal>http::Proxy::<host></literal> with the special keyword "
3700 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3701 "settings is specified, <envar>http_proxy</envar> environment variable will "
3705 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3706 #: apt.conf.5.xml:332
3708 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
3709 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
3710 "response under any circumstances, <literal>Max-Age</literal> is sent only "
3711 "for index files and tells the cache to refresh its object if it is older "
3712 "than the given number of seconds. Debian updates its index files daily so "
3713 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
3714 "should never store this request, it is only set for archive files. This may "
3715 "be useful to prevent polluting a proxy cache with very large .deb "
3716 "files. Note: Squid 2.0.2 does not support any of these options."
3719 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3720 #: apt.conf.5.xml:342 apt.conf.5.xml:408
3722 "The option <literal>timeout</literal> sets the timeout timer used by the "
3723 "method, this applies to all things including connection timeout and data "
3727 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3728 #: apt.conf.5.xml:345
3730 "The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to "
3731 "enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial "
3732 "e.g. on high-latency connections. It specifies how many requests are send in "
3733 "a pipeline. Previous APT versions had a default of 10 for this setting, but "
3734 "the default value is now 0 (= disabled) to avoid problems with the "
3735 "ever-growing amount of webservers and proxies which choose to not conform to "
3736 "the HTTP/1.1 specification."
3739 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3740 #: apt.conf.5.xml:352
3742 "<literal>Acquire::http::AllowRedirect</literal> controls if APT will follow "
3743 "redirects, which is enabled by default."
3746 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3747 #: apt.conf.5.xml:355
3749 "The used bandwidth can be limited with "
3750 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
3751 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
3752 "as much as possible of the bandwidth (Note that this option implicit "
3753 "deactivates the download from multiple servers at the same time.)"
3756 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3757 #: apt.conf.5.xml:360
3759 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
3760 "User-Agent for the http download method as some proxies allow access for "
3761 "clients only if the client uses a known identifier."
3764 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3765 #: apt.conf.5.xml:367
3767 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
3768 "options are the same as for <literal>http</literal> method and will also "
3769 "default to the options from the <literal>http</literal> method if they are "
3770 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
3771 "not supported yet."
3774 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3775 #: apt.conf.5.xml:373
3777 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
3778 "about trusted certificates. <literal><host>::CaInfo</literal> is "
3779 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
3780 "suboption determines whether verify server's host certificate against "
3781 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
3782 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
3783 "suboption determines whether verify server's hostname or not. "
3784 "<literal><host>::Verify-Host</literal> is corresponding per-host "
3785 "option. <literal>SslCert</literal> determines what certificate to use for "
3786 "client authentication. <literal><host>::SslCert</literal> is "
3787 "corresponding per-host option. <literal>SslKey</literal> determines what "
3788 "private key to use for client "
3789 "authentication. <literal><host>::SslKey</literal> is corresponding "
3790 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
3791 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
3792 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
3796 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3797 #: apt.conf.5.xml:392
3799 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
3800 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
3801 "proxies can also be specified by using the form "
3802 "<literal>ftp::Proxy::<host></literal> with the special keyword "
3803 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
3804 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
3805 "used. To use a ftp proxy you will have to set the "
3806 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
3807 "entry specifies the commands to send to tell the proxy server what to "
3808 "connect to. Please see &configureindex; for an example of how to do "
3809 "this. The substitution variables available are "
3810 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
3811 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
3812 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
3813 "from it's respective URI component."
3816 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3817 #: apt.conf.5.xml:411
3819 "Several settings are provided to control passive mode. Generally it is safe "
3820 "to leave passive mode on, it works in nearly every environment. However "
3821 "some situations require that passive mode be disabled and port mode ftp used "
3822 "instead. This can be done globally, for connections that go through a proxy "
3823 "or for a specific host (See the sample config file for examples)."
3826 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3827 #: apt.conf.5.xml:418
3829 "It is possible to proxy FTP over HTTP by setting the "
3830 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
3831 "discussion of the http method above for syntax. You cannot set this in the "
3832 "configuration file and it is not recommended to use FTP over HTTP due to its "
3836 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3837 #: apt.conf.5.xml:423
3839 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
3840 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
3841 "false, which means these commands are only used if the control connection is "
3842 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
3843 "that most FTP servers do not support RFC2428."
3846 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3847 #: apt.conf.5.xml:436
3849 msgid "/cdrom/::Mount \"foo\";"
3852 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3853 #: apt.conf.5.xml:431
3855 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
3856 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
3857 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
3858 "provide alternate mount and unmount commands if your mount point cannot be "
3859 "listed in the fstab (such as an SMB mount and old mount packages). The "
3860 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
3861 "cdrom block. It is important to have the trailing slash. Unmount commands "
3862 "can be specified using UMount."
3865 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3866 #: apt.conf.5.xml:442
3868 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
3869 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
3873 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3874 #: apt.conf.5.xml:453
3877 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
3878 "\"<replaceable>Methodname</replaceable>\";"
3881 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3882 #: apt.conf.5.xml:448
3884 "List of compression types which are understood by the acquire methods. "
3885 "Files like <filename>Packages</filename> can be available in various "
3886 "compression formats. Per default the acquire methods can decompress "
3887 "<command>bzip2</command>, <command>lzma</command> and "
3888 "<command>gzip</command> compressed files, with this setting more formats can "
3889 "be added on the fly or the used method can be changed. The syntax for this "
3890 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
3893 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3894 #: apt.conf.5.xml:458
3896 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
3899 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
3900 #: apt.conf.5.xml:461
3902 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
3905 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3906 #: apt.conf.5.xml:454
3908 "Also the <literal>Order</literal> subgroup can be used to define in which "
3909 "order the acquire system will try to download the compressed files. The "
3910 "acquire system will try the first and proceed with the next compression type "
3911 "in this list on error, so to prefer one over the other type simple add the "
3912 "preferred type at first - not already added default types will be added at "
3913 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
3914 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
3915 "over <command>bzip2</command> and <command>lzma</command>. If "
3916 "<command>lzma</command> should be preferred over <command>gzip</command> and "
3917 "<command>bzip2</command> the configure setting should look like this "
3918 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
3919 "<literal>bz2</literal> explicit to the list as it will be added automatic."
3922 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
3923 #: apt.conf.5.xml:465
3925 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
3928 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3929 #: apt.conf.5.xml:463
3931 "Note that at run time the "
3932 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
3933 "checked: If this setting exists the method will only be used if this file "
3934 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
3935 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
3936 "the command line will be added at the end of the list specified in the "
3937 "configuration files, but before the default entries. To prefer a type in "
3938 "this case over the ones specified in the configuration files you can set the "
3939 "option direct - not in list style. This will not override the defined list, "
3940 "it will only prefix the list with this type."
3943 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3944 #: apt.conf.5.xml:470
3946 "The special type <literal>uncompressed</literal> can be used to give "
3947 "uncompressed files a preference, but note that most archives don't provide "
3948 "uncompressed files so this is mostly only useable for local mirrors."
3951 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3952 #: apt.conf.5.xml:477
3954 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
3955 "Sources, or Translations), keep them gzip compressed locally instead of "
3956 "unpacking them. This saves quite a lot of disk space at the expense of more "
3957 "CPU requirements when building the local package caches. False by default."
3960 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3961 #: apt.conf.5.xml:485
3963 "The Languages subsection controls which <filename>Translation</filename> "
3964 "files are downloaded and in which order APT tries to display the "
3965 "Description-Translations. APT will try to display the first available "
3966 "Description in the Language which is listed at first. Languages can be "
3967 "defined with their short or long Languagecodes. Note that not all archives "
3968 "provide <filename>Translation</filename> files for every Language - "
3969 "especially the long Languagecodes are rare, so please inform you which ones "
3970 "are available before you set here impossible values."
3973 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
3974 #: apt.conf.5.xml:501
3976 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
3979 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
3980 #: apt.conf.5.xml:491
3982 "The default list includes \"environment\" and "
3983 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
3984 "will be replaced at runtime with the languagecodes extracted from the "
3985 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
3986 "that these codes are not included twice in the list. If "
3987 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
3988 "<filename>Translation-en</filename> file (if available) will be used. To "
3989 "force apt to use no Translation file use the setting "
3990 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
3991 "another special meaning code which will stop the search for a fitting "
3992 "<filename>Translation</filename> file. This can be used by the system "
3993 "administrator to let APT know that it should download also this files "
3994 "without actually use them if the environment doesn't specify this "
3995 "languages. So the following example configuration will result in the order "
3996 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
3997 "that \"fr\" is downloaded, but not used if APT is not used in a french "
3998 "localization, in such an environment the order would be \"fr, de, en\". "
3999 "<placeholder type=\"programlisting\" id=\"0\"/>"
4002 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4003 #: apt.conf.5.xml:502
4005 "Note: To prevent problems resulting from APT being executed in different "
4006 "environments (e.g. by different users or by other programs) all Translation "
4007 "files which are found in <filename>/var/lib/apt/lists/</filename> will be "
4008 "added to the end of the list (after an implicit "
4009 "\"<literal>none</literal>\")."
4012 #. type: Content of: <refentry><refsect1><para>
4013 #: apt.conf.5.xml:255
4015 "The <literal>Acquire</literal> group of options controls the download of "
4016 "packages and the URI handlers. <placeholder type=\"variablelist\" "
4020 #. type: Content of: <refentry><refsect1><title>
4021 #: apt.conf.5.xml:513
4025 #. type: Content of: <refentry><refsect1><para>
4026 #: apt.conf.5.xml:515
4028 "The <literal>Dir::State</literal> section has directories that pertain to "
4029 "local state information. <literal>lists</literal> is the directory to place "
4030 "downloaded package lists in and <literal>status</literal> is the name of the "
4031 "dpkg status file. <literal>preferences</literal> is the name of the APT "
4032 "<filename>preferences</filename> file. <literal>Dir::State</literal> "
4033 "contains the default directory to prefix on all sub items if they do not "
4034 "start with <filename>/</filename> or <filename>./</filename>."
4037 #. type: Content of: <refentry><refsect1><para>
4038 #: apt.conf.5.xml:522
4040 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
4041 "information, such as the two package caches <literal>srcpkgcache</literal> "
4042 "and <literal>pkgcache</literal> as well as the location to place downloaded "
4043 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
4044 "be turned off by setting their names to be blank. This will slow down "
4045 "startup but save disk space. It is probably preferred to turn off the "
4046 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
4047 "default directory is contained in <literal>Dir::Cache</literal>"
4050 #. type: Content of: <refentry><refsect1><para>
4051 #: apt.conf.5.xml:531
4053 "<literal>Dir::Etc</literal> contains the location of configuration files, "
4054 "<literal>sourcelist</literal> gives the location of the sourcelist and "
4055 "<literal>main</literal> is the default configuration file (setting has no "
4056 "effect, unless it is done from the config file specified by "
4057 "<envar>APT_CONFIG</envar>)."
4060 #. type: Content of: <refentry><refsect1><para>
4061 #: apt.conf.5.xml:537
4063 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
4064 "in lexical order from the directory specified. After this is done then the "
4065 "main config file is loaded."
4068 #. type: Content of: <refentry><refsect1><para>
4069 #: apt.conf.5.xml:541
4071 "Binary programs are pointed to by "
4072 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
4073 "the location of the method handlers and <literal>gzip</literal>, "
4074 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
4075 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
4076 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
4077 "specify the location of the respective programs."
4080 #. type: Content of: <refentry><refsect1><para>
4081 #: apt.conf.5.xml:549
4083 "The configuration item <literal>RootDir</literal> has a special meaning. If "
4084 "set, all paths in <literal>Dir::</literal> will be relative to "
4085 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
4086 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
4087 "set to <filename>/tmp/staging</filename> and "
4088 "<literal>Dir::State::status</literal> is set to "
4089 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
4090 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
4093 #. type: Content of: <refentry><refsect1><para>
4094 #: apt.conf.5.xml:562
4096 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
4097 "which files APT should silently ignore while parsing the files in the "
4098 "fragment directories. Per default a file which end with "
4099 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
4100 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
4101 "default value these patterns can use regular expression syntax."
4104 #. type: Content of: <refentry><refsect1><title>
4105 #: apt.conf.5.xml:571
4106 msgid "APT in DSelect"
4109 #. type: Content of: <refentry><refsect1><para>
4110 #: apt.conf.5.xml:573
4112 "When APT is used as a &dselect; method several configuration directives "
4113 "control the default behaviour. These are in the <literal>DSelect</literal> "
4117 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4118 #: apt.conf.5.xml:578
4120 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
4121 "and never. always and prompt will remove all packages from the cache after "
4122 "upgrading, prompt (the default) does so conditionally. auto removes only "
4123 "those packages which are no longer downloadable (replaced with a new version "
4124 "for instance). pre-auto performs this action before downloading new "
4128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4129 #: apt.conf.5.xml:587
4131 "The contents of this variable is passed to &apt-get; as command line options "
4132 "when it is run for the install phase."
4135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4136 #: apt.conf.5.xml:592
4138 "The contents of this variable is passed to &apt-get; as command line options "
4139 "when it is run for the update phase."
4142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4143 #: apt.conf.5.xml:597
4145 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
4146 "The default is to prompt only on error."
4149 #. type: Content of: <refentry><refsect1><title>
4150 #: apt.conf.5.xml:603
4151 msgid "How APT calls dpkg"
4154 #. type: Content of: <refentry><refsect1><para>
4155 #: apt.conf.5.xml:604
4157 "Several configuration directives control how APT invokes &dpkg;. These are "
4158 "in the <literal>DPkg</literal> section."
4161 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4162 #: apt.conf.5.xml:609
4164 "This is a list of options to pass to dpkg. The options must be specified "
4165 "using the list notation and each list item is passed as a single argument to "
4169 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4170 #: apt.conf.5.xml:615
4172 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
4173 "<literal>options</literal> this must be specified in list notation. The "
4174 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4175 "fail APT will abort."
4178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4179 #: apt.conf.5.xml:622
4181 "This is a list of shell commands to run before invoking dpkg. Like "
4182 "<literal>options</literal> this must be specified in list notation. The "
4183 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
4184 "fail APT will abort. APT will pass to the commands on standard input the "
4185 "filenames of all .deb files it is going to install, one per line."
4188 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4189 #: apt.conf.5.xml:628
4191 "Version 2 of this protocol dumps more information, including the protocol "
4192 "version, the APT configuration space and the packages, files and versions "
4193 "being changed. Version 2 is enabled by setting "
4194 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
4195 "2. <literal>cmd</literal> is a command given to "
4196 "<literal>Pre-Install-Pkgs</literal>."
4199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4200 #: apt.conf.5.xml:636
4202 "APT chdirs to this directory before invoking dpkg, the default is "
4203 "<filename>/</filename>."
4206 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4207 #: apt.conf.5.xml:641
4209 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
4210 "default is to disable signing and produce all binaries."
4213 #. type: Content of: <refentry><refsect1><refsect2><title>
4214 #: apt.conf.5.xml:646
4215 msgid "dpkg trigger usage (and related options)"
4218 #. type: Content of: <refentry><refsect1><refsect2><para>
4219 #: apt.conf.5.xml:647
4221 "APT can call dpkg in a way so it can make aggressive use of triggers over "
4222 "multiple calls of dpkg. Without further options dpkg will use triggers only "
4223 "in between his own run. Activating these options can therefore decrease the "
4224 "time needed to perform the install / upgrade. Note that it is intended to "
4225 "activate these options per default in the future, but as it changes the way "
4226 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
4227 "options are therefore currently experimental and should not be used in "
4228 "productive environments.</emphasis> Also it breaks the progress reporting so "
4229 "all frontends will currently stay around half (or more) of the time in the "
4230 "100% state while it actually configures all packages."
4233 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
4234 #: apt.conf.5.xml:662
4237 "DPkg::NoTriggers \"true\";\n"
4238 "PackageManager::Configure \"smart\";\n"
4239 "DPkg::ConfigurePending \"true\";\n"
4240 "DPkg::TriggersPending \"true\";"
4243 #. type: Content of: <refentry><refsect1><refsect2><para>
4244 #: apt.conf.5.xml:656
4246 "Note that it is not guaranteed that APT will support these options or that "
4247 "these options will not cause (big) trouble in the future. If you have "
4248 "understand the current risks and problems with these options, but are brave "
4249 "enough to help testing them create a new configuration file and test a "
4250 "combination of options. Please report any bugs, problems and improvements "
4251 "you encounter and make sure to note which options you have used in your "
4252 "reports. Asking dpkg for help could also be useful for debugging proposes, "
4253 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
4254 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
4257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4258 #: apt.conf.5.xml:669
4260 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
4261 "call). See &dpkg; if you are interested in what this actually means. In "
4262 "short: dpkg will not run the triggers when this flag is present unless it is "
4263 "explicitly called to do so in an extra call. Note that this option exists "
4264 "(undocumented) also in older apt versions with a slightly different meaning: "
4265 "Previously these option only append --no-triggers to the configure calls to "
4266 "dpkg - now apt will add these flag also to the unpack and remove calls."
4269 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4270 #: apt.conf.5.xml:677
4272 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
4273 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
4274 "value and causes APT to configure all packages explicit. The "
4275 "\"<literal>smart</literal>\" way is it to configure only packages which need "
4276 "to be configured before another package can be unpacked (Pre-Depends) and "
4277 "let the rest configure by dpkg with a call generated by the next "
4278 "option. \"<literal>no</literal>\" on the other hand will not configure "
4279 "anything and totally rely on dpkg for configuration (which will at the "
4280 "moment fail if a Pre-Depends is encountered). Setting this option to "
4281 "another than the all value will implicitly activate also the next option per "
4282 "default as otherwise the system could end in an unconfigured status which "
4283 "could be unbootable!"
4286 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4287 #: apt.conf.5.xml:688
4289 "If this option is set apt will call <command>dpkg --configure "
4290 "--pending</command> to let dpkg handle all required configurations and "
4291 "triggers. This option is activated automatic per default if the previous "
4292 "option is not set to <literal>all</literal>, but deactivating could be "
4293 "useful if you want to run APT multiple times in a row - e.g. in an "
4294 "installer. In these sceneries you could deactivate this option in all but "
4298 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4299 #: apt.conf.5.xml:695
4301 "Useful for <literal>smart</literal> configuration as a package which has "
4302 "pending triggers is not considered as <literal>installed</literal> and dpkg "
4303 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
4304 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
4305 "triggers, not only the triggers needed to configure this package."
4308 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4309 #: apt.conf.5.xml:701
4311 "As the configuration can be deferred to be done at the end by dpkg it can be "
4312 "tried to order the unpack series only by critical needs, e.g. by "
4313 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
4314 "various steps by everything. While both method were present in earlier APT "
4315 "versions the <literal>OrderCritical</literal> method was unused, so this "
4316 "method is very experimental and needs further improvements before becoming "
4320 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
4321 #: apt.conf.5.xml:716
4324 "OrderList::Score {\n"
4326 "\tEssential 200;\n"
4328 "\tPreDepends 50;\n"
4332 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
4333 #: apt.conf.5.xml:709
4335 "Essential packages (and there dependencies) should be configured immediately "
4336 "after unpacking. It will be a good idea to do this quite early in the "
4337 "upgrade process as these these configure calls require currently also "
4338 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
4339 "(which maybe not needed). Essentials get per default a high score but the "
4340 "immediate flag is relatively low (a package which has a Pre-Depends is "
4341 "higher rated). These option and the others in the same group can be used to "
4342 "change the scoring. The following example shows the settings with there "
4343 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
4346 #. type: Content of: <refentry><refsect1><title>
4347 #: apt.conf.5.xml:729
4348 msgid "Periodic and Archives options"
4351 #. type: Content of: <refentry><refsect1><para>
4352 #: apt.conf.5.xml:730
4354 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
4355 "of options configure behavior of apt periodic updates, which is done by "
4356 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
4357 "the brief documentation of these options."
4360 #. type: Content of: <refentry><refsect1><title>
4361 #: apt.conf.5.xml:738
4362 msgid "Debug options"
4365 #. type: Content of: <refentry><refsect1><para>
4366 #: apt.conf.5.xml:740
4368 "Enabling options in the <literal>Debug::</literal> section will cause "
4369 "debugging information to be sent to the standard error stream of the program "
4370 "utilizing the <literal>apt</literal> libraries, or enable special program "
4371 "modes that are primarily useful for debugging the behavior of "
4372 "<literal>apt</literal>. Most of these options are not interesting to a "
4373 "normal user, but a few may be:"
4376 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4377 #: apt.conf.5.xml:751
4379 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
4380 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
4384 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4385 #: apt.conf.5.xml:759
4387 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
4388 "used to run some operations (for instance, <literal>apt-get -s "
4389 "install</literal>) as a non-root user."
4392 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4393 #: apt.conf.5.xml:768
4395 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
4396 "time that <literal>apt</literal> invokes &dpkg;."
4400 #. motivating example, except I haven't a clue why you'd want
4402 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
4403 #: apt.conf.5.xml:776
4405 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
4409 #. type: Content of: <refentry><refsect1><para>
4410 #: apt.conf.5.xml:786
4411 msgid "A full list of debugging options to apt follows."
4414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4415 #: apt.conf.5.xml:795
4416 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
4419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4420 #: apt.conf.5.xml:806
4421 msgid "Print information related to downloading packages using FTP."
4424 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4425 #: apt.conf.5.xml:817
4426 msgid "Print information related to downloading packages using HTTP."
4429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4430 #: apt.conf.5.xml:828
4431 msgid "Print information related to downloading packages using HTTPS."
4434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4435 #: apt.conf.5.xml:839
4437 "Print information related to verifying cryptographic signatures using "
4438 "<literal>gpg</literal>."
4441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4442 #: apt.conf.5.xml:850
4444 "Output information about the process of accessing collections of packages "
4445 "stored on CD-ROMs."
4448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4449 #: apt.conf.5.xml:860
4450 msgid "Describes the process of resolving build-dependencies in &apt-get;."
4453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4454 #: apt.conf.5.xml:870
4456 "Output each cryptographic hash that is generated by the "
4457 "<literal>apt</literal> libraries."
4460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4461 #: apt.conf.5.xml:880
4463 "Do not include information from <literal>statfs</literal>, namely the number "
4464 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
4468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4469 #: apt.conf.5.xml:891
4471 "Disable all file locking. For instance, this will allow two instances of "
4472 "<quote><literal>apt-get update</literal></quote> to run at the same time."
4475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4476 #: apt.conf.5.xml:903
4477 msgid "Log when items are added to or removed from the global download queue."
4480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4481 #: apt.conf.5.xml:913
4483 "Output status messages and errors related to verifying checksums and "
4484 "cryptographic signatures of downloaded files."
4487 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4488 #: apt.conf.5.xml:923
4490 "Output information about downloading and applying package index list diffs, "
4491 "and errors relating to package index list diffs."
4494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4495 #: apt.conf.5.xml:935
4497 "Output information related to patching apt package lists when downloading "
4498 "index diffs instead of full indices."
4501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4502 #: apt.conf.5.xml:946
4503 msgid "Log all interactions with the sub-processes that actually perform downloads."
4506 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4507 #: apt.conf.5.xml:957
4509 "Log events related to the automatically-installed status of packages and to "
4510 "the removal of unused packages."
4513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4514 #: apt.conf.5.xml:967
4516 "Generate debug messages describing which packages are being automatically "
4517 "installed to resolve dependencies. This corresponds to the initial "
4518 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
4519 "and not to the full <literal>apt</literal> dependency resolver; see "
4520 "<literal>Debug::pkgProblemResolver</literal> for that."
4523 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4524 #: apt.conf.5.xml:981
4526 "Generate debug messages describing which package is marked as "
4527 "keep/install/remove while the ProblemResolver does his work. Each addition "
4528 "or deletion may trigger additional actions; they are shown indented two "
4529 "additional space under the original entry. The format for each line is "
4530 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
4531 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
4532 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
4533 "is the current version of the package, <literal>d.e.f</literal> is the "
4534 "version considered for installation and <literal>x.y.z</literal> is a newer "
4535 "version, but not considered for installation (because of a low pin "
4536 "score). The later two can be omitted if there is none or if it is the same "
4537 "version as the installed. <literal>section</literal> is the name of the "
4538 "section the package appears in."
4541 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4542 #: apt.conf.5.xml:1003
4543 msgid "Dump the default configuration to standard error on startup."
4546 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4547 #: apt.conf.5.xml:1013
4549 "When invoking &dpkg;, output the precise command line with which it is being "
4550 "invoked, with arguments separated by a single space character."
4553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4554 #: apt.conf.5.xml:1024
4556 "Output all the data received from &dpkg; on the status file descriptor and "
4557 "any errors encountered while parsing it."
4560 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4561 #: apt.conf.5.xml:1035
4563 "Generate a trace of the algorithm that decides the order in which "
4564 "<literal>apt</literal> should pass packages to &dpkg;."
4567 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4568 #: apt.conf.5.xml:1047
4569 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
4572 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4573 #: apt.conf.5.xml:1058
4574 msgid "Output the priority of each package list on startup."
4577 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4578 #: apt.conf.5.xml:1068
4580 "Trace the execution of the dependency resolver (this applies only to what "
4581 "happens when a complex dependency problem is encountered)."
4584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4585 #: apt.conf.5.xml:1079
4587 "Display a list of all installed packages with their calculated score used by "
4588 "the pkgProblemResolver. The description of the package is the same as "
4589 "described in <literal>Debug::pkgDepCache::Marker</literal>"
4592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4593 #: apt.conf.5.xml:1091
4595 "Print information about the vendors read from "
4596 "<filename>/etc/apt/vendors.list</filename>."
4599 #. type: Content of: <refentry><refsect1><para>
4600 #: apt.conf.5.xml:1114
4602 "&configureindex; is a configuration file showing example values for all "
4606 #. type: Content of: <refentry><refsect1><variablelist>
4607 #: apt.conf.5.xml:1121
4608 msgid "&file-aptconf;"
4611 #. ? reading apt.conf
4612 #. type: Content of: <refentry><refsect1><para>
4613 #: apt.conf.5.xml:1126
4614 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
4617 #. The last update date
4618 #. type: Content of: <refentry><refentryinfo>
4619 #: apt_preferences.5.xml:16
4620 msgid "&apt-author.team; &apt-email; &apt-product; <date>16 February 2010</date>"
4623 #. type: Content of: <refentry><refnamediv><refpurpose>
4624 #: apt_preferences.5.xml:32
4625 msgid "Preference control file for APT"
4628 #. type: Content of: <refentry><refsect1><para>
4629 #: apt_preferences.5.xml:37
4631 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
4632 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
4633 "can be used to control which versions of packages will be selected for "
4637 #. type: Content of: <refentry><refsect1><para>
4638 #: apt_preferences.5.xml:42
4640 "Several versions of a package may be available for installation when the "
4641 "&sources-list; file contains references to more than one distribution (for "
4642 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
4643 "assigns a priority to each version that is available. Subject to dependency "
4644 "constraints, <command>apt-get</command> selects the version with the highest "
4645 "priority for installation. The APT preferences file overrides the "
4646 "priorities that APT assigns to package versions by default, thus giving the "
4647 "user control over which one is selected for installation."
4650 #. type: Content of: <refentry><refsect1><para>
4651 #: apt_preferences.5.xml:52
4653 "Several instances of the same version of a package may be available when the "
4654 "&sources-list; file contains references to more than one source. In this "
4655 "case <command>apt-get</command> downloads the instance listed earliest in "
4656 "the &sources-list; file. The APT preferences file does not affect the "
4657 "choice of instance, only the choice of version."
4660 #. type: Content of: <refentry><refsect1><para>
4661 #: apt_preferences.5.xml:59
4663 "Preferences are a strong power in the hands of a system administrator but "
4664 "they can become also their biggest nightmare if used without care! APT will "
4665 "not questioning the preferences so wrong settings will therefore lead to "
4666 "uninstallable packages or wrong decisions while upgrading packages. Even "
4667 "more problems will arise if multiply distribution releases are mixed without "
4668 "a good understanding of the following paragraphs. Packages included in a "
4669 "specific release aren't tested in and therefore doesn't always work as "
4670 "expected in older or newer releases or together with other packages from "
4671 "different releases. You have been warned."
4674 #. type: Content of: <refentry><refsect1><para>
4675 #: apt_preferences.5.xml:70
4677 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
4678 "directory are parsed in alphanumeric ascending order and need to obey the "
4679 "following naming convention: The files have either no or "
4680 "\"<literal>pref</literal>\" as filename extension and only contain "
4681 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
4682 "Otherwise APT will print a notice that it has ignored a file if the file "
4683 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
4684 "configuration list - in this case it will be silently ignored."
4687 #. type: Content of: <refentry><refsect1><refsect2><title>
4688 #: apt_preferences.5.xml:79
4689 msgid "APT's Default Priority Assignments"
4692 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4693 #: apt_preferences.5.xml:94
4696 "<command>apt-get install -t testing "
4697 "<replaceable>some-package</replaceable></command>\n"
4700 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
4701 #: apt_preferences.5.xml:97
4703 msgid "APT::Default-Release \"stable\";\n"
4706 #. type: Content of: <refentry><refsect1><refsect2><para>
4707 #: apt_preferences.5.xml:81
4709 "If there is no preferences file or if there is no entry in the file that "
4710 "applies to a particular version then the priority assigned to that version "
4711 "is the priority of the distribution to which that version belongs. It is "
4712 "possible to single out a distribution, \"the target release\", which "
4713 "receives a higher priority than other distributions do by default. The "
4714 "target release can be set on the <command>apt-get</command> command line or "
4715 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
4716 "that this has precedence over any general priority you set in the "
4717 "<filename>/etc/apt/preferences</filename> file described later, but not over "
4718 "specifically pinned packages. For example, <placeholder "
4719 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
4723 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4724 #: apt_preferences.5.xml:106
4728 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4729 #: apt_preferences.5.xml:107
4731 "to the versions coming from archives which in their "
4732 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
4733 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
4734 "<literal>experimental</literal> archive."
4737 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4738 #: apt_preferences.5.xml:113
4739 msgid "priority 100"
4742 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4743 #: apt_preferences.5.xml:114
4745 "to the version that is already installed (if any) and to the versions coming "
4746 "from archives which in their <filename>Release</filename> files are marked "
4747 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
4748 "backports archive since <literal>squeeze-backports</literal>."
4751 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4752 #: apt_preferences.5.xml:121
4753 msgid "priority 500"
4756 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4757 #: apt_preferences.5.xml:122
4759 "to the versions that are not installed and do not belong to the target "
4763 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
4764 #: apt_preferences.5.xml:126
4765 msgid "priority 990"
4768 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
4769 #: apt_preferences.5.xml:127
4770 msgid "to the versions that are not installed and belong to the target release."
4773 #. type: Content of: <refentry><refsect1><refsect2><para>
4774 #: apt_preferences.5.xml:101
4776 "If the target release has been specified then APT uses the following "
4777 "algorithm to set the priorities of the versions of a package. Assign: "
4778 "<placeholder type=\"variablelist\" id=\"0\"/>"
4781 #. type: Content of: <refentry><refsect1><refsect2><para>
4782 #: apt_preferences.5.xml:132
4784 "If the target release has not been specified then APT simply assigns "
4785 "priority 100 to all installed package versions and priority 500 to all "
4786 "uninstalled package versions, except versions coming from archives which in "
4787 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
4788 "- these versions get the priority 1 or priority 100 if it is additionally "
4789 "marked as \"ButAutomaticUpgrades: yes\"."
4792 #. type: Content of: <refentry><refsect1><refsect2><para>
4793 #: apt_preferences.5.xml:139
4795 "APT then applies the following rules, listed in order of precedence, to "
4796 "determine which version of a package to install."
4799 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4800 #: apt_preferences.5.xml:142
4802 "Never downgrade unless the priority of an available version exceeds 1000. "
4803 "(\"Downgrading\" is installing a less recent version of a package in place "
4804 "of a more recent version. Note that none of APT's default priorities "
4805 "exceeds 1000; such high priorities can only be set in the preferences file. "
4806 "Note also that downgrading a package can be risky.)"
4809 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4810 #: apt_preferences.5.xml:148
4811 msgid "Install the highest priority version."
4814 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4815 #: apt_preferences.5.xml:149
4817 "If two or more versions have the same priority, install the most recent one "
4818 "(that is, the one with the higher version number)."
4821 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4822 #: apt_preferences.5.xml:152
4824 "If two or more versions have the same priority and version number but either "
4825 "the packages differ in some of their metadata or the "
4826 "<literal>--reinstall</literal> option is given, install the uninstalled one."
4829 #. type: Content of: <refentry><refsect1><refsect2><para>
4830 #: apt_preferences.5.xml:158
4832 "In a typical situation, the installed version of a package (priority 100) "
4833 "is not as recent as one of the versions available from the sources listed in "
4834 "the &sources-list; file (priority 500 or 990). Then the package will be "
4835 "upgraded when <command>apt-get install "
4836 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4837 "upgrade</command> is executed."
4840 #. type: Content of: <refentry><refsect1><refsect2><para>
4841 #: apt_preferences.5.xml:165
4843 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
4844 "recent than any of the other available versions. The package will not be "
4845 "downgraded when <command>apt-get install "
4846 "<replaceable>some-package</replaceable></command> or <command>apt-get "
4847 "upgrade</command> is executed."
4850 #. type: Content of: <refentry><refsect1><refsect2><para>
4851 #: apt_preferences.5.xml:170
4853 "Sometimes the installed version of a package is more recent than the version "
4854 "belonging to the target release, but not as recent as a version belonging to "
4855 "some other distribution. Such a package will indeed be upgraded when "
4856 "<command>apt-get install <replaceable>some-package</replaceable></command> "
4857 "or <command>apt-get upgrade</command> is executed, because at least "
4858 "<emphasis>one</emphasis> of the available versions has a higher priority "
4859 "than the installed version."
4862 #. type: Content of: <refentry><refsect1><refsect2><title>
4863 #: apt_preferences.5.xml:179
4864 msgid "The Effect of APT Preferences"
4867 #. type: Content of: <refentry><refsect1><refsect2><para>
4868 #: apt_preferences.5.xml:181
4870 "The APT preferences file allows the system administrator to control the "
4871 "assignment of priorities. The file consists of one or more multi-line "
4872 "records separated by blank lines. Records can have one of two forms, a "
4873 "specific form and a general form."
4876 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4877 #: apt_preferences.5.xml:187
4879 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
4880 "specified packages and specified version or version range. For example, the "
4881 "following record assigns a high priority to all versions of the "
4882 "<filename>perl</filename> package whose version number begins with "
4883 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
4886 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4887 #: apt_preferences.5.xml:194
4891 "Pin: version 5.8*\n"
4892 "Pin-Priority: 1001\n"
4895 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4896 #: apt_preferences.5.xml:200
4898 "The general form assigns a priority to all of the package versions in a "
4899 "given distribution (that is, to all the versions of packages that are listed "
4900 "in a certain <filename>Release</filename> file) or to all of the package "
4901 "versions coming from a particular Internet site, as identified by the site's "
4902 "fully qualified domain name."
4905 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4906 #: apt_preferences.5.xml:206
4908 "This general-form entry in the APT preferences file applies only to groups "
4909 "of packages. For example, the following record assigns a high priority to "
4910 "all package versions available from the local site."
4913 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4914 #: apt_preferences.5.xml:211
4918 "Pin: origin \"\"\n"
4919 "Pin-Priority: 999\n"
4922 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4923 #: apt_preferences.5.xml:216
4925 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
4926 "which can be used to match a hostname. The following record will assign a "
4927 "high priority to all versions available from the server identified by the "
4928 "hostname \"ftp.de.debian.org\""
4931 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4932 #: apt_preferences.5.xml:220
4936 "Pin: origin \"ftp.de.debian.org\"\n"
4937 "Pin-Priority: 999\n"
4940 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4941 #: apt_preferences.5.xml:224
4943 "This should <emphasis>not</emphasis> be confused with the Origin of a "
4944 "distribution as specified in a <filename>Release</filename> file. What "
4945 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
4946 "Internet address but an author or vendor name, such as \"Debian\" or "
4950 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4951 #: apt_preferences.5.xml:229
4953 "The following record assigns a low priority to all package versions "
4954 "belonging to any distribution whose Archive name is "
4955 "\"<literal>unstable</literal>\"."
4958 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4959 #: apt_preferences.5.xml:233
4963 "Pin: release a=unstable\n"
4964 "Pin-Priority: 50\n"
4967 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4968 #: apt_preferences.5.xml:238
4970 "The following record assigns a high priority to all package versions "
4971 "belonging to any distribution whose Codename is "
4972 "\"<literal>&testing-codename;</literal>\"."
4975 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4976 #: apt_preferences.5.xml:242
4980 "Pin: release n=&testing-codename;\n"
4981 "Pin-Priority: 900\n"
4984 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
4985 #: apt_preferences.5.xml:247
4987 "The following record assigns a high priority to all package versions "
4988 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
4989 "and whose release Version number is \"<literal>3.0</literal>\"."
4992 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
4993 #: apt_preferences.5.xml:252
4997 "Pin: release a=stable, v=3.0\n"
4998 "Pin-Priority: 500\n"
5001 #. type: Content of: <refentry><refsect1><refsect2><title>
5002 #: apt_preferences.5.xml:262
5003 msgid "Regular expressions and glob() syntax"
5006 #. type: Content of: <refentry><refsect1><refsect2><para>
5007 #: apt_preferences.5.xml:264
5009 "APT also supports pinning by glob() expressions and regular expressions "
5010 "surrounded by /. For example, the following example assigns the priority 500 "
5011 "to all packages from experimental where the name starts with gnome (as a "
5012 "glob()-like expression) or contains the word kde (as a POSIX extended "
5013 "regular expression surrounded by slashes)."
5016 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5017 #: apt_preferences.5.xml:273
5020 "Package: gnome* /kde/\n"
5021 "Pin: release n=experimental\n"
5022 "Pin-Priority: 500\n"
5025 #. type: Content of: <refentry><refsect1><refsect2><para>
5026 #: apt_preferences.5.xml:279
5028 "The rule for those expressions is that they can occur anywhere where a "
5029 "string can occur. Thus, the following pin assigns the priority 990 to all "
5030 "packages from a release starting with karmic."
5033 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5034 #: apt_preferences.5.xml:285
5038 "Pin: release n=karmic*\n"
5039 "Pin-Priority: 990\n"
5042 #. type: Content of: <refentry><refsect1><refsect2><para>
5043 #: apt_preferences.5.xml:291
5045 "If a regular expression occurs in a <literal>Package</literal> field, the "
5046 "behavior is the same as if this regular expression were replaced with a list "
5047 "of all package names it matches. It is undecided whether this will change in "
5048 "the future, thus you should always list wild-card pins first, so later "
5049 "specific pins override it. The pattern \"<literal>*</literal>\" in a "
5050 "Package field is not considered a glob() expression in itself."
5053 #. type: Content of: <refentry><refsect1><refsect2><title>
5054 #: apt_preferences.5.xml:307
5055 msgid "How APT Interprets Priorities"
5058 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5059 #: apt_preferences.5.xml:315
5063 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5064 #: apt_preferences.5.xml:316
5066 "causes a version to be installed even if this constitutes a downgrade of the "
5070 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5071 #: apt_preferences.5.xml:320
5072 msgid "990 < P <=1000"
5075 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5076 #: apt_preferences.5.xml:321
5078 "causes a version to be installed even if it does not come from the target "
5079 "release, unless the installed version is more recent"
5082 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5083 #: apt_preferences.5.xml:326
5084 msgid "500 < P <=990"
5087 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5088 #: apt_preferences.5.xml:327
5090 "causes a version to be installed unless there is a version available "
5091 "belonging to the target release or the installed version is more recent"
5094 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5095 #: apt_preferences.5.xml:332
5096 msgid "100 < P <=500"
5099 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5100 #: apt_preferences.5.xml:333
5102 "causes a version to be installed unless there is a version available "
5103 "belonging to some other distribution or the installed version is more recent"
5106 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5107 #: apt_preferences.5.xml:338
5108 msgid "0 < P <=100"
5111 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5112 #: apt_preferences.5.xml:339
5114 "causes a version to be installed only if there is no installed version of "
5118 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5119 #: apt_preferences.5.xml:343
5123 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5124 #: apt_preferences.5.xml:344
5125 msgid "prevents the version from being installed"
5128 #. type: Content of: <refentry><refsect1><refsect2><para>
5129 #: apt_preferences.5.xml:310
5131 "Priorities (P) assigned in the APT preferences file must be positive or "
5132 "negative integers. They are interpreted as follows (roughly speaking): "
5133 "<placeholder type=\"variablelist\" id=\"0\"/>"
5136 #. type: Content of: <refentry><refsect1><refsect2><para>
5137 #: apt_preferences.5.xml:349
5139 "If any specific-form records match an available package version then the "
5140 "first such record determines the priority of the package version. Failing "
5141 "that, if any general-form records match an available package version then "
5142 "the first such record determines the priority of the package version."
5145 #. type: Content of: <refentry><refsect1><refsect2><para>
5146 #: apt_preferences.5.xml:355
5148 "For example, suppose the APT preferences file contains the three records "
5149 "presented earlier:"
5152 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
5153 #: apt_preferences.5.xml:359
5157 "Pin: version 5.8*\n"
5158 "Pin-Priority: 1001\n"
5161 "Pin: origin \"\"\n"
5162 "Pin-Priority: 999\n"
5165 "Pin: release unstable\n"
5166 "Pin-Priority: 50\n"
5169 #. type: Content of: <refentry><refsect1><refsect2><para>
5170 #: apt_preferences.5.xml:372
5174 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5175 #: apt_preferences.5.xml:374
5177 "The most recent available version of the <literal>perl</literal> package "
5178 "will be installed, so long as that version's version number begins with "
5179 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
5180 "<literal>perl</literal> is available and the installed version is 5.9*, then "
5181 "<literal>perl</literal> will be downgraded."
5184 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5185 #: apt_preferences.5.xml:379
5187 "A version of any package other than <literal>perl</literal> that is "
5188 "available from the local system has priority over other versions, even "
5189 "versions belonging to the target release."
5192 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5193 #: apt_preferences.5.xml:383
5195 "A version of a package whose origin is not the local system but some other "
5196 "site listed in &sources-list; and which belongs to an "
5197 "<literal>unstable</literal> distribution is only installed if it is selected "
5198 "for installation and no version of the package is already installed."
5201 #. type: Content of: <refentry><refsect1><refsect2><title>
5202 #: apt_preferences.5.xml:393
5203 msgid "Determination of Package Version and Distribution Properties"
5206 #. type: Content of: <refentry><refsect1><refsect2><para>
5207 #: apt_preferences.5.xml:395
5209 "The locations listed in the &sources-list; file should provide "
5210 "<filename>Packages</filename> and <filename>Release</filename> files to "
5211 "describe the packages available at that location."
5214 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5215 #: apt_preferences.5.xml:407
5216 msgid "the <literal>Package:</literal> line"
5219 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5220 #: apt_preferences.5.xml:408
5221 msgid "gives the package name"
5224 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5225 #: apt_preferences.5.xml:411 apt_preferences.5.xml:461
5226 msgid "the <literal>Version:</literal> line"
5229 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5230 #: apt_preferences.5.xml:412
5231 msgid "gives the version number for the named package"
5234 #. type: Content of: <refentry><refsect1><refsect2><para>
5235 #: apt_preferences.5.xml:399
5237 "The <filename>Packages</filename> file is normally found in the directory "
5238 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
5240 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
5241 "consists of a series of multi-line records, one for each package available "
5242 "in that directory. Only two lines in each record are relevant for setting "
5243 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
5246 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5247 #: apt_preferences.5.xml:428
5248 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
5251 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5252 #: apt_preferences.5.xml:429
5254 "names the archive to which all the packages in the directory tree belong. "
5255 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
5256 "that all of the packages in the directory tree below the parent of the "
5257 "<filename>Release</filename> file are in a <literal>stable</literal> "
5258 "archive. Specifying this value in the APT preferences file would require "
5262 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5263 #: apt_preferences.5.xml:439
5265 msgid "Pin: release a=stable\n"
5268 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5269 #: apt_preferences.5.xml:445
5270 msgid "the <literal>Codename:</literal> line"
5273 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5274 #: apt_preferences.5.xml:446
5276 "names the codename to which all the packages in the directory tree belong. "
5277 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
5278 "the packages in the directory tree below the parent of the "
5279 "<filename>Release</filename> file belong to a version named "
5280 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
5281 "preferences file would require the line:"
5284 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5285 #: apt_preferences.5.xml:455
5287 msgid "Pin: release n=&testing-codename;\n"
5290 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5291 #: apt_preferences.5.xml:462
5293 "names the release version. For example, the packages in the tree might "
5294 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
5295 "no version number for the <literal>testing</literal> and "
5296 "<literal>unstable</literal> distributions because they have not been "
5297 "released yet. Specifying this in the APT preferences file would require one "
5298 "of the following lines."
5301 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5302 #: apt_preferences.5.xml:471
5305 "Pin: release v=3.0\n"
5306 "Pin: release a=stable, v=3.0\n"
5307 "Pin: release 3.0\n"
5310 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5311 #: apt_preferences.5.xml:480
5312 msgid "the <literal>Component:</literal> line"
5315 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5316 #: apt_preferences.5.xml:481
5318 "names the licensing component associated with the packages in the directory "
5319 "tree of the <filename>Release</filename> file. For example, the line "
5320 "\"Component: main\" specifies that all the packages in the directory tree "
5321 "are from the <literal>main</literal> component, which entails that they are "
5322 "licensed under terms listed in the Debian Free Software Guidelines. "
5323 "Specifying this component in the APT preferences file would require the "
5327 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5328 #: apt_preferences.5.xml:490
5330 msgid "Pin: release c=main\n"
5333 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5334 #: apt_preferences.5.xml:496
5335 msgid "the <literal>Origin:</literal> line"
5338 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5339 #: apt_preferences.5.xml:497
5341 "names the originator of the packages in the directory tree of the "
5342 "<filename>Release</filename> file. Most commonly, this is "
5343 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
5344 "file would require the line:"
5347 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5348 #: apt_preferences.5.xml:503
5350 msgid "Pin: release o=Debian\n"
5353 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5354 #: apt_preferences.5.xml:509
5355 msgid "the <literal>Label:</literal> line"
5358 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5359 #: apt_preferences.5.xml:510
5361 "names the label of the packages in the directory tree of the "
5362 "<filename>Release</filename> file. Most commonly, this is "
5363 "<literal>Debian</literal>. Specifying this label in the APT preferences "
5364 "file would require the line:"
5367 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
5368 #: apt_preferences.5.xml:516
5370 msgid "Pin: release l=Debian\n"
5373 #. type: Content of: <refentry><refsect1><refsect2><para>
5374 #: apt_preferences.5.xml:417
5376 "The <filename>Release</filename> file is normally found in the directory "
5377 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
5378 "example, <filename>.../dists/stable/Release</filename>, or "
5379 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
5380 "single multi-line record which applies to <emphasis>all</emphasis> of the "
5381 "packages in the directory tree below its parent. Unlike the "
5382 "<filename>Packages</filename> file, nearly all of the lines in a "
5383 "<filename>Release</filename> file are relevant for setting APT priorities: "
5384 "<placeholder type=\"variablelist\" id=\"0\"/>"
5387 #. type: Content of: <refentry><refsect1><refsect2><para>
5388 #: apt_preferences.5.xml:523
5390 "All of the <filename>Packages</filename> and <filename>Release</filename> "
5391 "files retrieved from locations listed in the &sources-list; file are stored "
5392 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
5393 "named by the variable <literal>Dir::State::Lists</literal> in the "
5394 "<filename>apt.conf</filename> file. For example, the file "
5395 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
5396 "contains the <filename>Release</filename> file retrieved from the site "
5397 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
5398 "architecture files from the <literal>contrib</literal> component of the "
5399 "<literal>unstable</literal> distribution."
5402 #. type: Content of: <refentry><refsect1><refsect2><title>
5403 #: apt_preferences.5.xml:536
5404 msgid "Optional Lines in an APT Preferences Record"
5407 #. type: Content of: <refentry><refsect1><refsect2><para>
5408 #: apt_preferences.5.xml:538
5410 "Each record in the APT preferences file can optionally begin with one or "
5411 "more lines beginning with the word <literal>Explanation:</literal>. This "
5412 "provides a place for comments."
5415 #. type: Content of: <refentry><refsect1><refsect2><title>
5416 #: apt_preferences.5.xml:547
5417 msgid "Tracking Stable"
5420 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5421 #: apt_preferences.5.xml:555
5424 "Explanation: Uninstall or do not install any Debian-originated\n"
5425 "Explanation: package versions other than those in the stable distro\n"
5427 "Pin: release a=stable\n"
5428 "Pin-Priority: 900\n"
5431 "Pin: release o=Debian\n"
5432 "Pin-Priority: -10\n"
5435 #. type: Content of: <refentry><refsect1><refsect2><para>
5436 #: apt_preferences.5.xml:549
5438 "The following APT preferences file will cause APT to assign a priority "
5439 "higher than the default (500) to all package versions belonging to a "
5440 "<literal>stable</literal> distribution and a prohibitively low priority to "
5441 "package versions belonging to other <literal>Debian</literal> "
5442 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
5445 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5446 #: apt_preferences.5.xml:572 apt_preferences.5.xml:618 apt_preferences.5.xml:676
5449 "apt-get install <replaceable>package-name</replaceable>\n"
5451 "apt-get dist-upgrade\n"
5454 #. type: Content of: <refentry><refsect1><refsect2><para>
5455 #: apt_preferences.5.xml:567
5457 "With a suitable &sources-list; file and the above preferences file, any of "
5458 "the following commands will cause APT to upgrade to the latest "
5459 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
5463 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5464 #: apt_preferences.5.xml:584
5466 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
5469 #. type: Content of: <refentry><refsect1><refsect2><para>
5470 #: apt_preferences.5.xml:578
5472 "The following command will cause APT to upgrade the specified package to the "
5473 "latest version from the <literal>testing</literal> distribution; the package "
5474 "will not be upgraded again unless this command is given again. <placeholder "
5475 "type=\"programlisting\" id=\"0\"/>"
5478 #. type: Content of: <refentry><refsect1><refsect2><title>
5479 #: apt_preferences.5.xml:590
5480 msgid "Tracking Testing or Unstable"
5483 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5484 #: apt_preferences.5.xml:599
5488 "Pin: release a=testing\n"
5489 "Pin-Priority: 900\n"
5492 "Pin: release a=unstable\n"
5493 "Pin-Priority: 800\n"
5496 "Pin: release o=Debian\n"
5497 "Pin-Priority: -10\n"
5500 #. type: Content of: <refentry><refsect1><refsect2><para>
5501 #: apt_preferences.5.xml:592
5503 "The following APT preferences file will cause APT to assign a high priority "
5504 "to package versions from the <literal>testing</literal> distribution, a "
5505 "lower priority to package versions from the <literal>unstable</literal> "
5506 "distribution, and a prohibitively low priority to package versions from "
5507 "other <literal>Debian</literal> distributions. <placeholder "
5508 "type=\"programlisting\" id=\"0\"/>"
5511 #. type: Content of: <refentry><refsect1><refsect2><para>
5512 #: apt_preferences.5.xml:613
5514 "With a suitable &sources-list; file and the above preferences file, any of "
5515 "the following commands will cause APT to upgrade to the latest "
5516 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
5520 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5521 #: apt_preferences.5.xml:633
5523 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
5526 #. type: Content of: <refentry><refsect1><refsect2><para>
5527 #: apt_preferences.5.xml:624
5529 "The following command will cause APT to upgrade the specified package to the "
5530 "latest version from the <literal>unstable</literal> distribution. "
5531 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
5532 "the most recent <literal>testing</literal> version if that is more recent "
5533 "than the installed version, otherwise, to the most recent "
5534 "<literal>unstable</literal> version if that is more recent than the "
5535 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
5538 #. type: Content of: <refentry><refsect1><refsect2><title>
5539 #: apt_preferences.5.xml:640
5540 msgid "Tracking the evolution of a codename release"
5543 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5544 #: apt_preferences.5.xml:654
5547 "Explanation: Uninstall or do not install any Debian-originated package "
5549 "Explanation: other than those in the distribution codenamed with "
5550 "&testing-codename; or sid\n"
5552 "Pin: release n=&testing-codename;\n"
5553 "Pin-Priority: 900\n"
5555 "Explanation: Debian unstable is always codenamed with sid\n"
5557 "Pin: release n=sid\n"
5558 "Pin-Priority: 800\n"
5561 "Pin: release o=Debian\n"
5562 "Pin-Priority: -10\n"
5565 #. type: Content of: <refentry><refsect1><refsect2><para>
5566 #: apt_preferences.5.xml:642
5568 "The following APT preferences file will cause APT to assign a priority "
5569 "higher than the default (500) to all package versions belonging to a "
5570 "specified codename of a distribution and a prohibitively low priority to "
5571 "package versions belonging to other <literal>Debian</literal> distributions, "
5572 "codenames and archives. Note that with this APT preference APT will follow "
5573 "the migration of a release from the archive <literal>testing</literal> to "
5574 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
5575 "want to follow for example the progress in <literal>testing</literal> "
5576 "notwithstanding the codename changes you should use the example "
5577 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
5580 #. type: Content of: <refentry><refsect1><refsect2><para>
5581 #: apt_preferences.5.xml:671
5583 "With a suitable &sources-list; file and the above preferences file, any of "
5584 "the following commands will cause APT to upgrade to the latest version(s) in "
5585 "the release codenamed with <literal>&testing-codename;</literal>. "
5586 "<placeholder type=\"programlisting\" id=\"0\"/>"
5589 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5590 #: apt_preferences.5.xml:691
5592 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
5595 #. type: Content of: <refentry><refsect1><refsect2><para>
5596 #: apt_preferences.5.xml:682
5598 "The following command will cause APT to upgrade the specified package to the "
5599 "latest version from the <literal>sid</literal> distribution. Thereafter, "
5600 "<command>apt-get upgrade</command> will upgrade the package to the most "
5601 "recent <literal>&testing-codename;</literal> version if that is more recent "
5602 "than the installed version, otherwise, to the most recent "
5603 "<literal>sid</literal> version if that is more recent than the installed "
5604 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
5607 #. type: Content of: <refentry><refsect1><variablelist>
5608 #: apt_preferences.5.xml:700
5609 msgid "&file-preferences;"
5612 #. type: Content of: <refentry><refsect1><para>
5613 #: apt_preferences.5.xml:706
5614 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
5617 #. type: Content of: <refentry><refnamediv><refpurpose>
5618 #: sources.list.5.xml:33
5619 msgid "Package resource list for APT"
5622 #. type: Content of: <refentry><refsect1><para>
5623 #: sources.list.5.xml:37
5625 "The package resource list is used to locate archives of the package "
5626 "distribution system in use on the system. At this time, this manual page "
5627 "documents only the packaging system used by the Debian GNU/Linux system. "
5628 "This control file is <filename>/etc/apt/sources.list</filename>."
5631 #. type: Content of: <refentry><refsect1><para>
5632 #: sources.list.5.xml:42
5634 "The source list is designed to support any number of active sources and a "
5635 "variety of source media. The file lists one source per line, with the most "
5636 "preferred source listed first. The format of each line is: <literal>type uri "
5637 "args</literal> The first item, <literal>type</literal> determines the format "
5638 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
5639 "Identifier (URI), which is a superset of the more specific and well-known "
5640 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
5641 "comment by using a #."
5644 #. type: Content of: <refentry><refsect1><title>
5645 #: sources.list.5.xml:53
5646 msgid "sources.list.d"
5649 #. type: Content of: <refentry><refsect1><para>
5650 #: sources.list.5.xml:54
5652 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
5653 "add sources.list entries in separate files. The format is the same as for "
5654 "the regular <filename>sources.list</filename> file. File names need to end "
5655 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
5656 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
5657 "Otherwise APT will print a notice that it has ignored a file if the file "
5658 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5659 "configuration list - in this case it will be silently ignored."
5662 #. type: Content of: <refentry><refsect1><title>
5663 #: sources.list.5.xml:65
5664 msgid "The deb and deb-src types"
5667 #. type: Content of: <refentry><refsect1><para>
5668 #: sources.list.5.xml:66
5670 "The <literal>deb</literal> type describes a typical two-level Debian "
5671 "archive, <filename>distribution/component</filename>. Typically, "
5672 "<literal>distribution</literal> is generally an archivename like "
5673 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
5674 "<literal>&stable-codename;</literal> or "
5675 "<literal>&testing-codename;</literal> while component is one of "
5676 "<literal>main</literal> <literal>contrib</literal> or "
5677 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
5678 "debian distribution's source code in the same form as the "
5679 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
5680 "to fetch source indexes."
5683 #. type: Content of: <refentry><refsect1><para>
5684 #: sources.list.5.xml:78
5686 "The format for a <filename>sources.list</filename> entry using the "
5687 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
5690 #. type: Content of: <refentry><refsect1><literallayout>
5691 #: sources.list.5.xml:81
5693 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
5696 #. type: Content of: <refentry><refsect1><para>
5697 #: sources.list.5.xml:83
5699 "The URI for the <literal>deb</literal> type must specify the base of the "
5700 "Debian distribution, from which APT will find the information it needs. "
5701 "<literal>distribution</literal> can specify an exact path, in which case the "
5702 "components must be omitted and <literal>distribution</literal> must end with "
5703 "a slash (/). This is useful for when the case only a particular sub-section "
5704 "of the archive denoted by the URI is of interest. If "
5705 "<literal>distribution</literal> does not specify an exact path, at least one "
5706 "<literal>component</literal> must be present."
5709 #. type: Content of: <refentry><refsect1><para>
5710 #: sources.list.5.xml:92
5712 "<literal>distribution</literal> may also contain a variable, "
5713 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
5714 "m68k, powerpc, ...) used on the system. This permits "
5715 "architecture-independent <filename>sources.list</filename> files to be "
5716 "used. In general this is only of interest when specifying an exact path, "
5717 "<literal>APT</literal> will automatically generate a URI with the current "
5718 "architecture otherwise."
5721 #. type: Content of: <refentry><refsect1><para>
5722 #: sources.list.5.xml:100
5724 "Since only one distribution can be specified per line it may be necessary to "
5725 "have multiple lines for the same URI, if a subset of all available "
5726 "distributions or components at that location is desired. APT will sort the "
5727 "URI list after it has generated a complete set internally, and will collapse "
5728 "multiple references to the same Internet host, for instance, into a single "
5729 "connection, so that it does not inefficiently establish an FTP connection, "
5730 "close it, do something else, and then re-establish a connection to that same "
5731 "host. This feature is useful for accessing busy FTP sites with limits on the "
5732 "number of simultaneous anonymous users. APT also parallelizes connections to "
5733 "different hosts to more effectively deal with sites with low bandwidth."
5736 #. type: Content of: <refentry><refsect1><para>
5737 #: sources.list.5.xml:112
5739 "<literal>options</literal> is always optional and needs to be surounded by "
5740 "square brackets. It can consist of multiple settings in the form "
5741 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
5742 "Multiple settings are separated by spaces. The following settings are "
5743 "supported by APT, note though that unsupported settings will be ignored "
5747 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5748 #: sources.list.5.xml:117
5750 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
5751 "can be used to specify for which architectures packages information should "
5752 "be downloaded. If this option is not set all architectures defined by the "
5753 "<literal>APT::Architectures</literal> option will be downloaded."
5756 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5757 #: sources.list.5.xml:121
5759 "<literal>trusted=yes</literal> can be set to indicate that packages from "
5760 "this source are always authenticated even if the "
5761 "<filename>Release</filename> file is not signed or the signature can't be "
5762 "checked. This disables parts of &apt-secure; and should therefore only be "
5763 "used in a local and trusted context. <literal>trusted=no</literal> is the "
5764 "opposite which handles even correctly authenticated sources as not "
5768 #. type: Content of: <refentry><refsect1><para>
5769 #: sources.list.5.xml:128
5771 "It is important to list sources in order of preference, with the most "
5772 "preferred source listed first. Typically this will result in sorting by "
5773 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
5774 "followed by distant Internet hosts, for example)."
5777 #. type: Content of: <refentry><refsect1><para>
5778 #: sources.list.5.xml:133
5779 msgid "Some examples:"
5782 #. type: Content of: <refentry><refsect1><literallayout>
5783 #: sources.list.5.xml:135
5786 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
5787 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
5792 #. type: Content of: <refentry><refsect1><title>
5793 #: sources.list.5.xml:141
5794 msgid "URI specification"
5797 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5798 #: sources.list.5.xml:146
5802 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5803 #: sources.list.5.xml:148
5805 "The file scheme allows an arbitrary directory in the file system to be "
5806 "considered an archive. This is useful for NFS mounts and local mirrors or "
5810 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5811 #: sources.list.5.xml:153
5815 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5816 #: sources.list.5.xml:155
5818 "The cdrom scheme allows APT to use a local CDROM drive with media "
5819 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
5823 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5824 #: sources.list.5.xml:160
5828 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5829 #: sources.list.5.xml:162
5831 "The http scheme specifies an HTTP server for the archive. If an environment "
5832 "variable <envar>http_proxy</envar> is set with the format "
5833 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
5834 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
5835 "the format http://user:pass@server:port/. Note that this is an insecure "
5836 "method of authentication."
5839 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5840 #: sources.list.5.xml:171
5844 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5845 #: sources.list.5.xml:173
5847 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
5848 "is highly configurable; for more information see the &apt-conf; manual "
5849 "page. Please note that a ftp proxy can be specified by using the "
5850 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
5851 "http proxy (http proxy servers often understand ftp urls) using this method "
5852 "and ONLY this method. ftp proxies using http specified in the configuration "
5853 "file will be ignored."
5856 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5857 #: sources.list.5.xml:182
5861 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5862 #: sources.list.5.xml:184
5864 "The copy scheme is identical to the file scheme except that packages are "
5865 "copied into the cache directory instead of used directly at their location. "
5866 "This is useful for people using a zip disk to copy files around with APT."
5869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5870 #: sources.list.5.xml:189
5874 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5875 #: sources.list.5.xml:189
5879 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5880 #: sources.list.5.xml:191
5882 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
5883 "user and access the files. It is a good idea to do prior arrangements with "
5884 "RSA keys or rhosts. Access to files on the remote uses standard "
5885 "<command>find</command> and <command>dd</command> commands to perform the "
5886 "file transfers from the remote."
5889 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
5890 #: sources.list.5.xml:199
5891 msgid "more recognizable URI types"
5894 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5895 #: sources.list.5.xml:201
5897 "APT can be extended with more methods shipped in other optional packages "
5898 "which should follow the nameing scheme "
5899 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
5900 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
5901 "which provides access methods for https-URIs with features similar to the "
5902 "http method, but other methods for using e.g. debtorrent are also available, "
5903 "see <citerefentry> "
5904 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
5905 "<manvolnum>1</manvolnum></citerefentry>."
5908 #. type: Content of: <refentry><refsect1><para>
5909 #: sources.list.5.xml:143
5911 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
5912 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
5915 #. type: Content of: <refentry><refsect1><para>
5916 #: sources.list.5.xml:215
5918 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
5919 "stable/main, stable/contrib, and stable/non-free."
5922 #. type: Content of: <refentry><refsect1><literallayout>
5923 #: sources.list.5.xml:217
5925 msgid "deb file:/home/jason/debian stable main contrib non-free"
5928 #. type: Content of: <refentry><refsect1><para>
5929 #: sources.list.5.xml:219
5930 msgid "As above, except this uses the unstable (development) distribution."
5933 #. type: Content of: <refentry><refsect1><literallayout>
5934 #: sources.list.5.xml:220
5936 msgid "deb file:/home/jason/debian unstable main contrib non-free"
5939 #. type: Content of: <refentry><refsect1><para>
5940 #: sources.list.5.xml:222
5941 msgid "Source line for the above"
5944 #. type: Content of: <refentry><refsect1><literallayout>
5945 #: sources.list.5.xml:223
5947 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
5950 #. type: Content of: <refentry><refsect1><para>
5951 #: sources.list.5.xml:225
5953 "The first line gets package information for the architectures in "
5954 "<literal>APT::Architectures</literal> while the second always retrieves "
5955 "<literal>amd64</literal> and <literal>armel</literal>."
5958 #. type: Content of: <refentry><refsect1><literallayout>
5959 #: sources.list.5.xml:227
5962 "deb http://ftp.debian.org/debian &stable-codename; main\n"
5963 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
5966 #. type: Content of: <refentry><refsect1><para>
5967 #: sources.list.5.xml:230
5969 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
5973 #. type: Content of: <refentry><refsect1><literallayout>
5974 #: sources.list.5.xml:232
5976 msgid "deb http://archive.debian.org/debian-archive hamm main"
5979 #. type: Content of: <refentry><refsect1><para>
5980 #: sources.list.5.xml:234
5982 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5983 "directory, and uses only the &stable-codename;/contrib area."
5986 #. type: Content of: <refentry><refsect1><literallayout>
5987 #: sources.list.5.xml:236
5989 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
5992 #. type: Content of: <refentry><refsect1><para>
5993 #: sources.list.5.xml:238
5995 "Uses FTP to access the archive at ftp.debian.org, under the debian "
5996 "directory, and uses only the unstable/contrib area. If this line appears as "
5997 "well as the one in the previous example in <filename>sources.list</filename> "
5998 "a single FTP session will be used for both resource lines."
6001 #. type: Content of: <refentry><refsect1><literallayout>
6002 #: sources.list.5.xml:242
6004 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
6007 #. type: Content of: <refentry><refsect1><para><literallayout>
6008 #: sources.list.5.xml:251
6010 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
6013 #. type: Content of: <refentry><refsect1><para>
6014 #: sources.list.5.xml:244
6016 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
6017 "directory, and uses only files found under "
6018 "<filename>unstable/binary-i386</filename> on i386 machines, "
6019 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
6020 "supported architectures. [Note this example only illustrates how to use the "
6021 "substitution variable; official debian archives are not structured like "
6022 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
6025 #. type: Content of: <refentry><refsect1><para>
6026 #: sources.list.5.xml:256
6027 msgid "&apt-cache; &apt-conf;"
6030 #. type: <title></title>
6032 msgid "APT User's Guide"
6035 #. type: <author></author>
6036 #: guide.sgml:6 offline.sgml:6
6037 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
6040 #. type: <version></version>
6042 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
6045 #. type: <abstract></abstract>
6048 "This document provides an overview of how to use the the APT package "
6052 #. type: <copyrightsummary></copyrightsummary>
6054 msgid "Copyright © Jason Gunthorpe, 1998."
6058 #: guide.sgml:21 offline.sgml:22
6060 "\"APT\" and this document are free software; you can redistribute them "
6061 "and/or modify them under the terms of the GNU General Public License as "
6062 "published by the Free Software Foundation; either version 2 of the License, "
6063 "or (at your option) any later version."
6067 #: guide.sgml:24 offline.sgml:25
6069 "For more details, on Debian GNU/Linux systems, see the file "
6070 "/usr/share/common-licenses/GPL for the full license."
6073 #. type: <heading></heading>
6081 "The APT package currently contains two sections, the APT "
6082 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
6083 "interface. Both provide a way to install and remove packages as well as "
6084 "download new packages from the Internet."
6087 #. type: <heading></heading>
6089 msgid "Anatomy of the Package System"
6095 "The Debian packaging system has a large amount of information associated "
6096 "with each package to help assure that it integrates cleanly and easily into "
6097 "the system. The most prominent of its features is the dependency system."
6103 "The dependency system allows individual programs to make use of shared "
6104 "elements in the system such as libraries. It simplifies placing infrequently "
6105 "used portions of a program in separate packages to reduce the number of "
6106 "things the average user is required to install. Also, it allows for choices "
6107 "in mail transport agents, X servers and so on."
6113 "The first step to understanding the dependency system is to grasp the "
6114 "concept of a simple dependency. The meaning of a simple dependency is that a "
6115 "package requires another package to be installed at the same time to work "
6122 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
6123 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
6124 "simple dependency on GPG. Also, because it is an emacs extension it has a "
6125 "simple dependency on emacs, without emacs it is completely useless."
6131 "The other important dependency to understand is a conflicting dependency. It "
6132 "means that a package, when installed with another package, will not work and "
6133 "may possibly be extremely harmful to the system. As an example consider a "
6134 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
6135 "have two mail transport agents installed because both need to listen to the "
6136 "network to receive mail. Attempting to install two will seriously damage the "
6137 "system so all mail transport agents have a conflicting dependency with all "
6138 "other mail transport agents."
6144 "As an added complication there is the possibility for a package to pretend "
6145 "to be another package. Consider that exim and sendmail for many intents are "
6146 "identical, they both deliver mail and understand a common interface. Hence, "
6147 "the package system has a way for them to declare that they are both "
6148 "mail-transport-agents. So, exim and sendmail both declare that they provide "
6149 "a mail-transport-agent and other packages that need a mail transport agent "
6150 "depend on mail-transport-agent. This can add a great deal of confusion when "
6151 "trying to manually fix packages."
6157 "At any given time a single dependency may be met by packages that are "
6158 "already installed or it may not be. APT attempts to help resolve dependency "
6159 "issues by providing a number of automatic algorithms that help in selecting "
6160 "packages for installation."
6163 #. type: <heading></heading>
6171 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
6172 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
6173 "understand .deb files, it works with the package's proper name and can only "
6174 "install .deb archives from a <em>Source</em>."
6180 "The first <footnote><p>If you are using an http proxy server you must set "
6181 "the http_proxy environment variable first, see "
6182 "sources.list(5)</p></footnote> thing that should be done before using "
6183 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
6184 "so that it knows what packages are available. This is done with <tt>apt-get "
6185 "update</tt>. For instance,"
6188 #. type: <example></example>
6192 "# apt-get update\n"
6193 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
6194 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6195 "Reading Package Lists... Done\n"
6196 "Building Dependency Tree... Done"
6199 #. type: <p><taglist>
6201 msgid "Once updated there are several commands that can be used:"
6204 #. type: <tag></tag>
6212 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
6213 "install a new package or remove an existing package, nor will it ever "
6214 "upgrade a package that might cause some other package to break. This can be "
6215 "used daily to relatively safely upgrade the system. Upgrade will list all of "
6216 "the packages that it could not upgrade, this usually means that they depend "
6217 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
6218 "<tt>apt-get install</tt> can be used to force these packages to install."
6221 #. type: <tag></tag>
6229 "Install is used to install packages by name. The package is automatically "
6230 "fetched and installed. This can be useful if you already know the name of "
6231 "the package to install and do not want to go into a GUI to select it. Any "
6232 "number of packages may be passed to install, they will all be "
6233 "fetched. Install automatically attempts to resolve dependency problems with "
6234 "the listed packages and will print a summary and ask for confirmation if "
6235 "anything other than its arguments are changed."
6238 #. type: <tag></tag>
6240 msgid "dist-upgrade"
6246 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
6247 "releases of Debian. It uses a sophisticated algorithm to determine the best "
6248 "set of packages to install, upgrade and remove to get as much of the system "
6249 "to the newest release. In some situations it may be desired to use "
6250 "dist-upgrade rather than spend the time manually resolving dependencies in "
6251 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
6252 "<prgn>dselect</prgn> can be used to install any packages that may have been "
6259 "It is important to closely look at what dist-upgrade is going to do, its "
6260 "decisions may sometimes be quite surprising."
6266 "<prgn>apt-get</prgn> has several command line options that are detailed in "
6267 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
6268 "option is <tt>-d</tt> which does not install the fetched files. If the "
6269 "system has to download a large number of package it would be undesired to "
6270 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
6271 "the downloaded archives can be installed by simply running the command that "
6272 "caused them to be downloaded again without <tt>-d</tt>."
6275 #. type: <heading></heading>
6283 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
6284 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
6285 "to select the packages to be installed or removed and APT actually installs "
6292 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
6293 "and then choose the APT method. You will be prompted for a set of "
6294 "<em>Sources</em> which are places to fetch archives from. These can be "
6295 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
6296 "provide a fragment of the total Debian archive, APT will automatically "
6297 "combine them to form a complete set of packages. If you have a CDROM then it "
6298 "is a good idea to specify it first and then specify a mirror so that you "
6299 "have access to the latest bug fixes. APT will automatically use packages on "
6300 "your CDROM before downloading from the Internet."
6303 #. type: <example></example>
6307 " Set up a list of distribution source locations\n"
6309 " Please give the base URL of the debian distribution.\n"
6310 " The access schemes I know about are: http file\n"
6313 " file:/mnt/debian,\n"
6314 " ftp://ftp.debian.org/debian,\n"
6315 " http://ftp.de.debian.org/debian,\n"
6318 " URL [http://llug.sep.bnl.gov/debian]:"
6324 "The <em>Sources</em> setup starts by asking for the base of the Debian "
6325 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
6329 #. type: <example></example>
6333 " Please give the distribution tag to get or a path to the\n"
6334 " package file ending in a /. The distribution\n"
6335 " tags are typically something like: stable unstable testing non-US\n"
6337 " Distribution [stable]:"
6343 "The distribution refers to the Debian version in the archive, "
6344 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
6345 "refers to the developmental version. <em>non-US</em> is only available on "
6346 "some mirrors and refers to packages that contain encryption technology or "
6347 "other things that cannot be exported from the United States. Importing these "
6348 "packages into the US is legal however."
6351 #. type: <example></example>
6355 " Please give the components to get\n"
6356 " The components are typically something like: main contrib non-free\n"
6358 " Components [main contrib non-free]:"
6364 "The components list refers to the list of sub distributions to fetch. The "
6365 "distribution is split up based on software licenses, main being DFSG free "
6366 "packages while contrib and non-free contain things that have various "
6367 "restrictions placed on their use and distribution."
6373 "Any number of sources can be added, the setup script will continue to prompt "
6374 "until you have specified all that you want."
6380 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
6381 "available list by selecting [U]pdate from the menu. This is a superset of "
6382 "<tt>apt-get update</tt> that makes the fetched information available to "
6383 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
6384 "update</tt> has been run before."
6390 "You can then go on and make your selections using [S]elect and then perform "
6391 "the installation using [I]nstall. When using the APT method the [C]onfig and "
6392 "[R]emove commands have no meaning, the [I]nstall command performs both of "
6399 "By default APT will automatically remove the package (.deb) files once they "
6400 "have been successfully installed. To change this behavior place "
6401 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
6404 #. type: <heading></heading>
6406 msgid "The Interface"
6412 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
6413 "same interface. It is a simple system that generally tells you what it will "
6414 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
6415 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
6416 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
6417 "alone.</p></footnote> After printing out a summary of what will happen APT "
6418 "then will print out some informative status messages so that you can "
6419 "estimate how far along it is and how much is left to do."
6422 #. type: <heading></heading>
6430 "Before all operations except update, APT performs a number of actions to "
6431 "prepare its internal state. It also does some checks of the system's "
6432 "state. At any time these operations can be performed by running <tt>apt-get "
6436 #. type: <example></example>
6441 "Reading Package Lists... Done\n"
6442 "Building Dependency Tree... Done"
6448 "The first thing it does is read all the package files into memory. APT uses "
6449 "a caching scheme so this operation will be faster the second time it is "
6450 "run. If some of the package files are not found then they will be ignored "
6451 "and a warning will be printed when apt-get exits."
6457 "The final operation performs a detailed analysis of the system's "
6458 "dependencies. It checks every dependency of every installed or unpacked "
6459 "package and considers if it is OK. Should this find a problem then a report "
6460 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
6463 #. type: <example></example>
6468 "Reading Package Lists... Done\n"
6469 "Building Dependency Tree... Done\n"
6470 "You might want to run apt-get -f install' to correct these.\n"
6471 "Sorry, but the following packages have unmet dependencies:\n"
6472 " 9fonts: Depends: xlib6g but it is not installed\n"
6473 " uucp: Depends: mailx but it is not installed\n"
6474 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6475 " adduser: Depends: perl-base but it is not installed\n"
6476 " aumix: Depends: libgpmg1 but it is not installed\n"
6477 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
6478 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
6479 " cthugha: Depends: svgalibg1 but it is not installed\n"
6480 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
6481 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
6487 "In this example the system has many problems, including a serious problem "
6488 "with libreadlineg2. For each package that has unmet dependencies a line is "
6489 "printed out indicating the package with the problem and the dependencies "
6490 "that are unmet. A short explanation of why the package has a dependency "
6491 "problem is also included."
6497 "There are two ways a system can get into a broken state like this. The first "
6498 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
6499 "packages when performing upgrades. <footnote><p>APT however considers all "
6500 "known dependencies and attempts to prevent broken "
6501 "packages</p></footnote>. The second is if a package installation fails "
6502 "during an operation. In this situation a package may have been unpacked "
6503 "without its dependents being installed."
6509 "The second situation is much less serious than the first because APT places "
6510 "certain constraints on the order that packages are installed. In both cases "
6511 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
6512 "deduce a possible solution to the problem and then continue on. The APT "
6513 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
6514 "for easy continuation of failed maintainer scripts."
6520 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
6521 "system caused by the first case then it is possible that it will either fail "
6522 "immediately or the installation sequence will fail. In either case it is "
6523 "necessary to manually use dpkg (possibly with forcing options) to correct "
6524 "the situation enough to allow APT to proceed."
6527 #. type: <heading></heading>
6529 msgid "The Status Report"
6535 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
6536 "happen. Generally the report reflects the type of operation being performed "
6537 "but there are several common elements. In all cases the lists reflect the "
6538 "final state of things, taking into account the <tt>-f</tt> option and any "
6539 "other relevant activities to the command being executed."
6542 #. type: <heading></heading>
6544 msgid "The Extra Package list"
6547 #. type: <example></example>
6551 "The following extra packages will be installed:\n"
6552 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
6553 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
6554 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
6555 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
6562 "The Extra Package list shows all of the packages that will be installed or "
6563 "upgraded in excess of the ones mentioned on the command line. It is only "
6564 "generated for an <tt>install</tt> command. The listed packages are often the "
6565 "result of an Auto Install."
6568 #. type: <heading></heading>
6570 msgid "The Packages to Remove"
6573 #. type: <example></example>
6577 "The following packages will be REMOVED:\n"
6578 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
6579 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
6580 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
6587 "The Packages to Remove list shows all of the packages that will be removed "
6588 "from the system. It can be shown for any of the operations and should be "
6589 "given a careful inspection to ensure nothing important is to be taken "
6590 "off. The <tt>-f</tt> option is especially good at generating packages to "
6591 "remove so extreme care should be used in that case. The list may contain "
6592 "packages that are going to be removed because they are only partially "
6593 "installed, possibly due to an aborted installation."
6596 #. type: <heading></heading>
6598 msgid "The New Packages list"
6601 #. type: <example></example>
6605 "The following NEW packages will installed:\n"
6606 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
6612 "The New Packages list is simply a reminder of what will happen. The packages "
6613 "listed are not presently installed in the system but will be when APT is "
6617 #. type: <heading></heading>
6619 msgid "The Kept Back list"
6622 #. type: <example></example>
6626 "The following packages have been kept back\n"
6627 " compface man-db tetex-base msql libpaper svgalib1\n"
6628 " gs snmp arena lynx xpat2 groff xscreensaver"
6634 "Whenever the whole system is being upgraded there is the possibility that "
6635 "new versions of packages cannot be installed because they require new things "
6636 "or conflict with already installed things. In this case the package will "
6637 "appear in the Kept Back list. The best way to convince packages listed there "
6638 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
6639 "to resolve their problems."
6642 #. type: <heading></heading>
6644 msgid "Held Packages warning"
6647 #. type: <example></example>
6651 "The following held packages will be changed:\n"
6658 "Sometimes you can ask APT to install a package that is on hold, in such a "
6659 "case it prints out a warning that the held package is going to be "
6660 "changed. This should only happen during dist-upgrade or install."
6663 #. type: <heading></heading>
6665 msgid "Final summary"
6670 msgid "Finally, APT will print out a summary of all the changes that will occur."
6673 #. type: <example></example>
6677 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
6679 "12 packages not fully installed or removed.\n"
6680 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
6686 "The first line of the summary simply is a reduced version of all of the "
6687 "lists and includes the number of upgrades - that is packages already "
6688 "installed that have new versions available. The second line indicates the "
6689 "number of poorly configured packages, possibly the result of an aborted "
6690 "installation. The final line shows the space requirements that the "
6691 "installation needs. The first pair of numbers refer to the size of the "
6692 "archive files. The first number indicates the number of bytes that must be "
6693 "fetched from remote locations and the second indicates the total size of all "
6694 "the archives required. The next number indicates the size difference between "
6695 "the presently installed packages and the newly installed packages. It is "
6696 "roughly equivalent to the space required in /usr after everything is "
6697 "done. If a large number of packages are being removed then the value may "
6698 "indicate the amount of space that will be freed."
6704 "Some other reports can be generated by using the -u option to show packages "
6705 "to upgrade, they are similar to the previous examples."
6708 #. type: <heading></heading>
6710 msgid "The Status Display"
6716 "During the download of archives and package files APT prints out a series of "
6720 #. type: <example></example>
6724 "# apt-get update\n"
6725 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
6726 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
6727 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
6728 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
6730 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
6731 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
6737 "The lines starting with <em>Get</em> are printed out when APT begins to "
6738 "fetch a file while the last line indicates the progress of the download. The "
6739 "first percent value on the progress line indicates the total percent done of "
6740 "all files. Unfortunately since the size of the Package files is unknown "
6741 "<tt>apt-get update</tt> estimates the percent done which causes some "
6748 "The next section of the status line is repeated once for each download "
6749 "thread and indicates the operation being performed and some useful "
6750 "information about what is happening. Sometimes this section will simply read "
6751 "<em>Forking</em> which means the OS is loading the download module. The "
6752 "first word after the [ is the fetch number as shown on the history "
6753 "lines. The next word is the short form name of the object being "
6754 "downloaded. For archives it will contain the name of the package that is "
6761 "Inside of the single quote is an informative string indicating the progress "
6762 "of the negotiation phase of the download. Typically it progresses from "
6763 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
6764 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
6765 "the remote site. Once the download begins this is represented as "
6766 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
6767 "kilobytes is expected. The total size is always shown in 4 figure notation "
6768 "to preserve space. After the size display is a percent meter for the file "
6769 "itself. The second last element is the instantaneous average speed. This "
6770 "values is updated every 5 seconds and reflects the rate of data transfer for "
6771 "that period. Finally is shown the estimated transfer time. This is updated "
6772 "regularly and reflects the time to complete everything at the shown transfer "
6779 "The status display updates every half second to provide a constant feedback "
6780 "on the download progress while the Get lines scroll back whenever a new file "
6781 "is started. Since the status display is constantly updated it is unsuitable "
6782 "for logging to a file, use the <tt>-q</tt> option to remove the status "
6786 #. type: <heading></heading>
6794 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
6795 "to the <prgn>dpkg</prgn> interface once downloading is "
6796 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
6797 "processes the packages and the packages themselves may also ask several "
6798 "questions. Before each question there is usually a description of what it is "
6799 "asking and the questions are too varied to discuss completely here."
6802 #. type: <title></title>
6804 msgid "Using APT Offline"
6807 #. type: <version></version>
6809 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
6812 #. type: <abstract></abstract>
6815 "This document describes how to use APT in a non-networked environment, "
6816 "specifically a 'sneaker-net' approach for performing upgrades."
6819 #. type: <copyrightsummary></copyrightsummary>
6821 msgid "Copyright © Jason Gunthorpe, 1999."
6824 #. type: <heading></heading>
6826 msgid "Introduction"
6829 #. type: <heading></heading>
6830 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
6837 "Normally APT requires direct access to a Debian archive, either from a local "
6838 "media or through a network. Another common complaint is that a Debian "
6839 "machine is on a slow link, such as a modem and another machine has a very "
6840 "fast connection but they are physically distant."
6846 "The solution to this is to use large removable media such as a Zip disc or a "
6847 "SuperDisk disc. These discs are not large enough to store the entire Debian "
6848 "archive but can easily fit a subset large enough for most users. The idea is "
6849 "to use APT to generate a list of packages that are required and then fetch "
6850 "them onto the disc using another machine with good connectivity. It is even "
6851 "possible to use another Debian machine with APT or to use a completely "
6852 "different OS and a download tool like wget. Let <em>remote host</em> mean "
6853 "the machine downloading the packages, and <em>target host</em> the one with "
6854 "bad or no connection."
6860 "This is achieved by creatively manipulating the APT configuration file. The "
6861 "essential premise to tell APT to look on a disc for it's archive files. Note "
6862 "that the disc should be formated with a filesystem that can handle long file "
6863 "names such as ext2, fat32 or vfat."
6866 #. type: <heading></heading>
6868 msgid "Using APT on both machines"
6871 #. type: <p><example>
6874 "APT being available on both machines gives the simplest configuration. The "
6875 "basic idea is to place a copy of the status file on the disc and use the "
6876 "remote machine to fetch the latest package files and decide which packages "
6877 "to download. The disk directory structure should look like:"
6880 #. type: <example></example>
6894 #. type: <heading></heading>
6896 msgid "The configuration file"
6902 "The configuration file should tell APT to store its files on the disc and to "
6903 "use the configuration files on the disc as well. The sources.list should "
6904 "contain the proper sites that you wish to use from the remote machine, and "
6905 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
6906 "<em>target host</em>. Please note, if you are using a local archive you must "
6907 "use copy URIs, the syntax is identical to file URIs."
6910 #. type: <p><example>
6913 "<em>apt.conf</em> must contain the necessary information to make APT use the "
6917 #. type: <example></example>
6923 " /* This is not necessary if the two machines are the same arch, it "
6925 " the remote APT what architecture the target machine is */\n"
6926 " Architecture \"i386\";\n"
6928 " Get::Download-Only \"true\";\n"
6933 " /* Use the disc for state information and redirect the status file from\n"
6934 " the /var/lib/dpkg default */\n"
6935 " State \"/disc/\";\n"
6936 " State::status \"status\";\n"
6938 " // Binary caches will be stored locally\n"
6939 " Cache::archives \"/disc/archives/\";\n"
6940 " Cache \"/tmp/\";\n"
6942 " // Location of the source list.\n"
6943 " Etc \"/disc/\";\n"
6947 #. type: </example></p>
6950 "More details can be seen by examining the apt.conf man page and the sample "
6951 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
6954 #. type: <p><example>
6957 "On the target machine the first thing to do is mount the disc and copy "
6958 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
6959 "directories outlined in the Overview, <em>archives/partial/</em> and "
6960 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
6961 "configure the sources.list. On the remote machine execute the following:"
6964 #. type: <example></example>
6968 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6969 " # apt-get update\n"
6970 " [ APT fetches the package files ]\n"
6971 " # apt-get dist-upgrade\n"
6972 " [ APT fetches all the packages needed to upgrade the target machine ]"
6975 #. type: </example></p>
6978 "The dist-upgrade command can be replaced with any other standard APT "
6979 "commands, particularly dselect-upgrade. You can even use an APT front end "
6980 "such as <em>dselect</em>. However this presents a problem in communicating "
6981 "your selections back to the local computer."
6984 #. type: <p><example>
6987 "Now the disc contains all of the index files and archives needed to upgrade "
6988 "the target machine. Take the disc back and run:"
6991 #. type: <example></example>
6995 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
6996 " # apt-get check\n"
6997 " [ APT generates a local copy of the cache files ]\n"
6998 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
6999 " [ Or any other APT command ]"
7005 "It is necessary for proper function to re-specify the status file to be the "
7006 "local one. This is very important!"
7012 "If you are using dselect you can do the very risky operation of copying "
7013 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
7014 "remote machine are updated. I highly recommend that people only make "
7015 "selections on the local machine - but this may not always be possible. DO "
7016 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
7019 #. type: <heading></heading>
7021 msgid "Using APT and wget"
7027 "<em>wget</em> is a popular and portable download tool that can run on nearly "
7028 "any machine. Unlike the method above this requires that the Debian machine "
7029 "already has a list of available packages."
7035 "The basic idea is to create a disc that has only the archive files "
7036 "downloaded from the remote site. This is done by using the --print-uris "
7037 "option to apt-get and then preparing a wget script to actually fetch the "
7041 #. type: <heading></heading>
7046 #. type: <p><example>
7049 "Unlike the previous technique no special configuration files are "
7050 "required. We merely use the standard APT commands to generate the file list."
7053 #. type: <example></example>
7057 " # apt-get dist-upgrade \n"
7058 " [ Press no when prompted, make sure you are happy with the actions ]\n"
7059 " # apt-get -qq --print-uris dist-upgrade > uris\n"
7060 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
7063 #. type: </example></p>
7066 "Any command other than dist-upgrade could be used here, including "
7073 "The /disc/wget-script file will now contain a list of wget commands to "
7074 "execute in order to fetch the necessary archives. This script should be run "
7075 "with the current directory as the disc's mount point so as to save the "
7076 "output on the disc."
7079 #. type: <p><example>
7081 msgid "The remote machine would do something like"
7084 #. type: <example></example>
7089 " # sh -x ./wget-script\n"
7093 #. type: </example><example>
7096 "Once the archives are downloaded and the disc returned to the Debian machine "
7097 "installation can proceed using,"
7100 #. type: <example></example>
7103 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
7106 #. type: </example></p>
7108 msgid "Which will use the already fetched archives on the disc."