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-04-20 14:20+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> (implicit "
335 "partial). </para></listitem>\n"
344 "<!ENTITY file-preferences \"\n"
345 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
346 " <listitem><para>Version preferences file.\n"
347 " This is where you would specify "pinning",\n"
348 " i.e. a preference to get certain packages\n"
349 " from a separate source\n"
350 " or from a different version of a distribution.\n"
351 " Configuration Item: "
352 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
361 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
362 " <listitem><para>File fragments for the version preferences.\n"
363 " Configuration Item: "
364 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
373 "<!ENTITY file-sourceslist \"\n"
374 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
375 " <listitem><para>Locations to fetch packages from.\n"
376 " Configuration Item: "
377 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
386 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
387 " <listitem><para>File fragments for locations to fetch packages from.\n"
388 " Configuration Item: "
389 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
398 "<!ENTITY file-statelists \"\n"
399 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
400 " <listitem><para>Storage area for state information for each package "
401 "resource specified in\n"
403 " Configuration Item: "
404 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
413 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
414 " <listitem><para>Storage area for state information in transit.\n"
415 " Configuration Item: <literal>Dir::State::Lists</literal> (implicit "
416 "partial).</para></listitem>\n"
425 "<!ENTITY file-trustedgpg \"\n"
426 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
427 " <listitem><para>Keyring of local trusted keys, new keys will be added "
429 " Configuration Item: "
430 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
439 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
440 " <listitem><para>File fragments for the trusted keys, additional "
442 " be stored here (by other packages or the administrator).\n"
443 " Configuration Item "
444 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
453 "<!ENTITY file-extended_states \"\n"
455 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
456 " <listitem><para>Status list of auto-installed packages.\n"
457 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
458 " </para></listitem>\n"
467 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
469 " to the other headers like NAME and DESCRIPTION and should therefore be "
471 "<!ENTITY translation-title \"TRANSLATION\">\n"
478 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
480 " to the translation in the past, who is responsible now and maybe "
481 "further information\n"
482 " specially related to your translation. -->\n"
483 "<!ENTITY translation-holder \"\n"
484 " The english translation was done by John Doe "
485 "<email>john@doe.org</email> in 2009,\n"
486 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
488 " Debian Dummy l10n Team "
489 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
497 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
498 "untranslated/fuzzy strings\n"
499 " in a shipped manpage newer/modified paragraphs will maybe appear in "
501 " the generated manpage. This sentence is therefore here to tell the "
503 " is not a mistake by the translator - obviously the target is that at "
505 " releases this sentence is not needed. :) -->\n"
506 "<!ENTITY translation-english \"\n"
507 " Note that this translated document may contain untranslated parts.\n"
508 " This is done on purpose, to avoid losing content when the\n"
509 " translation is lagging behind the original content.\n"
516 "<!-- TRANSLATOR: used as in -o=config_string "
517 "e.g. -o=Debug::pkgProblemResolver=1 --> <!ENTITY synopsis-config-string "
524 "<!-- TRANSLATOR: used as in -c=config_file e.g. -c=./apt.conf --> <!ENTITY "
525 "synopsis-config-file \"config_file\">"
531 "<!-- TRANSLATOR: used as in -t=target_release or pkg/target_release "
532 "e.g. -t=squeeze apt/experimental --> <!ENTITY synopsis-target-release "
533 "\"target_release\">"
539 "<!-- TRANSLATOR: used as in -a=architecture e.g. -a=armel --> <!ENTITY "
540 "synopsis-architecture \"architecture\">"
546 "<!-- TRANSLATOR: used as in apt-get install pkg e.g. apt-get install awesome "
547 "--> <!ENTITY synopsis-pkg \"pkg\">"
553 "<!-- TRANSLATOR: used as in pkg=pkg_version_number e.g. apt=0.8.15 --> "
554 "<!ENTITY synopsis-pkg-ver-number \"pkg_version_number\">"
560 "<!-- TRANSLATOR: used as in apt-cache pkgnames prefix e.g. apt-cache "
561 "pkgnames apt --> <!ENTITY synopsis-prefix \"prefix\">"
567 "<!-- TRANSLATOR: used as in apt-cache search regex e.g. apt-cache search "
568 "awesome --> <!ENTITY synopsis-regex \"regex\">"
574 "<!-- TRANSLATOR: used as in apt-cdrom -d=cdrom_mount_point e.g. apt-cdrom "
575 "-d=/media/cdrom --> <!ENTITY synopsis-cdrom-mount \"cdrom_mount_point\">"
581 "<!-- TRANSLATOR: used as in apt-extracttemplates -t=temporary_directory "
582 "e.g. apt-extracttemplates -t=/tmp --> <!ENTITY synopsis-tmp-directory "
583 "\"temporary_directory\">"
589 "<!-- TRANSLATOR: used as in apt-extracttemplates filename --> <!ENTITY "
590 "synopsis-filename \"filename\">"
596 "<!-- TRANSLATOR: used as parameters for apt-ftparchive e.g. apt-ftparchive "
597 "packages path override pathprefix --> <!ENTITY synopsis-path \"path\"> "
598 "<!ENTITY synopsis-pathprefix \"pathprefix\"> <!ENTITY synopsis-section "
599 "\"section\"> <!ENTITY synopsis-override \"override\">"
605 "<!-- TRANSLATOR: used as in apt-key export keyid e.g. apt-key export "
606 "473041FA --> <!ENTITY synopsis-keyid \"keyid\">"
609 #. The last update date
610 #. type: Content of: <refentry><refentryinfo>
611 #: apt-cache.8.xml:16
613 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>04 "
614 "February 2011</date>"
617 #. type: Content of: <refentry><refnamediv><refname>
618 #: apt-cache.8.xml:25 apt-cache.8.xml:32
622 #. type: Content of: <refentry><refmeta><manvolnum>
623 #: 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
627 #. type: Content of: <refentry><refmeta><refmiscinfo>
628 #: 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
632 #. type: Content of: <refentry><refnamediv><refpurpose>
633 #: apt-cache.8.xml:33
634 msgid "query the APT cache"
637 #. type: Content of: <refentry><refsect1><title>
638 #: 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
642 #. type: Content of: <refentry><refsect1><para>
643 #: apt-cache.8.xml:39
645 "<command>apt-cache</command> performs a variety of operations on APT's "
646 "package cache. <command>apt-cache</command> does not manipulate the state of "
647 "the system but does provide operations to search and generate interesting "
648 "output from the package metadata."
651 #. type: Content of: <refentry><refsect1><para>
652 #: apt-cache.8.xml:44 apt-get.8.xml:44
654 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
655 "one of the commands below must be present."
658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
659 #: apt-cache.8.xml:48
663 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
664 #: apt-cache.8.xml:49
666 "<literal>gencaches</literal> performs the same operation as <command>apt-get "
667 "check</command>. It builds the source and package caches from the sources in "
668 "&sources-list; and from <filename>/var/lib/dpkg/status</filename>."
671 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
672 #: apt-cache.8.xml:55
673 msgid "showpkg <replaceable>pkg(s)</replaceable>"
676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
677 #: apt-cache.8.xml:56
679 "<literal>showpkg</literal> displays information about the packages listed on "
680 "the command line. Remaining arguments are package names. The available "
681 "versions and reverse dependencies of each package listed are listed, as well "
682 "as forward dependencies for each version. Forward (normal) dependencies are "
683 "those packages upon which the package in question depends; reverse "
684 "dependencies are those packages that depend upon the package in "
685 "question. Thus, forward dependencies must be satisfied for a package, but "
686 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
687 "libreadline2</command> would produce output similar to the following:"
690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
691 #: apt-cache.8.xml:68
694 "Package: libreadline2\n"
695 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
696 "Reverse Depends: \n"
697 " libreadlineg2,libreadline2\n"
698 " libreadline2-altdev,libreadline2\n"
700 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
703 "Reverse Provides: \n"
706 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
707 #: apt-cache.8.xml:80
709 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
710 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
711 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
712 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
713 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
714 "installed. For the specific meaning of the remainder of the output it is "
715 "best to consult the apt source code."
718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
719 #: apt-cache.8.xml:89
723 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
724 #: apt-cache.8.xml:89
726 "<literal>stats</literal> displays some statistics about the cache. No "
727 "further arguments are expected. Statistics reported are:"
730 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
731 #: apt-cache.8.xml:92
733 "<literal>Total package names</literal> is the number of package names found "
737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
738 #: apt-cache.8.xml:96
740 "<literal>Normal packages</literal> is the number of regular, ordinary "
741 "package names; these are packages that bear a one-to-one correspondence "
742 "between their names and the names used by other packages for them in "
743 "dependencies. The majority of packages fall into this category."
746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
747 #: apt-cache.8.xml:102
749 "<literal>Pure virtual packages</literal> is the number of packages that "
750 "exist only as a virtual package name; that is, packages only \"provide\" the "
751 "virtual package name, and no package actually uses the name. For instance, "
752 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
753 "package; several packages provide \"mail-transport-agent\", but there is no "
754 "package named \"mail-transport-agent\"."
757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
758 #: apt-cache.8.xml:110
760 "<literal>Single virtual packages</literal> is the number of packages with "
761 "only one package providing a particular virtual package. For example, in the "
762 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
763 "one package, xless, provides \"X11-text-viewer\"."
766 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
767 #: apt-cache.8.xml:116
769 "<literal>Mixed virtual packages</literal> is the number of packages that "
770 "either provide a particular virtual package or have the virtual package name "
771 "as the package name. For instance, in the Debian GNU/Linux system, "
772 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
777 #: apt-cache.8.xml:123
779 "<literal>Missing</literal> is the number of package names that were "
780 "referenced in a dependency but were not provided by any package. Missing "
781 "packages may be an evidence if a full distribution is not accessed, or if a "
782 "package (real or virtual) has been dropped from the distribution. Usually "
783 "they are referenced from Conflicts or Breaks statements."
786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
787 #: apt-cache.8.xml:130
789 "<literal>Total distinct</literal> versions is the number of package versions "
790 "found in the cache; this value is therefore at least equal to the number of "
791 "total package names. If more than one distribution (both \"stable\" and "
792 "\"unstable\", for instance), is being accessed, this value can be "
793 "considerably larger than the number of total package names."
796 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
797 #: apt-cache.8.xml:137
799 "<literal>Total dependencies</literal> is the number of dependency "
800 "relationships claimed by all of the packages in the cache."
803 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
804 #: apt-cache.8.xml:144
805 msgid "showsrc <replaceable>pkg(s)</replaceable>"
808 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
809 #: apt-cache.8.xml:145
811 "<literal>showsrc</literal> displays all the source package records that "
812 "match the given package names. All versions are shown, as well as all "
813 "records that declare the name to be a Binary."
816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
817 #: apt-cache.8.xml:150 apt-config.8.xml:75
821 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
822 #: apt-cache.8.xml:151
824 "<literal>dump</literal> shows a short listing of every package in the "
825 "cache. It is primarily for debugging."
828 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
829 #: apt-cache.8.xml:155
833 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
834 #: apt-cache.8.xml:156
836 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
837 "suitable for use with &dpkg; and is used by the &dselect; method."
840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
841 #: apt-cache.8.xml:160
845 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
846 #: apt-cache.8.xml:161
848 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
853 #: apt-cache.8.xml:165
854 msgid "show <replaceable>pkg(s)</replaceable>"
857 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
858 #: apt-cache.8.xml:166
860 "<literal>show</literal> performs a function similar to <command>dpkg "
861 "--print-avail</command>; it displays the package records for the named "
865 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
866 #: apt-cache.8.xml:171
867 msgid "search <replaceable>regex [ regex ... ]</replaceable>"
870 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
871 #: apt-cache.8.xml:172
873 "<literal>search</literal> performs a full text search on all available "
874 "package lists for the POSIX regex pattern given, see "
875 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
876 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
877 "the descriptions for an occurrence of the regular expression and prints out "
878 "the package name and the short description, including virtual package "
879 "names. If <option>--full</option> is given then output identical to "
880 "<literal>show</literal> is produced for each matched package, and if "
881 "<option>--names-only</option> is given then the long description is not "
882 "searched, only the package name is."
885 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
886 #: apt-cache.8.xml:185
888 "Separate arguments can be used to specify multiple search patterns that are "
892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
893 #: apt-cache.8.xml:189
894 msgid "depends <replaceable>pkg(s)</replaceable>"
897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
898 #: apt-cache.8.xml:190
900 "<literal>depends</literal> shows a listing of each dependency a package has "
901 "and all the possible other packages that can fulfill that dependency."
904 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
905 #: apt-cache.8.xml:194
906 msgid "rdepends <replaceable>pkg(s)</replaceable>"
909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
910 #: apt-cache.8.xml:195
912 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
916 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
917 #: apt-cache.8.xml:199
918 msgid "pkgnames <replaceable>[ prefix ]</replaceable>"
921 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
922 #: apt-cache.8.xml:200
924 "This command prints the name of each package APT knows. The optional "
925 "argument is a prefix match to filter the name list. The output is suitable "
926 "for use in a shell tab complete function and the output is generated "
927 "extremely quickly. This command is best used with the "
928 "<option>--generate</option> option."
931 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
932 #: apt-cache.8.xml:205
934 "Note that a package which APT knows of is not necessarily available to "
935 "download, installable or installed, e.g. virtual packages are also listed in "
936 "the generated list."
939 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
940 #: apt-cache.8.xml:210
941 msgid "dotty <replaceable>pkg(s)</replaceable>"
944 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
945 #: apt-cache.8.xml:211
947 "<literal>dotty</literal> takes a list of packages on the command line and "
948 "generates output suitable for use by dotty from the <ulink "
949 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
950 "package. The result will be a set of nodes and edges representing the "
951 "relationships between the packages. By default the given packages will trace "
952 "out all dependent packages; this can produce a very large graph. To limit "
953 "the output to only the packages listed on the command line, set the "
954 "<literal>APT::Cache::GivenOnly</literal> option."
957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
958 #: apt-cache.8.xml:220
960 "The resulting nodes will have several shapes; normal packages are boxes, "
961 "pure provides are triangles, mixed provides are diamonds, missing packages "
962 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
963 "lines are pre-depends, green lines are conflicts."
966 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
967 #: apt-cache.8.xml:225
968 msgid "Caution, dotty cannot graph larger sets of packages."
971 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
972 #: apt-cache.8.xml:228
973 msgid "xvcg <replaceable>pkg(s)</replaceable>"
976 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
977 #: apt-cache.8.xml:229
979 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
980 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
984 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
985 #: apt-cache.8.xml:233
986 msgid "policy <replaceable>[ pkg(s) ]</replaceable>"
989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
990 #: apt-cache.8.xml:234
992 "<literal>policy</literal> is meant to help debug issues relating to the "
993 "preferences file. With no arguments it will print out the priorities of each "
994 "source. Otherwise it prints out detailed information about the priority "
995 "selection of the named package."
998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
999 #: apt-cache.8.xml:240
1000 msgid "madison <replaceable>[ pkg(s) ]</replaceable>"
1003 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1004 #: apt-cache.8.xml:241
1006 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
1007 "to mimic the output format and a subset of the functionality of the Debian "
1008 "archive management tool, <literal>madison</literal>. It displays available "
1009 "versions of a package in a tabular format. Unlike the original "
1010 "<literal>madison</literal>, it can only display information for the "
1011 "architecture for which APT has retrieved package lists "
1012 "(<literal>APT::Architecture</literal>)."
1015 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1016 #: apt-cache.8.xml:252 apt-config.8.xml:84 apt-extracttemplates.1.xml:51 apt-ftparchive.1.xml:504 apt-get.8.xml:259 apt-mark.8.xml:108 apt-sortpkgs.1.xml:48 apt.conf.5.xml:577 apt.conf.5.xml:599
1020 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1021 #: apt-cache.8.xml:256
1022 msgid "<option>-p</option>"
1025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1026 #: apt-cache.8.xml:256
1027 msgid "<option>--pkg-cache</option>"
1030 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1031 #: apt-cache.8.xml:257
1033 "Select the file to store the package cache. The package cache is the primary "
1034 "cache used by all operations. Configuration Item: "
1035 "<literal>Dir::Cache::pkgcache</literal>."
1038 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1039 #: apt-cache.8.xml:262 apt-ftparchive.1.xml:551 apt-get.8.xml:321 apt-sortpkgs.1.xml:52
1040 msgid "<option>-s</option>"
1043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1044 #: apt-cache.8.xml:262
1045 msgid "<option>--src-cache</option>"
1048 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1049 #: apt-cache.8.xml:263
1051 "Select the file to store the source cache. The source is used only by "
1052 "<literal>gencaches</literal> and it stores a parsed version of the package "
1053 "information from remote sources. When building the package cache the source "
1054 "cache is used to avoid reparsing all of the package files. Configuration "
1055 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
1058 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1059 #: apt-cache.8.xml:270 apt-ftparchive.1.xml:525 apt-get.8.xml:311
1060 msgid "<option>-q</option>"
1063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1064 #: apt-cache.8.xml:270 apt-ftparchive.1.xml:525 apt-get.8.xml:311
1065 msgid "<option>--quiet</option>"
1068 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1069 #: apt-cache.8.xml:271
1071 "Quiet; produces output suitable for logging, omitting progress indicators. "
1072 "More q's will produce more quietness up to a maximum of 2. You can also use "
1073 "<option>-q=#</option> to set the quietness level, overriding the "
1074 "configuration file. Configuration Item: <literal>quiet</literal>."
1077 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1078 #: apt-cache.8.xml:277
1079 msgid "<option>-i</option>"
1082 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1083 #: apt-cache.8.xml:277
1084 msgid "<option>--important</option>"
1087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1088 #: apt-cache.8.xml:278
1090 "Print only important dependencies; for use with unmet and depends. Causes "
1091 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
1092 "<literal>APT::Cache::Important</literal>."
1095 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1096 #: apt-cache.8.xml:283
1097 msgid "<option>--no-pre-depends</option>"
1100 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1101 #: apt-cache.8.xml:284
1102 msgid "<option>--no-depends</option>"
1105 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1106 #: apt-cache.8.xml:285
1107 msgid "<option>--no-recommends</option>"
1110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1111 #: apt-cache.8.xml:286
1112 msgid "<option>--no-suggests</option>"
1115 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1116 #: apt-cache.8.xml:287
1117 msgid "<option>--no-conflicts</option>"
1120 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1121 #: apt-cache.8.xml:288
1122 msgid "<option>--no-breaks</option>"
1125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1126 #: apt-cache.8.xml:289
1127 msgid "<option>--no-replaces</option>"
1130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1131 #: apt-cache.8.xml:290
1132 msgid "<option>--no-enhances</option>"
1135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1136 #: apt-cache.8.xml:291
1138 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1139 "print all dependencies. This can be tweaked with these flags which will omit "
1140 "the specified dependency type. Configuration Item: "
1141 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1142 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1146 #: apt-cache.8.xml:297 apt-cdrom.8.xml:111 apt-get.8.xml:278
1147 msgid "<option>-f</option>"
1150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1151 #: apt-cache.8.xml:297
1152 msgid "<option>--full</option>"
1155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1156 #: apt-cache.8.xml:298
1158 "Print full package records when searching. Configuration Item: "
1159 "<literal>APT::Cache::ShowFull</literal>."
1162 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1163 #: apt-cache.8.xml:302 apt-cdrom.8.xml:121 apt-ftparchive.1.xml:563 apt-get.8.xml:369
1164 msgid "<option>-a</option>"
1167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1168 #: apt-cache.8.xml:302
1169 msgid "<option>--all-versions</option>"
1172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1173 #: apt-cache.8.xml:303
1175 "Print full records for all available versions. This is the default; to turn "
1176 "it off, use <option>--no-all-versions</option>. If "
1177 "<option>--no-all-versions</option> is specified, only the candidate version "
1178 "will displayed (the one which would be selected for installation). This "
1179 "option is only applicable to the <literal>show</literal> command. "
1180 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1183 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1184 #: apt-cache.8.xml:311
1185 msgid "<option>-g</option>"
1188 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1189 #: apt-cache.8.xml:311
1190 msgid "<option>--generate</option>"
1193 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1194 #: apt-cache.8.xml:312
1196 "Perform automatic package cache regeneration, rather than use the cache as "
1197 "it is. This is the default; to turn it off, use "
1198 "<option>--no-generate</option>. Configuration Item: "
1199 "<literal>APT::Cache::Generate</literal>."
1202 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1203 #: apt-cache.8.xml:317
1204 msgid "<option>--names-only</option>"
1207 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1208 #: apt-cache.8.xml:317 apt-cdrom.8.xml:129
1209 msgid "<option>-n</option>"
1212 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1213 #: apt-cache.8.xml:318
1215 "Only search on the package names, not the long descriptions. Configuration "
1216 "Item: <literal>APT::Cache::NamesOnly</literal>."
1219 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1220 #: apt-cache.8.xml:322
1221 msgid "<option>--all-names</option>"
1224 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1225 #: apt-cache.8.xml:323
1227 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1228 "and missing dependencies. Configuration Item: "
1229 "<literal>APT::Cache::AllNames</literal>."
1232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1233 #: apt-cache.8.xml:328
1234 msgid "<option>--recurse</option>"
1237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1238 #: apt-cache.8.xml:329
1240 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1241 "that all packages mentioned are printed once. Configuration Item: "
1242 "<literal>APT::Cache::RecurseDepends</literal>."
1245 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1246 #: apt-cache.8.xml:334
1247 msgid "<option>--installed</option>"
1250 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1251 #: apt-cache.8.xml:336
1253 "Limit the output of <literal>depends</literal> and "
1254 "<literal>rdepends</literal> to packages which are currently installed. "
1255 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1258 #. type: Content of: <refentry><refsect1><variablelist>
1259 #: apt-cache.8.xml:341 apt-cdrom.8.xml:140 apt-config.8.xml:89 apt-extracttemplates.1.xml:62 apt-ftparchive.1.xml:591 apt-get.8.xml:513 apt-mark.8.xml:122 apt-sortpkgs.1.xml:58
1260 msgid "&apt-commonoptions;"
1263 #. type: Content of: <refentry><refsect1><title>
1264 #: apt-cache.8.xml:346 apt-get.8.xml:518 apt-key.8.xml:167 apt-mark.8.xml:126 apt.conf.5.xml:1110 apt_preferences.5.xml:697
1268 #. type: Content of: <refentry><refsect1><variablelist>
1269 #: apt-cache.8.xml:348
1270 msgid "&file-sourceslist; &file-statelists;"
1273 #. type: Content of: <refentry><refsect1><title>
1274 #: apt-cache.8.xml:353 apt-cdrom.8.xml:145 apt-config.8.xml:94 apt-extracttemplates.1.xml:69 apt-ftparchive.1.xml:607 apt-get.8.xml:528 apt-key.8.xml:188 apt-mark.8.xml:132 apt-secure.8.xml:185 apt-sortpkgs.1.xml:63 apt.conf.5.xml:1116 apt_preferences.5.xml:704 sources.list.5.xml:255
1278 #. type: Content of: <refentry><refsect1><para>
1279 #: apt-cache.8.xml:354
1280 msgid "&apt-conf;, &sources-list;, &apt-get;"
1283 #. type: Content of: <refentry><refsect1><title>
1284 #: apt-cache.8.xml:358 apt-cdrom.8.xml:150 apt-config.8.xml:99 apt-extracttemplates.1.xml:73 apt-ftparchive.1.xml:611 apt-get.8.xml:534 apt-mark.8.xml:136 apt-sortpkgs.1.xml:67
1288 #. type: Content of: <refentry><refsect1><para>
1289 #: apt-cache.8.xml:359
1291 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1295 #. type: Content of: <refentry><refentryinfo>
1296 #: apt-cdrom.8.xml:16
1298 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>14 "
1299 "February 2004</date>"
1302 #. type: Content of: <refentry><refnamediv><refname>
1303 #: apt-cdrom.8.xml:24 apt-cdrom.8.xml:31
1307 #. type: Content of: <refentry><refnamediv><refpurpose>
1308 #: apt-cdrom.8.xml:32
1309 msgid "APT CDROM management utility"
1312 #. type: Content of: <refentry><refsect1><para>
1313 #: apt-cdrom.8.xml:38
1315 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1316 "available sources. <command>apt-cdrom</command> takes care of determining "
1317 "the structure of the disc as well as correcting for several possible "
1318 "mis-burns and verifying the index files."
1321 #. type: Content of: <refentry><refsect1><para>
1322 #: apt-cdrom.8.xml:45
1324 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1325 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1326 "must be inserted and scanned separately to account for possible mis-burns."
1329 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1330 #: apt-cdrom.8.xml:55
1334 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1335 #: apt-cdrom.8.xml:56
1337 "<literal>add</literal> is used to add a new disc to the source list. It will "
1338 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1339 "to scan it and copy the index files. If the disc does not have a proper "
1340 "<filename>disk</filename> directory you will be prompted for a descriptive "
1344 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1345 #: apt-cdrom.8.xml:64
1347 "APT uses a CDROM ID to track which disc is currently in the drive and "
1348 "maintains a database of these IDs in "
1349 "<filename>&statedir;/cdroms.list</filename>"
1352 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1353 #: apt-cdrom.8.xml:71
1357 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1358 #: apt-cdrom.8.xml:72
1360 "A debugging tool to report the identity of the current disc as well as the "
1364 #. type: Content of: <refentry><refsect1><para>
1365 #: apt-cdrom.8.xml:51
1367 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1368 "one of the commands below must be present. <placeholder "
1369 "type=\"variablelist\" id=\"0\"/>"
1372 #. type: Content of: <refentry><refsect1><title>
1373 #: apt-cdrom.8.xml:81 apt-key.8.xml:153
1377 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1378 #: apt-cdrom.8.xml:85 apt-ftparchive.1.xml:519 apt-get.8.xml:273
1379 msgid "<option>-d</option>"
1382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1383 #: apt-cdrom.8.xml:85
1384 msgid "<option>--cdrom</option>"
1387 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1388 #: apt-cdrom.8.xml:86
1390 "Mount point; specify the location to mount the cdrom. This mount point must "
1391 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1392 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1396 #: apt-cdrom.8.xml:94
1397 msgid "<option>-r</option>"
1400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1401 #: apt-cdrom.8.xml:94
1402 msgid "<option>--rename</option>"
1405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1406 #: apt-cdrom.8.xml:95
1408 "Rename a disc; change the label of a disk or override the disks given "
1409 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1410 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1413 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1414 #: apt-cdrom.8.xml:103 apt-get.8.xml:292
1415 msgid "<option>-m</option>"
1418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1419 #: apt-cdrom.8.xml:103
1420 msgid "<option>--no-mount</option>"
1423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1424 #: apt-cdrom.8.xml:104
1426 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1427 "unmounting the mount point. Configuration Item: "
1428 "<literal>APT::CDROM::NoMount</literal>."
1431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1432 #: apt-cdrom.8.xml:111
1433 msgid "<option>--fast</option>"
1436 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1437 #: apt-cdrom.8.xml:112
1439 "Fast Copy; Assume the package files are valid and do not check every "
1440 "package. This option should be used only if <command>apt-cdrom</command> has "
1441 "been run on this disc before and did not detect any errors. Configuration "
1442 "Item: <literal>APT::CDROM::Fast</literal>."
1445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1446 #: apt-cdrom.8.xml:121
1447 msgid "<option>--thorough</option>"
1450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1451 #: apt-cdrom.8.xml:122
1453 "Thorough Package Scan; This option may be needed with some old Debian "
1454 "1.1/1.2 discs that have Package files in strange places. It takes much "
1455 "longer to scan the CD but will pick them all up."
1458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1459 #: apt-cdrom.8.xml:130 apt-get.8.xml:323
1460 msgid "<option>--just-print</option>"
1463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1464 #: apt-cdrom.8.xml:131 apt-get.8.xml:325
1465 msgid "<option>--recon</option>"
1468 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1469 #: apt-cdrom.8.xml:132 apt-get.8.xml:326
1470 msgid "<option>--no-act</option>"
1473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1474 #: apt-cdrom.8.xml:133
1476 "No Changes; Do not change the &sources-list; file and do not write index "
1477 "files. Everything is still checked however. Configuration Item: "
1478 "<literal>APT::CDROM::NoAct</literal>."
1481 #. type: Content of: <refentry><refsect1><para>
1482 #: apt-cdrom.8.xml:146
1483 msgid "&apt-conf;, &apt-get;, &sources-list;"
1486 #. type: Content of: <refentry><refsect1><para>
1487 #: apt-cdrom.8.xml:151
1489 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1493 #. The last update date
1494 #. type: Content of: <refentry><refentryinfo>
1495 #: apt-config.8.xml:16 apt-extracttemplates.1.xml:16 apt-sortpkgs.1.xml:16 sources.list.5.xml:16
1497 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>29 "
1498 "February 2004</date>"
1501 #. type: Content of: <refentry><refnamediv><refname>
1502 #: apt-config.8.xml:25 apt-config.8.xml:32
1506 #. type: Content of: <refentry><refnamediv><refpurpose>
1507 #: apt-config.8.xml:33
1508 msgid "APT Configuration Query program"
1511 #. type: Content of: <refentry><refsect1><para>
1512 #: apt-config.8.xml:39
1514 "<command>apt-config</command> is an internal program used by various "
1515 "portions of the APT suite to provide consistent configurability. It accesses "
1516 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1517 "manner that is easy to use by scripted applications."
1520 #. type: Content of: <refentry><refsect1><para>
1521 #: apt-config.8.xml:44 apt-ftparchive.1.xml:54
1523 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1524 "one of the commands below must be present."
1527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1528 #: apt-config.8.xml:49
1532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1533 #: apt-config.8.xml:51
1535 "shell is used to access the configuration information from a shell "
1536 "script. It is given pairs of arguments, the first being a shell variable and "
1537 "the second the configuration value to query. As output it lists a series of "
1538 "shell assignments commands for each present value. In a shell script it "
1539 "should be used like:"
1542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1543 #: apt-config.8.xml:59
1547 "RES=`apt-config shell OPTS MyApp::options`\n"
1551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1552 #: apt-config.8.xml:64
1554 "This will set the shell environment variable $OPTS to the value of "
1555 "MyApp::options with a default of <option>-f</option>."
1558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1559 #: apt-config.8.xml:68
1561 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1562 "names, d returns directories, b returns true or false and i returns an "
1563 "integer. Each of the returns is normalized and verified internally."
1566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1567 #: apt-config.8.xml:77
1568 msgid "Just show the contents of the configuration space."
1571 #. type: Content of: <refentry><refsect1><para>
1572 #: apt-config.8.xml:95 apt-extracttemplates.1.xml:70 apt-ftparchive.1.xml:608 apt-sortpkgs.1.xml:64
1576 #. type: Content of: <refentry><refsect1><para>
1577 #: apt-config.8.xml:100
1579 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1583 #. type: Content of: <refentry><refnamediv><refname>
1584 #: apt-extracttemplates.1.xml:25 apt-extracttemplates.1.xml:32
1585 msgid "apt-extracttemplates"
1588 #. type: Content of: <refentry><refmeta><manvolnum>
1589 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1593 #. type: Content of: <refentry><refnamediv><refpurpose>
1594 #: apt-extracttemplates.1.xml:33
1595 msgid "Utility to extract DebConf config and templates from Debian packages"
1598 #. type: Content of: <refentry><refsect1><para>
1599 #: apt-extracttemplates.1.xml:39
1601 "<command>apt-extracttemplates</command> will take one or more Debian package "
1602 "files as input and write out (to a temporary directory) all associated "
1603 "config scripts and template files. For each passed in package that contains "
1604 "config scripts and templates, one line of output will be generated in the "
1608 #. type: Content of: <refentry><refsect1><para>
1609 #: apt-extracttemplates.1.xml:44
1610 msgid "package version template-file config-script"
1613 #. type: Content of: <refentry><refsect1><para>
1614 #: apt-extracttemplates.1.xml:45
1616 "template-file and config-script are written to the temporary directory "
1617 "specified by the -t or --tempdir "
1618 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1619 "filenames of the form <filename>package.template.XXXX</filename> and "
1620 "<filename>package.config.XXXX</filename>"
1623 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1624 #: apt-extracttemplates.1.xml:55 apt-get.8.xml:447
1625 msgid "<option>-t</option>"
1628 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1629 #: apt-extracttemplates.1.xml:55
1630 msgid "<option>--tempdir</option>"
1633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1634 #: apt-extracttemplates.1.xml:57
1636 "Temporary directory in which to write extracted debconf template files and "
1637 "config scripts. Configuration Item: "
1638 "<literal>APT::ExtractTemplates::TempDir</literal>"
1641 #. type: Content of: <refentry><refsect1><para>
1642 #: apt-extracttemplates.1.xml:74
1644 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1645 "decimal 100 on error."
1648 #. The last update date
1649 #. type: Content of: <refentry><refentryinfo>
1650 #: apt-ftparchive.1.xml:16
1652 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>17 "
1653 "August 2009</date>"
1656 #. type: Content of: <refentry><refnamediv><refname>
1657 #: apt-ftparchive.1.xml:25 apt-ftparchive.1.xml:32
1658 msgid "apt-ftparchive"
1661 #. type: Content of: <refentry><refnamediv><refpurpose>
1662 #: apt-ftparchive.1.xml:33
1663 msgid "Utility to generate index files"
1666 #. type: Content of: <refentry><refsect1><para>
1667 #: apt-ftparchive.1.xml:39
1669 "<command>apt-ftparchive</command> is the command line tool that generates "
1670 "the index files that APT uses to access a distribution source. The index "
1671 "files should be generated on the origin site based on the content of that "
1675 #. type: Content of: <refentry><refsect1><para>
1676 #: apt-ftparchive.1.xml:43
1678 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1679 "program, incorporating its entire functionality via the "
1680 "<literal>packages</literal> command. It also contains a contents file "
1681 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1682 "the generation process for a complete archive."
1685 #. type: Content of: <refentry><refsect1><para>
1686 #: apt-ftparchive.1.xml:49
1688 "Internally <command>apt-ftparchive</command> can make use of binary "
1689 "databases to cache the contents of a .deb file and it does not rely on any "
1690 "external programs aside from &gzip;. When doing a full generate it "
1691 "automatically performs file-change checks and builds the desired compressed "
1695 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1696 #: apt-ftparchive.1.xml:58
1700 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1701 #: apt-ftparchive.1.xml:60
1703 "The packages command generates a package file from a directory tree. It "
1704 "takes the given directory and recursively searches it for .deb files, "
1705 "emitting a package record to stdout for each. This command is approximately "
1706 "equivalent to &dpkg-scanpackages;."
1709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1710 #: apt-ftparchive.1.xml:65 apt-ftparchive.1.xml:89
1711 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1714 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1715 #: apt-ftparchive.1.xml:68
1719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1720 #: apt-ftparchive.1.xml:70
1722 "The <literal>sources</literal> command generates a source index file from a "
1723 "directory tree. It takes the given directory and recursively searches it "
1724 "for .dsc files, emitting a source record to stdout for each. This command is "
1725 "approximately equivalent to &dpkg-scansources;."
1728 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1729 #: apt-ftparchive.1.xml:75
1731 "If an override file is specified then a source override file will be looked "
1732 "for with an extension of .src. The --source-override option can be used to "
1733 "change the source override file that will be used."
1736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1737 #: apt-ftparchive.1.xml:80
1741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1742 #: apt-ftparchive.1.xml:82
1744 "The <literal>contents</literal> command generates a contents file from a "
1745 "directory tree. It takes the given directory and recursively searches it for "
1746 ".deb files, and reads the file list from each file. It then sorts and writes "
1747 "to stdout the list of files matched to packages. Directories are not written "
1748 "to the output. If multiple packages own the same file then each package is "
1749 "separated by a comma in the output."
1752 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1753 #: apt-ftparchive.1.xml:92
1757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1758 #: apt-ftparchive.1.xml:94
1760 "The <literal>release</literal> command generates a Release file from a "
1761 "directory tree. It recursively searches the given directory for uncompressed "
1762 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1763 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1764 "<command>lzma</command> as well as <filename>Release</filename> and "
1765 "<filename>md5sum.txt</filename> files by default "
1766 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1767 "filename patterns can be added by listing them in "
1768 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1769 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1774 #: apt-ftparchive.1.xml:104
1776 "Values for the additional metadata fields in the Release file are taken from "
1777 "the corresponding variables under "
1778 "<literal>APT::FTPArchive::Release</literal>, "
1779 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1780 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1781 "<literal>Suite</literal>, <literal>Version</literal>, "
1782 "<literal>Codename</literal>, <literal>Date</literal>, "
1783 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1784 "<literal>Components</literal>, <literal>Description</literal>."
1787 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1788 #: apt-ftparchive.1.xml:115
1792 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1793 #: apt-ftparchive.1.xml:117
1795 "The <literal>generate</literal> command is designed to be runnable from a "
1796 "cron script and builds indexes according to the given config file. The "
1797 "config language provides a flexible means of specifying which index files "
1798 "are built from which directories, as well as providing a simple means of "
1799 "maintaining the required settings."
1802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1803 #: apt-ftparchive.1.xml:124 apt-get.8.xml:215
1807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1808 #: apt-ftparchive.1.xml:126
1810 "The <literal>clean</literal> command tidies the databases used by the given "
1811 "configuration file by removing any records that are no longer necessary."
1814 #. type: Content of: <refentry><refsect1><title>
1815 #: apt-ftparchive.1.xml:132
1816 msgid "The Generate Configuration"
1819 #. type: Content of: <refentry><refsect1><para>
1820 #: apt-ftparchive.1.xml:134
1822 "The <literal>generate</literal> command uses a configuration file to "
1823 "describe the archives that are going to be generated. It follows the typical "
1824 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1825 "&apt-conf; contains a description of the syntax. Note that the generate "
1826 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1827 "tree manner. This only effects how the scope tag is handled."
1830 #. type: Content of: <refentry><refsect1><para>
1831 #: apt-ftparchive.1.xml:142
1832 msgid "The generate configuration has 4 separate sections, each described below."
1835 #. type: Content of: <refentry><refsect1><refsect2><title>
1836 #: apt-ftparchive.1.xml:144
1840 #. type: Content of: <refentry><refsect1><refsect2><para>
1841 #: apt-ftparchive.1.xml:146
1843 "The <literal>Dir</literal> section defines the standard directories needed "
1844 "to locate the files required during the generation process. These "
1845 "directories are prepended certain relative paths defined in later sections "
1846 "to produce a complete an absolute path."
1849 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1850 #: apt-ftparchive.1.xml:151
1854 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1855 #: apt-ftparchive.1.xml:153
1857 "Specifies the root of the FTP archive, in a standard Debian configuration "
1858 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1862 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1863 #: apt-ftparchive.1.xml:158
1867 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1868 #: apt-ftparchive.1.xml:160
1869 msgid "Specifies the location of the override files."
1872 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1873 #: apt-ftparchive.1.xml:163
1877 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1878 #: apt-ftparchive.1.xml:165
1879 msgid "Specifies the location of the cache files"
1882 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1883 #: apt-ftparchive.1.xml:168
1887 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1888 #: apt-ftparchive.1.xml:170
1890 "Specifies the location of the file list files, if the "
1891 "<literal>FileList</literal> setting is used below."
1894 #. type: Content of: <refentry><refsect1><refsect2><title>
1895 #: apt-ftparchive.1.xml:176
1896 msgid "Default Section"
1899 #. type: Content of: <refentry><refsect1><refsect2><para>
1900 #: apt-ftparchive.1.xml:178
1902 "The <literal>Default</literal> section specifies default values, and "
1903 "settings that control the operation of the generator. Other sections may "
1904 "override these defaults with a per-section setting."
1907 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1908 #: apt-ftparchive.1.xml:182
1909 msgid "Packages::Compress"
1912 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1913 #: apt-ftparchive.1.xml:184
1915 "Sets the default compression schemes to use for the Package index files. It "
1916 "is a string that contains a space separated list of at least one of: '.' (no "
1917 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1921 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1922 #: apt-ftparchive.1.xml:190
1923 msgid "Packages::Extensions"
1926 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1927 #: apt-ftparchive.1.xml:192
1929 "Sets the default list of file extensions that are package files. This "
1930 "defaults to '.deb'."
1933 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1934 #: apt-ftparchive.1.xml:196
1935 msgid "Sources::Compress"
1938 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1939 #: apt-ftparchive.1.xml:198
1941 "This is similar to <literal>Packages::Compress</literal> except that it "
1942 "controls the compression for the Sources files."
1945 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1946 #: apt-ftparchive.1.xml:202
1947 msgid "Sources::Extensions"
1950 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1951 #: apt-ftparchive.1.xml:204
1953 "Sets the default list of file extensions that are source files. This "
1954 "defaults to '.dsc'."
1957 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1958 #: apt-ftparchive.1.xml:208
1959 msgid "Contents::Compress"
1962 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1963 #: apt-ftparchive.1.xml:210
1965 "This is similar to <literal>Packages::Compress</literal> except that it "
1966 "controls the compression for the Contents files."
1969 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1970 #: apt-ftparchive.1.xml:214
1971 msgid "Translation::Compress"
1974 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1975 #: apt-ftparchive.1.xml:216
1977 "This is similar to <literal>Packages::Compress</literal> except that it "
1978 "controls the compression for the Translation-en master file."
1981 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1982 #: apt-ftparchive.1.xml:220
1986 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1987 #: apt-ftparchive.1.xml:222
1989 "Specifies the number of kilobytes to delink (and replace with hard links) "
1990 "per run. This is used in conjunction with the per-section "
1991 "<literal>External-Links</literal> setting."
1994 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1995 #: apt-ftparchive.1.xml:227
1999 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2000 #: apt-ftparchive.1.xml:229
2002 "Specifies the mode of all created index files. It defaults to 0644. All "
2003 "index files are set to this mode with no regard to the umask."
2006 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2007 #: apt-ftparchive.1.xml:234 apt-ftparchive.1.xml:380
2008 msgid "LongDescription"
2011 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2012 #: apt-ftparchive.1.xml:236 apt-ftparchive.1.xml:382
2014 "Sets if long descriptions should be included in the Packages file or split "
2015 "out into a master Translation-en file."
2018 #. type: Content of: <refentry><refsect1><refsect2><title>
2019 #: apt-ftparchive.1.xml:242
2020 msgid "TreeDefault Section"
2023 #. type: Content of: <refentry><refsect1><refsect2><para>
2024 #: apt-ftparchive.1.xml:244
2026 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
2027 "variables are substitution variables and have the strings $(DIST), "
2028 "$(SECTION) and $(ARCH) replaced with their respective values."
2031 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2032 #: apt-ftparchive.1.xml:249
2033 msgid "MaxContentsChange"
2036 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2037 #: apt-ftparchive.1.xml:251
2039 "Sets the number of kilobytes of contents files that are generated each "
2040 "day. The contents files are round-robined so that over several days they "
2041 "will all be rebuilt."
2044 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2045 #: apt-ftparchive.1.xml:256
2049 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2050 #: apt-ftparchive.1.xml:258
2052 "Controls the number of days a contents file is allowed to be checked without "
2053 "changing. If this limit is passed the mtime of the contents file is "
2054 "updated. This case can occur if the package file is changed in such a way "
2055 "that does not result in a new contents file [override edit for instance]. A "
2056 "hold off is allowed in hopes that new .debs will be installed, requiring a "
2057 "new file anyhow. The default is 10, the units are in days."
2060 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2061 #: apt-ftparchive.1.xml:267
2065 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2066 #: apt-ftparchive.1.xml:269
2068 "Sets the top of the .deb directory tree. Defaults to "
2069 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
2072 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2073 #: apt-ftparchive.1.xml:273
2074 msgid "SrcDirectory"
2077 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2078 #: apt-ftparchive.1.xml:275
2080 "Sets the top of the source package directory tree. Defaults to "
2081 "<filename>$(DIST)/$(SECTION)/source/</filename>"
2084 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2085 #: apt-ftparchive.1.xml:279 apt-ftparchive.1.xml:418
2089 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2090 #: apt-ftparchive.1.xml:281
2092 "Sets the output Packages file. Defaults to "
2093 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
2096 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2097 #: apt-ftparchive.1.xml:285 apt-ftparchive.1.xml:423
2101 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2102 #: apt-ftparchive.1.xml:287
2104 "Sets the output Sources file. Defaults to "
2105 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
2108 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2109 #: apt-ftparchive.1.xml:291
2113 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2114 #: apt-ftparchive.1.xml:293
2116 "Set the output Translation-en master file with the long descriptions if they "
2117 "should be not included in the Packages file. Defaults to "
2118 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
2121 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2122 #: apt-ftparchive.1.xml:298
2123 msgid "InternalPrefix"
2126 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2127 #: apt-ftparchive.1.xml:300
2129 "Sets the path prefix that causes a symlink to be considered an internal link "
2130 "instead of an external link. Defaults to "
2131 "<filename>$(DIST)/$(SECTION)/</filename>"
2134 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2135 #: apt-ftparchive.1.xml:305 apt-ftparchive.1.xml:429
2139 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2140 #: apt-ftparchive.1.xml:307
2142 "Sets the output Contents file. Defaults to "
2143 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
2144 "multiple Packages files to map onto a single Contents file (such as the "
2145 "default) then <command>apt-ftparchive</command> will integrate those "
2146 "package files together automatically."
2149 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2150 #: apt-ftparchive.1.xml:314
2151 msgid "Contents::Header"
2154 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2155 #: apt-ftparchive.1.xml:316
2156 msgid "Sets header file to prepend to the contents output."
2159 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2160 #: apt-ftparchive.1.xml:319 apt-ftparchive.1.xml:454
2164 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2165 #: apt-ftparchive.1.xml:321
2167 "Sets the binary cache database to use for this section. Multiple sections "
2168 "can share the same database."
2171 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2172 #: apt-ftparchive.1.xml:325
2176 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2177 #: apt-ftparchive.1.xml:327
2179 "Specifies that instead of walking the directory tree, "
2180 "<command>apt-ftparchive</command> should read the list of files from the "
2181 "given file. Relative files names are prefixed with the archive directory."
2184 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2185 #: apt-ftparchive.1.xml:332
2186 msgid "SourceFileList"
2189 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2190 #: apt-ftparchive.1.xml:334
2192 "Specifies that instead of walking the directory tree, "
2193 "<command>apt-ftparchive</command> should read the list of files from the "
2194 "given file. Relative files names are prefixed with the archive directory. "
2195 "This is used when processing source indexes."
2198 #. type: Content of: <refentry><refsect1><refsect2><title>
2199 #: apt-ftparchive.1.xml:342
2200 msgid "Tree Section"
2203 #. type: Content of: <refentry><refsect1><refsect2><para>
2204 #: apt-ftparchive.1.xml:344
2206 "The <literal>Tree</literal> section defines a standard Debian file tree "
2207 "which consists of a base directory, then multiple sections in that base "
2208 "directory and finally multiple Architectures in each section. The exact "
2209 "pathing used is defined by the <literal>Directory</literal> substitution "
2213 #. type: Content of: <refentry><refsect1><refsect2><para>
2214 #: apt-ftparchive.1.xml:349
2216 "The <literal>Tree</literal> section takes a scope tag which sets the "
2217 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
2218 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
2219 "setting such as <filename>dists/&stable-codename;</filename>."
2222 #. type: Content of: <refentry><refsect1><refsect2><para>
2223 #: apt-ftparchive.1.xml:354
2225 "All of the settings defined in the <literal>TreeDefault</literal> section "
2226 "can be use in a <literal>Tree</literal> section as well as three new "
2230 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
2231 #: apt-ftparchive.1.xml:360
2234 "for i in Sections do \n"
2235 " for j in Architectures do\n"
2236 " Generate for DIST=scope SECTION=i ARCH=j\n"
2240 #. type: Content of: <refentry><refsect1><refsect2><para>
2241 #: apt-ftparchive.1.xml:357
2243 "When processing a <literal>Tree</literal> section "
2244 "<command>apt-ftparchive</command> performs an operation similar to: "
2245 "<placeholder type=\"programlisting\" id=\"0\"/>"
2248 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2249 #: apt-ftparchive.1.xml:366
2253 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2254 #: apt-ftparchive.1.xml:368
2256 "This is a space separated list of sections which appear under the "
2257 "distribution, typically this is something like <literal>main contrib "
2258 "non-free</literal>"
2261 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2262 #: apt-ftparchive.1.xml:373 apt.conf.5.xml:157
2263 msgid "Architectures"
2266 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2267 #: apt-ftparchive.1.xml:375
2269 "This is a space separated list of all the architectures that appear under "
2270 "search section. The special architecture 'source' is used to indicate that "
2271 "this tree has a source archive."
2274 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2275 #: apt-ftparchive.1.xml:386 apt-ftparchive.1.xml:434
2279 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2280 #: apt-ftparchive.1.xml:388
2282 "Sets the binary override file. The override file contains section, priority "
2283 "and maintainer address information."
2286 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2287 #: apt-ftparchive.1.xml:392 apt-ftparchive.1.xml:439
2291 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2292 #: apt-ftparchive.1.xml:394
2294 "Sets the source override file. The override file contains section "
2298 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2299 #: apt-ftparchive.1.xml:398 apt-ftparchive.1.xml:444
2300 msgid "ExtraOverride"
2303 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2304 #: apt-ftparchive.1.xml:400 apt-ftparchive.1.xml:446
2305 msgid "Sets the binary extra override file."
2308 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2309 #: apt-ftparchive.1.xml:403 apt-ftparchive.1.xml:449
2310 msgid "SrcExtraOverride"
2313 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2314 #: apt-ftparchive.1.xml:405 apt-ftparchive.1.xml:451
2315 msgid "Sets the source extra override file."
2318 #. type: Content of: <refentry><refsect1><refsect2><title>
2319 #: apt-ftparchive.1.xml:410
2320 msgid "BinDirectory Section"
2323 #. type: Content of: <refentry><refsect1><refsect2><para>
2324 #: apt-ftparchive.1.xml:412
2326 "The <literal>bindirectory</literal> section defines a binary directory tree "
2327 "with no special structure. The scope tag specifies the location of the "
2328 "binary directory and the settings are similar to the <literal>Tree</literal> "
2329 "section with no substitution variables or "
2330 "<literal>Section</literal><literal>Architecture</literal> settings."
2333 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2334 #: apt-ftparchive.1.xml:420
2335 msgid "Sets the Packages file output."
2338 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2339 #: apt-ftparchive.1.xml:425
2341 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
2342 "<literal>Sources</literal> is required."
2345 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2346 #: apt-ftparchive.1.xml:431
2347 msgid "Sets the Contents file output. (optional)"
2350 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2351 #: apt-ftparchive.1.xml:436
2352 msgid "Sets the binary override file."
2355 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2356 #: apt-ftparchive.1.xml:441
2357 msgid "Sets the source override file."
2360 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2361 #: apt-ftparchive.1.xml:456
2362 msgid "Sets the cache DB."
2365 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2366 #: apt-ftparchive.1.xml:459
2370 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2371 #: apt-ftparchive.1.xml:461
2372 msgid "Appends a path to all the output paths."
2375 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2376 #: apt-ftparchive.1.xml:464
2377 msgid "FileList, SourceFileList"
2380 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2381 #: apt-ftparchive.1.xml:466
2382 msgid "Specifies the file list file."
2385 #. type: Content of: <refentry><refsect1><title>
2386 #: apt-ftparchive.1.xml:473
2387 msgid "The Binary Override File"
2390 #. type: Content of: <refentry><refsect1><para>
2391 #: apt-ftparchive.1.xml:474
2393 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
2394 "contains 4 fields separated by spaces. The first field is the package name, "
2395 "the second is the priority to force that package to, the third is the the "
2396 "section to force that package to and the final field is the maintainer "
2397 "permutation field."
2400 #. type: Content of: <refentry><refsect1><para><literallayout>
2401 #: apt-ftparchive.1.xml:480
2403 msgid "old [// oldn]* => new"
2406 #. type: Content of: <refentry><refsect1><para><literallayout>
2407 #: apt-ftparchive.1.xml:482
2412 #. type: Content of: <refentry><refsect1><para>
2413 #: apt-ftparchive.1.xml:479
2415 "The general form of the maintainer field is: <placeholder "
2416 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
2417 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
2418 "separated list of old email addresses to be specified. If any of those are "
2419 "found then new is substituted for the maintainer field. The second form "
2420 "unconditionally substitutes the maintainer field."
2423 #. type: Content of: <refentry><refsect1><title>
2424 #: apt-ftparchive.1.xml:490
2425 msgid "The Source Override File"
2428 #. type: Content of: <refentry><refsect1><para>
2429 #: apt-ftparchive.1.xml:492
2431 "The source override file is fully compatible with &dpkg-scansources;. It "
2432 "contains 2 fields separated by spaces. The first fields is the source "
2433 "package name, the second is the section to assign it."
2436 #. type: Content of: <refentry><refsect1><title>
2437 #: apt-ftparchive.1.xml:497
2438 msgid "The Extra Override File"
2441 #. type: Content of: <refentry><refsect1><para>
2442 #: apt-ftparchive.1.xml:499
2444 "The extra override file allows any arbitrary tag to be added or replaced in "
2445 "the output. It has 3 columns, the first is the package, the second is the "
2446 "tag and the remainder of the line is the new value."
2449 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2450 #: apt-ftparchive.1.xml:508
2451 msgid "<option>--md5</option>, <option>--sha1</option>, <option>--sha256</option>"
2454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2455 #: apt-ftparchive.1.xml:510
2457 "Generate the given checksum. These options default to on, when turned off "
2458 "the generated index files will not have the checksum fields where possible. "
2459 "Configuration Items: "
2460 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
2461 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
2462 "where <literal><replaceable>Index</replaceable></literal> can be "
2463 "<literal>Packages</literal>, <literal>Sources</literal> or "
2464 "<literal>Release</literal> and "
2465 "<literal><replaceable>Checksum</replaceable></literal> can be "
2466 "<literal>MD5</literal>, <literal>SHA1</literal> or "
2467 "<literal>SHA256</literal>."
2470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2471 #: apt-ftparchive.1.xml:519
2472 msgid "<option>--db</option>"
2475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2476 #: apt-ftparchive.1.xml:521
2478 "Use a binary caching DB. This has no effect on the generate command. "
2479 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
2482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2483 #: apt-ftparchive.1.xml:527
2485 "Quiet; produces output suitable for logging, omitting progress indicators. "
2486 "More q's will produce more quiet up to a maximum of 2. You can also use "
2487 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2488 "file. Configuration Item: <literal>quiet</literal>."
2491 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2492 #: apt-ftparchive.1.xml:533
2493 msgid "<option>--delink</option>"
2496 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2497 #: apt-ftparchive.1.xml:535
2499 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
2500 "then this option actually enables delinking of the files. It defaults to on "
2501 "and can be turned off with <option>--no-delink</option>. Configuration "
2502 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
2505 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2506 #: apt-ftparchive.1.xml:541
2507 msgid "<option>--contents</option>"
2510 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2511 #: apt-ftparchive.1.xml:543
2513 "Perform contents generation. When this option is set and package indexes are "
2514 "being generated with a cache DB then the file listing will also be extracted "
2515 "and stored in the DB for later use. When using the generate command this "
2516 "option also allows the creation of any Contents files. The default is on. "
2517 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
2520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2521 #: apt-ftparchive.1.xml:551
2522 msgid "<option>--source-override</option>"
2525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2526 #: apt-ftparchive.1.xml:553
2528 "Select the source override file to use with the <literal>sources</literal> "
2529 "command. Configuration Item: "
2530 "<literal>APT::FTPArchive::SourceOverride</literal>."
2533 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2534 #: apt-ftparchive.1.xml:557
2535 msgid "<option>--readonly</option>"
2538 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2539 #: apt-ftparchive.1.xml:559
2541 "Make the caching databases read only. Configuration Item: "
2542 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2546 #: apt-ftparchive.1.xml:563
2547 msgid "<option>--arch</option>"
2550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2551 #: apt-ftparchive.1.xml:564
2553 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2554 "commands only package files matching <literal>*_arch.deb</literal> or "
2555 "<literal>*_all.deb</literal> instead of all package files in the given "
2556 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2560 #: apt-ftparchive.1.xml:570
2561 msgid "<option>APT::FTPArchive::AlwaysStat</option>"
2564 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2565 #: apt-ftparchive.1.xml:572
2567 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2568 "packages are recompiled and/or republished with the same version again, this "
2569 "will lead to problems as the now outdated cached metadata like size and "
2570 "checksums will be used. With this option enabled this will no longer happen "
2571 "as it will be checked if the file was changed. Note that this option is set "
2572 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2573 "multiply versions/builds of a package with the same versionnumber, so in "
2574 "theory nobody will have these problems and therefore all these extra checks "
2578 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2579 #: apt-ftparchive.1.xml:582
2580 msgid "<option>APT::FTPArchive::LongDescription</option>"
2583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2584 #: apt-ftparchive.1.xml:584
2586 "This configuration option defaults to \"<literal>true</literal>\" and should "
2587 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2588 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2589 "that the <filename>Translation-en</filename> master file can only be created "
2590 "in the generate command."
2593 #. type: Content of: <refentry><refsect1><title>
2594 #: apt-ftparchive.1.xml:596 apt.conf.5.xml:1104 apt_preferences.5.xml:544 sources.list.5.xml:214
2598 #. type: Content of: <refentry><refsect1><para><programlisting>
2599 #: apt-ftparchive.1.xml:602
2602 "<command>apt-ftparchive</command> packages "
2603 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2604 "<filename>Packages.gz</filename>\n"
2607 #. type: Content of: <refentry><refsect1><para>
2608 #: apt-ftparchive.1.xml:598
2610 "To create a compressed Packages file for a directory containing binary "
2611 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2614 #. type: Content of: <refentry><refsect1><para>
2615 #: apt-ftparchive.1.xml:612
2617 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2621 #. The last update date
2622 #. type: Content of: <refentry><refentryinfo>
2625 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>08 "
2626 "November 2008</date>"
2629 #. type: <heading></heading>
2630 #: apt-get.8.xml:25 apt-get.8.xml:32 guide.sgml:96
2634 #. type: Content of: <refentry><refnamediv><refpurpose>
2636 msgid "APT package handling utility -- command-line interface"
2639 #. type: Content of: <refentry><refsect1><para>
2642 "<command>apt-get</command> is the command-line tool for handling packages, "
2643 "and may be considered the user's \"back-end\" to other tools using the APT "
2644 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2645 "&aptitude;, &synaptic; and &wajig;."
2648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2649 #: apt-get.8.xml:48 apt-key.8.xml:119
2653 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2656 "<literal>update</literal> is used to resynchronize the package index files "
2657 "from their sources. The indexes of available packages are fetched from the "
2658 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2659 "example, when using a Debian archive, this command retrieves and scans the "
2660 "<filename>Packages.gz</filename> files, so that information about new and "
2661 "updated packages is available. An <literal>update</literal> should always be "
2662 "performed before an <literal>upgrade</literal> or "
2663 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2664 "meter will be incorrect as the size of the package files cannot be known in "
2668 #. type: <tag></tag>
2669 #: apt-get.8.xml:60 guide.sgml:121
2673 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2676 "<literal>upgrade</literal> is used to install the newest versions of all "
2677 "packages currently installed on the system from the sources enumerated in "
2678 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2679 "with new versions available are retrieved and upgraded; under no "
2680 "circumstances are currently installed packages removed, or packages not "
2681 "already installed retrieved and installed. New versions of currently "
2682 "installed packages that cannot be upgraded without changing the install "
2683 "status of another package will be left at their current version. An "
2684 "<literal>update</literal> must be performed first so that "
2685 "<command>apt-get</command> knows that new versions of packages are "
2689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2691 msgid "dselect-upgrade"
2694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2697 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2698 "traditional Debian packaging front-end, "
2699 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2700 "&dselect; to the <literal>Status</literal> field of available packages, and "
2701 "performs the actions necessary to realize that state (for instance, the "
2702 "removal of old and the installation of new packages)."
2705 #. type: <tag></tag>
2706 #: apt-get.8.xml:83 guide.sgml:140
2707 msgid "dist-upgrade"
2710 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2713 "<literal>dist-upgrade</literal> in addition to performing the function of "
2714 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2715 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2716 "conflict resolution system, and it will attempt to upgrade the most "
2717 "important packages at the expense of less important ones if necessary. So, "
2718 "<literal>dist-upgrade</literal> command may remove some packages. The "
2719 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2720 "from which to retrieve desired package files. See also &apt-preferences; "
2721 "for a mechanism for overriding the general settings for individual packages."
2724 #. type: <tag></tag>
2725 #: apt-get.8.xml:96 guide.sgml:131
2729 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2732 "<literal>install</literal> is followed by one or more packages desired for "
2733 "installation or upgrading. Each package is a package name, not a fully "
2734 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2735 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2736 "packages required by the package(s) specified for installation will also be "
2737 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2738 "file is used to locate the desired packages. If a hyphen is appended to the "
2739 "package name (with no intervening space), the identified package will be "
2740 "removed if it is installed. Similarly a plus sign can be used to designate "
2741 "a package to install. These latter features may be used to override "
2742 "decisions made by apt-get's conflict resolution system."
2745 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2746 #: apt-get.8.xml:116
2748 "A specific version of a package can be selected for installation by "
2749 "following the package name with an equals and the version of the package to "
2750 "select. This will cause that version to be located and selected for "
2751 "install. Alternatively a specific distribution can be selected by following "
2752 "the package name with a slash and the version of the distribution or the "
2753 "Archive name (stable, testing, unstable)."
2756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2757 #: apt-get.8.xml:123
2759 "Both of the version selection mechanisms can downgrade packages and must be "
2763 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2764 #: apt-get.8.xml:126
2766 "This is also the target to use if you want to upgrade one or more "
2767 "already-installed packages without upgrading every package you have on your "
2768 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2769 "all currently installed packages, \"install\" will install the newest "
2770 "version of only the package(s) specified. Simply provide the name of the "
2771 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2772 "its dependencies, as described above) will be downloaded and installed."
2775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2776 #: apt-get.8.xml:137
2778 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2779 "installation policy for individual packages."
2782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2783 #: apt-get.8.xml:141
2785 "If no package matches the given expression and the expression contains one "
2786 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2787 "it is applied to all package names in the database. Any matches are then "
2788 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2789 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2790 "expression with a '^' or '$' character, or create a more specific regular "
2794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2795 #: apt-get.8.xml:150
2799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2800 #: apt-get.8.xml:151
2802 "<literal>remove</literal> is identical to <literal>install</literal> except "
2803 "that packages are removed instead of installed. Note the removing a package "
2804 "leaves its configuration files in system. If a plus sign is appended to the "
2805 "package name (with no intervening space), the identified package will be "
2806 "installed instead of removed."
2809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2810 #: apt-get.8.xml:158
2814 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2815 #: apt-get.8.xml:159
2817 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2818 "that packages are removed and purged (any configuration files are deleted "
2822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2823 #: apt-get.8.xml:163
2827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2828 #: apt-get.8.xml:164
2830 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2831 "packages. APT will examine the available packages to decide which source "
2832 "package to fetch. It will then find and download into the current directory "
2833 "the newest available version of that source package while respecting the "
2834 "default release, set with the option "
2835 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2836 "per package with the <literal>pkg/release</literal> syntax, if possible."
2839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2840 #: apt-get.8.xml:172
2842 "Source packages are tracked separately from binary packages via "
2843 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2844 "that you will need to add such a line for each repository you want to get "
2845 "sources from. If you don't do this you will properly get another (newer, "
2846 "older or none) source version than the one you have installed or could "
2850 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2851 #: apt-get.8.xml:179
2853 "If the <option>--compile</option> option is specified then the package will "
2854 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2855 "the architecture as defined by the <command>--host-architecture</command> "
2856 "option. If <option>--download-only</option> is specified then the source "
2857 "package will not be unpacked."
2860 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2861 #: apt-get.8.xml:186
2863 "A specific source version can be retrieved by postfixing the source name "
2864 "with an equals and then the version to fetch, similar to the mechanism used "
2865 "for the package files. This enables exact matching of the source package "
2866 "name and version, implicitly enabling the "
2867 "<literal>APT::Get::Only-Source</literal> option."
2870 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2871 #: apt-get.8.xml:192
2873 "Note that source packages are not tracked like binary packages, they exist "
2874 "only in the current directory and are similar to downloading source tar "
2878 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2879 #: apt-get.8.xml:197
2883 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2884 #: apt-get.8.xml:198
2886 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2887 "attempt to satisfy the build dependencies for a source package. By default "
2888 "the dependencies are satisfied to build the package natively. If desired a "
2889 "host-architecture can be specified with the "
2890 "<option>--host-architecture</option> option instead."
2893 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2894 #: apt-get.8.xml:204
2898 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2899 #: apt-get.8.xml:205
2901 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2902 "and checks for broken dependencies."
2905 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2906 #: apt-get.8.xml:209
2910 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2911 #: apt-get.8.xml:210
2913 "<literal>download</literal> will download the given binary package into the "
2914 "current directory."
2917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2918 #: apt-get.8.xml:216
2920 "<literal>clean</literal> clears out the local repository of retrieved "
2921 "package files. It removes everything but the lock file from "
2922 "<filename>&cachedir;/archives/</filename> and "
2923 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2924 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2925 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2926 "from time to time to free up disk space."
2929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2930 #: apt-get.8.xml:225
2934 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2935 #: apt-get.8.xml:226
2937 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2938 "local repository of retrieved package files. The difference is that it only "
2939 "removes package files that can no longer be downloaded, and are largely "
2940 "useless. This allows a cache to be maintained over a long period without it "
2941 "growing out of control. The configuration option "
2942 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2943 "being erased if it is set to off."
2946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2947 #: apt-get.8.xml:235
2951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2952 #: apt-get.8.xml:236
2954 "<literal>autoremove</literal> is used to remove packages that were "
2955 "automatically installed to satisfy dependencies for other packages and are "
2956 "now no longer needed."
2959 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2960 #: apt-get.8.xml:240
2964 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2965 #: apt-get.8.xml:241
2967 "<literal>changelog</literal> downloads a package changelog and displays it "
2968 "through <command>sensible-pager</command>. The server name and base "
2969 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2970 "variable (e. g. <ulink>http://packages.debian.org/changelogs</ulink> for "
2971 "Debian or <ulink>http://changelogs.ubuntu.com/changelogs</ulink> for "
2972 "Ubuntu). By default it displays the changelog for the version that is "
2973 "installed. However, you can specify the same options as for the "
2974 "<option>install</option> command."
2977 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2978 #: apt-get.8.xml:263
2979 msgid "<option>--no-install-recommends</option>"
2982 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2983 #: apt-get.8.xml:264
2985 "Do not consider recommended packages as a dependency for installing. "
2986 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2990 #: apt-get.8.xml:268
2991 msgid "<option>--install-suggests</option>"
2994 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2995 #: apt-get.8.xml:269
2997 "Consider suggested packages as a dependency for installing. Configuration "
2998 "Item: <literal>APT::Install-Suggests</literal>."
3001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3002 #: apt-get.8.xml:273
3003 msgid "<option>--download-only</option>"
3006 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3007 #: apt-get.8.xml:274
3009 "Download only; package files are only retrieved, not unpacked or installed. "
3010 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
3013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3014 #: apt-get.8.xml:278
3015 msgid "<option>--fix-broken</option>"
3018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3019 #: apt-get.8.xml:279
3021 "Fix; attempt to correct a system with broken dependencies in place. This "
3022 "option, when used with install/remove, can omit any packages to permit APT "
3023 "to deduce a likely solution. If packages are specified, these have to "
3024 "completely correct the problem. The option is sometimes necessary when "
3025 "running APT for the first time; APT itself does not allow broken package "
3026 "dependencies to exist on a system. It is possible that a system's dependency "
3027 "structure can be so corrupt as to require manual intervention (which usually "
3028 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
3029 "of the offending packages). Use of this option together with "
3030 "<option>-m</option> may produce an error in some situations. Configuration "
3031 "Item: <literal>APT::Get::Fix-Broken</literal>."
3034 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3035 #: apt-get.8.xml:292
3036 msgid "<option>--ignore-missing</option>"
3039 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3040 #: apt-get.8.xml:293
3041 msgid "<option>--fix-missing</option>"
3044 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3045 #: apt-get.8.xml:294
3047 "Ignore missing packages; If packages cannot be retrieved or fail the "
3048 "integrity check after retrieval (corrupted package files), hold back those "
3049 "packages and handle the result. Use of this option together with "
3050 "<option>-f</option> may produce an error in some situations. If a package is "
3051 "selected for installation (particularly if it is mentioned on the command "
3052 "line) and it could not be downloaded then it will be silently held back. "
3053 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
3056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3057 #: apt-get.8.xml:304
3058 msgid "<option>--no-download</option>"
3061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3062 #: apt-get.8.xml:305
3064 "Disables downloading of packages. This is best used with "
3065 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
3066 "already downloaded. Configuration Item: "
3067 "<literal>APT::Get::Download</literal>."
3070 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3071 #: apt-get.8.xml:312
3073 "Quiet; produces output suitable for logging, omitting progress indicators. "
3074 "More q's will produce more quiet up to a maximum of 2. You can also use "
3075 "<option>-q=#</option> to set the quiet level, overriding the configuration "
3076 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
3077 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
3078 "may decided to do something you did not expect. Configuration Item: "
3079 "<literal>quiet</literal>."
3082 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3083 #: apt-get.8.xml:322
3084 msgid "<option>--simulate</option>"
3087 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3088 #: apt-get.8.xml:324
3089 msgid "<option>--dry-run</option>"
3092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3093 #: apt-get.8.xml:327
3095 "No action; perform a simulation of events that would occur but do not "
3096 "actually change the system. Configuration Item: "
3097 "<literal>APT::Get::Simulate</literal>."
3100 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3101 #: apt-get.8.xml:331
3103 "Simulation run as user will deactivate locking "
3104 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
3105 "displayed indicating that this is only a simulation, if the option "
3106 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
3107 "true). Neither NoLocking nor the notice will be triggered if run as root "
3108 "(root should know what he is doing without further warnings by "
3109 "<literal>apt-get</literal>)."
3112 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3113 #: apt-get.8.xml:337
3115 "Simulate prints out a series of lines each one representing a dpkg "
3116 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
3117 "indicate broken packages and empty set of square brackets meaning breaks "
3118 "that are of no consequence (rare)."
3121 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3122 #: apt-get.8.xml:344
3123 msgid "<option>-y</option>"
3126 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3127 #: apt-get.8.xml:344
3128 msgid "<option>--yes</option>"
3131 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3132 #: apt-get.8.xml:345
3133 msgid "<option>--assume-yes</option>"
3136 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3137 #: apt-get.8.xml:346
3139 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
3140 "non-interactively. If an undesirable situation, such as changing a held "
3141 "package, trying to install a unauthenticated package or removing an "
3142 "essential package occurs then <literal>apt-get</literal> will abort. "
3143 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
3146 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3147 #: apt-get.8.xml:353
3148 msgid "<option>--assume-no</option>"
3151 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3152 #: apt-get.8.xml:354
3154 "Automatic \"no\" to all prompts. Configuration Item: "
3155 "<literal>APT::Get::Assume-No</literal>."
3158 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3159 #: apt-get.8.xml:358
3160 msgid "<option>-u</option>"
3163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3164 #: apt-get.8.xml:358
3165 msgid "<option>--show-upgraded</option>"
3168 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3169 #: apt-get.8.xml:359
3171 "Show upgraded packages; Print out a list of all packages that are to be "
3172 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
3175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3176 #: apt-get.8.xml:364
3177 msgid "<option>-V</option>"
3180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3181 #: apt-get.8.xml:364
3182 msgid "<option>--verbose-versions</option>"
3185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3186 #: apt-get.8.xml:365
3188 "Show full versions for upgraded and installed packages. Configuration Item: "
3189 "<literal>APT::Get::Show-Versions</literal>."
3192 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3193 #: apt-get.8.xml:370
3194 msgid "<option>--host-architecture</option>"
3197 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3198 #: apt-get.8.xml:371
3200 "This option controls the architecture packages are built for by "
3201 "<command>apt-get source --compile</command> and how cross-builddependencies "
3202 "are satisfied. By default is it not set which means that the host "
3203 "architecture is the same as the build architecture (which is defined by "
3204 "<literal>APT::Architecture</literal>). Configuration Item: "
3205 "<literal>APT::Get::Host-Architecture</literal>"
3208 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3209 #: apt-get.8.xml:379
3210 msgid "<option>-b</option>"
3213 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3214 #: apt-get.8.xml:379
3215 msgid "<option>--compile</option>"
3218 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3219 #: apt-get.8.xml:380
3220 msgid "<option>--build</option>"
3223 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3224 #: apt-get.8.xml:381
3226 "Compile source packages after downloading them. Configuration Item: "
3227 "<literal>APT::Get::Compile</literal>."
3230 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3231 #: apt-get.8.xml:385
3232 msgid "<option>--ignore-hold</option>"
3235 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3236 #: apt-get.8.xml:386
3238 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
3239 "hold placed on a package. This may be useful in conjunction with "
3240 "<literal>dist-upgrade</literal> to override a large number of undesired "
3241 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
3244 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3245 #: apt-get.8.xml:392
3246 msgid "<option>--no-upgrade</option>"
3249 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3250 #: apt-get.8.xml:393
3252 "Do not upgrade packages; When used in conjunction with "
3253 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
3254 "packages on the command line from being upgraded if they are already "
3255 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
3258 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3259 #: apt-get.8.xml:399
3260 msgid "<option>--only-upgrade</option>"
3263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3264 #: apt-get.8.xml:400
3266 "Do not install new packages; When used in conjunction with "
3267 "<literal>install</literal>, <literal>only-upgrade</literal> will prevent "
3268 "packages on the command line from being upgraded if they are not already "
3269 "installed. Configuration Item: <literal>APT::Get::Only-Upgrade</literal>."
3272 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3273 #: apt-get.8.xml:406
3274 msgid "<option>--force-yes</option>"
3277 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3278 #: apt-get.8.xml:407
3280 "Force yes; This is a dangerous option that will cause apt to continue "
3281 "without prompting if it is doing something potentially harmful. It should "
3282 "not be used except in very special situations. Using "
3283 "<literal>force-yes</literal> can potentially destroy your system! "
3284 "Configuration Item: <literal>APT::Get::force-yes</literal>."
3287 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3288 #: apt-get.8.xml:414
3289 msgid "<option>--print-uris</option>"
3292 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3293 #: apt-get.8.xml:415
3295 "Instead of fetching the files to install their URIs are printed. Each URI "
3296 "will have the path, the destination file name, the size and the expected md5 "
3297 "hash. Note that the file name to write to will not always match the file "
3298 "name on the remote site! This also works with the <literal>source</literal> "
3299 "and <literal>update</literal> commands. When used with the "
3300 "<literal>update</literal> command the MD5 and size are not included, and it "
3301 "is up to the user to decompress any compressed files. Configuration Item: "
3302 "<literal>APT::Get::Print-URIs</literal>."
3305 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3306 #: apt-get.8.xml:425
3307 msgid "<option>--purge</option>"
3310 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3311 #: apt-get.8.xml:426
3313 "Use purge instead of remove for anything that would be removed. An asterisk "
3314 "(\"*\") will be displayed next to packages which are scheduled to be "
3315 "purged. <option>remove --purge</option> is equivalent to the "
3316 "<option>purge</option> command. Configuration Item: "
3317 "<literal>APT::Get::Purge</literal>."
3320 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3321 #: apt-get.8.xml:433
3322 msgid "<option>--reinstall</option>"
3325 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3326 #: apt-get.8.xml:434
3328 "Re-Install packages that are already installed and at the newest version. "
3329 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
3332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3333 #: apt-get.8.xml:438
3334 msgid "<option>--list-cleanup</option>"
3337 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3338 #: apt-get.8.xml:439
3340 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
3341 "it off. When on <command>apt-get</command> will automatically manage the "
3342 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
3343 "files are erased. The only reason to turn it off is if you frequently "
3344 "change your source list. Configuration Item: "
3345 "<literal>APT::Get::List-Cleanup</literal>."
3348 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3349 #: apt-get.8.xml:448
3350 msgid "<option>--target-release</option>"
3353 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3354 #: apt-get.8.xml:449
3355 msgid "<option>--default-release</option>"
3358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3359 #: apt-get.8.xml:450
3361 "This option controls the default input to the policy engine, it creates a "
3362 "default pin at priority 990 using the specified release string. This "
3363 "overrides the general settings in "
3364 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
3365 "not affected by the value of this option. In short, this option lets you "
3366 "have simple control over which distribution packages will be retrieved "
3367 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
3368 "unstable</option> or <option>-t sid</option>. Configuration Item: "
3369 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
3373 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3374 #: apt-get.8.xml:463
3375 msgid "<option>--trivial-only</option>"
3378 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3379 #: apt-get.8.xml:465
3381 "Only perform operations that are 'trivial'. Logically this can be considered "
3382 "related to <option>--assume-yes</option>, where "
3383 "<option>--assume-yes</option> will answer yes to any prompt, "
3384 "<option>--trivial-only</option> will answer no. Configuration Item: "
3385 "<literal>APT::Get::Trivial-Only</literal>."
3388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3389 #: apt-get.8.xml:471
3390 msgid "<option>--no-remove</option>"
3393 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3394 #: apt-get.8.xml:472
3396 "If any packages are to be removed apt-get immediately aborts without "
3397 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
3400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3401 #: apt-get.8.xml:477
3402 msgid "<option>--auto-remove</option>"
3405 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3406 #: apt-get.8.xml:478
3408 "If the command is either <literal>install</literal> or "
3409 "<literal>remove</literal>, then this option acts like running "
3410 "<literal>autoremove</literal> command, removing the unused dependency "
3411 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
3414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3415 #: apt-get.8.xml:484
3416 msgid "<option>--only-source</option>"
3419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3420 #: apt-get.8.xml:485
3422 "Only has meaning for the <literal>source</literal> and "
3423 "<literal>build-dep</literal> commands. Indicates that the given source "
3424 "names are not to be mapped through the binary table. This means that if "
3425 "this option is specified, these commands will only accept source package "
3426 "names as arguments, rather than accepting binary package names and looking "
3427 "up the corresponding source package. Configuration Item: "
3428 "<literal>APT::Get::Only-Source</literal>."
3431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3432 #: apt-get.8.xml:495
3433 msgid "<option>--diff-only</option>"
3436 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3437 #: apt-get.8.xml:495
3438 msgid "<option>--dsc-only</option>"
3441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3442 #: apt-get.8.xml:495
3443 msgid "<option>--tar-only</option>"
3446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3447 #: apt-get.8.xml:496
3449 "Download only the diff, dsc, or tar file of a source archive. Configuration "
3450 "Item: <literal>APT::Get::Diff-Only</literal>, "
3451 "<literal>APT::Get::Dsc-Only</literal>, and "
3452 "<literal>APT::Get::Tar-Only</literal>."
3455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3456 #: apt-get.8.xml:501
3457 msgid "<option>--arch-only</option>"
3460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3461 #: apt-get.8.xml:502
3463 "Only process architecture-dependent build-dependencies. Configuration Item: "
3464 "<literal>APT::Get::Arch-Only</literal>."
3467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3468 #: apt-get.8.xml:506
3469 msgid "<option>--allow-unauthenticated</option>"
3472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3473 #: apt-get.8.xml:507
3475 "Ignore if packages can't be authenticated and don't prompt about it. This "
3476 "is useful for tools like pbuilder. Configuration Item: "
3477 "<literal>APT::Get::AllowUnauthenticated</literal>."
3480 #. type: Content of: <refentry><refsect1><variablelist>
3481 #: apt-get.8.xml:520
3483 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
3487 #. type: Content of: <refentry><refsect1><para>
3488 #: apt-get.8.xml:529
3490 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
3491 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
3492 "&apt-preferences;, the APT Howto."
3495 #. type: Content of: <refentry><refsect1><para>
3496 #: apt-get.8.xml:535
3498 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
3502 #. type: Content of: <refentry><refsect1><title>
3503 #: apt-get.8.xml:538
3504 msgid "ORIGINAL AUTHORS"
3507 #. type: Content of: <refentry><refsect1><para>
3508 #: apt-get.8.xml:539
3509 msgid "&apt-author.jgunthorpe;"
3512 #. type: Content of: <refentry><refsect1><title>
3513 #: apt-get.8.xml:542
3514 msgid "CURRENT AUTHORS"
3517 #. type: Content of: <refentry><refsect1><para>
3518 #: apt-get.8.xml:544
3519 msgid "&apt-author.team;"
3522 #. type: Content of: <refentry><refnamediv><refname>
3523 #: apt-key.8.xml:17 apt-key.8.xml:24
3527 #. type: Content of: <refentry><refnamediv><refpurpose>
3529 msgid "APT key management utility"
3532 #. type: Content of: <refentry><refsect1><para>
3535 "<command>apt-key</command> is used to manage the list of keys used by apt to "
3536 "authenticate packages. Packages which have been authenticated using these "
3537 "keys will be considered trusted."
3540 #. type: Content of: <refentry><refsect1><title>
3545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3547 msgid "add &synopsis-param-filename;"
3550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3553 "Add a new key to the list of trusted keys. The key is read from "
3554 "&synopsis-param-filename;, or standard input if &synopsis-param-filename; is "
3555 "<literal>-</literal>."
3558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3560 msgid "del &synopsis-param-keyid;"
3563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3565 msgid "Remove a key from the list of trusted keys."
3568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3570 msgid "export &synopsis-param-keyid;"
3573 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3575 msgid "Output the key &synopsis-param-keyid; to standard output."
3578 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3585 msgid "Output all trusted keys to standard output."
3588 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3595 msgid "List trusted keys."
3598 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3603 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3604 #: apt-key.8.xml:100
3605 msgid "List fingerprints of trusted keys."
3608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3609 #: apt-key.8.xml:107
3613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3614 #: apt-key.8.xml:111
3616 "Pass advanced options to gpg. With adv --recv-key you can download the "
3620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3621 #: apt-key.8.xml:123
3623 "Update the local keyring with the archive keyring and remove from the local "
3624 "keyring the archive keys which are no longer valid. The archive keyring is "
3625 "shipped in the <literal>archive-keyring</literal> package of your "
3626 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
3630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3631 #: apt-key.8.xml:133
3635 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3636 #: apt-key.8.xml:137
3638 "Work similar to the <command>update</command> command above, but get the "
3639 "archive keyring from an URI instead and validate it against a master key. "
3640 "This requires an installed &wget; and an APT build configured to have a "
3641 "server to fetch from and a master keyring to validate. APT in Debian does "
3642 "not support this command and relies on <command>update</command> instead, "
3643 "but Ubuntu's APT does."
3646 #. type: Content of: <refentry><refsect1><para>
3647 #: apt-key.8.xml:154
3649 "Note that options need to be defined before the commands described in the "
3653 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3654 #: apt-key.8.xml:156
3655 msgid "--keyring &synopsis-param-filename;"
3658 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3659 #: apt-key.8.xml:157
3661 "With this option it is possible to specify a specific keyring file the "
3662 "command should operate on. The default is that a command is executed on the "
3663 "<filename>trusted.gpg</filename> file as well as on all parts in the "
3664 "<filename>trusted.gpg.d</filename> directory, though "
3665 "<filename>trusted.gpg</filename> is the primary keyring which means that "
3666 "e.g. new keys are added to this one."
3669 #. type: Content of: <refentry><refsect1><variablelist>
3670 #: apt-key.8.xml:170
3671 msgid "&file-trustedgpg;"
3674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3675 #: apt-key.8.xml:172
3676 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
3679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3680 #: apt-key.8.xml:173
3681 msgid "Local trust database of archive keys."
3684 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3685 #: apt-key.8.xml:176
3686 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
3689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3690 #: apt-key.8.xml:177
3691 msgid "Keyring of Debian archive trusted keys."
3694 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3695 #: apt-key.8.xml:180
3696 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
3699 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3700 #: apt-key.8.xml:181
3701 msgid "Keyring of Debian archive removed trusted keys."
3704 #. type: Content of: <refentry><refsect1><para>
3705 #: apt-key.8.xml:190
3706 msgid "&apt-get;, &apt-secure;"
3709 #. The last update date
3710 #. type: Content of: <refentry><refentryinfo>
3711 #: apt-mark.8.xml:16
3713 "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product; <date>21 "
3717 #. type: Content of: <refentry><refnamediv><refname>
3718 #: apt-mark.8.xml:25 apt-mark.8.xml:32
3722 #. type: Content of: <refentry><refnamediv><refpurpose>
3723 #: apt-mark.8.xml:33
3724 msgid "mark/unmark a package as being automatically-installed"
3727 #. type: Content of: <refentry><refsect1><para>
3728 #: apt-mark.8.xml:39
3730 "<command>apt-mark</command> will change whether a package has been marked as "
3731 "being automatically installed."
3734 #. type: Content of: <refentry><refsect1><para>
3735 #: apt-mark.8.xml:43
3737 "When you request that a package is installed, and as a result other packages "
3738 "are installed to satisfy its dependencies, the dependencies are marked as "
3739 "being automatically installed. Once these automatically installed packages "
3740 "are no longer depended on by any manually installed packages, they will be "
3741 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
3744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3745 #: apt-mark.8.xml:51
3749 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3750 #: apt-mark.8.xml:52
3752 "<literal>auto</literal> is used to mark a package as being automatically "
3753 "installed, which will cause the package to be removed when no more manually "
3754 "installed packages depend on this package."
3757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3758 #: apt-mark.8.xml:59
3762 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3763 #: apt-mark.8.xml:60
3765 "<literal>manual</literal> is used to mark a package as being manually "
3766 "installed, which will prevent the package from being automatically removed "
3767 "if no other packages depend on it."
3770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3771 #: apt-mark.8.xml:67
3775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3776 #: apt-mark.8.xml:68
3778 "<literal>hold</literal> is used to mark a package as hold back, which will "
3779 "prevent the package from being automatically installed, upgraded or "
3780 "removed. The command is only a wrapper around <command>dpkg "
3781 "--set-selections</command> and the state is therefore maintained by &dpkg; "
3782 "and not effected by the <option>--filename</option> option."
3785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3786 #: apt-mark.8.xml:77
3790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3791 #: apt-mark.8.xml:78
3793 "<literal>unhold</literal> is used to cancel a previously set hold on a "
3794 "package to allow all actions again."
3797 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3798 #: apt-mark.8.xml:83
3802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3803 #: apt-mark.8.xml:84
3805 "<literal>showauto</literal> is used to print a list of automatically "
3806 "installed packages with each package on a new line. All automatically "
3807 "installed packages will be listed if no package is given. If packages are "
3808 "given only those which are automatically installed will be shown."
3811 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3812 #: apt-mark.8.xml:91
3816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3817 #: apt-mark.8.xml:92
3819 "<literal>showmanual</literal> can be used in the same way as "
3820 "<literal>showauto</literal> except that it will print a list of manually "
3821 "installed packages instead."
3824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3825 #: apt-mark.8.xml:98
3829 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3830 #: apt-mark.8.xml:99
3832 "<literal>showhold</literal> is used to print a list of packages on hold in "
3833 "the same way as for the other show commands."
3836 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3837 #: apt-mark.8.xml:112
3838 msgid "<option>-f=<filename><replaceable>FILENAME</replaceable></filename></option>"
3841 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3842 #: apt-mark.8.xml:113
3843 msgid "<option>--file=<filename><replaceable>FILENAME</replaceable></filename></option>"
3846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3847 #: apt-mark.8.xml:116
3849 "Read/Write package stats from "
3850 "<filename><replaceable>FILENAME</replaceable></filename> instead of the "
3851 "default location, which is <filename>extended_status</filename> in the "
3852 "directory defined by the Configuration Item: <literal>Dir::State</literal>."
3855 #. type: Content of: <refentry><refsect1><variablelist>
3856 #: apt-mark.8.xml:128
3857 msgid " &file-extended_states;"
3860 #. type: Content of: <refentry><refsect1><para>
3861 #: apt-mark.8.xml:133
3862 msgid "&apt-get;,&aptitude;,&apt-conf;"
3865 #. type: Content of: <refentry><refsect1><para>
3866 #: apt-mark.8.xml:137
3868 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
3872 #. type: Content of: <refentry><refnamediv><refname>
3873 #: apt-secure.8.xml:17 apt-secure.8.xml:39
3877 #. type: Content of: <refentry><refnamediv><refpurpose>
3878 #: apt-secure.8.xml:40
3879 msgid "Archive authentication support for APT"
3882 #. type: Content of: <refentry><refsect1><para>
3883 #: apt-secure.8.xml:45
3885 "Starting with version 0.6, <command>apt</command> contains code that does "
3886 "signature checking of the Release file for all archives. This ensures that "
3887 "packages in the archive can't be modified by people who have no access to "
3888 "the Release file signing key."
3891 #. type: Content of: <refentry><refsect1><para>
3892 #: apt-secure.8.xml:53
3894 "If a package comes from a archive without a signature or with a signature "
3895 "that apt does not have a key for that package is considered untrusted and "
3896 "installing it will result in a big warning. <command>apt-get</command> will "
3897 "currently only warn for unsigned archives, future releases might force all "
3898 "sources to be verified before downloading packages from them."
3901 #. type: Content of: <refentry><refsect1><para>
3902 #: apt-secure.8.xml:62
3904 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
3905 "authentication feature."
3908 #. type: Content of: <refentry><refsect1><title>
3909 #: apt-secure.8.xml:67
3910 msgid "Trusted archives"
3913 #. type: Content of: <refentry><refsect1><para>
3914 #: apt-secure.8.xml:70
3916 "The chain of trust from an apt archive to the end user is made up of "
3917 "different steps. <command>apt-secure</command> is the last step in this "
3918 "chain, trusting an archive does not mean that the packages that you trust it "
3919 "do not contain malicious code but means that you trust the archive "
3920 "maintainer. It's the archive maintainer responsibility to ensure that the "
3921 "archive integrity is correct."
3924 #. type: Content of: <refentry><refsect1><para>
3925 #: apt-secure.8.xml:78
3927 "apt-secure does not review signatures at a package level. If you require "
3928 "tools to do this you should look at <command>debsig-verify</command> and "
3929 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3930 "packages respectively)."
3933 #. type: Content of: <refentry><refsect1><para>
3934 #: apt-secure.8.xml:85
3936 "The chain of trust in Debian starts when a maintainer uploads a new package "
3937 "or a new version of a package to the Debian archive. This upload in order to "
3938 "become effective needs to be signed by a key of a maintainer within the "
3939 "Debian maintainer's keyring (available in the debian-keyring "
3940 "package). Maintainer's keys are signed by other maintainers following "
3941 "pre-established procedures to ensure the identity of the key holder."
3944 #. type: Content of: <refentry><refsect1><para>
3945 #: apt-secure.8.xml:95
3947 "Once the uploaded package is verified and included in the archive, the "
3948 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3949 "and put in the Packages file. The MD5 sum of all of the packages files are "
3950 "then computed and put into the Release file. The Release file is then signed "
3951 "by the archive key (which is created once a year) and distributed through "
3952 "the FTP server. This key is also on the Debian keyring."
3955 #. type: Content of: <refentry><refsect1><para>
3956 #: apt-secure.8.xml:105
3958 "Any end user can check the signature of the Release file, extract the MD5 "
3959 "sum of a package from it and compare it with the MD5 sum of the package he "
3960 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3961 "package was checked. Now both the MD5 sum and the signature of the Release "
3965 #. type: Content of: <refentry><refsect1><para>
3966 #: apt-secure.8.xml:112
3968 "Notice that this is distinct from checking signatures on a per package "
3969 "basis. It is designed to prevent two possible attacks:"
3972 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3973 #: apt-secure.8.xml:117
3975 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3976 "checking, a malicious agent can introduce himself in the package download "
3977 "process and provide malicious software either by controlling a network "
3978 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3979 "(through arp or DNS spoofing attacks)."
3982 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3983 #: apt-secure.8.xml:125
3985 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3986 "malicious agent can compromise a mirror host and modify the files in it to "
3987 "propagate malicious software to all users downloading packages from that "
3991 #. type: Content of: <refentry><refsect1><para>
3992 #: apt-secure.8.xml:132
3994 "However, it does not defend against a compromise of the Debian master server "
3995 "itself (which signs the packages) or against a compromise of the key used to "
3996 "sign the Release files. In any case, this mechanism can complement a "
3997 "per-package signature."
4000 #. type: Content of: <refentry><refsect1><title>
4001 #: apt-secure.8.xml:138
4002 msgid "User configuration"
4005 #. type: Content of: <refentry><refsect1><para>
4006 #: apt-secure.8.xml:140
4008 "<command>apt-key</command> is the program that manages the list of keys used "
4009 "by apt. It can be used to add or remove keys although an installation of "
4010 "this release will automatically provide the default Debian archive signing "
4011 "keys used in the Debian package repositories."
4014 #. type: Content of: <refentry><refsect1><para>
4015 #: apt-secure.8.xml:147
4017 "In order to add a new key you need to first download it (you should make "
4018 "sure you are using a trusted communication channel when retrieving it), add "
4019 "it with <command>apt-key</command> and then run <command>apt-get "
4020 "update</command> so that apt can download and verify the "
4021 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
4022 "from the archives you have configured."
4025 #. type: Content of: <refentry><refsect1><title>
4026 #: apt-secure.8.xml:156
4027 msgid "Archive configuration"
4030 #. type: Content of: <refentry><refsect1><para>
4031 #: apt-secure.8.xml:158
4033 "If you want to provide archive signatures in an archive under your "
4034 "maintenance you have to:"
4037 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4038 #: apt-secure.8.xml:163
4040 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
4041 "already. You can do this by running <command>apt-ftparchive "
4042 "release</command> (provided in apt-utils)."
4045 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4046 #: apt-secure.8.xml:168
4048 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
4049 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
4050 "Release.gpg Release</command>."
4053 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4054 #: apt-secure.8.xml:172
4056 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
4057 "know what key they need to import in order to authenticate the files in the "
4061 #. type: Content of: <refentry><refsect1><para>
4062 #: apt-secure.8.xml:179
4064 "Whenever the contents of the archive changes (new packages are added or "
4065 "removed) the archive maintainer has to follow the first two steps previously "
4069 #. type: Content of: <refentry><refsect1><para>
4070 #: apt-secure.8.xml:187
4072 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
4073 "&debsign; &debsig-verify;, &gpg;"
4076 #. type: Content of: <refentry><refsect1><para>
4077 #: apt-secure.8.xml:191
4079 "For more background information you might want to review the <ulink "
4080 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7\">Debian "
4081 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
4082 "(available also in the harden-doc package) and the <ulink "
4083 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
4084 "Distribution HOWTO</ulink> by V. Alex Brennen."
4087 #. type: Content of: <refentry><refsect1><title>
4088 #: apt-secure.8.xml:204
4089 msgid "Manpage Authors"
4092 #. type: Content of: <refentry><refsect1><para>
4093 #: apt-secure.8.xml:206
4095 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
4096 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
4099 #. type: Content of: <refentry><refnamediv><refname>
4100 #: apt-sortpkgs.1.xml:25 apt-sortpkgs.1.xml:32
4101 msgid "apt-sortpkgs"
4104 #. type: Content of: <refentry><refnamediv><refpurpose>
4105 #: apt-sortpkgs.1.xml:33
4106 msgid "Utility to sort package index files"
4109 #. type: Content of: <refentry><refsect1><para>
4110 #: apt-sortpkgs.1.xml:39
4112 "<command>apt-sortpkgs</command> will take an index file (Source index or "
4113 "Package index) and sort the records so that they are ordered by the package "
4114 "name. It will also sort the internal fields of each record according to the "
4115 "internal sorting rules."
4118 #. type: Content of: <refentry><refsect1><para>
4119 #: apt-sortpkgs.1.xml:45
4120 msgid "All output is sent to stdout, the input must be a seekable file."
4123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4124 #: apt-sortpkgs.1.xml:52
4125 msgid "<option>--source</option>"
4128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4129 #: apt-sortpkgs.1.xml:54
4131 "Use Source index field ordering. Configuration Item: "
4132 "<literal>APT::SortPkgs::Source</literal>."
4135 #. type: Content of: <refentry><refsect1><para>
4136 #: apt-sortpkgs.1.xml:68
4138 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
4142 #. The last update date
4143 #. type: Content of: <refentry><refentryinfo>
4144 #: apt.conf.5.xml:16
4146 "&apt-author.jgunthorpe; &apt-author.team; <author> "
4147 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
4148 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
4149 "</author> &apt-email; &apt-product; <date>16 January 2010</date>"
4152 #. type: Content of: <refentry><refnamediv><refname>
4153 #: apt.conf.5.xml:31 apt.conf.5.xml:38
4157 #. type: Content of: <refentry><refmeta><manvolnum>
4158 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
4162 #. type: Content of: <refentry><refnamediv><refpurpose>
4163 #: apt.conf.5.xml:39
4164 msgid "Configuration file for APT"
4167 #. type: Content of: <refentry><refsect1><para>
4168 #: apt.conf.5.xml:43
4170 "<filename>apt.conf</filename> is the main configuration file for the APT "
4171 "suite of tools, but by far not the only place changes to options can be "
4172 "made. All tools therefore share the configuration files and also use a "
4173 "common command line parser to provide a uniform environment."
4176 #. type: Content of: <refentry><refsect1><orderedlist><para>
4177 #: apt.conf.5.xml:48
4179 "When an APT tool starts up it will read the configuration files in the "
4183 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4184 #: apt.conf.5.xml:50
4186 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
4190 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4191 #: apt.conf.5.xml:52
4193 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
4194 "order which have either no or \"<literal>conf</literal>\" as filename "
4195 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
4196 "and period (.) characters. Otherwise APT will print a notice that it has "
4197 "ignored a file if the file doesn't match a pattern in the "
4198 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
4199 "case it will be silently ignored."
4202 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4203 #: apt.conf.5.xml:59
4204 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
4207 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4208 #: apt.conf.5.xml:61
4210 "the command line options are applied to override the configuration "
4211 "directives or to load even more configuration files."
4214 #. type: Content of: <refentry><refsect1><title>
4215 #: apt.conf.5.xml:65
4219 #. type: Content of: <refentry><refsect1><para>
4220 #: apt.conf.5.xml:66
4222 "The configuration file is organized in a tree with options organized into "
4223 "functional groups. Option specification is given with a double colon "
4224 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
4225 "within the APT tool group, for the Get tool. Options do not inherit from "
4226 "their parent groups."
4229 #. type: Content of: <refentry><refsect1><para>
4230 #: apt.conf.5.xml:72
4232 "Syntactically the configuration language is modeled after what the ISC tools "
4233 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
4234 "treated as comments (ignored), as well as all text between "
4235 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
4236 "Each line is of the form <literal>APT::Get::Assume-Yes "
4237 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
4238 "value must be on one line, and there is no kind of string concatenation. It "
4239 "must not include inside quotes. The behavior of the backslash \"\\\" and "
4240 "escaped characters inside a value is undefined and it should not be used. An "
4241 "option name may include alphanumerical characters and the \"/-:._+\" "
4242 "characters. A new scope can be opened with curly braces, like:"
4245 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4246 #: apt.conf.5.xml:86
4251 " Assume-Yes \"true\";\n"
4252 " Fix-Broken \"true\";\n"
4257 #. type: Content of: <refentry><refsect1><para>
4258 #: apt.conf.5.xml:94
4260 "with newlines placed to make it more readable. Lists can be created by "
4261 "opening a scope and including a single string enclosed in quotes followed by "
4262 "a semicolon. Multiple entries can be included, each separated by a "
4266 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4267 #: apt.conf.5.xml:99
4269 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
4272 #. type: Content of: <refentry><refsect1><para>
4273 #: apt.conf.5.xml:102
4275 "In general the sample configuration file in "
4276 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
4277 "guide for how it should look."
4280 #. type: Content of: <refentry><refsect1><para>
4281 #: apt.conf.5.xml:106
4283 "The names of the configuration items are not case-sensitive. So in the "
4284 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
4287 #. type: Content of: <refentry><refsect1><para>
4288 #: apt.conf.5.xml:109
4290 "Names for the configuration items are optional if a list is defined as it "
4291 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
4292 "above. If you don't specify a name a new entry will simply add a new option "
4293 "to the list. If you specify a name you can override the option as every "
4294 "other option by reassigning a new value to the option."
4297 #. type: Content of: <refentry><refsect1><para>
4298 #: apt.conf.5.xml:114
4300 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
4301 "and not supported by alternative implementations) and "
4302 "<literal>#clear</literal>: <literal>#include</literal> will include the "
4303 "given file, unless the filename ends in a slash, then the whole directory is "
4304 "included. <literal>#clear</literal> is used to erase a part of the "
4305 "configuration tree. The specified element and all its descendants are "
4306 "erased. (Note that these lines also need to end with a semicolon.)"
4309 #. type: Content of: <refentry><refsect1><para>
4310 #: apt.conf.5.xml:122
4312 "The #clear command is the only way to delete a list or a complete scope. "
4313 "Reopening a scope or the ::-style described below will "
4314 "<emphasis>not</emphasis> override previously written entries. Only options "
4315 "can be overridden by addressing a new value to it - lists and scopes can't "
4316 "be overridden, only cleared."
4319 #. type: Content of: <refentry><refsect1><para>
4320 #: apt.conf.5.xml:127
4322 "All of the APT tools take a -o option which allows an arbitrary "
4323 "configuration directive to be specified on the command line. The syntax is a "
4324 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
4325 "followed by an equals sign then the new value of the option. Lists can be "
4326 "appended too by adding a trailing :: to the list name. (As you might "
4327 "suspect: The scope syntax can't be used on the command line.)"
4330 #. type: Content of: <refentry><refsect1><para>
4331 #: apt.conf.5.xml:134
4333 "Note that you can use :: only for appending one item per line to a list and "
4334 "that you should not use it in combination with the scope syntax. (The scope "
4335 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
4336 "which some users unfortunately relay on: An option with the unusual name "
4337 "\"<literal>::</literal>\" which acts like every other option with a "
4338 "name. These introduces many problems including that a user who writes "
4339 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
4340 "append to a list will gain the opposite as only the last assignment for this "
4341 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
4342 "raise errors and will stop working if they encounter this misuse, so please "
4343 "correct such statements now as long as APT doesn't complain explicit about "
4347 #. type: Content of: <refentry><refsect1><title>
4348 #: apt.conf.5.xml:146
4349 msgid "The APT Group"
4352 #. type: Content of: <refentry><refsect1><para>
4353 #: apt.conf.5.xml:147
4355 "This group of options controls general APT behavior as well as holding the "
4356 "options for all of the tools."
4359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4360 #: apt.conf.5.xml:151
4361 msgid "Architecture"
4364 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4365 #: apt.conf.5.xml:152
4367 "System Architecture; sets the architecture to use when fetching files and "
4368 "parsing package lists. The internal default is the architecture apt was "
4372 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4373 #: apt.conf.5.xml:158
4375 "All Architectures the system supports. Processors implementing the "
4376 "<literal>amd64</literal> are e.g. also able to execute binaries compiled for "
4377 "<literal>i386</literal>; This list is use when fetching files and parsing "
4378 "package lists. The internal default is always the native architecture "
4379 "(<literal>APT::Architecture</literal>) and all foreign architectures it can "
4380 "retrieve by calling <command>dpkg --print-foreign-architectures</command>."
4383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4384 #: apt.conf.5.xml:165
4385 msgid "Default-Release"
4388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4389 #: apt.conf.5.xml:166
4391 "Default release to install packages from if more than one version "
4392 "available. Contains release name, codename or release version. Examples: "
4393 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
4394 "'4.0', '5.0*'. See also &apt-preferences;."
4397 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4398 #: apt.conf.5.xml:171
4402 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4403 #: apt.conf.5.xml:172
4405 "Ignore Held packages; This global option causes the problem resolver to "
4406 "ignore held packages in its decision making."
4409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4410 #: apt.conf.5.xml:176
4411 msgid "Clean-Installed"
4414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4415 #: apt.conf.5.xml:177
4417 "Defaults to on. When turned on the autoclean feature will remove any "
4418 "packages which can no longer be downloaded from the cache. If turned off "
4419 "then packages that are locally installed are also excluded from cleaning - "
4420 "but note that APT provides no direct means to reinstall them."
4423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4424 #: apt.conf.5.xml:183
4425 msgid "Immediate-Configure"
4428 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4429 #: apt.conf.5.xml:184
4431 "Defaults to on which will cause APT to install essential and important "
4432 "packages as fast as possible in the install/upgrade operation. This is done "
4433 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
4434 "does treat an important package in the same way as an extra package: Between "
4435 "the unpacking of the important package A and his configuration can then be "
4436 "many other unpack or configuration calls, e.g. for package B which has no "
4437 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
4438 "script of package B generates an error) which results in a system state in "
4439 "which package A is unpacked but unconfigured - each package depending on A "
4440 "is now no longer guaranteed to work as their dependency on A is not longer "
4441 "satisfied. The immediate configuration marker is also applied to all "
4442 "dependencies which can generate a problem if the dependencies e.g. form a "
4443 "circle as a dependency with the immediate flag is comparable with a "
4444 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
4445 "in which it is unable to perform immediate configuration, errors out and "
4446 "refers to this option so the user can deactivate the immediate configuration "
4447 "temporarily to be able to perform an install/upgrade again. Note the use of "
4448 "the word \"theory\" here as this problem was only encountered by now in real "
4449 "world a few times in non-stable distribution versions and was caused by "
4450 "wrong dependencies of the package in question or by a system in an already "
4451 "broken state, so you should not blindly disable this option as the mentioned "
4452 "scenario above is not the only problem immediate configuration can help to "
4453 "prevent in the first place. Before a big operation like "
4454 "<literal>dist-upgrade</literal> is run with this option disabled it should "
4455 "be tried to explicitly <literal>install</literal> the package APT is unable "
4456 "to configure immediately, but please make sure to report your problem also "
4457 "to your distribution and to the APT team with the buglink below so they can "
4458 "work on improving or correcting the upgrade process."
4461 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4462 #: apt.conf.5.xml:206
4463 msgid "Force-LoopBreak"
4466 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4467 #: apt.conf.5.xml:207
4469 "Never Enable this option unless you -really- know what you are doing. It "
4470 "permits APT to temporarily remove an essential package to break a "
4471 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
4472 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
4473 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
4474 "anything that those packages depend on."
4477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4478 #: apt.conf.5.xml:215
4479 msgid "Cache-Start, Cache-Grow and Cache-Limit"
4482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4483 #: apt.conf.5.xml:216
4485 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
4486 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
4487 "to which size the Cache will grow and is therefore the amount of memory APT "
4488 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
4489 "that these amount of space need to be available for APT otherwise it will "
4490 "likely fail ungracefully, so for memory restricted devices these value "
4491 "should be lowered while on systems with a lot of configured sources this "
4492 "might be increased. <literal>Cache-Grow</literal> defines in byte with the "
4493 "default of 1048576 (~1 MB) how much the Cache size will be increased in the "
4494 "event the space defined by <literal>Cache-Start</literal> is not "
4495 "enough. These value will be applied again and again until either the cache "
4496 "is big enough to store all information or the size of the cache reaches the "
4497 "<literal>Cache-Limit</literal>. The default of "
4498 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
4499 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
4503 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4504 #: apt.conf.5.xml:231
4505 msgid "Build-Essential"
4508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4509 #: apt.conf.5.xml:232
4510 msgid "Defines which package(s) are considered essential build dependencies."
4513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4514 #: apt.conf.5.xml:235
4518 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4519 #: apt.conf.5.xml:236
4521 "The Get subsection controls the &apt-get; tool, please see its documentation "
4522 "for more information about the options here."
4525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4526 #: apt.conf.5.xml:240
4530 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4531 #: apt.conf.5.xml:241
4533 "The Cache subsection controls the &apt-cache; tool, please see its "
4534 "documentation for more information about the options here."
4537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4538 #: apt.conf.5.xml:245
4542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4543 #: apt.conf.5.xml:246
4545 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
4546 "documentation for more information about the options here."
4549 #. type: Content of: <refentry><refsect1><title>
4550 #: apt.conf.5.xml:252
4551 msgid "The Acquire Group"
4554 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4555 #: apt.conf.5.xml:257
4556 msgid "Check-Valid-Until"
4559 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4560 #: apt.conf.5.xml:258
4562 "Security related option defaulting to true as an expiring validation for a "
4563 "Release file prevents longtime replay attacks and can e.g. also help users "
4564 "to identify no longer updated mirrors - but the feature depends on the "
4565 "correctness of the time on the user system. Archive maintainers are "
4566 "encouraged to create Release files with the <literal>Valid-Until</literal> "
4567 "header, but if they don't or a stricter value is volitional the following "
4568 "<literal>Max-ValidTime</literal> option can be used."
4571 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4572 #: apt.conf.5.xml:268
4573 msgid "Max-ValidTime"
4576 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4577 #: apt.conf.5.xml:269
4579 "Seconds the Release file should be considered valid after it was created "
4580 "(indicated by the <literal>Date</literal> header). If the Release file "
4581 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
4582 "the two is used as the expiration date. The default value is "
4583 "<literal>0</literal> which stands for \"for ever\". Archive specific "
4584 "settings can be made by appending the label of the archive to the option "
4588 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4589 #: apt.conf.5.xml:279
4590 msgid "Min-ValidTime"
4593 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4594 #: apt.conf.5.xml:280
4596 "Minimum of seconds the Release file should be considered valid after it was "
4597 "created (indicated by the <literal>Date</literal> header). Use this if you "
4598 "need to use a seldomly updated (local) mirror of a more regular updated "
4599 "archive with a <literal>Valid-Until</literal> header instead of completely "
4600 "disabling the expiration date checking. Archive specific settings can and "
4601 "should be used by appending the label of the archive to the option name."
4604 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4605 #: apt.conf.5.xml:290
4609 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4610 #: apt.conf.5.xml:291
4612 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
4613 "Sources files instead of downloading whole ones. True by default."
4616 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4617 #: apt.conf.5.xml:294
4619 "Two sub-options to limit the use of PDiffs are also available: With "
4620 "<literal>FileLimit</literal> can be specified how many PDiff files are "
4621 "downloaded at most to patch a file. <literal>SizeLimit</literal> on the "
4622 "other hand is the maximum percentage of the size of all patches compared to "
4623 "the size of the targeted file. If one of these limits is exceeded the "
4624 "complete file is downloaded instead of the patches."
4627 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4628 #: apt.conf.5.xml:303
4632 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4633 #: apt.conf.5.xml:304
4635 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
4636 "<literal>host</literal> or <literal>access</literal> which determines how "
4637 "APT parallelizes outgoing connections. <literal>host</literal> means that "
4638 "one connection per target host will be opened, <literal>access</literal> "
4639 "means that one connection per URI type will be opened."
4642 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4643 #: apt.conf.5.xml:311
4647 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4648 #: apt.conf.5.xml:312
4650 "Number of retries to perform. If this is non-zero APT will retry failed "
4651 "files the given number of times."
4654 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4655 #: apt.conf.5.xml:316
4656 msgid "Source-Symlinks"
4659 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4660 #: apt.conf.5.xml:317
4662 "Use symlinks for source archives. If set to true then source archives will "
4663 "be symlinked when possible instead of copying. True is the default."
4666 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4667 #: apt.conf.5.xml:321 sources.list.5.xml:160
4671 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4672 #: apt.conf.5.xml:322
4674 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
4675 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
4676 "host proxies can also be specified by using the form "
4677 "<literal>http::Proxy::<host></literal> with the special keyword "
4678 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4679 "settings is specified, <envar>http_proxy</envar> environment variable will "
4683 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4684 #: apt.conf.5.xml:330
4686 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
4687 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
4688 "response under any circumstances, <literal>Max-Age</literal> is sent only "
4689 "for index files and tells the cache to refresh its object if it is older "
4690 "than the given number of seconds. Debian updates its index files daily so "
4691 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
4692 "should never store this request, it is only set for archive files. This may "
4693 "be useful to prevent polluting a proxy cache with very large .deb "
4694 "files. Note: Squid 2.0.2 does not support any of these options."
4697 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4698 #: apt.conf.5.xml:340 apt.conf.5.xml:404
4700 "The option <literal>timeout</literal> sets the timeout timer used by the "
4701 "method, this applies to all things including connection timeout and data "
4705 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4706 #: apt.conf.5.xml:343
4708 "One setting is provided to control the pipeline depth in cases where the "
4709 "remote server is not RFC conforming or buggy (such as Squid 2.0.2). "
4710 "<literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5 "
4711 "indicating how many outstanding requests APT should send. A value of zero "
4712 "MUST be specified if the remote host does not properly linger on TCP "
4713 "connections - otherwise data corruption will occur. Hosts which require this "
4714 "are in violation of RFC 2068."
4717 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4718 #: apt.conf.5.xml:351
4720 "The used bandwidth can be limited with "
4721 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
4722 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
4723 "as much as possible of the bandwidth (Note that this option implicit "
4724 "deactivates the download from multiple servers at the same time.)"
4727 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4728 #: apt.conf.5.xml:356
4730 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
4731 "User-Agent for the http download method as some proxies allow access for "
4732 "clients only if the client uses a known identifier."
4735 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4736 #: apt.conf.5.xml:362
4740 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4741 #: apt.conf.5.xml:363
4743 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
4744 "options are the same as for <literal>http</literal> method and will also "
4745 "default to the options from the <literal>http</literal> method if they are "
4746 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
4747 "not supported yet."
4750 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4751 #: apt.conf.5.xml:369
4753 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
4754 "about trusted certificates. <literal><host>::CaInfo</literal> is "
4755 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
4756 "suboption determines whether verify server's host certificate against "
4757 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
4758 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
4759 "suboption determines whether verify server's hostname or not. "
4760 "<literal><host>::Verify-Host</literal> is corresponding per-host "
4761 "option. <literal>SslCert</literal> determines what certificate to use for "
4762 "client authentication. <literal><host>::SslCert</literal> is "
4763 "corresponding per-host option. <literal>SslKey</literal> determines what "
4764 "private key to use for client "
4765 "authentication. <literal><host>::SslKey</literal> is corresponding "
4766 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
4767 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
4768 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
4772 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4773 #: apt.conf.5.xml:387 sources.list.5.xml:171
4777 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4778 #: apt.conf.5.xml:388
4780 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
4781 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
4782 "proxies can also be specified by using the form "
4783 "<literal>ftp::Proxy::<host></literal> with the special keyword "
4784 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4785 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
4786 "used. To use a ftp proxy you will have to set the "
4787 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
4788 "entry specifies the commands to send to tell the proxy server what to "
4789 "connect to. Please see &configureindex; for an example of how to do "
4790 "this. The substitution variables available are "
4791 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
4792 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
4793 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
4794 "from it's respective URI component."
4797 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4798 #: apt.conf.5.xml:407
4800 "Several settings are provided to control passive mode. Generally it is safe "
4801 "to leave passive mode on, it works in nearly every environment. However "
4802 "some situations require that passive mode be disabled and port mode ftp used "
4803 "instead. This can be done globally, for connections that go through a proxy "
4804 "or for a specific host (See the sample config file for examples)."
4807 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4808 #: apt.conf.5.xml:414
4810 "It is possible to proxy FTP over HTTP by setting the "
4811 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
4812 "discussion of the http method above for syntax. You cannot set this in the "
4813 "configuration file and it is not recommended to use FTP over HTTP due to its "
4817 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4818 #: apt.conf.5.xml:419
4820 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
4821 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
4822 "false, which means these commands are only used if the control connection is "
4823 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
4824 "that most FTP servers do not support RFC2428."
4827 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4828 #: apt.conf.5.xml:426 sources.list.5.xml:153
4832 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4833 #: apt.conf.5.xml:432
4835 msgid "/cdrom/::Mount \"foo\";"
4838 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4839 #: apt.conf.5.xml:427
4841 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
4842 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
4843 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
4844 "provide alternate mount and unmount commands if your mount point cannot be "
4845 "listed in the fstab (such as an SMB mount and old mount packages). The "
4846 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
4847 "cdrom block. It is important to have the trailing slash. Unmount commands "
4848 "can be specified using UMount."
4851 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4852 #: apt.conf.5.xml:437
4856 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4857 #: apt.conf.5.xml:438
4859 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
4860 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
4864 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4865 #: apt.conf.5.xml:443
4866 msgid "CompressionTypes"
4869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4870 #: apt.conf.5.xml:449
4873 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
4874 "\"<replaceable>Methodname</replaceable>\";"
4877 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4878 #: apt.conf.5.xml:444
4880 "List of compression types which are understood by the acquire methods. "
4881 "Files like <filename>Packages</filename> can be available in various "
4882 "compression formats. Per default the acquire methods can decompress "
4883 "<command>bzip2</command>, <command>lzma</command> and "
4884 "<command>gzip</command> compressed files, with this setting more formats can "
4885 "be added on the fly or the used method can be changed. The syntax for this "
4886 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
4889 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4890 #: apt.conf.5.xml:454
4892 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
4895 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4896 #: apt.conf.5.xml:457
4898 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
4901 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4902 #: apt.conf.5.xml:450
4904 "Also the <literal>Order</literal> subgroup can be used to define in which "
4905 "order the acquire system will try to download the compressed files. The "
4906 "acquire system will try the first and proceed with the next compression type "
4907 "in this list on error, so to prefer one over the other type simple add the "
4908 "preferred type at first - not already added default types will be added at "
4909 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
4910 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
4911 "over <command>bzip2</command> and <command>lzma</command>. If "
4912 "<command>lzma</command> should be preferred over <command>gzip</command> and "
4913 "<command>bzip2</command> the configure setting should look like this "
4914 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
4915 "<literal>bz2</literal> explicit to the list as it will be added automatic."
4918 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4919 #: apt.conf.5.xml:461
4921 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
4924 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4925 #: apt.conf.5.xml:459
4927 "Note that at run time the "
4928 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
4929 "checked: If this setting exists the method will only be used if this file "
4930 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
4931 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
4932 "the command line will be added at the end of the list specified in the "
4933 "configuration files, but before the default entries. To prefer a type in "
4934 "this case over the ones specified in the configuration files you can set the "
4935 "option direct - not in list style. This will not override the defined list, "
4936 "it will only prefix the list with this type."
4939 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4940 #: apt.conf.5.xml:466
4942 "The special type <literal>uncompressed</literal> can be used to give "
4943 "uncompressed files a preference, but note that most archives don't provide "
4944 "uncompressed files so this is mostly only useable for local mirrors."
4947 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4948 #: apt.conf.5.xml:471
4952 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4953 #: apt.conf.5.xml:473
4955 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
4956 "Sources, or Translations), keep them gzip compressed locally instead of "
4957 "unpacking them. This saves quite a lot of disk space at the expense of more "
4958 "CPU requirements when building the local package caches. False by default."
4961 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4962 #: apt.conf.5.xml:480
4966 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4967 #: apt.conf.5.xml:481
4969 "The Languages subsection controls which <filename>Translation</filename> "
4970 "files are downloaded and in which order APT tries to display the "
4971 "Description-Translations. APT will try to display the first available "
4972 "Description in the Language which is listed at first. Languages can be "
4973 "defined with their short or long Languagecodes. Note that not all archives "
4974 "provide <filename>Translation</filename> files for every Language - "
4975 "especially the long Languagecodes are rare, so please inform you which ones "
4976 "are available before you set here impossible values."
4979 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
4980 #: apt.conf.5.xml:497
4982 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
4985 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4986 #: apt.conf.5.xml:487
4988 "The default list includes \"environment\" and "
4989 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
4990 "will be replaced at runtime with the languagecodes extracted from the "
4991 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
4992 "that these codes are not included twice in the list. If "
4993 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
4994 "<filename>Translation-en</filename> file (if available) will be used. To "
4995 "force apt to use no Translation file use the setting "
4996 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
4997 "another special meaning code which will stop the search for a fitting "
4998 "<filename>Translation</filename> file. This can be used by the system "
4999 "administrator to let APT know that it should download also this files "
5000 "without actually use them if the environment doesn't specify this "
5001 "languages. So the following example configuration will result in the order "
5002 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
5003 "that \"fr\" is downloaded, but not used if APT is not used in a french "
5004 "localization, in such an environment the order would be \"fr, de, en\". "
5005 "<placeholder type=\"programlisting\" id=\"0\"/>"
5008 #. type: Content of: <refentry><refsect1><para>
5009 #: apt.conf.5.xml:253
5011 "The <literal>Acquire</literal> group of options controls the download of "
5012 "packages and the URI handlers. <placeholder type=\"variablelist\" "
5016 #. type: Content of: <refentry><refsect1><title>
5017 #: apt.conf.5.xml:504
5021 #. type: Content of: <refentry><refsect1><para>
5022 #: apt.conf.5.xml:506
5024 "The <literal>Dir::State</literal> section has directories that pertain to "
5025 "local state information. <literal>lists</literal> is the directory to place "
5026 "downloaded package lists in and <literal>status</literal> is the name of the "
5027 "dpkg status file. <literal>preferences</literal> is the name of the APT "
5028 "preferences file. <literal>Dir::State</literal> contains the default "
5029 "directory to prefix on all sub items if they do not start with "
5030 "<filename>/</filename> or <filename>./</filename>."
5033 #. type: Content of: <refentry><refsect1><para>
5034 #: apt.conf.5.xml:513
5036 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
5037 "information, such as the two package caches <literal>srcpkgcache</literal> "
5038 "and <literal>pkgcache</literal> as well as the location to place downloaded "
5039 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
5040 "be turned off by setting their names to be blank. This will slow down "
5041 "startup but save disk space. It is probably preferred to turn off the "
5042 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
5043 "default directory is contained in <literal>Dir::Cache</literal>"
5046 #. type: Content of: <refentry><refsect1><para>
5047 #: apt.conf.5.xml:522
5049 "<literal>Dir::Etc</literal> contains the location of configuration files, "
5050 "<literal>sourcelist</literal> gives the location of the sourcelist and "
5051 "<literal>main</literal> is the default configuration file (setting has no "
5052 "effect, unless it is done from the config file specified by "
5053 "<envar>APT_CONFIG</envar>)."
5056 #. type: Content of: <refentry><refsect1><para>
5057 #: apt.conf.5.xml:528
5059 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
5060 "in lexical order from the directory specified. After this is done then the "
5061 "main config file is loaded."
5064 #. type: Content of: <refentry><refsect1><para>
5065 #: apt.conf.5.xml:532
5067 "Binary programs are pointed to by "
5068 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
5069 "the location of the method handlers and <literal>gzip</literal>, "
5070 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
5071 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
5072 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
5073 "specify the location of the respective programs."
5076 #. type: Content of: <refentry><refsect1><para>
5077 #: apt.conf.5.xml:540
5079 "The configuration item <literal>RootDir</literal> has a special meaning. If "
5080 "set, all paths in <literal>Dir::</literal> will be relative to "
5081 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
5082 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
5083 "set to <filename>/tmp/staging</filename> and "
5084 "<literal>Dir::State::status</literal> is set to "
5085 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
5086 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
5089 #. type: Content of: <refentry><refsect1><para>
5090 #: apt.conf.5.xml:553
5092 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
5093 "which files APT should silently ignore while parsing the files in the "
5094 "fragment directories. Per default a file which end with "
5095 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
5096 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
5097 "default value these patterns can use regular expression syntax."
5100 #. type: Content of: <refentry><refsect1><title>
5101 #: apt.conf.5.xml:562
5102 msgid "APT in DSelect"
5105 #. type: Content of: <refentry><refsect1><para>
5106 #: apt.conf.5.xml:564
5108 "When APT is used as a &dselect; method several configuration directives "
5109 "control the default behaviour. These are in the <literal>DSelect</literal> "
5113 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5114 #: apt.conf.5.xml:568
5118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5119 #: apt.conf.5.xml:569
5121 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
5122 "and never. always and prompt will remove all packages from the cache after "
5123 "upgrading, prompt (the default) does so conditionally. auto removes only "
5124 "those packages which are no longer downloadable (replaced with a new version "
5125 "for instance). pre-auto performs this action before downloading new "
5129 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5130 #: apt.conf.5.xml:578
5132 "The contents of this variable is passed to &apt-get; as command line options "
5133 "when it is run for the install phase."
5136 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5137 #: apt.conf.5.xml:582
5138 msgid "Updateoptions"
5141 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5142 #: apt.conf.5.xml:583
5144 "The contents of this variable is passed to &apt-get; as command line options "
5145 "when it is run for the update phase."
5148 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5149 #: apt.conf.5.xml:587
5150 msgid "PromptAfterUpdate"
5153 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5154 #: apt.conf.5.xml:588
5156 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
5157 "The default is to prompt only on error."
5160 #. type: Content of: <refentry><refsect1><title>
5161 #: apt.conf.5.xml:594
5162 msgid "How APT calls dpkg"
5165 #. type: Content of: <refentry><refsect1><para>
5166 #: apt.conf.5.xml:595
5168 "Several configuration directives control how APT invokes &dpkg;. These are "
5169 "in the <literal>DPkg</literal> section."
5172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5173 #: apt.conf.5.xml:600
5175 "This is a list of options to pass to dpkg. The options must be specified "
5176 "using the list notation and each list item is passed as a single argument to "
5180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5181 #: apt.conf.5.xml:605
5185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5186 #: apt.conf.5.xml:605
5190 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5191 #: apt.conf.5.xml:606
5193 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
5194 "<literal>options</literal> this must be specified in list notation. The "
5195 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5196 "fail APT will abort."
5199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5200 #: apt.conf.5.xml:612
5201 msgid "Pre-Install-Pkgs"
5204 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5205 #: apt.conf.5.xml:613
5207 "This is a list of shell commands to run before invoking dpkg. Like "
5208 "<literal>options</literal> this must be specified in list notation. The "
5209 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5210 "fail APT will abort. APT will pass to the commands on standard input the "
5211 "filenames of all .deb files it is going to install, one per line."
5214 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5215 #: apt.conf.5.xml:619
5217 "Version 2 of this protocol dumps more information, including the protocol "
5218 "version, the APT configuration space and the packages, files and versions "
5219 "being changed. Version 2 is enabled by setting "
5220 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
5221 "2. <literal>cmd</literal> is a command given to "
5222 "<literal>Pre-Install-Pkgs</literal>."
5225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5226 #: apt.conf.5.xml:626
5227 msgid "Run-Directory"
5230 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5231 #: apt.conf.5.xml:627
5233 "APT chdirs to this directory before invoking dpkg, the default is "
5234 "<filename>/</filename>."
5237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5238 #: apt.conf.5.xml:631
5239 msgid "Build-options"
5242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5243 #: apt.conf.5.xml:632
5245 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
5246 "default is to disable signing and produce all binaries."
5249 #. type: Content of: <refentry><refsect1><refsect2><title>
5250 #: apt.conf.5.xml:637
5251 msgid "dpkg trigger usage (and related options)"
5254 #. type: Content of: <refentry><refsect1><refsect2><para>
5255 #: apt.conf.5.xml:638
5257 "APT can call dpkg in a way so it can make aggressive use of triggers over "
5258 "multiple calls of dpkg. Without further options dpkg will use triggers only "
5259 "in between his own run. Activating these options can therefore decrease the "
5260 "time needed to perform the install / upgrade. Note that it is intended to "
5261 "activate these options per default in the future, but as it changes the way "
5262 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
5263 "options are therefore currently experimental and should not be used in "
5264 "productive environments.</emphasis> Also it breaks the progress reporting so "
5265 "all frontends will currently stay around half (or more) of the time in the "
5266 "100% state while it actually configures all packages."
5269 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
5270 #: apt.conf.5.xml:653
5273 "DPkg::NoTriggers \"true\";\n"
5274 "PackageManager::Configure \"smart\";\n"
5275 "DPkg::ConfigurePending \"true\";\n"
5276 "DPkg::TriggersPending \"true\";"
5279 #. type: Content of: <refentry><refsect1><refsect2><para>
5280 #: apt.conf.5.xml:647
5282 "Note that it is not guaranteed that APT will support these options or that "
5283 "these options will not cause (big) trouble in the future. If you have "
5284 "understand the current risks and problems with these options, but are brave "
5285 "enough to help testing them create a new configuration file and test a "
5286 "combination of options. Please report any bugs, problems and improvements "
5287 "you encounter and make sure to note which options you have used in your "
5288 "reports. Asking dpkg for help could also be useful for debugging proposes, "
5289 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
5290 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
5293 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5294 #: apt.conf.5.xml:659
5295 msgid "DPkg::NoTriggers"
5298 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5299 #: apt.conf.5.xml:660
5301 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
5302 "call). See &dpkg; if you are interested in what this actually means. In "
5303 "short: dpkg will not run the triggers when this flag is present unless it is "
5304 "explicitly called to do so in an extra call. Note that this option exists "
5305 "(undocumented) also in older apt versions with a slightly different meaning: "
5306 "Previously these option only append --no-triggers to the configure calls to "
5307 "dpkg - now apt will add these flag also to the unpack and remove calls."
5310 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5311 #: apt.conf.5.xml:667
5312 msgid "PackageManager::Configure"
5315 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5316 #: apt.conf.5.xml:668
5318 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
5319 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
5320 "value and causes APT to configure all packages explicit. The "
5321 "\"<literal>smart</literal>\" way is it to configure only packages which need "
5322 "to be configured before another package can be unpacked (Pre-Depends) and "
5323 "let the rest configure by dpkg with a call generated by the next "
5324 "option. \"<literal>no</literal>\" on the other hand will not configure "
5325 "anything and totally rely on dpkg for configuration (which will at the "
5326 "moment fail if a Pre-Depends is encountered). Setting this option to "
5327 "another than the all value will implicitly activate also the next option per "
5328 "default as otherwise the system could end in an unconfigured status which "
5329 "could be unbootable!"
5332 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5333 #: apt.conf.5.xml:678
5334 msgid "DPkg::ConfigurePending"
5337 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5338 #: apt.conf.5.xml:679
5340 "If this option is set apt will call <command>dpkg --configure "
5341 "--pending</command> to let dpkg handle all required configurations and "
5342 "triggers. This option is activated automatic per default if the previous "
5343 "option is not set to <literal>all</literal>, but deactivating could be "
5344 "useful if you want to run APT multiple times in a row - e.g. in an "
5345 "installer. In these sceneries you could deactivate this option in all but "
5349 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5350 #: apt.conf.5.xml:685
5351 msgid "DPkg::TriggersPending"
5354 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5355 #: apt.conf.5.xml:686
5357 "Useful for <literal>smart</literal> configuration as a package which has "
5358 "pending triggers is not considered as <literal>installed</literal> and dpkg "
5359 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
5360 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
5361 "triggers, not only the triggers needed to configure this package."
5364 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5365 #: apt.conf.5.xml:691
5366 msgid "PackageManager::UnpackAll"
5369 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5370 #: apt.conf.5.xml:692
5372 "As the configuration can be deferred to be done at the end by dpkg it can be "
5373 "tried to order the unpack series only by critical needs, e.g. by "
5374 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
5375 "various steps by everything. While both method were present in earlier APT "
5376 "versions the <literal>OrderCritical</literal> method was unused, so this "
5377 "method is very experimental and needs further improvements before becoming "
5381 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5382 #: apt.conf.5.xml:699
5383 msgid "OrderList::Score::Immediate"
5386 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
5387 #: apt.conf.5.xml:707
5390 "OrderList::Score {\n"
5392 "\tEssential 200;\n"
5394 "\tPreDepends 50;\n"
5398 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5399 #: apt.conf.5.xml:700
5401 "Essential packages (and there dependencies) should be configured immediately "
5402 "after unpacking. It will be a good idea to do this quite early in the "
5403 "upgrade process as these these configure calls require currently also "
5404 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
5405 "(which maybe not needed). Essentials get per default a high score but the "
5406 "immediate flag is relatively low (a package which has a Pre-Depends is "
5407 "higher rated). These option and the others in the same group can be used to "
5408 "change the scoring. The following example shows the settings with there "
5409 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
5412 #. type: Content of: <refentry><refsect1><title>
5413 #: apt.conf.5.xml:720
5414 msgid "Periodic and Archives options"
5417 #. type: Content of: <refentry><refsect1><para>
5418 #: apt.conf.5.xml:721
5420 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
5421 "of options configure behavior of apt periodic updates, which is done by "
5422 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
5423 "the brief documentation of these options."
5426 #. type: Content of: <refentry><refsect1><title>
5427 #: apt.conf.5.xml:729
5428 msgid "Debug options"
5431 #. type: Content of: <refentry><refsect1><para>
5432 #: apt.conf.5.xml:731
5434 "Enabling options in the <literal>Debug::</literal> section will cause "
5435 "debugging information to be sent to the standard error stream of the program "
5436 "utilizing the <literal>apt</literal> libraries, or enable special program "
5437 "modes that are primarily useful for debugging the behavior of "
5438 "<literal>apt</literal>. Most of these options are not interesting to a "
5439 "normal user, but a few may be:"
5442 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5443 #: apt.conf.5.xml:742
5445 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
5446 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
5450 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5451 #: apt.conf.5.xml:750
5453 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
5454 "used to run some operations (for instance, <literal>apt-get -s "
5455 "install</literal>) as a non-root user."
5458 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5459 #: apt.conf.5.xml:759
5461 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
5462 "time that <literal>apt</literal> invokes &dpkg;."
5466 #. motivating example, except I haven't a clue why you'd want
5468 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5469 #: apt.conf.5.xml:767
5471 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
5475 #. type: Content of: <refentry><refsect1><para>
5476 #: apt.conf.5.xml:777
5477 msgid "A full list of debugging options to apt follows."
5480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5481 #: apt.conf.5.xml:782
5482 msgid "<literal>Debug::Acquire::cdrom</literal>"
5485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5486 #: apt.conf.5.xml:786
5487 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
5490 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5491 #: apt.conf.5.xml:793
5492 msgid "<literal>Debug::Acquire::ftp</literal>"
5495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5496 #: apt.conf.5.xml:797
5497 msgid "Print information related to downloading packages using FTP."
5500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5501 #: apt.conf.5.xml:804
5502 msgid "<literal>Debug::Acquire::http</literal>"
5505 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5506 #: apt.conf.5.xml:808
5507 msgid "Print information related to downloading packages using HTTP."
5510 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5511 #: apt.conf.5.xml:815
5512 msgid "<literal>Debug::Acquire::https</literal>"
5515 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5516 #: apt.conf.5.xml:819
5517 msgid "Print information related to downloading packages using HTTPS."
5520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5521 #: apt.conf.5.xml:826
5522 msgid "<literal>Debug::Acquire::gpgv</literal>"
5525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5526 #: apt.conf.5.xml:830
5528 "Print information related to verifying cryptographic signatures using "
5529 "<literal>gpg</literal>."
5532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5533 #: apt.conf.5.xml:837
5534 msgid "<literal>Debug::aptcdrom</literal>"
5537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5538 #: apt.conf.5.xml:841
5540 "Output information about the process of accessing collections of packages "
5541 "stored on CD-ROMs."
5544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5545 #: apt.conf.5.xml:848
5546 msgid "<literal>Debug::BuildDeps</literal>"
5549 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5550 #: apt.conf.5.xml:851
5551 msgid "Describes the process of resolving build-dependencies in &apt-get;."
5554 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5555 #: apt.conf.5.xml:858
5556 msgid "<literal>Debug::Hashes</literal>"
5559 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5560 #: apt.conf.5.xml:861
5562 "Output each cryptographic hash that is generated by the "
5563 "<literal>apt</literal> libraries."
5566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5567 #: apt.conf.5.xml:868
5568 msgid "<literal>Debug::IdentCDROM</literal>"
5571 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5572 #: apt.conf.5.xml:871
5574 "Do not include information from <literal>statfs</literal>, namely the number "
5575 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
5579 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5580 #: apt.conf.5.xml:879
5581 msgid "<literal>Debug::NoLocking</literal>"
5584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5585 #: apt.conf.5.xml:882
5587 "Disable all file locking. For instance, this will allow two instances of "
5588 "<quote><literal>apt-get update</literal></quote> to run at the same time."
5591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5592 #: apt.conf.5.xml:890
5593 msgid "<literal>Debug::pkgAcquire</literal>"
5596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5597 #: apt.conf.5.xml:894
5598 msgid "Log when items are added to or removed from the global download queue."
5601 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5602 #: apt.conf.5.xml:901
5603 msgid "<literal>Debug::pkgAcquire::Auth</literal>"
5606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5607 #: apt.conf.5.xml:904
5609 "Output status messages and errors related to verifying checksums and "
5610 "cryptographic signatures of downloaded files."
5613 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5614 #: apt.conf.5.xml:911
5615 msgid "<literal>Debug::pkgAcquire::Diffs</literal>"
5618 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5619 #: apt.conf.5.xml:914
5621 "Output information about downloading and applying package index list diffs, "
5622 "and errors relating to package index list diffs."
5625 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5626 #: apt.conf.5.xml:922
5627 msgid "<literal>Debug::pkgAcquire::RRed</literal>"
5630 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5631 #: apt.conf.5.xml:926
5633 "Output information related to patching apt package lists when downloading "
5634 "index diffs instead of full indices."
5637 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5638 #: apt.conf.5.xml:933
5639 msgid "<literal>Debug::pkgAcquire::Worker</literal>"
5642 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5643 #: apt.conf.5.xml:937
5644 msgid "Log all interactions with the sub-processes that actually perform downloads."
5647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5648 #: apt.conf.5.xml:944
5649 msgid "<literal>Debug::pkgAutoRemove</literal>"
5652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5653 #: apt.conf.5.xml:948
5655 "Log events related to the automatically-installed status of packages and to "
5656 "the removal of unused packages."
5659 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5660 #: apt.conf.5.xml:955
5661 msgid "<literal>Debug::pkgDepCache::AutoInstall</literal>"
5664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5665 #: apt.conf.5.xml:958
5667 "Generate debug messages describing which packages are being automatically "
5668 "installed to resolve dependencies. This corresponds to the initial "
5669 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
5670 "and not to the full <literal>apt</literal> dependency resolver; see "
5671 "<literal>Debug::pkgProblemResolver</literal> for that."
5674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5675 #: apt.conf.5.xml:969
5676 msgid "<literal>Debug::pkgDepCache::Marker</literal>"
5679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5680 #: apt.conf.5.xml:972
5682 "Generate debug messages describing which package is marked as "
5683 "keep/install/remove while the ProblemResolver does his work. Each addition "
5684 "or deletion may trigger additional actions; they are shown indented two "
5685 "additional space under the original entry. The format for each line is "
5686 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
5687 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
5688 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
5689 "is the current version of the package, <literal>d.e.f</literal> is the "
5690 "version considered for installation and <literal>x.y.z</literal> is a newer "
5691 "version, but not considered for installation (because of a low pin "
5692 "score). The later two can be omitted if there is none or if it is the same "
5693 "version as the installed. <literal>section</literal> is the name of the "
5694 "section the package appears in."
5697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5698 #: apt.conf.5.xml:991
5699 msgid "<literal>Debug::pkgInitConfig</literal>"
5702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5703 #: apt.conf.5.xml:994
5704 msgid "Dump the default configuration to standard error on startup."
5707 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5708 #: apt.conf.5.xml:1001
5709 msgid "<literal>Debug::pkgDPkgPM</literal>"
5712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5713 #: apt.conf.5.xml:1004
5715 "When invoking &dpkg;, output the precise command line with which it is being "
5716 "invoked, with arguments separated by a single space character."
5719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5720 #: apt.conf.5.xml:1012
5721 msgid "<literal>Debug::pkgDPkgProgressReporting</literal>"
5724 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5725 #: apt.conf.5.xml:1015
5727 "Output all the data received from &dpkg; on the status file descriptor and "
5728 "any errors encountered while parsing it."
5731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5732 #: apt.conf.5.xml:1022
5733 msgid "<literal>Debug::pkgOrderList</literal>"
5736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5737 #: apt.conf.5.xml:1026
5739 "Generate a trace of the algorithm that decides the order in which "
5740 "<literal>apt</literal> should pass packages to &dpkg;."
5743 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5744 #: apt.conf.5.xml:1034
5745 msgid "<literal>Debug::pkgPackageManager</literal>"
5748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5749 #: apt.conf.5.xml:1038
5750 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
5753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5754 #: apt.conf.5.xml:1045
5755 msgid "<literal>Debug::pkgPolicy</literal>"
5758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5759 #: apt.conf.5.xml:1049
5760 msgid "Output the priority of each package list on startup."
5763 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5764 #: apt.conf.5.xml:1055
5765 msgid "<literal>Debug::pkgProblemResolver</literal>"
5768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5769 #: apt.conf.5.xml:1059
5771 "Trace the execution of the dependency resolver (this applies only to what "
5772 "happens when a complex dependency problem is encountered)."
5775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5776 #: apt.conf.5.xml:1067
5777 msgid "<literal>Debug::pkgProblemResolver::ShowScores</literal>"
5780 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5781 #: apt.conf.5.xml:1070
5783 "Display a list of all installed packages with their calculated score used by "
5784 "the pkgProblemResolver. The description of the package is the same as "
5785 "described in <literal>Debug::pkgDepCache::Marker</literal>"
5788 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5789 #: apt.conf.5.xml:1078
5790 msgid "<literal>Debug::sourceList</literal>"
5793 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5794 #: apt.conf.5.xml:1082
5796 "Print information about the vendors read from "
5797 "<filename>/etc/apt/vendors.list</filename>."
5800 #. type: Content of: <refentry><refsect1><para>
5801 #: apt.conf.5.xml:1105
5803 "&configureindex; is a configuration file showing example values for all "
5807 #. type: Content of: <refentry><refsect1><variablelist>
5808 #: apt.conf.5.xml:1112
5809 msgid "&file-aptconf;"
5812 #. ? reading apt.conf
5813 #. type: Content of: <refentry><refsect1><para>
5814 #: apt.conf.5.xml:1117
5815 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
5818 #. The last update date
5819 #. type: Content of: <refentry><refentryinfo>
5820 #: apt_preferences.5.xml:16
5821 msgid "&apt-author.team; &apt-email; &apt-product; <date>16 February 2010</date>"
5824 #. type: Content of: <refentry><refnamediv><refname>
5825 #: apt_preferences.5.xml:24 apt_preferences.5.xml:31
5826 msgid "apt_preferences"
5829 #. type: Content of: <refentry><refnamediv><refpurpose>
5830 #: apt_preferences.5.xml:32
5831 msgid "Preference control file for APT"
5834 #. type: Content of: <refentry><refsect1><para>
5835 #: apt_preferences.5.xml:37
5837 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
5838 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
5839 "can be used to control which versions of packages will be selected for "
5843 #. type: Content of: <refentry><refsect1><para>
5844 #: apt_preferences.5.xml:42
5846 "Several versions of a package may be available for installation when the "
5847 "&sources-list; file contains references to more than one distribution (for "
5848 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
5849 "assigns a priority to each version that is available. Subject to dependency "
5850 "constraints, <command>apt-get</command> selects the version with the highest "
5851 "priority for installation. The APT preferences file overrides the "
5852 "priorities that APT assigns to package versions by default, thus giving the "
5853 "user control over which one is selected for installation."
5856 #. type: Content of: <refentry><refsect1><para>
5857 #: apt_preferences.5.xml:52
5859 "Several instances of the same version of a package may be available when the "
5860 "&sources-list; file contains references to more than one source. In this "
5861 "case <command>apt-get</command> downloads the instance listed earliest in "
5862 "the &sources-list; file. The APT preferences file does not affect the "
5863 "choice of instance, only the choice of version."
5866 #. type: Content of: <refentry><refsect1><para>
5867 #: apt_preferences.5.xml:59
5869 "Preferences are a strong power in the hands of a system administrator but "
5870 "they can become also their biggest nightmare if used without care! APT will "
5871 "not questioning the preferences so wrong settings will therefore lead to "
5872 "uninstallable packages or wrong decisions while upgrading packages. Even "
5873 "more problems will arise if multiply distribution releases are mixed without "
5874 "a good understanding of the following paragraphs. Packages included in a "
5875 "specific release aren't tested in and therefore doesn't always work as "
5876 "expected in older or newer releases or together with other packages from "
5877 "different releases. You have been warned."
5880 #. type: Content of: <refentry><refsect1><para>
5881 #: apt_preferences.5.xml:70
5883 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
5884 "directory are parsed in alphanumeric ascending order and need to obey the "
5885 "following naming convention: The files have either no or "
5886 "\"<literal>pref</literal>\" as filename extension and only contain "
5887 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
5888 "Otherwise APT will print a notice that it has ignored a file if the file "
5889 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5890 "configuration list - in this case it will be silently ignored."
5893 #. type: Content of: <refentry><refsect1><refsect2><title>
5894 #: apt_preferences.5.xml:79
5895 msgid "APT's Default Priority Assignments"
5898 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5899 #: apt_preferences.5.xml:94
5902 "<command>apt-get install -t testing "
5903 "<replaceable>some-package</replaceable></command>\n"
5906 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5907 #: apt_preferences.5.xml:97
5909 msgid "APT::Default-Release \"stable\";\n"
5912 #. type: Content of: <refentry><refsect1><refsect2><para>
5913 #: apt_preferences.5.xml:81
5915 "If there is no preferences file or if there is no entry in the file that "
5916 "applies to a particular version then the priority assigned to that version "
5917 "is the priority of the distribution to which that version belongs. It is "
5918 "possible to single out a distribution, \"the target release\", which "
5919 "receives a higher priority than other distributions do by default. The "
5920 "target release can be set on the <command>apt-get</command> command line or "
5921 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
5922 "that this has precedence over any general priority you set in the "
5923 "<filename>/etc/apt/preferences</filename> file described later, but not over "
5924 "specifically pinned packages. For example, <placeholder "
5925 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
5929 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5930 #: apt_preferences.5.xml:106
5934 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5935 #: apt_preferences.5.xml:107
5937 "to the versions coming from archives which in their "
5938 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
5939 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
5940 "<literal>experimental</literal> archive."
5943 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5944 #: apt_preferences.5.xml:113
5945 msgid "priority 100"
5948 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5949 #: apt_preferences.5.xml:114
5951 "to the version that is already installed (if any) and to the versions coming "
5952 "from archives which in their <filename>Release</filename> files are marked "
5953 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
5954 "backports archive since <literal>squeeze-backports</literal>."
5957 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5958 #: apt_preferences.5.xml:121
5959 msgid "priority 500"
5962 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5963 #: apt_preferences.5.xml:122
5965 "to the versions that are not installed and do not belong to the target "
5969 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5970 #: apt_preferences.5.xml:126
5971 msgid "priority 990"
5974 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5975 #: apt_preferences.5.xml:127
5976 msgid "to the versions that are not installed and belong to the target release."
5979 #. type: Content of: <refentry><refsect1><refsect2><para>
5980 #: apt_preferences.5.xml:101
5982 "If the target release has been specified then APT uses the following "
5983 "algorithm to set the priorities of the versions of a package. Assign: "
5984 "<placeholder type=\"variablelist\" id=\"0\"/>"
5987 #. type: Content of: <refentry><refsect1><refsect2><para>
5988 #: apt_preferences.5.xml:132
5990 "If the target release has not been specified then APT simply assigns "
5991 "priority 100 to all installed package versions and priority 500 to all "
5992 "uninstalled package versions, except versions coming from archives which in "
5993 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
5994 "- these versions get the priority 1 or priority 100 if it is additionally "
5995 "marked as \"ButAutomaticUpgrades: yes\"."
5998 #. type: Content of: <refentry><refsect1><refsect2><para>
5999 #: apt_preferences.5.xml:139
6001 "APT then applies the following rules, listed in order of precedence, to "
6002 "determine which version of a package to install."
6005 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6006 #: apt_preferences.5.xml:142
6008 "Never downgrade unless the priority of an available version exceeds 1000. "
6009 "(\"Downgrading\" is installing a less recent version of a package in place "
6010 "of a more recent version. Note that none of APT's default priorities "
6011 "exceeds 1000; such high priorities can only be set in the preferences file. "
6012 "Note also that downgrading a package can be risky.)"
6015 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6016 #: apt_preferences.5.xml:148
6017 msgid "Install the highest priority version."
6020 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6021 #: apt_preferences.5.xml:149
6023 "If two or more versions have the same priority, install the most recent one "
6024 "(that is, the one with the higher version number)."
6027 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6028 #: apt_preferences.5.xml:152
6030 "If two or more versions have the same priority and version number but either "
6031 "the packages differ in some of their metadata or the "
6032 "<literal>--reinstall</literal> option is given, install the uninstalled one."
6035 #. type: Content of: <refentry><refsect1><refsect2><para>
6036 #: apt_preferences.5.xml:158
6038 "In a typical situation, the installed version of a package (priority 100) "
6039 "is not as recent as one of the versions available from the sources listed in "
6040 "the &sources-list; file (priority 500 or 990). Then the package will be "
6041 "upgraded when <command>apt-get install "
6042 "<replaceable>some-package</replaceable></command> or <command>apt-get "
6043 "upgrade</command> is executed."
6046 #. type: Content of: <refentry><refsect1><refsect2><para>
6047 #: apt_preferences.5.xml:165
6049 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
6050 "recent than any of the other available versions. The package will not be "
6051 "downgraded when <command>apt-get install "
6052 "<replaceable>some-package</replaceable></command> or <command>apt-get "
6053 "upgrade</command> is executed."
6056 #. type: Content of: <refentry><refsect1><refsect2><para>
6057 #: apt_preferences.5.xml:170
6059 "Sometimes the installed version of a package is more recent than the version "
6060 "belonging to the target release, but not as recent as a version belonging to "
6061 "some other distribution. Such a package will indeed be upgraded when "
6062 "<command>apt-get install <replaceable>some-package</replaceable></command> "
6063 "or <command>apt-get upgrade</command> is executed, because at least "
6064 "<emphasis>one</emphasis> of the available versions has a higher priority "
6065 "than the installed version."
6068 #. type: Content of: <refentry><refsect1><refsect2><title>
6069 #: apt_preferences.5.xml:179
6070 msgid "The Effect of APT Preferences"
6073 #. type: Content of: <refentry><refsect1><refsect2><para>
6074 #: apt_preferences.5.xml:181
6076 "The APT preferences file allows the system administrator to control the "
6077 "assignment of priorities. The file consists of one or more multi-line "
6078 "records separated by blank lines. Records can have one of two forms, a "
6079 "specific form and a general form."
6082 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6083 #: apt_preferences.5.xml:187
6085 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
6086 "specified packages and specified version or version range. For example, the "
6087 "following record assigns a high priority to all versions of the "
6088 "<filename>perl</filename> package whose version number begins with "
6089 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
6092 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6093 #: apt_preferences.5.xml:194
6097 "Pin: version 5.8*\n"
6098 "Pin-Priority: 1001\n"
6101 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6102 #: apt_preferences.5.xml:200
6104 "The general form assigns a priority to all of the package versions in a "
6105 "given distribution (that is, to all the versions of packages that are listed "
6106 "in a certain <filename>Release</filename> file) or to all of the package "
6107 "versions coming from a particular Internet site, as identified by the site's "
6108 "fully qualified domain name."
6111 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6112 #: apt_preferences.5.xml:206
6114 "This general-form entry in the APT preferences file applies only to groups "
6115 "of packages. For example, the following record assigns a high priority to "
6116 "all package versions available from the local site."
6119 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6120 #: apt_preferences.5.xml:211
6124 "Pin: origin \"\"\n"
6125 "Pin-Priority: 999\n"
6128 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6129 #: apt_preferences.5.xml:216
6131 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
6132 "which can be used to match a hostname. The following record will assign a "
6133 "high priority to all versions available from the server identified by the "
6134 "hostname \"ftp.de.debian.org\""
6137 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6138 #: apt_preferences.5.xml:220
6142 "Pin: origin \"ftp.de.debian.org\"\n"
6143 "Pin-Priority: 999\n"
6146 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6147 #: apt_preferences.5.xml:224
6149 "This should <emphasis>not</emphasis> be confused with the Origin of a "
6150 "distribution as specified in a <filename>Release</filename> file. What "
6151 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
6152 "Internet address but an author or vendor name, such as \"Debian\" or "
6156 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6157 #: apt_preferences.5.xml:229
6159 "The following record assigns a low priority to all package versions "
6160 "belonging to any distribution whose Archive name is "
6161 "\"<literal>unstable</literal>\"."
6164 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6165 #: apt_preferences.5.xml:233
6169 "Pin: release a=unstable\n"
6170 "Pin-Priority: 50\n"
6173 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6174 #: apt_preferences.5.xml:238
6176 "The following record assigns a high priority to all package versions "
6177 "belonging to any distribution whose Codename is "
6178 "\"<literal>&testing-codename;</literal>\"."
6181 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6182 #: apt_preferences.5.xml:242
6186 "Pin: release n=&testing-codename;\n"
6187 "Pin-Priority: 900\n"
6190 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6191 #: apt_preferences.5.xml:247
6193 "The following record assigns a high priority to all package versions "
6194 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
6195 "and whose release Version number is \"<literal>3.0</literal>\"."
6198 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6199 #: apt_preferences.5.xml:252
6203 "Pin: release a=stable, v=3.0\n"
6204 "Pin-Priority: 500\n"
6207 #. type: Content of: <refentry><refsect1><refsect2><title>
6208 #: apt_preferences.5.xml:262
6209 msgid "Regular expressions and glob() syntax"
6212 #. type: Content of: <refentry><refsect1><refsect2><para>
6213 #: apt_preferences.5.xml:264
6215 "APT also supports pinning by glob() expressions and regular expressions "
6216 "surrounded by /. For example, the following example assigns the priority 500 "
6217 "to all packages from experimental where the name starts with gnome (as a "
6218 "glob()-like expression) or contains the word kde (as a POSIX extended "
6219 "regular expression surrounded by slashes)."
6222 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6223 #: apt_preferences.5.xml:273
6226 "Package: gnome* /kde/\n"
6227 "Pin: release n=experimental\n"
6228 "Pin-Priority: 500\n"
6231 #. type: Content of: <refentry><refsect1><refsect2><para>
6232 #: apt_preferences.5.xml:279
6234 "The rule for those expressions is that they can occur anywhere where a "
6235 "string can occur. Thus, the following pin assigns the priority 990 to all "
6236 "packages from a release starting with karmic."
6239 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6240 #: apt_preferences.5.xml:285
6244 "Pin: release n=karmic*\n"
6245 "Pin-Priority: 990\n"
6248 #. type: Content of: <refentry><refsect1><refsect2><literal>
6249 #: apt_preferences.5.xml:290
6253 #. type: Content of: <refentry><refsect1><refsect2><literal>
6254 #: apt_preferences.5.xml:296
6258 #. type: Content of: <refentry><refsect1><refsect2><title>
6259 #: apt_preferences.5.xml:306
6260 msgid "How APT Interprets Priorities"
6263 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6264 #: apt_preferences.5.xml:314
6268 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6269 #: apt_preferences.5.xml:315
6271 "causes a version to be installed even if this constitutes a downgrade of the "
6275 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6276 #: apt_preferences.5.xml:319
6277 msgid "990 < P <=1000"
6280 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6281 #: apt_preferences.5.xml:320
6283 "causes a version to be installed even if it does not come from the target "
6284 "release, unless the installed version is more recent"
6287 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6288 #: apt_preferences.5.xml:325
6289 msgid "500 < P <=990"
6292 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6293 #: apt_preferences.5.xml:326
6295 "causes a version to be installed unless there is a version available "
6296 "belonging to the target release or the installed version is more recent"
6299 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6300 #: apt_preferences.5.xml:331
6301 msgid "100 < P <=500"
6304 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6305 #: apt_preferences.5.xml:332
6307 "causes a version to be installed unless there is a version available "
6308 "belonging to some other distribution or the installed version is more recent"
6311 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6312 #: apt_preferences.5.xml:337
6313 msgid "0 < P <=100"
6316 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6317 #: apt_preferences.5.xml:338
6319 "causes a version to be installed only if there is no installed version of "
6323 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6324 #: apt_preferences.5.xml:342
6328 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6329 #: apt_preferences.5.xml:343
6330 msgid "prevents the version from being installed"
6333 #. type: Content of: <refentry><refsect1><refsect2><para>
6334 #: apt_preferences.5.xml:309
6336 "Priorities (P) assigned in the APT preferences file must be positive or "
6337 "negative integers. They are interpreted as follows (roughly speaking): "
6338 "<placeholder type=\"variablelist\" id=\"0\"/>"
6341 #. type: Content of: <refentry><refsect1><refsect2><para>
6342 #: apt_preferences.5.xml:348
6344 "If any specific-form records match an available package version then the "
6345 "first such record determines the priority of the package version. Failing "
6346 "that, if any general-form records match an available package version then "
6347 "the first such record determines the priority of the package version."
6350 #. type: Content of: <refentry><refsect1><refsect2><para>
6351 #: apt_preferences.5.xml:354
6353 "For example, suppose the APT preferences file contains the three records "
6354 "presented earlier:"
6357 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6358 #: apt_preferences.5.xml:358
6362 "Pin: version 5.8*\n"
6363 "Pin-Priority: 1001\n"
6366 "Pin: origin \"\"\n"
6367 "Pin-Priority: 999\n"
6370 "Pin: release unstable\n"
6371 "Pin-Priority: 50\n"
6374 #. type: Content of: <refentry><refsect1><refsect2><para>
6375 #: apt_preferences.5.xml:371
6379 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6380 #: apt_preferences.5.xml:373
6382 "The most recent available version of the <literal>perl</literal> package "
6383 "will be installed, so long as that version's version number begins with "
6384 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
6385 "<literal>perl</literal> is available and the installed version is 5.9*, then "
6386 "<literal>perl</literal> will be downgraded."
6389 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6390 #: apt_preferences.5.xml:378
6392 "A version of any package other than <literal>perl</literal> that is "
6393 "available from the local system has priority over other versions, even "
6394 "versions belonging to the target release."
6397 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6398 #: apt_preferences.5.xml:382
6400 "A version of a package whose origin is not the local system but some other "
6401 "site listed in &sources-list; and which belongs to an "
6402 "<literal>unstable</literal> distribution is only installed if it is selected "
6403 "for installation and no version of the package is already installed."
6406 #. type: Content of: <refentry><refsect1><refsect2><title>
6407 #: apt_preferences.5.xml:392
6408 msgid "Determination of Package Version and Distribution Properties"
6411 #. type: Content of: <refentry><refsect1><refsect2><para>
6412 #: apt_preferences.5.xml:394
6414 "The locations listed in the &sources-list; file should provide "
6415 "<filename>Packages</filename> and <filename>Release</filename> files to "
6416 "describe the packages available at that location."
6419 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6420 #: apt_preferences.5.xml:406
6421 msgid "the <literal>Package:</literal> line"
6424 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6425 #: apt_preferences.5.xml:407
6426 msgid "gives the package name"
6429 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6430 #: apt_preferences.5.xml:410 apt_preferences.5.xml:460
6431 msgid "the <literal>Version:</literal> line"
6434 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6435 #: apt_preferences.5.xml:411
6436 msgid "gives the version number for the named package"
6439 #. type: Content of: <refentry><refsect1><refsect2><para>
6440 #: apt_preferences.5.xml:398
6442 "The <filename>Packages</filename> file is normally found in the directory "
6443 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
6445 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
6446 "consists of a series of multi-line records, one for each package available "
6447 "in that directory. Only two lines in each record are relevant for setting "
6448 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
6451 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6452 #: apt_preferences.5.xml:427
6453 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
6456 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6457 #: apt_preferences.5.xml:428
6459 "names the archive to which all the packages in the directory tree belong. "
6460 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
6461 "that all of the packages in the directory tree below the parent of the "
6462 "<filename>Release</filename> file are in a <literal>stable</literal> "
6463 "archive. Specifying this value in the APT preferences file would require "
6467 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6468 #: apt_preferences.5.xml:438
6470 msgid "Pin: release a=stable\n"
6473 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6474 #: apt_preferences.5.xml:444
6475 msgid "the <literal>Codename:</literal> line"
6478 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6479 #: apt_preferences.5.xml:445
6481 "names the codename to which all the packages in the directory tree belong. "
6482 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
6483 "the packages in the directory tree below the parent of the "
6484 "<filename>Release</filename> file belong to a version named "
6485 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
6486 "preferences file would require the line:"
6489 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6490 #: apt_preferences.5.xml:454
6492 msgid "Pin: release n=&testing-codename;\n"
6495 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6496 #: apt_preferences.5.xml:461
6498 "names the release version. For example, the packages in the tree might "
6499 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
6500 "no version number for the <literal>testing</literal> and "
6501 "<literal>unstable</literal> distributions because they have not been "
6502 "released yet. Specifying this in the APT preferences file would require one "
6503 "of the following lines."
6506 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6507 #: apt_preferences.5.xml:470
6510 "Pin: release v=3.0\n"
6511 "Pin: release a=stable, v=3.0\n"
6512 "Pin: release 3.0\n"
6515 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6516 #: apt_preferences.5.xml:479
6517 msgid "the <literal>Component:</literal> line"
6520 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6521 #: apt_preferences.5.xml:480
6523 "names the licensing component associated with the packages in the directory "
6524 "tree of the <filename>Release</filename> file. For example, the line "
6525 "\"Component: main\" specifies that all the packages in the directory tree "
6526 "are from the <literal>main</literal> component, which entails that they are "
6527 "licensed under terms listed in the Debian Free Software Guidelines. "
6528 "Specifying this component in the APT preferences file would require the "
6532 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6533 #: apt_preferences.5.xml:489
6535 msgid "Pin: release c=main\n"
6538 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6539 #: apt_preferences.5.xml:495
6540 msgid "the <literal>Origin:</literal> line"
6543 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6544 #: apt_preferences.5.xml:496
6546 "names the originator of the packages in the directory tree of the "
6547 "<filename>Release</filename> file. Most commonly, this is "
6548 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
6549 "file would require the line:"
6552 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6553 #: apt_preferences.5.xml:502
6555 msgid "Pin: release o=Debian\n"
6558 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6559 #: apt_preferences.5.xml:508
6560 msgid "the <literal>Label:</literal> line"
6563 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6564 #: apt_preferences.5.xml:509
6566 "names the label of the packages in the directory tree of the "
6567 "<filename>Release</filename> file. Most commonly, this is "
6568 "<literal>Debian</literal>. Specifying this label in the APT preferences "
6569 "file would require the line:"
6572 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6573 #: apt_preferences.5.xml:515
6575 msgid "Pin: release l=Debian\n"
6578 #. type: Content of: <refentry><refsect1><refsect2><para>
6579 #: apt_preferences.5.xml:416
6581 "The <filename>Release</filename> file is normally found in the directory "
6582 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
6583 "example, <filename>.../dists/stable/Release</filename>, or "
6584 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
6585 "single multi-line record which applies to <emphasis>all</emphasis> of the "
6586 "packages in the directory tree below its parent. Unlike the "
6587 "<filename>Packages</filename> file, nearly all of the lines in a "
6588 "<filename>Release</filename> file are relevant for setting APT priorities: "
6589 "<placeholder type=\"variablelist\" id=\"0\"/>"
6592 #. type: Content of: <refentry><refsect1><refsect2><para>
6593 #: apt_preferences.5.xml:522
6595 "All of the <filename>Packages</filename> and <filename>Release</filename> "
6596 "files retrieved from locations listed in the &sources-list; file are stored "
6597 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
6598 "named by the variable <literal>Dir::State::Lists</literal> in the "
6599 "<filename>apt.conf</filename> file. For example, the file "
6600 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
6601 "contains the <filename>Release</filename> file retrieved from the site "
6602 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
6603 "architecture files from the <literal>contrib</literal> component of the "
6604 "<literal>unstable</literal> distribution."
6607 #. type: Content of: <refentry><refsect1><refsect2><title>
6608 #: apt_preferences.5.xml:535
6609 msgid "Optional Lines in an APT Preferences Record"
6612 #. type: Content of: <refentry><refsect1><refsect2><para>
6613 #: apt_preferences.5.xml:537
6615 "Each record in the APT preferences file can optionally begin with one or "
6616 "more lines beginning with the word <literal>Explanation:</literal>. This "
6617 "provides a place for comments."
6620 #. type: Content of: <refentry><refsect1><refsect2><title>
6621 #: apt_preferences.5.xml:546
6622 msgid "Tracking Stable"
6625 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6626 #: apt_preferences.5.xml:554
6629 "Explanation: Uninstall or do not install any Debian-originated\n"
6630 "Explanation: package versions other than those in the stable distro\n"
6632 "Pin: release a=stable\n"
6633 "Pin-Priority: 900\n"
6636 "Pin: release o=Debian\n"
6637 "Pin-Priority: -10\n"
6640 #. type: Content of: <refentry><refsect1><refsect2><para>
6641 #: apt_preferences.5.xml:548
6643 "The following APT preferences file will cause APT to assign a priority "
6644 "higher than the default (500) to all package versions belonging to a "
6645 "<literal>stable</literal> distribution and a prohibitively low priority to "
6646 "package versions belonging to other <literal>Debian</literal> "
6647 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
6650 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6651 #: apt_preferences.5.xml:571 apt_preferences.5.xml:617 apt_preferences.5.xml:675
6654 "apt-get install <replaceable>package-name</replaceable>\n"
6656 "apt-get dist-upgrade\n"
6659 #. type: Content of: <refentry><refsect1><refsect2><para>
6660 #: apt_preferences.5.xml:566
6662 "With a suitable &sources-list; file and the above preferences file, any of "
6663 "the following commands will cause APT to upgrade to the latest "
6664 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
6668 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6669 #: apt_preferences.5.xml:583
6671 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
6674 #. type: Content of: <refentry><refsect1><refsect2><para>
6675 #: apt_preferences.5.xml:577
6677 "The following command will cause APT to upgrade the specified package to the "
6678 "latest version from the <literal>testing</literal> distribution; the package "
6679 "will not be upgraded again unless this command is given again. <placeholder "
6680 "type=\"programlisting\" id=\"0\"/>"
6683 #. type: Content of: <refentry><refsect1><refsect2><title>
6684 #: apt_preferences.5.xml:589
6685 msgid "Tracking Testing or Unstable"
6688 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6689 #: apt_preferences.5.xml:598
6693 "Pin: release a=testing\n"
6694 "Pin-Priority: 900\n"
6697 "Pin: release a=unstable\n"
6698 "Pin-Priority: 800\n"
6701 "Pin: release o=Debian\n"
6702 "Pin-Priority: -10\n"
6705 #. type: Content of: <refentry><refsect1><refsect2><para>
6706 #: apt_preferences.5.xml:591
6708 "The following APT preferences file will cause APT to assign a high priority "
6709 "to package versions from the <literal>testing</literal> distribution, a "
6710 "lower priority to package versions from the <literal>unstable</literal> "
6711 "distribution, and a prohibitively low priority to package versions from "
6712 "other <literal>Debian</literal> distributions. <placeholder "
6713 "type=\"programlisting\" id=\"0\"/>"
6716 #. type: Content of: <refentry><refsect1><refsect2><para>
6717 #: apt_preferences.5.xml:612
6719 "With a suitable &sources-list; file and the above preferences file, any of "
6720 "the following commands will cause APT to upgrade to the latest "
6721 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
6725 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6726 #: apt_preferences.5.xml:632
6728 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
6731 #. type: Content of: <refentry><refsect1><refsect2><para>
6732 #: apt_preferences.5.xml:623
6734 "The following command will cause APT to upgrade the specified package to the "
6735 "latest version from the <literal>unstable</literal> distribution. "
6736 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
6737 "the most recent <literal>testing</literal> version if that is more recent "
6738 "than the installed version, otherwise, to the most recent "
6739 "<literal>unstable</literal> version if that is more recent than the "
6740 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
6743 #. type: Content of: <refentry><refsect1><refsect2><title>
6744 #: apt_preferences.5.xml:639
6745 msgid "Tracking the evolution of a codename release"
6748 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6749 #: apt_preferences.5.xml:653
6752 "Explanation: Uninstall or do not install any Debian-originated package "
6754 "Explanation: other than those in the distribution codenamed with "
6755 "&testing-codename; or sid\n"
6757 "Pin: release n=&testing-codename;\n"
6758 "Pin-Priority: 900\n"
6760 "Explanation: Debian unstable is always codenamed with sid\n"
6762 "Pin: release n=sid\n"
6763 "Pin-Priority: 800\n"
6766 "Pin: release o=Debian\n"
6767 "Pin-Priority: -10\n"
6770 #. type: Content of: <refentry><refsect1><refsect2><para>
6771 #: apt_preferences.5.xml:641
6773 "The following APT preferences file will cause APT to assign a priority "
6774 "higher than the default (500) to all package versions belonging to a "
6775 "specified codename of a distribution and a prohibitively low priority to "
6776 "package versions belonging to other <literal>Debian</literal> distributions, "
6777 "codenames and archives. Note that with this APT preference APT will follow "
6778 "the migration of a release from the archive <literal>testing</literal> to "
6779 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
6780 "want to follow for example the progress in <literal>testing</literal> "
6781 "notwithstanding the codename changes you should use the example "
6782 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
6785 #. type: Content of: <refentry><refsect1><refsect2><para>
6786 #: apt_preferences.5.xml:670
6788 "With a suitable &sources-list; file and the above preferences file, any of "
6789 "the following commands will cause APT to upgrade to the latest version(s) in "
6790 "the release codenamed with <literal>&testing-codename;</literal>. "
6791 "<placeholder type=\"programlisting\" id=\"0\"/>"
6794 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6795 #: apt_preferences.5.xml:690
6797 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
6800 #. type: Content of: <refentry><refsect1><refsect2><para>
6801 #: apt_preferences.5.xml:681
6803 "The following command will cause APT to upgrade the specified package to the "
6804 "latest version from the <literal>sid</literal> distribution. Thereafter, "
6805 "<command>apt-get upgrade</command> will upgrade the package to the most "
6806 "recent <literal>&testing-codename;</literal> version if that is more recent "
6807 "than the installed version, otherwise, to the most recent "
6808 "<literal>sid</literal> version if that is more recent than the installed "
6809 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
6812 #. type: Content of: <refentry><refsect1><variablelist>
6813 #: apt_preferences.5.xml:699
6814 msgid "&file-preferences;"
6817 #. type: Content of: <refentry><refsect1><para>
6818 #: apt_preferences.5.xml:705
6819 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
6822 #. type: Content of: <refentry><refnamediv><refname>
6823 #: sources.list.5.xml:25 sources.list.5.xml:32
6824 msgid "sources.list"
6827 #. type: Content of: <refentry><refnamediv><refpurpose>
6828 #: sources.list.5.xml:33
6829 msgid "Package resource list for APT"
6832 #. type: Content of: <refentry><refsect1><para>
6833 #: sources.list.5.xml:37
6835 "The package resource list is used to locate archives of the package "
6836 "distribution system in use on the system. At this time, this manual page "
6837 "documents only the packaging system used by the Debian GNU/Linux system. "
6838 "This control file is <filename>/etc/apt/sources.list</filename>."
6841 #. type: Content of: <refentry><refsect1><para>
6842 #: sources.list.5.xml:42
6844 "The source list is designed to support any number of active sources and a "
6845 "variety of source media. The file lists one source per line, with the most "
6846 "preferred source listed first. The format of each line is: <literal>type uri "
6847 "args</literal> The first item, <literal>type</literal> determines the format "
6848 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
6849 "Identifier (URI), which is a superset of the more specific and well-known "
6850 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
6851 "comment by using a #."
6854 #. type: Content of: <refentry><refsect1><title>
6855 #: sources.list.5.xml:53
6856 msgid "sources.list.d"
6859 #. type: Content of: <refentry><refsect1><para>
6860 #: sources.list.5.xml:54
6862 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
6863 "add sources.list entries in separate files. The format is the same as for "
6864 "the regular <filename>sources.list</filename> file. File names need to end "
6865 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
6866 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
6867 "Otherwise APT will print a notice that it has ignored a file if the file "
6868 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
6869 "configuration list - in this case it will be silently ignored."
6872 #. type: Content of: <refentry><refsect1><title>
6873 #: sources.list.5.xml:65
6874 msgid "The deb and deb-src types"
6877 #. type: Content of: <refentry><refsect1><para>
6878 #: sources.list.5.xml:66
6880 "The <literal>deb</literal> type describes a typical two-level Debian "
6881 "archive, <filename>distribution/component</filename>. Typically, "
6882 "<literal>distribution</literal> is generally an archivename like "
6883 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
6884 "<literal>&stable-codename;</literal> or "
6885 "<literal>&testing-codename;</literal> while component is one of "
6886 "<literal>main</literal> <literal>contrib</literal> or "
6887 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
6888 "debian distribution's source code in the same form as the "
6889 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
6890 "to fetch source indexes."
6893 #. type: Content of: <refentry><refsect1><para>
6894 #: sources.list.5.xml:78
6896 "The format for a <filename>sources.list</filename> entry using the "
6897 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
6900 #. type: Content of: <refentry><refsect1><literallayout>
6901 #: sources.list.5.xml:81
6903 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
6906 #. type: Content of: <refentry><refsect1><para>
6907 #: sources.list.5.xml:83
6909 "The URI for the <literal>deb</literal> type must specify the base of the "
6910 "Debian distribution, from which APT will find the information it needs. "
6911 "<literal>distribution</literal> can specify an exact path, in which case the "
6912 "components must be omitted and <literal>distribution</literal> must end with "
6913 "a slash (/). This is useful for when the case only a particular sub-section "
6914 "of the archive denoted by the URI is of interest. If "
6915 "<literal>distribution</literal> does not specify an exact path, at least one "
6916 "<literal>component</literal> must be present."
6919 #. type: Content of: <refentry><refsect1><para>
6920 #: sources.list.5.xml:92
6922 "<literal>distribution</literal> may also contain a variable, "
6923 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
6924 "m68k, powerpc, ...) used on the system. This permits "
6925 "architecture-independent <filename>sources.list</filename> files to be "
6926 "used. In general this is only of interest when specifying an exact path, "
6927 "<literal>APT</literal> will automatically generate a URI with the current "
6928 "architecture otherwise."
6931 #. type: Content of: <refentry><refsect1><para>
6932 #: sources.list.5.xml:100
6934 "Since only one distribution can be specified per line it may be necessary to "
6935 "have multiple lines for the same URI, if a subset of all available "
6936 "distributions or components at that location is desired. APT will sort the "
6937 "URI list after it has generated a complete set internally, and will collapse "
6938 "multiple references to the same Internet host, for instance, into a single "
6939 "connection, so that it does not inefficiently establish an FTP connection, "
6940 "close it, do something else, and then re-establish a connection to that same "
6941 "host. This feature is useful for accessing busy FTP sites with limits on the "
6942 "number of simultaneous anonymous users. APT also parallelizes connections to "
6943 "different hosts to more effectively deal with sites with low bandwidth."
6946 #. type: Content of: <refentry><refsect1><para>
6947 #: sources.list.5.xml:112
6949 "<literal>options</literal> is always optional and needs to be surounded by "
6950 "square brackets. It can consist of multiple settings in the form "
6951 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
6952 "Multiple settings are separated by spaces. The following settings are "
6953 "supported by APT, note though that unsupported settings will be ignored "
6957 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
6958 #: sources.list.5.xml:117
6960 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
6961 "can be used to specify for which architectures packages information should "
6962 "be downloaded. If this option is not set all architectures defined by the "
6963 "<literal>APT::Architectures</literal> option will be downloaded."
6966 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
6967 #: sources.list.5.xml:121
6969 "<literal>trusted=yes</literal> can be set to indicate that packages from "
6970 "this source are always authenificated even if the "
6971 "<filename>Release</filename> file is not signed or the signature can't be "
6972 "checked. This disables parts of &apt-secure; and should therefore only be "
6973 "used in a local and trusted context. <literal>trusted=no</literal> is the "
6974 "opposite which handles even correctly authenificated sources as not "
6978 #. type: Content of: <refentry><refsect1><para>
6979 #: sources.list.5.xml:128
6981 "It is important to list sources in order of preference, with the most "
6982 "preferred source listed first. Typically this will result in sorting by "
6983 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
6984 "followed by distant Internet hosts, for example)."
6987 #. type: Content of: <refentry><refsect1><para>
6988 #: sources.list.5.xml:133
6989 msgid "Some examples:"
6992 #. type: Content of: <refentry><refsect1><literallayout>
6993 #: sources.list.5.xml:135
6996 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
6997 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
7002 #. type: Content of: <refentry><refsect1><title>
7003 #: sources.list.5.xml:141
7004 msgid "URI specification"
7007 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7008 #: sources.list.5.xml:146
7012 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7013 #: sources.list.5.xml:148
7015 "The file scheme allows an arbitrary directory in the file system to be "
7016 "considered an archive. This is useful for NFS mounts and local mirrors or "
7020 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7021 #: sources.list.5.xml:155
7023 "The cdrom scheme allows APT to use a local CDROM drive with media "
7024 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
7028 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7029 #: sources.list.5.xml:162
7031 "The http scheme specifies an HTTP server for the archive. If an environment "
7032 "variable <envar>http_proxy</envar> is set with the format "
7033 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
7034 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
7035 "the format http://user:pass@server:port/. Note that this is an insecure "
7036 "method of authentication."
7039 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7040 #: sources.list.5.xml:173
7042 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
7043 "is highly configurable; for more information see the &apt-conf; manual "
7044 "page. Please note that a ftp proxy can be specified by using the "
7045 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
7046 "http proxy (http proxy servers often understand ftp urls) using this method "
7047 "and ONLY this method. ftp proxies using http specified in the configuration "
7048 "file will be ignored."
7051 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7052 #: sources.list.5.xml:182
7056 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7057 #: sources.list.5.xml:184
7059 "The copy scheme is identical to the file scheme except that packages are "
7060 "copied into the cache directory instead of used directly at their location. "
7061 "This is useful for people using a zip disk to copy files around with APT."
7064 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7065 #: sources.list.5.xml:189
7069 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7070 #: sources.list.5.xml:189
7074 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7075 #: sources.list.5.xml:191
7077 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
7078 "user and access the files. It is a good idea to do prior arrangements with "
7079 "RSA keys or rhosts. Access to files on the remote uses standard "
7080 "<command>find</command> and <command>dd</command> commands to perform the "
7081 "file transfers from the remote."
7084 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7085 #: sources.list.5.xml:199
7086 msgid "more recognizable URI types"
7089 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7090 #: sources.list.5.xml:201
7092 "APT can be extended with more methods shipped in other optional packages "
7093 "which should follow the nameing scheme "
7094 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
7095 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
7096 "which provides access methods for https-URIs with features similar to the "
7097 "http method, but other methods for using e.g. debtorrent are also available, "
7098 "see <citerefentry> "
7099 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
7100 "<manvolnum>1</manvolnum></citerefentry>."
7103 #. type: Content of: <refentry><refsect1><para>
7104 #: sources.list.5.xml:143
7106 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
7107 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
7110 #. type: Content of: <refentry><refsect1><para>
7111 #: sources.list.5.xml:215
7113 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
7114 "stable/main, stable/contrib, and stable/non-free."
7117 #. type: Content of: <refentry><refsect1><literallayout>
7118 #: sources.list.5.xml:217
7120 msgid "deb file:/home/jason/debian stable main contrib non-free"
7123 #. type: Content of: <refentry><refsect1><para>
7124 #: sources.list.5.xml:219
7125 msgid "As above, except this uses the unstable (development) distribution."
7128 #. type: Content of: <refentry><refsect1><literallayout>
7129 #: sources.list.5.xml:220
7131 msgid "deb file:/home/jason/debian unstable main contrib non-free"
7134 #. type: Content of: <refentry><refsect1><para>
7135 #: sources.list.5.xml:222
7136 msgid "Source line for the above"
7139 #. type: Content of: <refentry><refsect1><literallayout>
7140 #: sources.list.5.xml:223
7142 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
7145 #. type: Content of: <refentry><refsect1><para>
7146 #: sources.list.5.xml:225
7148 "The first line gets package information for the architectures in "
7149 "<literal>APT::Architectures</literal> while the second always retrieves "
7150 "<literal>amd64</literal> and <literal>armel</literal>."
7153 #. type: Content of: <refentry><refsect1><literallayout>
7154 #: sources.list.5.xml:227
7157 "deb http://ftp.debian.org/debian &stable-codename; main\n"
7158 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
7161 #. type: Content of: <refentry><refsect1><para>
7162 #: sources.list.5.xml:230
7164 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
7168 #. type: Content of: <refentry><refsect1><literallayout>
7169 #: sources.list.5.xml:232
7171 msgid "deb http://archive.debian.org/debian-archive hamm main"
7174 #. type: Content of: <refentry><refsect1><para>
7175 #: sources.list.5.xml:234
7177 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7178 "directory, and uses only the &stable-codename;/contrib area."
7181 #. type: Content of: <refentry><refsect1><literallayout>
7182 #: sources.list.5.xml:236
7184 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
7187 #. type: Content of: <refentry><refsect1><para>
7188 #: sources.list.5.xml:238
7190 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7191 "directory, and uses only the unstable/contrib area. If this line appears as "
7192 "well as the one in the previous example in <filename>sources.list</filename> "
7193 "a single FTP session will be used for both resource lines."
7196 #. type: Content of: <refentry><refsect1><literallayout>
7197 #: sources.list.5.xml:242
7199 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
7202 #. type: Content of: <refentry><refsect1><para><literallayout>
7203 #: sources.list.5.xml:251
7205 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
7208 #. type: Content of: <refentry><refsect1><para>
7209 #: sources.list.5.xml:244
7211 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
7212 "directory, and uses only files found under "
7213 "<filename>unstable/binary-i386</filename> on i386 machines, "
7214 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
7215 "supported architectures. [Note this example only illustrates how to use the "
7216 "substitution variable; official debian archives are not structured like "
7217 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
7220 #. type: Content of: <refentry><refsect1><para>
7221 #: sources.list.5.xml:256
7222 msgid "&apt-cache; &apt-conf;"
7225 #. type: <title></title>
7227 msgid "APT User's Guide"
7230 #. type: <author></author>
7231 #: guide.sgml:6 offline.sgml:6
7232 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
7235 #. type: <version></version>
7237 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
7240 #. type: <abstract></abstract>
7243 "This document provides an overview of how to use the the APT package "
7247 #. type: <copyrightsummary></copyrightsummary>
7249 msgid "Copyright © Jason Gunthorpe, 1998."
7253 #: guide.sgml:21 offline.sgml:22
7255 "\"APT\" and this document are free software; you can redistribute them "
7256 "and/or modify them under the terms of the GNU General Public License as "
7257 "published by the Free Software Foundation; either version 2 of the License, "
7258 "or (at your option) any later version."
7262 #: guide.sgml:24 offline.sgml:25
7264 "For more details, on Debian GNU/Linux systems, see the file "
7265 "/usr/share/common-licenses/GPL for the full license."
7268 #. type: <heading></heading>
7276 "The APT package currently contains two sections, the APT "
7277 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
7278 "interface. Both provide a way to install and remove packages as well as "
7279 "download new packages from the Internet."
7282 #. type: <heading></heading>
7284 msgid "Anatomy of the Package System"
7290 "The Debian packaging system has a large amount of information associated "
7291 "with each package to help assure that it integrates cleanly and easily into "
7292 "the system. The most prominent of its features is the dependency system."
7298 "The dependency system allows individual programs to make use of shared "
7299 "elements in the system such as libraries. It simplifies placing infrequently "
7300 "used portions of a program in separate packages to reduce the number of "
7301 "things the average user is required to install. Also, it allows for choices "
7302 "in mail transport agents, X servers and so on."
7308 "The first step to understanding the dependency system is to grasp the "
7309 "concept of a simple dependency. The meaning of a simple dependency is that a "
7310 "package requires another package to be installed at the same time to work "
7317 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
7318 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
7319 "simple dependency on GPG. Also, because it is an emacs extension it has a "
7320 "simple dependency on emacs, without emacs it is completely useless."
7326 "The other important dependency to understand is a conflicting dependency. It "
7327 "means that a package, when installed with another package, will not work and "
7328 "may possibly be extremely harmful to the system. As an example consider a "
7329 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
7330 "have two mail transport agents installed because both need to listen to the "
7331 "network to receive mail. Attempting to install two will seriously damage the "
7332 "system so all mail transport agents have a conflicting dependency with all "
7333 "other mail transport agents."
7339 "As an added complication there is the possibility for a package to pretend "
7340 "to be another package. Consider that exim and sendmail for many intents are "
7341 "identical, they both deliver mail and understand a common interface. Hence, "
7342 "the package system has a way for them to declare that they are both "
7343 "mail-transport-agents. So, exim and sendmail both declare that they provide "
7344 "a mail-transport-agent and other packages that need a mail transport agent "
7345 "depend on mail-transport-agent. This can add a great deal of confusion when "
7346 "trying to manually fix packages."
7352 "At any given time a single dependency may be met by packages that are "
7353 "already installed or it may not be. APT attempts to help resolve dependency "
7354 "issues by providing a number of automatic algorithms that help in selecting "
7355 "packages for installation."
7361 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
7362 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
7363 "understand .deb files, it works with the package's proper name and can only "
7364 "install .deb archives from a <em>Source</em>."
7370 "The first <footnote><p>If you are using an http proxy server you must set "
7371 "the http_proxy environment variable first, see "
7372 "sources.list(5)</p></footnote> thing that should be done before using "
7373 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
7374 "so that it knows what packages are available. This is done with <tt>apt-get "
7375 "update</tt>. For instance,"
7378 #. type: <example></example>
7382 "# apt-get update\n"
7383 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
7384 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7385 "Reading Package Lists... Done\n"
7386 "Building Dependency Tree... Done"
7389 #. type: <p><taglist>
7391 msgid "Once updated there are several commands that can be used:"
7397 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
7398 "install a new package or remove an existing package, nor will it ever "
7399 "upgrade a package that might cause some other package to break. This can be "
7400 "used daily to relatively safely upgrade the system. Upgrade will list all of "
7401 "the packages that it could not upgrade, this usually means that they depend "
7402 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
7403 "<tt>apt-get install</tt> can be used to force these packages to install."
7409 "Install is used to install packages by name. The package is automatically "
7410 "fetched and installed. This can be useful if you already know the name of "
7411 "the package to install and do not want to go into a GUI to select it. Any "
7412 "number of packages may be passed to install, they will all be "
7413 "fetched. Install automatically attempts to resolve dependency problems with "
7414 "the listed packages and will print a summary and ask for confirmation if "
7415 "anything other than its arguments are changed."
7421 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
7422 "releases of Debian. It uses a sophisticated algorithm to determine the best "
7423 "set of packages to install, upgrade and remove to get as much of the system "
7424 "to the newest release. In some situations it may be desired to use "
7425 "dist-upgrade rather than spend the time manually resolving dependencies in "
7426 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
7427 "<prgn>dselect</prgn> can be used to install any packages that may have been "
7434 "It is important to closely look at what dist-upgrade is going to do, its "
7435 "decisions may sometimes be quite surprising."
7441 "<prgn>apt-get</prgn> has several command line options that are detailed in "
7442 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
7443 "option is <tt>-d</tt> which does not install the fetched files. If the "
7444 "system has to download a large number of package it would be undesired to "
7445 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
7446 "the downloaded archives can be installed by simply running the command that "
7447 "caused them to be downloaded again without <tt>-d</tt>."
7450 #. type: <heading></heading>
7458 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
7459 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
7460 "to select the packages to be installed or removed and APT actually installs "
7467 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
7468 "and then choose the APT method. You will be prompted for a set of "
7469 "<em>Sources</em> which are places to fetch archives from. These can be "
7470 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
7471 "provide a fragment of the total Debian archive, APT will automatically "
7472 "combine them to form a complete set of packages. If you have a CDROM then it "
7473 "is a good idea to specify it first and then specify a mirror so that you "
7474 "have access to the latest bug fixes. APT will automatically use packages on "
7475 "your CDROM before downloading from the Internet."
7478 #. type: <example></example>
7482 " Set up a list of distribution source locations\n"
7484 " Please give the base URL of the debian distribution.\n"
7485 " The access schemes I know about are: http file\n"
7488 " file:/mnt/debian,\n"
7489 " ftp://ftp.debian.org/debian,\n"
7490 " http://ftp.de.debian.org/debian,\n"
7493 " URL [http://llug.sep.bnl.gov/debian]:"
7499 "The <em>Sources</em> setup starts by asking for the base of the Debian "
7500 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
7504 #. type: <example></example>
7508 " Please give the distribution tag to get or a path to the\n"
7509 " package file ending in a /. The distribution\n"
7510 " tags are typically something like: stable unstable testing non-US\n"
7512 " Distribution [stable]:"
7518 "The distribution refers to the Debian version in the archive, "
7519 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
7520 "refers to the developmental version. <em>non-US</em> is only available on "
7521 "some mirrors and refers to packages that contain encryption technology or "
7522 "other things that cannot be exported from the United States. Importing these "
7523 "packages into the US is legal however."
7526 #. type: <example></example>
7530 " Please give the components to get\n"
7531 " The components are typically something like: main contrib non-free\n"
7533 " Components [main contrib non-free]:"
7539 "The components list refers to the list of sub distributions to fetch. The "
7540 "distribution is split up based on software licenses, main being DFSG free "
7541 "packages while contrib and non-free contain things that have various "
7542 "restrictions placed on their use and distribution."
7548 "Any number of sources can be added, the setup script will continue to prompt "
7549 "until you have specified all that you want."
7555 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
7556 "available list by selecting [U]pdate from the menu. This is a superset of "
7557 "<tt>apt-get update</tt> that makes the fetched information available to "
7558 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
7559 "update</tt> has been run before."
7565 "You can then go on and make your selections using [S]elect and then perform "
7566 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7567 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7574 "By default APT will automatically remove the package (.deb) files once they "
7575 "have been successfully installed. To change this behavior place "
7576 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
7579 #. type: <heading></heading>
7581 msgid "The Interface"
7587 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
7588 "same interface. It is a simple system that generally tells you what it will "
7589 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
7590 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
7591 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
7592 "alone.</p></footnote> After printing out a summary of what will happen APT "
7593 "then will print out some informative status messages so that you can "
7594 "estimate how far along it is and how much is left to do."
7597 #. type: <heading></heading>
7605 "Before all operations except update, APT performs a number of actions to "
7606 "prepare its internal state. It also does some checks of the system's "
7607 "state. At any time these operations can be performed by running <tt>apt-get "
7611 #. type: <example></example>
7616 "Reading Package Lists... Done\n"
7617 "Building Dependency Tree... Done"
7623 "The first thing it does is read all the package files into memory. APT uses "
7624 "a caching scheme so this operation will be faster the second time it is "
7625 "run. If some of the package files are not found then they will be ignored "
7626 "and a warning will be printed when apt-get exits."
7632 "The final operation performs a detailed analysis of the system's "
7633 "dependencies. It checks every dependency of every installed or unpacked "
7634 "package and considers if it is OK. Should this find a problem then a report "
7635 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
7638 #. type: <example></example>
7643 "Reading Package Lists... Done\n"
7644 "Building Dependency Tree... Done\n"
7645 "You might want to run apt-get -f install' to correct these.\n"
7646 "Sorry, but the following packages have unmet dependencies:\n"
7647 " 9fonts: Depends: xlib6g but it is not installed\n"
7648 " uucp: Depends: mailx but it is not installed\n"
7649 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7650 " adduser: Depends: perl-base but it is not installed\n"
7651 " aumix: Depends: libgpmg1 but it is not installed\n"
7652 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7653 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7654 " cthugha: Depends: svgalibg1 but it is not installed\n"
7655 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7656 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
7662 "In this example the system has many problems, including a serious problem "
7663 "with libreadlineg2. For each package that has unmet dependencies a line is "
7664 "printed out indicating the package with the problem and the dependencies "
7665 "that are unmet. A short explanation of why the package has a dependency "
7666 "problem is also included."
7672 "There are two ways a system can get into a broken state like this. The first "
7673 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
7674 "packages when performing upgrades. <footnote><p>APT however considers all "
7675 "known dependencies and attempts to prevent broken "
7676 "packages</p></footnote>. The second is if a package installation fails "
7677 "during an operation. In this situation a package may have been unpacked "
7678 "without its dependents being installed."
7684 "The second situation is much less serious than the first because APT places "
7685 "certain constraints on the order that packages are installed. In both cases "
7686 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
7687 "deduce a possible solution to the problem and then continue on. The APT "
7688 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
7689 "for easy continuation of failed maintainer scripts."
7695 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
7696 "system caused by the first case then it is possible that it will either fail "
7697 "immediately or the installation sequence will fail. In either case it is "
7698 "necessary to manually use dpkg (possibly with forcing options) to correct "
7699 "the situation enough to allow APT to proceed."
7702 #. type: <heading></heading>
7704 msgid "The Status Report"
7710 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
7711 "happen. Generally the report reflects the type of operation being performed "
7712 "but there are several common elements. In all cases the lists reflect the "
7713 "final state of things, taking into account the <tt>-f</tt> option and any "
7714 "other relevant activities to the command being executed."
7717 #. type: <heading></heading>
7719 msgid "The Extra Package list"
7722 #. type: <example></example>
7726 "The following extra packages will be installed:\n"
7727 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7728 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7729 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7730 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7737 "The Extra Package list shows all of the packages that will be installed or "
7738 "upgraded in excess of the ones mentioned on the command line. It is only "
7739 "generated for an <tt>install</tt> command. The listed packages are often the "
7740 "result of an Auto Install."
7743 #. type: <heading></heading>
7745 msgid "The Packages to Remove"
7748 #. type: <example></example>
7752 "The following packages will be REMOVED:\n"
7753 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7754 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7755 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7762 "The Packages to Remove list shows all of the packages that will be removed "
7763 "from the system. It can be shown for any of the operations and should be "
7764 "given a careful inspection to ensure nothing important is to be taken "
7765 "off. The <tt>-f</tt> option is especially good at generating packages to "
7766 "remove so extreme care should be used in that case. The list may contain "
7767 "packages that are going to be removed because they are only partially "
7768 "installed, possibly due to an aborted installation."
7771 #. type: <heading></heading>
7773 msgid "The New Packages list"
7776 #. type: <example></example>
7780 "The following NEW packages will installed:\n"
7781 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
7787 "The New Packages list is simply a reminder of what will happen. The packages "
7788 "listed are not presently installed in the system but will be when APT is "
7792 #. type: <heading></heading>
7794 msgid "The Kept Back list"
7797 #. type: <example></example>
7801 "The following packages have been kept back\n"
7802 " compface man-db tetex-base msql libpaper svgalib1\n"
7803 " gs snmp arena lynx xpat2 groff xscreensaver"
7809 "Whenever the whole system is being upgraded there is the possibility that "
7810 "new versions of packages cannot be installed because they require new things "
7811 "or conflict with already installed things. In this case the package will "
7812 "appear in the Kept Back list. The best way to convince packages listed there "
7813 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
7814 "to resolve their problems."
7817 #. type: <heading></heading>
7819 msgid "Held Packages warning"
7822 #. type: <example></example>
7826 "The following held packages will be changed:\n"
7833 "Sometimes you can ask APT to install a package that is on hold, in such a "
7834 "case it prints out a warning that the held package is going to be "
7835 "changed. This should only happen during dist-upgrade or install."
7838 #. type: <heading></heading>
7840 msgid "Final summary"
7845 msgid "Finally, APT will print out a summary of all the changes that will occur."
7848 #. type: <example></example>
7852 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7854 "12 packages not fully installed or removed.\n"
7855 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
7861 "The first line of the summary simply is a reduced version of all of the "
7862 "lists and includes the number of upgrades - that is packages already "
7863 "installed that have new versions available. The second line indicates the "
7864 "number of poorly configured packages, possibly the result of an aborted "
7865 "installation. The final line shows the space requirements that the "
7866 "installation needs. The first pair of numbers refer to the size of the "
7867 "archive files. The first number indicates the number of bytes that must be "
7868 "fetched from remote locations and the second indicates the total size of all "
7869 "the archives required. The next number indicates the size difference between "
7870 "the presently installed packages and the newly installed packages. It is "
7871 "roughly equivalent to the space required in /usr after everything is "
7872 "done. If a large number of packages are being removed then the value may "
7873 "indicate the amount of space that will be freed."
7879 "Some other reports can be generated by using the -u option to show packages "
7880 "to upgrade, they are similar to the previous examples."
7883 #. type: <heading></heading>
7885 msgid "The Status Display"
7891 "During the download of archives and package files APT prints out a series of "
7895 #. type: <example></example>
7899 "# apt-get update\n"
7900 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7901 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7902 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7903 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7905 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7906 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
7912 "The lines starting with <em>Get</em> are printed out when APT begins to "
7913 "fetch a file while the last line indicates the progress of the download. The "
7914 "first percent value on the progress line indicates the total percent done of "
7915 "all files. Unfortunately since the size of the Package files is unknown "
7916 "<tt>apt-get update</tt> estimates the percent done which causes some "
7923 "The next section of the status line is repeated once for each download "
7924 "thread and indicates the operation being performed and some useful "
7925 "information about what is happening. Sometimes this section will simply read "
7926 "<em>Forking</em> which means the OS is loading the download module. The "
7927 "first word after the [ is the fetch number as shown on the history "
7928 "lines. The next word is the short form name of the object being "
7929 "downloaded. For archives it will contain the name of the package that is "
7936 "Inside of the single quote is an informative string indicating the progress "
7937 "of the negotiation phase of the download. Typically it progresses from "
7938 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
7939 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
7940 "the remote site. Once the download begins this is represented as "
7941 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
7942 "kilobytes is expected. The total size is always shown in 4 figure notation "
7943 "to preserve space. After the size display is a percent meter for the file "
7944 "itself. The second last element is the instantaneous average speed. This "
7945 "values is updated every 5 seconds and reflects the rate of data transfer for "
7946 "that period. Finally is shown the estimated transfer time. This is updated "
7947 "regularly and reflects the time to complete everything at the shown transfer "
7954 "The status display updates every half second to provide a constant feedback "
7955 "on the download progress while the Get lines scroll back whenever a new file "
7956 "is started. Since the status display is constantly updated it is unsuitable "
7957 "for logging to a file, use the <tt>-q</tt> option to remove the status "
7961 #. type: <heading></heading>
7969 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
7970 "to the <prgn>dpkg</prgn> interface once downloading is "
7971 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
7972 "processes the packages and the packages themselves may also ask several "
7973 "questions. Before each question there is usually a description of what it is "
7974 "asking and the questions are too varied to discuss completely here."
7977 #. type: <title></title>
7979 msgid "Using APT Offline"
7982 #. type: <version></version>
7984 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
7987 #. type: <abstract></abstract>
7990 "This document describes how to use APT in a non-networked environment, "
7991 "specifically a 'sneaker-net' approach for performing upgrades."
7994 #. type: <copyrightsummary></copyrightsummary>
7996 msgid "Copyright © Jason Gunthorpe, 1999."
7999 #. type: <heading></heading>
8001 msgid "Introduction"
8004 #. type: <heading></heading>
8005 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
8012 "Normally APT requires direct access to a Debian archive, either from a local "
8013 "media or through a network. Another common complaint is that a Debian "
8014 "machine is on a slow link, such as a modem and another machine has a very "
8015 "fast connection but they are physically distant."
8021 "The solution to this is to use large removable media such as a Zip disc or a "
8022 "SuperDisk disc. These discs are not large enough to store the entire Debian "
8023 "archive but can easily fit a subset large enough for most users. The idea is "
8024 "to use APT to generate a list of packages that are required and then fetch "
8025 "them onto the disc using another machine with good connectivity. It is even "
8026 "possible to use another Debian machine with APT or to use a completely "
8027 "different OS and a download tool like wget. Let <em>remote host</em> mean "
8028 "the machine downloading the packages, and <em>target host</em> the one with "
8029 "bad or no connection."
8035 "This is achieved by creatively manipulating the APT configuration file. The "
8036 "essential premise to tell APT to look on a disc for it's archive files. Note "
8037 "that the disc should be formated with a filesystem that can handle long file "
8038 "names such as ext2, fat32 or vfat."
8041 #. type: <heading></heading>
8043 msgid "Using APT on both machines"
8046 #. type: <p><example>
8049 "APT being available on both machines gives the simplest configuration. The "
8050 "basic idea is to place a copy of the status file on the disc and use the "
8051 "remote machine to fetch the latest package files and decide which packages "
8052 "to download. The disk directory structure should look like:"
8055 #. type: <example></example>
8069 #. type: <heading></heading>
8071 msgid "The configuration file"
8077 "The configuration file should tell APT to store its files on the disc and to "
8078 "use the configuration files on the disc as well. The sources.list should "
8079 "contain the proper sites that you wish to use from the remote machine, and "
8080 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
8081 "<em>target host</em>. Please note, if you are using a local archive you must "
8082 "use copy URIs, the syntax is identical to file URIs."
8085 #. type: <p><example>
8088 "<em>apt.conf</em> must contain the necessary information to make APT use the "
8092 #. type: <example></example>
8098 " /* This is not necessary if the two machines are the same arch, it "
8100 " the remote APT what architecture the target machine is */\n"
8101 " Architecture \"i386\";\n"
8103 " Get::Download-Only \"true\";\n"
8108 " /* Use the disc for state information and redirect the status file from\n"
8109 " the /var/lib/dpkg default */\n"
8110 " State \"/disc/\";\n"
8111 " State::status \"status\";\n"
8113 " // Binary caches will be stored locally\n"
8114 " Cache::archives \"/disc/archives/\";\n"
8115 " Cache \"/tmp/\";\n"
8117 " // Location of the source list.\n"
8118 " Etc \"/disc/\";\n"
8122 #. type: </example></p>
8125 "More details can be seen by examining the apt.conf man page and the sample "
8126 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
8129 #. type: <p><example>
8132 "On the target machine the first thing to do is mount the disc and copy "
8133 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
8134 "directories outlined in the Overview, <em>archives/partial/</em> and "
8135 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
8136 "configure the sources.list. On the remote machine execute the following:"
8139 #. type: <example></example>
8143 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8144 " # apt-get update\n"
8145 " [ APT fetches the package files ]\n"
8146 " # apt-get dist-upgrade\n"
8147 " [ APT fetches all the packages needed to upgrade the target machine ]"
8150 #. type: </example></p>
8153 "The dist-upgrade command can be replaced with any other standard APT "
8154 "commands, particularly dselect-upgrade. You can even use an APT front end "
8155 "such as <em>dselect</em>. However this presents a problem in communicating "
8156 "your selections back to the local computer."
8159 #. type: <p><example>
8162 "Now the disc contains all of the index files and archives needed to upgrade "
8163 "the target machine. Take the disc back and run:"
8166 #. type: <example></example>
8170 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8171 " # apt-get check\n"
8172 " [ APT generates a local copy of the cache files ]\n"
8173 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
8174 " [ Or any other APT command ]"
8180 "It is necessary for proper function to re-specify the status file to be the "
8181 "local one. This is very important!"
8187 "If you are using dselect you can do the very risky operation of copying "
8188 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
8189 "remote machine are updated. I highly recommend that people only make "
8190 "selections on the local machine - but this may not always be possible. DO "
8191 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
8194 #. type: <heading></heading>
8196 msgid "Using APT and wget"
8202 "<em>wget</em> is a popular and portable download tool that can run on nearly "
8203 "any machine. Unlike the method above this requires that the Debian machine "
8204 "already has a list of available packages."
8210 "The basic idea is to create a disc that has only the archive files "
8211 "downloaded from the remote site. This is done by using the --print-uris "
8212 "option to apt-get and then preparing a wget script to actually fetch the "
8216 #. type: <heading></heading>
8221 #. type: <p><example>
8224 "Unlike the previous technique no special configuration files are "
8225 "required. We merely use the standard APT commands to generate the file list."
8228 #. type: <example></example>
8232 " # apt-get dist-upgrade \n"
8233 " [ Press no when prompted, make sure you are happy with the actions ]\n"
8234 " # apt-get -qq --print-uris dist-upgrade > uris\n"
8235 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
8238 #. type: </example></p>
8241 "Any command other than dist-upgrade could be used here, including "
8248 "The /disc/wget-script file will now contain a list of wget commands to "
8249 "execute in order to fetch the necessary archives. This script should be run "
8250 "with the current directory as the disc's mount point so as to save the "
8251 "output on the disc."
8254 #. type: <p><example>
8256 msgid "The remote machine would do something like"
8259 #. type: <example></example>
8264 " # sh -x ./wget-script\n"
8268 #. type: </example><example>
8271 "Once the archives are downloaded and the disc returned to the Debian machine "
8272 "installation can proceed using,"
8275 #. type: <example></example>
8278 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
8281 #. type: </example></p>
8283 msgid "Which will use the already fetched archives on the disc."