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-10-05 23:06+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:121 apt-key.8.xml:38 apt-mark.8.xml:56 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:127
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:342 apt-mark.8.xml:126 apt-sortpkgs.1.xml:57 apt.conf.5.xml:577 apt.conf.5.xml:599
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:572 apt-get.8.xml:404 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:546 apt-get.8.xml:394
991 msgid "<option>-q</option>"
994 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
995 #: apt-cache.8.xml:296 apt-ftparchive.1.xml:546 apt-get.8.xml:394
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 tweaked 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:361
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:584 apt-get.8.xml:447
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:612 apt-get.8.xml:591 apt-mark.8.xml:140 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:596 apt-key.8.xml:175 apt-mark.8.xml:144 apt.conf.5.xml:1110 apt_preferences.5.xml:697
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:628 apt-get.8.xml:606 apt-key.8.xml:196 apt-mark.8.xml:150 apt-secure.8.xml:185 apt-sortpkgs.1.xml:72 apt.conf.5.xml:1116 apt_preferences.5.xml:704 sources.list.5.xml:250
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:632 apt-get.8.xml:612 apt-mark.8.xml:154 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:161
1318 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1319 #: apt-cdrom.8.xml:98 apt-ftparchive.1.xml:540 apt-get.8.xml:356
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:375
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:406
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:408
1406 msgid "<option>--recon</option>"
1409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
1410 #: apt-cdrom.8.xml:145 apt-get.8.xml:409
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:629 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:525
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:298
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><variablelist><varlistentry><term>
2246 #: apt-ftparchive.1.xml:394 apt.conf.5.xml:157
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><replaceable>Index</replaceable></literal> can be "
2447 "<literal>Packages</literal>, <literal>Sources</literal> or "
2448 "<literal>Release</literal> and "
2449 "<literal><replaceable>Checksum</replaceable></literal> can be "
2450 "<literal>MD5</literal>, <literal>SHA1</literal> or "
2451 "<literal>SHA256</literal>."
2454 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2455 #: apt-ftparchive.1.xml:540
2456 msgid "<option>--db</option>"
2459 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2460 #: apt-ftparchive.1.xml:542
2462 "Use a binary caching DB. This has no effect on the generate command. "
2463 "Configuration Item: <literal>APT::FTPArchive::DB</literal>."
2466 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2467 #: apt-ftparchive.1.xml:548
2469 "Quiet; produces output suitable for logging, omitting progress indicators. "
2470 "More q's will produce more quiet up to a maximum of 2. You can also use "
2471 "<option>-q=#</option> to set the quiet level, overriding the configuration "
2472 "file. Configuration Item: <literal>quiet</literal>."
2475 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2476 #: apt-ftparchive.1.xml:554
2477 msgid "<option>--delink</option>"
2480 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2481 #: apt-ftparchive.1.xml:556
2483 "Perform Delinking. If the <literal>External-Links</literal> setting is used "
2484 "then this option actually enables delinking of the files. It defaults to on "
2485 "and can be turned off with <option>--no-delink</option>. Configuration "
2486 "Item: <literal>APT::FTPArchive::DeLinkAct</literal>."
2489 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2490 #: apt-ftparchive.1.xml:562
2491 msgid "<option>--contents</option>"
2494 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2495 #: apt-ftparchive.1.xml:564
2497 "Perform contents generation. When this option is set and package indexes are "
2498 "being generated with a cache DB then the file listing will also be extracted "
2499 "and stored in the DB for later use. When using the generate command this "
2500 "option also allows the creation of any Contents files. The default is on. "
2501 "Configuration Item: <literal>APT::FTPArchive::Contents</literal>."
2504 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2505 #: apt-ftparchive.1.xml:572
2506 msgid "<option>--source-override</option>"
2509 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2510 #: apt-ftparchive.1.xml:574
2512 "Select the source override file to use with the <literal>sources</literal> "
2513 "command. Configuration Item: "
2514 "<literal>APT::FTPArchive::SourceOverride</literal>."
2517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2518 #: apt-ftparchive.1.xml:578
2519 msgid "<option>--readonly</option>"
2522 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2523 #: apt-ftparchive.1.xml:580
2525 "Make the caching databases read only. Configuration Item: "
2526 "<literal>APT::FTPArchive::ReadOnlyDB</literal>."
2529 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2530 #: apt-ftparchive.1.xml:584
2531 msgid "<option>--arch</option>"
2534 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2535 #: apt-ftparchive.1.xml:585
2537 "Accept in the <literal>packages</literal> and <literal>contents</literal> "
2538 "commands only package files matching <literal>*_arch.deb</literal> or "
2539 "<literal>*_all.deb</literal> instead of all package files in the given "
2540 "path. Configuration Item: <literal>APT::FTPArchive::Architecture</literal>."
2543 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2544 #: apt-ftparchive.1.xml:591
2545 msgid "<option>APT::FTPArchive::AlwaysStat</option>"
2548 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2549 #: apt-ftparchive.1.xml:593
2551 "&apt-ftparchive; caches as much as possible of metadata in a cachedb. If "
2552 "packages are recompiled and/or republished with the same version again, this "
2553 "will lead to problems as the now outdated cached metadata like size and "
2554 "checksums will be used. With this option enabled this will no longer happen "
2555 "as it will be checked if the file was changed. Note that this option is set "
2556 "to \"<literal>false</literal>\" by default as it is not recommend to upload "
2557 "multiply versions/builds of a package with the same versionnumber, so in "
2558 "theory nobody will have these problems and therefore all these extra checks "
2562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2563 #: apt-ftparchive.1.xml:603
2564 msgid "<option>APT::FTPArchive::LongDescription</option>"
2567 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2568 #: apt-ftparchive.1.xml:605
2570 "This configuration option defaults to \"<literal>true</literal>\" and should "
2571 "only be set to <literal>\"false\"</literal> if the Archive generated with "
2572 "&apt-ftparchive; also provides <filename>Translation</filename> files. Note "
2573 "that the <filename>Translation-en</filename> master file can only be created "
2574 "in the generate command."
2577 #. type: Content of: <refentry><refsect1><title>
2578 #: apt-ftparchive.1.xml:617 apt.conf.5.xml:1104 apt_preferences.5.xml:544 sources.list.5.xml:209
2582 #. type: Content of: <refentry><refsect1><para><programlisting>
2583 #: apt-ftparchive.1.xml:623
2586 "<command>apt-ftparchive</command> packages "
2587 "<replaceable>directory</replaceable> | <command>gzip</command> > "
2588 "<filename>Packages.gz</filename>\n"
2591 #. type: Content of: <refentry><refsect1><para>
2592 #: apt-ftparchive.1.xml:619
2594 "To create a compressed Packages file for a directory containing binary "
2595 "packages (.deb): <placeholder type=\"programlisting\" id=\"0\"/>"
2598 #. type: Content of: <refentry><refsect1><para>
2599 #: apt-ftparchive.1.xml:633
2601 "<command>apt-ftparchive</command> returns zero on normal operation, decimal "
2605 #. The last update date
2606 #. type: Content of: <refentry><refentryinfo>
2609 "&apt-author.jgunthorpe; &apt-author.team; &apt-email; &apt-product; <date>08 "
2610 "November 2008</date>"
2613 #. type: <heading></heading>
2614 #: apt-get.8.xml:25 apt-get.8.xml:32 guide.sgml:96
2618 #. type: Content of: <refentry><refnamediv><refpurpose>
2620 msgid "APT package handling utility -- command-line interface"
2623 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
2626 "<command>apt-get</command> <arg><option>-sqdyfmubV</option></arg> <arg> "
2627 "<option>-o= <replaceable>config_string</replaceable> </option> </arg> <arg> "
2628 "<option>-c= <replaceable>config_file</replaceable> </option> </arg> <arg> "
2629 "<option>-t=</option> <arg choice='plain'> "
2630 "<replaceable>target_release</replaceable> </arg> </arg> <arg> "
2631 "<option>-a=</option> <arg choice='plain'> "
2632 "<replaceable>default_architecture</replaceable> </arg> </arg> <group "
2633 "choice=\"req\"> <arg choice='plain'>update</arg> <arg "
2634 "choice='plain'>upgrade</arg> <arg choice='plain'>dselect-upgrade</arg> <arg "
2635 "choice='plain'>dist-upgrade</arg> <arg choice='plain'>install <arg "
2636 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group "
2637 "choice='req'> <arg choice='plain'> "
2638 "=<replaceable>pkg_version_number</replaceable> </arg> <arg choice='plain'> "
2639 "/<replaceable>target_release</replaceable> </arg> </group> </arg> </arg> "
2640 "</arg> <arg choice='plain'>remove <arg choice=\"plain\" "
2641 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2642 "choice='plain'>purge <arg choice=\"plain\" "
2643 "rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> <arg "
2644 "choice='plain'>source <arg choice=\"plain\" "
2645 "rep=\"repeat\"><replaceable>pkg</replaceable> <arg> <group choice='req'> "
2646 "<arg choice='plain'> =<replaceable>pkg_version_number</replaceable> </arg> "
2647 "<arg choice='plain'> /<replaceable>target_release</replaceable> </arg> "
2648 "</group> </arg> </arg> </arg> <arg choice='plain'>build-dep <arg "
2649 "choice=\"plain\" rep=\"repeat\"><replaceable>pkg</replaceable></arg></arg> "
2650 "<arg choice='plain'>check</arg> <arg choice='plain'>clean</arg> <arg "
2651 "choice='plain'>autoclean</arg> <arg choice='plain'>autoremove</arg> <arg "
2652 "choice='plain'> <group choice='req'> <arg choice='plain'>-v</arg> <arg "
2653 "choice='plain'>--version</arg> </group> </arg> <arg choice='plain'> <group "
2654 "choice='req'> <arg choice='plain'>-h</arg> <arg choice='plain'>--help</arg> "
2655 "</group> </arg> </group>"
2658 #. type: Content of: <refentry><refsect1><para>
2659 #: apt-get.8.xml:122
2661 "<command>apt-get</command> is the command-line tool for handling packages, "
2662 "and may be considered the user's \"back-end\" to other tools using the APT "
2663 "library. Several \"front-end\" interfaces exist, such as &dselect;, "
2664 "&aptitude;, &synaptic; and &wajig;."
2667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2668 #: apt-get.8.xml:131 apt-key.8.xml:127
2672 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2673 #: apt-get.8.xml:132
2675 "<literal>update</literal> is used to resynchronize the package index files "
2676 "from their sources. The indexes of available packages are fetched from the "
2677 "location(s) specified in <filename>/etc/apt/sources.list</filename>. For "
2678 "example, when using a Debian archive, this command retrieves and scans the "
2679 "<filename>Packages.gz</filename> files, so that information about new and "
2680 "updated packages is available. An <literal>update</literal> should always be "
2681 "performed before an <literal>upgrade</literal> or "
2682 "<literal>dist-upgrade</literal>. Please be aware that the overall progress "
2683 "meter will be incorrect as the size of the package files cannot be known in "
2687 #. type: <tag></tag>
2688 #: apt-get.8.xml:143 guide.sgml:121
2692 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2693 #: apt-get.8.xml:144
2695 "<literal>upgrade</literal> is used to install the newest versions of all "
2696 "packages currently installed on the system from the sources enumerated in "
2697 "<filename>/etc/apt/sources.list</filename>. Packages currently installed "
2698 "with new versions available are retrieved and upgraded; under no "
2699 "circumstances are currently installed packages removed, or packages not "
2700 "already installed retrieved and installed. New versions of currently "
2701 "installed packages that cannot be upgraded without changing the install "
2702 "status of another package will be left at their current version. An "
2703 "<literal>update</literal> must be performed first so that "
2704 "<command>apt-get</command> knows that new versions of packages are "
2708 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2709 #: apt-get.8.xml:156
2710 msgid "dselect-upgrade"
2713 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2714 #: apt-get.8.xml:157
2716 "<literal>dselect-upgrade</literal> is used in conjunction with the "
2717 "traditional Debian packaging front-end, "
2718 "&dselect;. <literal>dselect-upgrade</literal> follows the changes made by "
2719 "&dselect; to the <literal>Status</literal> field of available packages, and "
2720 "performs the actions necessary to realize that state (for instance, the "
2721 "removal of old and the installation of new packages)."
2724 #. type: <tag></tag>
2725 #: apt-get.8.xml:166 guide.sgml:140
2726 msgid "dist-upgrade"
2729 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2730 #: apt-get.8.xml:167
2732 "<literal>dist-upgrade</literal> in addition to performing the function of "
2733 "<literal>upgrade</literal>, also intelligently handles changing dependencies "
2734 "with new versions of packages; <command>apt-get</command> has a \"smart\" "
2735 "conflict resolution system, and it will attempt to upgrade the most "
2736 "important packages at the expense of less important ones if necessary. So, "
2737 "<literal>dist-upgrade</literal> command may remove some packages. The "
2738 "<filename>/etc/apt/sources.list</filename> file contains a list of locations "
2739 "from which to retrieve desired package files. See also &apt-preferences; "
2740 "for a mechanism for overriding the general settings for individual packages."
2743 #. type: <tag></tag>
2744 #: apt-get.8.xml:179 guide.sgml:131
2748 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2749 #: apt-get.8.xml:181
2751 "<literal>install</literal> is followed by one or more packages desired for "
2752 "installation or upgrading. Each package is a package name, not a fully "
2753 "qualified filename (for instance, in a Debian GNU/Linux system, libc6 would "
2754 "be the argument provided, not <literal>libc6_1.9.6-2.deb</literal>). All "
2755 "packages required by the package(s) specified for installation will also be "
2756 "retrieved and installed. The <filename>/etc/apt/sources.list</filename> "
2757 "file is used to locate the desired packages. If a hyphen is appended to the "
2758 "package name (with no intervening space), the identified package will be "
2759 "removed if it is installed. Similarly a plus sign can be used to designate "
2760 "a package to install. These latter features may be used to override "
2761 "decisions made by apt-get's conflict resolution system."
2764 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2765 #: apt-get.8.xml:199
2767 "A specific version of a package can be selected for installation by "
2768 "following the package name with an equals and the version of the package to "
2769 "select. This will cause that version to be located and selected for "
2770 "install. Alternatively a specific distribution can be selected by following "
2771 "the package name with a slash and the version of the distribution or the "
2772 "Archive name (stable, testing, unstable)."
2775 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2776 #: apt-get.8.xml:206
2778 "Both of the version selection mechanisms can downgrade packages and must be "
2782 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2783 #: apt-get.8.xml:209
2785 "This is also the target to use if you want to upgrade one or more "
2786 "already-installed packages without upgrading every package you have on your "
2787 "system. Unlike the \"upgrade\" target, which installs the newest version of "
2788 "all currently installed packages, \"install\" will install the newest "
2789 "version of only the package(s) specified. Simply provide the name of the "
2790 "package(s) you wish to upgrade, and if a newer version is available, it (and "
2791 "its dependencies, as described above) will be downloaded and installed."
2794 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2795 #: apt-get.8.xml:220
2797 "Finally, the &apt-preferences; mechanism allows you to create an alternative "
2798 "installation policy for individual packages."
2801 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2802 #: apt-get.8.xml:224
2804 "If no package matches the given expression and the expression contains one "
2805 "of '.', '?' or '*' then it is assumed to be a POSIX regular expression, and "
2806 "it is applied to all package names in the database. Any matches are then "
2807 "installed (or removed). Note that matching is done by substring so 'lo.*' "
2808 "matches 'how-lo' and 'lowest'. If this is undesired, anchor the regular "
2809 "expression with a '^' or '$' character, or create a more specific regular "
2813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2814 #: apt-get.8.xml:233
2818 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2819 #: apt-get.8.xml:234
2821 "<literal>remove</literal> is identical to <literal>install</literal> except "
2822 "that packages are removed instead of installed. Note the removing a package "
2823 "leaves its configuration files in system. If a plus sign is appended to the "
2824 "package name (with no intervening space), the identified package will be "
2825 "installed instead of removed."
2828 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2829 #: apt-get.8.xml:241
2833 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2834 #: apt-get.8.xml:242
2836 "<literal>purge</literal> is identical to <literal>remove</literal> except "
2837 "that packages are removed and purged (any configuration files are deleted "
2841 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2842 #: apt-get.8.xml:246
2846 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2847 #: apt-get.8.xml:247
2849 "<literal>source</literal> causes <command>apt-get</command> to fetch source "
2850 "packages. APT will examine the available packages to decide which source "
2851 "package to fetch. It will then find and download into the current directory "
2852 "the newest available version of that source package while respect the "
2853 "default release, set with the option "
2854 "<literal>APT::Default-Release</literal>, the <option>-t</option> option or "
2855 "per package with the <literal>pkg/release</literal> syntax, if possible."
2858 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2859 #: apt-get.8.xml:255
2861 "Source packages are tracked separately from binary packages via "
2862 "<literal>deb-src</literal> type lines in the &sources-list; file. This means "
2863 "that you will need to add such a line for each repository you want to get "
2864 "sources from. If you don't do this you will properly get another (newer, "
2865 "older or none) source version than the one you have installed or could "
2869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2870 #: apt-get.8.xml:262
2872 "If the <option>--compile</option> option is specified then the package will "
2873 "be compiled to a binary .deb using <command>dpkg-buildpackage</command> for "
2874 "the architecture as defined by the <command>--host-architecture</command> "
2875 "option. If <option>--download-only</option> is specified then the source "
2876 "package will not be unpacked."
2879 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2880 #: apt-get.8.xml:269
2882 "A specific source version can be retrieved by postfixing the source name "
2883 "with an equals and then the version to fetch, similar to the mechanism used "
2884 "for the package files. This enables exact matching of the source package "
2885 "name and version, implicitly enabling the "
2886 "<literal>APT::Get::Only-Source</literal> option."
2889 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2890 #: apt-get.8.xml:275
2892 "Note that source packages are not tracked like binary packages, they exist "
2893 "only in the current directory and are similar to downloading source tar "
2897 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2898 #: apt-get.8.xml:280
2902 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2903 #: apt-get.8.xml:281
2905 "<literal>build-dep</literal> causes apt-get to install/remove packages in an "
2906 "attempt to satisfy the build dependencies for a source package. By default "
2907 "the dependencies are satisfied to build the package nativly. If desired a "
2908 "host-architecture can be specified with the "
2909 "<option>--host-architecture</option> option instead."
2912 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2913 #: apt-get.8.xml:287
2917 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2918 #: apt-get.8.xml:288
2920 "<literal>check</literal> is a diagnostic tool; it updates the package cache "
2921 "and checks for broken dependencies."
2924 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2925 #: apt-get.8.xml:292
2929 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2930 #: apt-get.8.xml:293
2932 "<literal>download</literal> will download the given binary package into the "
2933 "current directory."
2936 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2937 #: apt-get.8.xml:299
2939 "<literal>clean</literal> clears out the local repository of retrieved "
2940 "package files. It removes everything but the lock file from "
2941 "<filename>&cachedir;/archives/</filename> and "
2942 "<filename>&cachedir;/archives/partial/</filename>. When APT is used as a "
2943 "&dselect; method, <literal>clean</literal> is run automatically. Those who "
2944 "do not use dselect will likely want to run <literal>apt-get clean</literal> "
2945 "from time to time to free up disk space."
2948 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2949 #: apt-get.8.xml:308
2953 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2954 #: apt-get.8.xml:309
2956 "Like <literal>clean</literal>, <literal>autoclean</literal> clears out the "
2957 "local repository of retrieved package files. The difference is that it only "
2958 "removes package files that can no longer be downloaded, and are largely "
2959 "useless. This allows a cache to be maintained over a long period without it "
2960 "growing out of control. The configuration option "
2961 "<literal>APT::Clean-Installed</literal> will prevent installed packages from "
2962 "being erased if it is set to off."
2965 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2966 #: apt-get.8.xml:318
2970 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2971 #: apt-get.8.xml:319
2973 "<literal>autoremove</literal> is used to remove packages that were "
2974 "automatically installed to satisfy dependencies for other packages and are "
2975 "now no longer needed."
2978 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2979 #: apt-get.8.xml:323
2983 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
2984 #: apt-get.8.xml:324
2986 "<literal>changelog</literal> downloads a package changelog and displays it "
2987 "through <command>sensible-pager</command>. The server name and base "
2988 "directory is defined in the <literal>APT::Changelogs::Server</literal> "
2989 "variable (e. g. <ulink>http://packages.debian.org/changelogs</ulink> for "
2990 "Debian or <ulink>http://changelogs.ubuntu.com/changelogs</ulink> for "
2991 "Ubuntu). By default it displays the changelog for the version that is "
2992 "installed. However, you can specify the same options as for the "
2993 "<option>install</option> command."
2996 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
2997 #: apt-get.8.xml:346
2998 msgid "<option>--no-install-recommends</option>"
3001 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3002 #: apt-get.8.xml:347
3004 "Do not consider recommended packages as a dependency for installing. "
3005 "Configuration Item: <literal>APT::Install-Recommends</literal>."
3008 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3009 #: apt-get.8.xml:351
3010 msgid "<option>--install-suggests</option>"
3013 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3014 #: apt-get.8.xml:352
3016 "Consider suggested packages as a dependency for installing. Configuration "
3017 "Item: <literal>APT::Install-Suggests</literal>."
3020 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3021 #: apt-get.8.xml:356
3022 msgid "<option>--download-only</option>"
3025 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3026 #: apt-get.8.xml:357
3028 "Download only; package files are only retrieved, not unpacked or installed. "
3029 "Configuration Item: <literal>APT::Get::Download-Only</literal>."
3032 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3033 #: apt-get.8.xml:361
3034 msgid "<option>--fix-broken</option>"
3037 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3038 #: apt-get.8.xml:362
3040 "Fix; attempt to correct a system with broken dependencies in place. This "
3041 "option, when used with install/remove, can omit any packages to permit APT "
3042 "to deduce a likely solution. If packages are specified, these have to "
3043 "completely correct the problem. The option is sometimes necessary when "
3044 "running APT for the first time; APT itself does not allow broken package "
3045 "dependencies to exist on a system. It is possible that a system's dependency "
3046 "structure can be so corrupt as to require manual intervention (which usually "
3047 "means using &dselect; or <command>dpkg --remove</command> to eliminate some "
3048 "of the offending packages). Use of this option together with "
3049 "<option>-m</option> may produce an error in some situations. Configuration "
3050 "Item: <literal>APT::Get::Fix-Broken</literal>."
3053 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3054 #: apt-get.8.xml:375
3055 msgid "<option>--ignore-missing</option>"
3058 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3059 #: apt-get.8.xml:376
3060 msgid "<option>--fix-missing</option>"
3063 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3064 #: apt-get.8.xml:377
3066 "Ignore missing packages; If packages cannot be retrieved or fail the "
3067 "integrity check after retrieval (corrupted package files), hold back those "
3068 "packages and handle the result. Use of this option together with "
3069 "<option>-f</option> may produce an error in some situations. If a package is "
3070 "selected for installation (particularly if it is mentioned on the command "
3071 "line) and it could not be downloaded then it will be silently held back. "
3072 "Configuration Item: <literal>APT::Get::Fix-Missing</literal>."
3075 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3076 #: apt-get.8.xml:387
3077 msgid "<option>--no-download</option>"
3080 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3081 #: apt-get.8.xml:388
3083 "Disables downloading of packages. This is best used with "
3084 "<option>--ignore-missing</option> to force APT to use only the .debs it has "
3085 "already downloaded. Configuration Item: "
3086 "<literal>APT::Get::Download</literal>."
3089 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3090 #: apt-get.8.xml:395
3092 "Quiet; produces output suitable for logging, omitting progress indicators. "
3093 "More q's will produce more quiet up to a maximum of 2. You can also use "
3094 "<option>-q=#</option> to set the quiet level, overriding the configuration "
3095 "file. Note that quiet level 2 implies <option>-y</option>, you should never "
3096 "use -qq without a no-action modifier such as -d, --print-uris or -s as APT "
3097 "may decided to do something you did not expect. Configuration Item: "
3098 "<literal>quiet</literal>."
3101 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3102 #: apt-get.8.xml:405
3103 msgid "<option>--simulate</option>"
3106 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3107 #: apt-get.8.xml:407
3108 msgid "<option>--dry-run</option>"
3111 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3112 #: apt-get.8.xml:410
3114 "No action; perform a simulation of events that would occur but do not "
3115 "actually change the system. Configuration Item: "
3116 "<literal>APT::Get::Simulate</literal>."
3119 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3120 #: apt-get.8.xml:414
3122 "Simulation run as user will deactivate locking "
3123 "(<literal>Debug::NoLocking</literal>) automatic. Also a notice will be "
3124 "displayed indicating that this is only a simulation, if the option "
3125 "<literal>APT::Get::Show-User-Simulation-Note</literal> is set (Default: "
3126 "true). Neither NoLocking nor the notice will be triggered if run as root "
3127 "(root should know what he is doing without further warnings by "
3128 "<literal>apt-get</literal>)."
3131 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3132 #: apt-get.8.xml:420
3134 "Simulate prints out a series of lines each one representing a dpkg "
3135 "operation, Configure (Conf), Remove (Remv), Unpack (Inst). Square brackets "
3136 "indicate broken packages and empty set of square brackets meaning breaks "
3137 "that are of no consequence (rare)."
3140 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3141 #: apt-get.8.xml:427
3142 msgid "<option>-y</option>"
3145 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3146 #: apt-get.8.xml:427
3147 msgid "<option>--yes</option>"
3150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3151 #: apt-get.8.xml:428
3152 msgid "<option>--assume-yes</option>"
3155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3156 #: apt-get.8.xml:429
3158 "Automatic yes to prompts; assume \"yes\" as answer to all prompts and run "
3159 "non-interactively. If an undesirable situation, such as changing a held "
3160 "package, trying to install a unauthenticated package or removing an "
3161 "essential package occurs then <literal>apt-get</literal> will abort. "
3162 "Configuration Item: <literal>APT::Get::Assume-Yes</literal>."
3165 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3166 #: apt-get.8.xml:436
3167 msgid "<option>-u</option>"
3170 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3171 #: apt-get.8.xml:436
3172 msgid "<option>--show-upgraded</option>"
3175 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3176 #: apt-get.8.xml:437
3178 "Show upgraded packages; Print out a list of all packages that are to be "
3179 "upgraded. Configuration Item: <literal>APT::Get::Show-Upgraded</literal>."
3182 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3183 #: apt-get.8.xml:442
3184 msgid "<option>-V</option>"
3187 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3188 #: apt-get.8.xml:442
3189 msgid "<option>--verbose-versions</option>"
3192 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3193 #: apt-get.8.xml:443
3195 "Show full versions for upgraded and installed packages. Configuration Item: "
3196 "<literal>APT::Get::Show-Versions</literal>."
3199 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3200 #: apt-get.8.xml:448
3201 msgid "<option>--host-architecture</option>"
3204 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3205 #: apt-get.8.xml:449
3207 "This option controls the architecture packages are built for by "
3208 "<command>apt-get source --compile</command> and how cross-builddependencies "
3209 "are satisfied. By default is not set which means that the host architecture "
3210 "is the same as the build architecture (which is defined by "
3211 "<literal>APT::Architecture</literal>) Configuration Item: "
3212 "<literal>APT::Get::Host-Architecture</literal>"
3215 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3216 #: apt-get.8.xml:457
3217 msgid "<option>-b</option>"
3220 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3221 #: apt-get.8.xml:457
3222 msgid "<option>--compile</option>"
3225 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3226 #: apt-get.8.xml:458
3227 msgid "<option>--build</option>"
3230 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3231 #: apt-get.8.xml:459
3233 "Compile source packages after downloading them. Configuration Item: "
3234 "<literal>APT::Get::Compile</literal>."
3237 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3238 #: apt-get.8.xml:463
3239 msgid "<option>--ignore-hold</option>"
3242 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3243 #: apt-get.8.xml:464
3245 "Ignore package Holds; This causes <command>apt-get</command> to ignore a "
3246 "hold placed on a package. This may be useful in conjunction with "
3247 "<literal>dist-upgrade</literal> to override a large number of undesired "
3248 "holds. Configuration Item: <literal>APT::Ignore-Hold</literal>."
3251 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3252 #: apt-get.8.xml:470
3253 msgid "<option>--no-upgrade</option>"
3256 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3257 #: apt-get.8.xml:471
3259 "Do not upgrade packages; When used in conjunction with "
3260 "<literal>install</literal>, <literal>no-upgrade</literal> will prevent "
3261 "packages on the command line from being upgraded if they are already "
3262 "installed. Configuration Item: <literal>APT::Get::Upgrade</literal>."
3265 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3266 #: apt-get.8.xml:477
3267 msgid "<option>--only-upgrade</option>"
3270 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3271 #: apt-get.8.xml:478
3273 "Do not install new packages; When used in conjunction with "
3274 "<literal>install</literal>, <literal>only-upgrade</literal> will prevent "
3275 "packages on the command line from being upgraded if they are not already "
3276 "installed. Configuration Item: <literal>APT::Get::Only-Upgrade</literal>."
3279 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3280 #: apt-get.8.xml:484
3281 msgid "<option>--force-yes</option>"
3284 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3285 #: apt-get.8.xml:485
3287 "Force yes; This is a dangerous option that will cause apt to continue "
3288 "without prompting if it is doing something potentially harmful. It should "
3289 "not be used except in very special situations. Using "
3290 "<literal>force-yes</literal> can potentially destroy your system! "
3291 "Configuration Item: <literal>APT::Get::force-yes</literal>."
3294 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3295 #: apt-get.8.xml:492
3296 msgid "<option>--print-uris</option>"
3299 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3300 #: apt-get.8.xml:493
3302 "Instead of fetching the files to install their URIs are printed. Each URI "
3303 "will have the path, the destination file name, the size and the expected md5 "
3304 "hash. Note that the file name to write to will not always match the file "
3305 "name on the remote site! This also works with the <literal>source</literal> "
3306 "and <literal>update</literal> commands. When used with the "
3307 "<literal>update</literal> command the MD5 and size are not included, and it "
3308 "is up to the user to decompress any compressed files. Configuration Item: "
3309 "<literal>APT::Get::Print-URIs</literal>."
3312 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3313 #: apt-get.8.xml:503
3314 msgid "<option>--purge</option>"
3317 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3318 #: apt-get.8.xml:504
3320 "Use purge instead of remove for anything that would be removed. An asterisk "
3321 "(\"*\") will be displayed next to packages which are scheduled to be "
3322 "purged. <option>remove --purge</option> is equivalent to the "
3323 "<option>purge</option> command. Configuration Item: "
3324 "<literal>APT::Get::Purge</literal>."
3327 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3328 #: apt-get.8.xml:511
3329 msgid "<option>--reinstall</option>"
3332 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3333 #: apt-get.8.xml:512
3335 "Re-Install packages that are already installed and at the newest version. "
3336 "Configuration Item: <literal>APT::Get::ReInstall</literal>."
3339 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3340 #: apt-get.8.xml:516
3341 msgid "<option>--list-cleanup</option>"
3344 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3345 #: apt-get.8.xml:517
3347 "This option defaults to on, use <literal>--no-list-cleanup</literal> to turn "
3348 "it off. When on <command>apt-get</command> will automatically manage the "
3349 "contents of <filename>&statedir;/lists</filename> to ensure that obsolete "
3350 "files are erased. The only reason to turn it off is if you frequently "
3351 "change your source list. Configuration Item: "
3352 "<literal>APT::Get::List-Cleanup</literal>."
3355 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3356 #: apt-get.8.xml:526
3357 msgid "<option>--target-release</option>"
3360 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3361 #: apt-get.8.xml:527
3362 msgid "<option>--default-release</option>"
3365 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3366 #: apt-get.8.xml:528
3368 "This option controls the default input to the policy engine, it creates a "
3369 "default pin at priority 990 using the specified release string. This "
3370 "overrides the general settings in "
3371 "<filename>/etc/apt/preferences</filename>. Specifically pinned packages are "
3372 "not affected by the value of this option. In short, this option lets you "
3373 "have simple control over which distribution packages will be retrieved "
3374 "from. Some common examples might be <option>-t '2.1*'</option>, <option>-t "
3375 "unstable</option> or <option>-t sid</option>. Configuration Item: "
3376 "<literal>APT::Default-Release</literal>; see also the &apt-preferences; "
3380 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3381 #: apt-get.8.xml:541
3382 msgid "<option>--trivial-only</option>"
3385 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3386 #: apt-get.8.xml:543
3388 "Only perform operations that are 'trivial'. Logically this can be considered "
3389 "related to <option>--assume-yes</option>, where "
3390 "<option>--assume-yes</option> will answer yes to any prompt, "
3391 "<option>--trivial-only</option> will answer no. Configuration Item: "
3392 "<literal>APT::Get::Trivial-Only</literal>."
3395 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3396 #: apt-get.8.xml:549
3397 msgid "<option>--no-remove</option>"
3400 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3401 #: apt-get.8.xml:550
3403 "If any packages are to be removed apt-get immediately aborts without "
3404 "prompting. Configuration Item: <literal>APT::Get::Remove</literal>."
3407 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3408 #: apt-get.8.xml:555
3409 msgid "<option>--auto-remove</option>"
3412 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3413 #: apt-get.8.xml:556
3415 "If the command is either <literal>install</literal> or "
3416 "<literal>remove</literal>, then this option acts like running "
3417 "<literal>autoremove</literal> command, removing the unused dependency "
3418 "packages. Configuration Item: <literal>APT::Get::AutomaticRemove</literal>."
3421 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3422 #: apt-get.8.xml:562
3423 msgid "<option>--only-source</option>"
3426 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3427 #: apt-get.8.xml:563
3429 "Only has meaning for the <literal>source</literal> and "
3430 "<literal>build-dep</literal> commands. Indicates that the given source "
3431 "names are not to be mapped through the binary table. This means that if "
3432 "this option is specified, these commands will only accept source package "
3433 "names as arguments, rather than accepting binary package names and looking "
3434 "up the corresponding source package. Configuration Item: "
3435 "<literal>APT::Get::Only-Source</literal>."
3438 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3439 #: apt-get.8.xml:573
3440 msgid "<option>--diff-only</option>"
3443 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3444 #: apt-get.8.xml:573
3445 msgid "<option>--dsc-only</option>"
3448 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3449 #: apt-get.8.xml:573
3450 msgid "<option>--tar-only</option>"
3453 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3454 #: apt-get.8.xml:574
3456 "Download only the diff, dsc, or tar file of a source archive. Configuration "
3457 "Item: <literal>APT::Get::Diff-Only</literal>, "
3458 "<literal>APT::Get::Dsc-Only</literal>, and "
3459 "<literal>APT::Get::Tar-Only</literal>."
3462 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3463 #: apt-get.8.xml:579
3464 msgid "<option>--arch-only</option>"
3467 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3468 #: apt-get.8.xml:580
3470 "Only process architecture-dependent build-dependencies. Configuration Item: "
3471 "<literal>APT::Get::Arch-Only</literal>."
3474 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3475 #: apt-get.8.xml:584
3476 msgid "<option>--allow-unauthenticated</option>"
3479 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3480 #: apt-get.8.xml:585
3482 "Ignore if packages can't be authenticated and don't prompt about it. This "
3483 "is useful for tools like pbuilder. Configuration Item: "
3484 "<literal>APT::Get::AllowUnauthenticated</literal>."
3487 #. type: Content of: <refentry><refsect1><variablelist>
3488 #: apt-get.8.xml:598
3490 "&file-sourceslist; &file-aptconf; &file-preferences; &file-cachearchives; "
3494 #. type: Content of: <refentry><refsect1><para>
3495 #: apt-get.8.xml:607
3497 "&apt-cache;, &apt-cdrom;, &dpkg;, &dselect;, &sources-list;, &apt-conf;, "
3498 "&apt-config;, &apt-secure;, The APT User's guide in &guidesdir;, "
3499 "&apt-preferences;, the APT Howto."
3502 #. type: Content of: <refentry><refsect1><para>
3503 #: apt-get.8.xml:613
3505 "<command>apt-get</command> returns zero on normal operation, decimal 100 on "
3509 #. type: Content of: <refentry><refsect1><title>
3510 #: apt-get.8.xml:616
3511 msgid "ORIGINAL AUTHORS"
3514 #. type: Content of: <refentry><refsect1><para>
3515 #: apt-get.8.xml:617
3516 msgid "&apt-author.jgunthorpe;"
3519 #. type: Content of: <refentry><refsect1><title>
3520 #: apt-get.8.xml:620
3521 msgid "CURRENT AUTHORS"
3524 #. type: Content of: <refentry><refsect1><para>
3525 #: apt-get.8.xml:622
3526 msgid "&apt-author.team;"
3529 #. type: Content of: <refentry><refnamediv><refname>
3530 #: apt-key.8.xml:17 apt-key.8.xml:24
3534 #. type: Content of: <refentry><refnamediv><refpurpose>
3536 msgid "APT key management utility"
3539 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3542 "<command>apt-key</command> <arg><option>--keyring "
3543 "<replaceable>filename</replaceable></option></arg> "
3544 "<arg><replaceable>command</replaceable></arg> <arg "
3545 "rep=\"repeat\"><option><replaceable>arguments</replaceable></option></arg>"
3548 #. type: Content of: <refentry><refsect1><para>
3551 "<command>apt-key</command> is used to manage the list of keys used by apt to "
3552 "authenticate packages. Packages which have been authenticated using these "
3553 "keys will be considered trusted."
3556 #. type: Content of: <refentry><refsect1><title>
3561 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3563 msgid "add <replaceable>filename</replaceable>"
3566 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3569 "Add a new key to the list of trusted keys. The key is read from "
3570 "<replaceable>filename</replaceable>, or standard input if "
3571 "<replaceable>filename</replaceable> is <literal>-</literal>."
3574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3576 msgid "del <replaceable>keyid</replaceable>"
3579 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3581 msgid "Remove a key from the list of trusted keys."
3584 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3586 msgid "export <replaceable>keyid</replaceable>"
3589 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3591 msgid "Output the key <replaceable>keyid</replaceable> to standard output."
3594 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3599 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3601 msgid "Output all trusted keys to standard output."
3604 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3609 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3611 msgid "List trusted keys."
3614 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3615 #: apt-key.8.xml:104
3619 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3620 #: apt-key.8.xml:108
3621 msgid "List fingerprints of trusted keys."
3624 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3625 #: apt-key.8.xml:115
3629 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3630 #: apt-key.8.xml:119
3632 "Pass advanced options to gpg. With adv --recv-key you can download the "
3636 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3637 #: apt-key.8.xml:131
3639 "Update the local keyring with the archive keyring and remove from the local "
3640 "keyring the archive keys which are no longer valid. The archive keyring is "
3641 "shipped in the <literal>archive-keyring</literal> package of your "
3642 "distribution, e.g. the <literal>debian-archive-keyring</literal> package in "
3646 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3647 #: apt-key.8.xml:141
3651 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3652 #: apt-key.8.xml:145
3654 "Work similar to the <command>update</command> command above, but get the "
3655 "archive keyring from an URI instead and validate it against a master key. "
3656 "This requires an installed &wget; and an APT build configured to have a "
3657 "server to fetch from and a master keyring to validate. APT in Debian does "
3658 "not support this command and relies on <command>update</command> instead, "
3659 "but Ubuntu's APT does."
3662 #. type: Content of: <refentry><refsect1><para>
3663 #: apt-key.8.xml:162
3665 "Note that options need to be defined before the commands described in the "
3669 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3670 #: apt-key.8.xml:164
3671 msgid "--keyring <replaceable>filename</replaceable>"
3674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3675 #: apt-key.8.xml:165
3677 "With this option it is possible to specify a specific keyring file the "
3678 "command should operate on. The default is that a command is executed on the "
3679 "<filename>trusted.gpg</filename> file as well as on all parts in the "
3680 "<filename>trusted.gpg.d</filename> directory, through "
3681 "<filename>trusted.gpg</filename> is the primary keyring which means that "
3682 "e.g. new keys are added to this one."
3685 #. type: Content of: <refentry><refsect1><variablelist>
3686 #: apt-key.8.xml:178
3687 msgid "&file-trustedgpg;"
3690 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3691 #: apt-key.8.xml:180
3692 msgid "<filename>/etc/apt/trustdb.gpg</filename>"
3695 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3696 #: apt-key.8.xml:181
3697 msgid "Local trust database of archive keys."
3700 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3701 #: apt-key.8.xml:184
3702 msgid "<filename>/usr/share/keyrings/debian-archive-keyring.gpg</filename>"
3705 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3706 #: apt-key.8.xml:185
3707 msgid "Keyring of Debian archive trusted keys."
3710 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3711 #: apt-key.8.xml:188
3712 msgid "<filename>/usr/share/keyrings/debian-archive-removed-keys.gpg</filename>"
3715 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3716 #: apt-key.8.xml:189
3717 msgid "Keyring of Debian archive removed trusted keys."
3720 #. type: Content of: <refentry><refsect1><para>
3721 #: apt-key.8.xml:198
3722 msgid "&apt-get;, &apt-secure;"
3725 #. The last update date
3726 #. type: Content of: <refentry><refentryinfo>
3727 #: apt-mark.8.xml:16
3729 "&apt-author.moconnor; &apt-author.team; &apt-email; &apt-product; <date>21 "
3733 #. type: Content of: <refentry><refnamediv><refname>
3734 #: apt-mark.8.xml:25 apt-mark.8.xml:32
3738 #. type: Content of: <refentry><refnamediv><refpurpose>
3739 #: apt-mark.8.xml:33
3740 msgid "mark/unmark a package as being automatically-installed"
3743 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
3744 #: apt-mark.8.xml:39
3746 " <command>apt-mark</command> <arg><option>-hv</option></arg> "
3747 "<arg><option>-f=<replaceable>FILENAME</replaceable></option></arg> <group "
3748 "choice=\"plain\"> <arg choice=\"plain\"> <group choice=\"req\"> <arg "
3749 "choice=\"plain\">auto</arg> <arg choice=\"plain\">manual</arg> <arg "
3750 "choice=\"plain\">showauto</arg> <arg choice=\"plain\">showmanual</arg> "
3751 "</group> <arg choice=\"plain\" "
3752 "rep=\"repeat\"><replaceable>package</replaceable></arg> </arg> </group>"
3755 #. type: Content of: <refentry><refsect1><para>
3756 #: apt-mark.8.xml:57
3758 "<command>apt-mark</command> will change whether a package has been marked as "
3759 "being automatically installed."
3762 #. type: Content of: <refentry><refsect1><para>
3763 #: apt-mark.8.xml:61
3765 "When you request that a package is installed, and as a result other packages "
3766 "are installed to satisfy its dependencies, the dependencies are marked as "
3767 "being automatically installed. Once these automatically installed packages "
3768 "are no longer depended on by any manually installed packages, they will be "
3769 "removed by e.g. <command>apt-get</command> or <command>aptitude</command>."
3772 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3773 #: apt-mark.8.xml:69
3777 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3778 #: apt-mark.8.xml:70
3780 "<literal>auto</literal> is used to mark a package as being automatically "
3781 "installed, which will cause the package to be removed when no more manually "
3782 "installed packages depend on this package."
3785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3786 #: apt-mark.8.xml:77
3790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3791 #: apt-mark.8.xml:78
3793 "<literal>manual</literal> is used to mark a package as being manually "
3794 "installed, which will prevent the package from being automatically removed "
3795 "if no other packages depend on it."
3798 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3799 #: apt-mark.8.xml:85
3803 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3804 #: apt-mark.8.xml:86
3806 "<literal>hold</literal> is used to mark a package as hold back, which will "
3807 "prevent the package from being automatically installed, upgraded or "
3808 "removed. The command is only a wrapper around <command>dpkg "
3809 "--set-selections</command> and the state is therefore maintained by &dpkg; "
3810 "and not effected by the <option>--filename</option> option."
3813 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3814 #: apt-mark.8.xml:95
3818 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3819 #: apt-mark.8.xml:96
3821 "<literal>unhold</literal> is used to cancel a previously set hold on a "
3822 "package to allow all actions again."
3825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3826 #: apt-mark.8.xml:101
3830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3831 #: apt-mark.8.xml:102
3833 "<literal>showauto</literal> is used to print a list of automatically "
3834 "installed packages with each package on a new line. All automatically "
3835 "installed packages will be listed if no package is given. If packages are "
3836 "given only those which are automatically installed will be shown."
3839 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3840 #: apt-mark.8.xml:109
3844 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3845 #: apt-mark.8.xml:110
3847 "<literal>showmanual</literal> can be used in the same way as "
3848 "<literal>showauto</literal> except that it will print a list of manually "
3849 "installed packages instead."
3852 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3853 #: apt-mark.8.xml:116
3857 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3858 #: apt-mark.8.xml:117
3860 "<literal>showhold</literal> is used to print a list of packages on hold in "
3861 "the same way as for the other show commands."
3864 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3865 #: apt-mark.8.xml:130
3866 msgid "<option>-f=<filename><replaceable>FILENAME</replaceable></filename></option>"
3869 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
3870 #: apt-mark.8.xml:131
3871 msgid "<option>--file=<filename><replaceable>FILENAME</replaceable></filename></option>"
3874 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
3875 #: apt-mark.8.xml:134
3877 "Read/Write package stats from "
3878 "<filename><replaceable>FILENAME</replaceable></filename> instead of the "
3879 "default location, which is <filename>extended_status</filename> in the "
3880 "directory defined by the Configuration Item: <literal>Dir::State</literal>."
3883 #. type: Content of: <refentry><refsect1><variablelist>
3884 #: apt-mark.8.xml:146
3885 msgid " &file-extended_states;"
3888 #. type: Content of: <refentry><refsect1><para>
3889 #: apt-mark.8.xml:151
3890 msgid "&apt-get;,&aptitude;,&apt-conf;"
3893 #. type: Content of: <refentry><refsect1><para>
3894 #: apt-mark.8.xml:155
3896 "<command>apt-mark</command> returns zero on normal operation, non-zero on "
3900 #. type: Content of: <refentry><refnamediv><refname>
3901 #: apt-secure.8.xml:17 apt-secure.8.xml:39
3905 #. type: Content of: <refentry><refnamediv><refpurpose>
3906 #: apt-secure.8.xml:40
3907 msgid "Archive authentication support for APT"
3910 #. type: Content of: <refentry><refsect1><para>
3911 #: apt-secure.8.xml:45
3913 "Starting with version 0.6, <command>apt</command> contains code that does "
3914 "signature checking of the Release file for all archives. This ensures that "
3915 "packages in the archive can't be modified by people who have no access to "
3916 "the Release file signing key."
3919 #. type: Content of: <refentry><refsect1><para>
3920 #: apt-secure.8.xml:53
3922 "If a package comes from a archive without a signature or with a signature "
3923 "that apt does not have a key for that package is considered untrusted and "
3924 "installing it will result in a big warning. <command>apt-get</command> will "
3925 "currently only warn for unsigned archives, future releases might force all "
3926 "sources to be verified before downloading packages from them."
3929 #. type: Content of: <refentry><refsect1><para>
3930 #: apt-secure.8.xml:62
3932 "The package frontends &apt-get;, &aptitude; and &synaptic; support this new "
3933 "authentication feature."
3936 #. type: Content of: <refentry><refsect1><title>
3937 #: apt-secure.8.xml:67
3938 msgid "Trusted archives"
3941 #. type: Content of: <refentry><refsect1><para>
3942 #: apt-secure.8.xml:70
3944 "The chain of trust from an apt archive to the end user is made up of "
3945 "different steps. <command>apt-secure</command> is the last step in this "
3946 "chain, trusting an archive does not mean that the packages that you trust it "
3947 "do not contain malicious code but means that you trust the archive "
3948 "maintainer. It's the archive maintainer responsibility to ensure that the "
3949 "archive integrity is correct."
3952 #. type: Content of: <refentry><refsect1><para>
3953 #: apt-secure.8.xml:78
3955 "apt-secure does not review signatures at a package level. If you require "
3956 "tools to do this you should look at <command>debsig-verify</command> and "
3957 "<command>debsign</command> (provided in the debsig-verify and devscripts "
3958 "packages respectively)."
3961 #. type: Content of: <refentry><refsect1><para>
3962 #: apt-secure.8.xml:85
3964 "The chain of trust in Debian starts when a maintainer uploads a new package "
3965 "or a new version of a package to the Debian archive. This upload in order to "
3966 "become effective needs to be signed by a key of a maintainer within the "
3967 "Debian maintainer's keyring (available in the debian-keyring "
3968 "package). Maintainer's keys are signed by other maintainers following "
3969 "pre-established procedures to ensure the identity of the key holder."
3972 #. type: Content of: <refentry><refsect1><para>
3973 #: apt-secure.8.xml:95
3975 "Once the uploaded package is verified and included in the archive, the "
3976 "maintainer signature is stripped off, an MD5 sum of the package is computed "
3977 "and put in the Packages file. The MD5 sum of all of the packages files are "
3978 "then computed and put into the Release file. The Release file is then signed "
3979 "by the archive key (which is created once a year) and distributed through "
3980 "the FTP server. This key is also on the Debian keyring."
3983 #. type: Content of: <refentry><refsect1><para>
3984 #: apt-secure.8.xml:105
3986 "Any end user can check the signature of the Release file, extract the MD5 "
3987 "sum of a package from it and compare it with the MD5 sum of the package he "
3988 "downloaded. Prior to version 0.6 only the MD5 sum of the downloaded Debian "
3989 "package was checked. Now both the MD5 sum and the signature of the Release "
3993 #. type: Content of: <refentry><refsect1><para>
3994 #: apt-secure.8.xml:112
3996 "Notice that this is distinct from checking signatures on a per package "
3997 "basis. It is designed to prevent two possible attacks:"
4000 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4001 #: apt-secure.8.xml:117
4003 "<literal>Network \"man in the middle\" attacks</literal>. Without signature "
4004 "checking, a malicious agent can introduce himself in the package download "
4005 "process and provide malicious software either by controlling a network "
4006 "element (router, switch, etc.) or by redirecting traffic to a rogue server "
4007 "(through arp or DNS spoofing attacks)."
4010 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4011 #: apt-secure.8.xml:125
4013 "<literal>Mirror network compromise</literal>. Without signature checking, a "
4014 "malicious agent can compromise a mirror host and modify the files in it to "
4015 "propagate malicious software to all users downloading packages from that "
4019 #. type: Content of: <refentry><refsect1><para>
4020 #: apt-secure.8.xml:132
4022 "However, it does not defend against a compromise of the Debian master server "
4023 "itself (which signs the packages) or against a compromise of the key used to "
4024 "sign the Release files. In any case, this mechanism can complement a "
4025 "per-package signature."
4028 #. type: Content of: <refentry><refsect1><title>
4029 #: apt-secure.8.xml:138
4030 msgid "User configuration"
4033 #. type: Content of: <refentry><refsect1><para>
4034 #: apt-secure.8.xml:140
4036 "<command>apt-key</command> is the program that manages the list of keys used "
4037 "by apt. It can be used to add or remove keys although an installation of "
4038 "this release will automatically provide the default Debian archive signing "
4039 "keys used in the Debian package repositories."
4042 #. type: Content of: <refentry><refsect1><para>
4043 #: apt-secure.8.xml:147
4045 "In order to add a new key you need to first download it (you should make "
4046 "sure you are using a trusted communication channel when retrieving it), add "
4047 "it with <command>apt-key</command> and then run <command>apt-get "
4048 "update</command> so that apt can download and verify the "
4049 "<filename>InRelease</filename> or <filename>Release.gpg</filename> files "
4050 "from the archives you have configured."
4053 #. type: Content of: <refentry><refsect1><title>
4054 #: apt-secure.8.xml:156
4055 msgid "Archive configuration"
4058 #. type: Content of: <refentry><refsect1><para>
4059 #: apt-secure.8.xml:158
4061 "If you want to provide archive signatures in an archive under your "
4062 "maintenance you have to:"
4065 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4066 #: apt-secure.8.xml:163
4068 "<emphasis>Create a toplevel Release file</emphasis>, if it does not exist "
4069 "already. You can do this by running <command>apt-ftparchive "
4070 "release</command> (provided in apt-utils)."
4073 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4074 #: apt-secure.8.xml:168
4076 "<emphasis>Sign it</emphasis>. You can do this by running <command>gpg "
4077 "--clearsign -o InRelease Release</command> and <command>gpg -abs -o "
4078 "Release.gpg Release</command>."
4081 #. type: Content of: <refentry><refsect1><itemizedlist><listitem><para>
4082 #: apt-secure.8.xml:172
4084 "<emphasis>Publish the key fingerprint</emphasis>, that way your users will "
4085 "know what key they need to import in order to authenticate the files in the "
4089 #. type: Content of: <refentry><refsect1><para>
4090 #: apt-secure.8.xml:179
4092 "Whenever the contents of the archive changes (new packages are added or "
4093 "removed) the archive maintainer has to follow the first two steps previously "
4097 #. type: Content of: <refentry><refsect1><para>
4098 #: apt-secure.8.xml:187
4100 "&apt-conf;, &apt-get;, &sources-list;, &apt-key;, &apt-ftparchive;, "
4101 "&debsign; &debsig-verify;, &gpg;"
4104 #. type: Content of: <refentry><refsect1><para>
4105 #: apt-secure.8.xml:191
4107 "For more background information you might want to review the <ulink "
4108 "url=\"http://www.debian.org/doc/manuals/securing-debian-howto/ch7.en.html\">Debian "
4109 "Security Infrastructure</ulink> chapter of the Securing Debian Manual "
4110 "(available also in the harden-doc package) and the <ulink "
4111 "url=\"http://www.cryptnet.net/fdp/crypto/strong_distro.html\" >Strong "
4112 "Distribution HOWTO</ulink> by V. Alex Brennen."
4115 #. type: Content of: <refentry><refsect1><title>
4116 #: apt-secure.8.xml:204
4117 msgid "Manpage Authors"
4120 #. type: Content of: <refentry><refsect1><para>
4121 #: apt-secure.8.xml:206
4123 "This man-page is based on the work of Javier Fernández-Sanguino Peña, Isaac "
4124 "Jones, Colin Walters, Florian Weimer and Michael Vogt."
4127 #. type: Content of: <refentry><refnamediv><refname>
4128 #: apt-sortpkgs.1.xml:25 apt-sortpkgs.1.xml:32
4129 msgid "apt-sortpkgs"
4132 #. type: Content of: <refentry><refnamediv><refpurpose>
4133 #: apt-sortpkgs.1.xml:33
4134 msgid "Utility to sort package index files"
4137 #. type: Content of: <refentry><refsynopsisdiv><cmdsynopsis>
4138 #: apt-sortpkgs.1.xml:39
4140 "<command>apt-sortpkgs</command> <arg><option>-hvs</option></arg> "
4141 "<arg><option>-o=<replaceable>config string</replaceable></option></arg> "
4142 "<arg><option>-c=<replaceable>file</replaceable></option></arg> <arg "
4143 "choice=\"plain\" rep=\"repeat\"><replaceable>file</replaceable></arg>"
4146 #. type: Content of: <refentry><refsect1><para>
4147 #: apt-sortpkgs.1.xml:48
4149 "<command>apt-sortpkgs</command> will take an index file (Source index or "
4150 "Package index) and sort the records so that they are ordered by the package "
4151 "name. It will also sort the internal fields of each record according to the "
4152 "internal sorting rules."
4155 #. type: Content of: <refentry><refsect1><para>
4156 #: apt-sortpkgs.1.xml:54
4157 msgid "All output is sent to stdout, the input must be a seekable file."
4160 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4161 #: apt-sortpkgs.1.xml:61
4162 msgid "<option>--source</option>"
4165 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4166 #: apt-sortpkgs.1.xml:63
4168 "Use Source index field ordering. Configuration Item: "
4169 "<literal>APT::SortPkgs::Source</literal>."
4172 #. type: Content of: <refentry><refsect1><para>
4173 #: apt-sortpkgs.1.xml:77
4175 "<command>apt-sortpkgs</command> returns zero on normal operation, decimal "
4179 #. The last update date
4180 #. type: Content of: <refentry><refentryinfo>
4181 #: apt.conf.5.xml:16
4183 "&apt-author.jgunthorpe; &apt-author.team; <author> "
4184 "<firstname>Daniel</firstname> <surname>Burrows</surname> <contrib>Initial "
4185 "documentation of Debug::*.</contrib> <email>dburrows@debian.org</email> "
4186 "</author> &apt-email; &apt-product; <date>16 January 2010</date>"
4189 #. type: Content of: <refentry><refnamediv><refname>
4190 #: apt.conf.5.xml:31 apt.conf.5.xml:38
4194 #. type: Content of: <refentry><refmeta><manvolnum>
4195 #: apt.conf.5.xml:32 apt_preferences.5.xml:25 sources.list.5.xml:26
4199 #. type: Content of: <refentry><refnamediv><refpurpose>
4200 #: apt.conf.5.xml:39
4201 msgid "Configuration file for APT"
4204 #. type: Content of: <refentry><refsect1><para>
4205 #: apt.conf.5.xml:43
4207 "<filename>apt.conf</filename> is the main configuration file for the APT "
4208 "suite of tools, but by far not the only place changes to options can be "
4209 "made. All tools therefore share the configuration files and also use a "
4210 "common command line parser to provide a uniform environment."
4213 #. type: Content of: <refentry><refsect1><orderedlist><para>
4214 #: apt.conf.5.xml:48
4216 "When an APT tool starts up it will read the configuration files in the "
4220 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4221 #: apt.conf.5.xml:50
4223 "the file specified by the <envar>APT_CONFIG</envar> environment variable (if "
4227 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4228 #: apt.conf.5.xml:52
4230 "all files in <literal>Dir::Etc::Parts</literal> in alphanumeric ascending "
4231 "order which have either no or \"<literal>conf</literal>\" as filename "
4232 "extension and which only contain alphanumeric, hyphen (-), underscore (_) "
4233 "and period (.) characters. Otherwise APT will print a notice that it has "
4234 "ignored a file if the file doesn't match a pattern in the "
4235 "<literal>Dir::Ignore-Files-Silently</literal> configuration list - in this "
4236 "case it will be silently ignored."
4239 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4240 #: apt.conf.5.xml:59
4241 msgid "the main configuration file specified by <literal>Dir::Etc::main</literal>"
4244 #. type: Content of: <refentry><refsect1><orderedlist><listitem><para>
4245 #: apt.conf.5.xml:61
4247 "the command line options are applied to override the configuration "
4248 "directives or to load even more configuration files."
4251 #. type: Content of: <refentry><refsect1><title>
4252 #: apt.conf.5.xml:65
4256 #. type: Content of: <refentry><refsect1><para>
4257 #: apt.conf.5.xml:66
4259 "The configuration file is organized in a tree with options organized into "
4260 "functional groups. Option specification is given with a double colon "
4261 "notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option "
4262 "within the APT tool group, for the Get tool. Options do not inherit from "
4263 "their parent groups."
4266 #. type: Content of: <refentry><refsect1><para>
4267 #: apt.conf.5.xml:72
4269 "Syntactically the configuration language is modeled after what the ISC tools "
4270 "such as bind and dhcp use. Lines starting with <literal>//</literal> are "
4271 "treated as comments (ignored), as well as all text between "
4272 "<literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments. "
4273 "Each line is of the form <literal>APT::Get::Assume-Yes "
4274 "\"true\";</literal>. The trailing semicolon and the quotes are required. The "
4275 "value must be on one line, and there is no kind of string concatenation. It "
4276 "must not include inside quotes. The behavior of the backslash \"\\\" and "
4277 "escaped characters inside a value is undefined and it should not be used. An "
4278 "option name may include alphanumerical characters and the \"/-:._+\" "
4279 "characters. A new scope can be opened with curly braces, like:"
4282 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4283 #: apt.conf.5.xml:86
4288 " Assume-Yes \"true\";\n"
4289 " Fix-Broken \"true\";\n"
4294 #. type: Content of: <refentry><refsect1><para>
4295 #: apt.conf.5.xml:94
4297 "with newlines placed to make it more readable. Lists can be created by "
4298 "opening a scope and including a single string enclosed in quotes followed by "
4299 "a semicolon. Multiple entries can be included, each separated by a "
4303 #. type: Content of: <refentry><refsect1><informalexample><programlisting>
4304 #: apt.conf.5.xml:99
4306 msgid "DPkg::Pre-Install-Pkgs {\"/usr/sbin/dpkg-preconfigure --apt\";};\n"
4309 #. type: Content of: <refentry><refsect1><para>
4310 #: apt.conf.5.xml:102
4312 "In general the sample configuration file in "
4313 "<filename>&docdir;examples/apt.conf</filename> &configureindex; is a good "
4314 "guide for how it should look."
4317 #. type: Content of: <refentry><refsect1><para>
4318 #: apt.conf.5.xml:106
4320 "The names of the configuration items are not case-sensitive. So in the "
4321 "previous example you could use <literal>dpkg::pre-install-pkgs</literal>."
4324 #. type: Content of: <refentry><refsect1><para>
4325 #: apt.conf.5.xml:109
4327 "Names for the configuration items are optional if a list is defined as it "
4328 "can be see in the <literal>DPkg::Pre-Install-Pkgs</literal> example "
4329 "above. If you don't specify a name a new entry will simply add a new option "
4330 "to the list. If you specify a name you can override the option as every "
4331 "other option by reassigning a new value to the option."
4334 #. type: Content of: <refentry><refsect1><para>
4335 #: apt.conf.5.xml:114
4337 "Two specials are allowed, <literal>#include</literal> (which is deprecated "
4338 "and not supported by alternative implementations) and "
4339 "<literal>#clear</literal>: <literal>#include</literal> will include the "
4340 "given file, unless the filename ends in a slash, then the whole directory is "
4341 "included. <literal>#clear</literal> is used to erase a part of the "
4342 "configuration tree. The specified element and all its descendants are "
4343 "erased. (Note that these lines also need to end with a semicolon.)"
4346 #. type: Content of: <refentry><refsect1><para>
4347 #: apt.conf.5.xml:122
4349 "The #clear command is the only way to delete a list or a complete scope. "
4350 "Reopening a scope or the ::-style described below will "
4351 "<emphasis>not</emphasis> override previously written entries. Only options "
4352 "can be overridden by addressing a new value to it - lists and scopes can't "
4353 "be overridden, only cleared."
4356 #. type: Content of: <refentry><refsect1><para>
4357 #: apt.conf.5.xml:127
4359 "All of the APT tools take a -o option which allows an arbitrary "
4360 "configuration directive to be specified on the command line. The syntax is a "
4361 "full option name (<literal>APT::Get::Assume-Yes</literal> for instance) "
4362 "followed by an equals sign then the new value of the option. Lists can be "
4363 "appended too by adding a trailing :: to the list name. (As you might "
4364 "suspect: The scope syntax can't be used on the command line.)"
4367 #. type: Content of: <refentry><refsect1><para>
4368 #: apt.conf.5.xml:134
4370 "Note that you can use :: only for appending one item per line to a list and "
4371 "that you should not use it in combination with the scope syntax. (The scope "
4372 "syntax implicit insert ::) Using both syntaxes together will trigger a bug "
4373 "which some users unfortunately relay on: An option with the unusual name "
4374 "\"<literal>::</literal>\" which acts like every other option with a "
4375 "name. These introduces many problems including that a user who writes "
4376 "multiple lines in this <emphasis>wrong</emphasis> syntax in the hope to "
4377 "append to a list will gain the opposite as only the last assignment for this "
4378 "option \"<literal>::</literal>\" will be used. Upcoming APT versions will "
4379 "raise errors and will stop working if they encounter this misuse, so please "
4380 "correct such statements now as long as APT doesn't complain explicit about "
4384 #. type: Content of: <refentry><refsect1><title>
4385 #: apt.conf.5.xml:146
4386 msgid "The APT Group"
4389 #. type: Content of: <refentry><refsect1><para>
4390 #: apt.conf.5.xml:147
4392 "This group of options controls general APT behavior as well as holding the "
4393 "options for all of the tools."
4396 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4397 #: apt.conf.5.xml:151
4398 msgid "Architecture"
4401 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4402 #: apt.conf.5.xml:152
4404 "System Architecture; sets the architecture to use when fetching files and "
4405 "parsing package lists. The internal default is the architecture apt was "
4409 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4410 #: apt.conf.5.xml:158
4412 "All Architectures the system supports. Processors implementing the "
4413 "<literal>amd64</literal> are e.g. also able to execute binaries compiled for "
4414 "<literal>i386</literal>; This list is use when fetching files and parsing "
4415 "package lists. The internal default is always the native architecture "
4416 "(<literal>APT::Architecture</literal>) and all foreign architectures it can "
4417 "retrieve by calling <command>dpkg --print-foreign-architectures</command>."
4420 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4421 #: apt.conf.5.xml:165
4422 msgid "Default-Release"
4425 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4426 #: apt.conf.5.xml:166
4428 "Default release to install packages from if more than one version "
4429 "available. Contains release name, codename or release version. Examples: "
4430 "'stable', 'testing', 'unstable', '&stable-codename;', '&testing-codename;', "
4431 "'4.0', '5.0*'. See also &apt-preferences;."
4434 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4435 #: apt.conf.5.xml:171
4439 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4440 #: apt.conf.5.xml:172
4442 "Ignore Held packages; This global option causes the problem resolver to "
4443 "ignore held packages in its decision making."
4446 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4447 #: apt.conf.5.xml:176
4448 msgid "Clean-Installed"
4451 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4452 #: apt.conf.5.xml:177
4454 "Defaults to on. When turned on the autoclean feature will remove any "
4455 "packages which can no longer be downloaded from the cache. If turned off "
4456 "then packages that are locally installed are also excluded from cleaning - "
4457 "but note that APT provides no direct means to reinstall them."
4460 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4461 #: apt.conf.5.xml:183
4462 msgid "Immediate-Configure"
4465 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4466 #: apt.conf.5.xml:184
4468 "Defaults to on which will cause APT to install essential and important "
4469 "packages as fast as possible in the install/upgrade operation. This is done "
4470 "to limit the effect of a failing &dpkg; call: If this option is disabled APT "
4471 "does treat an important package in the same way as an extra package: Between "
4472 "the unpacking of the important package A and his configuration can then be "
4473 "many other unpack or configuration calls, e.g. for package B which has no "
4474 "relation to A, but causes the dpkg call to fail (e.g. because maintainer "
4475 "script of package B generates an error) which results in a system state in "
4476 "which package A is unpacked but unconfigured - each package depending on A "
4477 "is now no longer guaranteed to work as their dependency on A is not longer "
4478 "satisfied. The immediate configuration marker is also applied to all "
4479 "dependencies which can generate a problem if the dependencies e.g. form a "
4480 "circle as a dependency with the immediate flag is comparable with a "
4481 "Pre-Dependency. So in theory it is possible that APT encounters a situation "
4482 "in which it is unable to perform immediate configuration, errors out and "
4483 "refers to this option so the user can deactivate the immediate configuration "
4484 "temporarily to be able to perform an install/upgrade again. Note the use of "
4485 "the word \"theory\" here as this problem was only encountered by now in real "
4486 "world a few times in non-stable distribution versions and was caused by "
4487 "wrong dependencies of the package in question or by a system in an already "
4488 "broken state, so you should not blindly disable this option as the mentioned "
4489 "scenario above is not the only problem immediate configuration can help to "
4490 "prevent in the first place. Before a big operation like "
4491 "<literal>dist-upgrade</literal> is run with this option disabled it should "
4492 "be tried to explicitly <literal>install</literal> the package APT is unable "
4493 "to configure immediately, but please make sure to report your problem also "
4494 "to your distribution and to the APT team with the buglink below so they can "
4495 "work on improving or correcting the upgrade process."
4498 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4499 #: apt.conf.5.xml:206
4500 msgid "Force-LoopBreak"
4503 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4504 #: apt.conf.5.xml:207
4506 "Never Enable this option unless you -really- know what you are doing. It "
4507 "permits APT to temporarily remove an essential package to break a "
4508 "Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential "
4509 "packages. SUCH A LOOP SHOULD NEVER EXIST AND IS A GRAVE BUG. This option "
4510 "will work if the essential packages are not tar, gzip, libc, dpkg, bash or "
4511 "anything that those packages depend on."
4514 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4515 #: apt.conf.5.xml:215
4516 msgid "Cache-Start, Cache-Grow and Cache-Limit"
4519 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4520 #: apt.conf.5.xml:216
4522 "APT uses since version 0.7.26 a resizable memory mapped cache file to store "
4523 "the 'available' information. <literal>Cache-Start</literal> acts as a hint "
4524 "to which size the Cache will grow and is therefore the amount of memory APT "
4525 "will request at startup. The default value is 20971520 bytes (~20 MB). Note "
4526 "that these amount of space need to be available for APT otherwise it will "
4527 "likely fail ungracefully, so for memory restricted devices these value "
4528 "should be lowered while on systems with a lot of configured sources this "
4529 "might be increased. <literal>Cache-Grow</literal> defines in byte with the "
4530 "default of 1048576 (~1 MB) how much the Cache size will be increased in the "
4531 "event the space defined by <literal>Cache-Start</literal> is not "
4532 "enough. These value will be applied again and again until either the cache "
4533 "is big enough to store all information or the size of the cache reaches the "
4534 "<literal>Cache-Limit</literal>. The default of "
4535 "<literal>Cache-Limit</literal> is 0 which stands for no limit. If "
4536 "<literal>Cache-Grow</literal> is set to 0 the automatic grow of the cache is "
4540 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4541 #: apt.conf.5.xml:231
4542 msgid "Build-Essential"
4545 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4546 #: apt.conf.5.xml:232
4547 msgid "Defines which package(s) are considered essential build dependencies."
4550 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4551 #: apt.conf.5.xml:235
4555 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4556 #: apt.conf.5.xml:236
4558 "The Get subsection controls the &apt-get; tool, please see its documentation "
4559 "for more information about the options here."
4562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4563 #: apt.conf.5.xml:240
4567 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4568 #: apt.conf.5.xml:241
4570 "The Cache subsection controls the &apt-cache; tool, please see its "
4571 "documentation for more information about the options here."
4574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
4575 #: apt.conf.5.xml:245
4579 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
4580 #: apt.conf.5.xml:246
4582 "The CDROM subsection controls the &apt-cdrom; tool, please see its "
4583 "documentation for more information about the options here."
4586 #. type: Content of: <refentry><refsect1><title>
4587 #: apt.conf.5.xml:252
4588 msgid "The Acquire Group"
4591 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4592 #: apt.conf.5.xml:257
4593 msgid "Check-Valid-Until"
4596 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4597 #: apt.conf.5.xml:258
4599 "Security related option defaulting to true as an expiring validation for a "
4600 "Release file prevents longtime replay attacks and can e.g. also help users "
4601 "to identify no longer updated mirrors - but the feature depends on the "
4602 "correctness of the time on the user system. Archive maintainers are "
4603 "encouraged to create Release files with the <literal>Valid-Until</literal> "
4604 "header, but if they don't or a stricter value is volitional the following "
4605 "<literal>Max-ValidTime</literal> option can be used."
4608 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4609 #: apt.conf.5.xml:268
4610 msgid "Max-ValidTime"
4613 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4614 #: apt.conf.5.xml:269
4616 "Seconds the Release file should be considered valid after it was created "
4617 "(indicated by the <literal>Date</literal> header). If the Release file "
4618 "itself includes a <literal>Valid-Until</literal> header the earlier date of "
4619 "the two is used as the expiration date. The default value is "
4620 "<literal>0</literal> which stands for \"for ever\". Archive specific "
4621 "settings can be made by appending the label of the archive to the option "
4625 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4626 #: apt.conf.5.xml:279
4627 msgid "Min-ValidTime"
4630 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4631 #: apt.conf.5.xml:280
4633 "Minimum of seconds the Release file should be considered valid after it was "
4634 "created (indicated by the <literal>Date</literal> header). Use this if you "
4635 "need to use a seldomly updated (local) mirror of a more regular updated "
4636 "archive with a <literal>Valid-Until</literal> header instead of competely "
4637 "disabling the expiration date checking. Archive specific settings can and "
4638 "should be used by appending the label of the archive to the option name."
4641 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4642 #: apt.conf.5.xml:290
4646 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4647 #: apt.conf.5.xml:291
4649 "Try to download deltas called <literal>PDiffs</literal> for Packages or "
4650 "Sources files instead of downloading whole ones. True by default."
4653 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4654 #: apt.conf.5.xml:294
4656 "Two sub-options to limit the use of PDiffs are also available: With "
4657 "<literal>FileLimit</literal> can be specified how many PDiff files are "
4658 "downloaded at most to patch a file. <literal>SizeLimit</literal> on the "
4659 "other hand is the maximum percentage of the size of all patches compared to "
4660 "the size of the targeted file. If one of these limits is exceeded the "
4661 "complete file is downloaded instead of the patches."
4664 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4665 #: apt.conf.5.xml:303
4669 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4670 #: apt.conf.5.xml:304
4672 "Queuing mode; <literal>Queue-Mode</literal> can be one of "
4673 "<literal>host</literal> or <literal>access</literal> which determines how "
4674 "APT parallelizes outgoing connections. <literal>host</literal> means that "
4675 "one connection per target host will be opened, <literal>access</literal> "
4676 "means that one connection per URI type will be opened."
4679 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4680 #: apt.conf.5.xml:311
4684 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4685 #: apt.conf.5.xml:312
4687 "Number of retries to perform. If this is non-zero APT will retry failed "
4688 "files the given number of times."
4691 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4692 #: apt.conf.5.xml:316
4693 msgid "Source-Symlinks"
4696 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4697 #: apt.conf.5.xml:317
4699 "Use symlinks for source archives. If set to true then source archives will "
4700 "be symlinked when possible instead of copying. True is the default."
4703 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4704 #: apt.conf.5.xml:321 sources.list.5.xml:155
4708 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4709 #: apt.conf.5.xml:322
4711 "HTTP URIs; http::Proxy is the default http proxy to use. It is in the "
4712 "standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per "
4713 "host proxies can also be specified by using the form "
4714 "<literal>http::Proxy::<host></literal> with the special keyword "
4715 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4716 "settings is specified, <envar>http_proxy</envar> environment variable will "
4720 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4721 #: apt.conf.5.xml:330
4723 "Three settings are provided for cache control with HTTP/1.1 compliant proxy "
4724 "caches. <literal>No-Cache</literal> tells the proxy to not use its cached "
4725 "response under any circumstances, <literal>Max-Age</literal> is sent only "
4726 "for index files and tells the cache to refresh its object if it is older "
4727 "than the given number of seconds. Debian updates its index files daily so "
4728 "the default is 1 day. <literal>No-Store</literal> specifies that the cache "
4729 "should never store this request, it is only set for archive files. This may "
4730 "be useful to prevent polluting a proxy cache with very large .deb "
4731 "files. Note: Squid 2.0.2 does not support any of these options."
4734 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4735 #: apt.conf.5.xml:340 apt.conf.5.xml:404
4737 "The option <literal>timeout</literal> sets the timeout timer used by the "
4738 "method, this applies to all things including connection timeout and data "
4742 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4743 #: apt.conf.5.xml:343
4745 "One setting is provided to control the pipeline depth in cases where the "
4746 "remote server is not RFC conforming or buggy (such as Squid 2.0.2). "
4747 "<literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5 "
4748 "indicating how many outstanding requests APT should send. A value of zero "
4749 "MUST be specified if the remote host does not properly linger on TCP "
4750 "connections - otherwise data corruption will occur. Hosts which require this "
4751 "are in violation of RFC 2068."
4754 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4755 #: apt.conf.5.xml:351
4757 "The used bandwidth can be limited with "
4758 "<literal>Acquire::http::Dl-Limit</literal> which accepts integer values in "
4759 "kilobyte. The default value is 0 which deactivates the limit and tries uses "
4760 "as much as possible of the bandwidth (Note that this option implicit "
4761 "deactivates the download from multiple servers at the same time.)"
4764 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4765 #: apt.conf.5.xml:356
4767 "<literal>Acquire::http::User-Agent</literal> can be used to set a different "
4768 "User-Agent for the http download method as some proxies allow access for "
4769 "clients only if the client uses a known identifier."
4772 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4773 #: apt.conf.5.xml:362
4777 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4778 #: apt.conf.5.xml:363
4780 "HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and proxy "
4781 "options are the same as for <literal>http</literal> method and will also "
4782 "default to the options from the <literal>http</literal> method if they are "
4783 "not explicitly set for https. <literal>Pipeline-Depth</literal> option is "
4784 "not supported yet."
4787 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4788 #: apt.conf.5.xml:369
4790 "<literal>CaInfo</literal> suboption specifies place of file that holds info "
4791 "about trusted certificates. <literal><host>::CaInfo</literal> is "
4792 "corresponding per-host option. <literal>Verify-Peer</literal> boolean "
4793 "suboption determines whether verify server's host certificate against "
4794 "trusted certificates or not. <literal><host>::Verify-Peer</literal> "
4795 "is corresponding per-host option. <literal>Verify-Host</literal> boolean "
4796 "suboption determines whether verify server's hostname or not. "
4797 "<literal><host>::Verify-Host</literal> is corresponding per-host "
4798 "option. <literal>SslCert</literal> determines what certificate to use for "
4799 "client authentication. <literal><host>::SslCert</literal> is "
4800 "corresponding per-host option. <literal>SslKey</literal> determines what "
4801 "private key to use for client "
4802 "authentication. <literal><host>::SslKey</literal> is corresponding "
4803 "per-host option. <literal>SslForceVersion</literal> overrides default SSL "
4804 "version to use. Can contain 'TLSv1' or 'SSLv3' string. "
4805 "<literal><host>::SslForceVersion</literal> is corresponding per-host "
4809 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4810 #: apt.conf.5.xml:387 sources.list.5.xml:166
4814 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4815 #: apt.conf.5.xml:388
4817 "FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the standard "
4818 "form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per host "
4819 "proxies can also be specified by using the form "
4820 "<literal>ftp::Proxy::<host></literal> with the special keyword "
4821 "<literal>DIRECT</literal> meaning to use no proxies. If no one of the above "
4822 "settings is specified, <envar>ftp_proxy</envar> environment variable will be "
4823 "used. To use a ftp proxy you will have to set the "
4824 "<literal>ftp::ProxyLogin</literal> script in the configuration file. This "
4825 "entry specifies the commands to send to tell the proxy server what to "
4826 "connect to. Please see &configureindex; for an example of how to do "
4827 "this. The substitution variables available are "
4828 "<literal>$(PROXY_USER)</literal> <literal>$(PROXY_PASS)</literal> "
4829 "<literal>$(SITE_USER)</literal> <literal>$(SITE_PASS)</literal> "
4830 "<literal>$(SITE)</literal> and <literal>$(SITE_PORT)</literal> Each is taken "
4831 "from it's respective URI component."
4834 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4835 #: apt.conf.5.xml:407
4837 "Several settings are provided to control passive mode. Generally it is safe "
4838 "to leave passive mode on, it works in nearly every environment. However "
4839 "some situations require that passive mode be disabled and port mode ftp used "
4840 "instead. This can be done globally, for connections that go through a proxy "
4841 "or for a specific host (See the sample config file for examples)."
4844 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4845 #: apt.conf.5.xml:414
4847 "It is possible to proxy FTP over HTTP by setting the "
4848 "<envar>ftp_proxy</envar> environment variable to a http url - see the "
4849 "discussion of the http method above for syntax. You cannot set this in the "
4850 "configuration file and it is not recommended to use FTP over HTTP due to its "
4854 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4855 #: apt.conf.5.xml:419
4857 "The setting <literal>ForceExtended</literal> controls the use of RFC2428 "
4858 "<literal>EPSV</literal> and <literal>EPRT</literal> commands. The default is "
4859 "false, which means these commands are only used if the control connection is "
4860 "IPv6. Setting this to true forces their use even on IPv4 connections. Note "
4861 "that most FTP servers do not support RFC2428."
4864 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4865 #: apt.conf.5.xml:426 sources.list.5.xml:148
4869 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4870 #: apt.conf.5.xml:432
4872 msgid "/cdrom/::Mount \"foo\";"
4875 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4876 #: apt.conf.5.xml:427
4878 "CDROM URIs; the only setting for CDROM URIs is the mount point, "
4879 "<literal>cdrom::Mount</literal> which must be the mount point for the CDROM "
4880 "drive as specified in <filename>/etc/fstab</filename>. It is possible to "
4881 "provide alternate mount and unmount commands if your mount point cannot be "
4882 "listed in the fstab (such as an SMB mount and old mount packages). The "
4883 "syntax is to put <placeholder type=\"literallayout\" id=\"0\"/> within the "
4884 "cdrom block. It is important to have the trailing slash. Unmount commands "
4885 "can be specified using UMount."
4888 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4889 #: apt.conf.5.xml:437
4893 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4894 #: apt.conf.5.xml:438
4896 "GPGV URIs; the only option for GPGV URIs is the option to pass additional "
4897 "parameters to gpgv. <literal>gpgv::Options</literal> Additional options "
4901 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4902 #: apt.conf.5.xml:443
4903 msgid "CompressionTypes"
4906 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4907 #: apt.conf.5.xml:449
4910 "Acquire::CompressionTypes::<replaceable>FileExtension</replaceable> "
4911 "\"<replaceable>Methodname</replaceable>\";"
4914 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4915 #: apt.conf.5.xml:444
4917 "List of compression types which are understood by the acquire methods. "
4918 "Files like <filename>Packages</filename> can be available in various "
4919 "compression formats. Per default the acquire methods can decompress "
4920 "<command>bzip2</command>, <command>lzma</command> and "
4921 "<command>gzip</command> compressed files, with this setting more formats can "
4922 "be added on the fly or the used method can be changed. The syntax for this "
4923 "is: <placeholder type=\"synopsis\" id=\"0\"/>"
4926 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4927 #: apt.conf.5.xml:454
4929 msgid "Acquire::CompressionTypes::Order:: \"gz\";"
4932 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><synopsis>
4933 #: apt.conf.5.xml:457
4935 msgid "Acquire::CompressionTypes::Order { \"lzma\"; \"gz\"; };"
4938 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4939 #: apt.conf.5.xml:450
4941 "Also the <literal>Order</literal> subgroup can be used to define in which "
4942 "order the acquire system will try to download the compressed files. The "
4943 "acquire system will try the first and proceed with the next compression type "
4944 "in this list on error, so to prefer one over the other type simple add the "
4945 "preferred type at first - not already added default types will be added at "
4946 "run time to the end of the list, so e.g. <placeholder type=\"synopsis\" "
4947 "id=\"0\"/> can be used to prefer <command>gzip</command> compressed files "
4948 "over <command>bzip2</command> and <command>lzma</command>. If "
4949 "<command>lzma</command> should be preferred over <command>gzip</command> and "
4950 "<command>bzip2</command> the configure setting should look like this "
4951 "<placeholder type=\"synopsis\" id=\"1\"/> It is not needed to add "
4952 "<literal>bz2</literal> explicit to the list as it will be added automatic."
4955 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><literallayout>
4956 #: apt.conf.5.xml:461
4958 msgid "Dir::Bin::bzip2 \"/bin/bzip2\";"
4961 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4962 #: apt.conf.5.xml:459
4964 "Note that at run time the "
4965 "<literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will be "
4966 "checked: If this setting exists the method will only be used if this file "
4967 "exists, e.g. for the bzip2 method (the inbuilt) setting is: <placeholder "
4968 "type=\"literallayout\" id=\"0\"/> Note also that list entries specified on "
4969 "the command line will be added at the end of the list specified in the "
4970 "configuration files, but before the default entries. To prefer a type in "
4971 "this case over the ones specified in the configuration files you can set the "
4972 "option direct - not in list style. This will not override the defined list, "
4973 "it will only prefix the list with this type."
4976 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4977 #: apt.conf.5.xml:466
4979 "The special type <literal>uncompressed</literal> can be used to give "
4980 "uncompressed files a preference, but note that most archives don't provide "
4981 "uncompressed files so this is mostly only useable for local mirrors."
4984 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4985 #: apt.conf.5.xml:471
4989 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
4990 #: apt.conf.5.xml:473
4992 "When downloading <literal>gzip</literal> compressed indexes (Packages, "
4993 "Sources, or Translations), keep them gzip compressed locally instead of "
4994 "unpacking them. This saves quite a lot of disk space at the expense of more "
4995 "CPU requirements when building the local package caches. False by default."
4998 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
4999 #: apt.conf.5.xml:480
5003 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5004 #: apt.conf.5.xml:481
5006 "The Languages subsection controls which <filename>Translation</filename> "
5007 "files are downloaded and in which order APT tries to display the "
5008 "Description-Translations. APT will try to display the first available "
5009 "Description in the Language which is listed at first. Languages can be "
5010 "defined with their short or long Languagecodes. Note that not all archives "
5011 "provide <filename>Translation</filename> files for every Language - "
5012 "especially the long Languagecodes are rare, so please inform you which ones "
5013 "are available before you set here impossible values."
5016 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para><programlisting>
5017 #: apt.conf.5.xml:497
5019 msgid "Acquire::Languages { \"environment\"; \"de\"; \"en\"; \"none\"; \"fr\"; };"
5022 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
5023 #: apt.conf.5.xml:487
5025 "The default list includes \"environment\" and "
5026 "\"en\". \"<literal>environment</literal>\" has a special meaning here: It "
5027 "will be replaced at runtime with the languagecodes extracted from the "
5028 "<literal>LC_MESSAGES</literal> environment variable. It will also ensure "
5029 "that these codes are not included twice in the list. If "
5030 "<literal>LC_MESSAGES</literal> is set to \"C\" only the "
5031 "<filename>Translation-en</filename> file (if available) will be used. To "
5032 "force apt to use no Translation file use the setting "
5033 "<literal>Acquire::Languages=none</literal>. \"<literal>none</literal>\" is "
5034 "another special meaning code which will stop the search for a fitting "
5035 "<filename>Translation</filename> file. This can be used by the system "
5036 "administrator to let APT know that it should download also this files "
5037 "without actually use them if the environment doesn't specify this "
5038 "languages. So the following example configuration will result in the order "
5039 "\"en, de\" in an english and in \"de, en\" in a german localization. Note "
5040 "that \"fr\" is downloaded, but not used if APT is not used in a french "
5041 "localization, in such an environment the order would be \"fr, de, en\". "
5042 "<placeholder type=\"programlisting\" id=\"0\"/>"
5045 #. type: Content of: <refentry><refsect1><para>
5046 #: apt.conf.5.xml:253
5048 "The <literal>Acquire</literal> group of options controls the download of "
5049 "packages and the URI handlers. <placeholder type=\"variablelist\" "
5053 #. type: Content of: <refentry><refsect1><title>
5054 #: apt.conf.5.xml:504
5058 #. type: Content of: <refentry><refsect1><para>
5059 #: apt.conf.5.xml:506
5061 "The <literal>Dir::State</literal> section has directories that pertain to "
5062 "local state information. <literal>lists</literal> is the directory to place "
5063 "downloaded package lists in and <literal>status</literal> is the name of the "
5064 "dpkg status file. <literal>preferences</literal> is the name of the APT "
5065 "preferences file. <literal>Dir::State</literal> contains the default "
5066 "directory to prefix on all sub items if they do not start with "
5067 "<filename>/</filename> or <filename>./</filename>."
5070 #. type: Content of: <refentry><refsect1><para>
5071 #: apt.conf.5.xml:513
5073 "<literal>Dir::Cache</literal> contains locations pertaining to local cache "
5074 "information, such as the two package caches <literal>srcpkgcache</literal> "
5075 "and <literal>pkgcache</literal> as well as the location to place downloaded "
5076 "archives, <literal>Dir::Cache::archives</literal>. Generation of caches can "
5077 "be turned off by setting their names to be blank. This will slow down "
5078 "startup but save disk space. It is probably preferred to turn off the "
5079 "pkgcache rather than the srcpkgcache. Like <literal>Dir::State</literal> the "
5080 "default directory is contained in <literal>Dir::Cache</literal>"
5083 #. type: Content of: <refentry><refsect1><para>
5084 #: apt.conf.5.xml:522
5086 "<literal>Dir::Etc</literal> contains the location of configuration files, "
5087 "<literal>sourcelist</literal> gives the location of the sourcelist and "
5088 "<literal>main</literal> is the default configuration file (setting has no "
5089 "effect, unless it is done from the config file specified by "
5090 "<envar>APT_CONFIG</envar>)."
5093 #. type: Content of: <refentry><refsect1><para>
5094 #: apt.conf.5.xml:528
5096 "The <literal>Dir::Parts</literal> setting reads in all the config fragments "
5097 "in lexical order from the directory specified. After this is done then the "
5098 "main config file is loaded."
5101 #. type: Content of: <refentry><refsect1><para>
5102 #: apt.conf.5.xml:532
5104 "Binary programs are pointed to by "
5105 "<literal>Dir::Bin</literal>. <literal>Dir::Bin::Methods</literal> specifies "
5106 "the location of the method handlers and <literal>gzip</literal>, "
5107 "<literal>bzip2</literal>, <literal>lzma</literal>, <literal>dpkg</literal>, "
5108 "<literal>apt-get</literal> <literal>dpkg-source</literal> "
5109 "<literal>dpkg-buildpackage</literal> and <literal>apt-cache</literal> "
5110 "specify the location of the respective programs."
5113 #. type: Content of: <refentry><refsect1><para>
5114 #: apt.conf.5.xml:540
5116 "The configuration item <literal>RootDir</literal> has a special meaning. If "
5117 "set, all paths in <literal>Dir::</literal> will be relative to "
5118 "<literal>RootDir</literal>, <emphasis>even paths that are specified "
5119 "absolutely</emphasis>. So, for instance, if <literal>RootDir</literal> is "
5120 "set to <filename>/tmp/staging</filename> and "
5121 "<literal>Dir::State::status</literal> is set to "
5122 "<filename>/var/lib/dpkg/status</filename>, then the status file will be "
5123 "looked up in <filename>/tmp/staging/var/lib/dpkg/status</filename>."
5126 #. type: Content of: <refentry><refsect1><para>
5127 #: apt.conf.5.xml:553
5129 "The <literal>Ignore-Files-Silently</literal> list can be used to specify "
5130 "which files APT should silently ignore while parsing the files in the "
5131 "fragment directories. Per default a file which end with "
5132 "<literal>.disabled</literal>, <literal>~</literal>, <literal>.bak</literal> "
5133 "or <literal>.dpkg-[a-z]+</literal> is silently ignored. As seen in the last "
5134 "default value these patterns can use regular expression syntax."
5137 #. type: Content of: <refentry><refsect1><title>
5138 #: apt.conf.5.xml:562
5139 msgid "APT in DSelect"
5142 #. type: Content of: <refentry><refsect1><para>
5143 #: apt.conf.5.xml:564
5145 "When APT is used as a &dselect; method several configuration directives "
5146 "control the default behaviour. These are in the <literal>DSelect</literal> "
5150 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5151 #: apt.conf.5.xml:568
5155 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5156 #: apt.conf.5.xml:569
5158 "Cache Clean mode; this value may be one of always, prompt, auto, pre-auto "
5159 "and never. always and prompt will remove all packages from the cache after "
5160 "upgrading, prompt (the default) does so conditionally. auto removes only "
5161 "those packages which are no longer downloadable (replaced with a new version "
5162 "for instance). pre-auto performs this action before downloading new "
5166 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5167 #: apt.conf.5.xml:578
5169 "The contents of this variable is passed to &apt-get; as command line options "
5170 "when it is run for the install phase."
5173 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5174 #: apt.conf.5.xml:582
5175 msgid "Updateoptions"
5178 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5179 #: apt.conf.5.xml:583
5181 "The contents of this variable is passed to &apt-get; as command line options "
5182 "when it is run for the update phase."
5185 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5186 #: apt.conf.5.xml:587
5187 msgid "PromptAfterUpdate"
5190 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5191 #: apt.conf.5.xml:588
5193 "If true the [U]pdate operation in &dselect; will always prompt to continue. "
5194 "The default is to prompt only on error."
5197 #. type: Content of: <refentry><refsect1><title>
5198 #: apt.conf.5.xml:594
5199 msgid "How APT calls dpkg"
5202 #. type: Content of: <refentry><refsect1><para>
5203 #: apt.conf.5.xml:595
5205 "Several configuration directives control how APT invokes &dpkg;. These are "
5206 "in the <literal>DPkg</literal> section."
5209 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5210 #: apt.conf.5.xml:600
5212 "This is a list of options to pass to dpkg. The options must be specified "
5213 "using the list notation and each list item is passed as a single argument to "
5217 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5218 #: apt.conf.5.xml:605
5222 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5223 #: apt.conf.5.xml:605
5227 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5228 #: apt.conf.5.xml:606
5230 "This is a list of shell commands to run before/after invoking &dpkg;. Like "
5231 "<literal>options</literal> this must be specified in list notation. The "
5232 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5233 "fail APT will abort."
5236 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5237 #: apt.conf.5.xml:612
5238 msgid "Pre-Install-Pkgs"
5241 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5242 #: apt.conf.5.xml:613
5244 "This is a list of shell commands to run before invoking dpkg. Like "
5245 "<literal>options</literal> this must be specified in list notation. The "
5246 "commands are invoked in order using <filename>/bin/sh</filename>, should any "
5247 "fail APT will abort. APT will pass to the commands on standard input the "
5248 "filenames of all .deb files it is going to install, one per line."
5251 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5252 #: apt.conf.5.xml:619
5254 "Version 2 of this protocol dumps more information, including the protocol "
5255 "version, the APT configuration space and the packages, files and versions "
5256 "being changed. Version 2 is enabled by setting "
5257 "<literal>DPkg::Tools::options::cmd::Version</literal> to "
5258 "2. <literal>cmd</literal> is a command given to "
5259 "<literal>Pre-Install-Pkgs</literal>."
5262 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5263 #: apt.conf.5.xml:626
5264 msgid "Run-Directory"
5267 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5268 #: apt.conf.5.xml:627
5270 "APT chdirs to this directory before invoking dpkg, the default is "
5271 "<filename>/</filename>."
5274 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5275 #: apt.conf.5.xml:631
5276 msgid "Build-options"
5279 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5280 #: apt.conf.5.xml:632
5282 "These options are passed to &dpkg-buildpackage; when compiling packages, the "
5283 "default is to disable signing and produce all binaries."
5286 #. type: Content of: <refentry><refsect1><refsect2><title>
5287 #: apt.conf.5.xml:637
5288 msgid "dpkg trigger usage (and related options)"
5291 #. type: Content of: <refentry><refsect1><refsect2><para>
5292 #: apt.conf.5.xml:638
5294 "APT can call dpkg in a way so it can make aggressive use of triggers over "
5295 "multiple calls of dpkg. Without further options dpkg will use triggers only "
5296 "in between his own run. Activating these options can therefore decrease the "
5297 "time needed to perform the install / upgrade. Note that it is intended to "
5298 "activate these options per default in the future, but as it changes the way "
5299 "APT calling dpkg drastically it needs a lot more testing. <emphasis>These "
5300 "options are therefore currently experimental and should not be used in "
5301 "productive environments.</emphasis> Also it breaks the progress reporting so "
5302 "all frontends will currently stay around half (or more) of the time in the "
5303 "100% state while it actually configures all packages."
5306 #. type: Content of: <refentry><refsect1><refsect2><para><literallayout>
5307 #: apt.conf.5.xml:653
5310 "DPkg::NoTriggers \"true\";\n"
5311 "PackageManager::Configure \"smart\";\n"
5312 "DPkg::ConfigurePending \"true\";\n"
5313 "DPkg::TriggersPending \"true\";"
5316 #. type: Content of: <refentry><refsect1><refsect2><para>
5317 #: apt.conf.5.xml:647
5319 "Note that it is not guaranteed that APT will support these options or that "
5320 "these options will not cause (big) trouble in the future. If you have "
5321 "understand the current risks and problems with these options, but are brave "
5322 "enough to help testing them create a new configuration file and test a "
5323 "combination of options. Please report any bugs, problems and improvements "
5324 "you encounter and make sure to note which options you have used in your "
5325 "reports. Asking dpkg for help could also be useful for debugging proposes, "
5326 "see e.g. <command>dpkg --audit</command>. A defensive option combination "
5327 "would be <placeholder type=\"literallayout\" id=\"0\"/>"
5330 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5331 #: apt.conf.5.xml:659
5332 msgid "DPkg::NoTriggers"
5335 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5336 #: apt.conf.5.xml:660
5338 "Add the no triggers flag to all dpkg calls (except the ConfigurePending "
5339 "call). See &dpkg; if you are interested in what this actually means. In "
5340 "short: dpkg will not run the triggers when this flag is present unless it is "
5341 "explicitly called to do so in an extra call. Note that this option exists "
5342 "(undocumented) also in older apt versions with a slightly different meaning: "
5343 "Previously these option only append --no-triggers to the configure calls to "
5344 "dpkg - now apt will add these flag also to the unpack and remove calls."
5347 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5348 #: apt.conf.5.xml:667
5349 msgid "PackageManager::Configure"
5352 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5353 #: apt.conf.5.xml:668
5355 "Valid values are \"<literal>all</literal>\", \"<literal>smart</literal>\" "
5356 "and \"<literal>no</literal>\". \"<literal>all</literal>\" is the default "
5357 "value and causes APT to configure all packages explicit. The "
5358 "\"<literal>smart</literal>\" way is it to configure only packages which need "
5359 "to be configured before another package can be unpacked (Pre-Depends) and "
5360 "let the rest configure by dpkg with a call generated by the next "
5361 "option. \"<literal>no</literal>\" on the other hand will not configure "
5362 "anything and totally rely on dpkg for configuration (which will at the "
5363 "moment fail if a Pre-Depends is encountered). Setting this option to "
5364 "another than the all value will implicitly activate also the next option per "
5365 "default as otherwise the system could end in an unconfigured status which "
5366 "could be unbootable!"
5369 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5370 #: apt.conf.5.xml:678
5371 msgid "DPkg::ConfigurePending"
5374 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5375 #: apt.conf.5.xml:679
5377 "If this option is set apt will call <command>dpkg --configure "
5378 "--pending</command> to let dpkg handle all required configurations and "
5379 "triggers. This option is activated automatic per default if the previous "
5380 "option is not set to <literal>all</literal>, but deactivating could be "
5381 "useful if you want to run APT multiple times in a row - e.g. in an "
5382 "installer. In these sceneries you could deactivate this option in all but "
5386 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5387 #: apt.conf.5.xml:685
5388 msgid "DPkg::TriggersPending"
5391 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5392 #: apt.conf.5.xml:686
5394 "Useful for <literal>smart</literal> configuration as a package which has "
5395 "pending triggers is not considered as <literal>installed</literal> and dpkg "
5396 "treats them as <literal>unpacked</literal> currently which is a dealbreaker "
5397 "for Pre-Dependencies (see debbugs #526774). Note that this will process all "
5398 "triggers, not only the triggers needed to configure this package."
5401 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5402 #: apt.conf.5.xml:691
5403 msgid "PackageManager::UnpackAll"
5406 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5407 #: apt.conf.5.xml:692
5409 "As the configuration can be deferred to be done at the end by dpkg it can be "
5410 "tried to order the unpack series only by critical needs, e.g. by "
5411 "Pre-Depends. Default is true and therefore the \"old\" method of ordering in "
5412 "various steps by everything. While both method were present in earlier APT "
5413 "versions the <literal>OrderCritical</literal> method was unused, so this "
5414 "method is very experimental and needs further improvements before becoming "
5418 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><term>
5419 #: apt.conf.5.xml:699
5420 msgid "OrderList::Score::Immediate"
5423 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para><literallayout>
5424 #: apt.conf.5.xml:707
5427 "OrderList::Score {\n"
5429 "\tEssential 200;\n"
5431 "\tPreDepends 50;\n"
5435 #. type: Content of: <refentry><refsect1><refsect2><variablelist><varlistentry><listitem><para>
5436 #: apt.conf.5.xml:700
5438 "Essential packages (and there dependencies) should be configured immediately "
5439 "after unpacking. It will be a good idea to do this quite early in the "
5440 "upgrade process as these these configure calls require currently also "
5441 "<literal>DPkg::TriggersPending</literal> which will run quite a few triggers "
5442 "(which maybe not needed). Essentials get per default a high score but the "
5443 "immediate flag is relatively low (a package which has a Pre-Depends is "
5444 "higher rated). These option and the others in the same group can be used to "
5445 "change the scoring. The following example shows the settings with there "
5446 "default values. <placeholder type=\"literallayout\" id=\"0\"/>"
5449 #. type: Content of: <refentry><refsect1><title>
5450 #: apt.conf.5.xml:720
5451 msgid "Periodic and Archives options"
5454 #. type: Content of: <refentry><refsect1><para>
5455 #: apt.conf.5.xml:721
5457 "<literal>APT::Periodic</literal> and <literal>APT::Archives</literal> groups "
5458 "of options configure behavior of apt periodic updates, which is done by "
5459 "<literal>/etc/cron.daily/apt</literal> script. See header of this script for "
5460 "the brief documentation of these options."
5463 #. type: Content of: <refentry><refsect1><title>
5464 #: apt.conf.5.xml:729
5465 msgid "Debug options"
5468 #. type: Content of: <refentry><refsect1><para>
5469 #: apt.conf.5.xml:731
5471 "Enabling options in the <literal>Debug::</literal> section will cause "
5472 "debugging information to be sent to the standard error stream of the program "
5473 "utilizing the <literal>apt</literal> libraries, or enable special program "
5474 "modes that are primarily useful for debugging the behavior of "
5475 "<literal>apt</literal>. Most of these options are not interesting to a "
5476 "normal user, but a few may be:"
5479 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5480 #: apt.conf.5.xml:742
5482 "<literal>Debug::pkgProblemResolver</literal> enables output about the "
5483 "decisions made by <literal>dist-upgrade, upgrade, install, remove, "
5487 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5488 #: apt.conf.5.xml:750
5490 "<literal>Debug::NoLocking</literal> disables all file locking. This can be "
5491 "used to run some operations (for instance, <literal>apt-get -s "
5492 "install</literal>) as a non-root user."
5495 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5496 #: apt.conf.5.xml:759
5498 "<literal>Debug::pkgDPkgPM</literal> prints out the actual command line each "
5499 "time that <literal>apt</literal> invokes &dpkg;."
5503 #. motivating example, except I haven't a clue why you'd want
5505 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
5506 #: apt.conf.5.xml:767
5508 "<literal>Debug::IdentCdrom</literal> disables the inclusion of statfs data "
5512 #. type: Content of: <refentry><refsect1><para>
5513 #: apt.conf.5.xml:777
5514 msgid "A full list of debugging options to apt follows."
5517 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5518 #: apt.conf.5.xml:782
5519 msgid "<literal>Debug::Acquire::cdrom</literal>"
5522 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5523 #: apt.conf.5.xml:786
5524 msgid "Print information related to accessing <literal>cdrom://</literal> sources."
5527 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5528 #: apt.conf.5.xml:793
5529 msgid "<literal>Debug::Acquire::ftp</literal>"
5532 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5533 #: apt.conf.5.xml:797
5534 msgid "Print information related to downloading packages using FTP."
5537 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5538 #: apt.conf.5.xml:804
5539 msgid "<literal>Debug::Acquire::http</literal>"
5542 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5543 #: apt.conf.5.xml:808
5544 msgid "Print information related to downloading packages using HTTP."
5547 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5548 #: apt.conf.5.xml:815
5549 msgid "<literal>Debug::Acquire::https</literal>"
5552 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5553 #: apt.conf.5.xml:819
5554 msgid "Print information related to downloading packages using HTTPS."
5557 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5558 #: apt.conf.5.xml:826
5559 msgid "<literal>Debug::Acquire::gpgv</literal>"
5562 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5563 #: apt.conf.5.xml:830
5565 "Print information related to verifying cryptographic signatures using "
5566 "<literal>gpg</literal>."
5569 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5570 #: apt.conf.5.xml:837
5571 msgid "<literal>Debug::aptcdrom</literal>"
5574 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5575 #: apt.conf.5.xml:841
5577 "Output information about the process of accessing collections of packages "
5578 "stored on CD-ROMs."
5581 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5582 #: apt.conf.5.xml:848
5583 msgid "<literal>Debug::BuildDeps</literal>"
5586 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5587 #: apt.conf.5.xml:851
5588 msgid "Describes the process of resolving build-dependencies in &apt-get;."
5591 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5592 #: apt.conf.5.xml:858
5593 msgid "<literal>Debug::Hashes</literal>"
5596 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5597 #: apt.conf.5.xml:861
5599 "Output each cryptographic hash that is generated by the "
5600 "<literal>apt</literal> libraries."
5603 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5604 #: apt.conf.5.xml:868
5605 msgid "<literal>Debug::IdentCDROM</literal>"
5608 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5609 #: apt.conf.5.xml:871
5611 "Do not include information from <literal>statfs</literal>, namely the number "
5612 "of used and free blocks on the CD-ROM filesystem, when generating an ID for "
5616 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5617 #: apt.conf.5.xml:879
5618 msgid "<literal>Debug::NoLocking</literal>"
5621 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5622 #: apt.conf.5.xml:882
5624 "Disable all file locking. For instance, this will allow two instances of "
5625 "<quote><literal>apt-get update</literal></quote> to run at the same time."
5628 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5629 #: apt.conf.5.xml:890
5630 msgid "<literal>Debug::pkgAcquire</literal>"
5633 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5634 #: apt.conf.5.xml:894
5635 msgid "Log when items are added to or removed from the global download queue."
5638 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5639 #: apt.conf.5.xml:901
5640 msgid "<literal>Debug::pkgAcquire::Auth</literal>"
5643 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5644 #: apt.conf.5.xml:904
5646 "Output status messages and errors related to verifying checksums and "
5647 "cryptographic signatures of downloaded files."
5650 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5651 #: apt.conf.5.xml:911
5652 msgid "<literal>Debug::pkgAcquire::Diffs</literal>"
5655 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5656 #: apt.conf.5.xml:914
5658 "Output information about downloading and applying package index list diffs, "
5659 "and errors relating to package index list diffs."
5662 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5663 #: apt.conf.5.xml:922
5664 msgid "<literal>Debug::pkgAcquire::RRed</literal>"
5667 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5668 #: apt.conf.5.xml:926
5670 "Output information related to patching apt package lists when downloading "
5671 "index diffs instead of full indices."
5674 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5675 #: apt.conf.5.xml:933
5676 msgid "<literal>Debug::pkgAcquire::Worker</literal>"
5679 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5680 #: apt.conf.5.xml:937
5681 msgid "Log all interactions with the sub-processes that actually perform downloads."
5684 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5685 #: apt.conf.5.xml:944
5686 msgid "<literal>Debug::pkgAutoRemove</literal>"
5689 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5690 #: apt.conf.5.xml:948
5692 "Log events related to the automatically-installed status of packages and to "
5693 "the removal of unused packages."
5696 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5697 #: apt.conf.5.xml:955
5698 msgid "<literal>Debug::pkgDepCache::AutoInstall</literal>"
5701 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5702 #: apt.conf.5.xml:958
5704 "Generate debug messages describing which packages are being automatically "
5705 "installed to resolve dependencies. This corresponds to the initial "
5706 "auto-install pass performed in, e.g., <literal>apt-get install</literal>, "
5707 "and not to the full <literal>apt</literal> dependency resolver; see "
5708 "<literal>Debug::pkgProblemResolver</literal> for that."
5711 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5712 #: apt.conf.5.xml:969
5713 msgid "<literal>Debug::pkgDepCache::Marker</literal>"
5716 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5717 #: apt.conf.5.xml:972
5719 "Generate debug messages describing which package is marked as "
5720 "keep/install/remove while the ProblemResolver does his work. Each addition "
5721 "or deletion may trigger additional actions; they are shown indented two "
5722 "additional space under the original entry. The format for each line is "
5723 "<literal>MarkKeep</literal>, <literal>MarkDelete</literal> or "
5724 "<literal>MarkInstall</literal> followed by <literal>package-name <a.b.c "
5725 "-> d.e.f | x.y.z> (section)</literal> where <literal>a.b.c</literal> "
5726 "is the current version of the package, <literal>d.e.f</literal> is the "
5727 "version considered for installation and <literal>x.y.z</literal> is a newer "
5728 "version, but not considered for installation (because of a low pin "
5729 "score). The later two can be omitted if there is none or if it is the same "
5730 "version as the installed. <literal>section</literal> is the name of the "
5731 "section the package appears in."
5734 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5735 #: apt.conf.5.xml:991
5736 msgid "<literal>Debug::pkgInitConfig</literal>"
5739 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5740 #: apt.conf.5.xml:994
5741 msgid "Dump the default configuration to standard error on startup."
5744 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5745 #: apt.conf.5.xml:1001
5746 msgid "<literal>Debug::pkgDPkgPM</literal>"
5749 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5750 #: apt.conf.5.xml:1004
5752 "When invoking &dpkg;, output the precise command line with which it is being "
5753 "invoked, with arguments separated by a single space character."
5756 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5757 #: apt.conf.5.xml:1012
5758 msgid "<literal>Debug::pkgDPkgProgressReporting</literal>"
5761 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5762 #: apt.conf.5.xml:1015
5764 "Output all the data received from &dpkg; on the status file descriptor and "
5765 "any errors encountered while parsing it."
5768 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5769 #: apt.conf.5.xml:1022
5770 msgid "<literal>Debug::pkgOrderList</literal>"
5773 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5774 #: apt.conf.5.xml:1026
5776 "Generate a trace of the algorithm that decides the order in which "
5777 "<literal>apt</literal> should pass packages to &dpkg;."
5780 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5781 #: apt.conf.5.xml:1034
5782 msgid "<literal>Debug::pkgPackageManager</literal>"
5785 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5786 #: apt.conf.5.xml:1038
5787 msgid "Output status messages tracing the steps performed when invoking &dpkg;."
5790 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5791 #: apt.conf.5.xml:1045
5792 msgid "<literal>Debug::pkgPolicy</literal>"
5795 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5796 #: apt.conf.5.xml:1049
5797 msgid "Output the priority of each package list on startup."
5800 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5801 #: apt.conf.5.xml:1055
5802 msgid "<literal>Debug::pkgProblemResolver</literal>"
5805 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5806 #: apt.conf.5.xml:1059
5808 "Trace the execution of the dependency resolver (this applies only to what "
5809 "happens when a complex dependency problem is encountered)."
5812 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5813 #: apt.conf.5.xml:1067
5814 msgid "<literal>Debug::pkgProblemResolver::ShowScores</literal>"
5817 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5818 #: apt.conf.5.xml:1070
5820 "Display a list of all installed packages with their calculated score used by "
5821 "the pkgProblemResolver. The description of the package is the same as "
5822 "described in <literal>Debug::pkgDepCache::Marker</literal>"
5825 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><term>
5826 #: apt.conf.5.xml:1078
5827 msgid "<literal>Debug::sourceList</literal>"
5830 #. type: Content of: <refentry><refsect1><variablelist><varlistentry><listitem><para>
5831 #: apt.conf.5.xml:1082
5833 "Print information about the vendors read from "
5834 "<filename>/etc/apt/vendors.list</filename>."
5837 #. type: Content of: <refentry><refsect1><para>
5838 #: apt.conf.5.xml:1105
5840 "&configureindex; is a configuration file showing example values for all "
5844 #. type: Content of: <refentry><refsect1><variablelist>
5845 #: apt.conf.5.xml:1112
5846 msgid "&file-aptconf;"
5849 #. ? reading apt.conf
5850 #. type: Content of: <refentry><refsect1><para>
5851 #: apt.conf.5.xml:1117
5852 msgid "&apt-cache;, &apt-config;, &apt-preferences;."
5855 #. The last update date
5856 #. type: Content of: <refentry><refentryinfo>
5857 #: apt_preferences.5.xml:16
5858 msgid "&apt-author.team; &apt-email; &apt-product; <date>16 February 2010</date>"
5861 #. type: Content of: <refentry><refnamediv><refname>
5862 #: apt_preferences.5.xml:24 apt_preferences.5.xml:31
5863 msgid "apt_preferences"
5866 #. type: Content of: <refentry><refnamediv><refpurpose>
5867 #: apt_preferences.5.xml:32
5868 msgid "Preference control file for APT"
5871 #. type: Content of: <refentry><refsect1><para>
5872 #: apt_preferences.5.xml:37
5874 "The APT preferences file <filename>/etc/apt/preferences</filename> and the "
5875 "fragment files in the <filename>/etc/apt/preferences.d/</filename> folder "
5876 "can be used to control which versions of packages will be selected for "
5880 #. type: Content of: <refentry><refsect1><para>
5881 #: apt_preferences.5.xml:42
5883 "Several versions of a package may be available for installation when the "
5884 "&sources-list; file contains references to more than one distribution (for "
5885 "example, <literal>stable</literal> and <literal>testing</literal>). APT "
5886 "assigns a priority to each version that is available. Subject to dependency "
5887 "constraints, <command>apt-get</command> selects the version with the highest "
5888 "priority for installation. The APT preferences file overrides the "
5889 "priorities that APT assigns to package versions by default, thus giving the "
5890 "user control over which one is selected for installation."
5893 #. type: Content of: <refentry><refsect1><para>
5894 #: apt_preferences.5.xml:52
5896 "Several instances of the same version of a package may be available when the "
5897 "&sources-list; file contains references to more than one source. In this "
5898 "case <command>apt-get</command> downloads the instance listed earliest in "
5899 "the &sources-list; file. The APT preferences file does not affect the "
5900 "choice of instance, only the choice of version."
5903 #. type: Content of: <refentry><refsect1><para>
5904 #: apt_preferences.5.xml:59
5906 "Preferences are a strong power in the hands of a system administrator but "
5907 "they can become also their biggest nightmare if used without care! APT will "
5908 "not questioning the preferences so wrong settings will therefore lead to "
5909 "uninstallable packages or wrong decisions while upgrading packages. Even "
5910 "more problems will arise if multiply distribution releases are mixed without "
5911 "a good understanding of the following paragraphs. Packages included in a "
5912 "specific release aren't tested in and therefore doesn't always work as "
5913 "expected in older or newer releases or together with other packages from "
5914 "different releases. You have been warned."
5917 #. type: Content of: <refentry><refsect1><para>
5918 #: apt_preferences.5.xml:70
5920 "Note that the files in the <filename>/etc/apt/preferences.d</filename> "
5921 "directory are parsed in alphanumeric ascending order and need to obey the "
5922 "following naming convention: The files have either no or "
5923 "\"<literal>pref</literal>\" as filename extension and only contain "
5924 "alphanumeric, hyphen (-), underscore (_) and period (.) characters. "
5925 "Otherwise APT will print a notice that it has ignored a file if the file "
5926 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
5927 "configuration list - in this case it will be silently ignored."
5930 #. type: Content of: <refentry><refsect1><refsect2><title>
5931 #: apt_preferences.5.xml:79
5932 msgid "APT's Default Priority Assignments"
5935 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5936 #: apt_preferences.5.xml:94
5939 "<command>apt-get install -t testing "
5940 "<replaceable>some-package</replaceable></command>\n"
5943 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
5944 #: apt_preferences.5.xml:97
5946 msgid "APT::Default-Release \"stable\";\n"
5949 #. type: Content of: <refentry><refsect1><refsect2><para>
5950 #: apt_preferences.5.xml:81
5952 "If there is no preferences file or if there is no entry in the file that "
5953 "applies to a particular version then the priority assigned to that version "
5954 "is the priority of the distribution to which that version belongs. It is "
5955 "possible to single out a distribution, \"the target release\", which "
5956 "receives a higher priority than other distributions do by default. The "
5957 "target release can be set on the <command>apt-get</command> command line or "
5958 "in the APT configuration file <filename>/etc/apt/apt.conf</filename>. Note "
5959 "that this has precedence over any general priority you set in the "
5960 "<filename>/etc/apt/preferences</filename> file described later, but not over "
5961 "specifically pinned packages. For example, <placeholder "
5962 "type=\"programlisting\" id=\"0\"/> <placeholder type=\"programlisting\" "
5966 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5967 #: apt_preferences.5.xml:106
5971 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5972 #: apt_preferences.5.xml:107
5974 "to the versions coming from archives which in their "
5975 "<filename>Release</filename> files are marked as \"NotAutomatic: yes\" but "
5976 "<emphasis>not</emphasis> as \"ButAutomaticUpgrades: yes\" like the debian "
5977 "<literal>experimental</literal> archive."
5980 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5981 #: apt_preferences.5.xml:113
5982 msgid "priority 100"
5985 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
5986 #: apt_preferences.5.xml:114
5988 "to the version that is already installed (if any) and to the versions coming "
5989 "from archives which in their <filename>Release</filename> files are marked "
5990 "as \"NotAutomatic: yes\" and \"ButAutomaticUpgrades: yes\" like the debian "
5991 "backports archive since <literal>squeeze-backports</literal>."
5994 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
5995 #: apt_preferences.5.xml:121
5996 msgid "priority 500"
5999 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6000 #: apt_preferences.5.xml:122
6002 "to the versions that are not installed and do not belong to the target "
6006 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6007 #: apt_preferences.5.xml:126
6008 msgid "priority 990"
6011 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6012 #: apt_preferences.5.xml:127
6013 msgid "to the versions that are not installed and belong to the target release."
6016 #. type: Content of: <refentry><refsect1><refsect2><para>
6017 #: apt_preferences.5.xml:101
6019 "If the target release has been specified then APT uses the following "
6020 "algorithm to set the priorities of the versions of a package. Assign: "
6021 "<placeholder type=\"variablelist\" id=\"0\"/>"
6024 #. type: Content of: <refentry><refsect1><refsect2><para>
6025 #: apt_preferences.5.xml:132
6027 "If the target release has not been specified then APT simply assigns "
6028 "priority 100 to all installed package versions and priority 500 to all "
6029 "uninstalled package versions, except versions coming from archives which in "
6030 "their <filename>Release</filename> files are marked as \"NotAutomatic: yes\" "
6031 "- these versions get the priority 1 or priority 100 if it is additionally "
6032 "marked as \"ButAutomaticUpgrades: yes\"."
6035 #. type: Content of: <refentry><refsect1><refsect2><para>
6036 #: apt_preferences.5.xml:139
6038 "APT then applies the following rules, listed in order of precedence, to "
6039 "determine which version of a package to install."
6042 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6043 #: apt_preferences.5.xml:142
6045 "Never downgrade unless the priority of an available version exceeds 1000. "
6046 "(\"Downgrading\" is installing a less recent version of a package in place "
6047 "of a more recent version. Note that none of APT's default priorities "
6048 "exceeds 1000; such high priorities can only be set in the preferences file. "
6049 "Note also that downgrading a package can be risky.)"
6052 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6053 #: apt_preferences.5.xml:148
6054 msgid "Install the highest priority version."
6057 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6058 #: apt_preferences.5.xml:149
6060 "If two or more versions have the same priority, install the most recent one "
6061 "(that is, the one with the higher version number)."
6064 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6065 #: apt_preferences.5.xml:152
6067 "If two or more versions have the same priority and version number but either "
6068 "the packages differ in some of their metadata or the "
6069 "<literal>--reinstall</literal> option is given, install the uninstalled one."
6072 #. type: Content of: <refentry><refsect1><refsect2><para>
6073 #: apt_preferences.5.xml:158
6075 "In a typical situation, the installed version of a package (priority 100) "
6076 "is not as recent as one of the versions available from the sources listed in "
6077 "the &sources-list; file (priority 500 or 990). Then the package will be "
6078 "upgraded when <command>apt-get install "
6079 "<replaceable>some-package</replaceable></command> or <command>apt-get "
6080 "upgrade</command> is executed."
6083 #. type: Content of: <refentry><refsect1><refsect2><para>
6084 #: apt_preferences.5.xml:165
6086 "More rarely, the installed version of a package is <emphasis>more</emphasis> "
6087 "recent than any of the other available versions. The package will not be "
6088 "downgraded when <command>apt-get install "
6089 "<replaceable>some-package</replaceable></command> or <command>apt-get "
6090 "upgrade</command> is executed."
6093 #. type: Content of: <refentry><refsect1><refsect2><para>
6094 #: apt_preferences.5.xml:170
6096 "Sometimes the installed version of a package is more recent than the version "
6097 "belonging to the target release, but not as recent as a version belonging to "
6098 "some other distribution. Such a package will indeed be upgraded when "
6099 "<command>apt-get install <replaceable>some-package</replaceable></command> "
6100 "or <command>apt-get upgrade</command> is executed, because at least "
6101 "<emphasis>one</emphasis> of the available versions has a higher priority "
6102 "than the installed version."
6105 #. type: Content of: <refentry><refsect1><refsect2><title>
6106 #: apt_preferences.5.xml:179
6107 msgid "The Effect of APT Preferences"
6110 #. type: Content of: <refentry><refsect1><refsect2><para>
6111 #: apt_preferences.5.xml:181
6113 "The APT preferences file allows the system administrator to control the "
6114 "assignment of priorities. The file consists of one or more multi-line "
6115 "records separated by blank lines. Records can have one of two forms, a "
6116 "specific form and a general form."
6119 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6120 #: apt_preferences.5.xml:187
6122 "The specific form assigns a priority (a \"Pin-Priority\") to one or more "
6123 "specified packages and specified version or version range. For example, the "
6124 "following record assigns a high priority to all versions of the "
6125 "<filename>perl</filename> package whose version number begins with "
6126 "\"<literal>5.8</literal>\". Multiple packages can be separated by spaces."
6129 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6130 #: apt_preferences.5.xml:194
6134 "Pin: version 5.8*\n"
6135 "Pin-Priority: 1001\n"
6138 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6139 #: apt_preferences.5.xml:200
6141 "The general form assigns a priority to all of the package versions in a "
6142 "given distribution (that is, to all the versions of packages that are listed "
6143 "in a certain <filename>Release</filename> file) or to all of the package "
6144 "versions coming from a particular Internet site, as identified by the site's "
6145 "fully qualified domain name."
6148 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6149 #: apt_preferences.5.xml:206
6151 "This general-form entry in the APT preferences file applies only to groups "
6152 "of packages. For example, the following record assigns a high priority to "
6153 "all package versions available from the local site."
6156 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6157 #: apt_preferences.5.xml:211
6161 "Pin: origin \"\"\n"
6162 "Pin-Priority: 999\n"
6165 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6166 #: apt_preferences.5.xml:216
6168 "A note of caution: the keyword used here is \"<literal>origin</literal>\" "
6169 "which can be used to match a hostname. The following record will assign a "
6170 "high priority to all versions available from the server identified by the "
6171 "hostname \"ftp.de.debian.org\""
6174 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6175 #: apt_preferences.5.xml:220
6179 "Pin: origin \"ftp.de.debian.org\"\n"
6180 "Pin-Priority: 999\n"
6183 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6184 #: apt_preferences.5.xml:224
6186 "This should <emphasis>not</emphasis> be confused with the Origin of a "
6187 "distribution as specified in a <filename>Release</filename> file. What "
6188 "follows the \"Origin:\" tag in a <filename>Release</filename> file is not an "
6189 "Internet address but an author or vendor name, such as \"Debian\" or "
6193 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6194 #: apt_preferences.5.xml:229
6196 "The following record assigns a low priority to all package versions "
6197 "belonging to any distribution whose Archive name is "
6198 "\"<literal>unstable</literal>\"."
6201 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6202 #: apt_preferences.5.xml:233
6206 "Pin: release a=unstable\n"
6207 "Pin-Priority: 50\n"
6210 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6211 #: apt_preferences.5.xml:238
6213 "The following record assigns a high priority to all package versions "
6214 "belonging to any distribution whose Codename is "
6215 "\"<literal>&testing-codename;</literal>\"."
6218 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6219 #: apt_preferences.5.xml:242
6223 "Pin: release n=&testing-codename;\n"
6224 "Pin-Priority: 900\n"
6227 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6228 #: apt_preferences.5.xml:247
6230 "The following record assigns a high priority to all package versions "
6231 "belonging to any release whose Archive name is \"<literal>stable</literal>\" "
6232 "and whose release Version number is \"<literal>3.0</literal>\"."
6235 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><programlisting>
6236 #: apt_preferences.5.xml:252
6240 "Pin: release a=stable, v=3.0\n"
6241 "Pin-Priority: 500\n"
6244 #. type: Content of: <refentry><refsect1><refsect2><title>
6245 #: apt_preferences.5.xml:262
6246 msgid "Regular expressions and glob() syntax"
6249 #. type: Content of: <refentry><refsect1><refsect2><para>
6250 #: apt_preferences.5.xml:264
6252 "APT also supports pinning by glob() expressions and regular expressions "
6253 "surrounded by /. For example, the following example assigns the priority 500 "
6254 "to all packages from experimental where the name starts with gnome (as a "
6255 "glob()-like expression) or contains the word kde (as a POSIX extended "
6256 "regular expression surrounded by slashes)."
6259 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6260 #: apt_preferences.5.xml:273
6263 "Package: gnome* /kde/\n"
6264 "Pin: release n=experimental\n"
6265 "Pin-Priority: 500\n"
6268 #. type: Content of: <refentry><refsect1><refsect2><para>
6269 #: apt_preferences.5.xml:279
6271 "The rule for those expressions is that they can occur anywhere where a "
6272 "string can occur. Thus, the following pin assigns the priority 990 to all "
6273 "packages from a release starting with karmic."
6276 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6277 #: apt_preferences.5.xml:285
6281 "Pin: release n=karmic*\n"
6282 "Pin-Priority: 990\n"
6285 #. type: Content of: <refentry><refsect1><refsect2><literal>
6286 #: apt_preferences.5.xml:290
6290 #. type: Content of: <refentry><refsect1><refsect2><literal>
6291 #: apt_preferences.5.xml:296
6295 #. type: Content of: <refentry><refsect1><refsect2><title>
6296 #: apt_preferences.5.xml:306
6297 msgid "How APT Interprets Priorities"
6300 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6301 #: apt_preferences.5.xml:314
6305 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6306 #: apt_preferences.5.xml:315
6308 "causes a version to be installed even if this constitutes a downgrade of the "
6312 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6313 #: apt_preferences.5.xml:319
6314 msgid "990 < P <=1000"
6317 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6318 #: apt_preferences.5.xml:320
6320 "causes a version to be installed even if it does not come from the target "
6321 "release, unless the installed version is more recent"
6324 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6325 #: apt_preferences.5.xml:325
6326 msgid "500 < P <=990"
6329 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6330 #: apt_preferences.5.xml:326
6332 "causes a version to be installed unless there is a version available "
6333 "belonging to the target release or the installed version is more recent"
6336 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6337 #: apt_preferences.5.xml:331
6338 msgid "100 < P <=500"
6341 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6342 #: apt_preferences.5.xml:332
6344 "causes a version to be installed unless there is a version available "
6345 "belonging to some other distribution or the installed version is more recent"
6348 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6349 #: apt_preferences.5.xml:337
6350 msgid "0 < P <=100"
6353 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6354 #: apt_preferences.5.xml:338
6356 "causes a version to be installed only if there is no installed version of "
6360 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6361 #: apt_preferences.5.xml:342
6365 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6366 #: apt_preferences.5.xml:343
6367 msgid "prevents the version from being installed"
6370 #. type: Content of: <refentry><refsect1><refsect2><para>
6371 #: apt_preferences.5.xml:309
6373 "Priorities (P) assigned in the APT preferences file must be positive or "
6374 "negative integers. They are interpreted as follows (roughly speaking): "
6375 "<placeholder type=\"variablelist\" id=\"0\"/>"
6378 #. type: Content of: <refentry><refsect1><refsect2><para>
6379 #: apt_preferences.5.xml:348
6381 "If any specific-form records match an available package version then the "
6382 "first such record determines the priority of the package version. Failing "
6383 "that, if any general-form records match an available package version then "
6384 "the first such record determines the priority of the package version."
6387 #. type: Content of: <refentry><refsect1><refsect2><para>
6388 #: apt_preferences.5.xml:354
6390 "For example, suppose the APT preferences file contains the three records "
6391 "presented earlier:"
6394 #. type: Content of: <refentry><refsect1><refsect2><programlisting>
6395 #: apt_preferences.5.xml:358
6399 "Pin: version 5.8*\n"
6400 "Pin-Priority: 1001\n"
6403 "Pin: origin \"\"\n"
6404 "Pin-Priority: 999\n"
6407 "Pin: release unstable\n"
6408 "Pin-Priority: 50\n"
6411 #. type: Content of: <refentry><refsect1><refsect2><para>
6412 #: apt_preferences.5.xml:371
6416 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6417 #: apt_preferences.5.xml:373
6419 "The most recent available version of the <literal>perl</literal> package "
6420 "will be installed, so long as that version's version number begins with "
6421 "\"<literal>5.8</literal>\". If <emphasis>any</emphasis> 5.8* version of "
6422 "<literal>perl</literal> is available and the installed version is 5.9*, then "
6423 "<literal>perl</literal> will be downgraded."
6426 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6427 #: apt_preferences.5.xml:378
6429 "A version of any package other than <literal>perl</literal> that is "
6430 "available from the local system has priority over other versions, even "
6431 "versions belonging to the target release."
6434 #. type: Content of: <refentry><refsect1><refsect2><para><itemizedlist><listitem><simpara>
6435 #: apt_preferences.5.xml:382
6437 "A version of a package whose origin is not the local system but some other "
6438 "site listed in &sources-list; and which belongs to an "
6439 "<literal>unstable</literal> distribution is only installed if it is selected "
6440 "for installation and no version of the package is already installed."
6443 #. type: Content of: <refentry><refsect1><refsect2><title>
6444 #: apt_preferences.5.xml:392
6445 msgid "Determination of Package Version and Distribution Properties"
6448 #. type: Content of: <refentry><refsect1><refsect2><para>
6449 #: apt_preferences.5.xml:394
6451 "The locations listed in the &sources-list; file should provide "
6452 "<filename>Packages</filename> and <filename>Release</filename> files to "
6453 "describe the packages available at that location."
6456 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6457 #: apt_preferences.5.xml:406
6458 msgid "the <literal>Package:</literal> line"
6461 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6462 #: apt_preferences.5.xml:407
6463 msgid "gives the package name"
6466 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6467 #: apt_preferences.5.xml:410 apt_preferences.5.xml:460
6468 msgid "the <literal>Version:</literal> line"
6471 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6472 #: apt_preferences.5.xml:411
6473 msgid "gives the version number for the named package"
6476 #. type: Content of: <refentry><refsect1><refsect2><para>
6477 #: apt_preferences.5.xml:398
6479 "The <filename>Packages</filename> file is normally found in the directory "
6480 "<filename>.../dists/<replaceable>dist-name</replaceable>/<replaceable>component</replaceable>/<replaceable>arch</replaceable></filename>: "
6482 "<filename>.../dists/stable/main/binary-i386/Packages</filename>. It "
6483 "consists of a series of multi-line records, one for each package available "
6484 "in that directory. Only two lines in each record are relevant for setting "
6485 "APT priorities: <placeholder type=\"variablelist\" id=\"0\"/>"
6488 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6489 #: apt_preferences.5.xml:427
6490 msgid "the <literal>Archive:</literal> or <literal>Suite:</literal> line"
6493 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6494 #: apt_preferences.5.xml:428
6496 "names the archive to which all the packages in the directory tree belong. "
6497 "For example, the line \"Archive: stable\" or \"Suite: stable\" specifies "
6498 "that all of the packages in the directory tree below the parent of the "
6499 "<filename>Release</filename> file are in a <literal>stable</literal> "
6500 "archive. Specifying this value in the APT preferences file would require "
6504 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6505 #: apt_preferences.5.xml:438
6507 msgid "Pin: release a=stable\n"
6510 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6511 #: apt_preferences.5.xml:444
6512 msgid "the <literal>Codename:</literal> line"
6515 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6516 #: apt_preferences.5.xml:445
6518 "names the codename to which all the packages in the directory tree belong. "
6519 "For example, the line \"Codename: &testing-codename;\" specifies that all of "
6520 "the packages in the directory tree below the parent of the "
6521 "<filename>Release</filename> file belong to a version named "
6522 "<literal>&testing-codename;</literal>. Specifying this value in the APT "
6523 "preferences file would require the line:"
6526 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6527 #: apt_preferences.5.xml:454
6529 msgid "Pin: release n=&testing-codename;\n"
6532 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6533 #: apt_preferences.5.xml:461
6535 "names the release version. For example, the packages in the tree might "
6536 "belong to Debian GNU/Linux release version 3.0. Note that there is normally "
6537 "no version number for the <literal>testing</literal> and "
6538 "<literal>unstable</literal> distributions because they have not been "
6539 "released yet. Specifying this in the APT preferences file would require one "
6540 "of the following lines."
6543 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6544 #: apt_preferences.5.xml:470
6547 "Pin: release v=3.0\n"
6548 "Pin: release a=stable, v=3.0\n"
6549 "Pin: release 3.0\n"
6552 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6553 #: apt_preferences.5.xml:479
6554 msgid "the <literal>Component:</literal> line"
6557 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6558 #: apt_preferences.5.xml:480
6560 "names the licensing component associated with the packages in the directory "
6561 "tree of the <filename>Release</filename> file. For example, the line "
6562 "\"Component: main\" specifies that all the packages in the directory tree "
6563 "are from the <literal>main</literal> component, which entails that they are "
6564 "licensed under terms listed in the Debian Free Software Guidelines. "
6565 "Specifying this component in the APT preferences file would require the "
6569 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6570 #: apt_preferences.5.xml:489
6572 msgid "Pin: release c=main\n"
6575 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6576 #: apt_preferences.5.xml:495
6577 msgid "the <literal>Origin:</literal> line"
6580 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6581 #: apt_preferences.5.xml:496
6583 "names the originator of the packages in the directory tree of the "
6584 "<filename>Release</filename> file. Most commonly, this is "
6585 "<literal>Debian</literal>. Specifying this origin in the APT preferences "
6586 "file would require the line:"
6589 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6590 #: apt_preferences.5.xml:502
6592 msgid "Pin: release o=Debian\n"
6595 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><term>
6596 #: apt_preferences.5.xml:508
6597 msgid "the <literal>Label:</literal> line"
6600 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><simpara>
6601 #: apt_preferences.5.xml:509
6603 "names the label of the packages in the directory tree of the "
6604 "<filename>Release</filename> file. Most commonly, this is "
6605 "<literal>Debian</literal>. Specifying this label in the APT preferences "
6606 "file would require the line:"
6609 #. type: Content of: <refentry><refsect1><refsect2><para><variablelist><varlistentry><listitem><programlisting>
6610 #: apt_preferences.5.xml:515
6612 msgid "Pin: release l=Debian\n"
6615 #. type: Content of: <refentry><refsect1><refsect2><para>
6616 #: apt_preferences.5.xml:416
6618 "The <filename>Release</filename> file is normally found in the directory "
6619 "<filename>.../dists/<replaceable>dist-name</replaceable></filename>: for "
6620 "example, <filename>.../dists/stable/Release</filename>, or "
6621 "<filename>.../dists/&stable-codename;/Release</filename>. It consists of a "
6622 "single multi-line record which applies to <emphasis>all</emphasis> of the "
6623 "packages in the directory tree below its parent. Unlike the "
6624 "<filename>Packages</filename> file, nearly all of the lines in a "
6625 "<filename>Release</filename> file are relevant for setting APT priorities: "
6626 "<placeholder type=\"variablelist\" id=\"0\"/>"
6629 #. type: Content of: <refentry><refsect1><refsect2><para>
6630 #: apt_preferences.5.xml:522
6632 "All of the <filename>Packages</filename> and <filename>Release</filename> "
6633 "files retrieved from locations listed in the &sources-list; file are stored "
6634 "in the directory <filename>/var/lib/apt/lists</filename>, or in the file "
6635 "named by the variable <literal>Dir::State::Lists</literal> in the "
6636 "<filename>apt.conf</filename> file. For example, the file "
6637 "<filename>debian.lcs.mit.edu_debian_dists_unstable_contrib_binary-i386_Release</filename> "
6638 "contains the <filename>Release</filename> file retrieved from the site "
6639 "<literal>debian.lcs.mit.edu</literal> for <literal>binary-i386</literal> "
6640 "architecture files from the <literal>contrib</literal> component of the "
6641 "<literal>unstable</literal> distribution."
6644 #. type: Content of: <refentry><refsect1><refsect2><title>
6645 #: apt_preferences.5.xml:535
6646 msgid "Optional Lines in an APT Preferences Record"
6649 #. type: Content of: <refentry><refsect1><refsect2><para>
6650 #: apt_preferences.5.xml:537
6652 "Each record in the APT preferences file can optionally begin with one or "
6653 "more lines beginning with the word <literal>Explanation:</literal>. This "
6654 "provides a place for comments."
6657 #. type: Content of: <refentry><refsect1><refsect2><title>
6658 #: apt_preferences.5.xml:546
6659 msgid "Tracking Stable"
6662 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6663 #: apt_preferences.5.xml:554
6666 "Explanation: Uninstall or do not install any Debian-originated\n"
6667 "Explanation: package versions other than those in the stable distro\n"
6669 "Pin: release a=stable\n"
6670 "Pin-Priority: 900\n"
6673 "Pin: release o=Debian\n"
6674 "Pin-Priority: -10\n"
6677 #. type: Content of: <refentry><refsect1><refsect2><para>
6678 #: apt_preferences.5.xml:548
6680 "The following APT preferences file will cause APT to assign a priority "
6681 "higher than the default (500) to all package versions belonging to a "
6682 "<literal>stable</literal> distribution and a prohibitively low priority to "
6683 "package versions belonging to other <literal>Debian</literal> "
6684 "distributions. <placeholder type=\"programlisting\" id=\"0\"/>"
6687 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6688 #: apt_preferences.5.xml:571 apt_preferences.5.xml:617 apt_preferences.5.xml:675
6691 "apt-get install <replaceable>package-name</replaceable>\n"
6693 "apt-get dist-upgrade\n"
6696 #. type: Content of: <refentry><refsect1><refsect2><para>
6697 #: apt_preferences.5.xml:566
6699 "With a suitable &sources-list; file and the above preferences file, any of "
6700 "the following commands will cause APT to upgrade to the latest "
6701 "<literal>stable</literal> version(s). <placeholder type=\"programlisting\" "
6705 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6706 #: apt_preferences.5.xml:583
6708 msgid "apt-get install <replaceable>package</replaceable>/testing\n"
6711 #. type: Content of: <refentry><refsect1><refsect2><para>
6712 #: apt_preferences.5.xml:577
6714 "The following command will cause APT to upgrade the specified package to the "
6715 "latest version from the <literal>testing</literal> distribution; the package "
6716 "will not be upgraded again unless this command is given again. <placeholder "
6717 "type=\"programlisting\" id=\"0\"/>"
6720 #. type: Content of: <refentry><refsect1><refsect2><title>
6721 #: apt_preferences.5.xml:589
6722 msgid "Tracking Testing or Unstable"
6725 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6726 #: apt_preferences.5.xml:598
6730 "Pin: release a=testing\n"
6731 "Pin-Priority: 900\n"
6734 "Pin: release a=unstable\n"
6735 "Pin-Priority: 800\n"
6738 "Pin: release o=Debian\n"
6739 "Pin-Priority: -10\n"
6742 #. type: Content of: <refentry><refsect1><refsect2><para>
6743 #: apt_preferences.5.xml:591
6745 "The following APT preferences file will cause APT to assign a high priority "
6746 "to package versions from the <literal>testing</literal> distribution, a "
6747 "lower priority to package versions from the <literal>unstable</literal> "
6748 "distribution, and a prohibitively low priority to package versions from "
6749 "other <literal>Debian</literal> distributions. <placeholder "
6750 "type=\"programlisting\" id=\"0\"/>"
6753 #. type: Content of: <refentry><refsect1><refsect2><para>
6754 #: apt_preferences.5.xml:612
6756 "With a suitable &sources-list; file and the above preferences file, any of "
6757 "the following commands will cause APT to upgrade to the latest "
6758 "<literal>testing</literal> version(s). <placeholder type=\"programlisting\" "
6762 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6763 #: apt_preferences.5.xml:632
6765 msgid "apt-get install <replaceable>package</replaceable>/unstable\n"
6768 #. type: Content of: <refentry><refsect1><refsect2><para>
6769 #: apt_preferences.5.xml:623
6771 "The following command will cause APT to upgrade the specified package to the "
6772 "latest version from the <literal>unstable</literal> distribution. "
6773 "Thereafter, <command>apt-get upgrade</command> will upgrade the package to "
6774 "the most recent <literal>testing</literal> version if that is more recent "
6775 "than the installed version, otherwise, to the most recent "
6776 "<literal>unstable</literal> version if that is more recent than the "
6777 "installed version. <placeholder type=\"programlisting\" id=\"0\"/>"
6780 #. type: Content of: <refentry><refsect1><refsect2><title>
6781 #: apt_preferences.5.xml:639
6782 msgid "Tracking the evolution of a codename release"
6785 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6786 #: apt_preferences.5.xml:653
6789 "Explanation: Uninstall or do not install any Debian-originated package "
6791 "Explanation: other than those in the distribution codenamed with "
6792 "&testing-codename; or sid\n"
6794 "Pin: release n=&testing-codename;\n"
6795 "Pin-Priority: 900\n"
6797 "Explanation: Debian unstable is always codenamed with sid\n"
6799 "Pin: release n=sid\n"
6800 "Pin-Priority: 800\n"
6803 "Pin: release o=Debian\n"
6804 "Pin-Priority: -10\n"
6807 #. type: Content of: <refentry><refsect1><refsect2><para>
6808 #: apt_preferences.5.xml:641
6810 "The following APT preferences file will cause APT to assign a priority "
6811 "higher than the default (500) to all package versions belonging to a "
6812 "specified codename of a distribution and a prohibitively low priority to "
6813 "package versions belonging to other <literal>Debian</literal> distributions, "
6814 "codenames and archives. Note that with this APT preference APT will follow "
6815 "the migration of a release from the archive <literal>testing</literal> to "
6816 "<literal>stable</literal> and later <literal>oldstable</literal>. If you "
6817 "want to follow for example the progress in <literal>testing</literal> "
6818 "notwithstanding the codename changes you should use the example "
6819 "configurations above. <placeholder type=\"programlisting\" id=\"0\"/>"
6822 #. type: Content of: <refentry><refsect1><refsect2><para>
6823 #: apt_preferences.5.xml:670
6825 "With a suitable &sources-list; file and the above preferences file, any of "
6826 "the following commands will cause APT to upgrade to the latest version(s) in "
6827 "the release codenamed with <literal>&testing-codename;</literal>. "
6828 "<placeholder type=\"programlisting\" id=\"0\"/>"
6831 #. type: Content of: <refentry><refsect1><refsect2><para><programlisting>
6832 #: apt_preferences.5.xml:690
6834 msgid "apt-get install <replaceable>package</replaceable>/sid\n"
6837 #. type: Content of: <refentry><refsect1><refsect2><para>
6838 #: apt_preferences.5.xml:681
6840 "The following command will cause APT to upgrade the specified package to the "
6841 "latest version from the <literal>sid</literal> distribution. Thereafter, "
6842 "<command>apt-get upgrade</command> will upgrade the package to the most "
6843 "recent <literal>&testing-codename;</literal> version if that is more recent "
6844 "than the installed version, otherwise, to the most recent "
6845 "<literal>sid</literal> version if that is more recent than the installed "
6846 "version. <placeholder type=\"programlisting\" id=\"0\"/>"
6849 #. type: Content of: <refentry><refsect1><variablelist>
6850 #: apt_preferences.5.xml:699
6851 msgid "&file-preferences;"
6854 #. type: Content of: <refentry><refsect1><para>
6855 #: apt_preferences.5.xml:705
6856 msgid "&apt-get; &apt-cache; &apt-conf; &sources-list;"
6859 #. type: Content of: <refentry><refnamediv><refname>
6860 #: sources.list.5.xml:25 sources.list.5.xml:32
6861 msgid "sources.list"
6864 #. type: Content of: <refentry><refnamediv><refpurpose>
6865 #: sources.list.5.xml:33
6866 msgid "Package resource list for APT"
6869 #. type: Content of: <refentry><refsect1><para>
6870 #: sources.list.5.xml:37
6872 "The package resource list is used to locate archives of the package "
6873 "distribution system in use on the system. At this time, this manual page "
6874 "documents only the packaging system used by the Debian GNU/Linux system. "
6875 "This control file is <filename>/etc/apt/sources.list</filename>."
6878 #. type: Content of: <refentry><refsect1><para>
6879 #: sources.list.5.xml:42
6881 "The source list is designed to support any number of active sources and a "
6882 "variety of source media. The file lists one source per line, with the most "
6883 "preferred source listed first. The format of each line is: <literal>type uri "
6884 "args</literal> The first item, <literal>type</literal> determines the format "
6885 "for <literal>args</literal>. <literal>uri</literal> is a Universal Resource "
6886 "Identifier (URI), which is a superset of the more specific and well-known "
6887 "Universal Resource Locator, or URL. The rest of the line can be marked as a "
6888 "comment by using a #."
6891 #. type: Content of: <refentry><refsect1><title>
6892 #: sources.list.5.xml:53
6893 msgid "sources.list.d"
6896 #. type: Content of: <refentry><refsect1><para>
6897 #: sources.list.5.xml:54
6899 "The <filename>/etc/apt/sources.list.d</filename> directory provides a way to "
6900 "add sources.list entries in separate files. The format is the same as for "
6901 "the regular <filename>sources.list</filename> file. File names need to end "
6902 "with <filename>.list</filename> and may only contain letters (a-z and A-Z), "
6903 "digits (0-9), underscore (_), hyphen (-) and period (.) characters. "
6904 "Otherwise APT will print a notice that it has ignored a file if the file "
6905 "doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal> "
6906 "configuration list - in this case it will be silently ignored."
6909 #. type: Content of: <refentry><refsect1><title>
6910 #: sources.list.5.xml:65
6911 msgid "The deb and deb-src types"
6914 #. type: Content of: <refentry><refsect1><para>
6915 #: sources.list.5.xml:66
6917 "The <literal>deb</literal> type describes a typical two-level Debian "
6918 "archive, <filename>distribution/component</filename>. Typically, "
6919 "<literal>distribution</literal> is generally an archivename like "
6920 "<literal>stable</literal> or <literal>testing</literal> or a codename like "
6921 "<literal>&stable-codename;</literal> or "
6922 "<literal>&testing-codename;</literal> while component is one of "
6923 "<literal>main</literal> <literal>contrib</literal> or "
6924 "<literal>non-free</literal>. The <literal>deb-src</literal> type describes a "
6925 "debian distribution's source code in the same form as the "
6926 "<literal>deb</literal> type. A <literal>deb-src</literal> line is required "
6927 "to fetch source indexes."
6930 #. type: Content of: <refentry><refsect1><para>
6931 #: sources.list.5.xml:78
6933 "The format for a <filename>sources.list</filename> entry using the "
6934 "<literal>deb</literal> and <literal>deb-src</literal> types is:"
6937 #. type: Content of: <refentry><refsect1><literallayout>
6938 #: sources.list.5.xml:81
6940 msgid "deb [ options ] uri distribution [component1] [component2] [...]"
6943 #. type: Content of: <refentry><refsect1><para>
6944 #: sources.list.5.xml:83
6946 "The URI for the <literal>deb</literal> type must specify the base of the "
6947 "Debian distribution, from which APT will find the information it needs. "
6948 "<literal>distribution</literal> can specify an exact path, in which case the "
6949 "components must be omitted and <literal>distribution</literal> must end with "
6950 "a slash (/). This is useful for when the case only a particular sub-section "
6951 "of the archive denoted by the URI is of interest. If "
6952 "<literal>distribution</literal> does not specify an exact path, at least one "
6953 "<literal>component</literal> must be present."
6956 #. type: Content of: <refentry><refsect1><para>
6957 #: sources.list.5.xml:92
6959 "<literal>distribution</literal> may also contain a variable, "
6960 "<literal>$(ARCH)</literal> which expands to the Debian architecture (i386, "
6961 "m68k, powerpc, ...) used on the system. This permits "
6962 "architecture-independent <filename>sources.list</filename> files to be "
6963 "used. In general this is only of interest when specifying an exact path, "
6964 "<literal>APT</literal> will automatically generate a URI with the current "
6965 "architecture otherwise."
6968 #. type: Content of: <refentry><refsect1><para>
6969 #: sources.list.5.xml:100
6971 "Since only one distribution can be specified per line it may be necessary to "
6972 "have multiple lines for the same URI, if a subset of all available "
6973 "distributions or components at that location is desired. APT will sort the "
6974 "URI list after it has generated a complete set internally, and will collapse "
6975 "multiple references to the same Internet host, for instance, into a single "
6976 "connection, so that it does not inefficiently establish an FTP connection, "
6977 "close it, do something else, and then re-establish a connection to that same "
6978 "host. This feature is useful for accessing busy FTP sites with limits on the "
6979 "number of simultaneous anonymous users. APT also parallelizes connections to "
6980 "different hosts to more effectively deal with sites with low bandwidth."
6983 #. type: Content of: <refentry><refsect1><para>
6984 #: sources.list.5.xml:112
6986 "<literal>options</literal> is always optional and needs to be surounded by "
6987 "square brackets. It can consist of multiple settings in the form "
6988 "<literal><replaceable>setting</replaceable>=<replaceable>value</replaceable></literal>. "
6989 "Multiple settings are separated by spaces. The following settings are "
6990 "supported by APT, note through that unsupported settings will be ignored "
6994 #. type: Content of: <refentry><refsect1><para><itemizedlist><listitem><para>
6995 #: sources.list.5.xml:117
6997 "<literal>arch=<replaceable>arch1</replaceable>,<replaceable>arch2</replaceable>,…</literal> "
6998 "can be used to specify for which architectures packages information should "
6999 "be downloaded. If this option is not set all architectures defined by the "
7000 "<literal>APT::Architectures</literal> option will be downloaded."
7003 #. type: Content of: <refentry><refsect1><para>
7004 #: sources.list.5.xml:123
7006 "It is important to list sources in order of preference, with the most "
7007 "preferred source listed first. Typically this will result in sorting by "
7008 "speed from fastest to slowest (CD-ROM followed by hosts on a local network, "
7009 "followed by distant Internet hosts, for example)."
7012 #. type: Content of: <refentry><refsect1><para>
7013 #: sources.list.5.xml:128
7014 msgid "Some examples:"
7017 #. type: Content of: <refentry><refsect1><literallayout>
7018 #: sources.list.5.xml:130
7021 "deb http://ftp.debian.org/debian &stable-codename; main contrib non-free\n"
7022 "deb http://security.debian.org/ &stable-codename;/updates main contrib "
7027 #. type: Content of: <refentry><refsect1><title>
7028 #: sources.list.5.xml:136
7029 msgid "URI specification"
7032 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7033 #: sources.list.5.xml:141
7037 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7038 #: sources.list.5.xml:143
7040 "The file scheme allows an arbitrary directory in the file system to be "
7041 "considered an archive. This is useful for NFS mounts and local mirrors or "
7045 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7046 #: sources.list.5.xml:150
7048 "The cdrom scheme allows APT to use a local CDROM drive with media "
7049 "swapping. Use the &apt-cdrom; program to create cdrom entries in the source "
7053 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7054 #: sources.list.5.xml:157
7056 "The http scheme specifies an HTTP server for the archive. If an environment "
7057 "variable <envar>http_proxy</envar> is set with the format "
7058 "http://server:port/, the proxy server specified in <envar>http_proxy</envar> "
7059 "will be used. Users of authenticated HTTP/1.1 proxies may use a string of "
7060 "the format http://user:pass@server:port/. Note that this is an insecure "
7061 "method of authentication."
7064 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7065 #: sources.list.5.xml:168
7067 "The ftp scheme specifies an FTP server for the archive. APT's FTP behavior "
7068 "is highly configurable; for more information see the &apt-conf; manual "
7069 "page. Please note that a ftp proxy can be specified by using the "
7070 "<envar>ftp_proxy</envar> environment variable. It is possible to specify a "
7071 "http proxy (http proxy servers often understand ftp urls) using this method "
7072 "and ONLY this method. ftp proxies using http specified in the configuration "
7073 "file will be ignored."
7076 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7077 #: sources.list.5.xml:177
7081 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7082 #: sources.list.5.xml:179
7084 "The copy scheme is identical to the file scheme except that packages are "
7085 "copied into the cache directory instead of used directly at their location. "
7086 "This is useful for people using a zip disk to copy files around with APT."
7089 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7090 #: sources.list.5.xml:184
7094 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7095 #: sources.list.5.xml:184
7099 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7100 #: sources.list.5.xml:186
7102 "The rsh/ssh method invokes rsh/ssh to connect to a remote host as a given "
7103 "user and access the files. It is a good idea to do prior arrangements with "
7104 "RSA keys or rhosts. Access to files on the remote uses standard "
7105 "<command>find</command> and <command>dd</command> commands to perform the "
7106 "file transfers from the remote."
7109 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><term>
7110 #: sources.list.5.xml:194
7111 msgid "more recognizable URI types"
7114 #. type: Content of: <refentry><refsect1><para><variablelist><varlistentry><listitem><para>
7115 #: sources.list.5.xml:196
7117 "APT can be extended with more methods shipped in other optional packages "
7118 "which should follow the nameing scheme "
7119 "<literal>apt-transport-<replaceable>method</replaceable></literal>. The APT "
7120 "team e.g. maintains also the <literal>apt-transport-https</literal> package "
7121 "which provides access methods for https-URIs with features similar to the "
7122 "http method, but other methods for using e.g. debtorrent are also available, "
7123 "see <citerefentry> "
7124 "<refentrytitle><filename>apt-transport-debtorrent</filename></refentrytitle> "
7125 "<manvolnum>1</manvolnum></citerefentry>."
7128 #. type: Content of: <refentry><refsect1><para>
7129 #: sources.list.5.xml:138
7131 "The currently recognized URI types are cdrom, file, http, ftp, copy, ssh, "
7132 "rsh. <placeholder type=\"variablelist\" id=\"0\"/>"
7135 #. type: Content of: <refentry><refsect1><para>
7136 #: sources.list.5.xml:210
7138 "Uses the archive stored locally (or NFS mounted) at /home/jason/debian for "
7139 "stable/main, stable/contrib, and stable/non-free."
7142 #. type: Content of: <refentry><refsect1><literallayout>
7143 #: sources.list.5.xml:212
7145 msgid "deb file:/home/jason/debian stable main contrib non-free"
7148 #. type: Content of: <refentry><refsect1><para>
7149 #: sources.list.5.xml:214
7150 msgid "As above, except this uses the unstable (development) distribution."
7153 #. type: Content of: <refentry><refsect1><literallayout>
7154 #: sources.list.5.xml:215
7156 msgid "deb file:/home/jason/debian unstable main contrib non-free"
7159 #. type: Content of: <refentry><refsect1><para>
7160 #: sources.list.5.xml:217
7161 msgid "Source line for the above"
7164 #. type: Content of: <refentry><refsect1><literallayout>
7165 #: sources.list.5.xml:218
7167 msgid "deb-src file:/home/jason/debian unstable main contrib non-free"
7170 #. type: Content of: <refentry><refsect1><para>
7171 #: sources.list.5.xml:220
7173 "The first line gets package information for the architectures in "
7174 "<literal>APT::Architectures</literal> while the second always retrieves "
7175 "<literal>amd64</literal> and <literal>armel</literal>."
7178 #. type: Content of: <refentry><refsect1><literallayout>
7179 #: sources.list.5.xml:222
7182 "deb http://ftp.debian.org/debian &stable-codename; main\n"
7183 "deb [ arch=amd64,armel ] http://ftp.debian.org/debian &stable-codename; main"
7186 #. type: Content of: <refentry><refsect1><para>
7187 #: sources.list.5.xml:225
7189 "Uses HTTP to access the archive at archive.debian.org, and uses only the "
7193 #. type: Content of: <refentry><refsect1><literallayout>
7194 #: sources.list.5.xml:227
7196 msgid "deb http://archive.debian.org/debian-archive hamm main"
7199 #. type: Content of: <refentry><refsect1><para>
7200 #: sources.list.5.xml:229
7202 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7203 "directory, and uses only the &stable-codename;/contrib area."
7206 #. type: Content of: <refentry><refsect1><literallayout>
7207 #: sources.list.5.xml:231
7209 msgid "deb ftp://ftp.debian.org/debian &stable-codename; contrib"
7212 #. type: Content of: <refentry><refsect1><para>
7213 #: sources.list.5.xml:233
7215 "Uses FTP to access the archive at ftp.debian.org, under the debian "
7216 "directory, and uses only the unstable/contrib area. If this line appears as "
7217 "well as the one in the previous example in <filename>sources.list</filename> "
7218 "a single FTP session will be used for both resource lines."
7221 #. type: Content of: <refentry><refsect1><literallayout>
7222 #: sources.list.5.xml:237
7224 msgid "deb ftp://ftp.debian.org/debian unstable contrib"
7227 #. type: Content of: <refentry><refsect1><para><literallayout>
7228 #: sources.list.5.xml:246
7230 msgid "deb http://ftp.tlh.debian.org/universe unstable/binary-$(ARCH)/"
7233 #. type: Content of: <refentry><refsect1><para>
7234 #: sources.list.5.xml:239
7236 "Uses HTTP to access the archive at ftp.tlh.debian.org, under the universe "
7237 "directory, and uses only files found under "
7238 "<filename>unstable/binary-i386</filename> on i386 machines, "
7239 "<filename>unstable/binary-amd64</filename> on amd64, and so forth for other "
7240 "supported architectures. [Note this example only illustrates how to use the "
7241 "substitution variable; official debian archives are not structured like "
7242 "this] <placeholder type=\"literallayout\" id=\"0\"/>"
7245 #. type: Content of: <refentry><refsect1><para>
7246 #: sources.list.5.xml:251
7247 msgid "&apt-cache; &apt-conf;"
7250 #. type: <title></title>
7252 msgid "APT User's Guide"
7255 #. type: <author></author>
7256 #: guide.sgml:6 offline.sgml:6
7257 msgid "<name>Jason Gunthorpe </name><email>jgg@debian.org</email>"
7260 #. type: <version></version>
7262 msgid "$Id: guide.sgml,v 1.7 2003/04/26 23:26:13 doogie Exp $"
7265 #. type: <abstract></abstract>
7268 "This document provides an overview of how to use the the APT package "
7272 #. type: <copyrightsummary></copyrightsummary>
7274 msgid "Copyright © Jason Gunthorpe, 1998."
7278 #: guide.sgml:21 offline.sgml:22
7280 "\"APT\" and this document are free software; you can redistribute them "
7281 "and/or modify them under the terms of the GNU General Public License as "
7282 "published by the Free Software Foundation; either version 2 of the License, "
7283 "or (at your option) any later version."
7287 #: guide.sgml:24 offline.sgml:25
7289 "For more details, on Debian GNU/Linux systems, see the file "
7290 "/usr/share/common-licenses/GPL for the full license."
7293 #. type: <heading></heading>
7301 "The APT package currently contains two sections, the APT "
7302 "<prgn>dselect</prgn> method and the <prgn>apt-get</prgn> command line user "
7303 "interface. Both provide a way to install and remove packages as well as "
7304 "download new packages from the Internet."
7307 #. type: <heading></heading>
7309 msgid "Anatomy of the Package System"
7315 "The Debian packaging system has a large amount of information associated "
7316 "with each package to help assure that it integrates cleanly and easily into "
7317 "the system. The most prominent of its features is the dependency system."
7323 "The dependency system allows individual programs to make use of shared "
7324 "elements in the system such as libraries. It simplifies placing infrequently "
7325 "used portions of a program in separate packages to reduce the number of "
7326 "things the average user is required to install. Also, it allows for choices "
7327 "in mail transport agents, X servers and so on."
7333 "The first step to understanding the dependency system is to grasp the "
7334 "concept of a simple dependency. The meaning of a simple dependency is that a "
7335 "package requires another package to be installed at the same time to work "
7342 "For instance, mailcrypt is an emacs extension that aids in encrypting email "
7343 "with GPG. Without GPGP installed mailcrypt is useless, so mailcrypt has a "
7344 "simple dependency on GPG. Also, because it is an emacs extension it has a "
7345 "simple dependency on emacs, without emacs it is completely useless."
7351 "The other important dependency to understand is a conflicting dependency. It "
7352 "means that a package, when installed with another package, will not work and "
7353 "may possibly be extremely harmful to the system. As an example consider a "
7354 "mail transport agent such as sendmail, exim or qmail. It is not possible to "
7355 "have two mail transport agents installed because both need to listen to the "
7356 "network to receive mail. Attempting to install two will seriously damage the "
7357 "system so all mail transport agents have a conflicting dependency with all "
7358 "other mail transport agents."
7364 "As an added complication there is the possibility for a package to pretend "
7365 "to be another package. Consider that exim and sendmail for many intents are "
7366 "identical, they both deliver mail and understand a common interface. Hence, "
7367 "the package system has a way for them to declare that they are both "
7368 "mail-transport-agents. So, exim and sendmail both declare that they provide "
7369 "a mail-transport-agent and other packages that need a mail transport agent "
7370 "depend on mail-transport-agent. This can add a great deal of confusion when "
7371 "trying to manually fix packages."
7377 "At any given time a single dependency may be met by packages that are "
7378 "already installed or it may not be. APT attempts to help resolve dependency "
7379 "issues by providing a number of automatic algorithms that help in selecting "
7380 "packages for installation."
7386 "<prgn>apt-get</prgn> provides a simple way to install packages from the "
7387 "command line. Unlike <prgn>dpkg</prgn>, <prgn>apt-get</prgn> does not "
7388 "understand .deb files, it works with the package's proper name and can only "
7389 "install .deb archives from a <em>Source</em>."
7395 "The first <footnote><p>If you are using an http proxy server you must set "
7396 "the http_proxy environment variable first, see "
7397 "sources.list(5)</p></footnote> thing that should be done before using "
7398 "<prgn>apt-get</prgn> is to fetch the package lists from the <em>Sources</em> "
7399 "so that it knows what packages are available. This is done with <tt>apt-get "
7400 "update</tt>. For instance,"
7403 #. type: <example></example>
7407 "# apt-get update\n"
7408 "Get http://ftp.de.debian.org/debian-non-US/ stable/binary-i386/ Packages\n"
7409 "Get http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7410 "Reading Package Lists... Done\n"
7411 "Building Dependency Tree... Done"
7414 #. type: <p><taglist>
7416 msgid "Once updated there are several commands that can be used:"
7422 "Upgrade will attempt to gently upgrade the whole system. Upgrade will never "
7423 "install a new package or remove an existing package, nor will it ever "
7424 "upgrade a package that might cause some other package to break. This can be "
7425 "used daily to relatively safely upgrade the system. Upgrade will list all of "
7426 "the packages that it could not upgrade, this usually means that they depend "
7427 "on new packages or conflict with some other package. <prgn>dselect</prgn> or "
7428 "<tt>apt-get install</tt> can be used to force these packages to install."
7434 "Install is used to install packages by name. The package is automatically "
7435 "fetched and installed. This can be useful if you already know the name of "
7436 "the package to install and do not want to go into a GUI to select it. Any "
7437 "number of packages may be passed to install, they will all be "
7438 "fetched. Install automatically attempts to resolve dependency problems with "
7439 "the listed packages and will print a summary and ask for confirmation if "
7440 "anything other than its arguments are changed."
7446 "Dist-upgrade is a complete upgrader designed to simplify upgrading between "
7447 "releases of Debian. It uses a sophisticated algorithm to determine the best "
7448 "set of packages to install, upgrade and remove to get as much of the system "
7449 "to the newest release. In some situations it may be desired to use "
7450 "dist-upgrade rather than spend the time manually resolving dependencies in "
7451 "<prgn>dselect</prgn>. Once dist-upgrade has completed then "
7452 "<prgn>dselect</prgn> can be used to install any packages that may have been "
7459 "It is important to closely look at what dist-upgrade is going to do, its "
7460 "decisions may sometimes be quite surprising."
7466 "<prgn>apt-get</prgn> has several command line options that are detailed in "
7467 "its man page, <manref section=\"8\" name=\"apt-get\">. The most useful "
7468 "option is <tt>-d</tt> which does not install the fetched files. If the "
7469 "system has to download a large number of package it would be undesired to "
7470 "start installing them in case something goes wrong. When <tt>-d</tt> is used "
7471 "the downloaded archives can be installed by simply running the command that "
7472 "caused them to be downloaded again without <tt>-d</tt>."
7475 #. type: <heading></heading>
7483 "The APT <prgn>dselect</prgn> method provides the complete APT system with "
7484 "the <prgn>dselect</prgn> package selection GUI. <prgn>dselect</prgn> is used "
7485 "to select the packages to be installed or removed and APT actually installs "
7492 "To enable the APT method you need to select [A]ccess in <prgn>dselect</prgn> "
7493 "and then choose the APT method. You will be prompted for a set of "
7494 "<em>Sources</em> which are places to fetch archives from. These can be "
7495 "remote Internet sites, local Debian mirrors or CDROMs. Each source can "
7496 "provide a fragment of the total Debian archive, APT will automatically "
7497 "combine them to form a complete set of packages. If you have a CDROM then it "
7498 "is a good idea to specify it first and then specify a mirror so that you "
7499 "have access to the latest bug fixes. APT will automatically use packages on "
7500 "your CDROM before downloading from the Internet."
7503 #. type: <example></example>
7507 " Set up a list of distribution source locations\n"
7509 " Please give the base URL of the debian distribution.\n"
7510 " The access schemes I know about are: http file\n"
7513 " file:/mnt/debian,\n"
7514 " ftp://ftp.debian.org/debian,\n"
7515 " http://ftp.de.debian.org/debian,\n"
7518 " URL [http://llug.sep.bnl.gov/debian]:"
7524 "The <em>Sources</em> setup starts by asking for the base of the Debian "
7525 "archive, defaulting to a HTTP mirror. Next it asks for the distribution to "
7529 #. type: <example></example>
7533 " Please give the distribution tag to get or a path to the\n"
7534 " package file ending in a /. The distribution\n"
7535 " tags are typically something like: stable unstable testing non-US\n"
7537 " Distribution [stable]:"
7543 "The distribution refers to the Debian version in the archive, "
7544 "<em>stable</em> refers to the latest released version and <em>unstable</em> "
7545 "refers to the developmental version. <em>non-US</em> is only available on "
7546 "some mirrors and refers to packages that contain encryption technology or "
7547 "other things that cannot be exported from the United States. Importing these "
7548 "packages into the US is legal however."
7551 #. type: <example></example>
7555 " Please give the components to get\n"
7556 " The components are typically something like: main contrib non-free\n"
7558 " Components [main contrib non-free]:"
7564 "The components list refers to the list of sub distributions to fetch. The "
7565 "distribution is split up based on software licenses, main being DFSG free "
7566 "packages while contrib and non-free contain things that have various "
7567 "restrictions placed on their use and distribution."
7573 "Any number of sources can be added, the setup script will continue to prompt "
7574 "until you have specified all that you want."
7580 "Before starting to use <prgn>dselect</prgn> it is necessary to update the "
7581 "available list by selecting [U]pdate from the menu. This is a superset of "
7582 "<tt>apt-get update</tt> that makes the fetched information available to "
7583 "<prgn>dselect</prgn>. [U]pdate must be performed even if <tt>apt-get "
7584 "update</tt> has been run before."
7590 "You can then go on and make your selections using [S]elect and then perform "
7591 "the installation using [I]nstall. When using the APT method the [C]onfig and "
7592 "[R]emove commands have no meaning, the [I]nstall command performs both of "
7599 "By default APT will automatically remove the package (.deb) files once they "
7600 "have been successfully installed. To change this behavior place "
7601 "<tt>Dselect::clean \"prompt\";</tt> in /etc/apt/apt.conf."
7604 #. type: <heading></heading>
7606 msgid "The Interface"
7612 "Both that APT <prgn>dselect</prgn> method and <prgn>apt-get</prgn> share the "
7613 "same interface. It is a simple system that generally tells you what it will "
7614 "do and then goes and does it. <footnote><p>The <prgn>dselect</prgn> method "
7615 "actually is a set of wrapper scripts to <prgn>apt-get</prgn>. The method "
7616 "actually provides more functionality than is present in <prgn>apt-get</prgn> "
7617 "alone.</p></footnote> After printing out a summary of what will happen APT "
7618 "then will print out some informative status messages so that you can "
7619 "estimate how far along it is and how much is left to do."
7622 #. type: <heading></heading>
7630 "Before all operations except update, APT performs a number of actions to "
7631 "prepare its internal state. It also does some checks of the system's "
7632 "state. At any time these operations can be performed by running <tt>apt-get "
7636 #. type: <example></example>
7641 "Reading Package Lists... Done\n"
7642 "Building Dependency Tree... Done"
7648 "The first thing it does is read all the package files into memory. APT uses "
7649 "a caching scheme so this operation will be faster the second time it is "
7650 "run. If some of the package files are not found then they will be ignored "
7651 "and a warning will be printed when apt-get exits."
7657 "The final operation performs a detailed analysis of the system's "
7658 "dependencies. It checks every dependency of every installed or unpacked "
7659 "package and considers if it is OK. Should this find a problem then a report "
7660 "will be printed out and <prgn>apt-get</prgn> will refuse to run."
7663 #. type: <example></example>
7668 "Reading Package Lists... Done\n"
7669 "Building Dependency Tree... Done\n"
7670 "You might want to run apt-get -f install' to correct these.\n"
7671 "Sorry, but the following packages have unmet dependencies:\n"
7672 " 9fonts: Depends: xlib6g but it is not installed\n"
7673 " uucp: Depends: mailx but it is not installed\n"
7674 " blast: Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7675 " adduser: Depends: perl-base but it is not installed\n"
7676 " aumix: Depends: libgpmg1 but it is not installed\n"
7677 " debiandoc-sgml: Depends: sgml-base but it is not installed\n"
7678 " bash-builtins: Depends: bash (>= 2.01) but 2.0-3 is installed\n"
7679 " cthugha: Depends: svgalibg1 but it is not installed\n"
7680 " Depends: xlib6g (>= 3.3-5) but it is not installed\n"
7681 " libreadlineg2: Conflicts:libreadline2 (<< 2.1-2.1)"
7687 "In this example the system has many problems, including a serious problem "
7688 "with libreadlineg2. For each package that has unmet dependencies a line is "
7689 "printed out indicating the package with the problem and the dependencies "
7690 "that are unmet. A short explanation of why the package has a dependency "
7691 "problem is also included."
7697 "There are two ways a system can get into a broken state like this. The first "
7698 "is caused by <prgn>dpkg</prgn> missing some subtle relationships between "
7699 "packages when performing upgrades. <footnote><p>APT however considers all "
7700 "known dependencies and attempts to prevent broken "
7701 "packages</p></footnote>. The second is if a package installation fails "
7702 "during an operation. In this situation a package may have been unpacked "
7703 "without its dependents being installed."
7709 "The second situation is much less serious than the first because APT places "
7710 "certain constraints on the order that packages are installed. In both cases "
7711 "supplying the <tt>-f</tt> option to <prgn>apt-get</prgn> will cause APT to "
7712 "deduce a possible solution to the problem and then continue on. The APT "
7713 "<prgn>dselect</prgn> method always supplies the <tt>-f</tt> option to allow "
7714 "for easy continuation of failed maintainer scripts."
7720 "However, if the <tt>-f</tt> option is used to correct a seriously broken "
7721 "system caused by the first case then it is possible that it will either fail "
7722 "immediately or the installation sequence will fail. In either case it is "
7723 "necessary to manually use dpkg (possibly with forcing options) to correct "
7724 "the situation enough to allow APT to proceed."
7727 #. type: <heading></heading>
7729 msgid "The Status Report"
7735 "Before proceeding <prgn>apt-get</prgn> will present a report on what will "
7736 "happen. Generally the report reflects the type of operation being performed "
7737 "but there are several common elements. In all cases the lists reflect the "
7738 "final state of things, taking into account the <tt>-f</tt> option and any "
7739 "other relevant activities to the command being executed."
7742 #. type: <heading></heading>
7744 msgid "The Extra Package list"
7747 #. type: <example></example>
7751 "The following extra packages will be installed:\n"
7752 " libdbd-mysql-perl xlib6 zlib1 xzx libreadline2 libdbd-msql-perl\n"
7753 " mailpgp xdpkg fileutils pinepgp zlib1g xlib6g perl-base\n"
7754 " bin86 libgdbm1 libgdbmg1 quake-lib gmp2 bcc xbuffy\n"
7755 " squake pgp-i python-base debmake ldso perl libreadlineg2\n"
7762 "The Extra Package list shows all of the packages that will be installed or "
7763 "upgraded in excess of the ones mentioned on the command line. It is only "
7764 "generated for an <tt>install</tt> command. The listed packages are often the "
7765 "result of an Auto Install."
7768 #. type: <heading></heading>
7770 msgid "The Packages to Remove"
7773 #. type: <example></example>
7777 "The following packages will be REMOVED:\n"
7778 " xlib6-dev xpat2 tk40-dev xkeycaps xbattle xonix\n"
7779 " xdaliclock tk40 tk41 xforms0.86 ghostview xloadimage xcolorsel\n"
7780 " xadmin xboard perl-debug tkined xtetris libreadline2-dev perl-suid\n"
7787 "The Packages to Remove list shows all of the packages that will be removed "
7788 "from the system. It can be shown for any of the operations and should be "
7789 "given a careful inspection to ensure nothing important is to be taken "
7790 "off. The <tt>-f</tt> option is especially good at generating packages to "
7791 "remove so extreme care should be used in that case. The list may contain "
7792 "packages that are going to be removed because they are only partially "
7793 "installed, possibly due to an aborted installation."
7796 #. type: <heading></heading>
7798 msgid "The New Packages list"
7801 #. type: <example></example>
7805 "The following NEW packages will installed:\n"
7806 " zlib1g xlib6g perl-base libgdbmg1 quake-lib gmp2 pgp-i python-base"
7812 "The New Packages list is simply a reminder of what will happen. The packages "
7813 "listed are not presently installed in the system but will be when APT is "
7817 #. type: <heading></heading>
7819 msgid "The Kept Back list"
7822 #. type: <example></example>
7826 "The following packages have been kept back\n"
7827 " compface man-db tetex-base msql libpaper svgalib1\n"
7828 " gs snmp arena lynx xpat2 groff xscreensaver"
7834 "Whenever the whole system is being upgraded there is the possibility that "
7835 "new versions of packages cannot be installed because they require new things "
7836 "or conflict with already installed things. In this case the package will "
7837 "appear in the Kept Back list. The best way to convince packages listed there "
7838 "to install is with <tt>apt-get install</tt> or by using <prgn>dselect</prgn> "
7839 "to resolve their problems."
7842 #. type: <heading></heading>
7844 msgid "Held Packages warning"
7847 #. type: <example></example>
7851 "The following held packages will be changed:\n"
7858 "Sometimes you can ask APT to install a package that is on hold, in such a "
7859 "case it prints out a warning that the held package is going to be "
7860 "changed. This should only happen during dist-upgrade or install."
7863 #. type: <heading></heading>
7865 msgid "Final summary"
7870 msgid "Finally, APT will print out a summary of all the changes that will occur."
7873 #. type: <example></example>
7877 "206 packages upgraded, 8 newly installed, 23 to remove and 51 not "
7879 "12 packages not fully installed or removed.\n"
7880 "Need to get 65.7M/66.7M of archives. After unpacking 26.5M will be used."
7886 "The first line of the summary simply is a reduced version of all of the "
7887 "lists and includes the number of upgrades - that is packages already "
7888 "installed that have new versions available. The second line indicates the "
7889 "number of poorly configured packages, possibly the result of an aborted "
7890 "installation. The final line shows the space requirements that the "
7891 "installation needs. The first pair of numbers refer to the size of the "
7892 "archive files. The first number indicates the number of bytes that must be "
7893 "fetched from remote locations and the second indicates the total size of all "
7894 "the archives required. The next number indicates the size difference between "
7895 "the presently installed packages and the newly installed packages. It is "
7896 "roughly equivalent to the space required in /usr after everything is "
7897 "done. If a large number of packages are being removed then the value may "
7898 "indicate the amount of space that will be freed."
7904 "Some other reports can be generated by using the -u option to show packages "
7905 "to upgrade, they are similar to the previous examples."
7908 #. type: <heading></heading>
7910 msgid "The Status Display"
7916 "During the download of archives and package files APT prints out a series of "
7920 #. type: <example></example>
7924 "# apt-get update\n"
7925 "Get:1 http://ftp.de.debian.org/debian-non-US/ stable/non-US/ Packages\n"
7926 "Get:2 http://llug.sep.bnl.gov/debian/ testing/contrib Packages\n"
7927 "Hit http://llug.sep.bnl.gov/debian/ testing/main Packages\n"
7928 "Get:4 http://ftp.de.debian.org/debian-non-US/ unstable/binary-i386/ "
7930 "Get:5 http://llug.sep.bnl.gov/debian/ testing/non-free Packages\n"
7931 "11% [5 testing/non-free `Waiting for file' 0/32.1k 0%] 2203b/s 1m52s"
7937 "The lines starting with <em>Get</em> are printed out when APT begins to "
7938 "fetch a file while the last line indicates the progress of the download. The "
7939 "first percent value on the progress line indicates the total percent done of "
7940 "all files. Unfortunately since the size of the Package files is unknown "
7941 "<tt>apt-get update</tt> estimates the percent done which causes some "
7948 "The next section of the status line is repeated once for each download "
7949 "thread and indicates the operation being performed and some useful "
7950 "information about what is happening. Sometimes this section will simply read "
7951 "<em>Forking</em> which means the OS is loading the download module. The "
7952 "first word after the [ is the fetch number as shown on the history "
7953 "lines. The next word is the short form name of the object being "
7954 "downloaded. For archives it will contain the name of the package that is "
7961 "Inside of the single quote is an informative string indicating the progress "
7962 "of the negotiation phase of the download. Typically it progresses from "
7963 "<em>Connecting</em> to <em>Waiting for file</em> to <em>Downloading</em> or "
7964 "<em>Resuming</em>. The final value is the number of bytes downloaded from "
7965 "the remote site. Once the download begins this is represented as "
7966 "<tt>102/10.2k</tt> indicating that 102 bytes have been fetched and 10.2 "
7967 "kilobytes is expected. The total size is always shown in 4 figure notation "
7968 "to preserve space. After the size display is a percent meter for the file "
7969 "itself. The second last element is the instantaneous average speed. This "
7970 "values is updated every 5 seconds and reflects the rate of data transfer for "
7971 "that period. Finally is shown the estimated transfer time. This is updated "
7972 "regularly and reflects the time to complete everything at the shown transfer "
7979 "The status display updates every half second to provide a constant feedback "
7980 "on the download progress while the Get lines scroll back whenever a new file "
7981 "is started. Since the status display is constantly updated it is unsuitable "
7982 "for logging to a file, use the <tt>-q</tt> option to remove the status "
7986 #. type: <heading></heading>
7994 "APT uses <prgn>dpkg</prgn> for installing the archives and will switch over "
7995 "to the <prgn>dpkg</prgn> interface once downloading is "
7996 "completed. <prgn>dpkg</prgn> will also ask a number of questions as it "
7997 "processes the packages and the packages themselves may also ask several "
7998 "questions. Before each question there is usually a description of what it is "
7999 "asking and the questions are too varied to discuss completely here."
8002 #. type: <title></title>
8004 msgid "Using APT Offline"
8007 #. type: <version></version>
8009 msgid "$Id: offline.sgml,v 1.8 2003/02/12 15:06:41 doogie Exp $"
8012 #. type: <abstract></abstract>
8015 "This document describes how to use APT in a non-networked environment, "
8016 "specifically a 'sneaker-net' approach for performing upgrades."
8019 #. type: <copyrightsummary></copyrightsummary>
8021 msgid "Copyright © Jason Gunthorpe, 1999."
8024 #. type: <heading></heading>
8026 msgid "Introduction"
8029 #. type: <heading></heading>
8030 #: offline.sgml:34 offline.sgml:65 offline.sgml:180
8037 "Normally APT requires direct access to a Debian archive, either from a local "
8038 "media or through a network. Another common complaint is that a Debian "
8039 "machine is on a slow link, such as a modem and another machine has a very "
8040 "fast connection but they are physically distant."
8046 "The solution to this is to use large removable media such as a Zip disc or a "
8047 "SuperDisk disc. These discs are not large enough to store the entire Debian "
8048 "archive but can easily fit a subset large enough for most users. The idea is "
8049 "to use APT to generate a list of packages that are required and then fetch "
8050 "them onto the disc using another machine with good connectivity. It is even "
8051 "possible to use another Debian machine with APT or to use a completely "
8052 "different OS and a download tool like wget. Let <em>remote host</em> mean "
8053 "the machine downloading the packages, and <em>target host</em> the one with "
8054 "bad or no connection."
8060 "This is achieved by creatively manipulating the APT configuration file. The "
8061 "essential premise to tell APT to look on a disc for it's archive files. Note "
8062 "that the disc should be formated with a filesystem that can handle long file "
8063 "names such as ext2, fat32 or vfat."
8066 #. type: <heading></heading>
8068 msgid "Using APT on both machines"
8071 #. type: <p><example>
8074 "APT being available on both machines gives the simplest configuration. The "
8075 "basic idea is to place a copy of the status file on the disc and use the "
8076 "remote machine to fetch the latest package files and decide which packages "
8077 "to download. The disk directory structure should look like:"
8080 #. type: <example></example>
8094 #. type: <heading></heading>
8096 msgid "The configuration file"
8102 "The configuration file should tell APT to store its files on the disc and to "
8103 "use the configuration files on the disc as well. The sources.list should "
8104 "contain the proper sites that you wish to use from the remote machine, and "
8105 "the status file should be a copy of <em>/var/lib/dpkg/status</em> from the "
8106 "<em>target host</em>. Please note, if you are using a local archive you must "
8107 "use copy URIs, the syntax is identical to file URIs."
8110 #. type: <p><example>
8113 "<em>apt.conf</em> must contain the necessary information to make APT use the "
8117 #. type: <example></example>
8123 " /* This is not necessary if the two machines are the same arch, it "
8125 " the remote APT what architecture the target machine is */\n"
8126 " Architecture \"i386\";\n"
8128 " Get::Download-Only \"true\";\n"
8133 " /* Use the disc for state information and redirect the status file from\n"
8134 " the /var/lib/dpkg default */\n"
8135 " State \"/disc/\";\n"
8136 " State::status \"status\";\n"
8138 " // Binary caches will be stored locally\n"
8139 " Cache::archives \"/disc/archives/\";\n"
8140 " Cache \"/tmp/\";\n"
8142 " // Location of the source list.\n"
8143 " Etc \"/disc/\";\n"
8147 #. type: </example></p>
8150 "More details can be seen by examining the apt.conf man page and the sample "
8151 "configuration file in <em>/usr/share/doc/apt/examples/apt.conf</em>."
8154 #. type: <p><example>
8157 "On the target machine the first thing to do is mount the disc and copy "
8158 "<em>/var/lib/dpkg/status</em> to it. You will also need to create the "
8159 "directories outlined in the Overview, <em>archives/partial/</em> and "
8160 "<em>lists/partial/</em>. Then take the disc to the remote machine and "
8161 "configure the sources.list. On the remote machine execute the following:"
8164 #. type: <example></example>
8168 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8169 " # apt-get update\n"
8170 " [ APT fetches the package files ]\n"
8171 " # apt-get dist-upgrade\n"
8172 " [ APT fetches all the packages needed to upgrade the target machine ]"
8175 #. type: </example></p>
8178 "The dist-upgrade command can be replaced with any other standard APT "
8179 "commands, particularly dselect-upgrade. You can even use an APT front end "
8180 "such as <em>dselect</em>. However this presents a problem in communicating "
8181 "your selections back to the local computer."
8184 #. type: <p><example>
8187 "Now the disc contains all of the index files and archives needed to upgrade "
8188 "the target machine. Take the disc back and run:"
8191 #. type: <example></example>
8195 " # export APT_CONFIG=\"/disc/apt.conf\"\n"
8196 " # apt-get check\n"
8197 " [ APT generates a local copy of the cache files ]\n"
8198 " # apt-get --no-d -o dir::state::status=/var/lib/dpkg/status dist-upgrade\n"
8199 " [ Or any other APT command ]"
8205 "It is necessary for proper function to re-specify the status file to be the "
8206 "local one. This is very important!"
8212 "If you are using dselect you can do the very risky operation of copying "
8213 "disc/status to /var/lib/dpkg/status so that any selections you made on the "
8214 "remote machine are updated. I highly recommend that people only make "
8215 "selections on the local machine - but this may not always be possible. DO "
8216 "NOT copy the status file if dpkg or APT have been run in the mean time!!"
8219 #. type: <heading></heading>
8221 msgid "Using APT and wget"
8227 "<em>wget</em> is a popular and portable download tool that can run on nearly "
8228 "any machine. Unlike the method above this requires that the Debian machine "
8229 "already has a list of available packages."
8235 "The basic idea is to create a disc that has only the archive files "
8236 "downloaded from the remote site. This is done by using the --print-uris "
8237 "option to apt-get and then preparing a wget script to actually fetch the "
8241 #. type: <heading></heading>
8246 #. type: <p><example>
8249 "Unlike the previous technique no special configuration files are "
8250 "required. We merely use the standard APT commands to generate the file list."
8253 #. type: <example></example>
8257 " # apt-get dist-upgrade \n"
8258 " [ Press no when prompted, make sure you are happy with the actions ]\n"
8259 " # apt-get -qq --print-uris dist-upgrade > uris\n"
8260 " # awk '{print \"wget -O \" $2 \" \" $1}' < uris > /disc/wget-script"
8263 #. type: </example></p>
8266 "Any command other than dist-upgrade could be used here, including "
8273 "The /disc/wget-script file will now contain a list of wget commands to "
8274 "execute in order to fetch the necessary archives. This script should be run "
8275 "with the current directory as the disc's mount point so as to save the "
8276 "output on the disc."
8279 #. type: <p><example>
8281 msgid "The remote machine would do something like"
8284 #. type: <example></example>
8289 " # sh -x ./wget-script\n"
8293 #. type: </example><example>
8296 "Once the archives are downloaded and the disc returned to the Debian machine "
8297 "installation can proceed using,"
8300 #. type: <example></example>
8303 msgid " # apt-get -o dir::cache::archives=\"/disc/\" dist-upgrade"
8306 #. type: </example></p>
8308 msgid "Which will use the already fetched archives on the disc."