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-04-05 10:22+0300\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
34 msgid "Debian GNU/Linux"
45 msgid "apt - Advanced Package Tool"
68 "APT is a management system for software packages. For normal day to day "
69 "package management there are several frontends available, such as "
70 "B<aptitude>(8) for the command line or B<synaptic>(8) for the X Window "
71 "System. Some options are only implemented in B<apt-get>(8) though."
83 "B<apt-cache>(8), B<apt-get>(8), B<apt.conf>(5), B<sources.list>(5), "
84 "B<apt_preferences>(5), B<apt-secure>(8)"
95 msgid "apt returns zero on normal operation, decimal 100 on error."
106 msgid "This manpage isn't even started."
112 "See E<lt>http://bugs.debian.org/aptE<gt>. If you wish to report a bug in "
113 "B<apt>, please see I</usr/share/doc/debian/bug-reporting.txt> or the "
114 "B<reportbug>(1) command."
125 msgid "apt was written by the APT team E<lt>apt@packages.debian.orgE<gt>."
130 msgid "<!-- -*- mode: sgml; mode: fold -*- -->"
137 "<!-- Boiler plate docinfo section -->\n"
138 "<!ENTITY apt-docinfo \"\n"
140 " <address><email>apt@packages.debian.org</email></address>\n"
142 " <firstname>Jason</firstname> <surname>Gunthorpe</surname>\n"
143 " <contrib></contrib>\n"
145 " <copyright><year>1998-2001</year> <holder>Jason "
146 "Gunthorpe</holder></copyright>\n"
147 " <date>28 October 2008</date>\n"
148 " <productname>Linux</productname>\n"
157 "<!ENTITY apt-author.team \"\n"
159 " <othername>APT team</othername>\n"
160 " <contrib></contrib>\n"
169 "<!ENTITY apt-qapage \"\n"
171 "\t\t<ulink url='http://packages.qa.debian.org/a/apt.html'>QA Page</ulink>\n"
180 "<!-- Boiler plate Bug reporting section -->\n"
181 "<!ENTITY manbugs \"\n"
182 " <refsect1><title>Bugs</title>\n"
183 " <para><ulink url='http://bugs.debian.org/src:apt'>APT bug page</ulink>.\n"
184 " If you wish to report a bug in APT, please see\n"
185 " <filename>/usr/share/doc/debian/bug-reporting.txt</filename> or the\n"
186 " &reportbug; command.\n"
196 "<!-- Boiler plate Author section -->\n"
197 "<!ENTITY manauthor \"\n"
198 " <refsect1><title>Author</title>\n"
199 " <para>APT was written by the APT team "
200 "<email>apt@packages.debian.org</email>.\n"
210 "<!-- Should be used within the option section of the text to\n"
211 " put in the blurb about -h, -v, -c and -o -->\n"
212 "<!ENTITY apt-commonoptions \"\n"
213 " <varlistentry><term><option>-h</option></term>\n"
214 " <term><option>--help</option></term>\n"
215 " <listitem><para>Show a short usage summary.\n"
226 " <term><option>-v</option></term>\n"
227 " <term><option>--version</option></term>\n"
228 " <listitem><para>Show the program version.\n"
239 " <term><option>-c</option></term>\n"
240 " <term><option>--config-file</option></term>\n"
241 " <listitem><para>Configuration File; Specify a configuration file to "
243 " The program will read the default configuration file and then this \n"
244 " configuration file. If configuration settings need to be set before "
246 " default configuration files are parsed specify a file with the "
247 "<envar>APT_CONFIG</envar>\n"
248 " environment variable. See &apt-conf; for syntax information.\n"
259 " <term><option>-o</option></term>\n"
260 " <term><option>--option</option></term>\n"
261 " <listitem><para>Set a Configuration Option; This will set an "
263 " configuration option. The syntax is <option>-o "
264 "Foo::Bar=bar</option>.\n"
265 " <option>-o</option> and <option>--option</option> can be used "
267 " times to set different options.\n"
278 "<!-- Should be used within the option section of the text to\n"
279 " put in the blurb about -h, -v, -c and -o -->\n"
280 "<!ENTITY apt-cmdblurb \"\n"
281 " <para>All command line options may be set using the configuration file, "
283 " descriptions indicate the configuration option to set. For boolean\n"
284 " options you can override the config file by using something like \n"
285 " <option>-f-</option>,<option>--no-f</option>, <option>-f=no</option>\n"
286 " or several other variations.\n"
295 "<!ENTITY file-aptconf \"\n"
296 " <varlistentry><term><filename>/etc/apt/apt.conf</filename></term>\n"
297 " <listitem><para>APT configuration file.\n"
298 " Configuration Item: "
299 "<literal>Dir::Etc::Main</literal>.</para></listitem>\n"
307 " <varlistentry><term><filename>/etc/apt/apt.conf.d/</filename></term>\n"
308 " <listitem><para>APT configuration file fragments.\n"
309 " Configuration Item: "
310 "<literal>Dir::Etc::Parts</literal>.</para></listitem>\n"
319 "<!ENTITY file-cachearchives \"\n"
320 " <varlistentry><term><filename>&cachedir;/archives/</filename></term>\n"
321 " <listitem><para>Storage area for retrieved package files.\n"
322 " Configuration Item: "
323 "<literal>Dir::Cache::Archives</literal>.</para></listitem>\n"
332 "<varlistentry><term><filename>&cachedir;/archives/partial/</filename></term>\n"
333 " <listitem><para>Storage area for package files in transit.\n"
334 " Configuration Item: <literal>Dir::Cache::Archives</literal> (implicit "
335 "partial). </para></listitem>\n"
344 "<!ENTITY file-preferences \"\n"
345 " <varlistentry><term><filename>/etc/apt/preferences</filename></term>\n"
346 " <listitem><para>Version preferences file.\n"
347 " This is where you would specify "pinning",\n"
348 " i.e. a preference to get certain packages\n"
349 " from a separate source\n"
350 " or from a different version of a distribution.\n"
351 " Configuration Item: "
352 "<literal>Dir::Etc::Preferences</literal>.</para></listitem>\n"
361 "<varlistentry><term><filename>/etc/apt/preferences.d/</filename></term>\n"
362 " <listitem><para>File fragments for the version preferences.\n"
363 " Configuration Item: "
364 "<literal>Dir::Etc::PreferencesParts</literal>.</para></listitem>\n"
373 "<!ENTITY file-sourceslist \"\n"
374 " <varlistentry><term><filename>/etc/apt/sources.list</filename></term>\n"
375 " <listitem><para>Locations to fetch packages from.\n"
376 " Configuration Item: "
377 "<literal>Dir::Etc::SourceList</literal>.</para></listitem>\n"
386 "<varlistentry><term><filename>/etc/apt/sources.list.d/</filename></term>\n"
387 " <listitem><para>File fragments for locations to fetch packages from.\n"
388 " Configuration Item: "
389 "<literal>Dir::Etc::SourceParts</literal>.</para></listitem>\n"
398 "<!ENTITY file-statelists \"\n"
399 " <varlistentry><term><filename>&statedir;/lists/</filename></term>\n"
400 " <listitem><para>Storage area for state information for each package "
401 "resource specified in\n"
403 " Configuration Item: "
404 "<literal>Dir::State::Lists</literal>.</para></listitem>\n"
413 "<varlistentry><term><filename>&statedir;/lists/partial/</filename></term>\n"
414 " <listitem><para>Storage area for state information in transit.\n"
415 " Configuration Item: <literal>Dir::State::Lists</literal> (implicit "
416 "partial).</para></listitem>\n"
425 "<!ENTITY file-trustedgpg \"\n"
426 " <varlistentry><term><filename>/etc/apt/trusted.gpg</filename></term>\n"
427 " <listitem><para>Keyring of local trusted keys, new keys will be added "
429 " Configuration Item: "
430 "<literal>Dir::Etc::Trusted</literal>.</para></listitem>\n"
439 "<varlistentry><term><filename>/etc/apt/trusted.gpg.d/</filename></term>\n"
440 " <listitem><para>File fragments for the trusted keys, additional "
442 " be stored here (by other packages or the administrator).\n"
443 " Configuration Item "
444 "<literal>Dir::Etc::TrustedParts</literal>.</para></listitem>\n"
453 "<!ENTITY file-extended_states \"\n"
455 "<varlistentry><term><filename>/var/lib/apt/extended_states</filename></term>\n"
456 " <listitem><para>Status list of auto-installed packages.\n"
457 " Configuration Item: <literal>Dir::State::extended_states</literal>.\n"
458 " </para></listitem>\n"
467 "<!-- TRANSLATOR: This is the section header for the following paragraphs - "
469 " to the other headers like NAME and DESCRIPTION and should therefore be "
471 "<!ENTITY translation-title \"TRANSLATION\">\n"
478 "<!-- TRANSLATOR: This is a placeholder. You should write here who has "
480 " to the translation in the past, who is responsible now and maybe "
481 "further information\n"
482 " specially related to your translation. -->\n"
483 "<!ENTITY translation-holder \"\n"
484 " The english translation was done by John Doe "
485 "<email>john@doe.org</email> in 2009,\n"
486 " 2010 and Daniela Acme <email>daniela@acme.us</email> in 2010 together "
488 " Debian Dummy l10n Team "
489 "<email>debian-l10n-dummy@lists.debian.org</email>.\n"
497 "<!-- TRANSLATOR: As a translation is allowed to have 20% of "
498 "untranslated/fuzzy strings\n"
499 " in a shipped manpage newer/modified paragraphs will maybe appear in "
501 " the generated manpage. This sentence is therefore here to tell the "
503 " is not a mistake by the translator - obviously the target is that at "
505 " releases this sentence is not needed. :) -->\n"
506 "<!ENTITY translation-english \"\n"
507 " Note that this translated document may contain untranslated parts.\n"
508 " This is done on purpose, to avoid losing content when the\n"
509 " translation is lagging behind the original content.\n"
513 #. The last update date
514 #. type: Content of: <refentry><refentryinfo>
515 #: apt-cache.8.xml:16
517 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>04 "
518 "February 2011</date>"
521 #. type: Content of: <refentry><refnamediv><refname>
522 #: apt-cache.8.xml:25 apt-cache.8.xml:32
526 #. type: Content of: <refentry><refmeta><manvolnum>
527 #: 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
531 #. type: Content of: <refentry><refmeta><refmiscinfo>
532 #: 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
536 #. type: Content of: <refentry><refnamediv><refpurpose>
537 #: apt-cache.8.xml:33
538 msgid "query the APT cache"
541 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
542 #: apt-cache.8.xml:39
544 "<command>apt-cache</command> <arg><option>-hvsn</option></arg> "
545 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
546 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
547 "choice=\"req\"> <arg>gencaches</arg> <arg>showpkg <arg choice=\"plain\" "
548 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>showsrc <arg "
549 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
550 "<arg>stats</arg> <arg>dump</arg> <arg>dumpavail</arg> <arg>unmet</arg> "
552 "choice=\"plain\"><replaceable>regex</replaceable></arg></arg> <arg>show <arg "
553 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
554 "<arg>depends <arg choice=\"plain\" "
555 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>rdepends <arg "
556 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
557 "<arg>pkgnames <arg "
558 "choice=\"plain\"><replaceable>prefix</replaceable></arg></arg> <arg>dotty "
559 "<arg choice=\"plain\" "
560 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg>xvcg <arg "
561 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
562 "<arg>policy <arg choice=\"plain\" "
563 "rep=\"repeat\"><replaceable>pkgs</replaceable></arg></arg> <arg>madison <arg "
564 "choice=\"plain\" rep=\"repeat\"><replaceable>pkgs</replaceable></arg></arg> "
568 #. type: Content of: <refentry><refsect1><title>
569 #: 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
573 #. type: Content of: <refentry><refsect1><para>
574 #: apt-cache.8.xml:65
576 "<command>apt-cache</command> performs a variety of operations on APT's "
577 "package cache. <command>apt-cache</command> does not manipulate the state of "
578 "the system but does provide operations to search and generate interesting "
579 "output from the package metadata."
582 #. type: Content of: <refentry><refsect1><para>
583 #: apt-cache.8.xml:70 apt-get.8.xml:120
585 "Unless the <option>-h</option>, or <option>--help</option> option is given, "
586 "one of the commands below must be present."
589 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
590 #: apt-cache.8.xml:74
594 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
595 #: apt-cache.8.xml:75
597 "<literal>gencaches</literal> performs the same operation as <command>apt-get "
598 "check</command>. It builds the source and package caches from the sources in "
599 "&sources-list; and from <filename>/var/lib/dpkg/status</filename>."
602 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
603 #: apt-cache.8.xml:81
604 msgid "showpkg <replaceable>pkg(s)</replaceable>"
607 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
608 #: apt-cache.8.xml:82
610 "<literal>showpkg</literal> displays information about the packages listed on "
611 "the command line. Remaining arguments are package names. The available "
612 "versions and reverse dependencies of each package listed are listed, as well "
613 "as forward dependencies for each version. Forward (normal) dependencies are "
614 "those packages upon which the package in question depends; reverse "
615 "dependencies are those packages that depend upon the package in "
616 "question. Thus, forward dependencies must be satisfied for a package, but "
617 "reverse dependencies need not be. For instance, <command>apt-cache showpkg "
618 "libreadline2</command> would produce output similar to the following:"
621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
622 #: apt-cache.8.xml:94
625 "Package: libreadline2\n"
626 "Versions: 2.1-12(/var/state/apt/lists/foo_Packages),\n"
627 "Reverse Depends: \n"
628 " libreadlineg2,libreadline2\n"
629 " libreadline2-altdev,libreadline2\n"
631 "2.1-12 - libc5 (2 5.4.0-0) ncurses3.0 (0 (null))\n"
634 "Reverse Provides: \n"
637 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
638 #: apt-cache.8.xml:106
640 "Thus it may be seen that libreadline2, version 2.1-12, depends on libc5 and "
641 "ncurses3.0 which must be installed for libreadline2 to work. In turn, "
642 "libreadlineg2 and libreadline2-altdev depend on libreadline2. If "
643 "libreadline2 is installed, libc5 and ncurses3.0 (and ldso) must also be "
644 "installed; libreadlineg2 and libreadline2-altdev do not have to be "
645 "installed. For the specific meaning of the remainder of the output it is "
646 "best to consult the apt source code."
649 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
650 #: apt-cache.8.xml:115
654 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
655 #: apt-cache.8.xml:115
657 "<literal>stats</literal> displays some statistics about the cache. No "
658 "further arguments are expected. Statistics reported are:"
661 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
662 #: apt-cache.8.xml:118
664 "<literal>Total package names</literal> is the number of package names found "
668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
669 #: apt-cache.8.xml:122
671 "<literal>Normal packages</literal> is the number of regular, ordinary "
672 "package names; these are packages that bear a one-to-one correspondence "
673 "between their names and the names used by other packages for them in "
674 "dependencies. The majority of packages fall into this category."
677 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
678 #: apt-cache.8.xml:128
680 "<literal>Pure virtual packages</literal> is the number of packages that "
681 "exist only as a virtual package name; that is, packages only \"provide\" the "
682 "virtual package name, and no package actually uses the name. For instance, "
683 "\"mail-transport-agent\" in the Debian GNU/Linux system is a pure virtual "
684 "package; several packages provide \"mail-transport-agent\", but there is no "
685 "package named \"mail-transport-agent\"."
688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
689 #: apt-cache.8.xml:136
691 "<literal>Single virtual packages</literal> is the number of packages with "
692 "only one package providing a particular virtual package. For example, in the "
693 "Debian GNU/Linux system, \"X11-text-viewer\" is a virtual package, but only "
694 "one package, xless, provides \"X11-text-viewer\"."
697 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
698 #: apt-cache.8.xml:142
700 "<literal>Mixed virtual packages</literal> is the number of packages that "
701 "either provide a particular virtual package or have the virtual package name "
702 "as the package name. For instance, in the Debian GNU/Linux system, "
703 "\"debconf\" is both an actual package, and provided by the debconf-tiny "
707 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
708 #: apt-cache.8.xml:149
710 "<literal>Missing</literal> is the number of package names that were "
711 "referenced in a dependency but were not provided by any package. Missing "
712 "packages may be an evidence if a full distribution is not accessed, or if a "
713 "package (real or virtual) has been dropped from the distribution. Usually "
714 "they are referenced from Conflicts or Breaks statements."
717 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
718 #: apt-cache.8.xml:156
720 "<literal>Total distinct</literal> versions is the number of package versions "
721 "found in the cache; this value is therefore at least equal to the number of "
722 "total package names. If more than one distribution (both \"stable\" and "
723 "\"unstable\", for instance), is being accessed, this value can be "
724 "considerably larger than the number of total package names."
727 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para><itemizedlist><listitem><para>
728 #: apt-cache.8.xml:163
730 "<literal>Total dependencies</literal> is the number of dependency "
731 "relationships claimed by all of the packages in the cache."
734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
735 #: apt-cache.8.xml:170
736 msgid "showsrc <replaceable>pkg(s)</replaceable>"
739 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
740 #: apt-cache.8.xml:171
742 "<literal>showsrc</literal> displays all the source package records that "
743 "match the given package names. All versions are shown, as well as all "
744 "records that declare the name to be a Binary."
747 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
748 #: apt-cache.8.xml:176 apt-config.8.xml:87
752 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
753 #: apt-cache.8.xml:177
755 "<literal>dump</literal> shows a short listing of every package in the "
756 "cache. It is primarily for debugging."
759 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
760 #: apt-cache.8.xml:181
764 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
765 #: apt-cache.8.xml:182
767 "<literal>dumpavail</literal> prints out an available list to stdout. This is "
768 "suitable for use with &dpkg; and is used by the &dselect; method."
771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
772 #: apt-cache.8.xml:186
776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
777 #: apt-cache.8.xml:187
779 "<literal>unmet</literal> displays a summary of all unmet dependencies in the "
783 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
784 #: apt-cache.8.xml:191
785 msgid "show <replaceable>pkg(s)</replaceable>"
788 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
789 #: apt-cache.8.xml:192
791 "<literal>show</literal> performs a function similar to <command>dpkg "
792 "--print-avail</command>; it displays the package records for the named "
796 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
797 #: apt-cache.8.xml:197
798 msgid "search <replaceable>regex [ regex ... ]</replaceable>"
801 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
802 #: apt-cache.8.xml:198
804 "<literal>search</literal> performs a full text search on all available "
805 "package lists for the POSIX regex pattern given, see "
806 "<citerefentry><refentrytitle><command>regex</command></refentrytitle> "
807 "<manvolnum>7</manvolnum></citerefentry>. It searches the package names and "
808 "the descriptions for an occurrence of the regular expression and prints out "
809 "the package name and the short description, including virtual package "
810 "names. If <option>--full</option> is given then output identical to "
811 "<literal>show</literal> is produced for each matched package, and if "
812 "<option>--names-only</option> is given then the long description is not "
813 "searched, only the package name is."
816 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
817 #: apt-cache.8.xml:211
819 "Separate arguments can be used to specify multiple search patterns that are "
823 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
824 #: apt-cache.8.xml:215
825 msgid "depends <replaceable>pkg(s)</replaceable>"
828 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
829 #: apt-cache.8.xml:216
831 "<literal>depends</literal> shows a listing of each dependency a package has "
832 "and all the possible other packages that can fulfill that dependency."
835 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
836 #: apt-cache.8.xml:220
837 msgid "rdepends <replaceable>pkg(s)</replaceable>"
840 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
841 #: apt-cache.8.xml:221
843 "<literal>rdepends</literal> shows a listing of each reverse dependency a "
847 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
848 #: apt-cache.8.xml:225
849 msgid "pkgnames <replaceable>[ prefix ]</replaceable>"
852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
853 #: apt-cache.8.xml:226
855 "This command prints the name of each package APT knows. The optional "
856 "argument is a prefix match to filter the name list. The output is suitable "
857 "for use in a shell tab complete function and the output is generated "
858 "extremely quickly. This command is best used with the "
859 "<option>--generate</option> option."
862 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
863 #: apt-cache.8.xml:231
865 "Note that a package which APT knows of is not necessarily available to "
866 "download, installable or installed, e.g. virtual packages are also listed in "
867 "the generated list."
870 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
871 #: apt-cache.8.xml:236
872 msgid "dotty <replaceable>pkg(s)</replaceable>"
875 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
876 #: apt-cache.8.xml:237
878 "<literal>dotty</literal> takes a list of packages on the command line and "
879 "generates output suitable for use by dotty from the <ulink "
880 "url=\"http://www.research.att.com/sw/tools/graphviz/\">GraphViz</ulink> "
881 "package. The result will be a set of nodes and edges representing the "
882 "relationships between the packages. By default the given packages will trace "
883 "out all dependent packages; this can produce a very large graph. To limit "
884 "the output to only the packages listed on the command line, set the "
885 "<literal>APT::Cache::GivenOnly</literal> option."
888 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
889 #: apt-cache.8.xml:246
891 "The resulting nodes will have several shapes; normal packages are boxes, "
892 "pure provides are triangles, mixed provides are diamonds, missing packages "
893 "are hexagons. Orange boxes mean recursion was stopped [leaf packages], blue "
894 "lines are pre-depends, green lines are conflicts."
897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
898 #: apt-cache.8.xml:251
899 msgid "Caution, dotty cannot graph larger sets of packages."
902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
903 #: apt-cache.8.xml:254
904 msgid "xvcg <replaceable>pkg(s)</replaceable>"
907 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
908 #: apt-cache.8.xml:255
910 "The same as <literal>dotty</literal>, only for xvcg from the <ulink "
911 "url=\"http://rw4.cs.uni-sb.de/users/sander/html/gsvcg1.html\">VCG "
915 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
916 #: apt-cache.8.xml:259
917 msgid "policy <replaceable>[ pkg(s) ]</replaceable>"
920 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
921 #: apt-cache.8.xml:260
923 "<literal>policy</literal> is meant to help debug issues relating to the "
924 "preferences file. With no arguments it will print out the priorities of each "
925 "source. Otherwise it prints out detailed information about the priority "
926 "selection of the named package."
929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
930 #: apt-cache.8.xml:266
931 msgid "madison <replaceable>[ pkg(s) ]</replaceable>"
934 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
935 #: apt-cache.8.xml:267
937 "<literal>apt-cache</literal>'s <literal>madison</literal> command attempts "
938 "to mimic the output format and a subset of the functionality of the Debian "
939 "archive management tool, <literal>madison</literal>. It displays available "
940 "versions of a package in a tabular format. Unlike the original "
941 "<literal>madison</literal>, it can only display information for the "
942 "architecture for which APT has retrieved package lists "
943 "(<literal>APT::Architecture</literal>)."
946 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
947 #: 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
951 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
952 #: apt-cache.8.xml:282
953 msgid "<option>-p</option>"
956 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
957 #: apt-cache.8.xml:282
958 msgid "<option>--pkg-cache</option>"
961 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
962 #: apt-cache.8.xml:283
964 "Select the file to store the package cache. The package cache is the primary "
965 "cache used by all operations. Configuration Item: "
966 "<literal>Dir::Cache::pkgcache</literal>."
969 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
970 #: apt-cache.8.xml:288 apt-ftparchive.1.xml:571 apt-get.8.xml:393 apt-sortpkgs.1.xml:61
971 msgid "<option>-s</option>"
974 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
975 #: apt-cache.8.xml:288
976 msgid "<option>--src-cache</option>"
979 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
980 #: apt-cache.8.xml:289
982 "Select the file to store the source cache. The source is used only by "
983 "<literal>gencaches</literal> and it stores a parsed version of the package "
984 "information from remote sources. When building the package cache the source "
985 "cache is used to avoid reparsing all of the package files. Configuration "
986 "Item: <literal>Dir::Cache::srcpkgcache</literal>."
989 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
990 #: apt-cache.8.xml:296 apt-ftparchive.1.xml:545 apt-get.8.xml:383
991 msgid "<option>-q</option>"
994 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
995 #: apt-cache.8.xml:296 apt-ftparchive.1.xml:545 apt-get.8.xml:383
996 msgid "<option>--quiet</option>"
999 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1000 #: apt-cache.8.xml:297
1002 "Quiet; produces output suitable for logging, omitting progress indicators. "
1003 "More q's will produce more quietness up to a maximum of 2. You can also use "
1004 "<option>-q=#</option> to set the quietness level, overriding the "
1005 "configuration file. Configuration Item: <literal>quiet</literal>."
1008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1009 #: apt-cache.8.xml:303
1010 msgid "<option>-i</option>"
1013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1014 #: apt-cache.8.xml:303
1015 msgid "<option>--important</option>"
1018 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1019 #: apt-cache.8.xml:304
1021 "Print only important dependencies; for use with unmet and depends. Causes "
1022 "only Depends and Pre-Depends relations to be printed. Configuration Item: "
1023 "<literal>APT::Cache::Important</literal>."
1026 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1027 #: apt-cache.8.xml:309
1028 msgid "<option>--no-pre-depends</option>"
1031 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1032 #: apt-cache.8.xml:310
1033 msgid "<option>--no-depends</option>"
1036 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1037 #: apt-cache.8.xml:311
1038 msgid "<option>--no-recommends</option>"
1041 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1042 #: apt-cache.8.xml:312
1043 msgid "<option>--no-suggests</option>"
1046 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1047 #: apt-cache.8.xml:313
1048 msgid "<option>--no-conflicts</option>"
1051 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1052 #: apt-cache.8.xml:314
1053 msgid "<option>--no-breaks</option>"
1056 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1057 #: apt-cache.8.xml:315
1058 msgid "<option>--no-replaces</option>"
1061 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1062 #: apt-cache.8.xml:316
1063 msgid "<option>--no-enhances</option>"
1066 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1067 #: apt-cache.8.xml:317
1069 "Per default the <literal>depends</literal> and <literal>rdepends</literal> "
1070 "print all dependencies. This can be twicked with these flags which will omit "
1071 "the specified dependency type. Configuration Item: "
1072 "<literal>APT::Cache::Show<replaceable>DependencyType</replaceable></literal> "
1073 "e.g. <literal>APT::Cache::ShowRecommends</literal>."
1076 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1077 #: apt-cache.8.xml:323 apt-cdrom.8.xml:124 apt-get.8.xml:350
1078 msgid "<option>-f</option>"
1081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1082 #: apt-cache.8.xml:323
1083 msgid "<option>--full</option>"
1086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1087 #: apt-cache.8.xml:324
1089 "Print full package records when searching. Configuration Item: "
1090 "<literal>APT::Cache::ShowFull</literal>."
1093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1094 #: apt-cache.8.xml:328 apt-cdrom.8.xml:134 apt-ftparchive.1.xml:583
1095 msgid "<option>-a</option>"
1098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1099 #: apt-cache.8.xml:328
1100 msgid "<option>--all-versions</option>"
1103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1104 #: apt-cache.8.xml:329
1106 "Print full records for all available versions. This is the default; to turn "
1107 "it off, use <option>--no-all-versions</option>. If "
1108 "<option>--no-all-versions</option> is specified, only the candidate version "
1109 "will displayed (the one which would be selected for installation). This "
1110 "option is only applicable to the <literal>show</literal> command. "
1111 "Configuration Item: <literal>APT::Cache::AllVersions</literal>."
1114 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1115 #: apt-cache.8.xml:337
1116 msgid "<option>-g</option>"
1119 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1120 #: apt-cache.8.xml:337
1121 msgid "<option>--generate</option>"
1124 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1125 #: apt-cache.8.xml:338
1127 "Perform automatic package cache regeneration, rather than use the cache as "
1128 "it is. This is the default; to turn it off, use "
1129 "<option>--no-generate</option>. Configuration Item: "
1130 "<literal>APT::Cache::Generate</literal>."
1133 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1134 #: apt-cache.8.xml:343
1135 msgid "<option>--names-only</option>"
1138 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1139 #: apt-cache.8.xml:343 apt-cdrom.8.xml:142
1140 msgid "<option>-n</option>"
1143 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1144 #: apt-cache.8.xml:344
1146 "Only search on the package names, not the long descriptions. Configuration "
1147 "Item: <literal>APT::Cache::NamesOnly</literal>."
1150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1151 #: apt-cache.8.xml:348
1152 msgid "<option>--all-names</option>"
1155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1156 #: apt-cache.8.xml:349
1158 "Make <literal>pkgnames</literal> print all names, including virtual packages "
1159 "and missing dependencies. Configuration Item: "
1160 "<literal>APT::Cache::AllNames</literal>."
1163 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1164 #: apt-cache.8.xml:354
1165 msgid "<option>--recurse</option>"
1168 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1169 #: apt-cache.8.xml:355
1171 "Make <literal>depends</literal> and <literal>rdepends</literal> recursive so "
1172 "that all packages mentioned are printed once. Configuration Item: "
1173 "<literal>APT::Cache::RecurseDepends</literal>."
1176 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1177 #: apt-cache.8.xml:360
1178 msgid "<option>--installed</option>"
1181 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1182 #: apt-cache.8.xml:362
1184 "Limit the output of <literal>depends</literal> and "
1185 "<literal>rdepends</literal> to packages which are currently installed. "
1186 "Configuration Item: <literal>APT::Cache::Installed</literal>."
1189 #. type: Content of: <refentry><refsect1><variablelist>
1190 #: apt-cache.8.xml:367 apt-cdrom.8.xml:153 apt-config.8.xml:101 apt-extracttemplates.1.xml:70 apt-ftparchive.1.xml:611 apt-get.8.xml:570 apt-sortpkgs.1.xml:67
1191 msgid "&apt-commonoptions;"
1194 #. type: Content of: <refentry><refsect1><title>
1195 #: 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:654
1199 #. type: Content of: <refentry><refsect1><variablelist>
1200 #: apt-cache.8.xml:374
1201 msgid "&file-sourceslist; &file-statelists;"
1204 #. type: Content of: <refentry><refsect1><title>
1205 #: apt-cache.8.xml:379 apt-cdrom.8.xml:158 apt-config.8.xml:106 apt-extracttemplates.1.xml:77 apt-ftparchive.1.xml:627 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:661 sources.list.5.xml:234
1209 #. type: Content of: <refentry><refsect1><para>
1210 #: apt-cache.8.xml:380
1211 msgid "&apt-conf;, &sources-list;, &apt-get;"
1214 #. type: Content of: <refentry><refsect1><title>
1215 #: apt-cache.8.xml:384 apt-cdrom.8.xml:163 apt-config.8.xml:111 apt-extracttemplates.1.xml:81 apt-ftparchive.1.xml:631 apt-get.8.xml:591 apt-mark.8.xml:135 apt-sortpkgs.1.xml:76
1219 #. type: Content of: <refentry><refsect1><para>
1220 #: apt-cache.8.xml:385
1222 "<command>apt-cache</command> returns zero on normal operation, decimal 100 "
1226 #. type: Content of: <refentry><refentryinfo>
1227 #: apt-cdrom.8.xml:16
1229 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>14 "
1230 "February 2004</date>"
1233 #. type: Content of: <refentry><refnamediv><refname>
1234 #: apt-cdrom.8.xml:24 apt-cdrom.8.xml:31
1238 #. type: Content of: <refentry><refnamediv><refpurpose>
1239 #: apt-cdrom.8.xml:32
1240 msgid "APT CDROM management utility"
1243 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1244 #: apt-cdrom.8.xml:38
1246 "<command>apt-cdrom</command> <arg><option>-hvrmfan</option></arg> "
1247 "<arg><option>-d=<replaceable>cdrom mount point</replaceable></option></arg> "
1248 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
1249 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group> "
1250 "<arg>add</arg> <arg>ident</arg> </group>"
1253 #. type: Content of: <refentry><refsect1><para>
1254 #: apt-cdrom.8.xml:51
1256 "<command>apt-cdrom</command> is used to add a new CDROM to APTs list of "
1257 "available sources. <command>apt-cdrom</command> takes care of determining "
1258 "the structure of the disc as well as correcting for several possible "
1259 "mis-burns and verifying the index files."
1262 #. type: Content of: <refentry><refsect1><para>
1263 #: apt-cdrom.8.xml:58
1265 "It is necessary to use <command>apt-cdrom</command> to add CDs to the APT "
1266 "system, it cannot be done by hand. Furthermore each disk in a multi-cd set "
1267 "must be inserted and scanned separately to account for possible mis-burns."
1270 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1271 #: apt-cdrom.8.xml:68
1275 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1276 #: apt-cdrom.8.xml:69
1278 "<literal>add</literal> is used to add a new disc to the source list. It will "
1279 "unmount the CDROM device, prompt for a disk to be inserted and then proceed "
1280 "to scan it and copy the index files. If the disc does not have a proper "
1281 "<filename>disk</filename> directory you will be prompted for a descriptive "
1285 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1286 #: apt-cdrom.8.xml:77
1288 "APT uses a CDROM ID to track which disc is currently in the drive and "
1289 "maintains a database of these IDs in "
1290 "<filename>&statedir;/cdroms.list</filename>"
1293 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
1294 #: apt-cdrom.8.xml:84
1298 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
1299 #: apt-cdrom.8.xml:85
1301 "A debugging tool to report the identity of the current disc as well as the "
1305 #. type: Content of: <refentry><refsect1><para>
1306 #: apt-cdrom.8.xml:64
1308 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1309 "one of the commands below must be present. <placeholder "
1310 "type=\"variablelist\" id=\"0\"/>"
1313 #. type: Content of: <refentry><refsect1><title>
1314 #: apt-cdrom.8.xml:94 apt-key.8.xml:142
1318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1319 #: apt-cdrom.8.xml:98 apt-ftparchive.1.xml:539 apt-get.8.xml:345
1320 msgid "<option>-d</option>"
1323 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1324 #: apt-cdrom.8.xml:98
1325 msgid "<option>--cdrom</option>"
1328 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1329 #: apt-cdrom.8.xml:99
1331 "Mount point; specify the location to mount the cdrom. This mount point must "
1332 "be listed in <filename>/etc/fstab</filename> and properly configured. "
1333 "Configuration Item: <literal>Acquire::cdrom::mount</literal>."
1336 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1337 #: apt-cdrom.8.xml:107
1338 msgid "<option>-r</option>"
1341 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1342 #: apt-cdrom.8.xml:107
1343 msgid "<option>--rename</option>"
1346 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1347 #: apt-cdrom.8.xml:108
1349 "Rename a disc; change the label of a disk or override the disks given "
1350 "label. This option will cause <command>apt-cdrom</command> to prompt for a "
1351 "new label. Configuration Item: <literal>APT::CDROM::Rename</literal>."
1354 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1355 #: apt-cdrom.8.xml:116 apt-get.8.xml:364
1356 msgid "<option>-m</option>"
1359 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1360 #: apt-cdrom.8.xml:116
1361 msgid "<option>--no-mount</option>"
1364 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1365 #: apt-cdrom.8.xml:117
1367 "No mounting; prevent <command>apt-cdrom</command> from mounting and "
1368 "unmounting the mount point. Configuration Item: "
1369 "<literal>APT::CDROM::NoMount</literal>."
1372 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1373 #: apt-cdrom.8.xml:124
1374 msgid "<option>--fast</option>"
1377 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1378 #: apt-cdrom.8.xml:125
1380 "Fast Copy; Assume the package files are valid and do not check every "
1381 "package. This option should be used only if <command>apt-cdrom</command> has "
1382 "been run on this disc before and did not detect any errors. Configuration "
1383 "Item: <literal>APT::CDROM::Fast</literal>."
1386 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1387 #: apt-cdrom.8.xml:134
1388 msgid "<option>--thorough</option>"
1391 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1392 #: apt-cdrom.8.xml:135
1394 "Thorough Package Scan; This option may be needed with some old Debian "
1395 "1.1/1.2 discs that have Package files in strange places. It takes much "
1396 "longer to scan the CD but will pick them all up."
1399 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1400 #: apt-cdrom.8.xml:143 apt-get.8.xml:395
1401 msgid "<option>--just-print</option>"
1404 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1405 #: apt-cdrom.8.xml:144 apt-get.8.xml:397
1406 msgid "<option>--recon</option>"
1409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1410 #: apt-cdrom.8.xml:145 apt-get.8.xml:398
1411 msgid "<option>--no-act</option>"
1414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1415 #: apt-cdrom.8.xml:146
1417 "No Changes; Do not change the &sources-list; file and do not write index "
1418 "files. Everything is still checked however. Configuration Item: "
1419 "<literal>APT::CDROM::NoAct</literal>."
1422 #. type: Content of: <refentry><refsect1><para>
1423 #: apt-cdrom.8.xml:159
1424 msgid "&apt-conf;, &apt-get;, &sources-list;"
1427 #. type: Content of: <refentry><refsect1><para>
1428 #: apt-cdrom.8.xml:164
1430 "<command>apt-cdrom</command> returns zero on normal operation, decimal 100 "
1434 #. The last update date
1435 #. type: Content of: <refentry><refentryinfo>
1436 #: apt-config.8.xml:16 apt-extracttemplates.1.xml:16 apt-sortpkgs.1.xml:16 sources.list.5.xml:16
1438 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>29 "
1439 "February 2004</date>"
1442 #. type: Content of: <refentry><refnamediv><refname>
1443 #: apt-config.8.xml:25 apt-config.8.xml:32
1447 #. type: Content of: <refentry><refnamediv><refpurpose>
1448 #: apt-config.8.xml:33
1449 msgid "APT Configuration Query program"
1452 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1453 #: apt-config.8.xml:39
1455 "<command>apt-config</command> <arg><option>-hv</option></arg> "
1456 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
1457 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
1458 "choice=\"req\"> <arg>shell</arg> <arg>dump</arg> </group>"
1461 #. type: Content of: <refentry><refsect1><para>
1462 #: apt-config.8.xml:51
1464 "<command>apt-config</command> is an internal program used by various "
1465 "portions of the APT suite to provide consistent configurability. It accesses "
1466 "the main configuration file <filename>/etc/apt/apt.conf</filename> in a "
1467 "manner that is easy to use by scripted applications."
1470 #. type: Content of: <refentry><refsect1><para>
1471 #: apt-config.8.xml:56 apt-ftparchive.1.xml:75
1473 "Unless the <option>-h</option>, or <option>--help</option> option is given "
1474 "one of the commands below must be present."
1477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1478 #: apt-config.8.xml:61
1482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1483 #: apt-config.8.xml:63
1485 "shell is used to access the configuration information from a shell "
1486 "script. It is given pairs of arguments, the first being a shell variable and "
1487 "the second the configuration value to query. As output it lists a series of "
1488 "shell assignments commands for each present value. In a shell script it "
1489 "should be used like:"
1492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><informalexample><programlisting>
1493 #: apt-config.8.xml:71
1497 "RES=`apt-config shell OPTS MyApp::options`\n"
1501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1502 #: apt-config.8.xml:76
1504 "This will set the shell environment variable $OPTS to the value of "
1505 "MyApp::options with a default of <option>-f</option>."
1508 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1509 #: apt-config.8.xml:80
1511 "The configuration item may be postfixed with a /[fdbi]. f returns file "
1512 "names, d returns directories, b returns true or false and i returns an "
1513 "integer. Each of the returns is normalized and verified internally."
1516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1517 #: apt-config.8.xml:89
1518 msgid "Just show the contents of the configuration space."
1521 #. type: Content of: <refentry><refsect1><para>
1522 #: apt-config.8.xml:107 apt-extracttemplates.1.xml:78 apt-ftparchive.1.xml:628 apt-sortpkgs.1.xml:73
1526 #. type: Content of: <refentry><refsect1><para>
1527 #: apt-config.8.xml:112
1529 "<command>apt-config</command> returns zero on normal operation, decimal 100 "
1533 #. type: Content of: <refentry><refnamediv><refname>
1534 #: apt-extracttemplates.1.xml:25 apt-extracttemplates.1.xml:32
1535 msgid "apt-extracttemplates"
1538 #. type: Content of: <refentry><refmeta><manvolnum>
1539 #: apt-extracttemplates.1.xml:26 apt-ftparchive.1.xml:26 apt-sortpkgs.1.xml:26
1543 #. type: Content of: <refentry><refnamediv><refpurpose>
1544 #: apt-extracttemplates.1.xml:33
1545 msgid "Utility to extract DebConf config and templates from Debian packages"
1548 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1549 #: apt-extracttemplates.1.xml:39
1551 "<command>apt-extracttemplates</command> <arg><option>-hv</option></arg> "
1552 "<arg><option>-t=<replaceable>temporary "
1553 "directory</replaceable></option></arg> <arg choice=\"plain\" "
1554 "rep=\"repeat\"><replaceable>file</replaceable></arg>"
1557 #. type: Content of: <refentry><refsect1><para>
1558 #: apt-extracttemplates.1.xml:47
1560 "<command>apt-extracttemplates</command> will take one or more Debian package "
1561 "files as input and write out (to a temporary directory) all associated "
1562 "config scripts and template files. For each passed in package that contains "
1563 "config scripts and templates, one line of output will be generated in the "
1567 #. type: Content of: <refentry><refsect1><para>
1568 #: apt-extracttemplates.1.xml:52
1569 msgid "package version template-file config-script"
1572 #. type: Content of: <refentry><refsect1><para>
1573 #: apt-extracttemplates.1.xml:53
1575 "template-file and config-script are written to the temporary directory "
1576 "specified by the -t or --tempdir "
1577 "(<literal>APT::ExtractTemplates::TempDir</literal>) directory, with "
1578 "filenames of the form <filename>package.template.XXXX</filename> and "
1579 "<filename>package.config.XXXX</filename>"
1582 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1583 #: apt-extracttemplates.1.xml:63 apt-get.8.xml:504
1584 msgid "<option>-t</option>"
1587 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1588 #: apt-extracttemplates.1.xml:63
1589 msgid "<option>--tempdir</option>"
1592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1593 #: apt-extracttemplates.1.xml:65
1595 "Temporary directory in which to write extracted debconf template files and "
1596 "config scripts. Configuration Item: "
1597 "<literal>APT::ExtractTemplates::TempDir</literal>"
1600 #. type: Content of: <refentry><refsect1><para>
1601 #: apt-extracttemplates.1.xml:82
1603 "<command>apt-extracttemplates</command> returns zero on normal operation, "
1604 "decimal 100 on error."
1607 #. The last update date
1608 #. type: Content of: <refentry><refentryinfo>
1609 #: apt-ftparchive.1.xml:16
1611 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>17 "
1612 "August 2009</date>"
1615 #. type: Content of: <refentry><refnamediv><refname>
1616 #: apt-ftparchive.1.xml:25 apt-ftparchive.1.xml:32
1617 msgid "apt-ftparchive"
1620 #. type: Content of: <refentry><refnamediv><refpurpose>
1621 #: apt-ftparchive.1.xml:33
1622 msgid "Utility to generate index files"
1625 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
1626 #: apt-ftparchive.1.xml:39
1628 "<command>apt-ftparchive</command> <arg><option>-hvdsq</option></arg> "
1629 "<arg><option>--md5</option></arg> <arg><option>--delink</option></arg> "
1630 "<arg><option>--readonly</option></arg> "
1631 "<arg><option>--contents</option></arg> <arg><option>--arch "
1632 "<replaceable>architecture</replaceable></option></arg> <arg><option>-o "
1633 "<replaceable>config</replaceable>=<replaceable>string</replaceable></option></arg> "
1634 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <group "
1635 "choice=\"req\"> <arg>packages<arg choice=\"plain\" "
1636 "rep=\"repeat\"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg> "
1637 "<arg>sources<arg choice=\"plain\" "
1638 "rep=\"repeat\"><replaceable>path</replaceable></arg><arg><replaceable>override</replaceable><arg><replaceable>pathprefix</replaceable></arg></arg></arg> "
1639 "<arg>contents <arg "
1640 "choice=\"plain\"><replaceable>path</replaceable></arg></arg> <arg>release "
1641 "<arg choice=\"plain\"><replaceable>path</replaceable></arg></arg> "
1642 "<arg>generate <arg "
1643 "choice=\"plain\"><replaceable>config-file</replaceable></arg> <arg "
1645 "rep=\"repeat\"><replaceable>section</replaceable></arg></arg> <arg>clean "
1646 "<arg choice=\"plain\"><replaceable>config-file</replaceable></arg></arg> "
1650 #. type: Content of: <refentry><refsect1><para>
1651 #: apt-ftparchive.1.xml:60
1653 "<command>apt-ftparchive</command> is the command line tool that generates "
1654 "the index files that APT uses to access a distribution source. The index "
1655 "files should be generated on the origin site based on the content of that "
1659 #. type: Content of: <refentry><refsect1><para>
1660 #: apt-ftparchive.1.xml:64
1662 "<command>apt-ftparchive</command> is a superset of the &dpkg-scanpackages; "
1663 "program, incorporating its entire functionality via the "
1664 "<literal>packages</literal> command. It also contains a contents file "
1665 "generator, <literal>contents</literal>, and an elaborate means to 'script' "
1666 "the generation process for a complete archive."
1669 #. type: Content of: <refentry><refsect1><para>
1670 #: apt-ftparchive.1.xml:70
1672 "Internally <command>apt-ftparchive</command> can make use of binary "
1673 "databases to cache the contents of a .deb file and it does not rely on any "
1674 "external programs aside from &gzip;. When doing a full generate it "
1675 "automatically performs file-change checks and builds the desired compressed "
1679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1680 #: apt-ftparchive.1.xml:79
1684 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1685 #: apt-ftparchive.1.xml:81
1687 "The packages command generates a package file from a directory tree. It "
1688 "takes the given directory and recursively searches it for .deb files, "
1689 "emitting a package record to stdout for each. This command is approximately "
1690 "equivalent to &dpkg-scanpackages;."
1693 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1694 #: apt-ftparchive.1.xml:86 apt-ftparchive.1.xml:110
1695 msgid "The option <option>--db</option> can be used to specify a binary caching DB."
1698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1699 #: apt-ftparchive.1.xml:89
1703 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1704 #: apt-ftparchive.1.xml:91
1706 "The <literal>sources</literal> command generates a source index file from a "
1707 "directory tree. It takes the given directory and recursively searches it "
1708 "for .dsc files, emitting a source record to stdout for each. This command is "
1709 "approximately equivalent to &dpkg-scansources;."
1712 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1713 #: apt-ftparchive.1.xml:96
1715 "If an override file is specified then a source override file will be looked "
1716 "for with an extension of .src. The --source-override option can be used to "
1717 "change the source override file that will be used."
1720 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1721 #: apt-ftparchive.1.xml:101
1725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1726 #: apt-ftparchive.1.xml:103
1728 "The <literal>contents</literal> command generates a contents file from a "
1729 "directory tree. It takes the given directory and recursively searches it for "
1730 ".deb files, and reads the file list from each file. It then sorts and writes "
1731 "to stdout the list of files matched to packages. Directories are not written "
1732 "to the output. If multiple packages own the same file then each package is "
1733 "separated by a comma in the output."
1736 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1737 #: apt-ftparchive.1.xml:113
1741 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1742 #: apt-ftparchive.1.xml:115
1744 "The <literal>release</literal> command generates a Release file from a "
1745 "directory tree. It recursively searches the given directory for uncompressed "
1746 "<filename>Packages</filename> and <filename>Sources</filename> files and the "
1747 "ones compressed with <command>gzip</command>, <command>bzip2</command> or "
1748 "<command>lzma</command> as well as <filename>Release</filename> and "
1749 "<filename>md5sum.txt</filename> files by default "
1750 "(<literal>APT::FTPArchive::Release::Default-Patterns</literal>). Additional "
1751 "filename patterns can be added by listing them in "
1752 "<literal>APT::FTPArchive::Release::Patterns</literal>. It then writes to "
1753 "stdout a Release file containing a MD5, SHA1 and SHA256 digest for each "
1757 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1758 #: apt-ftparchive.1.xml:125
1760 "Values for the additional metadata fields in the Release file are taken from "
1761 "the corresponding variables under "
1762 "<literal>APT::FTPArchive::Release</literal>, "
1763 "e.g. <literal>APT::FTPArchive::Release::Origin</literal>. The supported "
1764 "fields are: <literal>Origin</literal>, <literal>Label</literal>, "
1765 "<literal>Suite</literal>, <literal>Version</literal>, "
1766 "<literal>Codename</literal>, <literal>Date</literal>, "
1767 "<literal>Valid-Until</literal>, <literal>Architectures</literal>, "
1768 "<literal>Components</literal>, <literal>Description</literal>."
1771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1772 #: apt-ftparchive.1.xml:136
1776 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1777 #: apt-ftparchive.1.xml:138
1779 "The <literal>generate</literal> command is designed to be runnable from a "
1780 "cron script and builds indexes according to the given config file. The "
1781 "config language provides a flexible means of specifying which index files "
1782 "are built from which directories, as well as providing a simple means of "
1783 "maintaining the required settings."
1786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1787 #: apt-ftparchive.1.xml:145 apt-get.8.xml:287
1791 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
1792 #: apt-ftparchive.1.xml:147
1794 "The <literal>clean</literal> command tidies the databases used by the given "
1795 "configuration file by removing any records that are no longer necessary."
1798 #. type: Content of: <refentry><refsect1><title>
1799 #: apt-ftparchive.1.xml:153
1800 msgid "The Generate Configuration"
1803 #. type: Content of: <refentry><refsect1><para>
1804 #: apt-ftparchive.1.xml:155
1806 "The <literal>generate</literal> command uses a configuration file to "
1807 "describe the archives that are going to be generated. It follows the typical "
1808 "ISC configuration format as seen in ISC tools like bind 8 and dhcpd. "
1809 "&apt-conf; contains a description of the syntax. Note that the generate "
1810 "configuration is parsed in sectional manner, but &apt-conf; is parsed in a "
1811 "tree manner. This only effects how the scope tag is handled."
1814 #. type: Content of: <refentry><refsect1><para>
1815 #: apt-ftparchive.1.xml:163
1816 msgid "The generate configuration has 4 separate sections, each described below."
1819 #. type: Content of: <refentry><refsect1><refsect2><title>
1820 #: apt-ftparchive.1.xml:165
1824 #. type: Content of: <refentry><refsect1><refsect2><para>
1825 #: apt-ftparchive.1.xml:167
1827 "The <literal>Dir</literal> section defines the standard directories needed "
1828 "to locate the files required during the generation process. These "
1829 "directories are prepended certain relative paths defined in later sections "
1830 "to produce a complete an absolute path."
1833 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1834 #: apt-ftparchive.1.xml:172
1838 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1839 #: apt-ftparchive.1.xml:174
1841 "Specifies the root of the FTP archive, in a standard Debian configuration "
1842 "this is the directory that contains the <filename>ls-LR</filename> and dist "
1846 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1847 #: apt-ftparchive.1.xml:179
1851 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1852 #: apt-ftparchive.1.xml:181
1853 msgid "Specifies the location of the override files."
1856 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1857 #: apt-ftparchive.1.xml:184
1861 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1862 #: apt-ftparchive.1.xml:186
1863 msgid "Specifies the location of the cache files"
1866 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1867 #: apt-ftparchive.1.xml:189
1871 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1872 #: apt-ftparchive.1.xml:191
1874 "Specifies the location of the file list files, if the "
1875 "<literal>FileList</literal> setting is used below."
1878 #. type: Content of: <refentry><refsect1><refsect2><title>
1879 #: apt-ftparchive.1.xml:197
1880 msgid "Default Section"
1883 #. type: Content of: <refentry><refsect1><refsect2><para>
1884 #: apt-ftparchive.1.xml:199
1886 "The <literal>Default</literal> section specifies default values, and "
1887 "settings that control the operation of the generator. Other sections may "
1888 "override these defaults with a per-section setting."
1891 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1892 #: apt-ftparchive.1.xml:203
1893 msgid "Packages::Compress"
1896 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1897 #: apt-ftparchive.1.xml:205
1899 "Sets the default compression schemes to use for the Package index files. It "
1900 "is a string that contains a space separated list of at least one of: '.' (no "
1901 "compression), 'gzip' and 'bzip2'. The default for all compression schemes is "
1905 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1906 #: apt-ftparchive.1.xml:211
1907 msgid "Packages::Extensions"
1910 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1911 #: apt-ftparchive.1.xml:213
1913 "Sets the default list of file extensions that are package files. This "
1914 "defaults to '.deb'."
1917 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1918 #: apt-ftparchive.1.xml:217
1919 msgid "Sources::Compress"
1922 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1923 #: apt-ftparchive.1.xml:219
1925 "This is similar to <literal>Packages::Compress</literal> except that it "
1926 "controls the compression for the Sources files."
1929 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1930 #: apt-ftparchive.1.xml:223
1931 msgid "Sources::Extensions"
1934 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1935 #: apt-ftparchive.1.xml:225
1937 "Sets the default list of file extensions that are source files. This "
1938 "defaults to '.dsc'."
1941 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1942 #: apt-ftparchive.1.xml:229
1943 msgid "Contents::Compress"
1946 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1947 #: apt-ftparchive.1.xml:231
1949 "This is similar to <literal>Packages::Compress</literal> except that it "
1950 "controls the compression for the Contents files."
1953 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1954 #: apt-ftparchive.1.xml:235
1955 msgid "Translation::Compress"
1958 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1959 #: apt-ftparchive.1.xml:237
1961 "This is similar to <literal>Packages::Compress</literal> except that it "
1962 "controls the compression for the Translation-en master file."
1965 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1966 #: apt-ftparchive.1.xml:241
1970 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1971 #: apt-ftparchive.1.xml:243
1973 "Specifies the number of kilobytes to delink (and replace with hard links) "
1974 "per run. This is used in conjunction with the per-section "
1975 "<literal>External-Links</literal> setting."
1978 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1979 #: apt-ftparchive.1.xml:248
1983 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1984 #: apt-ftparchive.1.xml:250
1986 "Specifies the mode of all created index files. It defaults to 0644. All "
1987 "index files are set to this mode with no regard to the umask."
1990 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
1991 #: apt-ftparchive.1.xml:255 apt-ftparchive.1.xml:401
1992 msgid "LongDescription"
1995 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
1996 #: apt-ftparchive.1.xml:257 apt-ftparchive.1.xml:403
1998 "Sets if long descriptions should be included in the Packages file or split "
1999 "out into a master Translation-en file."
2002 #. type: Content of: <refentry><refsect1><refsect2><title>
2003 #: apt-ftparchive.1.xml:263
2004 msgid "TreeDefault Section"
2007 #. type: Content of: <refentry><refsect1><refsect2><para>
2008 #: apt-ftparchive.1.xml:265
2010 "Sets defaults specific to <literal>Tree</literal> sections. All of these "
2011 "variables are substitution variables and have the strings $(DIST), "
2012 "$(SECTION) and $(ARCH) replaced with their respective values."
2015 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2016 #: apt-ftparchive.1.xml:270
2017 msgid "MaxContentsChange"
2020 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2021 #: apt-ftparchive.1.xml:272
2023 "Sets the number of kilobytes of contents files that are generated each "
2024 "day. The contents files are round-robined so that over several days they "
2025 "will all be rebuilt."
2028 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2029 #: apt-ftparchive.1.xml:277
2033 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2034 #: apt-ftparchive.1.xml:279
2036 "Controls the number of days a contents file is allowed to be checked without "
2037 "changing. If this limit is passed the mtime of the contents file is "
2038 "updated. This case can occur if the package file is changed in such a way "
2039 "that does not result in a new contents file [override edit for instance]. A "
2040 "hold off is allowed in hopes that new .debs will be installed, requiring a "
2041 "new file anyhow. The default is 10, the units are in days."
2044 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2045 #: apt-ftparchive.1.xml:288
2049 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2050 #: apt-ftparchive.1.xml:290
2052 "Sets the top of the .deb directory tree. Defaults to "
2053 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/</filename>"
2056 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2057 #: apt-ftparchive.1.xml:294
2058 msgid "SrcDirectory"
2061 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2062 #: apt-ftparchive.1.xml:296
2064 "Sets the top of the source package directory tree. Defaults to "
2065 "<filename>$(DIST)/$(SECTION)/source/</filename>"
2068 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2069 #: apt-ftparchive.1.xml:300 apt-ftparchive.1.xml:439
2073 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2074 #: apt-ftparchive.1.xml:302
2076 "Sets the output Packages file. Defaults to "
2077 "<filename>$(DIST)/$(SECTION)/binary-$(ARCH)/Packages</filename>"
2080 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2081 #: apt-ftparchive.1.xml:306 apt-ftparchive.1.xml:444
2085 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2086 #: apt-ftparchive.1.xml:308
2088 "Sets the output Sources file. Defaults to "
2089 "<filename>$(DIST)/$(SECTION)/source/Sources</filename>"
2092 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2093 #: apt-ftparchive.1.xml:312
2097 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2098 #: apt-ftparchive.1.xml:314
2100 "Set the output Translation-en master file with the long descriptions if they "
2101 "should be not included in the Packages file. Defaults to "
2102 "<filename>$(DIST)/$(SECTION)/i18n/Translation-en</filename>"
2105 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2106 #: apt-ftparchive.1.xml:319
2107 msgid "InternalPrefix"
2110 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2111 #: apt-ftparchive.1.xml:321
2113 "Sets the path prefix that causes a symlink to be considered an internal link "
2114 "instead of an external link. Defaults to "
2115 "<filename>$(DIST)/$(SECTION)/</filename>"
2118 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2119 #: apt-ftparchive.1.xml:326 apt-ftparchive.1.xml:450
2123 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2124 #: apt-ftparchive.1.xml:328
2126 "Sets the output Contents file. Defaults to "
2127 "<filename>$(DIST)/Contents-$(ARCH)</filename>. If this setting causes "
2128 "multiple Packages files to map onto a single Contents file (such as the "
2129 "default) then <command>apt-ftparchive</command> will integrate those "
2130 "package files together automatically."
2133 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2134 #: apt-ftparchive.1.xml:335
2135 msgid "Contents::Header"
2138 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2139 #: apt-ftparchive.1.xml:337
2140 msgid "Sets header file to prepend to the contents output."
2143 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2144 #: apt-ftparchive.1.xml:340 apt-ftparchive.1.xml:475
2148 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2149 #: apt-ftparchive.1.xml:342
2151 "Sets the binary cache database to use for this section. Multiple sections "
2152 "can share the same database."
2155 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2156 #: apt-ftparchive.1.xml:346
2160 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2161 #: apt-ftparchive.1.xml:348
2163 "Specifies that instead of walking the directory tree, "
2164 "<command>apt-ftparchive</command> should read the list of files from the "
2165 "given file. Relative files names are prefixed with the archive directory."
2168 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2169 #: apt-ftparchive.1.xml:353
2170 msgid "SourceFileList"
2173 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2174 #: apt-ftparchive.1.xml:355
2176 "Specifies that instead of walking the directory tree, "
2177 "<command>apt-ftparchive</command> should read the list of files from the "
2178 "given file. Relative files names are prefixed with the archive directory. "
2179 "This is used when processing source indexes."
2182 #. type: Content of: <refentry><refsect1><refsect2><title>
2183 #: apt-ftparchive.1.xml:363
2184 msgid "Tree Section"
2187 #. type: Content of: <refentry><refsect1><refsect2><para>
2188 #: apt-ftparchive.1.xml:365
2190 "The <literal>Tree</literal> section defines a standard Debian file tree "
2191 "which consists of a base directory, then multiple sections in that base "
2192 "directory and finally multiple Architectures in each section. The exact "
2193 "pathing used is defined by the <literal>Directory</literal> substitution "
2197 #. type: Content of: <refentry><refsect1><refsect2><para>
2198 #: apt-ftparchive.1.xml:370
2200 "The <literal>Tree</literal> section takes a scope tag which sets the "
2201 "<literal>$(DIST)</literal> variable and defines the root of the tree (the "
2202 "path is prefixed by <literal>ArchiveDir</literal>). Typically this is a "
2203 "setting such as <filename>dists/&stable-codename;</filename>."
2206 #. type: Content of: <refentry><refsect1><refsect2><para>
2207 #: apt-ftparchive.1.xml:375
2209 "All of the settings defined in the <literal>TreeDefault</literal> section "
2210 "can be use in a <literal>Tree</literal> section as well as three new "
2214 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
2215 #: apt-ftparchive.1.xml:381
2218 "for i in Sections do \n"
2219 " for j in Architectures do\n"
2220 " Generate for DIST=scope SECTION=i ARCH=j\n"
2224 #. type: Content of: <refentry><refsect1><refsect2><para>
2225 #: apt-ftparchive.1.xml:378
2227 "When processing a <literal>Tree</literal> section "
2228 "<command>apt-ftparchive</command> performs an operation similar to: "
2229 "<placeholder type=\"programlisting\" id=\"0\"/>"
2232 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2233 #: apt-ftparchive.1.xml:387
2237 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2238 #: apt-ftparchive.1.xml:389
2240 "This is a space separated list of sections which appear under the "
2241 "distribution, typically this is something like <literal>main contrib "
2242 "non-free</literal>"
2245 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2246 #: apt-ftparchive.1.xml:394
2247 msgid "Architectures"
2250 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2251 #: apt-ftparchive.1.xml:396
2253 "This is a space separated list of all the architectures that appear under "
2254 "search section. The special architecture 'source' is used to indicate that "
2255 "this tree has a source archive."
2258 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2259 #: apt-ftparchive.1.xml:407 apt-ftparchive.1.xml:455
2263 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2264 #: apt-ftparchive.1.xml:409
2266 "Sets the binary override file. The override file contains section, priority "
2267 "and maintainer address information."
2270 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2271 #: apt-ftparchive.1.xml:413 apt-ftparchive.1.xml:460
2275 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2276 #: apt-ftparchive.1.xml:415
2278 "Sets the source override file. The override file contains section "
2282 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2283 #: apt-ftparchive.1.xml:419 apt-ftparchive.1.xml:465
2284 msgid "ExtraOverride"
2287 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2288 #: apt-ftparchive.1.xml:421 apt-ftparchive.1.xml:467
2289 msgid "Sets the binary extra override file."
2292 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2293 #: apt-ftparchive.1.xml:424 apt-ftparchive.1.xml:470
2294 msgid "SrcExtraOverride"
2297 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2298 #: apt-ftparchive.1.xml:426 apt-ftparchive.1.xml:472
2299 msgid "Sets the source extra override file."
2302 #. type: Content of: <refentry><refsect1><refsect2><title>
2303 #: apt-ftparchive.1.xml:431
2304 msgid "BinDirectory Section"
2307 #. type: Content of: <refentry><refsect1><refsect2><para>
2308 #: apt-ftparchive.1.xml:433
2310 "The <literal>bindirectory</literal> section defines a binary directory tree "
2311 "with no special structure. The scope tag specifies the location of the "
2312 "binary directory and the settings are similar to the <literal>Tree</literal> "
2313 "section with no substitution variables or "
2314 "<literal>Section</literal><literal>Architecture</literal> settings."
2317 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2318 #: apt-ftparchive.1.xml:441
2319 msgid "Sets the Packages file output."
2322 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2323 #: apt-ftparchive.1.xml:446
2325 "Sets the Sources file output. At least one of <literal>Packages</literal> or "
2326 "<literal>Sources</literal> is required."
2329 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2330 #: apt-ftparchive.1.xml:452
2331 msgid "Sets the Contents file output. (optional)"
2334 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2335 #: apt-ftparchive.1.xml:457
2336 msgid "Sets the binary override file."
2339 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2340 #: apt-ftparchive.1.xml:462
2341 msgid "Sets the source override file."
2344 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2345 #: apt-ftparchive.1.xml:477
2346 msgid "Sets the cache DB."
2349 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2350 #: apt-ftparchive.1.xml:480
2354 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2355 #: apt-ftparchive.1.xml:482
2356 msgid "Appends a path to all the output paths."
2359 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
2360 #: apt-ftparchive.1.xml:485
2361 msgid "FileList, SourceFileList"
2364 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
2365 #: apt-ftparchive.1.xml:487
2366 msgid "Specifies the file list file."
2369 #. type: Content of: <refentry><refsect1><title>
2370 #: apt-ftparchive.1.xml:494
2371 msgid "The Binary Override File"
2374 #. type: Content of: <refentry><refsect1><para>
2375 #: apt-ftparchive.1.xml:495
2377 "The binary override file is fully compatible with &dpkg-scanpackages;. It "
2378 "contains 4 fields separated by spaces. The first field is the package name, "
2379 "the second is the priority to force that package to, the third is the the "
2380 "section to force that package to and the final field is the maintainer "
2381 "permutation field."
2384 #. type: Content of: <refentry><refsect1><para><literallayout>
2385 #: apt-ftparchive.1.xml:501
2387 msgid "old [// oldn]* => new"
2390 #. type: Content of: <refentry><refsect1><para><literallayout>
2391 #: apt-ftparchive.1.xml:503
2396 #. type: Content of: <refentry><refsect1><para>
2397 #: apt-ftparchive.1.xml:500
2399 "The general form of the maintainer field is: <placeholder "
2400 "type=\"literallayout\" id=\"0\"/> or simply, <placeholder "
2401 "type=\"literallayout\" id=\"1\"/> The first form allows a double-slash "
2402 "separated list of old email addresses to be specified. If any of those are "
2403 "found then new is substituted for the maintainer field. The second form "
2404 "unconditionally substitutes the maintainer field."
2407 #. type: Content of: <refentry><refsect1><title>
2408 #: apt-ftparchive.1.xml:511
2409 msgid "The Source Override File"
2412 #. type: Content of: <refentry><refsect1><para>
2413 #: apt-ftparchive.1.xml:513
2415 "The source override file is fully compatible with &dpkg-scansources;. It "
2416 "contains 2 fields separated by spaces. The first fields is the source "
2417 "package name, the second is the section to assign it."
2420 #. type: Content of: <refentry><refsect1><title>
2421 #: apt-ftparchive.1.xml:518
2422 msgid "The Extra Override File"
2425 #. type: Content of: <refentry><refsect1><para>
2426 #: apt-ftparchive.1.xml:520
2428 "The extra override file allows any arbitrary tag to be added or replaced in "
2429 "the output. It has 3 columns, the first is the package, the second is the "
2430 "tag and the remainder of the line is the new value."
2433 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2434 #: apt-ftparchive.1.xml:529
2435 msgid "<option>--md5</option>, <option>--sha1</option>, <option>--sha256</option>"
2438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2439 #: apt-ftparchive.1.xml:531
2441 "Generate the given checksum. These options default to on, when turned off "
2442 "the generated index files will not have the checksum fields where possible. "
2443 "Configuration Items: "
2444 "<literal>APT::FTPArchive::<replaceable>Checksum</replaceable></literal> and "
2445 "<literal>APT::FTPArchive::<replaceable>Index</replaceable>::<replaceable>Checksum</replaceable></literal> "
2446 "where <literal>Index</literal> can be <literal>Packages</literal>, "
2447 "<literal>Sources</literal> or <literal>Release</literal> and "
2448 "<literal>Checksum</literal> can be <literal>MD5</literal>, "
2449 "<literal>SHA1</literal> or <literal>SHA256</literal>."
2452 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2453 #: apt-ftparchive.1.xml:539
2454 msgid "<option>--db</option>"
2457 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2458 #: apt-ftparchive.1.xml:541
2460 "Use a binary caching DB. This has no effect on the generate command. "
2461 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
2464 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2465 #: apt-ftparchive.1.xml:547
2467 "Quiet; produces output suitable for logging, omitting progress indicators. "
2468 "More q's will produce more quiet up to a maximum of 2. You can also use "
2469 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2470 "file. Configuration Item: <literal>quiet</literal>."
2473 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2474 #: apt-ftparchive.1.xml:553
2475 msgid "<option>--delink</option>"
2478 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2479 #: apt-ftparchive.1.xml:555
2481 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
2482 "then this option actually enables delinking of the files. It defaults to on "
2483 "and can be turned off with <option>--no-delink</option>. Configuration "
2484 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
2487 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2488 #: apt-ftparchive.1.xml:561
2489 msgid "<option>--contents</option>"
2492 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2493 #: apt-ftparchive.1.xml:563
2495 "Perform contents generation. When this option is set and package indexes are "
2496 "being generated with a cache DB then the file listing will also be extracted "
2497 "and stored in the DB for later use. When using the generate command this "
2498 "option also allows the creation of any Contents files. The default is on. "
2499 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
2502 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2503 #: apt-ftparchive.1.xml:571
2504 msgid "<option>--source-override</option>"
2507 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2508 #: apt-ftparchive.1.xml:573
2510 "Select the source override file to use with the <literal>sources</literal> "
2511 "command. Configuration Item: "
2512 "<literal>APT::FTPArchive::SourceOverride</literal>."
2515 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2516 #: apt-ftparchive.1.xml:577
2517 msgid "<option>--readonly</option>"
2520 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2521 #: apt-ftparchive.1.xml:579
2523 "Make the caching databases read only. Configuration Item: "
2524 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2528 #: apt-ftparchive.1.xml:583
2529 msgid "<option>--arch</option>"
2532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2533 #: apt-ftparchive.1.xml:584
2535 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2536 "commands only package files matching <literal>*_arch.deb</literal> or "
2537 "<literal>*_all.deb</literal> instead of all package files in the given "
2538 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2541 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2542 #: apt-ftparchive.1.xml:590
2543 msgid "<option>APT::FTPArchive::AlwaysStat</option>"
2546 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2547 #: apt-ftparchive.1.xml:592
2549 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2550 "packages are recompiled and/or republished with the same version again, this "
2551 "will lead to problems as the now outdated cached metadata like size and "
2552 "checksums will be used. With this option enabled this will no longer happen "
2553 "as it will be checked if the file was changed. Note that this option is set "
2554 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2555 "multiply versions/builds of a package with the same versionnumber, so in "
2556 "theory nobody will have these problems and therefore all these extra checks "
2560 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2561 #: apt-ftparchive.1.xml:602
2562 msgid "<option>APT::FTPArchive::LongDescription</option>"
2565 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2566 #: apt-ftparchive.1.xml:604
2568 "This configuration option defaults to \"<literal>true</literal>\" and should "
2569 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2570 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2571 "that the <filename>Translation-en</filename> master file can only be created "
2572 "in the generate command."
2575 #. type: Content of: <refentry><refsect1><title>
2576 #: apt-ftparchive.1.xml:616 apt.conf.5.xml:1087 apt_preferences.5.xml:501 sources.list.5.xml:198
2580 #. type: Content of: <refentry><refsect1><para><programlisting>
2581 #: apt-ftparchive.1.xml:622
2584 "<command>apt-ftparchive</command> packages "
2585 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2586 "<filename>Packages.gz</filename>\n"
2589 #. type: Content of: <refentry><refsect1><para>
2590 #: apt-ftparchive.1.xml:618
2592 "To create a compressed Packages file for a directory containing binary "
2593 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2596 #. type: Content of: <refentry><refsect1><para>
2597 #: apt-ftparchive.1.xml:632
2599 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2603 #. The last update date
2604 #. type: Content of: <refentry><refentryinfo>
2607 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>08 "
2608 "November 2008</date>"
2611 #. type: <heading></heading>
2612 #: apt-get.8.xml:25 apt-get.8.xml:32 guide.sgml:96
2616 #. type: Content of: <refentry><refnamediv><refpurpose>
2618 msgid "APT package handling utility -- command-line interface"
2621 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
2624 "<command>apt-get</command> <arg><option>-sqdyfmubV</option></arg> <arg> "
2625 "<option>-o= <replaceable>config_string</replaceable> </option> </arg> <arg> "
2626 "<option>-c= <replaceable>config_file</replaceable> </option> </arg> <arg> "
2627 "<option>-t=</option> <arg choice='plain'> "
2628 "<replaceable>target_release</replaceable> </arg> </arg> <group "
2629 "choice=\"req\"> <arg choice='plain'>update</arg> <arg "
2630 "choice='plain'>upgrade</arg> <arg choice='plain'>dselect-upgrade</arg> <arg "
2631 "choice='plain'>dist-upgrade</arg> <arg choice='plain'>install <arg "
2632 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group "
2633 "choice='req'> <arg choice='plain'> "
2634 "=<replaceable>pkg_version_number</replaceable> </arg> <arg choice='plain'> "
2635 "/<replaceable>target_release</replaceable> </arg> </group> </arg> </arg> "
2636 "</arg> <arg choice='plain'>remove <arg choice=\"plain\" "
2637 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2638 "choice='plain'>purge <arg choice=\"plain\" "
2639 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2640 "choice='plain'>source <arg choice=\"plain\" "
2641 "rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group choice='req'> "
2642 "<arg choice='plain'> =<replaceable>pkg_version_number</replaceable> </arg> "
2643 "<arg choice='plain'> /<replaceable>target_release</replaceable> </arg> "
2644 "</group> </arg> </arg> </arg> <arg choice='plain'>build-dep <arg "
2645 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
2646 "<arg choice='plain'>check</arg> <arg choice='plain'>clean</arg> <arg "
2647 "choice='plain'>autoclean</arg> <arg choice='plain'>autoremove</arg> <arg "
2648 "choice='plain'> <group choice='req'> <arg choice='plain'>-v</arg> <arg "
2649 "choice='plain'>--version</arg> </group> </arg> <arg choice='plain'> <group "
2650 "choice='req'> <arg choice='plain'>-h</arg> <arg choice='plain'>--help</arg> "
2651 "</group> </arg> </group>"
2654 #. type: Content of: <refentry><refsect1><para>
2655 #: apt-get.8.xml:115
2657 "<command>apt-get</command> is the command-line tool for handling packages, "
2658 "and may be considered the user's \"back-end\" to other tools using the APT "
2659 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2660 "&aptitude;, &synaptic; and &wajig;."
2663 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2664 #: apt-get.8.xml:124 apt-key.8.xml:127
2668 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2669 #: apt-get.8.xml:125
2671 "<literal>update</literal> is used to resynchronize the package index files "
2672 "from their sources. The indexes of available packages are fetched from the "
2673 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2674 "example, when using a Debian archive, this command retrieves and scans the "
2675 "<filename>Packages.gz</filename> files, so that information about new and "
2676 "updated packages is available. An <literal>update</literal> should always be "
2677 "performed before an <literal>upgrade</literal> or "
2678 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2679 "meter will be incorrect as the size of the package files cannot be known in "
2683 #. type: <tag></tag>
2684 #: apt-get.8.xml:136 guide.sgml:121
2688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2689 #: apt-get.8.xml:137
2691 "<literal>upgrade</literal> is used to install the newest versions of all "
2692 "packages currently installed on the system from the sources enumerated in "
2693 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2694 "with new versions available are retrieved and upgraded; under no "
2695 "circumstances are currently installed packages removed, or packages not "
2696 "already installed retrieved and installed. New versions of currently "
2697 "installed packages that cannot be upgraded without changing the install "
2698 "status of another package will be left at their current version. An "
2699 "<literal>update</literal> must be performed first so that "
2700 "<command>apt-get</command> knows that new versions of packages are "
2704 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2705 #: apt-get.8.xml:149
2706 msgid "dselect-upgrade"
2709 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2710 #: apt-get.8.xml:150
2712 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2713 "traditional Debian packaging front-end, "
2714 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2715 "&dselect; to the <literal>Status</literal> field of available packages, and "
2716 "performs the actions necessary to realize that state (for instance, the "
2717 "removal of old and the installation of new packages)."
2720 #. type: <tag></tag>
2721 #: apt-get.8.xml:159 guide.sgml:140
2722 msgid "dist-upgrade"
2725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2726 #: apt-get.8.xml:160
2728 "<literal>dist-upgrade</literal> in addition to performing the function of "
2729 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2730 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2731 "conflict resolution system, and it will attempt to upgrade the most "
2732 "important packages at the expense of less important ones if necessary. So, "
2733 "<literal>dist-upgrade</literal> command may remove some packages. The "
2734 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2735 "from which to retrieve desired package files. See also &apt-preferences; "
2736 "for a mechanism for overriding the general settings for individual packages."
2739 #. type: <tag></tag>
2740 #: apt-get.8.xml:172 guide.sgml:131
2744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2745 #: apt-get.8.xml:174
2747 "<literal>install</literal> is followed by one or more packages desired for "
2748 "installation or upgrading. Each package is a package name, not a fully "
2749 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2750 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2751 "packages required by the package(s) specified for installation will also be "
2752 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2753 "file is used to locate the desired packages. If a hyphen is appended to the "
2754 "package name (with no intervening space), the identified package will be "
2755 "removed if it is installed. Similarly a plus sign can be used to designate "
2756 "a package to install. These latter features may be used to override "
2757 "decisions made by apt-get's conflict resolution system."
2760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2761 #: apt-get.8.xml:192
2763 "A specific version of a package can be selected for installation by "
2764 "following the package name with an equals and the version of the package to "
2765 "select. This will cause that version to be located and selected for "
2766 "install. Alternatively a specific distribution can be selected by following "
2767 "the package name with a slash and the version of the distribution or the "
2768 "Archive name (stable, testing, unstable)."
2771 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2772 #: apt-get.8.xml:199
2774 "Both of the version selection mechanisms can downgrade packages and must be "
2778 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2779 #: apt-get.8.xml:202
2781 "This is also the target to use if you want to upgrade one or more "
2782 "already-installed packages without upgrading every package you have on your "
2783 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2784 "all currently installed packages, \"install\" will install the newest "
2785 "version of only the package(s) specified. Simply provide the name of the "
2786 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2787 "its dependencies, as described above) will be downloaded and installed."
2790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2791 #: apt-get.8.xml:213
2793 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2794 "installation policy for individual packages."
2797 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2798 #: apt-get.8.xml:217
2800 "If no package matches the given expression and the expression contains one "
2801 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2802 "it is applied to all package names in the database. Any matches are then "
2803 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2804 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2805 "expression with a '^' or '$' character, or create a more specific regular "
2809 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2810 #: apt-get.8.xml:226
2814 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2815 #: apt-get.8.xml:227
2817 "<literal>remove</literal> is identical to <literal>install</literal> except "
2818 "that packages are removed instead of installed. Note the removing a package "
2819 "leaves its configuration files in system. If a plus sign is appended to the "
2820 "package name (with no intervening space), the identified package will be "
2821 "installed instead of removed."
2824 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2825 #: apt-get.8.xml:234
2829 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2830 #: apt-get.8.xml:235
2832 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2833 "that packages are removed and purged (any configuration files are deleted "
2837 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2838 #: apt-get.8.xml:239
2842 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2843 #: apt-get.8.xml:240
2845 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2846 "packages. APT will examine the available packages to decide which source "
2847 "package to fetch. It will then find and download into the current directory "
2848 "the newest available version of that source package while respect the "
2849 "default release, set with the option "
2850 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2851 "per package with the <literal>pkg/release</literal> syntax, if possible."
2854 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2855 #: apt-get.8.xml:248
2857 "Source packages are tracked separately from binary packages via "
2858 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2859 "that you will need to add such a line for each repository you want to get "
2860 "sources from. If you don't do this you will properly get another (newer, "
2861 "older or none) source version than the one you have installed or could "
2865 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2866 #: apt-get.8.xml:255
2868 "If the <option>--compile</option> option is specified then the package will "
2869 "be compiled to a binary .deb using <command>dpkg-buildpackage</command>, if "
2870 "<option>--download-only</option> is specified then the source package will "
2874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2875 #: apt-get.8.xml:260
2877 "A specific source version can be retrieved by postfixing the source name "
2878 "with an equals and then the version to fetch, similar to the mechanism used "
2879 "for the package files. This enables exact matching of the source package "
2880 "name and version, implicitly enabling the "
2881 "<literal>APT::Get::Only-Source</literal> option."
2884 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2885 #: apt-get.8.xml:266
2887 "Note that source packages are not tracked like binary packages, they exist "
2888 "only in the current directory and are similar to downloading source tar "
2892 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2893 #: apt-get.8.xml:271
2897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2898 #: apt-get.8.xml:272
2900 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2901 "attempt to satisfy the build dependencies for a source package."
2904 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2905 #: apt-get.8.xml:276
2909 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2910 #: apt-get.8.xml:277
2912 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2913 "and checks for broken dependencies."
2916 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2917 #: apt-get.8.xml:281
2921 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2922 #: apt-get.8.xml:282
2924 "<literal>download</literal> will download the given binary package into the "
2928 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2929 #: apt-get.8.xml:288
2931 "<literal>clean</literal> clears out the local repository of retrieved "
2932 "package files. It removes everything but the lock file from "
2933 "<filename>&cachedir;/archives/</filename> and "
2934 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2935 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2936 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2937 "from time to time to free up disk space."
2940 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2941 #: apt-get.8.xml:297
2945 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2946 #: apt-get.8.xml:298
2948 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2949 "local repository of retrieved package files. The difference is that it only "
2950 "removes package files that can no longer be downloaded, and are largely "
2951 "useless. This allows a cache to be maintained over a long period without it "
2952 "growing out of control. The configuration option "
2953 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2954 "being erased if it is set to off."
2957 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2958 #: apt-get.8.xml:307
2962 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2963 #: apt-get.8.xml:308
2965 "<literal>autoremove</literal> is used to remove packages that were "
2966 "automatically installed to satisfy dependencies for some package and that "
2967 "are no more needed."
2970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2971 #: apt-get.8.xml:312
2975 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2976 #: apt-get.8.xml:313
2978 "<literal>changelog</literal> downloads a package changelog and displays it "
2979 "through <command>sensible-pager</command>. The server name and base "
2980 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2981 "variable (e. g. <ulink>http://packages.debian.org/changelogs</ulink> for "
2982 "Debian or <ulink>http://changelogs.ubuntu.com/changelogs</ulink> for "
2983 "Ubuntu). By default it displays the changelog for the version that is "
2984 "installed. However, you can specify the same options as for the "
2985 "<option>install</option> command."
2988 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2989 #: apt-get.8.xml:335
2990 msgid "<option>--no-install-recommends</option>"
2993 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2994 #: apt-get.8.xml:336
2996 "Do not consider recommended packages as a dependency for installing. "
2997 "Configuration Item: <literal>APT::Install-Recommends</literal>."
3000 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3001 #: apt-get.8.xml:340
3002 msgid "<option>--install-suggests</option>"
3005 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3006 #: apt-get.8.xml:341
3008 "Consider suggested packages as a dependency for installing. Configuration "
3009 "Item: <literal>APT::Install-Suggests</literal>."
3012 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3013 #: apt-get.8.xml:345
3014 msgid "<option>--download-only</option>"
3017 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3018 #: apt-get.8.xml:346
3020 "Download only; package files are only retrieved, not unpacked or installed. "
3021 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
3024 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3025 #: apt-get.8.xml:350
3026 msgid "<option>--fix-broken</option>"
3029 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3030 #: apt-get.8.xml:351
3032 "Fix; attempt to correct a system with broken dependencies in place. This "
3033 "option, when used with install/remove, can omit any packages to permit APT "
3034 "to deduce a likely solution. If packages are specified, these have to "
3035 "completely correct the problem. The option is sometimes necessary when "
3036 "running APT for the first time; APT itself does not allow broken package "
3037 "dependencies to exist on a system. It is possible that a system's dependency "
3038 "structure can be so corrupt as to require manual intervention (which usually "
3039 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
3040 "of the offending packages). Use of this option together with "
3041 "<option>-m</option> may produce an error in some situations. Configuration "
3042 "Item: <literal>APT::Get::Fix-Broken</literal>."
3045 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3046 #: apt-get.8.xml:364
3047 msgid "<option>--ignore-missing</option>"
3050 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3051 #: apt-get.8.xml:365
3052 msgid "<option>--fix-missing</option>"
3055 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3056 #: apt-get.8.xml:366
3058 "Ignore missing packages; If packages cannot be retrieved or fail the "
3059 "integrity check after retrieval (corrupted package files), hold back those "
3060 "packages and handle the result. Use of this option together with "
3061 "<option>-f</option> may produce an error in some situations. If a package is "
3062 "selected for installation (particularly if it is mentioned on the command "
3063 "line) and it could not be downloaded then it will be silently held back. "
3064 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
3067 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3068 #: apt-get.8.xml:376
3069 msgid "<option>--no-download</option>"
3072 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3073 #: apt-get.8.xml:377
3075 "Disables downloading of packages. This is best used with "
3076 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
3077 "already downloaded. Configuration Item: "
3078 "<literal>APT::Get::Download</literal>."
3081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3082 #: apt-get.8.xml:384
3084 "Quiet; produces output suitable for logging, omitting progress indicators. "
3085 "More q's will produce more quiet up to a maximum of 2. You can also use "
3086 "<option>-q=#</option> to set the quiet level, overriding the configuration "
3087 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
3088 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
3089 "may decided to do something you did not expect. Configuration Item: "
3090 "<literal>quiet</literal>."
3093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3094 #: apt-get.8.xml:394
3095 msgid "<option>--simulate</option>"
3098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3099 #: apt-get.8.xml:396
3100 msgid "<option>--dry-run</option>"
3103 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3104 #: apt-get.8.xml:399
3106 "No action; perform a simulation of events that would occur but do not "
3107 "actually change the system. Configuration Item: "
3108 "<literal>APT::Get::Simulate</literal>."
3111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3112 #: apt-get.8.xml:403
3114 "Simulation run as user will deactivate locking "
3115 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
3116 "displayed indicating that this is only a simulation, if the option "
3117 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
3118 "true). Neither NoLocking nor the notice will be triggered if run as root "
3119 "(root should know what he is doing without further warnings by "
3120 "<literal>apt-get</literal>)."
3123 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3124 #: apt-get.8.xml:409
3126 "Simulate prints out a series of lines each one representing a dpkg "
3127 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
3128 "indicate broken packages and empty set of square brackets meaning breaks "
3129 "that are of no consequence (rare)."
3132 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3133 #: apt-get.8.xml:416
3134 msgid "<option>-y</option>"
3137 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3138 #: apt-get.8.xml:416
3139 msgid "<option>--yes</option>"
3142 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3143 #: apt-get.8.xml:417
3144 msgid "<option>--assume-yes</option>"
3147 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3148 #: apt-get.8.xml:418
3150 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
3151 "non-interactively. If an undesirable situation, such as changing a held "
3152 "package, trying to install a unauthenticated package or removing an "
3153 "essential package occurs then <literal>apt-get</literal> will abort. "
3154 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
3157 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3158 #: apt-get.8.xml:425
3159 msgid "<option>-u</option>"
3162 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3163 #: apt-get.8.xml:425
3164 msgid "<option>--show-upgraded</option>"
3167 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3168 #: apt-get.8.xml:426
3170 "Show upgraded packages; Print out a list of all packages that are to be "
3171 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
3174 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3175 #: apt-get.8.xml:431
3176 msgid "<option>-V</option>"
3179 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3180 #: apt-get.8.xml:431
3181 msgid "<option>--verbose-versions</option>"
3184 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3185 #: apt-get.8.xml:432
3187 "Show full versions for upgraded and installed packages. Configuration Item: "
3188 "<literal>APT::Get::Show-Versions</literal>."
3191 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3192 #: apt-get.8.xml:436
3193 msgid "<option>-b</option>"
3196 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3197 #: apt-get.8.xml:436
3198 msgid "<option>--compile</option>"
3201 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3202 #: apt-get.8.xml:437
3203 msgid "<option>--build</option>"
3206 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3207 #: apt-get.8.xml:438
3209 "Compile source packages after downloading them. Configuration Item: "
3210 "<literal>APT::Get::Compile</literal>."
3213 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3214 #: apt-get.8.xml:442
3215 msgid "<option>--ignore-hold</option>"
3218 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3219 #: apt-get.8.xml:443
3221 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
3222 "hold placed on a package. This may be useful in conjunction with "
3223 "<literal>dist-upgrade</literal> to override a large number of undesired "
3224 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
3227 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3228 #: apt-get.8.xml:449
3229 msgid "<option>--no-upgrade</option>"
3232 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3233 #: apt-get.8.xml:450
3235 "Do not upgrade packages; When used in conjunction with "
3236 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
3237 "packages on the command line from being upgraded if they are already "
3238 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
3241 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3242 #: apt-get.8.xml:456
3243 msgid "<option>--only-upgrade</option>"
3246 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3247 #: apt-get.8.xml:457
3249 "Do not install new packages; When used in conjunction with "
3250 "<literal>install</literal>, <literal>only-upgrade</literal> will prevent "
3251 "packages on the command line from being upgraded if they are not already "
3252 "installed. Configuration Item: <literal>APT::Get::Only-Upgrade</literal>."
3255 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3256 #: apt-get.8.xml:463
3257 msgid "<option>--force-yes</option>"
3260 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3261 #: apt-get.8.xml:464
3263 "Force yes; This is a dangerous option that will cause apt to continue "
3264 "without prompting if it is doing something potentially harmful. It should "
3265 "not be used except in very special situations. Using "
3266 "<literal>force-yes</literal> can potentially destroy your system! "
3267 "Configuration Item: <literal>APT::Get::force-yes</literal>."
3270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3271 #: apt-get.8.xml:471
3272 msgid "<option>--print-uris</option>"
3275 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3276 #: apt-get.8.xml:472
3278 "Instead of fetching the files to install their URIs are printed. Each URI "
3279 "will have the path, the destination file name, the size and the expected md5 "
3280 "hash. Note that the file name to write to will not always match the file "
3281 "name on the remote site! This also works with the <literal>source</literal> "
3282 "and <literal>update</literal> commands. When used with the "
3283 "<literal>update</literal> command the MD5 and size are not included, and it "
3284 "is up to the user to decompress any compressed files. Configuration Item: "
3285 "<literal>APT::Get::Print-URIs</literal>."
3288 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3289 #: apt-get.8.xml:482
3290 msgid "<option>--purge</option>"
3293 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3294 #: apt-get.8.xml:483
3296 "Use purge instead of remove for anything that would be removed. An asterisk "
3297 "(\"*\") will be displayed next to packages which are scheduled to be "
3298 "purged. <option>remove --purge</option> is equivalent to the "
3299 "<option>purge</option> command. Configuration Item: "
3300 "<literal>APT::Get::Purge</literal>."
3303 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3304 #: apt-get.8.xml:490
3305 msgid "<option>--reinstall</option>"
3308 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3309 #: apt-get.8.xml:491
3311 "Re-Install packages that are already installed and at the newest version. "
3312 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
3315 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3316 #: apt-get.8.xml:495
3317 msgid "<option>--list-cleanup</option>"
3320 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3321 #: apt-get.8.xml:496
3323 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
3324 "it off. When on <command>apt-get</command> will automatically manage the "
3325 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
3326 "files are erased. The only reason to turn it off is if you frequently "
3327 "change your source list. Configuration Item: "
3328 "<literal>APT::Get::List-Cleanup</literal>."
3331 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3332 #: apt-get.8.xml:505
3333 msgid "<option>--target-release</option>"
3336 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3337 #: apt-get.8.xml:506
3338 msgid "<option>--default-release</option>"
3341 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3342 #: apt-get.8.xml:507
3344 "This option controls the default input to the policy engine, it creates a "
3345 "default pin at priority 990 using the specified release string. This "
3346 "overrides the general settings in "
3347 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
3348 "not affected by the value of this option. In short, this option lets you "
3349 "have simple control over which distribution packages will be retrieved "
3350 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
3351 "unstable</option> or <option>-t sid</option>. Configuration Item: "
3352 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
3356 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3357 #: apt-get.8.xml:520
3358 msgid "<option>--trivial-only</option>"
3361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3362 #: apt-get.8.xml:522
3364 "Only perform operations that are 'trivial'. Logically this can be considered "
3365 "related to <option>--assume-yes</option>, where "
3366 "<option>--assume-yes</option> will answer yes to any prompt, "
3367 "<option>--trivial-only</option> will answer no. Configuration Item: "
3368 "<literal>APT::Get::Trivial-Only</literal>."
3371 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3372 #: apt-get.8.xml:528
3373 msgid "<option>--no-remove</option>"
3376 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3377 #: apt-get.8.xml:529
3379 "If any packages are to be removed apt-get immediately aborts without "
3380 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
3383 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3384 #: apt-get.8.xml:534
3385 msgid "<option>--auto-remove</option>"
3388 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3389 #: apt-get.8.xml:535
3391 "If the command is either <literal>install</literal> or "
3392 "<literal>remove</literal>, then this option acts like running "
3393 "<literal>autoremove</literal> command, removing the unused dependency "
3394 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
3397 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3398 #: apt-get.8.xml:541
3399 msgid "<option>--only-source</option>"
3402 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3403 #: apt-get.8.xml:542
3405 "Only has meaning for the <literal>source</literal> and "
3406 "<literal>build-dep</literal> commands. Indicates that the given source "
3407 "names are not to be mapped through the binary table. This means that if "
3408 "this option is specified, these commands will only accept source package "
3409 "names as arguments, rather than accepting binary package names and looking "
3410 "up the corresponding source package. Configuration Item: "
3411 "<literal>APT::Get::Only-Source</literal>."
3414 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3415 #: apt-get.8.xml:552
3416 msgid "<option>--diff-only</option>"
3419 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3420 #: apt-get.8.xml:552
3421 msgid "<option>--dsc-only</option>"
3424 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3425 #: apt-get.8.xml:552
3426 msgid "<option>--tar-only</option>"
3429 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3430 #: apt-get.8.xml:553
3432 "Download only the diff, dsc, or tar file of a source archive. Configuration "
3433 "Item: <literal>APT::Get::Diff-Only</literal>, "
3434 "<literal>APT::Get::Dsc-Only</literal>, and "
3435 "<literal>APT::Get::Tar-Only</literal>."
3438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3439 #: apt-get.8.xml:558
3440 msgid "<option>--arch-only</option>"
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3444 #: apt-get.8.xml:559
3446 "Only process architecture-dependent build-dependencies. Configuration Item: "
3447 "<literal>APT::Get::Arch-Only</literal>."
3450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3451 #: apt-get.8.xml:563
3452 msgid "<option>--allow-unauthenticated</option>"
3455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3456 #: apt-get.8.xml:564
3458 "Ignore if packages can't be authenticated and don't prompt about it. This "
3459 "is useful for tools like pbuilder. Configuration Item: "
3460 "<literal>APT::Get::AllowUnauthenticated</literal>."
3463 #. type: Content of: <refentry><refsect1><variablelist>
3464 #: apt-get.8.xml:577
3466 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
3470 #. type: Content of: <refentry><refsect1><para>
3471 #: apt-get.8.xml:586
3473 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
3474 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
3475 "&apt-preferences;, the APT Howto."
3478 #. type: Content of: <refentry><refsect1><para>
3479 #: apt-get.8.xml:592
3481 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
3485 #. type: Content of: <refentry><refsect1><title>
3486 #: apt-get.8.xml:595
3487 msgid "ORIGINAL AUTHORS"
3490 #. type: Content of: <refentry><refsect1><para>
3491 #: apt-get.8.xml:596
3492 msgid "&apt-author.jgunthorpe;"
3495 #. type: Content of: <refentry><refsect1><title>
3496 #: apt-get.8.xml:599
3497 msgid "CURRENT AUTHORS"
3500 #. type: Content of: <refentry><refsect1><para>
3501 #: apt-get.8.xml:601
3502 msgid "&apt-author.team;"
3505 #. type: Content of: <refentry><refnamediv><refname>
3506 #: apt-key.8.xml:17 apt-key.8.xml:24
3510 #. type: Content of: <refentry><refnamediv><refpurpose>
3512 msgid "APT key management utility"
3515 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3518 "<command>apt-key</command> <arg><option>--keyring "
3519 "<replaceable>filename</replaceable></option></arg> "
3520 "<arg><replaceable>command</replaceable></arg> <arg "
3521 "rep=\"repeat\"><option><replaceable>arguments</replaceable></option></arg>"
3524 #. type: Content of: <refentry><refsect1><para>
3527 "<command>apt-key</command> is used to manage the list of keys used by apt to "
3528 "authenticate packages. Packages which have been authenticated using these "
3529 "keys will be considered trusted."
3532 #. type: Content of: <refentry><refsect1><title>
3537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3539 msgid "add <replaceable>filename</replaceable>"
3542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3545 "Add a new key to the list of trusted keys. The key is read from "
3546 "<replaceable>filename</replaceable>, or standard input if "
3547 "<replaceable>filename</replaceable> is <literal>-</literal>."
3550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3552 msgid "del <replaceable>keyid</replaceable>"
3555 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3557 msgid "Remove a key from the list of trusted keys."
3560 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3562 msgid "export <replaceable>keyid</replaceable>"
3565 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3567 msgid "Output the key <replaceable>keyid</replaceable> to standard output."
3570 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3575 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3577 msgid "Output all trusted keys to standard output."
3580 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3585 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3587 msgid "List trusted keys."
3590 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3591 #: apt-key.8.xml:104
3595 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3596 #: apt-key.8.xml:108
3597 msgid "List fingerprints of trusted keys."
3600 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3601 #: apt-key.8.xml:115
3605 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3606 #: apt-key.8.xml:119
3608 "Pass advanced options to gpg. With adv --recv-key you can download the "
3612 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3613 #: apt-key.8.xml:131
3615 "Update the local keyring with the keyring of Debian archive keys and removes "
3616 "from the keyring the archive keys which are no longer valid."
3619 #. type: Content of: <refentry><refsect1><para>
3620 #: apt-key.8.xml:143
3622 "Note that options need to be defined before the commands described in the "
3626 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3627 #: apt-key.8.xml:145
3628 msgid "--keyring <replaceable>filename</replaceable>"
3631 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3632 #: apt-key.8.xml:146
3634 "With this option it is possible to specify a specific keyring file the "
3635 "command should operate on. The default is that a command is executed on the "
3636 "<filename>trusted.gpg</filename> file as well as on all parts in the "
3637 "<filename>trusted.gpg.d</filename> directory, through "
3638 "<filename>trusted.gpg</filename> is the primary keyring which means that "
3639 "e.g. new keys are added to this one."
3642 #. type: Content of: <refentry><refsect1><variablelist>
3643 #: apt-key.8.xml:159
3644 msgid "&file-trustedgpg;"
3647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3648 #: apt-key.8.xml:161
3649 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
3652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3653 #: apt-key.8.xml:162
3654 msgid "Local trust database of archive keys."
3657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3658 #: apt-key.8.xml:165
3659 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
3662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3663 #: apt-key.8.xml:166
3664 msgid "Keyring of Debian archive trusted keys."
3667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3668 #: apt-key.8.xml:169
3669 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
3672 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3673 #: apt-key.8.xml:170
3674 msgid "Keyring of Debian archive removed trusted keys."
3677 #. type: Content of: <refentry><refsect1><para>
3678 #: apt-key.8.xml:179
3679 msgid "&apt-get;, &apt-secure;"
3682 #. The last update date
3683 #. type: Content of: <refentry><refentryinfo>
3684 #: apt-mark.8.xml:16
3686 "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product; <date>9 "
3687 "August 2009</date>"
3690 #. type: Content of: <refentry><refnamediv><refname>
3691 #: apt-mark.8.xml:25 apt-mark.8.xml:32
3695 #. type: Content of: <refentry><refnamediv><refpurpose>
3696 #: apt-mark.8.xml:33
3697 msgid "mark/unmark a package as being automatically-installed"
3700 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3701 #: apt-mark.8.xml:39
3703 " <command>apt-mark</command> <arg><option>-hv</option></arg> "
3704 "<arg><option>-f=<replaceable>FILENAME</replaceable></option></arg> <group "
3705 "choice=\"plain\"> <arg choice=\"plain\"> <group choice=\"req\"> <arg "
3706 "choice=\"plain\">markauto</arg> <arg choice=\"plain\">unmarkauto</arg> "
3707 "</group> <arg choice=\"plain\" "
3708 "rep=\"repeat\"><replaceable>package</replaceable></arg> </arg> <arg "
3709 "choice=\"plain\">showauto</arg> </group>"
3712 #. type: Content of: <refentry><refsect1><para>
3713 #: apt-mark.8.xml:56
3715 "<command>apt-mark</command> will change whether a package has been marked as "
3716 "being automatically installed."
3719 #. type: Content of: <refentry><refsect1><para>
3720 #: apt-mark.8.xml:60
3722 "When you request that a package is installed, and as a result other packages "
3723 "are installed to satisfy its dependencies, the dependencies are marked as "
3724 "being automatically installed. Once these automatically installed packages "
3725 "are no longer depended on by any manually installed packages, they will be "
3726 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
3729 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3730 #: apt-mark.8.xml:68
3734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3735 #: apt-mark.8.xml:69
3737 "<literal>markauto</literal> is used to mark a package as being automatically "
3738 "installed, which will cause the package to be removed when no more manually "
3739 "installed packages depend on this package."
3742 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3743 #: apt-mark.8.xml:76
3747 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3748 #: apt-mark.8.xml:77
3750 "<literal>unmarkauto</literal> is used to mark a package as being manually "
3751 "installed, which will prevent the package from being automatically removed "
3752 "if no other packages depend on it."
3755 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3756 #: apt-mark.8.xml:84
3760 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3761 #: apt-mark.8.xml:85
3763 "<literal>showauto</literal> is used to print a list of automatically "
3764 "installed packages with each package on a new line."
3767 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3768 #: apt-mark.8.xml:96
3769 msgid "<option>-f=<filename><replaceable>FILENAME</replaceable></filename></option>"
3772 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3773 #: apt-mark.8.xml:97
3774 msgid "<option>--file=<filename><replaceable>FILENAME</replaceable></filename></option>"
3777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3778 #: apt-mark.8.xml:100
3780 "Read/Write package stats from "
3781 "<filename><replaceable>FILENAME</replaceable></filename> instead of the "
3782 "default location, which is <filename>extended_status</filename> in the "
3783 "directory defined by the Configuration Item: <literal>Dir::State</literal>."
3786 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3787 #: apt-mark.8.xml:106
3788 msgid "<option>-h</option>"
3791 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3792 #: apt-mark.8.xml:107
3793 msgid "<option>--help</option>"
3796 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3797 #: apt-mark.8.xml:108
3798 msgid "Show a short usage summary."
3801 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3802 #: apt-mark.8.xml:114
3803 msgid "<option>-v</option>"
3806 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3807 #: apt-mark.8.xml:115
3808 msgid "<option>--version</option>"
3811 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3812 #: apt-mark.8.xml:116
3813 msgid "Show the program version."
3816 #. type: Content of: <refentry><refsect1><variablelist>
3817 #: apt-mark.8.xml:127
3818 msgid " &file-extended_states;"
3821 #. type: Content of: <refentry><refsect1><para>
3822 #: apt-mark.8.xml:132
3823 msgid "&apt-get;,&aptitude;,&apt-conf;"
3826 #. type: Content of: <refentry><refsect1><para>
3827 #: apt-mark.8.xml:136
3829 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
3833 #. type: Content of: <refentry><refnamediv><refname>
3834 #: apt-secure.8.xml:17 apt-secure.8.xml:39
3838 #. type: Content of: <refentry><refnamediv><refpurpose>
3839 #: apt-secure.8.xml:40
3840 msgid "Archive authentication support for APT"
3843 #. type: Content of: <refentry><refsect1><para>
3844 #: apt-secure.8.xml:45
3846 "Starting with version 0.6, <command>apt</command> contains code that does "
3847 "signature checking of the Release file for all archives. This ensures that "
3848 "packages in the archive can't be modified by people who have no access to "
3849 "the Release file signing key."
3852 #. type: Content of: <refentry><refsect1><para>
3853 #: apt-secure.8.xml:53
3855 "If a package comes from a archive without a signature or with a signature "
3856 "that apt does not have a key for that package is considered untrusted and "
3857 "installing it will result in a big warning. <command>apt-get</command> will "
3858 "currently only warn for unsigned archives, future releases might force all "
3859 "sources to be verified before downloading packages from them."
3862 #. type: Content of: <refentry><refsect1><para>
3863 #: apt-secure.8.xml:62
3865 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
3866 "authentication feature."
3869 #. type: Content of: <refentry><refsect1><title>
3870 #: apt-secure.8.xml:67
3871 msgid "Trusted archives"
3874 #. type: Content of: <refentry><refsect1><para>
3875 #: apt-secure.8.xml:70
3877 "The chain of trust from an apt archive to the end user is made up of "
3878 "different steps. <command>apt-secure</command> is the last step in this "
3879 "chain, trusting an archive does not mean that the packages that you trust it "
3880 "do not contain malicious code but means that you trust the archive "
3881 "maintainer. It's the archive maintainer responsibility to ensure that the "
3882 "archive integrity is correct."
3885 #. type: Content of: <refentry><refsect1><para>
3886 #: apt-secure.8.xml:78
3888 "apt-secure does not review signatures at a package level. If you require "
3889 "tools to do this you should look at <command>debsig-verify</command> and "
3890 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3891 "packages respectively)."
3894 #. type: Content of: <refentry><refsect1><para>
3895 #: apt-secure.8.xml:85
3897 "The chain of trust in Debian starts when a maintainer uploads a new package "
3898 "or a new version of a package to the Debian archive. This upload in order to "
3899 "become effective needs to be signed by a key of a maintainer within the "
3900 "Debian maintainer's keyring (available in the debian-keyring "
3901 "package). Maintainer's keys are signed by other maintainers following "
3902 "pre-established procedures to ensure the identity of the key holder."
3905 #. type: Content of: <refentry><refsect1><para>
3906 #: apt-secure.8.xml:95
3908 "Once the uploaded package is verified and included in the archive, the "
3909 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3910 "and put in the Packages file. The MD5 sum of all of the packages files are "
3911 "then computed and put into the Release file. The Release file is then signed "
3912 "by the archive key (which is created once a year) and distributed through "
3913 "the FTP server. This key is also on the Debian keyring."
3916 #. type: Content of: <refentry><refsect1><para>
3917 #: apt-secure.8.xml:105
3919 "Any end user can check the signature of the Release file, extract the MD5 "
3920 "sum of a package from it and compare it with the MD5 sum of the package he "
3921 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3922 "package was checked. Now both the MD5 sum and the signature of the Release "
3926 #. type: Content of: <refentry><refsect1><para>
3927 #: apt-secure.8.xml:112
3929 "Notice that this is distinct from checking signatures on a per package "
3930 "basis. It is designed to prevent two possible attacks:"
3933 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3934 #: apt-secure.8.xml:117
3936 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
3937 "checking, a malicious agent can introduce himself in the package download "
3938 "process and provide malicious software either by controlling a network "
3939 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
3940 "(through arp or DNS spoofing attacks)."
3943 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3944 #: apt-secure.8.xml:125
3946 "<literal>Mirror network compromise</literal>. Without signature checking, a "
3947 "malicious agent can compromise a mirror host and modify the files in it to "
3948 "propagate malicious software to all users downloading packages from that "
3952 #. type: Content of: <refentry><refsect1><para>
3953 #: apt-secure.8.xml:132
3955 "However, it does not defend against a compromise of the Debian master server "
3956 "itself (which signs the packages) or against a compromise of the key used to "
3957 "sign the Release files. In any case, this mechanism can complement a "
3958 "per-package signature."
3961 #. type: Content of: <refentry><refsect1><title>
3962 #: apt-secure.8.xml:138
3963 msgid "User configuration"
3966 #. type: Content of: <refentry><refsect1><para>
3967 #: apt-secure.8.xml:140
3969 "<command>apt-key</command> is the program that manages the list of keys used "
3970 "by apt. It can be used to add or remove keys although an installation of "
3971 "this release will automatically provide the default Debian archive signing "
3972 "keys used in the Debian package repositories."
3975 #. type: Content of: <refentry><refsect1><para>
3976 #: apt-secure.8.xml:147
3978 "In order to add a new key you need to first download it (you should make "
3979 "sure you are using a trusted communication channel when retrieving it), add "
3980 "it with <command>apt-key</command> and then run <command>apt-get "
3981 "update</command> so that apt can download and verify the "
3982 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
3983 "from the archives you have configured."
3986 #. type: Content of: <refentry><refsect1><title>
3987 #: apt-secure.8.xml:156
3988 msgid "Archive configuration"
3991 #. type: Content of: <refentry><refsect1><para>
3992 #: apt-secure.8.xml:158
3994 "If you want to provide archive signatures in an archive under your "
3995 "maintenance you have to:"
3998 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
3999 #: apt-secure.8.xml:163
4001 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
4002 "already. You can do this by running <command>apt-ftparchive "
4003 "release</command> (provided in apt-utils)."
4006 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4007 #: apt-secure.8.xml:168
4009 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
4010 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
4011 "Release.gpg Release</command>."
4014 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4015 #: apt-secure.8.xml:172
4017 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
4018 "know what key they need to import in order to authenticate the files in the "
4022 #. type: Content of: <refentry><refsect1><para>
4023 #: apt-secure.8.xml:179
4025 "Whenever the contents of the archive changes (new packages are added or "
4026 "removed) the archive maintainer has to follow the first two steps previously "
4030 #. type: Content of: <refentry><refsect1><para>
4031 #: apt-secure.8.xml:187
4033 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
4034 "&debsign; &debsig-verify;, &gpg;"
4037 #. type: Content of: <refentry><refsect1><para>
4038 #: apt-secure.8.xml:191
4040 "For more background information you might want to review the <ulink "
4041 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7.en.html\">Debian "
4042 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
4043 "(available also in the harden-doc package) and the <ulink "
4044 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
4045 "Distribution HOWTO</ulink> by V. Alex Brennen."
4048 #. type: Content of: <refentry><refsect1><title>
4049 #: apt-secure.8.xml:204
4050 msgid "Manpage Authors"
4053 #. type: Content of: <refentry><refsect1><para>
4054 #: apt-secure.8.xml:206
4056 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
4057 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
4060 #. type: Content of: <refentry><refnamediv><refname>
4061 #: apt-sortpkgs.1.xml:25 apt-sortpkgs.1.xml:32
4062 msgid "apt-sortpkgs"
4065 #. type: Content of: <refentry><refnamediv><refpurpose>
4066 #: apt-sortpkgs.1.xml:33
4067 msgid "Utility to sort package index files"
4070 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
4071 #: apt-sortpkgs.1.xml:39
4073 "<command>apt-sortpkgs</command> <arg><option>-hvs</option></arg> "
4074 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
4075 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <arg "
4076 "choice=\"plain\" rep=\"repeat\"><replaceable>file</replaceable></arg>"
4079 #. type: Content of: <refentry><refsect1><para>
4080 #: apt-sortpkgs.1.xml:48
4082 "<command>apt-sortpkgs</command> will take an index file (Source index or "
4083 "Package index) and sort the records so that they are ordered by the package "
4084 "name. It will also sort the internal fields of each record according to the "
4085 "internal sorting rules."
4088 #. type: Content of: <refentry><refsect1><para>
4089 #: apt-sortpkgs.1.xml:54
4090 msgid "All output is sent to stdout, the input must be a seekable file."
4093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4094 #: apt-sortpkgs.1.xml:61
4095 msgid "<option>--source</option>"
4098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4099 #: apt-sortpkgs.1.xml:63
4101 "Use Source index field ordering. Configuration Item: "
4102 "<literal>APT::SortPkgs::Source</literal>."
4105 #. type: Content of: <refentry><refsect1><para>
4106 #: apt-sortpkgs.1.xml:77
4108 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
4112 #. The last update date
4113 #. type: Content of: <refentry><refentryinfo>
4114 #: apt.conf.5.xml:16
4116 "&apt-author.jgunthorpe; &apt-author.team; <author> "
4117 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
4118 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
4119 "</author> &apt-email; &apt-product; <date>16 January 2010</date>"
4122 #. type: Content of: <refentry><refnamediv><refname>
4123 #: apt.conf.5.xml:31 apt.conf.5.xml:38
4127 #. type: Content of: <refentry><refmeta><manvolnum>
4128 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
4132 #. type: Content of: <refentry><refnamediv><refpurpose>
4133 #: apt.conf.5.xml:39
4134 msgid "Configuration file for APT"
4137 #. type: Content of: <refentry><refsect1><para>
4138 #: apt.conf.5.xml:43
4140 "<filename>apt.conf</filename> is the main configuration file for the APT "
4141 "suite of tools, but by far not the only place changes to options can be "
4142 "made. All tools therefore share the configuration files and also use a "
4143 "common command line parser to provide a uniform environment."
4146 #. type: Content of: <refentry><refsect1><orderedlist><para>
4147 #: apt.conf.5.xml:48
4149 "When an APT tool starts up it will read the configuration files in the "
4153 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4154 #: apt.conf.5.xml:50
4156 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
4160 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4161 #: apt.conf.5.xml:52
4163 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
4164 "order which have no or \"<literal>conf</literal>\" as filename extension and "
4165 "which only contain alphanumeric, hyphen (-), underscore (_) and period (.) "
4166 "characters. Otherwise APT will print a notice that it has ignored a file if "
4167 "the file doesn't match a pattern in the "
4168 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
4169 "case it will be silently ignored."
4172 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4173 #: apt.conf.5.xml:59
4174 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
4177 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4178 #: apt.conf.5.xml:61
4180 "the command line options are applied to override the configuration "
4181 "directives or to load even more configuration files."
4184 #. type: Content of: <refentry><refsect1><title>
4185 #: apt.conf.5.xml:65
4189 #. type: Content of: <refentry><refsect1><para>
4190 #: apt.conf.5.xml:66
4192 "The configuration file is organized in a tree with options organized into "
4193 "functional groups. Option specification is given with a double colon "
4194 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
4195 "within the APT tool group, for the Get tool. Options do not inherit from "
4196 "their parent groups."
4199 #. type: Content of: <refentry><refsect1><para>
4200 #: apt.conf.5.xml:72
4202 "Syntactically the configuration language is modeled after what the ISC tools "
4203 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
4204 "treated as comments (ignored), as well as all text between "
4205 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
4206 "Each line is of the form <literal>APT::Get::Assume-Yes "
4207 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
4208 "value must be on one line, and there is no kind of string concatenation. It "
4209 "must not include inside quotes. The behavior of the backslash \"\\\" and "
4210 "escaped characters inside a value is undefined and it should not be used. An "
4211 "option name may include alphanumerical characters and the \"/-:._+\" "
4212 "characters. A new scope can be opened with curly braces, like:"
4215 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4216 #: apt.conf.5.xml:86
4221 " Assume-Yes \"true\";\n"
4222 " Fix-Broken \"true\";\n"
4227 #. type: Content of: <refentry><refsect1><para>
4228 #: apt.conf.5.xml:94
4230 "with newlines placed to make it more readable. Lists can be created by "
4231 "opening a scope and including a single string enclosed in quotes followed by "
4232 "a semicolon. Multiple entries can be included, each separated by a "
4236 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4237 #: apt.conf.5.xml:99
4239 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
4242 #. type: Content of: <refentry><refsect1><para>
4243 #: apt.conf.5.xml:102
4245 "In general the sample configuration file in "
4246 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
4247 "guide for how it should look."
4250 #. type: Content of: <refentry><refsect1><para>
4251 #: apt.conf.5.xml:106
4253 "The names of the configuration items are not case-sensitive. So in the "
4254 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
4257 #. type: Content of: <refentry><refsect1><para>
4258 #: apt.conf.5.xml:109
4260 "Names for the configuration items are optional if a list is defined as it "
4261 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
4262 "above. If you don't specify a name a new entry will simply add a new option "
4263 "to the list. If you specify a name you can override the option as every "
4264 "other option by reassigning a new value to the option."
4267 #. type: Content of: <refentry><refsect1><para>
4268 #: apt.conf.5.xml:114
4270 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
4271 "and not supported by alternative implementations) and "
4272 "<literal>#clear</literal>: <literal>#include</literal> will include the "
4273 "given file, unless the filename ends in a slash, then the whole directory is "
4274 "included. <literal>#clear</literal> is used to erase a part of the "
4275 "configuration tree. The specified element and all its descendants are "
4276 "erased. (Note that these lines also need to end with a semicolon.)"
4279 #. type: Content of: <refentry><refsect1><para>
4280 #: apt.conf.5.xml:122
4282 "The #clear command is the only way to delete a list or a complete scope. "
4283 "Reopening a scope or the ::-style described below will "
4284 "<emphasis>not</emphasis> override previously written entries. Only options "
4285 "can be overridden by addressing a new value to it - lists and scopes can't "
4286 "be overridden, only cleared."
4289 #. type: Content of: <refentry><refsect1><para>
4290 #: apt.conf.5.xml:127
4292 "All of the APT tools take a -o option which allows an arbitrary "
4293 "configuration directive to be specified on the command line. The syntax is a "
4294 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
4295 "followed by an equals sign then the new value of the option. Lists can be "
4296 "appended too by adding a trailing :: to the list name. (As you might "
4297 "suspect: The scope syntax can't be used on the command line.)"
4300 #. type: Content of: <refentry><refsect1><para>
4301 #: apt.conf.5.xml:134
4303 "Note that you can use :: only for appending one item per line to a list and "
4304 "that you should not use it in combination with the scope syntax. (The scope "
4305 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
4306 "which some users unfortunately relay on: An option with the unusual name "
4307 "\"<literal>::</literal>\" which acts like every other option with a "
4308 "name. These introduces many problems including that a user who writes "
4309 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
4310 "append to a list will gain the opposite as only the last assignment for this "
4311 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
4312 "raise errors and will stop working if they encounter this misuse, so please "
4313 "correct such statements now as long as APT doesn't complain explicit about "
4317 #. type: Content of: <refentry><refsect1><title>
4318 #: apt.conf.5.xml:146
4319 msgid "The APT Group"
4322 #. type: Content of: <refentry><refsect1><para>
4323 #: apt.conf.5.xml:147
4325 "This group of options controls general APT behavior as well as holding the "
4326 "options for all of the tools."
4329 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4330 #: apt.conf.5.xml:151
4331 msgid "Architecture"
4334 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4335 #: apt.conf.5.xml:152
4337 "System Architecture; sets the architecture to use when fetching files and "
4338 "parsing package lists. The internal default is the architecture apt was "
4342 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4343 #: apt.conf.5.xml:157
4344 msgid "Default-Release"
4347 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4348 #: apt.conf.5.xml:158
4350 "Default release to install packages from if more than one version "
4351 "available. Contains release name, codename or release version. Examples: "
4352 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
4353 "'4.0', '5.0*'. See also &apt-preferences;."
4356 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4357 #: apt.conf.5.xml:163
4361 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4362 #: apt.conf.5.xml:164
4364 "Ignore Held packages; This global option causes the problem resolver to "
4365 "ignore held packages in its decision making."
4368 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4369 #: apt.conf.5.xml:168
4370 msgid "Clean-Installed"
4373 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4374 #: apt.conf.5.xml:169
4376 "Defaults to on. When turned on the autoclean feature will remove any "
4377 "packages which can no longer be downloaded from the cache. If turned off "
4378 "then packages that are locally installed are also excluded from cleaning - "
4379 "but note that APT provides no direct means to reinstall them."
4382 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4383 #: apt.conf.5.xml:175
4384 msgid "Immediate-Configure"
4387 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4388 #: apt.conf.5.xml:176
4390 "Defaults to on which will cause APT to install essential and important "
4391 "packages as fast as possible in the install/upgrade operation. This is done "
4392 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
4393 "does treat an important package in the same way as an extra package: Between "
4394 "the unpacking of the important package A and his configuration can then be "
4395 "many other unpack or configuration calls, e.g. for package B which has no "
4396 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
4397 "script of package B generates an error) which results in a system state in "
4398 "which package A is unpacked but unconfigured - each package depending on A "
4399 "is now no longer guaranteed to work as their dependency on A is not longer "
4400 "satisfied. The immediate configuration marker is also applied to all "
4401 "dependencies which can generate a problem if the dependencies e.g. form a "
4402 "circle as a dependency with the immediate flag is comparable with a "
4403 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
4404 "in which it is unable to perform immediate configuration, errors out and "
4405 "refers to this option so the user can deactivate the immediate configuration "
4406 "temporarily to be able to perform an install/upgrade again. Note the use of "
4407 "the word \"theory\" here as this problem was only encountered by now in real "
4408 "world a few times in non-stable distribution versions and was caused by "
4409 "wrong dependencies of the package in question or by a system in an already "
4410 "broken state, so you should not blindly disable this option as the mentioned "
4411 "scenario above is not the only problem immediate configuration can help to "
4412 "prevent in the first place. Before a big operation like "
4413 "<literal>dist-upgrade</literal> is run with this option disabled it should "
4414 "be tried to explicitly <literal>install</literal> the package APT is unable "
4415 "to configure immediately, but please make sure to report your problem also "
4416 "to your distribution and to the APT team with the buglink below so they can "
4417 "work on improving or correcting the upgrade process."
4420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4421 #: apt.conf.5.xml:198
4422 msgid "Force-LoopBreak"
4425 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4426 #: apt.conf.5.xml:199
4428 "Never Enable this option unless you -really- know what you are doing. It "
4429 "permits APT to temporarily remove an essential package to break a "
4430 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
4431 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
4432 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
4433 "anything that those packages depend on."
4436 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4437 #: apt.conf.5.xml:207
4438 msgid "Cache-Start, Cache-Grow and Cache-Limit"
4441 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4442 #: apt.conf.5.xml:208
4444 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
4445 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
4446 "to which size the Cache will grow and is therefore the amount of memory APT "
4447 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
4448 "that these amount of space need to be available for APT otherwise it will "
4449 "likely fail ungracefully, so for memory restricted devices these value "
4450 "should be lowered while on systems with a lot of configured sources this "
4451 "might be increased. <literal>Cache-Grow</literal> defines in byte with the "
4452 "default of 1048576 (~1 MB) how much the Cache size will be increased in the "
4453 "event the space defined by <literal>Cache-Start</literal> is not "
4454 "enough. These value will be applied again and again until either the cache "
4455 "is big enough to store all information or the size of the cache reaches the "
4456 "<literal>Cache-Limit</literal>. The default of "
4457 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
4458 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
4462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4463 #: apt.conf.5.xml:223
4464 msgid "Build-Essential"
4467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4468 #: apt.conf.5.xml:224
4469 msgid "Defines which package(s) are considered essential build dependencies."
4472 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4473 #: apt.conf.5.xml:227
4477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4478 #: apt.conf.5.xml:228
4480 "The Get subsection controls the &apt-get; tool, please see its documentation "
4481 "for more information about the options here."
4484 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4485 #: apt.conf.5.xml:232
4489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4490 #: apt.conf.5.xml:233
4492 "The Cache subsection controls the &apt-cache; tool, please see its "
4493 "documentation for more information about the options here."
4496 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4497 #: apt.conf.5.xml:237
4501 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4502 #: apt.conf.5.xml:238
4504 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
4505 "documentation for more information about the options here."
4508 #. type: Content of: <refentry><refsect1><title>
4509 #: apt.conf.5.xml:244
4510 msgid "The Acquire Group"
4513 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4514 #: apt.conf.5.xml:249
4515 msgid "Check-Valid-Until"
4518 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4519 #: apt.conf.5.xml:250
4521 "Security related option defaulting to true as an expiring validation for a "
4522 "Release file prevents longtime replay attacks and can e.g. also help users "
4523 "to identify no longer updated mirrors - but the feature depends on the "
4524 "correctness of the time on the user system. Archive maintainers are "
4525 "encouraged to create Release files with the <literal>Valid-Until</literal> "
4526 "header, but if they don't or a stricter value is volitional the following "
4527 "<literal>Max-ValidTime</literal> option can be used."
4530 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4531 #: apt.conf.5.xml:260
4532 msgid "Max-ValidTime"
4535 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4536 #: apt.conf.5.xml:261
4538 "Seconds the Release file should be considered valid after it was "
4539 "created. The default is \"for ever\" (0) if the Release file of the archive "
4540 "doesn't include a <literal>Valid-Until</literal> header. If it does then "
4541 "this date is the default. The date from the Release file or the date "
4542 "specified by the creation time of the Release file (<literal>Date</literal> "
4543 "header) plus the seconds specified with this options are used to check if "
4544 "the validation of a file has expired by using the earlier date of the "
4545 "two. Archive specific settings can be made by appending the label of the "
4546 "archive to the option name."
4549 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4550 #: apt.conf.5.xml:273
4554 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4555 #: apt.conf.5.xml:274
4557 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
4558 "Sources files instead of downloading whole ones. True by default."
4561 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4562 #: apt.conf.5.xml:277
4564 "Two sub-options to limit the use of PDiffs are also available: With "
4565 "<literal>FileLimit</literal> can be specified how many PDiff files are "
4566 "downloaded at most to patch a file. <literal>SizeLimit</literal> on the "
4567 "other hand is the maximum precentage of the size of all patches compared to "
4568 "the size of the targeted file. If one of these limits is exceeded the "
4569 "complete file is downloaded instead of the patches."
4572 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4573 #: apt.conf.5.xml:286
4577 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4578 #: apt.conf.5.xml:287
4580 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
4581 "<literal>host</literal> or <literal>access</literal> which determines how "
4582 "APT parallelizes outgoing connections. <literal>host</literal> means that "
4583 "one connection per target host will be opened, <literal>access</literal> "
4584 "means that one connection per URI type will be opened."
4587 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4588 #: apt.conf.5.xml:294
4592 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4593 #: apt.conf.5.xml:295
4595 "Number of retries to perform. If this is non-zero APT will retry failed "
4596 "files the given number of times."
4599 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4600 #: apt.conf.5.xml:299
4601 msgid "Source-Symlinks"
4604 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4605 #: apt.conf.5.xml:300
4607 "Use symlinks for source archives. If set to true then source archives will "
4608 "be symlinked when possible instead of copying. True is the default."
4611 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4612 #: apt.conf.5.xml:304 sources.list.5.xml:144
4616 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4617 #: apt.conf.5.xml:305
4619 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
4620 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
4621 "host proxies can also be specified by using the form "
4622 "<literal>http::Proxy::<host></literal> with the special keyword "
4623 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4624 "settings is specified, <envar>http_proxy</envar> environment variable will "
4628 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4629 #: apt.conf.5.xml:313
4631 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
4632 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
4633 "response under any circumstances, <literal>Max-Age</literal> is sent only "
4634 "for index files and tells the cache to refresh its object if it is older "
4635 "than the given number of seconds. Debian updates its index files daily so "
4636 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
4637 "should never store this request, it is only set for archive files. This may "
4638 "be useful to prevent polluting a proxy cache with very large .deb "
4639 "files. Note: Squid 2.0.2 does not support any of these options."
4642 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4643 #: apt.conf.5.xml:323 apt.conf.5.xml:387
4645 "The option <literal>timeout</literal> sets the timeout timer used by the "
4646 "method, this applies to all things including connection timeout and data "
4650 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4651 #: apt.conf.5.xml:326
4653 "One setting is provided to control the pipeline depth in cases where the "
4654 "remote server is not RFC conforming or buggy (such as Squid 2.0.2). "
4655 "<literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5 "
4656 "indicating how many outstanding requests APT should send. A value of zero "
4657 "MUST be specified if the remote host does not properly linger on TCP "
4658 "connections - otherwise data corruption will occur. Hosts which require this "
4659 "are in violation of RFC 2068."
4662 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4663 #: apt.conf.5.xml:334
4665 "The used bandwidth can be limited with "
4666 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
4667 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
4668 "as much as possible of the bandwidth (Note that this option implicit "
4669 "deactivates the download from multiple servers at the same time.)"
4672 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4673 #: apt.conf.5.xml:339
4675 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
4676 "User-Agent for the http download method as some proxies allow access for "
4677 "clients only if the client uses a known identifier."
4680 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4681 #: apt.conf.5.xml:345
4685 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4686 #: apt.conf.5.xml:346
4688 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
4689 "options are the same as for <literal>http</literal> method and will also "
4690 "default to the options from the <literal>http</literal> method if they are "
4691 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
4692 "not supported yet."
4695 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4696 #: apt.conf.5.xml:352
4698 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
4699 "about trusted certificates. <literal><host>::CaInfo</literal> is "
4700 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
4701 "suboption determines whether verify server's host certificate against "
4702 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
4703 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
4704 "suboption determines whether verify server's hostname or not. "
4705 "<literal><host>::Verify-Host</literal> is corresponding per-host "
4706 "option. <literal>SslCert</literal> determines what certificate to use for "
4707 "client authentication. <literal><host>::SslCert</literal> is "
4708 "corresponding per-host option. <literal>SslKey</literal> determines what "
4709 "private key to use for client "
4710 "authentication. <literal><host>::SslKey</literal> is corresponding "
4711 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
4712 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
4713 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
4717 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4718 #: apt.conf.5.xml:370 sources.list.5.xml:155
4722 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4723 #: apt.conf.5.xml:371
4725 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
4726 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
4727 "proxies can also be specified by using the form "
4728 "<literal>ftp::Proxy::<host></literal> with the special keyword "
4729 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4730 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
4731 "used. To use a ftp proxy you will have to set the "
4732 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
4733 "entry specifies the commands to send to tell the proxy server what to "
4734 "connect to. Please see &configureindex; for an example of how to do "
4735 "this. The substitution variables available are "
4736 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
4737 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
4738 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
4739 "from it's respective URI component."
4742 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4743 #: apt.conf.5.xml:390
4745 "Several settings are provided to control passive mode. Generally it is safe "
4746 "to leave passive mode on, it works in nearly every environment. However "
4747 "some situations require that passive mode be disabled and port mode ftp used "
4748 "instead. This can be done globally, for connections that go through a proxy "
4749 "or for a specific host (See the sample config file for examples)."
4752 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4753 #: apt.conf.5.xml:397
4755 "It is possible to proxy FTP over HTTP by setting the "
4756 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
4757 "discussion of the http method above for syntax. You cannot set this in the "
4758 "configuration file and it is not recommended to use FTP over HTTP due to its "
4762 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4763 #: apt.conf.5.xml:402
4765 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
4766 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
4767 "false, which means these commands are only used if the control connection is "
4768 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
4769 "that most FTP servers do not support RFC2428."
4772 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4773 #: apt.conf.5.xml:409 sources.list.5.xml:137
4777 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4778 #: apt.conf.5.xml:415
4780 msgid "/cdrom/::Mount \"foo\";"
4783 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4784 #: apt.conf.5.xml:410
4786 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
4787 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
4788 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
4789 "provide alternate mount and unmount commands if your mount point cannot be "
4790 "listed in the fstab (such as an SMB mount and old mount packages). The "
4791 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
4792 "cdrom block. It is important to have the trailing slash. Unmount commands "
4793 "can be specified using UMount."
4796 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4797 #: apt.conf.5.xml:420
4801 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4802 #: apt.conf.5.xml:421
4804 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
4805 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
4809 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4810 #: apt.conf.5.xml:426
4811 msgid "CompressionTypes"
4814 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4815 #: apt.conf.5.xml:432
4818 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
4819 "\"<replaceable>Methodname</replaceable>\";"
4822 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4823 #: apt.conf.5.xml:427
4825 "List of compression types which are understood by the acquire methods. "
4826 "Files like <filename>Packages</filename> can be available in various "
4827 "compression formats. Per default the acquire methods can decompress "
4828 "<command>bzip2</command>, <command>lzma</command> and "
4829 "<command>gzip</command> compressed files, with this setting more formats can "
4830 "be added on the fly or the used method can be changed. The syntax for this "
4831 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
4834 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4835 #: apt.conf.5.xml:437
4837 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
4840 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4841 #: apt.conf.5.xml:440
4843 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
4846 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4847 #: apt.conf.5.xml:433
4849 "Also the <literal>Order</literal> subgroup can be used to define in which "
4850 "order the acquire system will try to download the compressed files. The "
4851 "acquire system will try the first and proceed with the next compression type "
4852 "in this list on error, so to prefer one over the other type simple add the "
4853 "preferred type at first - not already added default types will be added at "
4854 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
4855 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
4856 "over <command>bzip2</command> and <command>lzma</command>. If "
4857 "<command>lzma</command> should be preferred over <command>gzip</command> and "
4858 "<command>bzip2</command> the configure setting should look like this "
4859 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
4860 "<literal>bz2</literal> explicit to the list as it will be added automatic."
4863 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4864 #: apt.conf.5.xml:444
4866 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
4869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4870 #: apt.conf.5.xml:442
4872 "Note that at run time the "
4873 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
4874 "checked: If this setting exists the method will only be used if this file "
4875 "exists, e.g. for the bzip2 method (the inbuilt) setting is <placeholder "
4876 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
4877 "the command line will be added at the end of the list specified in the "
4878 "configuration files, but before the default entries. To prefer a type in "
4879 "this case over the ones specified in the configuration files you can set the "
4880 "option direct - not in list style. This will not override the defined list, "
4881 "it will only prefix the list with this type."
4884 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4885 #: apt.conf.5.xml:449
4887 "The special type <literal>uncompressed</literal> can be used to give "
4888 "uncompressed files a preference, but note that most archives doesn't provide "
4889 "uncompressed files so this is mostly only useable for local mirrors."
4892 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4893 #: apt.conf.5.xml:454
4897 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4898 #: apt.conf.5.xml:456
4900 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
4901 "Sources, or Translations), keep them gzip compressed locally instead of "
4902 "unpacking them. This saves quite a lot of disk space at the expense of more "
4903 "CPU requirements when building the local package caches. False by default."
4906 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4907 #: apt.conf.5.xml:463
4911 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4912 #: apt.conf.5.xml:464
4914 "The Languages subsection controls which <filename>Translation</filename> "
4915 "files are downloaded and in which order APT tries to display the "
4916 "Description-Translations. APT will try to display the first available "
4917 "Description in the Language which is listed at first. Languages can be "
4918 "defined with their short or long Languagecodes. Note that not all archives "
4919 "provide <filename>Translation</filename> files for every Language - "
4920 "especially the long Languagecodes are rare, so please inform you which ones "
4921 "are available before you set here impossible values."
4924 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
4925 #: apt.conf.5.xml:480
4927 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
4930 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4931 #: apt.conf.5.xml:470
4933 "The default list includes \"environment\" and "
4934 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
4935 "will be replaced at runtime with the languagecodes extracted from the "
4936 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
4937 "that these codes are not included twice in the list. If "
4938 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
4939 "<filename>Translation-en</filename> file (if available) will be used. To "
4940 "force apt to use no Translation file use the setting "
4941 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
4942 "another special meaning code which will stop the search for a fitting "
4943 "<filename>Translation</filename> file. This can be used by the system "
4944 "administrator to let APT know that it should download also this files "
4945 "without actually use them if the environment doesn't specify this "
4946 "languages. So the following example configuration will result in the order "
4947 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
4948 "that \"fr\" is downloaded, but not used if APT is not used in a french "
4949 "localization, in such an environment the order would be \"fr, de, en\". "
4950 "<placeholder type=\"programlisting\" id=\"0\"/>"
4953 #. type: Content of: <refentry><refsect1><para>
4954 #: apt.conf.5.xml:245
4956 "The <literal>Acquire</literal> group of options controls the download of "
4957 "packages and the URI handlers. <placeholder type=\"variablelist\" "
4961 #. type: Content of: <refentry><refsect1><title>
4962 #: apt.conf.5.xml:487
4966 #. type: Content of: <refentry><refsect1><para>
4967 #: apt.conf.5.xml:489
4969 "The <literal>Dir::State</literal> section has directories that pertain to "
4970 "local state information. <literal>lists</literal> is the directory to place "
4971 "downloaded package lists in and <literal>status</literal> is the name of the "
4972 "dpkg status file. <literal>preferences</literal> is the name of the APT "
4973 "preferences file. <literal>Dir::State</literal> contains the default "
4974 "directory to prefix on all sub items if they do not start with "
4975 "<filename>/</filename> or <filename>./</filename>."
4978 #. type: Content of: <refentry><refsect1><para>
4979 #: apt.conf.5.xml:496
4981 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
4982 "information, such as the two package caches <literal>srcpkgcache</literal> "
4983 "and <literal>pkgcache</literal> as well as the location to place downloaded "
4984 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
4985 "be turned off by setting their names to be blank. This will slow down "
4986 "startup but save disk space. It is probably preferred to turn off the "
4987 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
4988 "default directory is contained in <literal>Dir::Cache</literal>"
4991 #. type: Content of: <refentry><refsect1><para>
4992 #: apt.conf.5.xml:505
4994 "<literal>Dir::Etc</literal> contains the location of configuration files, "
4995 "<literal>sourcelist</literal> gives the location of the sourcelist and "
4996 "<literal>main</literal> is the default configuration file (setting has no "
4997 "effect, unless it is done from the config file specified by "
4998 "<envar>APT_CONFIG</envar>)."
5001 #. type: Content of: <refentry><refsect1><para>
5002 #: apt.conf.5.xml:511
5004 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
5005 "in lexical order from the directory specified. After this is done then the "
5006 "main config file is loaded."
5009 #. type: Content of: <refentry><refsect1><para>
5010 #: apt.conf.5.xml:515
5012 "Binary programs are pointed to by "
5013 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
5014 "the location of the method handlers and <literal>gzip</literal>, "
5015 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
5016 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
5017 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
5018 "specify the location of the respective programs."
5021 #. type: Content of: <refentry><refsect1><para>
5022 #: apt.conf.5.xml:523
5024 "The configuration item <literal>RootDir</literal> has a special meaning. If "
5025 "set, all paths in <literal>Dir::</literal> will be relative to "
5026 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
5027 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
5028 "set to <filename>/tmp/staging</filename> and "
5029 "<literal>Dir::State::status</literal> is set to "
5030 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
5031 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
5034 #. type: Content of: <refentry><refsect1><para>
5035 #: apt.conf.5.xml:536
5037 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
5038 "which files APT should silently ignore while parsing the files in the "
5039 "fragment directories. Per default a file which end with "
5040 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
5041 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
5042 "default value these patterns can use regular expression syntax."
5045 #. type: Content of: <refentry><refsect1><title>
5046 #: apt.conf.5.xml:545
5047 msgid "APT in DSelect"
5050 #. type: Content of: <refentry><refsect1><para>
5051 #: apt.conf.5.xml:547
5053 "When APT is used as a &dselect; method several configuration directives "
5054 "control the default behaviour. These are in the <literal>DSelect</literal> "
5058 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5059 #: apt.conf.5.xml:551
5063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5064 #: apt.conf.5.xml:552
5066 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
5067 "and never. always and prompt will remove all packages from the cache after "
5068 "upgrading, prompt (the default) does so conditionally. auto removes only "
5069 "those packages which are no longer downloadable (replaced with a new version "
5070 "for instance). pre-auto performs this action before downloading new "
5074 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5075 #: apt.conf.5.xml:561
5077 "The contents of this variable is passed to &apt-get; as command line options "
5078 "when it is run for the install phase."
5081 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5082 #: apt.conf.5.xml:565
5083 msgid "Updateoptions"
5086 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5087 #: apt.conf.5.xml:566
5089 "The contents of this variable is passed to &apt-get; as command line options "
5090 "when it is run for the update phase."
5093 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5094 #: apt.conf.5.xml:570
5095 msgid "PromptAfterUpdate"
5098 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5099 #: apt.conf.5.xml:571
5101 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
5102 "The default is to prompt only on error."
5105 #. type: Content of: <refentry><refsect1><title>
5106 #: apt.conf.5.xml:577
5107 msgid "How APT calls dpkg"
5110 #. type: Content of: <refentry><refsect1><para>
5111 #: apt.conf.5.xml:578
5113 "Several configuration directives control how APT invokes &dpkg;. These are "
5114 "in the <literal>DPkg</literal> section."
5117 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5118 #: apt.conf.5.xml:583
5120 "This is a list of options to pass to dpkg. The options must be specified "
5121 "using the list notation and each list item is passed as a single argument to "
5125 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5126 #: apt.conf.5.xml:588
5130 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5131 #: apt.conf.5.xml:588
5135 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5136 #: apt.conf.5.xml:589
5138 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
5139 "<literal>options</literal> this must be specified in list notation. The "
5140 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5141 "fail APT will abort."
5144 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5145 #: apt.conf.5.xml:595
5146 msgid "Pre-Install-Pkgs"
5149 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5150 #: apt.conf.5.xml:596
5152 "This is a list of shell commands to run before invoking dpkg. Like "
5153 "<literal>options</literal> this must be specified in list notation. The "
5154 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5155 "fail APT will abort. APT will pass to the commands on standard input the "
5156 "filenames of all .deb files it is going to install, one per line."
5159 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5160 #: apt.conf.5.xml:602
5162 "Version 2 of this protocol dumps more information, including the protocol "
5163 "version, the APT configuration space and the packages, files and versions "
5164 "being changed. Version 2 is enabled by setting "
5165 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
5166 "2. <literal>cmd</literal> is a command given to "
5167 "<literal>Pre-Install-Pkgs</literal>."
5170 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5171 #: apt.conf.5.xml:609
5172 msgid "Run-Directory"
5175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5176 #: apt.conf.5.xml:610
5178 "APT chdirs to this directory before invoking dpkg, the default is "
5179 "<filename>/</filename>."
5182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5183 #: apt.conf.5.xml:614
5184 msgid "Build-options"
5187 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5188 #: apt.conf.5.xml:615
5190 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
5191 "default is to disable signing and produce all binaries."
5194 #. type: Content of: <refentry><refsect1><refsect2><title>
5195 #: apt.conf.5.xml:620
5196 msgid "dpkg trigger usage (and related options)"
5199 #. type: Content of: <refentry><refsect1><refsect2><para>
5200 #: apt.conf.5.xml:621
5202 "APT can call dpkg in a way so it can make aggressive use of triggers over "
5203 "multiple calls of dpkg. Without further options dpkg will use triggers only "
5204 "in between his own run. Activating these options can therefore decrease the "
5205 "time needed to perform the install / upgrade. Note that it is intended to "
5206 "activate these options per default in the future, but as it changes the way "
5207 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
5208 "options are therefore currently experimental and should not be used in "
5209 "productive environments.</emphasis> Also it breaks the progress reporting so "
5210 "all frontends will currently stay around half (or more) of the time in the "
5211 "100% state while it actually configures all packages."
5214 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
5215 #: apt.conf.5.xml:636
5218 "DPkg::NoTriggers \"true\";\n"
5219 "PackageManager::Configure \"smart\";\n"
5220 "DPkg::ConfigurePending \"true\";\n"
5221 "DPkg::TriggersPending \"true\";"
5224 #. type: Content of: <refentry><refsect1><refsect2><para>
5225 #: apt.conf.5.xml:630
5227 "Note that it is not guaranteed that APT will support these options or that "
5228 "these options will not cause (big) trouble in the future. If you have "
5229 "understand the current risks and problems with these options, but are brave "
5230 "enough to help testing them create a new configuration file and test a "
5231 "combination of options. Please report any bugs, problems and improvements "
5232 "you encounter and make sure to note which options you have used in your "
5233 "reports. Asking dpkg for help could also be useful for debugging proposes, "
5234 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
5235 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
5238 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5239 #: apt.conf.5.xml:642
5240 msgid "DPkg::NoTriggers"
5243 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5244 #: apt.conf.5.xml:643
5246 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
5247 "call). See &dpkg; if you are interested in what this actually means. In "
5248 "short: dpkg will not run the triggers when this flag is present unless it is "
5249 "explicitly called to do so in an extra call. Note that this option exists "
5250 "(undocumented) also in older apt versions with a slightly different meaning: "
5251 "Previously these option only append --no-triggers to the configure calls to "
5252 "dpkg - now apt will add these flag also to the unpack and remove calls."
5255 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5256 #: apt.conf.5.xml:650
5257 msgid "PackageManager::Configure"
5260 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5261 #: apt.conf.5.xml:651
5263 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
5264 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
5265 "value and causes APT to configure all packages explicit. The "
5266 "\"<literal>smart</literal>\" way is it to configure only packages which need "
5267 "to be configured before another package can be unpacked (Pre-Depends) and "
5268 "let the rest configure by dpkg with a call generated by the next "
5269 "option. \"<literal>no</literal>\" on the other hand will not configure "
5270 "anything and totally rely on dpkg for configuration (which will at the "
5271 "moment fail if a Pre-Depends is encountered). Setting this option to "
5272 "another than the all value will implicitly activate also the next option per "
5273 "default as otherwise the system could end in an unconfigured status which "
5274 "could be unbootable!"
5277 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5278 #: apt.conf.5.xml:661
5279 msgid "DPkg::ConfigurePending"
5282 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5283 #: apt.conf.5.xml:662
5285 "If this option is set apt will call <command>dpkg --configure "
5286 "--pending</command> to let dpkg handle all required configurations and "
5287 "triggers. This option is activated automatic per default if the previous "
5288 "option is not set to <literal>all</literal>, but deactivating could be "
5289 "useful if you want to run APT multiple times in a row - e.g. in an "
5290 "installer. In these sceneries you could deactivate this option in all but "
5294 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5295 #: apt.conf.5.xml:668
5296 msgid "DPkg::TriggersPending"
5299 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5300 #: apt.conf.5.xml:669
5302 "Useful for <literal>smart</literal> configuration as a package which has "
5303 "pending triggers is not considered as <literal>installed</literal> and dpkg "
5304 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
5305 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
5306 "triggers, not only the triggers needed to configure this package."
5309 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5310 #: apt.conf.5.xml:674
5311 msgid "PackageManager::UnpackAll"
5314 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5315 #: apt.conf.5.xml:675
5317 "As the configuration can be deferred to be done at the end by dpkg it can be "
5318 "tried to order the unpack series only by critical needs, e.g. by "
5319 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
5320 "various steps by everything. While both method were present in earlier APT "
5321 "versions the <literal>OrderCritical</literal> method was unused, so this "
5322 "method is very experimental and needs further improvements before becoming "
5326 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5327 #: apt.conf.5.xml:682
5328 msgid "OrderList::Score::Immediate"
5331 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
5332 #: apt.conf.5.xml:690
5335 "OrderList::Score {\n"
5337 "\tEssential 200;\n"
5339 "\tPreDepends 50;\n"
5343 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5344 #: apt.conf.5.xml:683
5346 "Essential packages (and there dependencies) should be configured immediately "
5347 "after unpacking. It will be a good idea to do this quite early in the "
5348 "upgrade process as these these configure calls require currently also "
5349 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
5350 "(which maybe not needed). Essentials get per default a high score but the "
5351 "immediate flag is relatively low (a package which has a Pre-Depends is "
5352 "higher rated). These option and the others in the same group can be used to "
5353 "change the scoring. The following example shows the settings with there "
5354 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
5357 #. type: Content of: <refentry><refsect1><title>
5358 #: apt.conf.5.xml:703
5359 msgid "Periodic and Archives options"
5362 #. type: Content of: <refentry><refsect1><para>
5363 #: apt.conf.5.xml:704
5365 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
5366 "of options configure behavior of apt periodic updates, which is done by "
5367 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
5368 "the brief documentation of these options."
5371 #. type: Content of: <refentry><refsect1><title>
5372 #: apt.conf.5.xml:712
5373 msgid "Debug options"
5376 #. type: Content of: <refentry><refsect1><para>
5377 #: apt.conf.5.xml:714
5379 "Enabling options in the <literal>Debug::</literal> section will cause "
5380 "debugging information to be sent to the standard error stream of the program "
5381 "utilizing the <literal>apt</literal> libraries, or enable special program "
5382 "modes that are primarily useful for debugging the behavior of "
5383 "<literal>apt</literal>. Most of these options are not interesting to a "
5384 "normal user, but a few may be:"
5387 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5388 #: apt.conf.5.xml:725
5390 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
5391 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
5395 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5396 #: apt.conf.5.xml:733
5398 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
5399 "used to run some operations (for instance, <literal>apt-get -s "
5400 "install</literal>) as a non-root user."
5403 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5404 #: apt.conf.5.xml:742
5406 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
5407 "time that <literal>apt</literal> invokes &dpkg;."
5411 #. motivating example, except I haven't a clue why you'd want
5413 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5414 #: apt.conf.5.xml:750
5416 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
5420 #. type: Content of: <refentry><refsect1><para>
5421 #: apt.conf.5.xml:760
5422 msgid "A full list of debugging options to apt follows."
5425 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5426 #: apt.conf.5.xml:765
5427 msgid "<literal>Debug::Acquire::cdrom</literal>"
5430 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5431 #: apt.conf.5.xml:769
5432 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
5435 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5436 #: apt.conf.5.xml:776
5437 msgid "<literal>Debug::Acquire::ftp</literal>"
5440 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5441 #: apt.conf.5.xml:780
5442 msgid "Print information related to downloading packages using FTP."
5445 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5446 #: apt.conf.5.xml:787
5447 msgid "<literal>Debug::Acquire::http</literal>"
5450 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5451 #: apt.conf.5.xml:791
5452 msgid "Print information related to downloading packages using HTTP."
5455 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5456 #: apt.conf.5.xml:798
5457 msgid "<literal>Debug::Acquire::https</literal>"
5460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5461 #: apt.conf.5.xml:802
5462 msgid "Print information related to downloading packages using HTTPS."
5465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5466 #: apt.conf.5.xml:809
5467 msgid "<literal>Debug::Acquire::gpgv</literal>"
5470 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5471 #: apt.conf.5.xml:813
5473 "Print information related to verifying cryptographic signatures using "
5474 "<literal>gpg</literal>."
5477 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5478 #: apt.conf.5.xml:820
5479 msgid "<literal>Debug::aptcdrom</literal>"
5482 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5483 #: apt.conf.5.xml:824
5485 "Output information about the process of accessing collections of packages "
5486 "stored on CD-ROMs."
5489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5490 #: apt.conf.5.xml:831
5491 msgid "<literal>Debug::BuildDeps</literal>"
5494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5495 #: apt.conf.5.xml:834
5496 msgid "Describes the process of resolving build-dependencies in &apt-get;."
5499 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5500 #: apt.conf.5.xml:841
5501 msgid "<literal>Debug::Hashes</literal>"
5504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5505 #: apt.conf.5.xml:844
5507 "Output each cryptographic hash that is generated by the "
5508 "<literal>apt</literal> libraries."
5511 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5512 #: apt.conf.5.xml:851
5513 msgid "<literal>Debug::IdentCDROM</literal>"
5516 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5517 #: apt.conf.5.xml:854
5519 "Do not include information from <literal>statfs</literal>, namely the number "
5520 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
5524 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5525 #: apt.conf.5.xml:862
5526 msgid "<literal>Debug::NoLocking</literal>"
5529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5530 #: apt.conf.5.xml:865
5532 "Disable all file locking. For instance, this will allow two instances of "
5533 "<quote><literal>apt-get update</literal></quote> to run at the same time."
5536 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5537 #: apt.conf.5.xml:873
5538 msgid "<literal>Debug::pkgAcquire</literal>"
5541 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5542 #: apt.conf.5.xml:877
5543 msgid "Log when items are added to or removed from the global download queue."
5546 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5547 #: apt.conf.5.xml:884
5548 msgid "<literal>Debug::pkgAcquire::Auth</literal>"
5551 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5552 #: apt.conf.5.xml:887
5554 "Output status messages and errors related to verifying checksums and "
5555 "cryptographic signatures of downloaded files."
5558 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5559 #: apt.conf.5.xml:894
5560 msgid "<literal>Debug::pkgAcquire::Diffs</literal>"
5563 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5564 #: apt.conf.5.xml:897
5566 "Output information about downloading and applying package index list diffs, "
5567 "and errors relating to package index list diffs."
5570 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5571 #: apt.conf.5.xml:905
5572 msgid "<literal>Debug::pkgAcquire::RRed</literal>"
5575 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5576 #: apt.conf.5.xml:909
5578 "Output information related to patching apt package lists when downloading "
5579 "index diffs instead of full indices."
5582 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5583 #: apt.conf.5.xml:916
5584 msgid "<literal>Debug::pkgAcquire::Worker</literal>"
5587 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5588 #: apt.conf.5.xml:920
5589 msgid "Log all interactions with the sub-processes that actually perform downloads."
5592 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5593 #: apt.conf.5.xml:927
5594 msgid "<literal>Debug::pkgAutoRemove</literal>"
5597 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5598 #: apt.conf.5.xml:931
5600 "Log events related to the automatically-installed status of packages and to "
5601 "the removal of unused packages."
5604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5605 #: apt.conf.5.xml:938
5606 msgid "<literal>Debug::pkgDepCache::AutoInstall</literal>"
5609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5610 #: apt.conf.5.xml:941
5612 "Generate debug messages describing which packages are being automatically "
5613 "installed to resolve dependencies. This corresponds to the initial "
5614 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
5615 "and not to the full <literal>apt</literal> dependency resolver; see "
5616 "<literal>Debug::pkgProblemResolver</literal> for that."
5619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5620 #: apt.conf.5.xml:952
5621 msgid "<literal>Debug::pkgDepCache::Marker</literal>"
5624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5625 #: apt.conf.5.xml:955
5627 "Generate debug messages describing which package is marked as "
5628 "keep/install/remove while the ProblemResolver does his work. Each addition "
5629 "or deletion may trigger additional actions; they are shown indented two "
5630 "additional space under the original entry. The format for each line is "
5631 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
5632 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
5633 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
5634 "is the current version of the package, <literal>d.e.f</literal> is the "
5635 "version considered for installation and <literal>x.y.z</literal> is a newer "
5636 "version, but not considered for installation (because of a low pin "
5637 "score). The later two can be omitted if there is none or if it is the same "
5638 "version as the installed. <literal>section</literal> is the name of the "
5639 "section the package appears in."
5642 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5643 #: apt.conf.5.xml:974
5644 msgid "<literal>Debug::pkgInitConfig</literal>"
5647 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5648 #: apt.conf.5.xml:977
5649 msgid "Dump the default configuration to standard error on startup."
5652 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5653 #: apt.conf.5.xml:984
5654 msgid "<literal>Debug::pkgDPkgPM</literal>"
5657 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5658 #: apt.conf.5.xml:987
5660 "When invoking &dpkg;, output the precise command line with which it is being "
5661 "invoked, with arguments separated by a single space character."
5664 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5665 #: apt.conf.5.xml:995
5666 msgid "<literal>Debug::pkgDPkgProgressReporting</literal>"
5669 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5670 #: apt.conf.5.xml:998
5672 "Output all the data received from &dpkg; on the status file descriptor and "
5673 "any errors encountered while parsing it."
5676 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5677 #: apt.conf.5.xml:1005
5678 msgid "<literal>Debug::pkgOrderList</literal>"
5681 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5682 #: apt.conf.5.xml:1009
5684 "Generate a trace of the algorithm that decides the order in which "
5685 "<literal>apt</literal> should pass packages to &dpkg;."
5688 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5689 #: apt.conf.5.xml:1017
5690 msgid "<literal>Debug::pkgPackageManager</literal>"
5693 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5694 #: apt.conf.5.xml:1021
5695 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
5698 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5699 #: apt.conf.5.xml:1028
5700 msgid "<literal>Debug::pkgPolicy</literal>"
5703 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5704 #: apt.conf.5.xml:1032
5705 msgid "Output the priority of each package list on startup."
5708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5709 #: apt.conf.5.xml:1038
5710 msgid "<literal>Debug::pkgProblemResolver</literal>"
5713 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5714 #: apt.conf.5.xml:1042
5716 "Trace the execution of the dependency resolver (this applies only to what "
5717 "happens when a complex dependency problem is encountered)."
5720 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5721 #: apt.conf.5.xml:1050
5722 msgid "<literal>Debug::pkgProblemResolver::ShowScores</literal>"
5725 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5726 #: apt.conf.5.xml:1053
5728 "Display a list of all installed packages with their calculated score used by "
5729 "the pkgProblemResolver. The description of the package is the same as "
5730 "described in <literal>Debug::pkgDepCache::Marker</literal>"
5733 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5734 #: apt.conf.5.xml:1061
5735 msgid "<literal>Debug::sourceList</literal>"
5738 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5739 #: apt.conf.5.xml:1065
5741 "Print information about the vendors read from "
5742 "<filename>/etc/apt/vendors.list</filename>."
5745 #. type: Content of: <refentry><refsect1><para>
5746 #: apt.conf.5.xml:1088
5748 "&configureindex; is a configuration file showing example values for all "
5752 #. type: Content of: <refentry><refsect1><variablelist>
5753 #: apt.conf.5.xml:1095
5754 msgid "&file-aptconf;"
5757 #. ? reading apt.conf
5758 #. type: Content of: <refentry><refsect1><para>
5759 #: apt.conf.5.xml:1100
5760 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
5763 #. The last update date
5764 #. type: Content of: <refentry><refentryinfo>
5765 #: apt_preferences.5.xml:16
5766 msgid "&apt-author.team; &apt-email; &apt-product; <date>16 February 2010</date>"
5769 #. type: Content of: <refentry><refnamediv><refname>
5770 #: apt_preferences.5.xml:24 apt_preferences.5.xml:31
5771 msgid "apt_preferences"
5774 #. type: Content of: <refentry><refnamediv><refpurpose>
5775 #: apt_preferences.5.xml:32
5776 msgid "Preference control file for APT"
5779 #. type: Content of: <refentry><refsect1><para>
5780 #: apt_preferences.5.xml:37
5782 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
5783 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
5784 "can be used to control which versions of packages will be selected for "
5788 #. type: Content of: <refentry><refsect1><para>
5789 #: apt_preferences.5.xml:42
5791 "Several versions of a package may be available for installation when the "
5792 "&sources-list; file contains references to more than one distribution (for "
5793 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
5794 "assigns a priority to each version that is available. Subject to dependency "
5795 "constraints, <command>apt-get</command> selects the version with the highest "
5796 "priority for installation. The APT preferences file overrides the "
5797 "priorities that APT assigns to package versions by default, thus giving the "
5798 "user control over which one is selected for installation."
5801 #. type: Content of: <refentry><refsect1><para>
5802 #: apt_preferences.5.xml:52
5804 "Several instances of the same version of a package may be available when the "
5805 "&sources-list; file contains references to more than one source. In this "
5806 "case <command>apt-get</command> downloads the instance listed earliest in "
5807 "the &sources-list; file. The APT preferences file does not affect the "
5808 "choice of instance, only the choice of version."
5811 #. type: Content of: <refentry><refsect1><para>
5812 #: apt_preferences.5.xml:59
5814 "Preferences are a strong power in the hands of a system administrator but "
5815 "they can become also their biggest nightmare if used without care! APT will "
5816 "not questioning the preferences so wrong settings will therefore lead to "
5817 "uninstallable packages or wrong decisions while upgrading packages. Even "
5818 "more problems will arise if multiply distribution releases are mixed without "
5819 "a good understanding of the following paragraphs. Packages included in a "
5820 "specific release aren't tested in and therefore doesn't always work as "
5821 "expected in older or newer releases or together with other packages from "
5822 "different releases. You have been warned."
5825 #. type: Content of: <refentry><refsect1><para>
5826 #: apt_preferences.5.xml:70
5828 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
5829 "directory are parsed in alphanumeric ascending order and need to obey the "
5830 "following naming convention: The files have no or "
5831 "\"<literal>pref</literal>\" as filename extension and which only contain "
5832 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
5833 "Otherwise APT will print a notice that it has ignored a file if the file "
5834 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5835 "configuration list - in this case it will be silently ignored."
5838 #. type: Content of: <refentry><refsect1><refsect2><title>
5839 #: apt_preferences.5.xml:79
5840 msgid "APT's Default Priority Assignments"
5843 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5844 #: apt_preferences.5.xml:94
5847 "<command>apt-get install -t testing "
5848 "<replaceable>some-package</replaceable></command>\n"
5851 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5852 #: apt_preferences.5.xml:97
5854 msgid "APT::Default-Release \"stable\";\n"
5857 #. type: Content of: <refentry><refsect1><refsect2><para>
5858 #: apt_preferences.5.xml:81
5860 "If there is no preferences file or if there is no entry in the file that "
5861 "applies to a particular version then the priority assigned to that version "
5862 "is the priority of the distribution to which that version belongs. It is "
5863 "possible to single out a distribution, \"the target release\", which "
5864 "receives a higher priority than other distributions do by default. The "
5865 "target release can be set on the <command>apt-get</command> command line or "
5866 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
5867 "that this has precedence over any general priority you set in the "
5868 "<filename>/etc/apt/preferences</filename> file described later, but not over "
5869 "specifically pinned packages. For example, <placeholder "
5870 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
5874 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5875 #: apt_preferences.5.xml:106
5879 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5880 #: apt_preferences.5.xml:107
5882 "to the versions coming from archives which in their "
5883 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
5884 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
5885 "<literal>experimental</literal> archive."
5888 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5889 #: apt_preferences.5.xml:113
5890 msgid "priority 100"
5893 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5894 #: apt_preferences.5.xml:114
5896 "to the version that is already installed (if any) and to the versions coming "
5897 "from archives which in their <filename>Release</filename> files are marked "
5898 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
5899 "backports archive since <literal>squeeze-backports</literal>."
5902 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5903 #: apt_preferences.5.xml:121
5904 msgid "priority 500"
5907 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5908 #: apt_preferences.5.xml:122
5910 "to the versions that are not installed and do not belong to the target "
5914 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5915 #: apt_preferences.5.xml:126
5916 msgid "priority 990"
5919 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5920 #: apt_preferences.5.xml:127
5921 msgid "to the versions that are not installed and belong to the target release."
5924 #. type: Content of: <refentry><refsect1><refsect2><para>
5925 #: apt_preferences.5.xml:101
5927 "If the target release has been specified then APT uses the following "
5928 "algorithm to set the priorities of the versions of a package. Assign: "
5929 "<placeholder type=\"variablelist\" id=\"0\"/>"
5932 #. type: Content of: <refentry><refsect1><refsect2><para>
5933 #: apt_preferences.5.xml:132
5935 "If the target release has not been specified then APT simply assigns "
5936 "priority 100 to all installed package versions and priority 500 to all "
5937 "uninstalled package versions, except versions coming from archives which in "
5938 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
5939 "- these versions get the priority 1 or priority 100 if it is additionally "
5940 "marked as \"ButAutomaticUpgrades: yes\"."
5943 #. type: Content of: <refentry><refsect1><refsect2><para>
5944 #: apt_preferences.5.xml:139
5946 "APT then applies the following rules, listed in order of precedence, to "
5947 "determine which version of a package to install."
5950 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5951 #: apt_preferences.5.xml:142
5953 "Never downgrade unless the priority of an available version exceeds 1000. "
5954 "(\"Downgrading\" is installing a less recent version of a package in place "
5955 "of a more recent version. Note that none of APT's default priorities "
5956 "exceeds 1000; such high priorities can only be set in the preferences file. "
5957 "Note also that downgrading a package can be risky.)"
5960 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5961 #: apt_preferences.5.xml:148
5962 msgid "Install the highest priority version."
5965 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5966 #: apt_preferences.5.xml:149
5968 "If two or more versions have the same priority, install the most recent one "
5969 "(that is, the one with the higher version number)."
5972 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
5973 #: apt_preferences.5.xml:152
5975 "If two or more versions have the same priority and version number but either "
5976 "the packages differ in some of their metadata or the "
5977 "<literal>--reinstall</literal> option is given, install the uninstalled one."
5980 #. type: Content of: <refentry><refsect1><refsect2><para>
5981 #: apt_preferences.5.xml:158
5983 "In a typical situation, the installed version of a package (priority 100) "
5984 "is not as recent as one of the versions available from the sources listed in "
5985 "the &sources-list; file (priority 500 or 990). Then the package will be "
5986 "upgraded when <command>apt-get install "
5987 "<replaceable>some-package</replaceable></command> or <command>apt-get "
5988 "upgrade</command> is executed."
5991 #. type: Content of: <refentry><refsect1><refsect2><para>
5992 #: apt_preferences.5.xml:165
5994 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
5995 "recent than any of the other available versions. The package will not be "
5996 "downgraded when <command>apt-get install "
5997 "<replaceable>some-package</replaceable></command> or <command>apt-get "
5998 "upgrade</command> is executed."
6001 #. type: Content of: <refentry><refsect1><refsect2><para>
6002 #: apt_preferences.5.xml:170
6004 "Sometimes the installed version of a package is more recent than the version "
6005 "belonging to the target release, but not as recent as a version belonging to "
6006 "some other distribution. Such a package will indeed be upgraded when "
6007 "<command>apt-get install <replaceable>some-package</replaceable></command> "
6008 "or <command>apt-get upgrade</command> is executed, because at least "
6009 "<emphasis>one</emphasis> of the available versions has a higher priority "
6010 "than the installed version."
6013 #. type: Content of: <refentry><refsect1><refsect2><title>
6014 #: apt_preferences.5.xml:179
6015 msgid "The Effect of APT Preferences"
6018 #. type: Content of: <refentry><refsect1><refsect2><para>
6019 #: apt_preferences.5.xml:181
6021 "The APT preferences file allows the system administrator to control the "
6022 "assignment of priorities. The file consists of one or more multi-line "
6023 "records separated by blank lines. Records can have one of two forms, a "
6024 "specific form and a general form."
6027 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6028 #: apt_preferences.5.xml:187
6030 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
6031 "specified packages and specified version or version range. For example, the "
6032 "following record assigns a high priority to all versions of the "
6033 "<filename>perl</filename> package whose version number begins with "
6034 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
6037 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6038 #: apt_preferences.5.xml:194
6042 "Pin: version 5.8*\n"
6043 "Pin-Priority: 1001\n"
6046 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6047 #: apt_preferences.5.xml:200
6049 "The general form assigns a priority to all of the package versions in a "
6050 "given distribution (that is, to all the versions of packages that are listed "
6051 "in a certain <filename>Release</filename> file) or to all of the package "
6052 "versions coming from a particular Internet site, as identified by the site's "
6053 "fully qualified domain name."
6056 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6057 #: apt_preferences.5.xml:206
6059 "This general-form entry in the APT preferences file applies only to groups "
6060 "of packages. For example, the following record assigns a high priority to "
6061 "all package versions available from the local site."
6064 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6065 #: apt_preferences.5.xml:211
6069 "Pin: origin \"\"\n"
6070 "Pin-Priority: 999\n"
6073 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6074 #: apt_preferences.5.xml:216
6076 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
6077 "which can be used to match a hostname. The following record will assign a "
6078 "high priority to all versions available from the server identified by the "
6079 "hostname \"ftp.de.debian.org\""
6082 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6083 #: apt_preferences.5.xml:220
6087 "Pin: origin \"ftp.de.debian.org\"\n"
6088 "Pin-Priority: 999\n"
6091 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6092 #: apt_preferences.5.xml:224
6094 "This should <emphasis>not</emphasis> be confused with the Origin of a "
6095 "distribution as specified in a <filename>Release</filename> file. What "
6096 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
6097 "Internet address but an author or vendor name, such as \"Debian\" or "
6101 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6102 #: apt_preferences.5.xml:229
6104 "The following record assigns a low priority to all package versions "
6105 "belonging to any distribution whose Archive name is "
6106 "\"<literal>unstable</literal>\"."
6109 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6110 #: apt_preferences.5.xml:233
6114 "Pin: release a=unstable\n"
6115 "Pin-Priority: 50\n"
6118 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6119 #: apt_preferences.5.xml:238
6121 "The following record assigns a high priority to all package versions "
6122 "belonging to any distribution whose Codename is "
6123 "\"<literal>&testing-codename;</literal>\"."
6126 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6127 #: apt_preferences.5.xml:242
6131 "Pin: release n=&testing-codename;\n"
6132 "Pin-Priority: 900\n"
6135 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6136 #: apt_preferences.5.xml:247
6138 "The following record assigns a high priority to all package versions "
6139 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
6140 "and whose release Version number is \"<literal>3.0</literal>\"."
6143 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6144 #: apt_preferences.5.xml:252
6148 "Pin: release a=stable, v=3.0\n"
6149 "Pin-Priority: 500\n"
6152 #. type: Content of: <refentry><refsect1><refsect2><title>
6153 #: apt_preferences.5.xml:263
6154 msgid "How APT Interprets Priorities"
6157 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6158 #: apt_preferences.5.xml:271
6162 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6163 #: apt_preferences.5.xml:272
6165 "causes a version to be installed even if this constitutes a downgrade of the "
6169 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6170 #: apt_preferences.5.xml:276
6171 msgid "990 < P <=1000"
6174 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6175 #: apt_preferences.5.xml:277
6177 "causes a version to be installed even if it does not come from the target "
6178 "release, unless the installed version is more recent"
6181 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6182 #: apt_preferences.5.xml:282
6183 msgid "500 < P <=990"
6186 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6187 #: apt_preferences.5.xml:283
6189 "causes a version to be installed unless there is a version available "
6190 "belonging to the target release or the installed version is more recent"
6193 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6194 #: apt_preferences.5.xml:288
6195 msgid "100 < P <=500"
6198 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6199 #: apt_preferences.5.xml:289
6201 "causes a version to be installed unless there is a version available "
6202 "belonging to some other distribution or the installed version is more recent"
6205 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6206 #: apt_preferences.5.xml:294
6207 msgid "0 < P <=100"
6210 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6211 #: apt_preferences.5.xml:295
6213 "causes a version to be installed only if there is no installed version of "
6217 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6218 #: apt_preferences.5.xml:299
6222 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6223 #: apt_preferences.5.xml:300
6224 msgid "prevents the version from being installed"
6227 #. type: Content of: <refentry><refsect1><refsect2><para>
6228 #: apt_preferences.5.xml:266
6230 "Priorities (P) assigned in the APT preferences file must be positive or "
6231 "negative integers. They are interpreted as follows (roughly speaking): "
6232 "<placeholder type=\"variablelist\" id=\"0\"/>"
6235 #. type: Content of: <refentry><refsect1><refsect2><para>
6236 #: apt_preferences.5.xml:305
6238 "If any specific-form records match an available package version then the "
6239 "first such record determines the priority of the package version. Failing "
6240 "that, if any general-form records match an available package version then "
6241 "the first such record determines the priority of the package version."
6244 #. type: Content of: <refentry><refsect1><refsect2><para>
6245 #: apt_preferences.5.xml:311
6247 "For example, suppose the APT preferences file contains the three records "
6248 "presented earlier:"
6251 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6252 #: apt_preferences.5.xml:315
6256 "Pin: version 5.8*\n"
6257 "Pin-Priority: 1001\n"
6260 "Pin: origin \"\"\n"
6261 "Pin-Priority: 999\n"
6264 "Pin: release unstable\n"
6265 "Pin-Priority: 50\n"
6268 #. type: Content of: <refentry><refsect1><refsect2><para>
6269 #: apt_preferences.5.xml:328
6273 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6274 #: apt_preferences.5.xml:330
6276 "The most recent available version of the <literal>perl</literal> package "
6277 "will be installed, so long as that version's version number begins with "
6278 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
6279 "<literal>perl</literal> is available and the installed version is 5.9*, then "
6280 "<literal>perl</literal> will be downgraded."
6283 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6284 #: apt_preferences.5.xml:335
6286 "A version of any package other than <literal>perl</literal> that is "
6287 "available from the local system has priority over other versions, even "
6288 "versions belonging to the target release."
6291 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6292 #: apt_preferences.5.xml:339
6294 "A version of a package whose origin is not the local system but some other "
6295 "site listed in &sources-list; and which belongs to an "
6296 "<literal>unstable</literal> distribution is only installed if it is selected "
6297 "for installation and no version of the package is already installed."
6300 #. type: Content of: <refentry><refsect1><refsect2><title>
6301 #: apt_preferences.5.xml:349
6302 msgid "Determination of Package Version and Distribution Properties"
6305 #. type: Content of: <refentry><refsect1><refsect2><para>
6306 #: apt_preferences.5.xml:351
6308 "The locations listed in the &sources-list; file should provide "
6309 "<filename>Packages</filename> and <filename>Release</filename> files to "
6310 "describe the packages available at that location."
6313 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6314 #: apt_preferences.5.xml:363
6315 msgid "the <literal>Package:</literal> line"
6318 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6319 #: apt_preferences.5.xml:364
6320 msgid "gives the package name"
6323 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6324 #: apt_preferences.5.xml:367 apt_preferences.5.xml:417
6325 msgid "the <literal>Version:</literal> line"
6328 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6329 #: apt_preferences.5.xml:368
6330 msgid "gives the version number for the named package"
6333 #. type: Content of: <refentry><refsect1><refsect2><para>
6334 #: apt_preferences.5.xml:355
6336 "The <filename>Packages</filename> file is normally found in the directory "
6337 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
6339 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
6340 "consists of a series of multi-line records, one for each package available "
6341 "in that directory. Only two lines in each record are relevant for setting "
6342 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
6345 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6346 #: apt_preferences.5.xml:384
6347 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
6350 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6351 #: apt_preferences.5.xml:385
6353 "names the archive to which all the packages in the directory tree belong. "
6354 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
6355 "that all of the packages in the directory tree below the parent of the "
6356 "<filename>Release</filename> file are in a <literal>stable</literal> "
6357 "archive. Specifying this value in the APT preferences file would require "
6361 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6362 #: apt_preferences.5.xml:395
6364 msgid "Pin: release a=stable\n"
6367 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6368 #: apt_preferences.5.xml:401
6369 msgid "the <literal>Codename:</literal> line"
6372 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6373 #: apt_preferences.5.xml:402
6375 "names the codename to which all the packages in the directory tree belong. "
6376 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
6377 "the packages in the directory tree below the parent of the "
6378 "<filename>Release</filename> file belong to a version named "
6379 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
6380 "preferences file would require the line:"
6383 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6384 #: apt_preferences.5.xml:411
6386 msgid "Pin: release n=&testing-codename;\n"
6389 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6390 #: apt_preferences.5.xml:418
6392 "names the release version. For example, the packages in the tree might "
6393 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
6394 "no version number for the <literal>testing</literal> and "
6395 "<literal>unstable</literal> distributions because they have not been "
6396 "released yet. Specifying this in the APT preferences file would require one "
6397 "of the following lines."
6400 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6401 #: apt_preferences.5.xml:427
6404 "Pin: release v=3.0\n"
6405 "Pin: release a=stable, v=3.0\n"
6406 "Pin: release 3.0\n"
6409 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6410 #: apt_preferences.5.xml:436
6411 msgid "the <literal>Component:</literal> line"
6414 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6415 #: apt_preferences.5.xml:437
6417 "names the licensing component associated with the packages in the directory "
6418 "tree of the <filename>Release</filename> file. For example, the line "
6419 "\"Component: main\" specifies that all the packages in the directory tree "
6420 "are from the <literal>main</literal> component, which entails that they are "
6421 "licensed under terms listed in the Debian Free Software Guidelines. "
6422 "Specifying this component in the APT preferences file would require the "
6426 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6427 #: apt_preferences.5.xml:446
6429 msgid "Pin: release c=main\n"
6432 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6433 #: apt_preferences.5.xml:452
6434 msgid "the <literal>Origin:</literal> line"
6437 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6438 #: apt_preferences.5.xml:453
6440 "names the originator of the packages in the directory tree of the "
6441 "<filename>Release</filename> file. Most commonly, this is "
6442 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
6443 "file would require the line:"
6446 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6447 #: apt_preferences.5.xml:459
6449 msgid "Pin: release o=Debian\n"
6452 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6453 #: apt_preferences.5.xml:465
6454 msgid "the <literal>Label:</literal> line"
6457 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6458 #: apt_preferences.5.xml:466
6460 "names the label of the packages in the directory tree of the "
6461 "<filename>Release</filename> file. Most commonly, this is "
6462 "<literal>Debian</literal>. Specifying this label in the APT preferences "
6463 "file would require the line:"
6466 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6467 #: apt_preferences.5.xml:472
6469 msgid "Pin: release l=Debian\n"
6472 #. type: Content of: <refentry><refsect1><refsect2><para>
6473 #: apt_preferences.5.xml:373
6475 "The <filename>Release</filename> file is normally found in the directory "
6476 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
6477 "example, <filename>.../dists/stable/Release</filename>, or "
6478 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
6479 "single multi-line record which applies to <emphasis>all</emphasis> of the "
6480 "packages in the directory tree below its parent. Unlike the "
6481 "<filename>Packages</filename> file, nearly all of the lines in a "
6482 "<filename>Release</filename> file are relevant for setting APT priorities: "
6483 "<placeholder type=\"variablelist\" id=\"0\"/>"
6486 #. type: Content of: <refentry><refsect1><refsect2><para>
6487 #: apt_preferences.5.xml:479
6489 "All of the <filename>Packages</filename> and <filename>Release</filename> "
6490 "files retrieved from locations listed in the &sources-list; file are stored "
6491 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
6492 "named by the variable <literal>Dir::State::Lists</literal> in the "
6493 "<filename>apt.conf</filename> file. For example, the file "
6494 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
6495 "contains the <filename>Release</filename> file retrieved from the site "
6496 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
6497 "architecture files from the <literal>contrib</literal> component of the "
6498 "<literal>unstable</literal> distribution."
6501 #. type: Content of: <refentry><refsect1><refsect2><title>
6502 #: apt_preferences.5.xml:492
6503 msgid "Optional Lines in an APT Preferences Record"
6506 #. type: Content of: <refentry><refsect1><refsect2><para>
6507 #: apt_preferences.5.xml:494
6509 "Each record in the APT preferences file can optionally begin with one or "
6510 "more lines beginning with the word <literal>Explanation:</literal>. This "
6511 "provides a place for comments."
6514 #. type: Content of: <refentry><refsect1><refsect2><title>
6515 #: apt_preferences.5.xml:503
6516 msgid "Tracking Stable"
6519 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6520 #: apt_preferences.5.xml:511
6523 "Explanation: Uninstall or do not install any Debian-originated\n"
6524 "Explanation: package versions other than those in the stable distro\n"
6526 "Pin: release a=stable\n"
6527 "Pin-Priority: 900\n"
6530 "Pin: release o=Debian\n"
6531 "Pin-Priority: -10\n"
6534 #. type: Content of: <refentry><refsect1><refsect2><para>
6535 #: apt_preferences.5.xml:505
6537 "The following APT preferences file will cause APT to assign a priority "
6538 "higher than the default (500) to all package versions belonging to a "
6539 "<literal>stable</literal> distribution and a prohibitively low priority to "
6540 "package versions belonging to other <literal>Debian</literal> "
6541 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
6544 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6545 #: apt_preferences.5.xml:528 apt_preferences.5.xml:574 apt_preferences.5.xml:632
6548 "apt-get install <replaceable>package-name</replaceable>\n"
6550 "apt-get dist-upgrade\n"
6553 #. type: Content of: <refentry><refsect1><refsect2><para>
6554 #: apt_preferences.5.xml:523
6556 "With a suitable &sources-list; file and the above preferences file, any of "
6557 "the following commands will cause APT to upgrade to the latest "
6558 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
6562 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6563 #: apt_preferences.5.xml:540
6565 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
6568 #. type: Content of: <refentry><refsect1><refsect2><para>
6569 #: apt_preferences.5.xml:534
6571 "The following command will cause APT to upgrade the specified package to the "
6572 "latest version from the <literal>testing</literal> distribution; the package "
6573 "will not be upgraded again unless this command is given again. <placeholder "
6574 "type=\"programlisting\" id=\"0\"/>"
6577 #. type: Content of: <refentry><refsect1><refsect2><title>
6578 #: apt_preferences.5.xml:546
6579 msgid "Tracking Testing or Unstable"
6582 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6583 #: apt_preferences.5.xml:555
6587 "Pin: release a=testing\n"
6588 "Pin-Priority: 900\n"
6591 "Pin: release a=unstable\n"
6592 "Pin-Priority: 800\n"
6595 "Pin: release o=Debian\n"
6596 "Pin-Priority: -10\n"
6599 #. type: Content of: <refentry><refsect1><refsect2><para>
6600 #: apt_preferences.5.xml:548
6602 "The following APT preferences file will cause APT to assign a high priority "
6603 "to package versions from the <literal>testing</literal> distribution, a "
6604 "lower priority to package versions from the <literal>unstable</literal> "
6605 "distribution, and a prohibitively low priority to package versions from "
6606 "other <literal>Debian</literal> distributions. <placeholder "
6607 "type=\"programlisting\" id=\"0\"/>"
6610 #. type: Content of: <refentry><refsect1><refsect2><para>
6611 #: apt_preferences.5.xml:569
6613 "With a suitable &sources-list; file and the above preferences file, any of "
6614 "the following commands will cause APT to upgrade to the latest "
6615 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
6619 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6620 #: apt_preferences.5.xml:589
6622 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
6625 #. type: Content of: <refentry><refsect1><refsect2><para>
6626 #: apt_preferences.5.xml:580
6628 "The following command will cause APT to upgrade the specified package to the "
6629 "latest version from the <literal>unstable</literal> distribution. "
6630 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
6631 "the most recent <literal>testing</literal> version if that is more recent "
6632 "than the installed version, otherwise, to the most recent "
6633 "<literal>unstable</literal> version if that is more recent than the "
6634 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
6637 #. type: Content of: <refentry><refsect1><refsect2><title>
6638 #: apt_preferences.5.xml:596
6639 msgid "Tracking the evolution of a codename release"
6642 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6643 #: apt_preferences.5.xml:610
6646 "Explanation: Uninstall or do not install any Debian-originated package "
6648 "Explanation: other than those in the distribution codenamed with "
6649 "&testing-codename; or sid\n"
6651 "Pin: release n=&testing-codename;\n"
6652 "Pin-Priority: 900\n"
6654 "Explanation: Debian unstable is always codenamed with sid\n"
6656 "Pin: release n=sid\n"
6657 "Pin-Priority: 800\n"
6660 "Pin: release o=Debian\n"
6661 "Pin-Priority: -10\n"
6664 #. type: Content of: <refentry><refsect1><refsect2><para>
6665 #: apt_preferences.5.xml:598
6667 "The following APT preferences file will cause APT to assign a priority "
6668 "higher than the default (500) to all package versions belonging to a "
6669 "specified codename of a distribution and a prohibitively low priority to "
6670 "package versions belonging to other <literal>Debian</literal> distributions, "
6671 "codenames and archives. Note that with this APT preference APT will follow "
6672 "the migration of a release from the archive <literal>testing</literal> to "
6673 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
6674 "want to follow for example the progress in <literal>testing</literal> "
6675 "notwithstanding the codename changes you should use the example "
6676 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
6679 #. type: Content of: <refentry><refsect1><refsect2><para>
6680 #: apt_preferences.5.xml:627
6682 "With a suitable &sources-list; file and the above preferences file, any of "
6683 "the following commands will cause APT to upgrade to the latest version(s) in "
6684 "the release codenamed with <literal>&testing-codename;</literal>. "
6685 "<placeholder type=\"programlisting\" id=\"0\"/>"
6688 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6689 #: apt_preferences.5.xml:647
6691 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
6694 #. type: Content of: <refentry><refsect1><refsect2><para>
6695 #: apt_preferences.5.xml:638
6697 "The following command will cause APT to upgrade the specified package to the "
6698 "latest version from the <literal>sid</literal> distribution. Thereafter, "
6699 "<command>apt-get upgrade</command> will upgrade the package to the most "
6700 "recent <literal>&testing-codename;</literal> version if that is more recent "
6701 "than the installed version, otherwise, to the most recent "
6702 "<literal>sid</literal> version if that is more recent than the installed "
6703 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
6706 #. type: Content of: <refentry><refsect1><variablelist>
6707 #: apt_preferences.5.xml:656
6708 msgid "&file-preferences;"
6711 #. type: Content of: <refentry><refsect1><para>
6712 #: apt_preferences.5.xml:662
6713 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
6716 #. type: Content of: <refentry><refnamediv><refname>
6717 #: sources.list.5.xml:25 sources.list.5.xml:32
6718 msgid "sources.list"
6721 #. type: Content of: <refentry><refnamediv><refpurpose>
6722 #: sources.list.5.xml:33
6723 msgid "Package resource list for APT"
6726 #. type: Content of: <refentry><refsect1><para>
6727 #: sources.list.5.xml:37
6729 "The package resource list is used to locate archives of the package "
6730 "distribution system in use on the system. At this time, this manual page "
6731 "documents only the packaging system used by the Debian GNU/Linux system. "
6732 "This control file is <filename>/etc/apt/sources.list</filename>."
6735 #. type: Content of: <refentry><refsect1><para>
6736 #: sources.list.5.xml:42
6738 "The source list is designed to support any number of active sources and a "
6739 "variety of source media. The file lists one source per line, with the most "
6740 "preferred source listed first. The format of each line is: <literal>type uri "
6741 "args</literal> The first item, <literal>type</literal> determines the format "
6742 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
6743 "Identifier (URI), which is a superset of the more specific and well-known "
6744 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
6745 "comment by using a #."
6748 #. type: Content of: <refentry><refsect1><title>
6749 #: sources.list.5.xml:53
6750 msgid "sources.list.d"
6753 #. type: Content of: <refentry><refsect1><para>
6754 #: sources.list.5.xml:54
6756 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
6757 "add sources.list entries in separate files. The format is the same as for "
6758 "the regular <filename>sources.list</filename> file. File names need to end "
6759 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
6760 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
6761 "Otherwise APT will print a notice that it has ignored a file if the file "
6762 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
6763 "configuration list - in this case it will be silently ignored."
6766 #. type: Content of: <refentry><refsect1><title>
6767 #: sources.list.5.xml:65
6768 msgid "The deb and deb-src types"
6771 #. type: Content of: <refentry><refsect1><para>
6772 #: sources.list.5.xml:66
6774 "The <literal>deb</literal> type describes a typical two-level Debian "
6775 "archive, <filename>distribution/component</filename>. Typically, "
6776 "<literal>distribution</literal> is generally an archivename like "
6777 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
6778 "<literal>&stable-codename;</literal> or "
6779 "<literal>&testing-codename;</literal> while component is one of "
6780 "<literal>main</literal> <literal>contrib</literal> or "
6781 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
6782 "debian distribution's source code in the same form as the "
6783 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
6784 "to fetch source indexes."
6787 #. type: Content of: <refentry><refsect1><para>
6788 #: sources.list.5.xml:78
6790 "The format for a <filename>sources.list</filename> entry using the "
6791 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
6794 #. type: Content of: <refentry><refsect1><literallayout>
6795 #: sources.list.5.xml:81
6797 msgid "deb uri distribution [component1] [component2] [...]"
6800 #. type: Content of: <refentry><refsect1><para>
6801 #: sources.list.5.xml:83
6803 "The URI for the <literal>deb</literal> type must specify the base of the "
6804 "Debian distribution, from which APT will find the information it needs. "
6805 "<literal>distribution</literal> can specify an exact path, in which case the "
6806 "components must be omitted and <literal>distribution</literal> must end with "
6807 "a slash (/). This is useful for when the case only a particular sub-section "
6808 "of the archive denoted by the URI is of interest. If "
6809 "<literal>distribution</literal> does not specify an exact path, at least one "
6810 "<literal>component</literal> must be present."
6813 #. type: Content of: <refentry><refsect1><para>
6814 #: sources.list.5.xml:92
6816 "<literal>distribution</literal> may also contain a variable, "
6817 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
6818 "m68k, powerpc, ...) used on the system. This permits "
6819 "architecture-independent <filename>sources.list</filename> files to be "
6820 "used. In general this is only of interest when specifying an exact path, "
6821 "<literal>APT</literal> will automatically generate a URI with the current "
6822 "architecture otherwise."
6825 #. type: Content of: <refentry><refsect1><para>
6826 #: sources.list.5.xml:100
6828 "Since only one distribution can be specified per line it may be necessary to "
6829 "have multiple lines for the same URI, if a subset of all available "
6830 "distributions or components at that location is desired. APT will sort the "
6831 "URI list after it has generated a complete set internally, and will collapse "
6832 "multiple references to the same Internet host, for instance, into a single "
6833 "connection, so that it does not inefficiently establish an FTP connection, "
6834 "close it, do something else, and then re-establish a connection to that same "
6835 "host. This feature is useful for accessing busy FTP sites with limits on the "
6836 "number of simultaneous anonymous users. APT also parallelizes connections to "
6837 "different hosts to more effectively deal with sites with low bandwidth."
6840 #. type: Content of: <refentry><refsect1><para>
6841 #: sources.list.5.xml:112
6843 "It is important to list sources in order of preference, with the most "
6844 "preferred source listed first. Typically this will result in sorting by "
6845 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
6846 "followed by distant Internet hosts, for example)."
6849 #. type: Content of: <refentry><refsect1><para>
6850 #: sources.list.5.xml:117
6851 msgid "Some examples:"
6854 #. type: Content of: <refentry><refsect1><literallayout>
6855 #: sources.list.5.xml:119
6858 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
6859 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
6864 #. type: Content of: <refentry><refsect1><title>
6865 #: sources.list.5.xml:125
6866 msgid "URI specification"
6869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6870 #: sources.list.5.xml:130
6874 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6875 #: sources.list.5.xml:132
6877 "The file scheme allows an arbitrary directory in the file system to be "
6878 "considered an archive. This is useful for NFS mounts and local mirrors or "
6882 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6883 #: sources.list.5.xml:139
6885 "The cdrom scheme allows APT to use a local CDROM drive with media "
6886 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
6890 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6891 #: sources.list.5.xml:146
6893 "The http scheme specifies an HTTP server for the archive. If an environment "
6894 "variable <envar>http_proxy</envar> is set with the format "
6895 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
6896 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
6897 "the format http://user:pass@server:port/. Note that this is an insecure "
6898 "method of authentication."
6901 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6902 #: sources.list.5.xml:157
6904 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
6905 "is highly configurable; for more information see the &apt-conf; manual "
6906 "page. Please note that a ftp proxy can be specified by using the "
6907 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
6908 "http proxy (http proxy servers often understand ftp urls) using this method "
6909 "and ONLY this method. ftp proxies using http specified in the configuration "
6910 "file will be ignored."
6913 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6914 #: sources.list.5.xml:166
6918 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6919 #: sources.list.5.xml:168
6921 "The copy scheme is identical to the file scheme except that packages are "
6922 "copied into the cache directory instead of used directly at their location. "
6923 "This is useful for people using a zip disk to copy files around with APT."
6926 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6927 #: sources.list.5.xml:173
6931 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6932 #: sources.list.5.xml:173
6936 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6937 #: sources.list.5.xml:175
6939 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
6940 "user and access the files. It is a good idea to do prior arrangements with "
6941 "RSA keys or rhosts. Access to files on the remote uses standard "
6942 "<command>find</command> and <command>dd</command> commands to perform the "
6943 "file transfers from the remote."
6946 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
6947 #: sources.list.5.xml:183
6948 msgid "more recognizable URI types"
6951 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
6952 #: sources.list.5.xml:185
6954 "APT can be extended with more methods shipped in other optional packages "
6955 "which should follow the nameing scheme "
6956 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
6957 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
6958 "which provides access methods for https-URIs with features similar to the "
6959 "http method, but other methods for using e.g. debtorrent are also available, "
6960 "see <citerefentry> "
6961 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
6962 "<manvolnum>1</manvolnum></citerefentry>."
6965 #. type: Content of: <refentry><refsect1><para>
6966 #: sources.list.5.xml:127
6968 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
6969 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
6972 #. type: Content of: <refentry><refsect1><para>
6973 #: sources.list.5.xml:199
6975 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
6976 "stable/main, stable/contrib, and stable/non-free."
6979 #. type: Content of: <refentry><refsect1><literallayout>
6980 #: sources.list.5.xml:201
6982 msgid "deb file:/home/jason/debian stable main contrib non-free"
6985 #. type: Content of: <refentry><refsect1><para>
6986 #: sources.list.5.xml:203
6987 msgid "As above, except this uses the unstable (development) distribution."
6990 #. type: Content of: <refentry><refsect1><literallayout>
6991 #: sources.list.5.xml:204
6993 msgid "deb file:/home/jason/debian unstable main contrib non-free"
6996 #. type: Content of: <refentry><refsect1><para>
6997 #: sources.list.5.xml:206
6998 msgid "Source line for the above"
7001 #. type: Content of: <refentry><refsect1><literallayout>
7002 #: sources.list.5.xml:207
7004 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
7007 #. type: Content of: <refentry><refsect1><para>
7008 #: sources.list.5.xml:209
7010 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
7014 #. type: Content of: <refentry><refsect1><literallayout>
7015 #: sources.list.5.xml:211
7017 msgid "deb http://archive.debian.org/debian-archive hamm main"
7020 #. type: Content of: <refentry><refsect1><para>
7021 #: sources.list.5.xml:213
7023 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7024 "directory, and uses only the &stable-codename;/contrib area."
7027 #. type: Content of: <refentry><refsect1><literallayout>
7028 #: sources.list.5.xml:215
7030 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
7033 #. type: Content of: <refentry><refsect1><para>
7034 #: sources.list.5.xml:217
7036 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7037 "directory, and uses only the unstable/contrib area. If this line appears as "
7038 "well as the one in the previous example in <filename>sources.list</filename> "
7039 "a single FTP session will be used for both resource lines."
7042 #. type: Content of: <refentry><refsect1><literallayout>
7043 #: sources.list.5.xml:221
7045 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
7048 #. type: Content of: <refentry><refsect1><para><literallayout>
7049 #: sources.list.5.xml:230
7051 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
7054 #. type: Content of: <refentry><refsect1><para>
7055 #: sources.list.5.xml:223
7057 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
7058 "directory, and uses only files found under "
7059 "<filename>unstable/binary-i386</filename> on i386 machines, "
7060 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
7061 "supported architectures. [Note this example only illustrates how to use the "
7062 "substitution variable; official debian archives are not structured like "
7063 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
7066 #. type: Content of: <refentry><refsect1><para>
7067 #: sources.list.5.xml:235
7068 msgid "&apt-cache; &apt-conf;"
7071 #. type: <title></title>
7073 msgid "APT User's Guide"
7076 #. type: <author></author>
7077 #: guide.sgml:6 offline.sgml:6
7078 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
7081 #. type: <version></version>
7083 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
7086 #. type: <abstract></abstract>
7089 "This document provides an overview of how to use the the APT package "
7093 #. type: <copyrightsummary></copyrightsummary>
7095 msgid "Copyright © Jason Gunthorpe, 1998."
7099 #: guide.sgml:21 offline.sgml:22
7101 "\"APT\" and this document are free software; you can redistribute them "
7102 "and/or modify them under the terms of the GNU General Public License as "
7103 "published by the Free Software Foundation; either version 2 of the License, "
7104 "or (at your option) any later version."
7108 #: guide.sgml:24 offline.sgml:25
7110 "For more details, on Debian GNU/Linux systems, see the file "
7111 "/usr/share/common-licenses/GPL for the full license."
7114 #. type: <heading></heading>
7122 "The APT package currently contains two sections, the APT "
7123 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
7124 "interface. Both provide a way to install and remove packages as well as "
7125 "download new packages from the Internet."
7128 #. type: <heading></heading>
7130 msgid "Anatomy of the Package System"
7136 "The Debian packaging system has a large amount of information associated "
7137 "with each package to help assure that it integrates cleanly and easily into "
7138 "the system. The most prominent of its features is the dependency system."
7144 "The dependency system allows individual programs to make use of shared "
7145 "elements in the system such as libraries. It simplifies placing infrequently "
7146 "used portions of a program in separate packages to reduce the number of "
7147 "things the average user is required to install. Also, it allows for choices "
7148 "in mail transport agents, X servers and so on."
7154 "The first step to understanding the dependency system is to grasp the "
7155 "concept of a simple dependency. The meaning of a simple dependency is that a "
7156 "package requires another package to be installed at the same time to work "
7163 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
7164 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
7165 "simple dependency on GPG. Also, because it is an emacs extension it has a "
7166 "simple dependency on emacs, without emacs it is completely useless."
7172 "The other important dependency to understand is a conflicting dependency. It "
7173 "means that a package, when installed with another package, will not work and "
7174 "may possibly be extremely harmful to the system. As an example consider a "
7175 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
7176 "have two mail transport agents installed because both need to listen to the "
7177 "network to receive mail. Attempting to install two will seriously damage the "
7178 "system so all mail transport agents have a conflicting dependency with all "
7179 "other mail transport agents."
7185 "As an added complication there is the possibility for a package to pretend "
7186 "to be another package. Consider that exim and sendmail for many intents are "
7187 "identical, they both deliver mail and understand a common interface. Hence, "
7188 "the package system has a way for them to declare that they are both "
7189 "mail-transport-agents. So, exim and sendmail both declare that they provide "
7190 "a mail-transport-agent and other packages that need a mail transport agent "
7191 "depend on mail-transport-agent. This can add a great deal of confusion when "
7192 "trying to manually fix packages."
7198 "At any given time a single dependency may be met by packages that are "
7199 "already installed or it may not be. APT attempts to help resolve dependency "
7200 "issues by providing a number of automatic algorithms that help in selecting "
7201 "packages for installation."
7207 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
7208 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
7209 "understand .deb files, it works with the package's proper name and can only "
7210 "install .deb archives from a <em>Source</em>."
7216 "The first <footnote><p>If you are using an http proxy server you must set "
7217 "the http_proxy environment variable first, see "
7218 "sources.list(5)</p></footnote> thing that should be done before using "
7219 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
7220 "so that it knows what packages are available. This is done with <tt>apt-get "
7221 "update</tt>. For instance,"
7224 #. type: <example></example>
7228 "# apt-get update\n"
7229 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
7230 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7231 "Reading Package Lists... Done\n"
7232 "Building Dependency Tree... Done"
7235 #. type: <p><taglist>
7237 msgid "Once updated there are several commands that can be used:"
7243 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
7244 "install a new package or remove an existing package, nor will it ever "
7245 "upgrade a package that might cause some other package to break. This can be "
7246 "used daily to relatively safely upgrade the system. Upgrade will list all of "
7247 "the packages that it could not upgrade, this usually means that they depend "
7248 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
7249 "<tt>apt-get install</tt> can be used to force these packages to install."
7255 "Install is used to install packages by name. The package is automatically "
7256 "fetched and installed. This can be useful if you already know the name of "
7257 "the package to install and do not want to go into a GUI to select it. Any "
7258 "number of packages may be passed to install, they will all be "
7259 "fetched. Install automatically attempts to resolve dependency problems with "
7260 "the listed packages and will print a summary and ask for confirmation if "
7261 "anything other than its arguments are changed."
7267 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
7268 "releases of Debian. It uses a sophisticated algorithm to determine the best "
7269 "set of packages to install, upgrade and remove to get as much of the system "
7270 "to the newest release. In some situations it may be desired to use "
7271 "dist-upgrade rather than spend the time manually resolving dependencies in "
7272 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
7273 "<prgn>dselect</prgn> can be used to install any packages that may have been "
7280 "It is important to closely look at what dist-upgrade is going to do, its "
7281 "decisions may sometimes be quite surprising."
7287 "<prgn>apt-get</prgn> has several command line options that are detailed in "
7288 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
7289 "option is <tt>-d</tt> which does not install the fetched files. If the "
7290 "system has to download a large number of package it would be undesired to "
7291 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
7292 "the downloaded archives can be installed by simply running the command that "
7293 "caused them to be downloaded again without <tt>-d</tt>."
7296 #. type: <heading></heading>
7304 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
7305 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
7306 "to select the packages to be installed or removed and APT actually installs "
7313 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
7314 "and then choose the APT method. You will be prompted for a set of "
7315 "<em>Sources</em> which are places to fetch archives from. These can be "
7316 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
7317 "provide a fragment of the total Debian archive, APT will automatically "
7318 "combine them to form a complete set of packages. If you have a CDROM then it "
7319 "is a good idea to specify it first and then specify a mirror so that you "
7320 "have access to the latest bug fixes. APT will automatically use packages on "
7321 "your CDROM before downloading from the Internet."
7324 #. type: <example></example>
7328 " Set up a list of distribution source locations\n"
7330 " Please give the base URL of the debian distribution.\n"
7331 " The access schemes I know about are: http file\n"
7334 " file:/mnt/debian,\n"
7335 " ftp://ftp.debian.org/debian,\n"
7336 " http://ftp.de.debian.org/debian,\n"
7339 " URL [http://llug.sep.bnl.gov/debian]:"
7345 "The <em>Sources</em> setup starts by asking for the base of the Debian "
7346 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
7350 #. type: <example></example>
7354 " Please give the distribution tag to get or a path to the\n"
7355 " package file ending in a /. The distribution\n"
7356 " tags are typically something like: stable unstable testing non-US\n"
7358 " Distribution [stable]:"
7364 "The distribution refers to the Debian version in the archive, "
7365 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
7366 "refers to the developmental version. <em>non-US</em> is only available on "
7367 "some mirrors and refers to packages that contain encryption technology or "
7368 "other things that cannot be exported from the United States. Importing these "
7369 "packages into the US is legal however."
7372 #. type: <example></example>
7376 " Please give the components to get\n"
7377 " The components are typically something like: main contrib non-free\n"
7379 " Components [main contrib non-free]:"
7385 "The components list refers to the list of sub distributions to fetch. The "
7386 "distribution is split up based on software licenses, main being DFSG free "
7387 "packages while contrib and non-free contain things that have various "
7388 "restrictions placed on their use and distribution."
7394 "Any number of sources can be added, the setup script will continue to prompt "
7395 "until you have specified all that you want."
7401 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
7402 "available list by selecting [U]pdate from the menu. This is a superset of "
7403 "<tt>apt-get update</tt> that makes the fetched information available to "
7404 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
7405 "update</tt> has been run before."
7411 "You can then go on and make your selections using [S]elect and then perform "
7412 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7413 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7420 "By default APT will automatically remove the package (.deb) files once they "
7421 "have been successfully installed. To change this behavior place "
7422 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
7425 #. type: <heading></heading>
7427 msgid "The Interface"
7433 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
7434 "same interface. It is a simple system that generally tells you what it will "
7435 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
7436 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
7437 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
7438 "alone.</p></footnote> After printing out a summary of what will happen APT "
7439 "then will print out some informative status messages so that you can "
7440 "estimate how far along it is and how much is left to do."
7443 #. type: <heading></heading>
7451 "Before all operations except update, APT performs a number of actions to "
7452 "prepare its internal state. It also does some checks of the system's "
7453 "state. At any time these operations can be performed by running <tt>apt-get "
7457 #. type: <example></example>
7462 "Reading Package Lists... Done\n"
7463 "Building Dependency Tree... Done"
7469 "The first thing it does is read all the package files into memory. APT uses "
7470 "a caching scheme so this operation will be faster the second time it is "
7471 "run. If some of the package files are not found then they will be ignored "
7472 "and a warning will be printed when apt-get exits."
7478 "The final operation performs a detailed analysis of the system's "
7479 "dependencies. It checks every dependency of every installed or unpacked "
7480 "package and considers if it is OK. Should this find a problem then a report "
7481 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
7484 #. type: <example></example>
7489 "Reading Package Lists... Done\n"
7490 "Building Dependency Tree... Done\n"
7491 "You might want to run apt-get -f install' to correct these.\n"
7492 "Sorry, but the following packages have unmet dependencies:\n"
7493 " 9fonts: Depends: xlib6g but it is not installed\n"
7494 " uucp: Depends: mailx but it is not installed\n"
7495 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7496 " adduser: Depends: perl-base but it is not installed\n"
7497 " aumix: Depends: libgpmg1 but it is not installed\n"
7498 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7499 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7500 " cthugha: Depends: svgalibg1 but it is not installed\n"
7501 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7502 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
7508 "In this example the system has many problems, including a serious problem "
7509 "with libreadlineg2. For each package that has unmet dependencies a line is "
7510 "printed out indicating the package with the problem and the dependencies "
7511 "that are unmet. A short explanation of why the package has a dependency "
7512 "problem is also included."
7518 "There are two ways a system can get into a broken state like this. The first "
7519 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
7520 "packages when performing upgrades. <footnote><p>APT however considers all "
7521 "known dependencies and attempts to prevent broken "
7522 "packages</p></footnote>. The second is if a package installation fails "
7523 "during an operation. In this situation a package may have been unpacked "
7524 "without its dependents being installed."
7530 "The second situation is much less serious than the first because APT places "
7531 "certain constraints on the order that packages are installed. In both cases "
7532 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
7533 "deduce a possible solution to the problem and then continue on. The APT "
7534 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
7535 "for easy continuation of failed maintainer scripts."
7541 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
7542 "system caused by the first case then it is possible that it will either fail "
7543 "immediately or the installation sequence will fail. In either case it is "
7544 "necessary to manually use dpkg (possibly with forcing options) to correct "
7545 "the situation enough to allow APT to proceed."
7548 #. type: <heading></heading>
7550 msgid "The Status Report"
7556 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
7557 "happen. Generally the report reflects the type of operation being performed "
7558 "but there are several common elements. In all cases the lists reflect the "
7559 "final state of things, taking into account the <tt>-f</tt> option and any "
7560 "other relevant activities to the command being executed."
7563 #. type: <heading></heading>
7565 msgid "The Extra Package list"
7568 #. type: <example></example>
7572 "The following extra packages will be installed:\n"
7573 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7574 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7575 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7576 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7583 "The Extra Package list shows all of the packages that will be installed or "
7584 "upgraded in excess of the ones mentioned on the command line. It is only "
7585 "generated for an <tt>install</tt> command. The listed packages are often the "
7586 "result of an Auto Install."
7589 #. type: <heading></heading>
7591 msgid "The Packages to Remove"
7594 #. type: <example></example>
7598 "The following packages will be REMOVED:\n"
7599 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7600 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7601 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7608 "The Packages to Remove list shows all of the packages that will be removed "
7609 "from the system. It can be shown for any of the operations and should be "
7610 "given a careful inspection to ensure nothing important is to be taken "
7611 "off. The <tt>-f</tt> option is especially good at generating packages to "
7612 "remove so extreme care should be used in that case. The list may contain "
7613 "packages that are going to be removed because they are only partially "
7614 "installed, possibly due to an aborted installation."
7617 #. type: <heading></heading>
7619 msgid "The New Packages list"
7622 #. type: <example></example>
7626 "The following NEW packages will installed:\n"
7627 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
7633 "The New Packages list is simply a reminder of what will happen. The packages "
7634 "listed are not presently installed in the system but will be when APT is "
7638 #. type: <heading></heading>
7640 msgid "The Kept Back list"
7643 #. type: <example></example>
7647 "The following packages have been kept back\n"
7648 " compface man-db tetex-base msql libpaper svgalib1\n"
7649 " gs snmp arena lynx xpat2 groff xscreensaver"
7655 "Whenever the whole system is being upgraded there is the possibility that "
7656 "new versions of packages cannot be installed because they require new things "
7657 "or conflict with already installed things. In this case the package will "
7658 "appear in the Kept Back list. The best way to convince packages listed there "
7659 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
7660 "to resolve their problems."
7663 #. type: <heading></heading>
7665 msgid "Held Packages warning"
7668 #. type: <example></example>
7672 "The following held packages will be changed:\n"
7679 "Sometimes you can ask APT to install a package that is on hold, in such a "
7680 "case it prints out a warning that the held package is going to be "
7681 "changed. This should only happen during dist-upgrade or install."
7684 #. type: <heading></heading>
7686 msgid "Final summary"
7691 msgid "Finally, APT will print out a summary of all the changes that will occur."
7694 #. type: <example></example>
7698 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7700 "12 packages not fully installed or removed.\n"
7701 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
7707 "The first line of the summary simply is a reduced version of all of the "
7708 "lists and includes the number of upgrades - that is packages already "
7709 "installed that have new versions available. The second line indicates the "
7710 "number of poorly configured packages, possibly the result of an aborted "
7711 "installation. The final line shows the space requirements that the "
7712 "installation needs. The first pair of numbers refer to the size of the "
7713 "archive files. The first number indicates the number of bytes that must be "
7714 "fetched from remote locations and the second indicates the total size of all "
7715 "the archives required. The next number indicates the size difference between "
7716 "the presently installed packages and the newly installed packages. It is "
7717 "roughly equivalent to the space required in /usr after everything is "
7718 "done. If a large number of packages are being removed then the value may "
7719 "indicate the amount of space that will be freed."
7725 "Some other reports can be generated by using the -u option to show packages "
7726 "to upgrade, they are similar to the previous examples."
7729 #. type: <heading></heading>
7731 msgid "The Status Display"
7737 "During the download of archives and package files APT prints out a series of "
7741 #. type: <example></example>
7745 "# apt-get update\n"
7746 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7747 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7748 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7749 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7751 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7752 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
7758 "The lines starting with <em>Get</em> are printed out when APT begins to "
7759 "fetch a file while the last line indicates the progress of the download. The "
7760 "first percent value on the progress line indicates the total percent done of "
7761 "all files. Unfortunately since the size of the Package files is unknown "
7762 "<tt>apt-get update</tt> estimates the percent done which causes some "
7769 "The next section of the status line is repeated once for each download "
7770 "thread and indicates the operation being performed and some useful "
7771 "information about what is happening. Sometimes this section will simply read "
7772 "<em>Forking</em> which means the OS is loading the download module. The "
7773 "first word after the [ is the fetch number as shown on the history "
7774 "lines. The next word is the short form name of the object being "
7775 "downloaded. For archives it will contain the name of the package that is "
7782 "Inside of the single quote is an informative string indicating the progress "
7783 "of the negotiation phase of the download. Typically it progresses from "
7784 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
7785 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
7786 "the remote site. Once the download begins this is represented as "
7787 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
7788 "kilobytes is expected. The total size is always shown in 4 figure notation "
7789 "to preserve space. After the size display is a percent meter for the file "
7790 "itself. The second last element is the instantaneous average speed. This "
7791 "values is updated every 5 seconds and reflects the rate of data transfer for "
7792 "that period. Finally is shown the estimated transfer time. This is updated "
7793 "regularly and reflects the time to complete everything at the shown transfer "
7800 "The status display updates every half second to provide a constant feedback "
7801 "on the download progress while the Get lines scroll back whenever a new file "
7802 "is started. Since the status display is constantly updated it is unsuitable "
7803 "for logging to a file, use the <tt>-q</tt> option to remove the status "
7807 #. type: <heading></heading>
7815 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
7816 "to the <prgn>dpkg</prgn> interface once downloading is "
7817 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
7818 "processes the packages and the packages themselves may also ask several "
7819 "questions. Before each question there is usually a description of what it is "
7820 "asking and the questions are too varied to discuss completely here."
7823 #. type: <title></title>
7825 msgid "Using APT Offline"
7828 #. type: <version></version>
7830 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
7833 #. type: <abstract></abstract>
7836 "This document describes how to use APT in a non-networked environment, "
7837 "specifically a 'sneaker-net' approach for performing upgrades."
7840 #. type: <copyrightsummary></copyrightsummary>
7842 msgid "Copyright © Jason Gunthorpe, 1999."
7845 #. type: <heading></heading>
7847 msgid "Introduction"
7850 #. type: <heading></heading>
7851 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
7858 "Normally APT requires direct access to a Debian archive, either from a local "
7859 "media or through a network. Another common complaint is that a Debian "
7860 "machine is on a slow link, such as a modem and another machine has a very "
7861 "fast connection but they are physically distant."
7867 "The solution to this is to use large removable media such as a Zip disc or a "
7868 "SuperDisk disc. These discs are not large enough to store the entire Debian "
7869 "archive but can easily fit a subset large enough for most users. The idea is "
7870 "to use APT to generate a list of packages that are required and then fetch "
7871 "them onto the disc using another machine with good connectivity. It is even "
7872 "possible to use another Debian machine with APT or to use a completely "
7873 "different OS and a download tool like wget. Let <em>remote host</em> mean "
7874 "the machine downloading the packages, and <em>target host</em> the one with "
7875 "bad or no connection."
7881 "This is achieved by creatively manipulating the APT configuration file. The "
7882 "essential premise to tell APT to look on a disc for it's archive files. Note "
7883 "that the disc should be formated with a filesystem that can handle long file "
7884 "names such as ext2, fat32 or vfat."
7887 #. type: <heading></heading>
7889 msgid "Using APT on both machines"
7892 #. type: <p><example>
7895 "APT being available on both machines gives the simplest configuration. The "
7896 "basic idea is to place a copy of the status file on the disc and use the "
7897 "remote machine to fetch the latest package files and decide which packages "
7898 "to download. The disk directory structure should look like:"
7901 #. type: <example></example>
7915 #. type: <heading></heading>
7917 msgid "The configuration file"
7923 "The configuration file should tell APT to store its files on the disc and to "
7924 "use the configuration files on the disc as well. The sources.list should "
7925 "contain the proper sites that you wish to use from the remote machine, and "
7926 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
7927 "<em>target host</em>. Please note, if you are using a local archive you must "
7928 "use copy URIs, the syntax is identical to file URIs."
7931 #. type: <p><example>
7934 "<em>apt.conf</em> must contain the necessary information to make APT use the "
7938 #. type: <example></example>
7944 " /* This is not necessary if the two machines are the same arch, it "
7946 " the remote APT what architecture the target machine is */\n"
7947 " Architecture \"i386\";\n"
7949 " Get::Download-Only \"true\";\n"
7954 " /* Use the disc for state information and redirect the status file from\n"
7955 " the /var/lib/dpkg default */\n"
7956 " State \"/disc/\";\n"
7957 " State::status \"status\";\n"
7959 " // Binary caches will be stored locally\n"
7960 " Cache::archives \"/disc/archives/\";\n"
7961 " Cache \"/tmp/\";\n"
7963 " // Location of the source list.\n"
7964 " Etc \"/disc/\";\n"
7968 #. type: </example></p>
7971 "More details can be seen by examining the apt.conf man page and the sample "
7972 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
7975 #. type: <p><example>
7978 "On the target machine the first thing to do is mount the disc and copy "
7979 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
7980 "directories outlined in the Overview, <em>archives/partial/</em> and "
7981 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
7982 "configure the sources.list. On the remote machine execute the following:"
7985 #. type: <example></example>
7989 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
7990 " # apt-get update\n"
7991 " [ APT fetches the package files ]\n"
7992 " # apt-get dist-upgrade\n"
7993 " [ APT fetches all the packages needed to upgrade the target machine ]"
7996 #. type: </example></p>
7999 "The dist-upgrade command can be replaced with any other standard APT "
8000 "commands, particularly dselect-upgrade. You can even use an APT front end "
8001 "such as <em>dselect</em>. However this presents a problem in communicating "
8002 "your selections back to the local computer."
8005 #. type: <p><example>
8008 "Now the disc contains all of the index files and archives needed to upgrade "
8009 "the target machine. Take the disc back and run:"
8012 #. type: <example></example>
8016 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8017 " # apt-get check\n"
8018 " [ APT generates a local copy of the cache files ]\n"
8019 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
8020 " [ Or any other APT command ]"
8026 "It is necessary for proper function to re-specify the status file to be the "
8027 "local one. This is very important!"
8033 "If you are using dselect you can do the very risky operation of copying "
8034 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
8035 "remote machine are updated. I highly recommend that people only make "
8036 "selections on the local machine - but this may not always be possible. DO "
8037 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
8040 #. type: <heading></heading>
8042 msgid "Using APT and wget"
8048 "<em>wget</em> is a popular and portable download tool that can run on nearly "
8049 "any machine. Unlike the method above this requires that the Debian machine "
8050 "already has a list of available packages."
8056 "The basic idea is to create a disc that has only the archive files "
8057 "downloaded from the remote site. This is done by using the --print-uris "
8058 "option to apt-get and then preparing a wget script to actually fetch the "
8062 #. type: <heading></heading>
8067 #. type: <p><example>
8070 "Unlike the previous technique no special configuration files are "
8071 "required. We merely use the standard APT commands to generate the file list."
8074 #. type: <example></example>
8078 " # apt-get dist-upgrade \n"
8079 " [ Press no when prompted, make sure you are happy with the actions ]\n"
8080 " # apt-get -qq --print-uris dist-upgrade > uris\n"
8081 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
8084 #. type: </example></p>
8087 "Any command other than dist-upgrade could be used here, including "
8094 "The /disc/wget-script file will now contain a list of wget commands to "
8095 "execute in order to fetch the necessary archives. This script should be run "
8096 "with the current directory as the disc's mount point so as to save the "
8097 "output on the disc."
8100 #. type: <p><example>
8102 msgid "The remote machine would do something like"
8105 #. type: <example></example>
8110 " # sh -x ./wget-script\n"
8114 #. type: </example><example>
8117 "Once the archives are downloaded and the disc returned to the Debian machine "
8118 "installation can proceed using,"
8121 #. type: <example></example>
8124 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
8127 #. type: </example></p>
8129 msgid "Which will use the already fetched archives on the disc."