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: 2011-02-14 13:42+0100\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"
15 "Content-Type: text/plain; charset=utf-8\n"
16 "Content-Transfer-Encoding: ENCODING"
33 msgid "Debian GNU/Linux"
44 msgid "apt - Advanced Package Tool"
67 "APT is a management system for software packages. For normal day to day "
68 "package management there are several frontends available, such as "
69 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
70 "System. Some options are only implemented in B<apt-get>(8) though."
82 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
83 "B<apt_preferences>(5), B<apt-secure>(8)"
94 msgid "apt returns zero on normal operation, decimal 100 on error."
105 msgid "This manpage isn't even started."
111 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
112 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
113 "B<reportbug>(1) command."
124 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
129 msgid "<!-- -*- mode: sgml; mode: fold -*- -->"
136 "<!-- Boiler plate docinfo section -->\n"
137 "<!ENTITY apt-docinfo \"\n"
139 " <address><email>apt@packages.debian.org</email></address>\n"
141 " <firstname>Jason</firstname> <surname>Gunthorpe</surname>\n"
142 " <contrib></contrib>\n"
144 " <copyright><year>1998-2001</year> <holder>Jason "
145 "Gunthorpe</holder></copyright>\n"
146 " <date>28 October 2008</date>\n"
147 " <productname>Linux</productname>\n"
156 "<!ENTITY apt-author.team \"\n"
158 " <othername>APT team</othername>\n"
159 " <contrib></contrib>\n"
168 "<!ENTITY apt-qapage \"\n"
170 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
179 "<!-- Boiler plate Bug reporting section -->\n"
180 "<!ENTITY manbugs \"\n"
181 " <refsect1><title>Bugs</title>\n"
182 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
183 " If you wish to report a bug in APT, please see\n"
184 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
185 " &reportbug; command.\n"
195 "<!-- Boiler plate Author section -->\n"
196 "<!ENTITY manauthor \"\n"
197 " <refsect1><title>Author</title>\n"
198 " <para>APT was written by the APT team "
199 "<email>apt@packages.debian.org</email>.\n"
209 "<!-- Should be used within the option section of the text to\n"
210 " put in the blurb about -h, -v, -c and -o -->\n"
211 "<!ENTITY apt-commonoptions \"\n"
212 " <varlistentry><term><option>-h</option></term>\n"
213 " <term><option>--help</option></term>\n"
214 " <listitem><para>Show a short usage summary.\n"
225 " <term><option>-v</option></term>\n"
226 " <term><option>--version</option></term>\n"
227 " <listitem><para>Show the program version.\n"
238 " <term><option>-c</option></term>\n"
239 " <term><option>--config-file</option></term>\n"
240 " <listitem><para>Configuration File; Specify a configuration file to "
242 " The program will read the default configuration file and then this \n"
243 " configuration file. If configuration settings need to be set before "
245 " default configuration files are parsed specify a file with the "
246 "<envar>APT_CONFIG</envar>\n"
247 " environment variable. See &apt-conf; for syntax information.\n"
258 " <term><option>-o</option></term>\n"
259 " <term><option>--option</option></term>\n"
260 " <listitem><para>Set a Configuration Option; This will set an "
262 " configuration option. The syntax is <option>-o "
263 "Foo::Bar=bar</option>.\n"
264 " <option>-o</option> and <option>--option</option> can be used "
266 " times to set different options.\n"
277 "<!-- Should be used within the option section of the text to\n"
278 " put in the blurb about -h, -v, -c and -o -->\n"
279 "<!ENTITY apt-cmdblurb \"\n"
280 " <para>All command line options may be set using the configuration file, "
282 " descriptions indicate the configuration option to set. For boolean\n"
283 " options you can override the config file by using something like \n"
284 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
285 " or several other variations.\n"
294 "<!ENTITY file-aptconf \"\n"
295 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
296 " <listitem><para>APT configuration file.\n"
297 " Configuration Item: "
298 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
306 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
307 " <listitem><para>APT configuration file fragments.\n"
308 " Configuration Item: "
309 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
318 "<!ENTITY file-cachearchives \"\n"
319 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
320 " <listitem><para>Storage area for retrieved package files.\n"
321 " Configuration Item: "
322 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
331 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
332 " <listitem><para>Storage area for package files in transit.\n"
333 " Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit "
334 "partial). </para></listitem>\n"
343 "<!ENTITY file-preferences \"\n"
344 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
345 " <listitem><para>Version preferences file.\n"
346 " This is where you would specify "pinning",\n"
347 " i.e. a preference to get certain packages\n"
348 " from a separate source\n"
349 " or from a different version of a distribution.\n"
350 " Configuration Item: "
351 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
360 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
361 " <listitem><para>File fragments for the version preferences.\n"
362 " Configuration Item: "
363 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
372 "<!ENTITY file-sourceslist \"\n"
373 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
374 " <listitem><para>Locations to fetch packages from.\n"
375 " Configuration Item: "
376 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
385 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
386 " <listitem><para>File fragments for locations to fetch packages from.\n"
387 " Configuration Item: "
388 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
397 "<!ENTITY file-statelists \"\n"
398 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
399 " <listitem><para>Storage area for state information for each package "
400 "resource specified in\n"
402 " Configuration Item: "
403 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
412 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
413 " <listitem><para>Storage area for state information in transit.\n"
414 " Configuration Item: <literal>Dir::State::Lists</literal> (implicit "
415 "partial).</para></listitem>\n"
424 "<!ENTITY file-trustedgpg \"\n"
425 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
426 " <listitem><para>Keyring of local trusted keys, new keys will be added "
428 " Configuration Item: "
429 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
438 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
439 " <listitem><para>File fragments for the trusted keys, additional "
441 " be stored here (by other packages or the administrator).\n"
442 " Configuration Item "
443 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
452 "<!ENTITY file-extended_states \"\n"
454 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
455 " <listitem><para>Status list of auto-installed packages.\n"
456 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
457 " </para></listitem>\n"
466 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
468 " to the other headers like NAME and DESCRIPTION and should therefore be "
470 "<!ENTITY translation-title \"TRANSLATION\">\n"
477 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
479 " to the translation in the past, who is responsible now and maybe "
480 "further information\n"
481 " specially related to your translation. -->\n"
482 "<!ENTITY translation-holder \"\n"
483 " The english translation was done by John Doe "
484 "<email>john@doe.org</email> in 2009,\n"
485 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
487 " Debian Dummy l10n Team "
488 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
496 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
497 "untranslated/fuzzy strings\n"
498 " in a shipped manpage newer/modified paragraphs will maybe appear in "
500 " the generated manpage. This sentence is therefore here to tell the "
502 " is not a mistake by the translator - obviously the target is that at "
504 " releases this sentence is not needed. :) -->\n"
505 "<!ENTITY translation-english \"\n"
506 " Note that this translated document may contain untranslated parts.\n"
507 " This is done on purpose, to avoid losing content when the\n"
508 " translation is lagging behind the original content.\n"
512 #. The last update date
513 #. type: Content of: <refentry><refentryinfo>
514 #: apt-cache.8.xml:16
516 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>04 "
517 "February 2011</date>"
520 #. type: Content of: <refentry><refnamediv><refname>
521 #: apt-cache.8.xml:25 apt-cache.8.xml:32
525 #. type: Content of: <refentry><refmeta><manvolnum>
526 #: 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
530 #. type: Content of: <refentry><refmeta><refmiscinfo>
531 #: 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
535 #. type: Content of: <refentry><refnamediv><refpurpose>
536 #: apt-cache.8.xml:33
537 msgid "query the APT cache"
540 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
541 #: apt-cache.8.xml:39
543 "<command>apt-cache</command> <arg><option>-hvsn</option></arg> "
544 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
545 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
546 "choice=\"req\"> <arg>gencaches</arg> <arg>showpkg <arg choice=\"plain\" "
547 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>showsrc <arg "
548 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
549 "<arg>stats</arg> <arg>dump</arg> <arg>dumpavail</arg> <arg>unmet</arg> "
551 "choice=\"plain\"><replaceable>regex</replaceable></arg></arg> <arg>show <arg "
552 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
553 "<arg>depends <arg choice=\"plain\" "
554 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>rdepends <arg "
555 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
556 "<arg>pkgnames <arg "
557 "choice=\"plain\"><replaceable>prefix</replaceable></arg></arg> <arg>dotty "
558 "<arg choice=\"plain\" "
559 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>xvcg <arg "
560 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
561 "<arg>policy <arg choice=\"plain\" "
562 "rep=\"repeat\"><replaceable>pkgs</replaceable></arg></arg> <arg>madison <arg "
563 "choice=\"plain\" rep=\"repeat\"><replaceable>pkgs</replaceable></arg></arg> "
567 #. type: Content of: <refentry><refsect1><title>
568 #: apt-cache.8.xml:64 apt-cdrom.8.xml:50 apt-config.8.xml:50 apt-extracttemplates.1.xml:46 apt-ftparchive.1.xml:59 apt-get.8.xml:114 apt-key.8.xml:38 apt-mark.8.xml:55 apt-secure.8.xml:43 apt-sortpkgs.1.xml:47 apt.conf.5.xml:42 apt_preferences.5.xml:36 sources.list.5.xml:36
572 #. type: Content of: <refentry><refsect1><para>
573 #: apt-cache.8.xml:65
575 "<command>apt-cache</command> performs a variety of operations on APT's "
576 "package cache. <command>apt-cache</command> does not manipulate the state of "
577 "the system but does provide operations to search and generate interesting "
578 "output from the package metadata."
581 #. type: Content of: <refentry><refsect1><para>
582 #: apt-cache.8.xml:70 apt-get.8.xml:120
584 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
585 "one of the commands below must be present."
588 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
589 #: apt-cache.8.xml:74
593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
594 #: apt-cache.8.xml:75
596 "<literal>gencaches</literal> performs the same operation as <command>apt-get "
597 "check</command>. It builds the source and package caches from the sources in "
598 "&sources-list; and from <filename>/var/lib/dpkg/status</filename>."
601 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
602 #: apt-cache.8.xml:81
603 msgid "showpkg <replaceable>pkg(s)</replaceable>"
606 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
607 #: apt-cache.8.xml:82
609 "<literal>showpkg</literal> displays information about the packages listed on "
610 "the command line. Remaining arguments are package names. The available "
611 "versions and reverse dependencies of each package listed are listed, as well "
612 "as forward dependencies for each version. Forward (normal) dependencies are "
613 "those packages upon which the package in question depends; reverse "
614 "dependencies are those packages that depend upon the package in "
615 "question. Thus, forward dependencies must be satisfied for a package, but "
616 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
617 "libreadline2</command> would produce output similar to the following:"
620 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
621 #: apt-cache.8.xml:94
624 "Package: libreadline2\n"
625 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
626 "Reverse Depends: \n"
627 " libreadlineg2,libreadline2\n"
628 " libreadline2-altdev,libreadline2\n"
630 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
633 "Reverse Provides: \n"
636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
637 #: apt-cache.8.xml:106
639 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
640 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
641 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
642 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
643 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
644 "installed. For the specific meaning of the remainder of the output it is "
645 "best to consult the apt source code."
648 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
649 #: apt-cache.8.xml:115
653 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
654 #: apt-cache.8.xml:115
656 "<literal>stats</literal> displays some statistics about the cache. No "
657 "further arguments are expected. Statistics reported are:"
660 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
661 #: apt-cache.8.xml:118
663 "<literal>Total package names</literal> is the number of package names found "
667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
668 #: apt-cache.8.xml:122
670 "<literal>Normal packages</literal> is the number of regular, ordinary "
671 "package names; these are packages that bear a one-to-one correspondence "
672 "between their names and the names used by other packages for them in "
673 "dependencies. The majority of packages fall into this category."
676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
677 #: apt-cache.8.xml:128
679 "<literal>Pure virtual packages</literal> is the number of packages that "
680 "exist only as a virtual package name; that is, packages only \"provide\" the "
681 "virtual package name, and no package actually uses the name. For instance, "
682 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
683 "package; several packages provide \"mail-transport-agent\", but there is no "
684 "package named \"mail-transport-agent\"."
687 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
688 #: apt-cache.8.xml:136
690 "<literal>Single virtual packages</literal> is the number of packages with "
691 "only one package providing a particular virtual package. For example, in the "
692 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
693 "one package, xless, provides \"X11-text-viewer\"."
696 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
697 #: apt-cache.8.xml:142
699 "<literal>Mixed virtual packages</literal> is the number of packages that "
700 "either provide a particular virtual package or have the virtual package name "
701 "as the package name. For instance, in the Debian GNU/Linux system, "
702 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
706 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
707 #: apt-cache.8.xml:149
709 "<literal>Missing</literal> is the number of package names that were "
710 "referenced in a dependency but were not provided by any package. Missing "
711 "packages may be an evidence if a full distribution is not accessed, or if a "
712 "package (real or virtual) has been dropped from the distribution. Usually "
713 "they are referenced from Conflicts or Breaks statements."
716 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
717 #: apt-cache.8.xml:156
719 "<literal>Total distinct</literal> versions is the number of package versions "
720 "found in the cache; this value is therefore at least equal to the number of "
721 "total package names. If more than one distribution (both \"stable\" and "
722 "\"unstable\", for instance), is being accessed, this value can be "
723 "considerably larger than the number of total package names."
726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
727 #: apt-cache.8.xml:163
729 "<literal>Total dependencies</literal> is the number of dependency "
730 "relationships claimed by all of the packages in the cache."
733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
734 #: apt-cache.8.xml:170
735 msgid "showsrc <replaceable>pkg(s)</replaceable>"
738 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
739 #: apt-cache.8.xml:171
741 "<literal>showsrc</literal> displays all the source package records that "
742 "match the given package names. All versions are shown, as well as all "
743 "records that declare the name to be a Binary."
746 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
747 #: apt-cache.8.xml:176 apt-config.8.xml:87
751 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
752 #: apt-cache.8.xml:177
754 "<literal>dump</literal> shows a short listing of every package in the "
755 "cache. It is primarily for debugging."
758 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
759 #: apt-cache.8.xml:181
763 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
764 #: apt-cache.8.xml:182
766 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
767 "suitable for use with &dpkg; and is used by the &dselect; method."
770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
771 #: apt-cache.8.xml:186
775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
776 #: apt-cache.8.xml:187
778 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
783 #: apt-cache.8.xml:191
784 msgid "show <replaceable>pkg(s)</replaceable>"
787 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
788 #: apt-cache.8.xml:192
790 "<literal>show</literal> performs a function similar to <command>dpkg "
791 "--print-avail</command>; it displays the package records for the named "
795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
796 #: apt-cache.8.xml:197
797 msgid "search <replaceable>regex [ regex ... ]</replaceable>"
800 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
801 #: apt-cache.8.xml:198
803 "<literal>search</literal> performs a full text search on all available "
804 "package lists for the POSIX regex pattern given, see "
805 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
806 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
807 "the descriptions for an occurrence of the regular expression and prints out "
808 "the package name and the short description, including virtual package "
809 "names. If <option>--full</option> is given then output identical to "
810 "<literal>show</literal> is produced for each matched package, and if "
811 "<option>--names-only</option> is given then the long description is not "
812 "searched, only the package name is."
815 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
816 #: apt-cache.8.xml:211
818 "Separate arguments can be used to specify multiple search patterns that are "
822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
823 #: apt-cache.8.xml:215
824 msgid "depends <replaceable>pkg(s)</replaceable>"
827 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
828 #: apt-cache.8.xml:216
830 "<literal>depends</literal> shows a listing of each dependency a package has "
831 "and all the possible other packages that can fulfill that dependency."
834 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
835 #: apt-cache.8.xml:220
836 msgid "rdepends <replaceable>pkg(s)</replaceable>"
839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
840 #: apt-cache.8.xml:221
842 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
847 #: apt-cache.8.xml:225
848 msgid "pkgnames <replaceable>[ prefix ]</replaceable>"
851 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
852 #: apt-cache.8.xml:226
854 "This command prints the name of each package APT knows. The optional "
855 "argument is a prefix match to filter the name list. The output is suitable "
856 "for use in a shell tab complete function and the output is generated "
857 "extremely quickly. This command is best used with the "
858 "<option>--generate</option> option."
861 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
862 #: apt-cache.8.xml:231
864 "Note that a package which APT knows of is not necessarily available to "
865 "download, installable or installed, e.g. virtual packages are also listed in "
866 "the generated list."
869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
870 #: apt-cache.8.xml:236
871 msgid "dotty <replaceable>pkg(s)</replaceable>"
874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
875 #: apt-cache.8.xml:237
877 "<literal>dotty</literal> takes a list of packages on the command line and "
878 "generates output suitable for use by dotty from the <ulink "
879 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
880 "package. The result will be a set of nodes and edges representing the "
881 "relationships between the packages. By default the given packages will trace "
882 "out all dependent packages; this can produce a very large graph. To limit "
883 "the output to only the packages listed on the command line, set the "
884 "<literal>APT::Cache::GivenOnly</literal> option."
887 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
888 #: apt-cache.8.xml:246
890 "The resulting nodes will have several shapes; normal packages are boxes, "
891 "pure provides are triangles, mixed provides are diamonds, missing packages "
892 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
893 "lines are pre-depends, green lines are conflicts."
896 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
897 #: apt-cache.8.xml:251
898 msgid "Caution, dotty cannot graph larger sets of packages."
901 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
902 #: apt-cache.8.xml:254
903 msgid "xvcg <replaceable>pkg(s)</replaceable>"
906 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
907 #: apt-cache.8.xml:255
909 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
910 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
915 #: apt-cache.8.xml:259
916 msgid "policy <replaceable>[ pkg(s) ]</replaceable>"
919 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
920 #: apt-cache.8.xml:260
922 "<literal>policy</literal> is meant to help debug issues relating to the "
923 "preferences file. With no arguments it will print out the priorities of each "
924 "source. Otherwise it prints out detailed information about the priority "
925 "selection of the named package."
928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
929 #: apt-cache.8.xml:266
930 msgid "madison <replaceable>/[ pkg(s) ]</replaceable>"
933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
934 #: apt-cache.8.xml:267
936 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
937 "to mimic the output format and a subset of the functionality of the Debian "
938 "archive management tool, <literal>madison</literal>. It displays available "
939 "versions of a package in a tabular format. Unlike the original "
940 "<literal>madison</literal>, it can only display information for the "
941 "architecture for which APT has retrieved package lists "
942 "(<literal>APT::Architecture</literal>)."
945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
946 #: apt-cache.8.xml:278 apt-config.8.xml:96 apt-extracttemplates.1.xml:59 apt-ftparchive.1.xml:525 apt-get.8.xml:331 apt-mark.8.xml:92 apt-sortpkgs.1.xml:57 apt.conf.5.xml:560 apt.conf.5.xml:582
950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
951 #: apt-cache.8.xml:282
952 msgid "<option>-p</option>"
955 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
956 #: apt-cache.8.xml:282
957 msgid "<option>--pkg-cache</option>"
960 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
961 #: apt-cache.8.xml:283
963 "Select the file to store the package cache. The package cache is the primary "
964 "cache used by all operations. Configuration Item: "
965 "<literal>Dir::Cache::pkgcache</literal>."
968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
969 #: apt-cache.8.xml:288 apt-ftparchive.1.xml:568 apt-get.8.xml:393 apt-sortpkgs.1.xml:61
970 msgid "<option>-s</option>"
973 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
974 #: apt-cache.8.xml:288
975 msgid "<option>--src-cache</option>"
978 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
979 #: apt-cache.8.xml:289
981 "Select the file to store the source cache. The source is used only by "
982 "<literal>gencaches</literal> and it stores a parsed version of the package "
983 "information from remote sources. When building the package cache the source "
984 "cache is used to avoid reparsing all of the package files. Configuration "
985 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
989 #: apt-cache.8.xml:296 apt-ftparchive.1.xml:542 apt-get.8.xml:383
990 msgid "<option>-q</option>"
993 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
994 #: apt-cache.8.xml:296 apt-ftparchive.1.xml:542 apt-get.8.xml:383
995 msgid "<option>--quiet</option>"
998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
999 #: apt-cache.8.xml:297
1001 "Quiet; produces output suitable for logging, omitting progress indicators. "
1002 "More q's will produce more quietness up to a maximum of 2. You can also use "
1003 "<option>-q=#</option> to set the quietness level, overriding the "
1004 "configuration file. Configuration Item: <literal>quiet</literal>."
1007 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1008 #: apt-cache.8.xml:303
1009 msgid "<option>-i</option>"
1012 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1013 #: apt-cache.8.xml:303
1014 msgid "<option>--important</option>"
1017 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1018 #: apt-cache.8.xml:304
1020 "Print only important dependencies; for use with unmet and depends. Causes "
1021 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
1022 "<literal>APT::Cache::Important</literal>."
1025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1026 #: apt-cache.8.xml:309
1027 msgid "<option>--no-pre-depends</option>"
1030 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1031 #: apt-cache.8.xml:310
1032 msgid "<option>--no-depends</option>"
1035 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1036 #: apt-cache.8.xml:311
1037 msgid "<option>--no-recommends</option>"
1040 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1041 #: apt-cache.8.xml:312
1042 msgid "<option>--no-suggests</option>"
1045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1046 #: apt-cache.8.xml:313
1047 msgid "<option>--no-conflicts</option>"
1050 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1051 #: apt-cache.8.xml:314
1052 msgid "<option>--no-breaks</option>"
1055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1056 #: apt-cache.8.xml:315
1057 msgid "<option>--no-replaces</option>"
1060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1061 #: apt-cache.8.xml:316
1062 msgid "<option>--no-enhances</option>"
1065 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1066 #: apt-cache.8.xml:317
1068 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1069 "print all dependencies. This can be twicked with these flags which will omit "
1070 "the specified dependency type. Configuration Item: "
1071 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1072 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1075 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1076 #: apt-cache.8.xml:323 apt-cdrom.8.xml:124 apt-get.8.xml:350
1077 msgid "<option>-f</option>"
1080 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1081 #: apt-cache.8.xml:323
1082 msgid "<option>--full</option>"
1085 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1086 #: apt-cache.8.xml:324
1088 "Print full package records when searching. Configuration Item: "
1089 "<literal>APT::Cache::ShowFull</literal>."
1092 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1093 #: apt-cache.8.xml:328 apt-cdrom.8.xml:134 apt-ftparchive.1.xml:580
1094 msgid "<option>-a</option>"
1097 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1098 #: apt-cache.8.xml:328
1099 msgid "<option>--all-versions</option>"
1102 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1103 #: apt-cache.8.xml:329
1105 "Print full records for all available versions. This is the default; to turn "
1106 "it off, use <option>--no-all-versions</option>. If "
1107 "<option>--no-all-versions</option> is specified, only the candidate version "
1108 "will displayed (the one which would be selected for installation). This "
1109 "option is only applicable to the <literal>show</literal> command. "
1110 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1113 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1114 #: apt-cache.8.xml:337
1115 msgid "<option>-g</option>"
1118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1119 #: apt-cache.8.xml:337
1120 msgid "<option>--generate</option>"
1123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1124 #: apt-cache.8.xml:338
1126 "Perform automatic package cache regeneration, rather than use the cache as "
1127 "it is. This is the default; to turn it off, use "
1128 "<option>--no-generate</option>. Configuration Item: "
1129 "<literal>APT::Cache::Generate</literal>."
1132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1133 #: apt-cache.8.xml:343
1134 msgid "<option>--names-only</option>"
1137 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1138 #: apt-cache.8.xml:343 apt-cdrom.8.xml:142
1139 msgid "<option>-n</option>"
1142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1143 #: apt-cache.8.xml:344
1145 "Only search on the package names, not the long descriptions. Configuration "
1146 "Item: <literal>APT::Cache::NamesOnly</literal>."
1149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1150 #: apt-cache.8.xml:348
1151 msgid "<option>--all-names</option>"
1154 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1155 #: apt-cache.8.xml:349
1157 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1158 "and missing dependencies. Configuration Item: "
1159 "<literal>APT::Cache::AllNames</literal>."
1162 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1163 #: apt-cache.8.xml:354
1164 msgid "<option>--recurse</option>"
1167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1168 #: apt-cache.8.xml:355
1170 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1171 "that all packages mentioned are printed once. Configuration Item: "
1172 "<literal>APT::Cache::RecurseDepends</literal>."
1175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1176 #: apt-cache.8.xml:360
1177 msgid "<option>--installed</option>"
1180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1181 #: apt-cache.8.xml:362
1183 "Limit the output of <literal>depends</literal> and "
1184 "<literal>rdepends</literal> to packages which are currently installed. "
1185 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1188 #. type: Content of: <refentry><refsect1><variablelist>
1189 #: apt-cache.8.xml:367 apt-cdrom.8.xml:153 apt-config.8.xml:101 apt-extracttemplates.1.xml:70 apt-ftparchive.1.xml:608 apt-get.8.xml:570 apt-sortpkgs.1.xml:67
1190 msgid "&apt-commonoptions;"
1193 #. type: Content of: <refentry><refsect1><title>
1194 #: apt-cache.8.xml:372 apt-get.8.xml:575 apt-key.8.xml:156 apt-mark.8.xml:125 apt.conf.5.xml:1093 apt_preferences.5.xml:649
1198 #. type: Content of: <refentry><refsect1><variablelist>
1199 #: apt-cache.8.xml:374
1200 msgid "&file-sourceslist; &file-statelists;"
1203 #. type: Content of: <refentry><refsect1><title>
1204 #: apt-cache.8.xml:379 apt-cdrom.8.xml:158 apt-config.8.xml:106 apt-extracttemplates.1.xml:77 apt-ftparchive.1.xml:624 apt-get.8.xml:585 apt-key.8.xml:177 apt-mark.8.xml:131 apt-secure.8.xml:185 apt-sortpkgs.1.xml:72 apt.conf.5.xml:1099 apt_preferences.5.xml:656 sources.list.5.xml:234
1208 #. type: Content of: <refentry><refsect1><para>
1209 #: apt-cache.8.xml:380
1210 msgid "&apt-conf;, &sources-list;, &apt-get;"
1213 #. type: Content of: <refentry><refsect1><title>
1214 #: apt-cache.8.xml:384 apt-cdrom.8.xml:163 apt-config.8.xml:111 apt-extracttemplates.1.xml:81 apt-ftparchive.1.xml:628 apt-get.8.xml:591 apt-mark.8.xml:135 apt-sortpkgs.1.xml:76
1218 #. type: Content of: <refentry><refsect1><para>
1219 #: apt-cache.8.xml:385
1221 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1225 #. type: Content of: <refentry><refentryinfo>
1226 #: apt-cdrom.8.xml:16
1228 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>14 "
1229 "February 2004</date>"
1232 #. type: Content of: <refentry><refnamediv><refname>
1233 #: apt-cdrom.8.xml:24 apt-cdrom.8.xml:31
1237 #. type: Content of: <refentry><refnamediv><refpurpose>
1238 #: apt-cdrom.8.xml:32
1239 msgid "APT CDROM management utility"
1242 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1243 #: apt-cdrom.8.xml:38
1245 "<command>apt-cdrom</command> <arg><option>-hvrmfan</option></arg> "
1246 "<arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg> "
1247 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
1248 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group> "
1249 "<arg>add</arg> <arg>ident</arg> </group>"
1252 #. type: Content of: <refentry><refsect1><para>
1253 #: apt-cdrom.8.xml:51
1255 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1256 "available sources. <command>apt-cdrom</command> takes care of determining "
1257 "the structure of the disc as well as correcting for several possible "
1258 "mis-burns and verifying the index files."
1261 #. type: Content of: <refentry><refsect1><para>
1262 #: apt-cdrom.8.xml:58
1264 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1265 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1266 "must be inserted and scanned separately to account for possible mis-burns."
1269 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1270 #: apt-cdrom.8.xml:68
1274 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1275 #: apt-cdrom.8.xml:69
1277 "<literal>add</literal> is used to add a new disc to the source list. It will "
1278 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1279 "to scan it and copy the index files. If the disc does not have a proper "
1280 "<filename>disk</filename> directory you will be prompted for a descriptive "
1284 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1285 #: apt-cdrom.8.xml:77
1287 "APT uses a CDROM ID to track which disc is currently in the drive and "
1288 "maintains a database of these IDs in "
1289 "<filename>&statedir;/cdroms.list</filename>"
1292 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1293 #: apt-cdrom.8.xml:84
1297 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1298 #: apt-cdrom.8.xml:85
1300 "A debugging tool to report the identity of the current disc as well as the "
1304 #. type: Content of: <refentry><refsect1><para>
1305 #: apt-cdrom.8.xml:64
1307 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1308 "one of the commands below must be present. <placeholder "
1309 "type=\"variablelist\" id=\"0\"/>"
1312 #. type: Content of: <refentry><refsect1><title>
1313 #: apt-cdrom.8.xml:94 apt-key.8.xml:142
1317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1318 #: apt-cdrom.8.xml:98 apt-ftparchive.1.xml:536 apt-get.8.xml:345
1319 msgid "<option>-d</option>"
1322 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1323 #: apt-cdrom.8.xml:98
1324 msgid "<option>--cdrom</option>"
1327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1328 #: apt-cdrom.8.xml:99
1330 "Mount point; specify the location to mount the cdrom. This mount point must "
1331 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1332 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1335 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1336 #: apt-cdrom.8.xml:107
1337 msgid "<option>-r</option>"
1340 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1341 #: apt-cdrom.8.xml:107
1342 msgid "<option>--rename</option>"
1345 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1346 #: apt-cdrom.8.xml:108
1348 "Rename a disc; change the label of a disk or override the disks given "
1349 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1350 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1353 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1354 #: apt-cdrom.8.xml:116 apt-get.8.xml:364
1355 msgid "<option>-m</option>"
1358 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1359 #: apt-cdrom.8.xml:116
1360 msgid "<option>--no-mount</option>"
1363 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1364 #: apt-cdrom.8.xml:117
1366 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1367 "unmounting the mount point. Configuration Item: "
1368 "<literal>APT::CDROM::NoMount</literal>."
1371 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1372 #: apt-cdrom.8.xml:124
1373 msgid "<option>--fast</option>"
1376 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1377 #: apt-cdrom.8.xml:125
1379 "Fast Copy; Assume the package files are valid and do not check every "
1380 "package. This option should be used only if <command>apt-cdrom</command> has "
1381 "been run on this disc before and did not detect any errors. Configuration "
1382 "Item: <literal>APT::CDROM::Fast</literal>."
1385 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1386 #: apt-cdrom.8.xml:134
1387 msgid "<option>--thorough</option>"
1390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1391 #: apt-cdrom.8.xml:135
1393 "Thorough Package Scan; This option may be needed with some old Debian "
1394 "1.1/1.2 discs that have Package files in strange places. It takes much "
1395 "longer to scan the CD but will pick them all up."
1398 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1399 #: apt-cdrom.8.xml:143 apt-get.8.xml:395
1400 msgid "<option>--just-print</option>"
1403 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1404 #: apt-cdrom.8.xml:144 apt-get.8.xml:397
1405 msgid "<option>--recon</option>"
1408 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1409 #: apt-cdrom.8.xml:145 apt-get.8.xml:398
1410 msgid "<option>--no-act</option>"
1413 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1414 #: apt-cdrom.8.xml:146
1416 "No Changes; Do not change the &sources-list; file and do not write index "
1417 "files. Everything is still checked however. Configuration Item: "
1418 "<literal>APT::CDROM::NoAct</literal>."
1421 #. type: Content of: <refentry><refsect1><para>
1422 #: apt-cdrom.8.xml:159
1423 msgid "&apt-conf;, &apt-get;, &sources-list;"
1426 #. type: Content of: <refentry><refsect1><para>
1427 #: apt-cdrom.8.xml:164
1429 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1433 #. The last update date
1434 #. type: Content of: <refentry><refentryinfo>
1435 #: apt-config.8.xml:16 apt-extracttemplates.1.xml:16 apt-sortpkgs.1.xml:16 sources.list.5.xml:16
1437 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>29 "
1438 "February 2004</date>"
1441 #. type: Content of: <refentry><refnamediv><refname>
1442 #: apt-config.8.xml:25 apt-config.8.xml:32
1446 #. type: Content of: <refentry><refnamediv><refpurpose>
1447 #: apt-config.8.xml:33
1448 msgid "APT Configuration Query program"
1451 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1452 #: apt-config.8.xml:39
1454 "<command>apt-config</command> <arg><option>-hv</option></arg> "
1455 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
1456 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
1457 "choice=\"req\"> <arg>shell</arg> <arg>dump</arg> </group>"
1460 #. type: Content of: <refentry><refsect1><para>
1461 #: apt-config.8.xml:51
1463 "<command>apt-config</command> is an internal program used by various "
1464 "portions of the APT suite to provide consistent configurability. It accesses "
1465 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1466 "manner that is easy to use by scripted applications."
1469 #. type: Content of: <refentry><refsect1><para>
1470 #: apt-config.8.xml:56 apt-ftparchive.1.xml:75
1472 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1473 "one of the commands below must be present."
1476 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1477 #: apt-config.8.xml:61
1481 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1482 #: apt-config.8.xml:63
1484 "shell is used to access the configuration information from a shell "
1485 "script. It is given pairs of arguments, the first being a shell variable and "
1486 "the second the configuration value to query. As output it lists a series of "
1487 "shell assignments commands for each present value. In a shell script it "
1488 "should be used like:"
1491 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1492 #: apt-config.8.xml:71
1496 "RES=`apt-config shell OPTS MyApp::options`\n"
1500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1501 #: apt-config.8.xml:76
1503 "This will set the shell environment variable $OPTS to the value of "
1504 "MyApp::options with a default of <option>-f</option>."
1507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1508 #: apt-config.8.xml:80
1510 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1511 "names, d returns directories, b returns true or false and i returns an "
1512 "integer. Each of the returns is normalized and verified internally."
1515 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1516 #: apt-config.8.xml:89
1517 msgid "Just show the contents of the configuration space."
1520 #. type: Content of: <refentry><refsect1><para>
1521 #: apt-config.8.xml:107 apt-extracttemplates.1.xml:78 apt-ftparchive.1.xml:625 apt-sortpkgs.1.xml:73
1525 #. type: Content of: <refentry><refsect1><para>
1526 #: apt-config.8.xml:112
1528 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1532 #. type: Content of: <refentry><refnamediv><refname>
1533 #: apt-extracttemplates.1.xml:25 apt-extracttemplates.1.xml:32
1534 msgid "apt-extracttemplates"
1537 #. type: Content of: <refentry><refmeta><manvolnum>
1538 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1542 #. type: Content of: <refentry><refnamediv><refpurpose>
1543 #: apt-extracttemplates.1.xml:33
1544 msgid "Utility to extract DebConf config and templates from Debian packages"
1547 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1548 #: apt-extracttemplates.1.xml:39
1550 "<command>apt-extracttemplates</command> <arg><option>-hv</option></arg> "
1551 "<arg><option>-t=<replaceable>temporary "
1552 "directory</replaceable></option></arg> <arg choice=\"plain\" "
1553 "rep=\"repeat\"><replaceable>file</replaceable></arg>"
1556 #. type: Content of: <refentry><refsect1><para>
1557 #: apt-extracttemplates.1.xml:47
1559 "<command>apt-extracttemplates</command> will take one or more Debian package "
1560 "files as input and write out (to a temporary directory) all associated "
1561 "config scripts and template files. For each passed in package that contains "
1562 "config scripts and templates, one line of output will be generated in the "
1566 #. type: Content of: <refentry><refsect1><para>
1567 #: apt-extracttemplates.1.xml:52
1568 msgid "package version template-file config-script"
1571 #. type: Content of: <refentry><refsect1><para>
1572 #: apt-extracttemplates.1.xml:53
1574 "template-file and config-script are written to the temporary directory "
1575 "specified by the -t or --tempdir "
1576 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1577 "filenames of the form <filename>package.template.XXXX</filename> and "
1578 "<filename>package.config.XXXX</filename>"
1581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1582 #: apt-extracttemplates.1.xml:63 apt-get.8.xml:504
1583 msgid "<option>-t</option>"
1586 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1587 #: apt-extracttemplates.1.xml:63
1588 msgid "<option>--tempdir</option>"
1591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1592 #: apt-extracttemplates.1.xml:65
1594 "Temporary directory in which to write extracted debconf template files and "
1595 "config scripts. Configuration Item: "
1596 "<literal>APT::ExtractTemplates::TempDir</literal>"
1599 #. type: Content of: <refentry><refsect1><para>
1600 #: apt-extracttemplates.1.xml:82
1602 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1603 "decimal 100 on error."
1606 #. The last update date
1607 #. type: Content of: <refentry><refentryinfo>
1608 #: apt-ftparchive.1.xml:16
1610 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>17 "
1611 "August 2009</date>"
1614 #. type: Content of: <refentry><refnamediv><refname>
1615 #: apt-ftparchive.1.xml:25 apt-ftparchive.1.xml:32
1616 msgid "apt-ftparchive"
1619 #. type: Content of: <refentry><refnamediv><refpurpose>
1620 #: apt-ftparchive.1.xml:33
1621 msgid "Utility to generate index files"
1624 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1625 #: apt-ftparchive.1.xml:39
1627 "<command>apt-ftparchive</command> <arg><option>-hvdsq</option></arg> "
1628 "<arg><option>--md5</option></arg> <arg><option>--delink</option></arg> "
1629 "<arg><option>--readonly</option></arg> "
1630 "<arg><option>--contents</option></arg> <arg><option>--arch "
1631 "<replaceable>architecture</replaceable></option></arg> <arg><option>-o "
1632 "<replaceable>config</replaceable>=<replaceable>string</replaceable></option></arg> "
1633 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
1634 "choice=\"req\"> <arg>packages<arg choice=\"plain\" "
1635 "rep=\"repeat\"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg> "
1636 "<arg>sources<arg choice=\"plain\" "
1637 "rep=\"repeat\"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg> "
1638 "<arg>contents <arg "
1639 "choice=\"plain\"><replaceable>path</replaceable></arg></arg> <arg>release "
1640 "<arg choice=\"plain\"><replaceable>path</replaceable></arg></arg> "
1641 "<arg>generate <arg "
1642 "choice=\"plain\"><replaceable>config-file</replaceable></arg> <arg "
1644 "rep=\"repeat\"><replaceable>section</replaceable></arg></arg> <arg>clean "
1645 "<arg choice=\"plain\"><replaceable>config-file</replaceable></arg></arg> "
1649 #. type: Content of: <refentry><refsect1><para>
1650 #: apt-ftparchive.1.xml:60
1652 "<command>apt-ftparchive</command> is the command line tool that generates "
1653 "the index files that APT uses to access a distribution source. The index "
1654 "files should be generated on the origin site based on the content of that "
1658 #. type: Content of: <refentry><refsect1><para>
1659 #: apt-ftparchive.1.xml:64
1661 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1662 "program, incorporating its entire functionality via the "
1663 "<literal>packages</literal> command. It also contains a contents file "
1664 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1665 "the generation process for a complete archive."
1668 #. type: Content of: <refentry><refsect1><para>
1669 #: apt-ftparchive.1.xml:70
1671 "Internally <command>apt-ftparchive</command> can make use of binary "
1672 "databases to cache the contents of a .deb file and it does not rely on any "
1673 "external programs aside from &gzip;. When doing a full generate it "
1674 "automatically performs file-change checks and builds the desired compressed "
1678 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1679 #: apt-ftparchive.1.xml:79
1683 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1684 #: apt-ftparchive.1.xml:81
1686 "The packages command generates a package file from a directory tree. It "
1687 "takes the given directory and recursively searches it for .deb files, "
1688 "emitting a package record to stdout for each. This command is approximately "
1689 "equivalent to &dpkg-scanpackages;."
1692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1693 #: apt-ftparchive.1.xml:86 apt-ftparchive.1.xml:110
1694 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1698 #: apt-ftparchive.1.xml:89
1702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1703 #: apt-ftparchive.1.xml:91
1705 "The <literal>sources</literal> command generates a source index file from a "
1706 "directory tree. It takes the given directory and recursively searches it "
1707 "for .dsc files, emitting a source record to stdout for each. This command is "
1708 "approximately equivalent to &dpkg-scansources;."
1711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1712 #: apt-ftparchive.1.xml:96
1714 "If an override file is specified then a source override file will be looked "
1715 "for with an extension of .src. The --source-override option can be used to "
1716 "change the source override file that will be used."
1719 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1720 #: apt-ftparchive.1.xml:101
1724 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1725 #: apt-ftparchive.1.xml:103
1727 "The <literal>contents</literal> command generates a contents file from a "
1728 "directory tree. It takes the given directory and recursively searches it for "
1729 ".deb files, and reads the file list from each file. It then sorts and writes "
1730 "to stdout the list of files matched to packages. Directories are not written "
1731 "to the output. If multiple packages own the same file then each package is "
1732 "separated by a comma in the output."
1735 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1736 #: apt-ftparchive.1.xml:113
1740 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1741 #: apt-ftparchive.1.xml:115
1743 "The <literal>release</literal> command generates a Release file from a "
1744 "directory tree. It recursively searches the given directory for uncompressed "
1745 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1746 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1747 "<command>lzma</command> as well as <filename>Release</filename> and "
1748 "<filename>md5sum.txt</filename> files by default "
1749 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1750 "filename patterns can be added by listing them in "
1751 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1752 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1757 #: apt-ftparchive.1.xml:125
1759 "Values for the additional metadata fields in the Release file are taken from "
1760 "the corresponding variables under "
1761 "<literal>APT::FTPArchive::Release</literal>, "
1762 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1763 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1764 "<literal>Suite</literal>, <literal>Version</literal>, "
1765 "<literal>Codename</literal>, <literal>Date</literal>, "
1766 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1767 "<literal>Components</literal>, <literal>Description</literal>."
1770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1771 #: apt-ftparchive.1.xml:136
1775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1776 #: apt-ftparchive.1.xml:138
1778 "The <literal>generate</literal> command is designed to be runnable from a "
1779 "cron script and builds indexes according to the given config file. The "
1780 "config language provides a flexible means of specifying which index files "
1781 "are built from which directories, as well as providing a simple means of "
1782 "maintaining the required settings."
1785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1786 #: apt-ftparchive.1.xml:145 apt-get.8.xml:287
1790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1791 #: apt-ftparchive.1.xml:147
1793 "The <literal>clean</literal> command tidies the databases used by the given "
1794 "configuration file by removing any records that are no longer necessary."
1797 #. type: Content of: <refentry><refsect1><title>
1798 #: apt-ftparchive.1.xml:153
1799 msgid "The Generate Configuration"
1802 #. type: Content of: <refentry><refsect1><para>
1803 #: apt-ftparchive.1.xml:155
1805 "The <literal>generate</literal> command uses a configuration file to "
1806 "describe the archives that are going to be generated. It follows the typical "
1807 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1808 "&apt-conf; contains a description of the syntax. Note that the generate "
1809 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1810 "tree manner. This only effects how the scope tag is handled."
1813 #. type: Content of: <refentry><refsect1><para>
1814 #: apt-ftparchive.1.xml:163
1815 msgid "The generate configuration has 4 separate sections, each described below."
1818 #. type: Content of: <refentry><refsect1><refsect2><title>
1819 #: apt-ftparchive.1.xml:165
1823 #. type: Content of: <refentry><refsect1><refsect2><para>
1824 #: apt-ftparchive.1.xml:167
1826 "The <literal>Dir</literal> section defines the standard directories needed "
1827 "to locate the files required during the generation process. These "
1828 "directories are prepended certain relative paths defined in later sections "
1829 "to produce a complete an absolute path."
1832 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1833 #: apt-ftparchive.1.xml:172
1837 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1838 #: apt-ftparchive.1.xml:174
1840 "Specifies the root of the FTP archive, in a standard Debian configuration "
1841 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1845 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1846 #: apt-ftparchive.1.xml:179
1850 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1851 #: apt-ftparchive.1.xml:181
1852 msgid "Specifies the location of the override files."
1855 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1856 #: apt-ftparchive.1.xml:184
1860 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1861 #: apt-ftparchive.1.xml:186
1862 msgid "Specifies the location of the cache files"
1865 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1866 #: apt-ftparchive.1.xml:189
1870 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1871 #: apt-ftparchive.1.xml:191
1873 "Specifies the location of the file list files, if the "
1874 "<literal>FileList</literal> setting is used below."
1877 #. type: Content of: <refentry><refsect1><refsect2><title>
1878 #: apt-ftparchive.1.xml:197
1879 msgid "Default Section"
1882 #. type: Content of: <refentry><refsect1><refsect2><para>
1883 #: apt-ftparchive.1.xml:199
1885 "The <literal>Default</literal> section specifies default values, and "
1886 "settings that control the operation of the generator. Other sections may "
1887 "override these defaults with a per-section setting."
1890 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1891 #: apt-ftparchive.1.xml:203
1892 msgid "Packages::Compress"
1895 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1896 #: apt-ftparchive.1.xml:205
1898 "Sets the default compression schemes to use for the Package index files. It "
1899 "is a string that contains a space separated list of at least one of: '.' (no "
1900 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1904 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1905 #: apt-ftparchive.1.xml:211
1906 msgid "Packages::Extensions"
1909 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1910 #: apt-ftparchive.1.xml:213
1912 "Sets the default list of file extensions that are package files. This "
1913 "defaults to '.deb'."
1916 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1917 #: apt-ftparchive.1.xml:217
1918 msgid "Sources::Compress"
1921 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1922 #: apt-ftparchive.1.xml:219
1924 "This is similar to <literal>Packages::Compress</literal> except that it "
1925 "controls the compression for the Sources files."
1928 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1929 #: apt-ftparchive.1.xml:223
1930 msgid "Sources::Extensions"
1933 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1934 #: apt-ftparchive.1.xml:225
1936 "Sets the default list of file extensions that are source files. This "
1937 "defaults to '.dsc'."
1940 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1941 #: apt-ftparchive.1.xml:229
1942 msgid "Contents::Compress"
1945 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1946 #: apt-ftparchive.1.xml:231
1948 "This is similar to <literal>Packages::Compress</literal> except that it "
1949 "controls the compression for the Contents files."
1952 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1953 #: apt-ftparchive.1.xml:235
1954 msgid "Translation::Compress"
1957 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1958 #: apt-ftparchive.1.xml:237
1960 "This is similar to <literal>Packages::Compress</literal> except that it "
1961 "controls the compression for the Translation-en master file."
1964 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1965 #: apt-ftparchive.1.xml:241
1969 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1970 #: apt-ftparchive.1.xml:243
1972 "Specifies the number of kilobytes to delink (and replace with hard links) "
1973 "per run. This is used in conjunction with the per-section "
1974 "<literal>External-Links</literal> setting."
1977 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1978 #: apt-ftparchive.1.xml:248
1982 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1983 #: apt-ftparchive.1.xml:250
1985 "Specifies the mode of all created index files. It defaults to 0644. All "
1986 "index files are set to this mode with no regard to the umask."
1989 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1990 #: apt-ftparchive.1.xml:255 apt-ftparchive.1.xml:401
1991 msgid "LongDescription"
1994 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1995 #: apt-ftparchive.1.xml:257 apt-ftparchive.1.xml:403
1997 "Sets if long descriptions should be included in the Packages file or split "
1998 "out into a master Translation-en file."
2001 #. type: Content of: <refentry><refsect1><refsect2><title>
2002 #: apt-ftparchive.1.xml:263
2003 msgid "TreeDefault Section"
2006 #. type: Content of: <refentry><refsect1><refsect2><para>
2007 #: apt-ftparchive.1.xml:265
2009 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
2010 "variables are substitution variables and have the strings $(DIST), "
2011 "$(SECTION) and $(ARCH) replaced with their respective values."
2014 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2015 #: apt-ftparchive.1.xml:270
2016 msgid "MaxContentsChange"
2019 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2020 #: apt-ftparchive.1.xml:272
2022 "Sets the number of kilobytes of contents files that are generated each "
2023 "day. The contents files are round-robined so that over several days they "
2024 "will all be rebuilt."
2027 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2028 #: apt-ftparchive.1.xml:277
2032 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2033 #: apt-ftparchive.1.xml:279
2035 "Controls the number of days a contents file is allowed to be checked without "
2036 "changing. If this limit is passed the mtime of the contents file is "
2037 "updated. This case can occur if the package file is changed in such a way "
2038 "that does not result in a new contents file [override edit for instance]. A "
2039 "hold off is allowed in hopes that new .debs will be installed, requiring a "
2040 "new file anyhow. The default is 10, the units are in days."
2043 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2044 #: apt-ftparchive.1.xml:288
2048 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2049 #: apt-ftparchive.1.xml:290
2051 "Sets the top of the .deb directory tree. Defaults to "
2052 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
2055 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2056 #: apt-ftparchive.1.xml:294
2057 msgid "SrcDirectory"
2060 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2061 #: apt-ftparchive.1.xml:296
2063 "Sets the top of the source package directory tree. Defaults to "
2064 "<filename>$(DIST)/$(SECTION)/source/</filename>"
2067 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2068 #: apt-ftparchive.1.xml:300 apt-ftparchive.1.xml:439
2072 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2073 #: apt-ftparchive.1.xml:302
2075 "Sets the output Packages file. Defaults to "
2076 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
2079 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2080 #: apt-ftparchive.1.xml:306 apt-ftparchive.1.xml:444
2084 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2085 #: apt-ftparchive.1.xml:308
2087 "Sets the output Sources file. Defaults to "
2088 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
2091 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2092 #: apt-ftparchive.1.xml:312
2096 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2097 #: apt-ftparchive.1.xml:314
2099 "Set the output Translation-en master file with the long descriptions if they "
2100 "should be not included in the Packages file. Defaults to "
2101 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
2104 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2105 #: apt-ftparchive.1.xml:319
2106 msgid "InternalPrefix"
2109 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2110 #: apt-ftparchive.1.xml:321
2112 "Sets the path prefix that causes a symlink to be considered an internal link "
2113 "instead of an external link. Defaults to "
2114 "<filename>$(DIST)/$(SECTION)/</filename>"
2117 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2118 #: apt-ftparchive.1.xml:326 apt-ftparchive.1.xml:450
2122 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2123 #: apt-ftparchive.1.xml:328
2125 "Sets the output Contents file. Defaults to "
2126 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
2127 "multiple Packages files to map onto a single Contents file (such as the "
2128 "default) then <command>apt-ftparchive</command> will integrate those "
2129 "package files together automatically."
2132 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2133 #: apt-ftparchive.1.xml:335
2134 msgid "Contents::Header"
2137 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2138 #: apt-ftparchive.1.xml:337
2139 msgid "Sets header file to prepend to the contents output."
2142 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2143 #: apt-ftparchive.1.xml:340 apt-ftparchive.1.xml:475
2147 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2148 #: apt-ftparchive.1.xml:342
2150 "Sets the binary cache database to use for this section. Multiple sections "
2151 "can share the same database."
2154 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2155 #: apt-ftparchive.1.xml:346
2159 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2160 #: apt-ftparchive.1.xml:348
2162 "Specifies that instead of walking the directory tree, "
2163 "<command>apt-ftparchive</command> should read the list of files from the "
2164 "given file. Relative files names are prefixed with the archive directory."
2167 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2168 #: apt-ftparchive.1.xml:353
2169 msgid "SourceFileList"
2172 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2173 #: apt-ftparchive.1.xml:355
2175 "Specifies that instead of walking the directory tree, "
2176 "<command>apt-ftparchive</command> should read the list of files from the "
2177 "given file. Relative files names are prefixed with the archive directory. "
2178 "This is used when processing source indexes."
2181 #. type: Content of: <refentry><refsect1><refsect2><title>
2182 #: apt-ftparchive.1.xml:363
2183 msgid "Tree Section"
2186 #. type: Content of: <refentry><refsect1><refsect2><para>
2187 #: apt-ftparchive.1.xml:365
2189 "The <literal>Tree</literal> section defines a standard Debian file tree "
2190 "which consists of a base directory, then multiple sections in that base "
2191 "directory and finally multiple Architectures in each section. The exact "
2192 "pathing used is defined by the <literal>Directory</literal> substitution "
2196 #. type: Content of: <refentry><refsect1><refsect2><para>
2197 #: apt-ftparchive.1.xml:370
2199 "The <literal>Tree</literal> section takes a scope tag which sets the "
2200 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
2201 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
2202 "setting such as <filename>dists/&stable-codename;</filename>."
2205 #. type: Content of: <refentry><refsect1><refsect2><para>
2206 #: apt-ftparchive.1.xml:375
2208 "All of the settings defined in the <literal>TreeDefault</literal> section "
2209 "can be use in a <literal>Tree</literal> section as well as three new "
2213 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
2214 #: apt-ftparchive.1.xml:381
2217 "for i in Sections do \n"
2218 " for j in Architectures do\n"
2219 " Generate for DIST=scope SECTION=i ARCH=j\n"
2223 #. type: Content of: <refentry><refsect1><refsect2><para>
2224 #: apt-ftparchive.1.xml:378
2226 "When processing a <literal>Tree</literal> section "
2227 "<command>apt-ftparchive</command> performs an operation similar to: "
2228 "<placeholder type=\"programlisting\" id=\"0\"/>"
2231 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2232 #: apt-ftparchive.1.xml:387
2236 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2237 #: apt-ftparchive.1.xml:389
2239 "This is a space separated list of sections which appear under the "
2240 "distribution, typically this is something like <literal>main contrib "
2241 "non-free</literal>"
2244 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2245 #: apt-ftparchive.1.xml:394
2246 msgid "Architectures"
2249 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2250 #: apt-ftparchive.1.xml:396
2252 "This is a space separated list of all the architectures that appear under "
2253 "search section. The special architecture 'source' is used to indicate that "
2254 "this tree has a source archive."
2257 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2258 #: apt-ftparchive.1.xml:407 apt-ftparchive.1.xml:455
2262 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2263 #: apt-ftparchive.1.xml:409
2265 "Sets the binary override file. The override file contains section, priority "
2266 "and maintainer address information."
2269 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2270 #: apt-ftparchive.1.xml:413 apt-ftparchive.1.xml:460
2274 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2275 #: apt-ftparchive.1.xml:415
2277 "Sets the source override file. The override file contains section "
2281 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2282 #: apt-ftparchive.1.xml:419 apt-ftparchive.1.xml:465
2283 msgid "ExtraOverride"
2286 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2287 #: apt-ftparchive.1.xml:421 apt-ftparchive.1.xml:467
2288 msgid "Sets the binary extra override file."
2291 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2292 #: apt-ftparchive.1.xml:424 apt-ftparchive.1.xml:470
2293 msgid "SrcExtraOverride"
2296 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2297 #: apt-ftparchive.1.xml:426 apt-ftparchive.1.xml:472
2298 msgid "Sets the source extra override file."
2301 #. type: Content of: <refentry><refsect1><refsect2><title>
2302 #: apt-ftparchive.1.xml:431
2303 msgid "BinDirectory Section"
2306 #. type: Content of: <refentry><refsect1><refsect2><para>
2307 #: apt-ftparchive.1.xml:433
2309 "The <literal>bindirectory</literal> section defines a binary directory tree "
2310 "with no special structure. The scope tag specifies the location of the "
2311 "binary directory and the settings are similar to the <literal>Tree</literal> "
2312 "section with no substitution variables or "
2313 "<literal>Section</literal><literal>Architecture</literal> settings."
2316 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2317 #: apt-ftparchive.1.xml:441
2318 msgid "Sets the Packages file output."
2321 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2322 #: apt-ftparchive.1.xml:446
2324 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
2325 "<literal>Sources</literal> is required."
2328 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2329 #: apt-ftparchive.1.xml:452
2330 msgid "Sets the Contents file output. (optional)"
2333 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2334 #: apt-ftparchive.1.xml:457
2335 msgid "Sets the binary override file."
2338 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2339 #: apt-ftparchive.1.xml:462
2340 msgid "Sets the source override file."
2343 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2344 #: apt-ftparchive.1.xml:477
2345 msgid "Sets the cache DB."
2348 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2349 #: apt-ftparchive.1.xml:480
2353 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2354 #: apt-ftparchive.1.xml:482
2355 msgid "Appends a path to all the output paths."
2358 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2359 #: apt-ftparchive.1.xml:485
2360 msgid "FileList, SourceFileList"
2363 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2364 #: apt-ftparchive.1.xml:487
2365 msgid "Specifies the file list file."
2368 #. type: Content of: <refentry><refsect1><title>
2369 #: apt-ftparchive.1.xml:494
2370 msgid "The Binary Override File"
2373 #. type: Content of: <refentry><refsect1><para>
2374 #: apt-ftparchive.1.xml:495
2376 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
2377 "contains 4 fields separated by spaces. The first field is the package name, "
2378 "the second is the priority to force that package to, the third is the the "
2379 "section to force that package to and the final field is the maintainer "
2380 "permutation field."
2383 #. type: Content of: <refentry><refsect1><para><literallayout>
2384 #: apt-ftparchive.1.xml:501
2386 msgid "old [// oldn]* => new"
2389 #. type: Content of: <refentry><refsect1><para><literallayout>
2390 #: apt-ftparchive.1.xml:503
2395 #. type: Content of: <refentry><refsect1><para>
2396 #: apt-ftparchive.1.xml:500
2398 "The general form of the maintainer field is: <placeholder "
2399 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
2400 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
2401 "separated list of old email addresses to be specified. If any of those are "
2402 "found then new is substituted for the maintainer field. The second form "
2403 "unconditionally substitutes the maintainer field."
2406 #. type: Content of: <refentry><refsect1><title>
2407 #: apt-ftparchive.1.xml:511
2408 msgid "The Source Override File"
2411 #. type: Content of: <refentry><refsect1><para>
2412 #: apt-ftparchive.1.xml:513
2414 "The source override file is fully compatible with &dpkg-scansources;. It "
2415 "contains 2 fields separated by spaces. The first fields is the source "
2416 "package name, the second is the section to assign it."
2419 #. type: Content of: <refentry><refsect1><title>
2420 #: apt-ftparchive.1.xml:518
2421 msgid "The Extra Override File"
2424 #. type: Content of: <refentry><refsect1><para>
2425 #: apt-ftparchive.1.xml:520
2427 "The extra override file allows any arbitrary tag to be added or replaced in "
2428 "the output. It has 3 columns, the first is the package, the second is the "
2429 "tag and the remainder of the line is the new value."
2432 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2433 #: apt-ftparchive.1.xml:529
2434 msgid "<option>--md5</option>"
2437 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2438 #: apt-ftparchive.1.xml:531
2440 "Generate MD5 sums. This defaults to on, when turned off the generated index "
2441 "files will not have MD5Sum fields where possible. Configuration Item: "
2442 "<literal>APT::FTPArchive::MD5</literal>"
2445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2446 #: apt-ftparchive.1.xml:536
2447 msgid "<option>--db</option>"
2450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2451 #: apt-ftparchive.1.xml:538
2453 "Use a binary caching DB. This has no effect on the generate command. "
2454 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
2457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2458 #: apt-ftparchive.1.xml:544
2460 "Quiet; produces output suitable for logging, omitting progress indicators. "
2461 "More q's will produce more quiet up to a maximum of 2. You can also use "
2462 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2463 "file. Configuration Item: <literal>quiet</literal>."
2466 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2467 #: apt-ftparchive.1.xml:550
2468 msgid "<option>--delink</option>"
2471 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2472 #: apt-ftparchive.1.xml:552
2474 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
2475 "then this option actually enables delinking of the files. It defaults to on "
2476 "and can be turned off with <option>--no-delink</option>. Configuration "
2477 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
2480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2481 #: apt-ftparchive.1.xml:558
2482 msgid "<option>--contents</option>"
2485 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2486 #: apt-ftparchive.1.xml:560
2488 "Perform contents generation. When this option is set and package indexes are "
2489 "being generated with a cache DB then the file listing will also be extracted "
2490 "and stored in the DB for later use. When using the generate command this "
2491 "option also allows the creation of any Contents files. The default is on. "
2492 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
2495 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2496 #: apt-ftparchive.1.xml:568
2497 msgid "<option>--source-override</option>"
2500 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2501 #: apt-ftparchive.1.xml:570
2503 "Select the source override file to use with the <literal>sources</literal> "
2504 "command. Configuration Item: "
2505 "<literal>APT::FTPArchive::SourceOverride</literal>."
2508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2509 #: apt-ftparchive.1.xml:574
2510 msgid "<option>--readonly</option>"
2513 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2514 #: apt-ftparchive.1.xml:576
2516 "Make the caching databases read only. Configuration Item: "
2517 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2521 #: apt-ftparchive.1.xml:580
2522 msgid "<option>--arch</option>"
2525 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2526 #: apt-ftparchive.1.xml:581
2528 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2529 "commands only package files matching <literal>*_arch.deb</literal> or "
2530 "<literal>*_all.deb</literal> instead of all package files in the given "
2531 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2534 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2535 #: apt-ftparchive.1.xml:587
2536 msgid "<option>APT::FTPArchive::AlwaysStat</option>"
2539 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2540 #: apt-ftparchive.1.xml:589
2542 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2543 "packages are recompiled and/or republished with the same version again, this "
2544 "will lead to problems as the now outdated cached metadata like size and "
2545 "checksums will be used. With this option enabled this will no longer happen "
2546 "as it will be checked if the file was changed. Note that this option is set "
2547 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2548 "multiply versions/builds of a package with the same versionnumber, so in "
2549 "theory nobody will have these problems and therefore all these extra checks "
2553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2554 #: apt-ftparchive.1.xml:599
2555 msgid "<option>APT::FTPArchive::LongDescription</option>"
2558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2559 #: apt-ftparchive.1.xml:601
2561 "This configuration option defaults to \"<literal>true</literal>\" and should "
2562 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2563 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2564 "that the <filename>Translation-en</filename> master file can only be created "
2565 "in the generate command."
2568 #. type: Content of: <refentry><refsect1><title>
2569 #: apt-ftparchive.1.xml:613 apt.conf.5.xml:1087 apt_preferences.5.xml:496 sources.list.5.xml:198
2573 #. type: Content of: <refentry><refsect1><para><programlisting>
2574 #: apt-ftparchive.1.xml:619
2577 "<command>apt-ftparchive</command> packages "
2578 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2579 "<filename>Packages.gz</filename>\n"
2582 #. type: Content of: <refentry><refsect1><para>
2583 #: apt-ftparchive.1.xml:615
2585 "To create a compressed Packages file for a directory containing binary "
2586 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2589 #. type: Content of: <refentry><refsect1><para>
2590 #: apt-ftparchive.1.xml:629
2592 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2596 #. The last update date
2597 #. type: Content of: <refentry><refentryinfo>
2600 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>08 "
2601 "November 2008</date>"
2604 #. type: <heading></heading>
2605 #: apt-get.8.xml:25 apt-get.8.xml:32 guide.sgml:96
2609 #. type: Content of: <refentry><refnamediv><refpurpose>
2611 msgid "APT package handling utility -- command-line interface"
2614 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
2617 "<command>apt-get</command> <arg><option>-sqdyfmubV</option></arg> <arg> "
2618 "<option>-o= <replaceable>config_string</replaceable> </option> </arg> <arg> "
2619 "<option>-c= <replaceable>config_file</replaceable> </option> </arg> <arg> "
2620 "<option>-t=</option> <arg choice='plain'> "
2621 "<replaceable>target_release</replaceable> </arg> </arg> <group "
2622 "choice=\"req\"> <arg choice='plain'>update</arg> <arg "
2623 "choice='plain'>upgrade</arg> <arg choice='plain'>dselect-upgrade</arg> <arg "
2624 "choice='plain'>dist-upgrade</arg> <arg choice='plain'>install <arg "
2625 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group "
2626 "choice='req'> <arg choice='plain'> "
2627 "=<replaceable>pkg_version_number</replaceable> </arg> <arg choice='plain'> "
2628 "/<replaceable>target_release</replaceable> </arg> </group> </arg> </arg> "
2629 "</arg> <arg choice='plain'>remove <arg choice=\"plain\" "
2630 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2631 "choice='plain'>purge <arg choice=\"plain\" "
2632 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2633 "choice='plain'>source <arg choice=\"plain\" "
2634 "rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group choice='req'> "
2635 "<arg choice='plain'> =<replaceable>pkg_version_number</replaceable> </arg> "
2636 "<arg choice='plain'> /<replaceable>target_release</replaceable> </arg> "
2637 "</group> </arg> </arg> </arg> <arg choice='plain'>build-dep <arg "
2638 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
2639 "<arg choice='plain'>check</arg> <arg choice='plain'>clean</arg> <arg "
2640 "choice='plain'>autoclean</arg> <arg choice='plain'>autoremove</arg> <arg "
2641 "choice='plain'> <group choice='req'> <arg choice='plain'>-v</arg> <arg "
2642 "choice='plain'>--version</arg> </group> </arg> <arg choice='plain'> <group "
2643 "choice='req'> <arg choice='plain'>-h</arg> <arg choice='plain'>--help</arg> "
2644 "</group> </arg> </group>"
2647 #. type: Content of: <refentry><refsect1><para>
2648 #: apt-get.8.xml:115
2650 "<command>apt-get</command> is the command-line tool for handling packages, "
2651 "and may be considered the user's \"back-end\" to other tools using the APT "
2652 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2653 "&aptitude;, &synaptic; and &wajig;."
2656 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2657 #: apt-get.8.xml:124 apt-key.8.xml:127
2661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2662 #: apt-get.8.xml:125
2664 "<literal>update</literal> is used to resynchronize the package index files "
2665 "from their sources. The indexes of available packages are fetched from the "
2666 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2667 "example, when using a Debian archive, this command retrieves and scans the "
2668 "<filename>Packages.gz</filename> files, so that information about new and "
2669 "updated packages is available. An <literal>update</literal> should always be "
2670 "performed before an <literal>upgrade</literal> or "
2671 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2672 "meter will be incorrect as the size of the package files cannot be known in "
2676 #. type: <tag></tag>
2677 #: apt-get.8.xml:136 guide.sgml:121
2681 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2682 #: apt-get.8.xml:137
2684 "<literal>upgrade</literal> is used to install the newest versions of all "
2685 "packages currently installed on the system from the sources enumerated in "
2686 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2687 "with new versions available are retrieved and upgraded; under no "
2688 "circumstances are currently installed packages removed, or packages not "
2689 "already installed retrieved and installed. New versions of currently "
2690 "installed packages that cannot be upgraded without changing the install "
2691 "status of another package will be left at their current version. An "
2692 "<literal>update</literal> must be performed first so that "
2693 "<command>apt-get</command> knows that new versions of packages are "
2697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2698 #: apt-get.8.xml:149
2699 msgid "dselect-upgrade"
2702 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2703 #: apt-get.8.xml:150
2705 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2706 "traditional Debian packaging front-end, "
2707 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2708 "&dselect; to the <literal>Status</literal> field of available packages, and "
2709 "performs the actions necessary to realize that state (for instance, the "
2710 "removal of old and the installation of new packages)."
2713 #. type: <tag></tag>
2714 #: apt-get.8.xml:159 guide.sgml:140
2715 msgid "dist-upgrade"
2718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2719 #: apt-get.8.xml:160
2721 "<literal>dist-upgrade</literal> in addition to performing the function of "
2722 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2723 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2724 "conflict resolution system, and it will attempt to upgrade the most "
2725 "important packages at the expense of less important ones if necessary. So, "
2726 "<literal>dist-upgrade</literal> command may remove some packages. The "
2727 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2728 "from which to retrieve desired package files. See also &apt-preferences; "
2729 "for a mechanism for overriding the general settings for individual packages."
2732 #. type: <tag></tag>
2733 #: apt-get.8.xml:172 guide.sgml:131
2737 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2738 #: apt-get.8.xml:174
2740 "<literal>install</literal> is followed by one or more packages desired for "
2741 "installation or upgrading. Each package is a package name, not a fully "
2742 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2743 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2744 "packages required by the package(s) specified for installation will also be "
2745 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2746 "file is used to locate the desired packages. If a hyphen is appended to the "
2747 "package name (with no intervening space), the identified package will be "
2748 "removed if it is installed. Similarly a plus sign can be used to designate "
2749 "a package to install. These latter features may be used to override "
2750 "decisions made by apt-get's conflict resolution system."
2753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2754 #: apt-get.8.xml:192
2756 "A specific version of a package can be selected for installation by "
2757 "following the package name with an equals and the version of the package to "
2758 "select. This will cause that version to be located and selected for "
2759 "install. Alternatively a specific distribution can be selected by following "
2760 "the package name with a slash and the version of the distribution or the "
2761 "Archive name (stable, testing, unstable)."
2764 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2765 #: apt-get.8.xml:199
2767 "Both of the version selection mechanisms can downgrade packages and must be "
2771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2772 #: apt-get.8.xml:202
2774 "This is also the target to use if you want to upgrade one or more "
2775 "already-installed packages without upgrading every package you have on your "
2776 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2777 "all currently installed packages, \"install\" will install the newest "
2778 "version of only the package(s) specified. Simply provide the name of the "
2779 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2780 "its dependencies, as described above) will be downloaded and installed."
2783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2784 #: apt-get.8.xml:213
2786 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2787 "installation policy for individual packages."
2790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2791 #: apt-get.8.xml:217
2793 "If no package matches the given expression and the expression contains one "
2794 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2795 "it is applied to all package names in the database. Any matches are then "
2796 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2797 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2798 "expression with a '^' or '$' character, or create a more specific regular "
2802 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2803 #: apt-get.8.xml:226
2807 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2808 #: apt-get.8.xml:227
2810 "<literal>remove</literal> is identical to <literal>install</literal> except "
2811 "that packages are removed instead of installed. Note the removing a package "
2812 "leaves its configuration files in system. If a plus sign is appended to the "
2813 "package name (with no intervening space), the identified package will be "
2814 "installed instead of removed."
2817 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2818 #: apt-get.8.xml:234
2822 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2823 #: apt-get.8.xml:235
2825 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2826 "that packages are removed and purged (any configuration files are deleted "
2830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2831 #: apt-get.8.xml:239
2835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2836 #: apt-get.8.xml:240
2838 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2839 "packages. APT will examine the available packages to decide which source "
2840 "package to fetch. It will then find and download into the current directory "
2841 "the newest available version of that source package while respect the "
2842 "default release, set with the option "
2843 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2844 "per package with the <literal>pkg/release</literal> syntax, if possible."
2847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2848 #: apt-get.8.xml:248
2850 "Source packages are tracked separately from binary packages via "
2851 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2852 "that you will need to add such a line for each repository you want to get "
2853 "sources from. If you don't do this you will properly get another (newer, "
2854 "older or none) source version than the one you have installed or could "
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2859 #: apt-get.8.xml:255
2861 "If the <option>--compile</option> option is specified then the package will "
2862 "be compiled to a binary .deb using <command>dpkg-buildpackage</command>, if "
2863 "<option>--download-only</option> is specified then the source package will "
2867 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2868 #: apt-get.8.xml:260
2870 "A specific source version can be retrieved by postfixing the source name "
2871 "with an equals and then the version to fetch, similar to the mechanism used "
2872 "for the package files. This enables exact matching of the source package "
2873 "name and version, implicitly enabling the "
2874 "<literal>APT::Get::Only-Source</literal> option."
2877 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2878 #: apt-get.8.xml:266
2880 "Note that source packages are not tracked like binary packages, they exist "
2881 "only in the current directory and are similar to downloading source tar "
2885 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2886 #: apt-get.8.xml:271
2890 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2891 #: apt-get.8.xml:272
2893 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2894 "attempt to satisfy the build dependencies for a source package."
2897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2898 #: apt-get.8.xml:276
2902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2903 #: apt-get.8.xml:277
2905 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2906 "and checks for broken dependencies."
2909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2910 #: apt-get.8.xml:281
2914 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2915 #: apt-get.8.xml:282
2917 "<literal>download</literal> will download the given binary package into the "
2921 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2922 #: apt-get.8.xml:288
2924 "<literal>clean</literal> clears out the local repository of retrieved "
2925 "package files. It removes everything but the lock file from "
2926 "<filename>&cachedir;/archives/</filename> and "
2927 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2928 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2929 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2930 "from time to time to free up disk space."
2933 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2934 #: apt-get.8.xml:297
2938 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2939 #: apt-get.8.xml:298
2941 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2942 "local repository of retrieved package files. The difference is that it only "
2943 "removes package files that can no longer be downloaded, and are largely "
2944 "useless. This allows a cache to be maintained over a long period without it "
2945 "growing out of control. The configuration option "
2946 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2947 "being erased if it is set to off."
2950 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2951 #: apt-get.8.xml:307
2955 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2956 #: apt-get.8.xml:308
2958 "<literal>autoremove</literal> is used to remove packages that were "
2959 "automatically installed to satisfy dependencies for some package and that "
2960 "are no more needed."
2963 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2964 #: apt-get.8.xml:312
2968 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2969 #: apt-get.8.xml:313
2971 "<literal>changelog</literal> downloads a package changelog and displays it "
2972 "through <command>sensible-pager</command>. The server name and base "
2973 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2974 "variable (e. g. <ulink>http://packages.debian.org/changelogs</ulink> for "
2975 "Debian or <ulink>http://changelogs.ubuntu.com/changelogs</ulink> for "
2976 "Ubuntu). By default it displays the changelog for the version that is "
2977 "installed. However, you can specify the same options as for the "
2978 "<option>install</option> command."
2981 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2982 #: apt-get.8.xml:335
2983 msgid "<option>--no-install-recommends</option>"
2986 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2987 #: apt-get.8.xml:336
2989 "Do not consider recommended packages as a dependency for installing. "
2990 "Configuration Item: <literal>APT::Install-Recommends</literal>."
2993 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2994 #: apt-get.8.xml:340
2995 msgid "<option>--install-suggests</option>"
2998 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2999 #: apt-get.8.xml:341
3001 "Consider suggested packages as a dependency for installing. Configuration "
3002 "Item: <literal>APT::Install-Suggests</literal>."
3005 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3006 #: apt-get.8.xml:345
3007 msgid "<option>--download-only</option>"
3010 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3011 #: apt-get.8.xml:346
3013 "Download only; package files are only retrieved, not unpacked or installed. "
3014 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
3017 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3018 #: apt-get.8.xml:350
3019 msgid "<option>--fix-broken</option>"
3022 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3023 #: apt-get.8.xml:351
3025 "Fix; attempt to correct a system with broken dependencies in place. This "
3026 "option, when used with install/remove, can omit any packages to permit APT "
3027 "to deduce a likely solution. If packages are specified, these have to "
3028 "completely correct the problem. The option is sometimes necessary when "
3029 "running APT for the first time; APT itself does not allow broken package "
3030 "dependencies to exist on a system. It is possible that a system's dependency "
3031 "structure can be so corrupt as to require manual intervention (which usually "
3032 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
3033 "of the offending packages). Use of this option together with "
3034 "<option>-m</option> may produce an error in some situations. Configuration "
3035 "Item: <literal>APT::Get::Fix-Broken</literal>."
3038 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3039 #: apt-get.8.xml:364
3040 msgid "<option>--ignore-missing</option>"
3043 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3044 #: apt-get.8.xml:365
3045 msgid "<option>--fix-missing</option>"
3048 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3049 #: apt-get.8.xml:366
3051 "Ignore missing packages; If packages cannot be retrieved or fail the "
3052 "integrity check after retrieval (corrupted package files), hold back those "
3053 "packages and handle the result. Use of this option together with "
3054 "<option>-f</option> may produce an error in some situations. If a package is "
3055 "selected for installation (particularly if it is mentioned on the command "
3056 "line) and it could not be downloaded then it will be silently held back. "
3057 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
3060 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3061 #: apt-get.8.xml:376
3062 msgid "<option>--no-download</option>"
3065 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3066 #: apt-get.8.xml:377
3068 "Disables downloading of packages. This is best used with "
3069 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
3070 "already downloaded. Configuration Item: "
3071 "<literal>APT::Get::Download</literal>."
3074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3075 #: apt-get.8.xml:384
3077 "Quiet; produces output suitable for logging, omitting progress indicators. "
3078 "More q's will produce more quiet up to a maximum of 2. You can also use "
3079 "<option>-q=#</option> to set the quiet level, overriding the configuration "
3080 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
3081 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
3082 "may decided to do something you did not expect. Configuration Item: "
3083 "<literal>quiet</literal>."
3086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3087 #: apt-get.8.xml:394
3088 msgid "<option>--simulate</option>"
3091 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3092 #: apt-get.8.xml:396
3093 msgid "<option>--dry-run</option>"
3096 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3097 #: apt-get.8.xml:399
3099 "No action; perform a simulation of events that would occur but do not "
3100 "actually change the system. Configuration Item: "
3101 "<literal>APT::Get::Simulate</literal>."
3104 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3105 #: apt-get.8.xml:403
3107 "Simulation run as user will deactivate locking "
3108 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
3109 "displayed indicating that this is only a simulation, if the option "
3110 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
3111 "true). Neither NoLocking nor the notice will be triggered if run as root "
3112 "(root should know what he is doing without further warnings by "
3113 "<literal>apt-get</literal>)."
3116 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3117 #: apt-get.8.xml:409
3119 "Simulate prints out a series of lines each one representing a dpkg "
3120 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
3121 "indicate broken packages and empty set of square brackets meaning breaks "
3122 "that are of no consequence (rare)."
3125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3126 #: apt-get.8.xml:416
3127 msgid "<option>-y</option>"
3130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3131 #: apt-get.8.xml:416
3132 msgid "<option>--yes</option>"
3135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3136 #: apt-get.8.xml:417
3137 msgid "<option>--assume-yes</option>"
3140 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3141 #: apt-get.8.xml:418
3143 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
3144 "non-interactively. If an undesirable situation, such as changing a held "
3145 "package, trying to install a unauthenticated package or removing an "
3146 "essential package occurs then <literal>apt-get</literal> will abort. "
3147 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
3150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3151 #: apt-get.8.xml:425
3152 msgid "<option>-u</option>"
3155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3156 #: apt-get.8.xml:425
3157 msgid "<option>--show-upgraded</option>"
3160 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3161 #: apt-get.8.xml:426
3163 "Show upgraded packages; Print out a list of all packages that are to be "
3164 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
3167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3168 #: apt-get.8.xml:431
3169 msgid "<option>-V</option>"
3172 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3173 #: apt-get.8.xml:431
3174 msgid "<option>--verbose-versions</option>"
3177 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3178 #: apt-get.8.xml:432
3180 "Show full versions for upgraded and installed packages. Configuration Item: "
3181 "<literal>APT::Get::Show-Versions</literal>."
3184 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3185 #: apt-get.8.xml:436
3186 msgid "<option>-b</option>"
3189 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3190 #: apt-get.8.xml:436
3191 msgid "<option>--compile</option>"
3194 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3195 #: apt-get.8.xml:437
3196 msgid "<option>--build</option>"
3199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3200 #: apt-get.8.xml:438
3202 "Compile source packages after downloading them. Configuration Item: "
3203 "<literal>APT::Get::Compile</literal>."
3206 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3207 #: apt-get.8.xml:442
3208 msgid "<option>--ignore-hold</option>"
3211 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3212 #: apt-get.8.xml:443
3214 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
3215 "hold placed on a package. This may be useful in conjunction with "
3216 "<literal>dist-upgrade</literal> to override a large number of undesired "
3217 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
3220 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3221 #: apt-get.8.xml:449
3222 msgid "<option>--no-upgrade</option>"
3225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3226 #: apt-get.8.xml:450
3228 "Do not upgrade packages; When used in conjunction with "
3229 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
3230 "packages on the command line from being upgraded if they are already "
3231 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
3234 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3235 #: apt-get.8.xml:456
3236 msgid "<option>--only-upgrade</option>"
3239 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3240 #: apt-get.8.xml:457
3242 "Do not install new packages; When used in conjunction with "
3243 "<literal>install</literal>, <literal>only-upgrade</literal> will prevent "
3244 "packages on the command line from being upgraded if they are not already "
3245 "installed. Configuration Item: <literal>APT::Get::Only-Upgrade</literal>."
3248 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3249 #: apt-get.8.xml:463
3250 msgid "<option>--force-yes</option>"
3253 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3254 #: apt-get.8.xml:464
3256 "Force yes; This is a dangerous option that will cause apt to continue "
3257 "without prompting if it is doing something potentially harmful. It should "
3258 "not be used except in very special situations. Using "
3259 "<literal>force-yes</literal> can potentially destroy your system! "
3260 "Configuration Item: <literal>APT::Get::force-yes</literal>."
3263 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3264 #: apt-get.8.xml:471
3265 msgid "<option>--print-uris</option>"
3268 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3269 #: apt-get.8.xml:472
3271 "Instead of fetching the files to install their URIs are printed. Each URI "
3272 "will have the path, the destination file name, the size and the expected md5 "
3273 "hash. Note that the file name to write to will not always match the file "
3274 "name on the remote site! This also works with the <literal>source</literal> "
3275 "and <literal>update</literal> commands. When used with the "
3276 "<literal>update</literal> command the MD5 and size are not included, and it "
3277 "is up to the user to decompress any compressed files. Configuration Item: "
3278 "<literal>APT::Get::Print-URIs</literal>."
3281 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3282 #: apt-get.8.xml:482
3283 msgid "<option>--purge</option>"
3286 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3287 #: apt-get.8.xml:483
3289 "Use purge instead of remove for anything that would be removed. An asterisk "
3290 "(\"*\") will be displayed next to packages which are scheduled to be "
3291 "purged. <option>remove --purge</option> is equivalent to the "
3292 "<option>purge</option> command. Configuration Item: "
3293 "<literal>APT::Get::Purge</literal>."
3296 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3297 #: apt-get.8.xml:490
3298 msgid "<option>--reinstall</option>"
3301 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3302 #: apt-get.8.xml:491
3304 "Re-Install packages that are already installed and at the newest version. "
3305 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
3308 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3309 #: apt-get.8.xml:495
3310 msgid "<option>--list-cleanup</option>"
3313 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3314 #: apt-get.8.xml:496
3316 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
3317 "it off. When on <command>apt-get</command> will automatically manage the "
3318 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
3319 "files are erased. The only reason to turn it off is if you frequently "
3320 "change your source list. Configuration Item: "
3321 "<literal>APT::Get::List-Cleanup</literal>."
3324 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3325 #: apt-get.8.xml:505
3326 msgid "<option>--target-release</option>"
3329 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3330 #: apt-get.8.xml:506
3331 msgid "<option>--default-release</option>"
3334 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3335 #: apt-get.8.xml:507
3337 "This option controls the default input to the policy engine, it creates a "
3338 "default pin at priority 990 using the specified release string. This "
3339 "overrides the general settings in "
3340 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
3341 "not affected by the value of this option. In short, this option lets you "
3342 "have simple control over which distribution packages will be retrieved "
3343 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
3344 "unstable</option> or <option>-t sid</option>. Configuration Item: "
3345 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
3349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3350 #: apt-get.8.xml:520
3351 msgid "<option>--trivial-only</option>"
3354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3355 #: apt-get.8.xml:522
3357 "Only perform operations that are 'trivial'. Logically this can be considered "
3358 "related to <option>--assume-yes</option>, where "
3359 "<option>--assume-yes</option> will answer yes to any prompt, "
3360 "<option>--trivial-only</option> will answer no. Configuration Item: "
3361 "<literal>APT::Get::Trivial-Only</literal>."
3364 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3365 #: apt-get.8.xml:528
3366 msgid "<option>--no-remove</option>"
3369 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3370 #: apt-get.8.xml:529
3372 "If any packages are to be removed apt-get immediately aborts without "
3373 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
3376 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3377 #: apt-get.8.xml:534
3378 msgid "<option>--auto-remove</option>"
3381 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3382 #: apt-get.8.xml:535
3384 "If the command is either <literal>install</literal> or "
3385 "<literal>remove</literal>, then this option acts like running "
3386 "<literal>autoremove</literal> command, removing the unused dependency "
3387 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
3390 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3391 #: apt-get.8.xml:541
3392 msgid "<option>--only-source</option>"
3395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3396 #: apt-get.8.xml:542
3398 "Only has meaning for the <literal>source</literal> and "
3399 "<literal>build-dep</literal> commands. Indicates that the given source "
3400 "names are not to be mapped through the binary table. This means that if "
3401 "this option is specified, these commands will only accept source package "
3402 "names as arguments, rather than accepting binary package names and looking "
3403 "up the corresponding source package. Configuration Item: "
3404 "<literal>APT::Get::Only-Source</literal>."
3407 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3408 #: apt-get.8.xml:552
3409 msgid "<option>--diff-only</option>"
3412 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3413 #: apt-get.8.xml:552
3414 msgid "<option>--dsc-only</option>"
3417 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3418 #: apt-get.8.xml:552
3419 msgid "<option>--tar-only</option>"
3422 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3423 #: apt-get.8.xml:553
3425 "Download only the diff, dsc, or tar file of a source archive. Configuration "
3426 "Item: <literal>APT::Get::Diff-Only</literal>, "
3427 "<literal>APT::Get::Dsc-Only</literal>, and "
3428 "<literal>APT::Get::Tar-Only</literal>."
3431 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3432 #: apt-get.8.xml:558
3433 msgid "<option>--arch-only</option>"
3436 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3437 #: apt-get.8.xml:559
3439 "Only process architecture-dependent build-dependencies. Configuration Item: "
3440 "<literal>APT::Get::Arch-Only</literal>."
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3444 #: apt-get.8.xml:563
3445 msgid "<option>--allow-unauthenticated</option>"
3448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3449 #: apt-get.8.xml:564
3451 "Ignore if packages can't be authenticated and don't prompt about it. This "
3452 "is useful for tools like pbuilder. Configuration Item: "
3453 "<literal>APT::Get::AllowUnauthenticated</literal>."
3456 #. type: Content of: <refentry><refsect1><variablelist>
3457 #: apt-get.8.xml:577
3459 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
3463 #. type: Content of: <refentry><refsect1><para>
3464 #: apt-get.8.xml:586
3466 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
3467 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
3468 "&apt-preferences;, the APT Howto."
3471 #. type: Content of: <refentry><refsect1><para>
3472 #: apt-get.8.xml:592
3474 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
3478 #. type: Content of: <refentry><refsect1><title>
3479 #: apt-get.8.xml:595
3480 msgid "ORIGINAL AUTHORS"
3483 #. type: Content of: <refentry><refsect1><para>
3484 #: apt-get.8.xml:596
3485 msgid "&apt-author.jgunthorpe;"
3488 #. type: Content of: <refentry><refsect1><title>
3489 #: apt-get.8.xml:599
3490 msgid "CURRENT AUTHORS"
3493 #. type: Content of: <refentry><refsect1><para>
3494 #: apt-get.8.xml:601
3495 msgid "&apt-author.team;"
3498 #. type: Content of: <refentry><refnamediv><refname>
3499 #: apt-key.8.xml:17 apt-key.8.xml:24
3503 #. type: Content of: <refentry><refnamediv><refpurpose>
3505 msgid "APT key management utility"
3508 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3511 "<command>apt-key</command> <arg><option>--keyring "
3512 "<replaceable>filename</replaceable></option></arg> "
3513 "<arg><replaceable>command</replaceable></arg> <arg "
3514 "rep=\"repeat\"><option><replaceable>arguments</replaceable></option></arg>"
3517 #. type: Content of: <refentry><refsect1><para>
3520 "<command>apt-key</command> is used to manage the list of keys used by apt to "
3521 "authenticate packages. Packages which have been authenticated using these "
3522 "keys will be considered trusted."
3525 #. type: Content of: <refentry><refsect1><title>
3530 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3532 msgid "add <replaceable>filename</replaceable>"
3535 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3538 "Add a new key to the list of trusted keys. The key is read from "
3539 "<replaceable>filename</replaceable>, or standard input if "
3540 "<replaceable>filename</replaceable> is <literal>-</literal>."
3543 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3545 msgid "del <replaceable>keyid</replaceable>"
3548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3550 msgid "Remove a key from the list of trusted keys."
3553 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3555 msgid "export <replaceable>keyid</replaceable>"
3558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3560 msgid "Output the key <replaceable>keyid</replaceable> to standard output."
3563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3570 msgid "Output all trusted keys to standard output."
3573 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3578 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3580 msgid "List trusted keys."
3583 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3584 #: apt-key.8.xml:104
3588 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3589 #: apt-key.8.xml:108
3590 msgid "List fingerprints of trusted keys."
3593 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3594 #: apt-key.8.xml:115
3598 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3599 #: apt-key.8.xml:119
3601 "Pass advanced options to gpg. With adv --recv-key you can download the "
3605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3606 #: apt-key.8.xml:131
3608 "Update the local keyring with the keyring of Debian archive keys and removes "
3609 "from the keyring the archive keys which are no longer valid."
3612 #. type: Content of: <refentry><refsect1><para>
3613 #: apt-key.8.xml:143
3615 "Note that options need to be defined before the commands described in the "
3619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3620 #: apt-key.8.xml:145
3621 msgid "--keyring <replaceable>filename</replaceable>"
3624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3625 #: apt-key.8.xml:146
3627 "With this option it is possible to specify a specific keyring file the "
3628 "command should operate on. The default is that a command is executed on the "
3629 "<filename>trusted.gpg</filename> file as well as on all parts in the "
3630 "<filename>trusted.gpg.d</filename> directory, through "
3631 "<filename>trusted.gpg</filename> is the primary keyring which means that "
3632 "e.g. new keys are added to this one."
3635 #. type: Content of: <refentry><refsect1><variablelist>
3636 #: apt-key.8.xml:159
3637 msgid "&file-trustedgpg;"
3640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3641 #: apt-key.8.xml:161
3642 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
3645 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3646 #: apt-key.8.xml:162
3647 msgid "Local trust database of archive keys."
3650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3651 #: apt-key.8.xml:165
3652 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
3655 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3656 #: apt-key.8.xml:166
3657 msgid "Keyring of Debian archive trusted keys."
3660 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3661 #: apt-key.8.xml:169
3662 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
3665 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3666 #: apt-key.8.xml:170
3667 msgid "Keyring of Debian archive removed trusted keys."
3670 #. type: Content of: <refentry><refsect1><para>
3671 #: apt-key.8.xml:179
3672 msgid "&apt-get;, &apt-secure;"
3675 #. The last update date
3676 #. type: Content of: <refentry><refentryinfo>
3677 #: apt-mark.8.xml:16
3679 "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product; <date>9 "
3680 "August 2009</date>"
3683 #. type: Content of: <refentry><refnamediv><refname>
3684 #: apt-mark.8.xml:25 apt-mark.8.xml:32
3688 #. type: Content of: <refentry><refnamediv><refpurpose>
3689 #: apt-mark.8.xml:33
3690 msgid "mark/unmark a package as being automatically-installed"
3693 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3694 #: apt-mark.8.xml:39
3696 " <command>apt-mark</command> <arg><option>-hv</option></arg> "
3697 "<arg><option>-f=<replaceable>FILENAME</replaceable></option></arg> <group "
3698 "choice=\"plain\"> <arg choice=\"plain\"> <group choice=\"req\"> <arg "
3699 "choice=\"plain\">markauto</arg> <arg choice=\"plain\">unmarkauto</arg> "
3700 "</group> <arg choice=\"plain\" "
3701 "rep=\"repeat\"><replaceable>package</replaceable></arg> </arg> <arg "
3702 "choice=\"plain\">showauto</arg> </group>"
3705 #. type: Content of: <refentry><refsect1><para>
3706 #: apt-mark.8.xml:56
3708 "<command>apt-mark</command> will change whether a package has been marked as "
3709 "being automatically installed."
3712 #. type: Content of: <refentry><refsect1><para>
3713 #: apt-mark.8.xml:60
3715 "When you request that a package is installed, and as a result other packages "
3716 "are installed to satisfy its dependencies, the dependencies are marked as "
3717 "being automatically installed. Once these automatically installed packages "
3718 "are no longer depended on by any manually installed packages, they will be "
3719 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
3722 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3723 #: apt-mark.8.xml:68
3727 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3728 #: apt-mark.8.xml:69
3730 "<literal>markauto</literal> is used to mark a package as being automatically "
3731 "installed, which will cause the package to be removed when no more manually "
3732 "installed packages depend on this package."
3735 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3736 #: apt-mark.8.xml:76
3740 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3741 #: apt-mark.8.xml:77
3743 "<literal>unmarkauto</literal> is used to mark a package as being manually "
3744 "installed, which will prevent the package from being automatically removed "
3745 "if no other packages depend on it."
3748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3749 #: apt-mark.8.xml:84
3753 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3754 #: apt-mark.8.xml:85
3756 "<literal>showauto</literal> is used to print a list of automatically "
3757 "installed packages with each package on a new line."
3760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3761 #: apt-mark.8.xml:96
3762 msgid "<option>-f=<filename><replaceable>FILENAME</replaceable></filename></option>"
3765 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3766 #: apt-mark.8.xml:97
3767 msgid "<option>--file=<filename><replaceable>FILENAME</replaceable></filename></option>"
3770 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3771 #: apt-mark.8.xml:100
3773 "Read/Write package stats from "
3774 "<filename><replaceable>FILENAME</replaceable></filename> instead of the "
3775 "default location, which is <filename>extended_status</filename> in the "
3776 "directory defined by the Configuration Item: <literal>Dir::State</literal>."
3779 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3780 #: apt-mark.8.xml:106
3781 msgid "<option>-h</option>"
3784 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3785 #: apt-mark.8.xml:107
3786 msgid "<option>--help</option>"
3789 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3790 #: apt-mark.8.xml:108
3791 msgid "Show a short usage summary."
3794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3795 #: apt-mark.8.xml:114
3796 msgid "<option>-v</option>"
3799 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3800 #: apt-mark.8.xml:115
3801 msgid "<option>--version</option>"
3804 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3805 #: apt-mark.8.xml:116
3806 msgid "Show the program version."
3809 #. type: Content of: <refentry><refsect1><variablelist>
3810 #: apt-mark.8.xml:127
3811 msgid " &file-extended_states;"
3814 #. type: Content of: <refentry><refsect1><para>
3815 #: apt-mark.8.xml:132
3816 msgid "&apt-get;,&aptitude;,&apt-conf;"
3819 #. type: Content of: <refentry><refsect1><para>
3820 #: apt-mark.8.xml:136
3822 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
3826 #. type: Content of: <refentry><refnamediv><refname>
3827 #: apt-secure.8.xml:17 apt-secure.8.xml:39
3831 #. type: Content of: <refentry><refnamediv><refpurpose>
3832 #: apt-secure.8.xml:40
3833 msgid "Archive authentication support for APT"
3836 #. type: Content of: <refentry><refsect1><para>
3837 #: apt-secure.8.xml:45
3839 "Starting with version 0.6, <command>apt</command> contains code that does "
3840 "signature checking of the Release file for all archives. This ensures that "
3841 "packages in the archive can't be modified by people who have no access to "
3842 "the Release file signing key."
3845 #. type: Content of: <refentry><refsect1><para>
3846 #: apt-secure.8.xml:53
3848 "If a package comes from a archive without a signature or with a signature "
3849 "that apt does not have a key for that package is considered untrusted and "
3850 "installing it will result in a big warning. <command>apt-get</command> will "
3851 "currently only warn for unsigned archives, future releases might force all "
3852 "sources to be verified before downloading packages from them."
3855 #. type: Content of: <refentry><refsect1><para>
3856 #: apt-secure.8.xml:62
3858 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
3859 "authentication feature."
3862 #. type: Content of: <refentry><refsect1><title>
3863 #: apt-secure.8.xml:67
3864 msgid "Trusted archives"
3867 #. type: Content of: <refentry><refsect1><para>
3868 #: apt-secure.8.xml:70
3870 "The chain of trust from an apt archive to the end user is made up of "
3871 "different steps. <command>apt-secure</command> is the last step in this "
3872 "chain, trusting an archive does not mean that the packages that you trust it "
3873 "do not contain malicious code but means that you trust the archive "
3874 "maintainer. It's the archive maintainer responsibility to ensure that the "
3875 "archive integrity is correct."
3878 #. type: Content of: <refentry><refsect1><para>
3879 #: apt-secure.8.xml:78
3881 "apt-secure does not review signatures at a package level. If you require "
3882 "tools to do this you should look at <command>debsig-verify</command> and "
3883 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3884 "packages respectively)."
3887 #. type: Content of: <refentry><refsect1><para>
3888 #: apt-secure.8.xml:85
3890 "The chain of trust in Debian starts when a maintainer uploads a new package "
3891 "or a new version of a package to the Debian archive. This upload in order to "
3892 "become effective needs to be signed by a key of a maintainer within the "
3893 "Debian maintainer's keyring (available in the debian-keyring "
3894 "package). Maintainer's keys are signed by other maintainers following "
3895 "pre-established procedures to ensure the identity of the key holder."
3898 #. type: Content of: <refentry><refsect1><para>
3899 #: apt-secure.8.xml:95
3901 "Once the uploaded package is verified and included in the archive, the "
3902 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3903 "and put in the Packages file. The MD5 sum of all of the packages files are "
3904 "then computed and put into the Release file. The Release file is then signed "
3905 "by the archive key (which is created once a year) and distributed through "
3906 "the FTP server. This key is also on the Debian keyring."
3909 #. type: Content of: <refentry><refsect1><para>
3910 #: apt-secure.8.xml:105
3912 "Any end user can check the signature of the Release file, extract the MD5 "
3913 "sum of a package from it and compare it with the MD5 sum of the package he "
3914 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3915 "package was checked. Now both the MD5 sum and the signature of the Release "
3919 #. type: Content of: <refentry><refsect1><para>
3920 #: apt-secure.8.xml:112
3922 "Notice that this is distinct from checking signatures on a per package "
3923 "basis. It is designed to prevent two possible attacks:"
3926 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3927 #: apt-secure.8.xml:117
3929 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3930 "checking, a malicious agent can introduce himself in the package download "
3931 "process and provide malicious software either by controlling a network "
3932 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3933 "(through arp or DNS spoofing attacks)."
3936 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3937 #: apt-secure.8.xml:125
3939 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3940 "malicious agent can compromise a mirror host and modify the files in it to "
3941 "propagate malicious software to all users downloading packages from that "
3945 #. type: Content of: <refentry><refsect1><para>
3946 #: apt-secure.8.xml:132
3948 "However, it does not defend against a compromise of the Debian master server "
3949 "itself (which signs the packages) or against a compromise of the key used to "
3950 "sign the Release files. In any case, this mechanism can complement a "
3951 "per-package signature."
3954 #. type: Content of: <refentry><refsect1><title>
3955 #: apt-secure.8.xml:138
3956 msgid "User configuration"
3959 #. type: Content of: <refentry><refsect1><para>
3960 #: apt-secure.8.xml:140
3962 "<command>apt-key</command> is the program that manages the list of keys used "
3963 "by apt. It can be used to add or remove keys although an installation of "
3964 "this release will automatically provide the default Debian archive signing "
3965 "keys used in the Debian package repositories."
3968 #. type: Content of: <refentry><refsect1><para>
3969 #: apt-secure.8.xml:147
3971 "In order to add a new key you need to first download it (you should make "
3972 "sure you are using a trusted communication channel when retrieving it), add "
3973 "it with <command>apt-key</command> and then run <command>apt-get "
3974 "update</command> so that apt can download and verify the "
3975 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3976 "from the archives you have configured."
3979 #. type: Content of: <refentry><refsect1><title>
3980 #: apt-secure.8.xml:156
3981 msgid "Archive configuration"
3984 #. type: Content of: <refentry><refsect1><para>
3985 #: apt-secure.8.xml:158
3987 "If you want to provide archive signatures in an archive under your "
3988 "maintenance you have to:"
3991 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3992 #: apt-secure.8.xml:163
3994 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
3995 "already. You can do this by running <command>apt-ftparchive "
3996 "release</command> (provided in apt-utils)."
3999 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4000 #: apt-secure.8.xml:168
4002 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
4003 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
4004 "Release.gpg Release</command>."
4007 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4008 #: apt-secure.8.xml:172
4010 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
4011 "know what key they need to import in order to authenticate the files in the "
4015 #. type: Content of: <refentry><refsect1><para>
4016 #: apt-secure.8.xml:179
4018 "Whenever the contents of the archive changes (new packages are added or "
4019 "removed) the archive maintainer has to follow the first two steps previously "
4023 #. type: Content of: <refentry><refsect1><para>
4024 #: apt-secure.8.xml:187
4026 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
4027 "&debsign; &debsig-verify;, &gpg;"
4030 #. type: Content of: <refentry><refsect1><para>
4031 #: apt-secure.8.xml:191
4033 "For more background information you might want to review the <ulink "
4034 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7.en.html\">Debian "
4035 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
4036 "(available also in the harden-doc package) and the <ulink "
4037 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
4038 "Distribution HOWTO</ulink> by V. Alex Brennen."
4041 #. type: Content of: <refentry><refsect1><title>
4042 #: apt-secure.8.xml:204
4043 msgid "Manpage Authors"
4046 #. type: Content of: <refentry><refsect1><para>
4047 #: apt-secure.8.xml:206
4049 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
4050 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
4053 #. type: Content of: <refentry><refnamediv><refname>
4054 #: apt-sortpkgs.1.xml:25 apt-sortpkgs.1.xml:32
4055 msgid "apt-sortpkgs"
4058 #. type: Content of: <refentry><refnamediv><refpurpose>
4059 #: apt-sortpkgs.1.xml:33
4060 msgid "Utility to sort package index files"
4063 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
4064 #: apt-sortpkgs.1.xml:39
4066 "<command>apt-sortpkgs</command> <arg><option>-hvs</option></arg> "
4067 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
4068 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <arg "
4069 "choice=\"plain\" rep=\"repeat\"><replaceable>file</replaceable></arg>"
4072 #. type: Content of: <refentry><refsect1><para>
4073 #: apt-sortpkgs.1.xml:48
4075 "<command>apt-sortpkgs</command> will take an index file (Source index or "
4076 "Package index) and sort the records so that they are ordered by the package "
4077 "name. It will also sort the internal fields of each record according to the "
4078 "internal sorting rules."
4081 #. type: Content of: <refentry><refsect1><para>
4082 #: apt-sortpkgs.1.xml:54
4083 msgid "All output is sent to stdout, the input must be a seekable file."
4086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4087 #: apt-sortpkgs.1.xml:61
4088 msgid "<option>--source</option>"
4091 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4092 #: apt-sortpkgs.1.xml:63
4094 "Use Source index field ordering. Configuration Item: "
4095 "<literal>APT::SortPkgs::Source</literal>."
4098 #. type: Content of: <refentry><refsect1><para>
4099 #: apt-sortpkgs.1.xml:77
4101 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
4105 #. The last update date
4106 #. type: Content of: <refentry><refentryinfo>
4107 #: apt.conf.5.xml:16
4109 "&apt-author.jgunthorpe; &apt-author.team; <author> "
4110 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
4111 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
4112 "</author> &apt-email; &apt-product; <date>16 January 2010</date>"
4115 #. type: Content of: <refentry><refnamediv><refname>
4116 #: apt.conf.5.xml:31 apt.conf.5.xml:38
4120 #. type: Content of: <refentry><refmeta><manvolnum>
4121 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
4125 #. type: Content of: <refentry><refnamediv><refpurpose>
4126 #: apt.conf.5.xml:39
4127 msgid "Configuration file for APT"
4130 #. type: Content of: <refentry><refsect1><para>
4131 #: apt.conf.5.xml:43
4133 "<filename>apt.conf</filename> is the main configuration file for the APT "
4134 "suite of tools, but by far not the only place changes to options can be "
4135 "made. All tools therefore share the configuration files and also use a "
4136 "common command line parser to provide a uniform environment."
4139 #. type: Content of: <refentry><refsect1><orderedlist><para>
4140 #: apt.conf.5.xml:48
4142 "When an APT tool starts up it will read the configuration files in the "
4146 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4147 #: apt.conf.5.xml:50
4149 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
4153 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4154 #: apt.conf.5.xml:52
4156 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
4157 "order which have no or \"<literal>conf</literal>\" as filename extension and "
4158 "which only contain alphanumeric, hyphen (-), underscore (_) and period (.) "
4159 "characters. Otherwise APT will print a notice that it has ignored a file if "
4160 "the file doesn't match a pattern in the "
4161 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
4162 "case it will be silently ignored."
4165 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4166 #: apt.conf.5.xml:59
4167 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
4170 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4171 #: apt.conf.5.xml:61
4173 "the command line options are applied to override the configuration "
4174 "directives or to load even more configuration files."
4177 #. type: Content of: <refentry><refsect1><title>
4178 #: apt.conf.5.xml:65
4182 #. type: Content of: <refentry><refsect1><para>
4183 #: apt.conf.5.xml:66
4185 "The configuration file is organized in a tree with options organized into "
4186 "functional groups. Option specification is given with a double colon "
4187 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
4188 "within the APT tool group, for the Get tool. Options do not inherit from "
4189 "their parent groups."
4192 #. type: Content of: <refentry><refsect1><para>
4193 #: apt.conf.5.xml:72
4195 "Syntactically the configuration language is modeled after what the ISC tools "
4196 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
4197 "treated as comments (ignored), as well as all text between "
4198 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
4199 "Each line is of the form <literal>APT::Get::Assume-Yes "
4200 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
4201 "value must be on one line, and there is no kind of string concatenation. It "
4202 "must not include inside quotes. The behavior of the backslash \"\\\" and "
4203 "escaped characters inside a value is undefined and it should not be used. An "
4204 "option name may include alphanumerical characters and the \"/-:._+\" "
4205 "characters. A new scope can be opened with curly braces, like:"
4208 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4209 #: apt.conf.5.xml:86
4214 " Assume-Yes \"true\";\n"
4215 " Fix-Broken \"true\";\n"
4220 #. type: Content of: <refentry><refsect1><para>
4221 #: apt.conf.5.xml:94
4223 "with newlines placed to make it more readable. Lists can be created by "
4224 "opening a scope and including a single string enclosed in quotes followed by "
4225 "a semicolon. Multiple entries can be included, each separated by a "
4229 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4230 #: apt.conf.5.xml:99
4232 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
4235 #. type: Content of: <refentry><refsect1><para>
4236 #: apt.conf.5.xml:102
4238 "In general the sample configuration file in "
4239 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
4240 "guide for how it should look."
4243 #. type: Content of: <refentry><refsect1><para>
4244 #: apt.conf.5.xml:106
4246 "The names of the configuration items are not case-sensitive. So in the "
4247 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
4250 #. type: Content of: <refentry><refsect1><para>
4251 #: apt.conf.5.xml:109
4253 "Names for the configuration items are optional if a list is defined as it "
4254 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
4255 "above. If you don't specify a name a new entry will simply add a new option "
4256 "to the list. If you specify a name you can override the option as every "
4257 "other option by reassigning a new value to the option."
4260 #. type: Content of: <refentry><refsect1><para>
4261 #: apt.conf.5.xml:114
4263 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
4264 "and not supported by alternative implementations) and "
4265 "<literal>#clear</literal>: <literal>#include</literal> will include the "
4266 "given file, unless the filename ends in a slash, then the whole directory is "
4267 "included. <literal>#clear</literal> is used to erase a part of the "
4268 "configuration tree. The specified element and all its descendants are "
4269 "erased. (Note that these lines also need to end with a semicolon.)"
4272 #. type: Content of: <refentry><refsect1><para>
4273 #: apt.conf.5.xml:122
4275 "The #clear command is the only way to delete a list or a complete scope. "
4276 "Reopening a scope or the ::-style described below will "
4277 "<emphasis>not</emphasis> override previously written entries. Only options "
4278 "can be overridden by addressing a new value to it - lists and scopes can't "
4279 "be overridden, only cleared."
4282 #. type: Content of: <refentry><refsect1><para>
4283 #: apt.conf.5.xml:127
4285 "All of the APT tools take a -o option which allows an arbitrary "
4286 "configuration directive to be specified on the command line. The syntax is a "
4287 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
4288 "followed by an equals sign then the new value of the option. Lists can be "
4289 "appended too by adding a trailing :: to the list name. (As you might "
4290 "suspect: The scope syntax can't be used on the command line.)"
4293 #. type: Content of: <refentry><refsect1><para>
4294 #: apt.conf.5.xml:134
4296 "Note that you can use :: only for appending one item per line to a list and "
4297 "that you should not use it in combination with the scope syntax. (The scope "
4298 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
4299 "which some users unfortunately relay on: An option with the unusual name "
4300 "\"<literal>::</literal>\" which acts like every other option with a "
4301 "name. These introduces many problems including that a user who writes "
4302 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
4303 "append to a list will gain the opposite as only the last assignment for this "
4304 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
4305 "raise errors and will stop working if they encounter this misuse, so please "
4306 "correct such statements now as long as APT doesn't complain explicit about "
4310 #. type: Content of: <refentry><refsect1><title>
4311 #: apt.conf.5.xml:146
4312 msgid "The APT Group"
4315 #. type: Content of: <refentry><refsect1><para>
4316 #: apt.conf.5.xml:147
4318 "This group of options controls general APT behavior as well as holding the "
4319 "options for all of the tools."
4322 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4323 #: apt.conf.5.xml:151
4324 msgid "Architecture"
4327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4328 #: apt.conf.5.xml:152
4330 "System Architecture; sets the architecture to use when fetching files and "
4331 "parsing package lists. The internal default is the architecture apt was "
4335 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4336 #: apt.conf.5.xml:157
4337 msgid "Default-Release"
4340 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4341 #: apt.conf.5.xml:158
4343 "Default release to install packages from if more than one version "
4344 "available. Contains release name, codename or release version. Examples: "
4345 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
4346 "'4.0', '5.0*'. See also &apt-preferences;."
4349 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4350 #: apt.conf.5.xml:163
4354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4355 #: apt.conf.5.xml:164
4357 "Ignore Held packages; This global option causes the problem resolver to "
4358 "ignore held packages in its decision making."
4361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4362 #: apt.conf.5.xml:168
4363 msgid "Clean-Installed"
4366 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4367 #: apt.conf.5.xml:169
4369 "Defaults to on. When turned on the autoclean feature will remove any "
4370 "packages which can no longer be downloaded from the cache. If turned off "
4371 "then packages that are locally installed are also excluded from cleaning - "
4372 "but note that APT provides no direct means to reinstall them."
4375 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4376 #: apt.conf.5.xml:175
4377 msgid "Immediate-Configure"
4380 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4381 #: apt.conf.5.xml:176
4383 "Defaults to on which will cause APT to install essential and important "
4384 "packages as fast as possible in the install/upgrade operation. This is done "
4385 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
4386 "does treat an important package in the same way as an extra package: Between "
4387 "the unpacking of the important package A and his configuration can then be "
4388 "many other unpack or configuration calls, e.g. for package B which has no "
4389 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
4390 "script of package B generates an error) which results in a system state in "
4391 "which package A is unpacked but unconfigured - each package depending on A "
4392 "is now no longer guaranteed to work as their dependency on A is not longer "
4393 "satisfied. The immediate configuration marker is also applied to all "
4394 "dependencies which can generate a problem if the dependencies e.g. form a "
4395 "circle as a dependency with the immediate flag is comparable with a "
4396 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
4397 "in which it is unable to perform immediate configuration, errors out and "
4398 "refers to this option so the user can deactivate the immediate configuration "
4399 "temporarily to be able to perform an install/upgrade again. Note the use of "
4400 "the word \"theory\" here as this problem was only encountered by now in real "
4401 "world a few times in non-stable distribution versions and was caused by "
4402 "wrong dependencies of the package in question or by a system in an already "
4403 "broken state, so you should not blindly disable this option as the mentioned "
4404 "scenario above is not the only problem immediate configuration can help to "
4405 "prevent in the first place. Before a big operation like "
4406 "<literal>dist-upgrade</literal> is run with this option disabled it should "
4407 "be tried to explicitly <literal>install</literal> the package APT is unable "
4408 "to configure immediately, but please make sure to report your problem also "
4409 "to your distribution and to the APT team with the buglink below so they can "
4410 "work on improving or correcting the upgrade process."
4413 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4414 #: apt.conf.5.xml:198
4415 msgid "Force-LoopBreak"
4418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4419 #: apt.conf.5.xml:199
4421 "Never Enable this option unless you -really- know what you are doing. It "
4422 "permits APT to temporarily remove an essential package to break a "
4423 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
4424 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
4425 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
4426 "anything that those packages depend on."
4429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4430 #: apt.conf.5.xml:207
4431 msgid "Cache-Start, Cache-Grow and Cache-Limit"
4434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4435 #: apt.conf.5.xml:208
4437 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
4438 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
4439 "to which size the Cache will grow and is therefore the amount of memory APT "
4440 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
4441 "that these amount of space need to be available for APT otherwise it will "
4442 "likely fail ungracefully, so for memory restricted devices these value "
4443 "should be lowered while on systems with a lot of configured sources this "
4444 "might be increased. <literal>Cache-Grow</literal> defines in byte with the "
4445 "default of 1048576 (~1 MB) how much the Cache size will be increased in the "
4446 "event the space defined by <literal>Cache-Start</literal> is not "
4447 "enough. These value will be applied again and again until either the cache "
4448 "is big enough to store all information or the size of the cache reaches the "
4449 "<literal>Cache-Limit</literal>. The default of "
4450 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
4451 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
4455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4456 #: apt.conf.5.xml:223
4457 msgid "Build-Essential"
4460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4461 #: apt.conf.5.xml:224
4462 msgid "Defines which package(s) are considered essential build dependencies."
4465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4466 #: apt.conf.5.xml:227
4470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4471 #: apt.conf.5.xml:228
4473 "The Get subsection controls the &apt-get; tool, please see its documentation "
4474 "for more information about the options here."
4477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4478 #: apt.conf.5.xml:232
4482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4483 #: apt.conf.5.xml:233
4485 "The Cache subsection controls the &apt-cache; tool, please see its "
4486 "documentation for more information about the options here."
4489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4490 #: apt.conf.5.xml:237
4494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4495 #: apt.conf.5.xml:238
4497 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
4498 "documentation for more information about the options here."
4501 #. type: Content of: <refentry><refsect1><title>
4502 #: apt.conf.5.xml:244
4503 msgid "The Acquire Group"
4506 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4507 #: apt.conf.5.xml:249
4508 msgid "Check-Valid-Until"
4511 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4512 #: apt.conf.5.xml:250
4514 "Security related option defaulting to true as an expiring validation for a "
4515 "Release file prevents longtime replay attacks and can e.g. also help users "
4516 "to identify no longer updated mirrors - but the feature depends on the "
4517 "correctness of the time on the user system. Archive maintainers are "
4518 "encouraged to create Release files with the <literal>Valid-Until</literal> "
4519 "header, but if they don't or a stricter value is volitional the following "
4520 "<literal>Max-ValidTime</literal> option can be used."
4523 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4524 #: apt.conf.5.xml:260
4525 msgid "Max-ValidTime"
4528 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4529 #: apt.conf.5.xml:261
4531 "Seconds the Release file should be considered valid after it was "
4532 "created. The default is \"for ever\" (0) if the Release file of the archive "
4533 "doesn't include a <literal>Valid-Until</literal> header. If it does then "
4534 "this date is the default. The date from the Release file or the date "
4535 "specified by the creation time of the Release file (<literal>Date</literal> "
4536 "header) plus the seconds specified with this options are used to check if "
4537 "the validation of a file has expired by using the earlier date of the "
4538 "two. Archive specific settings can be made by appending the label of the "
4539 "archive to the option name."
4542 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4543 #: apt.conf.5.xml:273
4547 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4548 #: apt.conf.5.xml:274
4550 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
4551 "Sources files instead of downloading whole ones. True by default."
4554 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4555 #: apt.conf.5.xml:277
4557 "Two sub-options to limit the use of PDiffs are also available: With "
4558 "<literal>FileLimit</literal> can be specified how many PDiff files are "
4559 "downloaded at most to patch a file. <literal>SizeLimit</literal> on the "
4560 "other hand is the maximum precentage of the size of all patches compared to "
4561 "the size of the targeted file. If one of these limits is exceeded the "
4562 "complete file is downloaded instead of the patches."
4565 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4566 #: apt.conf.5.xml:286
4570 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4571 #: apt.conf.5.xml:287
4573 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
4574 "<literal>host</literal> or <literal>access</literal> which determines how "
4575 "APT parallelizes outgoing connections. <literal>host</literal> means that "
4576 "one connection per target host will be opened, <literal>access</literal> "
4577 "means that one connection per URI type will be opened."
4580 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4581 #: apt.conf.5.xml:294
4585 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4586 #: apt.conf.5.xml:295
4588 "Number of retries to perform. If this is non-zero APT will retry failed "
4589 "files the given number of times."
4592 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4593 #: apt.conf.5.xml:299
4594 msgid "Source-Symlinks"
4597 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4598 #: apt.conf.5.xml:300
4600 "Use symlinks for source archives. If set to true then source archives will "
4601 "be symlinked when possible instead of copying. True is the default."
4604 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4605 #: apt.conf.5.xml:304 sources.list.5.xml:144
4609 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4610 #: apt.conf.5.xml:305
4612 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
4613 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
4614 "host proxies can also be specified by using the form "
4615 "<literal>http::Proxy::<host></literal> with the special keyword "
4616 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4617 "settings is specified, <envar>http_proxy</envar> environment variable will "
4621 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4622 #: apt.conf.5.xml:313
4624 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
4625 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
4626 "response under any circumstances, <literal>Max-Age</literal> is sent only "
4627 "for index files and tells the cache to refresh its object if it is older "
4628 "than the given number of seconds. Debian updates its index files daily so "
4629 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
4630 "should never store this request, it is only set for archive files. This may "
4631 "be useful to prevent polluting a proxy cache with very large .deb "
4632 "files. Note: Squid 2.0.2 does not support any of these options."
4635 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4636 #: apt.conf.5.xml:323 apt.conf.5.xml:387
4638 "The option <literal>timeout</literal> sets the timeout timer used by the "
4639 "method, this applies to all things including connection timeout and data "
4643 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4644 #: apt.conf.5.xml:326
4646 "One setting is provided to control the pipeline depth in cases where the "
4647 "remote server is not RFC conforming or buggy (such as Squid 2.0.2). "
4648 "<literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5 "
4649 "indicating how many outstanding requests APT should send. A value of zero "
4650 "MUST be specified if the remote host does not properly linger on TCP "
4651 "connections - otherwise data corruption will occur. Hosts which require this "
4652 "are in violation of RFC 2068."
4655 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4656 #: apt.conf.5.xml:334
4658 "The used bandwidth can be limited with "
4659 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
4660 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
4661 "as much as possible of the bandwidth (Note that this option implicit "
4662 "deactivates the download from multiple servers at the same time.)"
4665 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4666 #: apt.conf.5.xml:339
4668 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
4669 "User-Agent for the http download method as some proxies allow access for "
4670 "clients only if the client uses a known identifier."
4673 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4674 #: apt.conf.5.xml:345
4678 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4679 #: apt.conf.5.xml:346
4681 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
4682 "options are the same as for <literal>http</literal> method and will also "
4683 "default to the options from the <literal>http</literal> method if they are "
4684 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
4685 "not supported yet."
4688 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4689 #: apt.conf.5.xml:352
4691 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
4692 "about trusted certificates. <literal><host>::CaInfo</literal> is "
4693 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
4694 "suboption determines whether verify server's host certificate against "
4695 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
4696 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
4697 "suboption determines whether verify server's hostname or not. "
4698 "<literal><host>::Verify-Host</literal> is corresponding per-host "
4699 "option. <literal>SslCert</literal> determines what certificate to use for "
4700 "client authentication. <literal><host>::SslCert</literal> is "
4701 "corresponding per-host option. <literal>SslKey</literal> determines what "
4702 "private key to use for client "
4703 "authentication. <literal><host>::SslKey</literal> is corresponding "
4704 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
4705 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
4706 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
4710 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4711 #: apt.conf.5.xml:370 sources.list.5.xml:155
4715 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4716 #: apt.conf.5.xml:371
4718 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
4719 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
4720 "proxies can also be specified by using the form "
4721 "<literal>ftp::Proxy::<host></literal> with the special keyword "
4722 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4723 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
4724 "used. To use a ftp proxy you will have to set the "
4725 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
4726 "entry specifies the commands to send to tell the proxy server what to "
4727 "connect to. Please see &configureindex; for an example of how to do "
4728 "this. The substitution variables available are "
4729 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
4730 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
4731 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
4732 "from it's respective URI component."
4735 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4736 #: apt.conf.5.xml:390
4738 "Several settings are provided to control passive mode. Generally it is safe "
4739 "to leave passive mode on, it works in nearly every environment. However "
4740 "some situations require that passive mode be disabled and port mode ftp used "
4741 "instead. This can be done globally, for connections that go through a proxy "
4742 "or for a specific host (See the sample config file for examples)."
4745 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4746 #: apt.conf.5.xml:397
4748 "It is possible to proxy FTP over HTTP by setting the "
4749 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
4750 "discussion of the http method above for syntax. You cannot set this in the "
4751 "configuration file and it is not recommended to use FTP over HTTP due to its "
4755 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4756 #: apt.conf.5.xml:402
4758 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
4759 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
4760 "false, which means these commands are only used if the control connection is "
4761 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
4762 "that most FTP servers do not support RFC2428."
4765 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4766 #: apt.conf.5.xml:409 sources.list.5.xml:137
4770 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4771 #: apt.conf.5.xml:415
4773 msgid "/cdrom/::Mount \"foo\";"
4776 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4777 #: apt.conf.5.xml:410
4779 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
4780 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
4781 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
4782 "provide alternate mount and unmount commands if your mount point cannot be "
4783 "listed in the fstab (such as an SMB mount and old mount packages). The "
4784 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
4785 "cdrom block. It is important to have the trailing slash. Unmount commands "
4786 "can be specified using UMount."
4789 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4790 #: apt.conf.5.xml:420
4794 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4795 #: apt.conf.5.xml:421
4797 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
4798 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
4802 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4803 #: apt.conf.5.xml:426
4804 msgid "CompressionTypes"
4807 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4808 #: apt.conf.5.xml:432
4811 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
4812 "\"<replaceable>Methodname</replaceable>\";"
4815 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4816 #: apt.conf.5.xml:427
4818 "List of compression types which are understood by the acquire methods. "
4819 "Files like <filename>Packages</filename> can be available in various "
4820 "compression formats. Per default the acquire methods can decompress "
4821 "<command>bzip2</command>, <command>lzma</command> and "
4822 "<command>gzip</command> compressed files, with this setting more formats can "
4823 "be added on the fly or the used method can be changed. The syntax for this "
4824 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
4827 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4828 #: apt.conf.5.xml:437
4830 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
4833 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4834 #: apt.conf.5.xml:440
4836 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
4839 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4840 #: apt.conf.5.xml:433
4842 "Also the <literal>Order</literal> subgroup can be used to define in which "
4843 "order the acquire system will try to download the compressed files. The "
4844 "acquire system will try the first and proceed with the next compression type "
4845 "in this list on error, so to prefer one over the other type simple add the "
4846 "preferred type at first - not already added default types will be added at "
4847 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
4848 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
4849 "over <command>bzip2</command> and <command>lzma</command>. If "
4850 "<command>lzma</command> should be preferred over <command>gzip</command> and "
4851 "<command>bzip2</command> the configure setting should look like this "
4852 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
4853 "<literal>bz2</literal> explicit to the list as it will be added automatic."
4856 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4857 #: apt.conf.5.xml:444
4859 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
4862 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4863 #: apt.conf.5.xml:442
4865 "Note that at run time the "
4866 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
4867 "checked: If this setting exists the method will only be used if this file "
4868 "exists, e.g. for the bzip2 method (the inbuilt) setting is <placeholder "
4869 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
4870 "the command line will be added at the end of the list specified in the "
4871 "configuration files, but before the default entries. To prefer a type in "
4872 "this case over the ones specified in the configuration files you can set the "
4873 "option direct - not in list style. This will not override the defined list, "
4874 "it will only prefix the list with this type."
4877 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4878 #: apt.conf.5.xml:449
4880 "The special type <literal>uncompressed</literal> can be used to give "
4881 "uncompressed files a preference, but note that most archives doesn't provide "
4882 "uncompressed files so this is mostly only useable for local mirrors."
4885 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4886 #: apt.conf.5.xml:454
4890 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4891 #: apt.conf.5.xml:456
4893 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
4894 "Sources, or Translations), keep them gzip compressed locally instead of "
4895 "unpacking them. This saves quite a lot of disk space at the expense of more "
4896 "CPU requirements when building the local package caches. False by default."
4899 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4900 #: apt.conf.5.xml:463
4904 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4905 #: apt.conf.5.xml:464
4907 "The Languages subsection controls which <filename>Translation</filename> "
4908 "files are downloaded and in which order APT tries to display the "
4909 "Description-Translations. APT will try to display the first available "
4910 "Description in the Language which is listed at first. Languages can be "
4911 "defined with their short or long Languagecodes. Note that not all archives "
4912 "provide <filename>Translation</filename> files for every Language - "
4913 "especially the long Languagecodes are rare, so please inform you which ones "
4914 "are available before you set here impossible values."
4917 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
4918 #: apt.conf.5.xml:480
4920 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
4923 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4924 #: apt.conf.5.xml:470
4926 "The default list includes \"environment\" and "
4927 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
4928 "will be replaced at runtime with the languagecodes extracted from the "
4929 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
4930 "that these codes are not included twice in the list. If "
4931 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
4932 "<filename>Translation-en</filename> file (if available) will be used. To "
4933 "force apt to use no Translation file use the setting "
4934 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
4935 "another special meaning code which will stop the search for a fitting "
4936 "<filename>Translation</filename> file. This can be used by the system "
4937 "administrator to let APT know that it should download also this files "
4938 "without actually use them if the environment doesn't specify this "
4939 "languages. So the following example configuration will result in the order "
4940 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
4941 "that \"fr\" is downloaded, but not used if APT is not used in a french "
4942 "localization, in such an environment the order would be \"fr, de, en\". "
4943 "<placeholder type=\"programlisting\" id=\"0\"/>"
4946 #. type: Content of: <refentry><refsect1><para>
4947 #: apt.conf.5.xml:245
4949 "The <literal>Acquire</literal> group of options controls the download of "
4950 "packages and the URI handlers. <placeholder type=\"variablelist\" "
4954 #. type: Content of: <refentry><refsect1><title>
4955 #: apt.conf.5.xml:487
4959 #. type: Content of: <refentry><refsect1><para>
4960 #: apt.conf.5.xml:489
4962 "The <literal>Dir::State</literal> section has directories that pertain to "
4963 "local state information. <literal>lists</literal> is the directory to place "
4964 "downloaded package lists in and <literal>status</literal> is the name of the "
4965 "dpkg status file. <literal>preferences</literal> is the name of the APT "
4966 "preferences file. <literal>Dir::State</literal> contains the default "
4967 "directory to prefix on all sub items if they do not start with "
4968 "<filename>/</filename> or <filename>./</filename>."
4971 #. type: Content of: <refentry><refsect1><para>
4972 #: apt.conf.5.xml:496
4974 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
4975 "information, such as the two package caches <literal>srcpkgcache</literal> "
4976 "and <literal>pkgcache</literal> as well as the location to place downloaded "
4977 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
4978 "be turned off by setting their names to be blank. This will slow down "
4979 "startup but save disk space. It is probably preferred to turn off the "
4980 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
4981 "default directory is contained in <literal>Dir::Cache</literal>"
4984 #. type: Content of: <refentry><refsect1><para>
4985 #: apt.conf.5.xml:505
4987 "<literal>Dir::Etc</literal> contains the location of configuration files, "
4988 "<literal>sourcelist</literal> gives the location of the sourcelist and "
4989 "<literal>main</literal> is the default configuration file (setting has no "
4990 "effect, unless it is done from the config file specified by "
4991 "<envar>APT_CONFIG</envar>)."
4994 #. type: Content of: <refentry><refsect1><para>
4995 #: apt.conf.5.xml:511
4997 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
4998 "in lexical order from the directory specified. After this is done then the "
4999 "main config file is loaded."
5002 #. type: Content of: <refentry><refsect1><para>
5003 #: apt.conf.5.xml:515
5005 "Binary programs are pointed to by "
5006 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
5007 "the location of the method handlers and <literal>gzip</literal>, "
5008 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
5009 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
5010 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
5011 "specify the location of the respective programs."
5014 #. type: Content of: <refentry><refsect1><para>
5015 #: apt.conf.5.xml:523
5017 "The configuration item <literal>RootDir</literal> has a special meaning. If "
5018 "set, all paths in <literal>Dir::</literal> will be relative to "
5019 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
5020 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
5021 "set to <filename>/tmp/staging</filename> and "
5022 "<literal>Dir::State::status</literal> is set to "
5023 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
5024 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
5027 #. type: Content of: <refentry><refsect1><para>
5028 #: apt.conf.5.xml:536
5030 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
5031 "which files APT should silently ignore while parsing the files in the "
5032 "fragment directories. Per default a file which end with "
5033 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
5034 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
5035 "default value these patterns can use regular expression syntax."
5038 #. type: Content of: <refentry><refsect1><title>
5039 #: apt.conf.5.xml:545
5040 msgid "APT in DSelect"
5043 #. type: Content of: <refentry><refsect1><para>
5044 #: apt.conf.5.xml:547
5046 "When APT is used as a &dselect; method several configuration directives "
5047 "control the default behaviour. These are in the <literal>DSelect</literal> "
5051 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5052 #: apt.conf.5.xml:551
5056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5057 #: apt.conf.5.xml:552
5059 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
5060 "and never. always and prompt will remove all packages from the cache after "
5061 "upgrading, prompt (the default) does so conditionally. auto removes only "
5062 "those packages which are no longer downloadable (replaced with a new version "
5063 "for instance). pre-auto performs this action before downloading new "
5067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5068 #: apt.conf.5.xml:561
5070 "The contents of this variable is passed to &apt-get; as command line options "
5071 "when it is run for the install phase."
5074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5075 #: apt.conf.5.xml:565
5076 msgid "Updateoptions"
5079 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5080 #: apt.conf.5.xml:566
5082 "The contents of this variable is passed to &apt-get; as command line options "
5083 "when it is run for the update phase."
5086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5087 #: apt.conf.5.xml:570
5088 msgid "PromptAfterUpdate"
5091 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5092 #: apt.conf.5.xml:571
5094 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
5095 "The default is to prompt only on error."
5098 #. type: Content of: <refentry><refsect1><title>
5099 #: apt.conf.5.xml:577
5100 msgid "How APT calls dpkg"
5103 #. type: Content of: <refentry><refsect1><para>
5104 #: apt.conf.5.xml:578
5106 "Several configuration directives control how APT invokes &dpkg;. These are "
5107 "in the <literal>DPkg</literal> section."
5110 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5111 #: apt.conf.5.xml:583
5113 "This is a list of options to pass to dpkg. The options must be specified "
5114 "using the list notation and each list item is passed as a single argument to "
5118 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5119 #: apt.conf.5.xml:588
5123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5124 #: apt.conf.5.xml:588
5128 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5129 #: apt.conf.5.xml:589
5131 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
5132 "<literal>options</literal> this must be specified in list notation. The "
5133 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5134 "fail APT will abort."
5137 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5138 #: apt.conf.5.xml:595
5139 msgid "Pre-Install-Pkgs"
5142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5143 #: apt.conf.5.xml:596
5145 "This is a list of shell commands to run before invoking dpkg. Like "
5146 "<literal>options</literal> this must be specified in list notation. The "
5147 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5148 "fail APT will abort. APT will pass to the commands on standard input the "
5149 "filenames of all .deb files it is going to install, one per line."
5152 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5153 #: apt.conf.5.xml:602
5155 "Version 2 of this protocol dumps more information, including the protocol "
5156 "version, the APT configuration space and the packages, files and versions "
5157 "being changed. Version 2 is enabled by setting "
5158 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
5159 "2. <literal>cmd</literal> is a command given to "
5160 "<literal>Pre-Install-Pkgs</literal>."
5163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5164 #: apt.conf.5.xml:609
5165 msgid "Run-Directory"
5168 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5169 #: apt.conf.5.xml:610
5171 "APT chdirs to this directory before invoking dpkg, the default is "
5172 "<filename>/</filename>."
5175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5176 #: apt.conf.5.xml:614
5177 msgid "Build-options"
5180 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5181 #: apt.conf.5.xml:615
5183 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
5184 "default is to disable signing and produce all binaries."
5187 #. type: Content of: <refentry><refsect1><refsect2><title>
5188 #: apt.conf.5.xml:620
5189 msgid "dpkg trigger usage (and related options)"
5192 #. type: Content of: <refentry><refsect1><refsect2><para>
5193 #: apt.conf.5.xml:621
5195 "APT can call dpkg in a way so it can make aggressive use of triggers over "
5196 "multiple calls of dpkg. Without further options dpkg will use triggers only "
5197 "in between his own run. Activating these options can therefore decrease the "
5198 "time needed to perform the install / upgrade. Note that it is intended to "
5199 "activate these options per default in the future, but as it changes the way "
5200 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
5201 "options are therefore currently experimental and should not be used in "
5202 "productive environments.</emphasis> Also it breaks the progress reporting so "
5203 "all frontends will currently stay around half (or more) of the time in the "
5204 "100% state while it actually configures all packages."
5207 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
5208 #: apt.conf.5.xml:636
5211 "DPkg::NoTriggers \"true\";\n"
5212 "PackageManager::Configure \"smart\";\n"
5213 "DPkg::ConfigurePending \"true\";\n"
5214 "DPkg::TriggersPending \"true\";"
5217 #. type: Content of: <refentry><refsect1><refsect2><para>
5218 #: apt.conf.5.xml:630
5220 "Note that it is not guaranteed that APT will support these options or that "
5221 "these options will not cause (big) trouble in the future. If you have "
5222 "understand the current risks and problems with these options, but are brave "
5223 "enough to help testing them create a new configuration file and test a "
5224 "combination of options. Please report any bugs, problems and improvements "
5225 "you encounter and make sure to note which options you have used in your "
5226 "reports. Asking dpkg for help could also be useful for debugging proposes, "
5227 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
5228 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
5231 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5232 #: apt.conf.5.xml:642
5233 msgid "DPkg::NoTriggers"
5236 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5237 #: apt.conf.5.xml:643
5239 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
5240 "call). See &dpkg; if you are interested in what this actually means. In "
5241 "short: dpkg will not run the triggers when this flag is present unless it is "
5242 "explicitly called to do so in an extra call. Note that this option exists "
5243 "(undocumented) also in older apt versions with a slightly different meaning: "
5244 "Previously these option only append --no-triggers to the configure calls to "
5245 "dpkg - now apt will add these flag also to the unpack and remove calls."
5248 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5249 #: apt.conf.5.xml:650
5250 msgid "PackageManager::Configure"
5253 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5254 #: apt.conf.5.xml:651
5256 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
5257 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
5258 "value and causes APT to configure all packages explicit. The "
5259 "\"<literal>smart</literal>\" way is it to configure only packages which need "
5260 "to be configured before another package can be unpacked (Pre-Depends) and "
5261 "let the rest configure by dpkg with a call generated by the next "
5262 "option. \"<literal>no</literal>\" on the other hand will not configure "
5263 "anything and totally rely on dpkg for configuration (which will at the "
5264 "moment fail if a Pre-Depends is encountered). Setting this option to "
5265 "another than the all value will implicitly activate also the next option per "
5266 "default as otherwise the system could end in an unconfigured status which "
5267 "could be unbootable!"
5270 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5271 #: apt.conf.5.xml:661
5272 msgid "DPkg::ConfigurePending"
5275 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5276 #: apt.conf.5.xml:662
5278 "If this option is set apt will call <command>dpkg --configure "
5279 "--pending</command> to let dpkg handle all required configurations and "
5280 "triggers. This option is activated automatic per default if the previous "
5281 "option is not set to <literal>all</literal>, but deactivating could be "
5282 "useful if you want to run APT multiple times in a row - e.g. in an "
5283 "installer. In these sceneries you could deactivate this option in all but "
5287 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5288 #: apt.conf.5.xml:668
5289 msgid "DPkg::TriggersPending"
5292 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5293 #: apt.conf.5.xml:669
5295 "Useful for <literal>smart</literal> configuration as a package which has "
5296 "pending triggers is not considered as <literal>installed</literal> and dpkg "
5297 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
5298 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
5299 "triggers, not only the triggers needed to configure this package."
5302 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5303 #: apt.conf.5.xml:674
5304 msgid "PackageManager::UnpackAll"
5307 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5308 #: apt.conf.5.xml:675
5310 "As the configuration can be deferred to be done at the end by dpkg it can be "
5311 "tried to order the unpack series only by critical needs, e.g. by "
5312 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
5313 "various steps by everything. While both method were present in earlier APT "
5314 "versions the <literal>OrderCritical</literal> method was unused, so this "
5315 "method is very experimental and needs further improvements before becoming "
5319 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5320 #: apt.conf.5.xml:682
5321 msgid "OrderList::Score::Immediate"
5324 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
5325 #: apt.conf.5.xml:690
5328 "OrderList::Score {\n"
5330 "\tEssential 200;\n"
5332 "\tPreDepends 50;\n"
5336 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5337 #: apt.conf.5.xml:683
5339 "Essential packages (and there dependencies) should be configured immediately "
5340 "after unpacking. It will be a good idea to do this quite early in the "
5341 "upgrade process as these these configure calls require currently also "
5342 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
5343 "(which maybe not needed). Essentials get per default a high score but the "
5344 "immediate flag is relatively low (a package which has a Pre-Depends is "
5345 "higher rated). These option and the others in the same group can be used to "
5346 "change the scoring. The following example shows the settings with there "
5347 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
5350 #. type: Content of: <refentry><refsect1><title>
5351 #: apt.conf.5.xml:703
5352 msgid "Periodic and Archives options"
5355 #. type: Content of: <refentry><refsect1><para>
5356 #: apt.conf.5.xml:704
5358 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
5359 "of options configure behavior of apt periodic updates, which is done by "
5360 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
5361 "the brief documentation of these options."
5364 #. type: Content of: <refentry><refsect1><title>
5365 #: apt.conf.5.xml:712
5366 msgid "Debug options"
5369 #. type: Content of: <refentry><refsect1><para>
5370 #: apt.conf.5.xml:714
5372 "Enabling options in the <literal>Debug::</literal> section will cause "
5373 "debugging information to be sent to the standard error stream of the program "
5374 "utilizing the <literal>apt</literal> libraries, or enable special program "
5375 "modes that are primarily useful for debugging the behavior of "
5376 "<literal>apt</literal>. Most of these options are not interesting to a "
5377 "normal user, but a few may be:"
5380 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5381 #: apt.conf.5.xml:725
5383 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
5384 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
5388 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5389 #: apt.conf.5.xml:733
5391 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
5392 "used to run some operations (for instance, <literal>apt-get -s "
5393 "install</literal>) as a non-root user."
5396 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5397 #: apt.conf.5.xml:742
5399 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
5400 "time that <literal>apt</literal> invokes &dpkg;."
5404 #. motivating example, except I haven't a clue why you'd want
5406 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5407 #: apt.conf.5.xml:750
5409 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
5413 #. type: Content of: <refentry><refsect1><para>
5414 #: apt.conf.5.xml:760
5415 msgid "A full list of debugging options to apt follows."
5418 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5419 #: apt.conf.5.xml:765
5420 msgid "<literal>Debug::Acquire::cdrom</literal>"
5423 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5424 #: apt.conf.5.xml:769
5425 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
5428 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5429 #: apt.conf.5.xml:776
5430 msgid "<literal>Debug::Acquire::ftp</literal>"
5433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5434 #: apt.conf.5.xml:780
5435 msgid "Print information related to downloading packages using FTP."
5438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5439 #: apt.conf.5.xml:787
5440 msgid "<literal>Debug::Acquire::http</literal>"
5443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5444 #: apt.conf.5.xml:791
5445 msgid "Print information related to downloading packages using HTTP."
5448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5449 #: apt.conf.5.xml:798
5450 msgid "<literal>Debug::Acquire::https</literal>"
5453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5454 #: apt.conf.5.xml:802
5455 msgid "Print information related to downloading packages using HTTPS."
5458 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5459 #: apt.conf.5.xml:809
5460 msgid "<literal>Debug::Acquire::gpgv</literal>"
5463 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5464 #: apt.conf.5.xml:813
5466 "Print information related to verifying cryptographic signatures using "
5467 "<literal>gpg</literal>."
5470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5471 #: apt.conf.5.xml:820
5472 msgid "<literal>Debug::aptcdrom</literal>"
5475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5476 #: apt.conf.5.xml:824
5478 "Output information about the process of accessing collections of packages "
5479 "stored on CD-ROMs."
5482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5483 #: apt.conf.5.xml:831
5484 msgid "<literal>Debug::BuildDeps</literal>"
5487 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5488 #: apt.conf.5.xml:834
5489 msgid "Describes the process of resolving build-dependencies in &apt-get;."
5492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5493 #: apt.conf.5.xml:841
5494 msgid "<literal>Debug::Hashes</literal>"
5497 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5498 #: apt.conf.5.xml:844
5500 "Output each cryptographic hash that is generated by the "
5501 "<literal>apt</literal> libraries."
5504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5505 #: apt.conf.5.xml:851
5506 msgid "<literal>Debug::IdentCDROM</literal>"
5509 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5510 #: apt.conf.5.xml:854
5512 "Do not include information from <literal>statfs</literal>, namely the number "
5513 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
5517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5518 #: apt.conf.5.xml:862
5519 msgid "<literal>Debug::NoLocking</literal>"
5522 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5523 #: apt.conf.5.xml:865
5525 "Disable all file locking. For instance, this will allow two instances of "
5526 "<quote><literal>apt-get update</literal></quote> to run at the same time."
5529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5530 #: apt.conf.5.xml:873
5531 msgid "<literal>Debug::pkgAcquire</literal>"
5534 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5535 #: apt.conf.5.xml:877
5536 msgid "Log when items are added to or removed from the global download queue."
5539 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5540 #: apt.conf.5.xml:884
5541 msgid "<literal>Debug::pkgAcquire::Auth</literal>"
5544 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5545 #: apt.conf.5.xml:887
5547 "Output status messages and errors related to verifying checksums and "
5548 "cryptographic signatures of downloaded files."
5551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5552 #: apt.conf.5.xml:894
5553 msgid "<literal>Debug::pkgAcquire::Diffs</literal>"
5556 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5557 #: apt.conf.5.xml:897
5559 "Output information about downloading and applying package index list diffs, "
5560 "and errors relating to package index list diffs."
5563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5564 #: apt.conf.5.xml:905
5565 msgid "<literal>Debug::pkgAcquire::RRed</literal>"
5568 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5569 #: apt.conf.5.xml:909
5571 "Output information related to patching apt package lists when downloading "
5572 "index diffs instead of full indices."
5575 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5576 #: apt.conf.5.xml:916
5577 msgid "<literal>Debug::pkgAcquire::Worker</literal>"
5580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5581 #: apt.conf.5.xml:920
5582 msgid "Log all interactions with the sub-processes that actually perform downloads."
5585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5586 #: apt.conf.5.xml:927
5587 msgid "<literal>Debug::pkgAutoRemove</literal>"
5590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5591 #: apt.conf.5.xml:931
5593 "Log events related to the automatically-installed status of packages and to "
5594 "the removal of unused packages."
5597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5598 #: apt.conf.5.xml:938
5599 msgid "<literal>Debug::pkgDepCache::AutoInstall</literal>"
5602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5603 #: apt.conf.5.xml:941
5605 "Generate debug messages describing which packages are being automatically "
5606 "installed to resolve dependencies. This corresponds to the initial "
5607 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
5608 "and not to the full <literal>apt</literal> dependency resolver; see "
5609 "<literal>Debug::pkgProblemResolver</literal> for that."
5612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5613 #: apt.conf.5.xml:952
5614 msgid "<literal>Debug::pkgDepCache::Marker</literal>"
5617 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5618 #: apt.conf.5.xml:955
5620 "Generate debug messages describing which package is marked as "
5621 "keep/install/remove while the ProblemResolver does his work. Each addition "
5622 "or deletion may trigger additional actions; they are shown indented two "
5623 "additional space under the original entry. The format for each line is "
5624 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
5625 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
5626 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
5627 "is the current version of the package, <literal>d.e.f</literal> is the "
5628 "version considered for installation and <literal>x.y.z</literal> is a newer "
5629 "version, but not considered for installation (because of a low pin "
5630 "score). The later two can be omitted if there is none or if it is the same "
5631 "version as the installed. <literal>section</literal> is the name of the "
5632 "section the package appears in."
5635 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5636 #: apt.conf.5.xml:974
5637 msgid "<literal>Debug::pkgInitConfig</literal>"
5640 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5641 #: apt.conf.5.xml:977
5642 msgid "Dump the default configuration to standard error on startup."
5645 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5646 #: apt.conf.5.xml:984
5647 msgid "<literal>Debug::pkgDPkgPM</literal>"
5650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5651 #: apt.conf.5.xml:987
5653 "When invoking &dpkg;, output the precise command line with which it is being "
5654 "invoked, with arguments separated by a single space character."
5657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5658 #: apt.conf.5.xml:995
5659 msgid "<literal>Debug::pkgDPkgProgressReporting</literal>"
5662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5663 #: apt.conf.5.xml:998
5665 "Output all the data received from &dpkg; on the status file descriptor and "
5666 "any errors encountered while parsing it."
5669 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5670 #: apt.conf.5.xml:1005
5671 msgid "<literal>Debug::pkgOrderList</literal>"
5674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5675 #: apt.conf.5.xml:1009
5677 "Generate a trace of the algorithm that decides the order in which "
5678 "<literal>apt</literal> should pass packages to &dpkg;."
5681 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5682 #: apt.conf.5.xml:1017
5683 msgid "<literal>Debug::pkgPackageManager</literal>"
5686 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5687 #: apt.conf.5.xml:1021
5688 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
5691 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5692 #: apt.conf.5.xml:1028
5693 msgid "<literal>Debug::pkgPolicy</literal>"
5696 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5697 #: apt.conf.5.xml:1032
5698 msgid "Output the priority of each package list on startup."
5701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5702 #: apt.conf.5.xml:1038
5703 msgid "<literal>Debug::pkgProblemResolver</literal>"
5706 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5707 #: apt.conf.5.xml:1042
5709 "Trace the execution of the dependency resolver (this applies only to what "
5710 "happens when a complex dependency problem is encountered)."
5713 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5714 #: apt.conf.5.xml:1050
5715 msgid "<literal>Debug::pkgProblemResolver::ShowScores</literal>"
5718 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5719 #: apt.conf.5.xml:1053
5721 "Display a list of all installed packages with their calculated score used by "
5722 "the pkgProblemResolver. The description of the package is the same as "
5723 "described in <literal>Debug::pkgDepCache::Marker</literal>"
5726 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5727 #: apt.conf.5.xml:1061
5728 msgid "<literal>Debug::sourceList</literal>"
5731 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5732 #: apt.conf.5.xml:1065
5734 "Print information about the vendors read from "
5735 "<filename>/etc/apt/vendors.list</filename>."
5738 #. type: Content of: <refentry><refsect1><para>
5739 #: apt.conf.5.xml:1088
5741 "&configureindex; is a configuration file showing example values for all "
5745 #. type: Content of: <refentry><refsect1><variablelist>
5746 #: apt.conf.5.xml:1095
5747 msgid "&file-aptconf;"
5750 #. ? reading apt.conf
5751 #. type: Content of: <refentry><refsect1><para>
5752 #: apt.conf.5.xml:1100
5753 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
5756 #. The last update date
5757 #. type: Content of: <refentry><refentryinfo>
5758 #: apt_preferences.5.xml:16
5759 msgid "&apt-author.team; &apt-email; &apt-product; <date>16 February 2010</date>"
5762 #. type: Content of: <refentry><refnamediv><refname>
5763 #: apt_preferences.5.xml:24 apt_preferences.5.xml:31
5764 msgid "apt_preferences"
5767 #. type: Content of: <refentry><refnamediv><refpurpose>
5768 #: apt_preferences.5.xml:32
5769 msgid "Preference control file for APT"
5772 #. type: Content of: <refentry><refsect1><para>
5773 #: apt_preferences.5.xml:37
5775 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
5776 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
5777 "can be used to control which versions of packages will be selected for "
5781 #. type: Content of: <refentry><refsect1><para>
5782 #: apt_preferences.5.xml:42
5784 "Several versions of a package may be available for installation when the "
5785 "&sources-list; file contains references to more than one distribution (for "
5786 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
5787 "assigns a priority to each version that is available. Subject to dependency "
5788 "constraints, <command>apt-get</command> selects the version with the highest "
5789 "priority for installation. The APT preferences file overrides the "
5790 "priorities that APT assigns to package versions by default, thus giving the "
5791 "user control over which one is selected for installation."
5794 #. type: Content of: <refentry><refsect1><para>
5795 #: apt_preferences.5.xml:52
5797 "Several instances of the same version of a package may be available when the "
5798 "&sources-list; file contains references to more than one source. In this "
5799 "case <command>apt-get</command> downloads the instance listed earliest in "
5800 "the &sources-list; file. The APT preferences file does not affect the "
5801 "choice of instance, only the choice of version."
5804 #. type: Content of: <refentry><refsect1><para>
5805 #: apt_preferences.5.xml:59
5807 "Preferences are a strong power in the hands of a system administrator but "
5808 "they can become also their biggest nightmare if used without care! APT will "
5809 "not questioning the preferences so wrong settings will therefore lead to "
5810 "uninstallable packages or wrong decisions while upgrading packages. Even "
5811 "more problems will arise if multiply distribution releases are mixed without "
5812 "a good understanding of the following paragraphs. Packages included in a "
5813 "specific release aren't tested in and therefore doesn't always work as "
5814 "expected in older or newer releases or together with other packages from "
5815 "different releases. You have been warned."
5818 #. type: Content of: <refentry><refsect1><para>
5819 #: apt_preferences.5.xml:70
5821 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
5822 "directory are parsed in alphanumeric ascending order and need to obey the "
5823 "following naming convention: The files have no or "
5824 "\"<literal>pref</literal>\" as filename extension and which only contain "
5825 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
5826 "Otherwise APT will print a notice that it has ignored a file if the file "
5827 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5828 "configuration list - in this case it will be silently ignored."
5831 #. type: Content of: <refentry><refsect1><refsect2><title>
5832 #: apt_preferences.5.xml:79
5833 msgid "APT's Default Priority Assignments"
5836 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5837 #: apt_preferences.5.xml:94
5840 "<command>apt-get install -t testing "
5841 "<replaceable>some-package</replaceable></command>\n"
5844 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5845 #: apt_preferences.5.xml:97
5847 msgid "APT::Default-Release \"stable\";\n"
5850 #. type: Content of: <refentry><refsect1><refsect2><para>
5851 #: apt_preferences.5.xml:81
5853 "If there is no preferences file or if there is no entry in the file that "
5854 "applies to a particular version then the priority assigned to that version "
5855 "is the priority of the distribution to which that version belongs. It is "
5856 "possible to single out a distribution, \"the target release\", which "
5857 "receives a higher priority than other distributions do by default. The "
5858 "target release can be set on the <command>apt-get</command> command line or "
5859 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
5860 "that this has precedence over any general priority you set in the "
5861 "<filename>/etc/apt/preferences</filename> file described later, but not over "
5862 "specifically pinned packages. For example, <placeholder "
5863 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
5867 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5868 #: apt_preferences.5.xml:106
5872 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5873 #: apt_preferences.5.xml:107
5875 "to the versions coming from archives which in their "
5876 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" like "
5877 "the debian experimental archive."
5880 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5881 #: apt_preferences.5.xml:112
5882 msgid "priority 100"
5885 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5886 #: apt_preferences.5.xml:113
5887 msgid "to the version that is already installed (if any)."
5890 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5891 #: apt_preferences.5.xml:117
5892 msgid "priority 500"
5895 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5896 #: apt_preferences.5.xml:118
5898 "to the versions that are not installed and do not belong to the target "
5902 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5903 #: apt_preferences.5.xml:122
5904 msgid "priority 990"
5907 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5908 #: apt_preferences.5.xml:123
5909 msgid "to the versions that are not installed and belong to the target release."
5912 #. type: Content of: <refentry><refsect1><refsect2><para>
5913 #: apt_preferences.5.xml:101
5915 "If the target release has been specified then APT uses the following "
5916 "algorithm to set the priorities of the versions of a package. Assign: "
5917 "<placeholder type=\"variablelist\" id=\"0\"/>"
5920 #. type: Content of: <refentry><refsect1><refsect2><para>
5921 #: apt_preferences.5.xml:128
5923 "If the target release has not been specified then APT simply assigns "
5924 "priority 100 to all installed package versions and priority 500 to all "
5925 "uninstalled package versions, expect versions coming from archives which in "
5926 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
5927 "- these versions get the priority 1."
5930 #. type: Content of: <refentry><refsect1><refsect2><para>
5931 #: apt_preferences.5.xml:134
5933 "APT then applies the following rules, listed in order of precedence, to "
5934 "determine which version of a package to install."
5937 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5938 #: apt_preferences.5.xml:137
5940 "Never downgrade unless the priority of an available version exceeds 1000. "
5941 "(\"Downgrading\" is installing a less recent version of a package in place "
5942 "of a more recent version. Note that none of APT's default priorities "
5943 "exceeds 1000; such high priorities can only be set in the preferences file. "
5944 "Note also that downgrading a package can be risky.)"
5947 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5948 #: apt_preferences.5.xml:143
5949 msgid "Install the highest priority version."
5952 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5953 #: apt_preferences.5.xml:144
5955 "If two or more versions have the same priority, install the most recent one "
5956 "(that is, the one with the higher version number)."
5959 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5960 #: apt_preferences.5.xml:147
5962 "If two or more versions have the same priority and version number but either "
5963 "the packages differ in some of their metadata or the "
5964 "<literal>--reinstall</literal> option is given, install the uninstalled one."
5967 #. type: Content of: <refentry><refsect1><refsect2><para>
5968 #: apt_preferences.5.xml:153
5970 "In a typical situation, the installed version of a package (priority 100) "
5971 "is not as recent as one of the versions available from the sources listed in "
5972 "the &sources-list; file (priority 500 or 990). Then the package will be "
5973 "upgraded when <command>apt-get install "
5974 "<replaceable>some-package</replaceable></command> or <command>apt-get "
5975 "upgrade</command> is executed."
5978 #. type: Content of: <refentry><refsect1><refsect2><para>
5979 #: apt_preferences.5.xml:160
5981 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
5982 "recent than any of the other available versions. The package will not be "
5983 "downgraded when <command>apt-get install "
5984 "<replaceable>some-package</replaceable></command> or <command>apt-get "
5985 "upgrade</command> is executed."
5988 #. type: Content of: <refentry><refsect1><refsect2><para>
5989 #: apt_preferences.5.xml:165
5991 "Sometimes the installed version of a package is more recent than the version "
5992 "belonging to the target release, but not as recent as a version belonging to "
5993 "some other distribution. Such a package will indeed be upgraded when "
5994 "<command>apt-get install <replaceable>some-package</replaceable></command> "
5995 "or <command>apt-get upgrade</command> is executed, because at least "
5996 "<emphasis>one</emphasis> of the available versions has a higher priority "
5997 "than the installed version."
6000 #. type: Content of: <refentry><refsect1><refsect2><title>
6001 #: apt_preferences.5.xml:174
6002 msgid "The Effect of APT Preferences"
6005 #. type: Content of: <refentry><refsect1><refsect2><para>
6006 #: apt_preferences.5.xml:176
6008 "The APT preferences file allows the system administrator to control the "
6009 "assignment of priorities. The file consists of one or more multi-line "
6010 "records separated by blank lines. Records can have one of two forms, a "
6011 "specific form and a general form."
6014 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6015 #: apt_preferences.5.xml:182
6017 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
6018 "specified packages and specified version or version range. For example, the "
6019 "following record assigns a high priority to all versions of the "
6020 "<filename>perl</filename> package whose version number begins with "
6021 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
6024 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6025 #: apt_preferences.5.xml:189
6029 "Pin: version 5.8*\n"
6030 "Pin-Priority: 1001\n"
6033 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6034 #: apt_preferences.5.xml:195
6036 "The general form assigns a priority to all of the package versions in a "
6037 "given distribution (that is, to all the versions of packages that are listed "
6038 "in a certain <filename>Release</filename> file) or to all of the package "
6039 "versions coming from a particular Internet site, as identified by the site's "
6040 "fully qualified domain name."
6043 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6044 #: apt_preferences.5.xml:201
6046 "This general-form entry in the APT preferences file applies only to groups "
6047 "of packages. For example, the following record assigns a high priority to "
6048 "all package versions available from the local site."
6051 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6052 #: apt_preferences.5.xml:206
6056 "Pin: origin \"\"\n"
6057 "Pin-Priority: 999\n"
6060 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6061 #: apt_preferences.5.xml:211
6063 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
6064 "which can be used to match a hostname. The following record will assign a "
6065 "high priority to all versions available from the server identified by the "
6066 "hostname \"ftp.de.debian.org\""
6069 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6070 #: apt_preferences.5.xml:215
6074 "Pin: origin \"ftp.de.debian.org\"\n"
6075 "Pin-Priority: 999\n"
6078 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6079 #: apt_preferences.5.xml:219
6081 "This should <emphasis>not</emphasis> be confused with the Origin of a "
6082 "distribution as specified in a <filename>Release</filename> file. What "
6083 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
6084 "Internet address but an author or vendor name, such as \"Debian\" or "
6088 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6089 #: apt_preferences.5.xml:224
6091 "The following record assigns a low priority to all package versions "
6092 "belonging to any distribution whose Archive name is "
6093 "\"<literal>unstable</literal>\"."
6096 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6097 #: apt_preferences.5.xml:228
6101 "Pin: release a=unstable\n"
6102 "Pin-Priority: 50\n"
6105 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6106 #: apt_preferences.5.xml:233
6108 "The following record assigns a high priority to all package versions "
6109 "belonging to any distribution whose Codename is "
6110 "\"<literal>&testing-codename;</literal>\"."
6113 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6114 #: apt_preferences.5.xml:237
6118 "Pin: release n=&testing-codename;\n"
6119 "Pin-Priority: 900\n"
6122 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6123 #: apt_preferences.5.xml:242
6125 "The following record assigns a high priority to all package versions "
6126 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
6127 "and whose release Version number is \"<literal>3.0</literal>\"."
6130 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6131 #: apt_preferences.5.xml:247
6135 "Pin: release a=stable, v=3.0\n"
6136 "Pin-Priority: 500\n"
6139 #. type: Content of: <refentry><refsect1><refsect2><title>
6140 #: apt_preferences.5.xml:258
6141 msgid "How APT Interprets Priorities"
6144 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6145 #: apt_preferences.5.xml:266
6149 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6150 #: apt_preferences.5.xml:267
6152 "causes a version to be installed even if this constitutes a downgrade of the "
6156 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6157 #: apt_preferences.5.xml:271
6158 msgid "990 < P <=1000"
6161 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6162 #: apt_preferences.5.xml:272
6164 "causes a version to be installed even if it does not come from the target "
6165 "release, unless the installed version is more recent"
6168 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6169 #: apt_preferences.5.xml:277
6170 msgid "500 < P <=990"
6173 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6174 #: apt_preferences.5.xml:278
6176 "causes a version to be installed unless there is a version available "
6177 "belonging to the target release or the installed version is more recent"
6180 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6181 #: apt_preferences.5.xml:283
6182 msgid "100 < P <=500"
6185 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6186 #: apt_preferences.5.xml:284
6188 "causes a version to be installed unless there is a version available "
6189 "belonging to some other distribution or the installed version is more recent"
6192 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6193 #: apt_preferences.5.xml:289
6194 msgid "0 < P <=100"
6197 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6198 #: apt_preferences.5.xml:290
6200 "causes a version to be installed only if there is no installed version of "
6204 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6205 #: apt_preferences.5.xml:294
6209 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6210 #: apt_preferences.5.xml:295
6211 msgid "prevents the version from being installed"
6214 #. type: Content of: <refentry><refsect1><refsect2><para>
6215 #: apt_preferences.5.xml:261
6217 "Priorities (P) assigned in the APT preferences file must be positive or "
6218 "negative integers. They are interpreted as follows (roughly speaking): "
6219 "<placeholder type=\"variablelist\" id=\"0\"/>"
6222 #. type: Content of: <refentry><refsect1><refsect2><para>
6223 #: apt_preferences.5.xml:300
6225 "If any specific-form records match an available package version then the "
6226 "first such record determines the priority of the package version. Failing "
6227 "that, if any general-form records match an available package version then "
6228 "the first such record determines the priority of the package version."
6231 #. type: Content of: <refentry><refsect1><refsect2><para>
6232 #: apt_preferences.5.xml:306
6234 "For example, suppose the APT preferences file contains the three records "
6235 "presented earlier:"
6238 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6239 #: apt_preferences.5.xml:310
6243 "Pin: version 5.8*\n"
6244 "Pin-Priority: 1001\n"
6247 "Pin: origin \"\"\n"
6248 "Pin-Priority: 999\n"
6251 "Pin: release unstable\n"
6252 "Pin-Priority: 50\n"
6255 #. type: Content of: <refentry><refsect1><refsect2><para>
6256 #: apt_preferences.5.xml:323
6260 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6261 #: apt_preferences.5.xml:325
6263 "The most recent available version of the <literal>perl</literal> package "
6264 "will be installed, so long as that version's version number begins with "
6265 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
6266 "<literal>perl</literal> is available and the installed version is 5.9*, then "
6267 "<literal>perl</literal> will be downgraded."
6270 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6271 #: apt_preferences.5.xml:330
6273 "A version of any package other than <literal>perl</literal> that is "
6274 "available from the local system has priority over other versions, even "
6275 "versions belonging to the target release."
6278 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6279 #: apt_preferences.5.xml:334
6281 "A version of a package whose origin is not the local system but some other "
6282 "site listed in &sources-list; and which belongs to an "
6283 "<literal>unstable</literal> distribution is only installed if it is selected "
6284 "for installation and no version of the package is already installed."
6287 #. type: Content of: <refentry><refsect1><refsect2><title>
6288 #: apt_preferences.5.xml:344
6289 msgid "Determination of Package Version and Distribution Properties"
6292 #. type: Content of: <refentry><refsect1><refsect2><para>
6293 #: apt_preferences.5.xml:346
6295 "The locations listed in the &sources-list; file should provide "
6296 "<filename>Packages</filename> and <filename>Release</filename> files to "
6297 "describe the packages available at that location."
6300 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6301 #: apt_preferences.5.xml:358
6302 msgid "the <literal>Package:</literal> line"
6305 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6306 #: apt_preferences.5.xml:359
6307 msgid "gives the package name"
6310 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6311 #: apt_preferences.5.xml:362 apt_preferences.5.xml:412
6312 msgid "the <literal>Version:</literal> line"
6315 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6316 #: apt_preferences.5.xml:363
6317 msgid "gives the version number for the named package"
6320 #. type: Content of: <refentry><refsect1><refsect2><para>
6321 #: apt_preferences.5.xml:350
6323 "The <filename>Packages</filename> file is normally found in the directory "
6324 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
6326 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
6327 "consists of a series of multi-line records, one for each package available "
6328 "in that directory. Only two lines in each record are relevant for setting "
6329 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
6332 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6333 #: apt_preferences.5.xml:379
6334 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
6337 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6338 #: apt_preferences.5.xml:380
6340 "names the archive to which all the packages in the directory tree belong. "
6341 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
6342 "that all of the packages in the directory tree below the parent of the "
6343 "<filename>Release</filename> file are in a <literal>stable</literal> "
6344 "archive. Specifying this value in the APT preferences file would require "
6348 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6349 #: apt_preferences.5.xml:390
6351 msgid "Pin: release a=stable\n"
6354 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6355 #: apt_preferences.5.xml:396
6356 msgid "the <literal>Codename:</literal> line"
6359 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6360 #: apt_preferences.5.xml:397
6362 "names the codename to which all the packages in the directory tree belong. "
6363 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
6364 "the packages in the directory tree below the parent of the "
6365 "<filename>Release</filename> file belong to a version named "
6366 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
6367 "preferences file would require the line:"
6370 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6371 #: apt_preferences.5.xml:406
6373 msgid "Pin: release n=&testing-codename;\n"
6376 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6377 #: apt_preferences.5.xml:413
6379 "names the release version. For example, the packages in the tree might "
6380 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
6381 "no version number for the <literal>testing</literal> and "
6382 "<literal>unstable</literal> distributions because they have not been "
6383 "released yet. Specifying this in the APT preferences file would require one "
6384 "of the following lines."
6387 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6388 #: apt_preferences.5.xml:422
6391 "Pin: release v=3.0\n"
6392 "Pin: release a=stable, v=3.0\n"
6393 "Pin: release 3.0\n"
6396 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6397 #: apt_preferences.5.xml:431
6398 msgid "the <literal>Component:</literal> line"
6401 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6402 #: apt_preferences.5.xml:432
6404 "names the licensing component associated with the packages in the directory "
6405 "tree of the <filename>Release</filename> file. For example, the line "
6406 "\"Component: main\" specifies that all the packages in the directory tree "
6407 "are from the <literal>main</literal> component, which entails that they are "
6408 "licensed under terms listed in the Debian Free Software Guidelines. "
6409 "Specifying this component in the APT preferences file would require the "
6413 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6414 #: apt_preferences.5.xml:441
6416 msgid "Pin: release c=main\n"
6419 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6420 #: apt_preferences.5.xml:447
6421 msgid "the <literal>Origin:</literal> line"
6424 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6425 #: apt_preferences.5.xml:448
6427 "names the originator of the packages in the directory tree of the "
6428 "<filename>Release</filename> file. Most commonly, this is "
6429 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
6430 "file would require the line:"
6433 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6434 #: apt_preferences.5.xml:454
6436 msgid "Pin: release o=Debian\n"
6439 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6440 #: apt_preferences.5.xml:460
6441 msgid "the <literal>Label:</literal> line"
6444 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6445 #: apt_preferences.5.xml:461
6447 "names the label of the packages in the directory tree of the "
6448 "<filename>Release</filename> file. Most commonly, this is "
6449 "<literal>Debian</literal>. Specifying this label in the APT preferences "
6450 "file would require the line:"
6453 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6454 #: apt_preferences.5.xml:467
6456 msgid "Pin: release l=Debian\n"
6459 #. type: Content of: <refentry><refsect1><refsect2><para>
6460 #: apt_preferences.5.xml:368
6462 "The <filename>Release</filename> file is normally found in the directory "
6463 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
6464 "example, <filename>.../dists/stable/Release</filename>, or "
6465 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
6466 "single multi-line record which applies to <emphasis>all</emphasis> of the "
6467 "packages in the directory tree below its parent. Unlike the "
6468 "<filename>Packages</filename> file, nearly all of the lines in a "
6469 "<filename>Release</filename> file are relevant for setting APT priorities: "
6470 "<placeholder type=\"variablelist\" id=\"0\"/>"
6473 #. type: Content of: <refentry><refsect1><refsect2><para>
6474 #: apt_preferences.5.xml:474
6476 "All of the <filename>Packages</filename> and <filename>Release</filename> "
6477 "files retrieved from locations listed in the &sources-list; file are stored "
6478 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
6479 "named by the variable <literal>Dir::State::Lists</literal> in the "
6480 "<filename>apt.conf</filename> file. For example, the file "
6481 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
6482 "contains the <filename>Release</filename> file retrieved from the site "
6483 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
6484 "architecture files from the <literal>contrib</literal> component of the "
6485 "<literal>unstable</literal> distribution."
6488 #. type: Content of: <refentry><refsect1><refsect2><title>
6489 #: apt_preferences.5.xml:487
6490 msgid "Optional Lines in an APT Preferences Record"
6493 #. type: Content of: <refentry><refsect1><refsect2><para>
6494 #: apt_preferences.5.xml:489
6496 "Each record in the APT preferences file can optionally begin with one or "
6497 "more lines beginning with the word <literal>Explanation:</literal>. This "
6498 "provides a place for comments."
6501 #. type: Content of: <refentry><refsect1><refsect2><title>
6502 #: apt_preferences.5.xml:498
6503 msgid "Tracking Stable"
6506 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6507 #: apt_preferences.5.xml:506
6510 "Explanation: Uninstall or do not install any Debian-originated\n"
6511 "Explanation: package versions other than those in the stable distro\n"
6513 "Pin: release a=stable\n"
6514 "Pin-Priority: 900\n"
6517 "Pin: release o=Debian\n"
6518 "Pin-Priority: -10\n"
6521 #. type: Content of: <refentry><refsect1><refsect2><para>
6522 #: apt_preferences.5.xml:500
6524 "The following APT preferences file will cause APT to assign a priority "
6525 "higher than the default (500) to all package versions belonging to a "
6526 "<literal>stable</literal> distribution and a prohibitively low priority to "
6527 "package versions belonging to other <literal>Debian</literal> "
6528 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
6531 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6532 #: apt_preferences.5.xml:523 apt_preferences.5.xml:569 apt_preferences.5.xml:627
6535 "apt-get install <replaceable>package-name</replaceable>\n"
6537 "apt-get dist-upgrade\n"
6540 #. type: Content of: <refentry><refsect1><refsect2><para>
6541 #: apt_preferences.5.xml:518
6543 "With a suitable &sources-list; file and the above preferences file, any of "
6544 "the following commands will cause APT to upgrade to the latest "
6545 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
6549 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6550 #: apt_preferences.5.xml:535
6552 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
6555 #. type: Content of: <refentry><refsect1><refsect2><para>
6556 #: apt_preferences.5.xml:529
6558 "The following command will cause APT to upgrade the specified package to the "
6559 "latest version from the <literal>testing</literal> distribution; the package "
6560 "will not be upgraded again unless this command is given again. <placeholder "
6561 "type=\"programlisting\" id=\"0\"/>"
6564 #. type: Content of: <refentry><refsect1><refsect2><title>
6565 #: apt_preferences.5.xml:541
6566 msgid "Tracking Testing or Unstable"
6569 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6570 #: apt_preferences.5.xml:550
6574 "Pin: release a=testing\n"
6575 "Pin-Priority: 900\n"
6578 "Pin: release a=unstable\n"
6579 "Pin-Priority: 800\n"
6582 "Pin: release o=Debian\n"
6583 "Pin-Priority: -10\n"
6586 #. type: Content of: <refentry><refsect1><refsect2><para>
6587 #: apt_preferences.5.xml:543
6589 "The following APT preferences file will cause APT to assign a high priority "
6590 "to package versions from the <literal>testing</literal> distribution, a "
6591 "lower priority to package versions from the <literal>unstable</literal> "
6592 "distribution, and a prohibitively low priority to package versions from "
6593 "other <literal>Debian</literal> distributions. <placeholder "
6594 "type=\"programlisting\" id=\"0\"/>"
6597 #. type: Content of: <refentry><refsect1><refsect2><para>
6598 #: apt_preferences.5.xml:564
6600 "With a suitable &sources-list; file and the above preferences file, any of "
6601 "the following commands will cause APT to upgrade to the latest "
6602 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
6606 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6607 #: apt_preferences.5.xml:584
6609 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
6612 #. type: Content of: <refentry><refsect1><refsect2><para>
6613 #: apt_preferences.5.xml:575
6615 "The following command will cause APT to upgrade the specified package to the "
6616 "latest version from the <literal>unstable</literal> distribution. "
6617 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
6618 "the most recent <literal>testing</literal> version if that is more recent "
6619 "than the installed version, otherwise, to the most recent "
6620 "<literal>unstable</literal> version if that is more recent than the "
6621 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
6624 #. type: Content of: <refentry><refsect1><refsect2><title>
6625 #: apt_preferences.5.xml:591
6626 msgid "Tracking the evolution of a codename release"
6629 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6630 #: apt_preferences.5.xml:605
6633 "Explanation: Uninstall or do not install any Debian-originated package "
6635 "Explanation: other than those in the distribution codenamed with "
6636 "&testing-codename; or sid\n"
6638 "Pin: release n=&testing-codename;\n"
6639 "Pin-Priority: 900\n"
6641 "Explanation: Debian unstable is always codenamed with sid\n"
6643 "Pin: release n=sid\n"
6644 "Pin-Priority: 800\n"
6647 "Pin: release o=Debian\n"
6648 "Pin-Priority: -10\n"
6651 #. type: Content of: <refentry><refsect1><refsect2><para>
6652 #: apt_preferences.5.xml:593
6654 "The following APT preferences file will cause APT to assign a priority "
6655 "higher than the default (500) to all package versions belonging to a "
6656 "specified codename of a distribution and a prohibitively low priority to "
6657 "package versions belonging to other <literal>Debian</literal> distributions, "
6658 "codenames and archives. Note that with this APT preference APT will follow "
6659 "the migration of a release from the archive <literal>testing</literal> to "
6660 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
6661 "want to follow for example the progress in <literal>testing</literal> "
6662 "notwithstanding the codename changes you should use the example "
6663 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
6666 #. type: Content of: <refentry><refsect1><refsect2><para>
6667 #: apt_preferences.5.xml:622
6669 "With a suitable &sources-list; file and the above preferences file, any of "
6670 "the following commands will cause APT to upgrade to the latest version(s) in "
6671 "the release codenamed with <literal>&testing-codename;</literal>. "
6672 "<placeholder type=\"programlisting\" id=\"0\"/>"
6675 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6676 #: apt_preferences.5.xml:642
6678 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
6681 #. type: Content of: <refentry><refsect1><refsect2><para>
6682 #: apt_preferences.5.xml:633
6684 "The following command will cause APT to upgrade the specified package to the "
6685 "latest version from the <literal>sid</literal> distribution. Thereafter, "
6686 "<command>apt-get upgrade</command> will upgrade the package to the most "
6687 "recent <literal>&testing-codename;</literal> version if that is more recent "
6688 "than the installed version, otherwise, to the most recent "
6689 "<literal>sid</literal> version if that is more recent than the installed "
6690 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
6693 #. type: Content of: <refentry><refsect1><variablelist>
6694 #: apt_preferences.5.xml:651
6695 msgid "&file-preferences;"
6698 #. type: Content of: <refentry><refsect1><para>
6699 #: apt_preferences.5.xml:657
6700 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
6703 #. type: Content of: <refentry><refnamediv><refname>
6704 #: sources.list.5.xml:25 sources.list.5.xml:32
6705 msgid "sources.list"
6708 #. type: Content of: <refentry><refnamediv><refpurpose>
6709 #: sources.list.5.xml:33
6710 msgid "Package resource list for APT"
6713 #. type: Content of: <refentry><refsect1><para>
6714 #: sources.list.5.xml:37
6716 "The package resource list is used to locate archives of the package "
6717 "distribution system in use on the system. At this time, this manual page "
6718 "documents only the packaging system used by the Debian GNU/Linux system. "
6719 "This control file is <filename>/etc/apt/sources.list</filename>."
6722 #. type: Content of: <refentry><refsect1><para>
6723 #: sources.list.5.xml:42
6725 "The source list is designed to support any number of active sources and a "
6726 "variety of source media. The file lists one source per line, with the most "
6727 "preferred source listed first. The format of each line is: <literal>type uri "
6728 "args</literal> The first item, <literal>type</literal> determines the format "
6729 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
6730 "Identifier (URI), which is a superset of the more specific and well-known "
6731 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
6732 "comment by using a #."
6735 #. type: Content of: <refentry><refsect1><title>
6736 #: sources.list.5.xml:53
6737 msgid "sources.list.d"
6740 #. type: Content of: <refentry><refsect1><para>
6741 #: sources.list.5.xml:54
6743 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
6744 "add sources.list entries in separate files. The format is the same as for "
6745 "the regular <filename>sources.list</filename> file. File names need to end "
6746 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
6747 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
6748 "Otherwise APT will print a notice that it has ignored a file if the file "
6749 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
6750 "configuration list - in this case it will be silently ignored."
6753 #. type: Content of: <refentry><refsect1><title>
6754 #: sources.list.5.xml:65
6755 msgid "The deb and deb-src types"
6758 #. type: Content of: <refentry><refsect1><para>
6759 #: sources.list.5.xml:66
6761 "The <literal>deb</literal> type describes a typical two-level Debian "
6762 "archive, <filename>distribution/component</filename>. Typically, "
6763 "<literal>distribution</literal> is generally an archivename like "
6764 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
6765 "<literal>&stable-codename;</literal> or "
6766 "<literal>&testing-codename;</literal> while component is one of "
6767 "<literal>main</literal> <literal>contrib</literal> or "
6768 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
6769 "debian distribution's source code in the same form as the "
6770 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
6771 "to fetch source indexes."
6774 #. type: Content of: <refentry><refsect1><para>
6775 #: sources.list.5.xml:78
6777 "The format for a <filename>sources.list</filename> entry using the "
6778 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
6781 #. type: Content of: <refentry><refsect1><literallayout>
6782 #: sources.list.5.xml:81
6784 msgid "deb uri distribution [component1] [component2] [...]"
6787 #. type: Content of: <refentry><refsect1><para>
6788 #: sources.list.5.xml:83
6790 "The URI for the <literal>deb</literal> type must specify the base of the "
6791 "Debian distribution, from which APT will find the information it needs. "
6792 "<literal>distribution</literal> can specify an exact path, in which case the "
6793 "components must be omitted and <literal>distribution</literal> must end with "
6794 "a slash (/). This is useful for when the case only a particular sub-section "
6795 "of the archive denoted by the URI is of interest. If "
6796 "<literal>distribution</literal> does not specify an exact path, at least one "
6797 "<literal>component</literal> must be present."
6800 #. type: Content of: <refentry><refsect1><para>
6801 #: sources.list.5.xml:92
6803 "<literal>distribution</literal> may also contain a variable, "
6804 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
6805 "m68k, powerpc, ...) used on the system. This permits "
6806 "architecture-independent <filename>sources.list</filename> files to be "
6807 "used. In general this is only of interest when specifying an exact path, "
6808 "<literal>APT</literal> will automatically generate a URI with the current "
6809 "architecture otherwise."
6812 #. type: Content of: <refentry><refsect1><para>
6813 #: sources.list.5.xml:100
6815 "Since only one distribution can be specified per line it may be necessary to "
6816 "have multiple lines for the same URI, if a subset of all available "
6817 "distributions or components at that location is desired. APT will sort the "
6818 "URI list after it has generated a complete set internally, and will collapse "
6819 "multiple references to the same Internet host, for instance, into a single "
6820 "connection, so that it does not inefficiently establish an FTP connection, "
6821 "close it, do something else, and then re-establish a connection to that same "
6822 "host. This feature is useful for accessing busy FTP sites with limits on the "
6823 "number of simultaneous anonymous users. APT also parallelizes connections to "
6824 "different hosts to more effectively deal with sites with low bandwidth."
6827 #. type: Content of: <refentry><refsect1><para>
6828 #: sources.list.5.xml:112
6830 "It is important to list sources in order of preference, with the most "
6831 "preferred source listed first. Typically this will result in sorting by "
6832 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
6833 "followed by distant Internet hosts, for example)."
6836 #. type: Content of: <refentry><refsect1><para>
6837 #: sources.list.5.xml:117
6838 msgid "Some examples:"
6841 #. type: Content of: <refentry><refsect1><literallayout>
6842 #: sources.list.5.xml:119
6845 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
6846 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
6851 #. type: Content of: <refentry><refsect1><title>
6852 #: sources.list.5.xml:125
6853 msgid "URI specification"
6856 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6857 #: sources.list.5.xml:130
6861 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6862 #: sources.list.5.xml:132
6864 "The file scheme allows an arbitrary directory in the file system to be "
6865 "considered an archive. This is useful for NFS mounts and local mirrors or "
6869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6870 #: sources.list.5.xml:139
6872 "The cdrom scheme allows APT to use a local CDROM drive with media "
6873 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
6877 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6878 #: sources.list.5.xml:146
6880 "The http scheme specifies an HTTP server for the archive. If an environment "
6881 "variable <envar>http_proxy</envar> is set with the format "
6882 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
6883 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
6884 "the format http://user:pass@server:port/. Note that this is an insecure "
6885 "method of authentication."
6888 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6889 #: sources.list.5.xml:157
6891 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
6892 "is highly configurable; for more information see the &apt-conf; manual "
6893 "page. Please note that a ftp proxy can be specified by using the "
6894 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
6895 "http proxy (http proxy servers often understand ftp urls) using this method "
6896 "and ONLY this method. ftp proxies using http specified in the configuration "
6897 "file will be ignored."
6900 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6901 #: sources.list.5.xml:166
6905 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6906 #: sources.list.5.xml:168
6908 "The copy scheme is identical to the file scheme except that packages are "
6909 "copied into the cache directory instead of used directly at their location. "
6910 "This is useful for people using a zip disk to copy files around with APT."
6913 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6914 #: sources.list.5.xml:173
6918 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6919 #: sources.list.5.xml:173
6923 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6924 #: sources.list.5.xml:175
6926 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
6927 "user and access the files. It is a good idea to do prior arrangements with "
6928 "RSA keys or rhosts. Access to files on the remote uses standard "
6929 "<command>find</command> and <command>dd</command> commands to perform the "
6930 "file transfers from the remote."
6933 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6934 #: sources.list.5.xml:183
6935 msgid "more recognizable URI types"
6938 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6939 #: sources.list.5.xml:185
6941 "APT can be extended with more methods shipped in other optional packages "
6942 "which should follow the nameing scheme "
6943 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
6944 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
6945 "which provides access methods for https-URIs with features similar to the "
6946 "http method, but other methods for using e.g. debtorrent are also available, "
6947 "see <citerefentry> "
6948 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
6949 "<manvolnum>1</manvolnum></citerefentry>."
6952 #. type: Content of: <refentry><refsect1><para>
6953 #: sources.list.5.xml:127
6955 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
6956 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
6959 #. type: Content of: <refentry><refsect1><para>
6960 #: sources.list.5.xml:199
6962 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
6963 "stable/main, stable/contrib, and stable/non-free."
6966 #. type: Content of: <refentry><refsect1><literallayout>
6967 #: sources.list.5.xml:201
6969 msgid "deb file:/home/jason/debian stable main contrib non-free"
6972 #. type: Content of: <refentry><refsect1><para>
6973 #: sources.list.5.xml:203
6974 msgid "As above, except this uses the unstable (development) distribution."
6977 #. type: Content of: <refentry><refsect1><literallayout>
6978 #: sources.list.5.xml:204
6980 msgid "deb file:/home/jason/debian unstable main contrib non-free"
6983 #. type: Content of: <refentry><refsect1><para>
6984 #: sources.list.5.xml:206
6985 msgid "Source line for the above"
6988 #. type: Content of: <refentry><refsect1><literallayout>
6989 #: sources.list.5.xml:207
6991 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
6994 #. type: Content of: <refentry><refsect1><para>
6995 #: sources.list.5.xml:209
6997 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
7001 #. type: Content of: <refentry><refsect1><literallayout>
7002 #: sources.list.5.xml:211
7004 msgid "deb http://archive.debian.org/debian-archive hamm main"
7007 #. type: Content of: <refentry><refsect1><para>
7008 #: sources.list.5.xml:213
7010 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7011 "directory, and uses only the &stable-codename;/contrib area."
7014 #. type: Content of: <refentry><refsect1><literallayout>
7015 #: sources.list.5.xml:215
7017 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
7020 #. type: Content of: <refentry><refsect1><para>
7021 #: sources.list.5.xml:217
7023 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7024 "directory, and uses only the unstable/contrib area. If this line appears as "
7025 "well as the one in the previous example in <filename>sources.list</filename> "
7026 "a single FTP session will be used for both resource lines."
7029 #. type: Content of: <refentry><refsect1><literallayout>
7030 #: sources.list.5.xml:221
7032 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
7035 #. type: Content of: <refentry><refsect1><para><literallayout>
7036 #: sources.list.5.xml:230
7038 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
7041 #. type: Content of: <refentry><refsect1><para>
7042 #: sources.list.5.xml:223
7044 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
7045 "directory, and uses only files found under "
7046 "<filename>unstable/binary-i386</filename> on i386 machines, "
7047 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
7048 "supported architectures. [Note this example only illustrates how to use the "
7049 "substitution variable; official debian archives are not structured like "
7050 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
7053 #. type: Content of: <refentry><refsect1><para>
7054 #: sources.list.5.xml:235
7055 msgid "&apt-cache; &apt-conf;"
7058 #. type: <title></title>
7060 msgid "APT User's Guide"
7063 #. type: <author></author>
7064 #: guide.sgml:6 offline.sgml:6
7065 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
7068 #. type: <version></version>
7070 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
7073 #. type: <abstract></abstract>
7076 "This document provides an overview of how to use the the APT package "
7080 #. type: <copyrightsummary></copyrightsummary>
7082 msgid "Copyright © Jason Gunthorpe, 1998."
7086 #: guide.sgml:21 offline.sgml:22
7088 "\"APT\" and this document are free software; you can redistribute them "
7089 "and/or modify them under the terms of the GNU General Public License as "
7090 "published by the Free Software Foundation; either version 2 of the License, "
7091 "or (at your option) any later version."
7095 #: guide.sgml:24 offline.sgml:25
7097 "For more details, on Debian GNU/Linux systems, see the file "
7098 "/usr/share/common-licenses/GPL for the full license."
7101 #. type: <heading></heading>
7109 "The APT package currently contains two sections, the APT "
7110 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
7111 "interface. Both provide a way to install and remove packages as well as "
7112 "download new packages from the Internet."
7115 #. type: <heading></heading>
7117 msgid "Anatomy of the Package System"
7123 "The Debian packaging system has a large amount of information associated "
7124 "with each package to help assure that it integrates cleanly and easily into "
7125 "the system. The most prominent of its features is the dependency system."
7131 "The dependency system allows individual programs to make use of shared "
7132 "elements in the system such as libraries. It simplifies placing infrequently "
7133 "used portions of a program in separate packages to reduce the number of "
7134 "things the average user is required to install. Also, it allows for choices "
7135 "in mail transport agents, X servers and so on."
7141 "The first step to understanding the dependency system is to grasp the "
7142 "concept of a simple dependency. The meaning of a simple dependency is that a "
7143 "package requires another package to be installed at the same time to work "
7150 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
7151 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
7152 "simple dependency on GPG. Also, because it is an emacs extension it has a "
7153 "simple dependency on emacs, without emacs it is completely useless."
7159 "The other important dependency to understand is a conflicting dependency. It "
7160 "means that a package, when installed with another package, will not work and "
7161 "may possibly be extremely harmful to the system. As an example consider a "
7162 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
7163 "have two mail transport agents installed because both need to listen to the "
7164 "network to receive mail. Attempting to install two will seriously damage the "
7165 "system so all mail transport agents have a conflicting dependency with all "
7166 "other mail transport agents."
7172 "As an added complication there is the possibility for a package to pretend "
7173 "to be another package. Consider that exim and sendmail for many intents are "
7174 "identical, they both deliver mail and understand a common interface. Hence, "
7175 "the package system has a way for them to declare that they are both "
7176 "mail-transport-agents. So, exim and sendmail both declare that they provide "
7177 "a mail-transport-agent and other packages that need a mail transport agent "
7178 "depend on mail-transport-agent. This can add a great deal of confusion when "
7179 "trying to manually fix packages."
7185 "At any given time a single dependency may be met by packages that are "
7186 "already installed or it may not be. APT attempts to help resolve dependency "
7187 "issues by providing a number of automatic algorithms that help in selecting "
7188 "packages for installation."
7194 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
7195 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
7196 "understand .deb files, it works with the package's proper name and can only "
7197 "install .deb archives from a <em>Source</em>."
7203 "The first <footnote><p>If you are using an http proxy server you must set "
7204 "the http_proxy environment variable first, see "
7205 "sources.list(5)</p></footnote> thing that should be done before using "
7206 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
7207 "so that it knows what packages are available. This is done with <tt>apt-get "
7208 "update</tt>. For instance,"
7211 #. type: <example></example>
7215 "# apt-get update\n"
7216 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
7217 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7218 "Reading Package Lists... Done\n"
7219 "Building Dependency Tree... Done"
7222 #. type: <p><taglist>
7224 msgid "Once updated there are several commands that can be used:"
7230 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
7231 "install a new package or remove an existing package, nor will it ever "
7232 "upgrade a package that might cause some other package to break. This can be "
7233 "used daily to relatively safely upgrade the system. Upgrade will list all of "
7234 "the packages that it could not upgrade, this usually means that they depend "
7235 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
7236 "<tt>apt-get install</tt> can be used to force these packages to install."
7242 "Install is used to install packages by name. The package is automatically "
7243 "fetched and installed. This can be useful if you already know the name of "
7244 "the package to install and do not want to go into a GUI to select it. Any "
7245 "number of packages may be passed to install, they will all be "
7246 "fetched. Install automatically attempts to resolve dependency problems with "
7247 "the listed packages and will print a summary and ask for confirmation if "
7248 "anything other than its arguments are changed."
7254 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
7255 "releases of Debian. It uses a sophisticated algorithm to determine the best "
7256 "set of packages to install, upgrade and remove to get as much of the system "
7257 "to the newest release. In some situations it may be desired to use "
7258 "dist-upgrade rather than spend the time manually resolving dependencies in "
7259 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
7260 "<prgn>dselect</prgn> can be used to install any packages that may have been "
7267 "It is important to closely look at what dist-upgrade is going to do, its "
7268 "decisions may sometimes be quite surprising."
7274 "<prgn>apt-get</prgn> has several command line options that are detailed in "
7275 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
7276 "option is <tt>-d</tt> which does not install the fetched files. If the "
7277 "system has to download a large number of package it would be undesired to "
7278 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
7279 "the downloaded archives can be installed by simply running the command that "
7280 "caused them to be downloaded again without <tt>-d</tt>."
7283 #. type: <heading></heading>
7291 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
7292 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
7293 "to select the packages to be installed or removed and APT actually installs "
7300 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
7301 "and then choose the APT method. You will be prompted for a set of "
7302 "<em>Sources</em> which are places to fetch archives from. These can be "
7303 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
7304 "provide a fragment of the total Debian archive, APT will automatically "
7305 "combine them to form a complete set of packages. If you have a CDROM then it "
7306 "is a good idea to specify it first and then specify a mirror so that you "
7307 "have access to the latest bug fixes. APT will automatically use packages on "
7308 "your CDROM before downloading from the Internet."
7311 #. type: <example></example>
7315 " Set up a list of distribution source locations\n"
7317 " Please give the base URL of the debian distribution.\n"
7318 " The access schemes I know about are: http file\n"
7321 " file:/mnt/debian,\n"
7322 " ftp://ftp.debian.org/debian,\n"
7323 " http://ftp.de.debian.org/debian,\n"
7326 " URL [http://llug.sep.bnl.gov/debian]:"
7332 "The <em>Sources</em> setup starts by asking for the base of the Debian "
7333 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
7337 #. type: <example></example>
7341 " Please give the distribution tag to get or a path to the\n"
7342 " package file ending in a /. The distribution\n"
7343 " tags are typically something like: stable unstable testing non-US\n"
7345 " Distribution [stable]:"
7351 "The distribution refers to the Debian version in the archive, "
7352 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
7353 "refers to the developmental version. <em>non-US</em> is only available on "
7354 "some mirrors and refers to packages that contain encryption technology or "
7355 "other things that cannot be exported from the United States. Importing these "
7356 "packages into the US is legal however."
7359 #. type: <example></example>
7363 " Please give the components to get\n"
7364 " The components are typically something like: main contrib non-free\n"
7366 " Components [main contrib non-free]:"
7372 "The components list refers to the list of sub distributions to fetch. The "
7373 "distribution is split up based on software licenses, main being DFSG free "
7374 "packages while contrib and non-free contain things that have various "
7375 "restrictions placed on their use and distribution."
7381 "Any number of sources can be added, the setup script will continue to prompt "
7382 "until you have specified all that you want."
7388 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
7389 "available list by selecting [U]pdate from the menu. This is a superset of "
7390 "<tt>apt-get update</tt> that makes the fetched information available to "
7391 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
7392 "update</tt> has been run before."
7398 "You can then go on and make your selections using [S]elect and then perform "
7399 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7400 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7407 "By default APT will automatically remove the package (.deb) files once they "
7408 "have been successfully installed. To change this behavior place "
7409 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
7412 #. type: <heading></heading>
7414 msgid "The Interface"
7420 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
7421 "same interface. It is a simple system that generally tells you what it will "
7422 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
7423 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
7424 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
7425 "alone.</p></footnote> After printing out a summary of what will happen APT "
7426 "then will print out some informative status messages so that you can "
7427 "estimate how far along it is and how much is left to do."
7430 #. type: <heading></heading>
7438 "Before all operations except update, APT performs a number of actions to "
7439 "prepare its internal state. It also does some checks of the system's "
7440 "state. At any time these operations can be performed by running <tt>apt-get "
7444 #. type: <example></example>
7449 "Reading Package Lists... Done\n"
7450 "Building Dependency Tree... Done"
7456 "The first thing it does is read all the package files into memory. APT uses "
7457 "a caching scheme so this operation will be faster the second time it is "
7458 "run. If some of the package files are not found then they will be ignored "
7459 "and a warning will be printed when apt-get exits."
7465 "The final operation performs a detailed analysis of the system's "
7466 "dependencies. It checks every dependency of every installed or unpacked "
7467 "package and considers if it is OK. Should this find a problem then a report "
7468 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
7471 #. type: <example></example>
7476 "Reading Package Lists... Done\n"
7477 "Building Dependency Tree... Done\n"
7478 "You might want to run apt-get -f install' to correct these.\n"
7479 "Sorry, but the following packages have unmet dependencies:\n"
7480 " 9fonts: Depends: xlib6g but it is not installed\n"
7481 " uucp: Depends: mailx but it is not installed\n"
7482 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7483 " adduser: Depends: perl-base but it is not installed\n"
7484 " aumix: Depends: libgpmg1 but it is not installed\n"
7485 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7486 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7487 " cthugha: Depends: svgalibg1 but it is not installed\n"
7488 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7489 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
7495 "In this example the system has many problems, including a serious problem "
7496 "with libreadlineg2. For each package that has unmet dependencies a line is "
7497 "printed out indicating the package with the problem and the dependencies "
7498 "that are unmet. A short explanation of why the package has a dependency "
7499 "problem is also included."
7505 "There are two ways a system can get into a broken state like this. The first "
7506 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
7507 "packages when performing upgrades. <footnote><p>APT however considers all "
7508 "known dependencies and attempts to prevent broken "
7509 "packages</p></footnote>. The second is if a package installation fails "
7510 "during an operation. In this situation a package may have been unpacked "
7511 "without its dependents being installed."
7517 "The second situation is much less serious than the first because APT places "
7518 "certain constraints on the order that packages are installed. In both cases "
7519 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
7520 "deduce a possible solution to the problem and then continue on. The APT "
7521 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
7522 "for easy continuation of failed maintainer scripts."
7528 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
7529 "system caused by the first case then it is possible that it will either fail "
7530 "immediately or the installation sequence will fail. In either case it is "
7531 "necessary to manually use dpkg (possibly with forcing options) to correct "
7532 "the situation enough to allow APT to proceed."
7535 #. type: <heading></heading>
7537 msgid "The Status Report"
7543 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
7544 "happen. Generally the report reflects the type of operation being performed "
7545 "but there are several common elements. In all cases the lists reflect the "
7546 "final state of things, taking into account the <tt>-f</tt> option and any "
7547 "other relevant activities to the command being executed."
7550 #. type: <heading></heading>
7552 msgid "The Extra Package list"
7555 #. type: <example></example>
7559 "The following extra packages will be installed:\n"
7560 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7561 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7562 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7563 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7570 "The Extra Package list shows all of the packages that will be installed or "
7571 "upgraded in excess of the ones mentioned on the command line. It is only "
7572 "generated for an <tt>install</tt> command. The listed packages are often the "
7573 "result of an Auto Install."
7576 #. type: <heading></heading>
7578 msgid "The Packages to Remove"
7581 #. type: <example></example>
7585 "The following packages will be REMOVED:\n"
7586 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7587 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7588 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7595 "The Packages to Remove list shows all of the packages that will be removed "
7596 "from the system. It can be shown for any of the operations and should be "
7597 "given a careful inspection to ensure nothing important is to be taken "
7598 "off. The <tt>-f</tt> option is especially good at generating packages to "
7599 "remove so extreme care should be used in that case. The list may contain "
7600 "packages that are going to be removed because they are only partially "
7601 "installed, possibly due to an aborted installation."
7604 #. type: <heading></heading>
7606 msgid "The New Packages list"
7609 #. type: <example></example>
7613 "The following NEW packages will installed:\n"
7614 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
7620 "The New Packages list is simply a reminder of what will happen. The packages "
7621 "listed are not presently installed in the system but will be when APT is "
7625 #. type: <heading></heading>
7627 msgid "The Kept Back list"
7630 #. type: <example></example>
7634 "The following packages have been kept back\n"
7635 " compface man-db tetex-base msql libpaper svgalib1\n"
7636 " gs snmp arena lynx xpat2 groff xscreensaver"
7642 "Whenever the whole system is being upgraded there is the possibility that "
7643 "new versions of packages cannot be installed because they require new things "
7644 "or conflict with already installed things. In this case the package will "
7645 "appear in the Kept Back list. The best way to convince packages listed there "
7646 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
7647 "to resolve their problems."
7650 #. type: <heading></heading>
7652 msgid "Held Packages warning"
7655 #. type: <example></example>
7659 "The following held packages will be changed:\n"
7666 "Sometimes you can ask APT to install a package that is on hold, in such a "
7667 "case it prints out a warning that the held package is going to be "
7668 "changed. This should only happen during dist-upgrade or install."
7671 #. type: <heading></heading>
7673 msgid "Final summary"
7678 msgid "Finally, APT will print out a summary of all the changes that will occur."
7681 #. type: <example></example>
7685 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7687 "12 packages not fully installed or removed.\n"
7688 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
7694 "The first line of the summary simply is a reduced version of all of the "
7695 "lists and includes the number of upgrades - that is packages already "
7696 "installed that have new versions available. The second line indicates the "
7697 "number of poorly configured packages, possibly the result of an aborted "
7698 "installation. The final line shows the space requirements that the "
7699 "installation needs. The first pair of numbers refer to the size of the "
7700 "archive files. The first number indicates the number of bytes that must be "
7701 "fetched from remote locations and the second indicates the total size of all "
7702 "the archives required. The next number indicates the size difference between "
7703 "the presently installed packages and the newly installed packages. It is "
7704 "roughly equivalent to the space required in /usr after everything is "
7705 "done. If a large number of packages are being removed then the value may "
7706 "indicate the amount of space that will be freed."
7712 "Some other reports can be generated by using the -u option to show packages "
7713 "to upgrade, they are similar to the previous examples."
7716 #. type: <heading></heading>
7718 msgid "The Status Display"
7724 "During the download of archives and package files APT prints out a series of "
7728 #. type: <example></example>
7732 "# apt-get update\n"
7733 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7734 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7735 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7736 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7738 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7739 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
7745 "The lines starting with <em>Get</em> are printed out when APT begins to "
7746 "fetch a file while the last line indicates the progress of the download. The "
7747 "first percent value on the progress line indicates the total percent done of "
7748 "all files. Unfortunately since the size of the Package files is unknown "
7749 "<tt>apt-get update</tt> estimates the percent done which causes some "
7756 "The next section of the status line is repeated once for each download "
7757 "thread and indicates the operation being performed and some useful "
7758 "information about what is happening. Sometimes this section will simply read "
7759 "<em>Forking</em> which means the OS is loading the download module. The "
7760 "first word after the [ is the fetch number as shown on the history "
7761 "lines. The next word is the short form name of the object being "
7762 "downloaded. For archives it will contain the name of the package that is "
7769 "Inside of the single quote is an informative string indicating the progress "
7770 "of the negotiation phase of the download. Typically it progresses from "
7771 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
7772 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
7773 "the remote site. Once the download begins this is represented as "
7774 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
7775 "kilobytes is expected. The total size is always shown in 4 figure notation "
7776 "to preserve space. After the size display is a percent meter for the file "
7777 "itself. The second last element is the instantaneous average speed. This "
7778 "values is updated every 5 seconds and reflects the rate of data transfer for "
7779 "that period. Finally is shown the estimated transfer time. This is updated "
7780 "regularly and reflects the time to complete everything at the shown transfer "
7787 "The status display updates every half second to provide a constant feedback "
7788 "on the download progress while the Get lines scroll back whenever a new file "
7789 "is started. Since the status display is constantly updated it is unsuitable "
7790 "for logging to a file, use the <tt>-q</tt> option to remove the status "
7794 #. type: <heading></heading>
7802 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
7803 "to the <prgn>dpkg</prgn> interface once downloading is "
7804 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
7805 "processes the packages and the packages themselves may also ask several "
7806 "questions. Before each question there is usually a description of what it is "
7807 "asking and the questions are too varied to discuss completely here."
7810 #. type: <title></title>
7812 msgid "Using APT Offline"
7815 #. type: <version></version>
7817 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
7820 #. type: <abstract></abstract>
7823 "This document describes how to use APT in a non-networked environment, "
7824 "specifically a 'sneaker-net' approach for performing upgrades."
7827 #. type: <copyrightsummary></copyrightsummary>
7829 msgid "Copyright © Jason Gunthorpe, 1999."
7832 #. type: <heading></heading>
7834 msgid "Introduction"
7837 #. type: <heading></heading>
7838 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
7845 "Normally APT requires direct access to a Debian archive, either from a local "
7846 "media or through a network. Another common complaint is that a Debian "
7847 "machine is on a slow link, such as a modem and another machine has a very "
7848 "fast connection but they are physically distant."
7854 "The solution to this is to use large removable media such as a Zip disc or a "
7855 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7856 "archive but can easily fit a subset large enough for most users. The idea is "
7857 "to use APT to generate a list of packages that are required and then fetch "
7858 "them onto the disc using another machine with good connectivity. It is even "
7859 "possible to use another Debian machine with APT or to use a completely "
7860 "different OS and a download tool like wget. Let <em>remote host</em> mean "
7861 "the machine downloading the packages, and <em>target host</em> the one with "
7862 "bad or no connection."
7868 "This is achieved by creatively manipulating the APT configuration file. The "
7869 "essential premise to tell APT to look on a disc for it's archive files. Note "
7870 "that the disc should be formated with a filesystem that can handle long file "
7871 "names such as ext2, fat32 or vfat."
7874 #. type: <heading></heading>
7876 msgid "Using APT on both machines"
7879 #. type: <p><example>
7882 "APT being available on both machines gives the simplest configuration. The "
7883 "basic idea is to place a copy of the status file on the disc and use the "
7884 "remote machine to fetch the latest package files and decide which packages "
7885 "to download. The disk directory structure should look like:"
7888 #. type: <example></example>
7902 #. type: <heading></heading>
7904 msgid "The configuration file"
7910 "The configuration file should tell APT to store its files on the disc and to "
7911 "use the configuration files on the disc as well. The sources.list should "
7912 "contain the proper sites that you wish to use from the remote machine, and "
7913 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
7914 "<em>target host</em>. Please note, if you are using a local archive you must "
7915 "use copy URIs, the syntax is identical to file URIs."
7918 #. type: <p><example>
7921 "<em>apt.conf</em> must contain the necessary information to make APT use the "
7925 #. type: <example></example>
7931 " /* This is not necessary if the two machines are the same arch, it "
7933 " the remote APT what architecture the target machine is */\n"
7934 " Architecture \"i386\";\n"
7936 " Get::Download-Only \"true\";\n"
7941 " /* Use the disc for state information and redirect the status file from\n"
7942 " the /var/lib/dpkg default */\n"
7943 " State \"/disc/\";\n"
7944 " State::status \"status\";\n"
7946 " // Binary caches will be stored locally\n"
7947 " Cache::archives \"/disc/archives/\";\n"
7948 " Cache \"/tmp/\";\n"
7950 " // Location of the source list.\n"
7951 " Etc \"/disc/\";\n"
7955 #. type: </example></p>
7958 "More details can be seen by examining the apt.conf man page and the sample "
7959 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
7962 #. type: <p><example>
7965 "On the target machine the first thing to do is mount the disc and copy "
7966 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
7967 "directories outlined in the Overview, <em>archives/partial/</em> and "
7968 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
7969 "configure the sources.list. On the remote machine execute the following:"
7972 #. type: <example></example>
7976 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7977 " # apt-get update\n"
7978 " [ APT fetches the package files ]\n"
7979 " # apt-get dist-upgrade\n"
7980 " [ APT fetches all the packages needed to upgrade the target machine ]"
7983 #. type: </example></p>
7986 "The dist-upgrade command can be replaced with any other standard APT "
7987 "commands, particularly dselect-upgrade. You can even use an APT front end "
7988 "such as <em>dselect</em>. However this presents a problem in communicating "
7989 "your selections back to the local computer."
7992 #. type: <p><example>
7995 "Now the disc contains all of the index files and archives needed to upgrade "
7996 "the target machine. Take the disc back and run:"
7999 #. type: <example></example>
8003 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8004 " # apt-get check\n"
8005 " [ APT generates a local copy of the cache files ]\n"
8006 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
8007 " [ Or any other APT command ]"
8013 "It is necessary for proper function to re-specify the status file to be the "
8014 "local one. This is very important!"
8020 "If you are using dselect you can do the very risky operation of copying "
8021 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
8022 "remote machine are updated. I highly recommend that people only make "
8023 "selections on the local machine - but this may not always be possible. DO "
8024 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
8027 #. type: <heading></heading>
8029 msgid "Using APT and wget"
8035 "<em>wget</em> is a popular and portable download tool that can run on nearly "
8036 "any machine. Unlike the method above this requires that the Debian machine "
8037 "already has a list of available packages."
8043 "The basic idea is to create a disc that has only the archive files "
8044 "downloaded from the remote site. This is done by using the --print-uris "
8045 "option to apt-get and then preparing a wget script to actually fetch the "
8049 #. type: <heading></heading>
8054 #. type: <p><example>
8057 "Unlike the previous technique no special configuration files are "
8058 "required. We merely use the standard APT commands to generate the file list."
8061 #. type: <example></example>
8065 " # apt-get dist-upgrade \n"
8066 " [ Press no when prompted, make sure you are happy with the actions ]\n"
8067 " # apt-get -qq --print-uris dist-upgrade > uris\n"
8068 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
8071 #. type: </example></p>
8074 "Any command other than dist-upgrade could be used here, including "
8081 "The /disc/wget-script file will now contain a list of wget commands to "
8082 "execute in order to fetch the necessary archives. This script should be run "
8083 "with the current directory as the disc's mount point so as to save the "
8084 "output on the disc."
8087 #. type: <p><example>
8089 msgid "The remote machine would do something like"
8092 #. type: <example></example>
8097 " # sh -x ./wget-script\n"
8101 #. type: </example><example>
8104 "Once the archives are downloaded and the disc returned to the Debian machine "
8105 "installation can proceed using,"
8108 #. type: <example></example>
8111 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
8114 #. type: </example></p>
8116 msgid "Which will use the already fetched archives on the disc."