merge fix from david for warning during xml build
[ntk/apt.git] / doc / apt.conf.5.xml
index 7b72907..3de22e0 100644 (file)
@@ -5,6 +5,9 @@
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
 
+<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
+%aptverbatiment;
+
 ]>
 
 <refentry>
    &apt-author.jgunthorpe;
    &apt-author.team;
    <author>
-     <firstname>Daniel</firstname>
-     <surname>Burrows</surname>
+     &apt-name.dburrows;
      <contrib>Initial documentation of Debug::*.</contrib>
      <email>dburrows@debian.org</email>
    </author>
    &apt-email;
    &apt-product;
    <!-- The last update date -->
-   <date>16 January 2010</date>
+   <date>2012-05-21T00:00:00Z</date>
  </refentryinfo>
  
  <refmeta>
       <listitem><para>the file specified by the <envar>APT_CONFIG</envar>
         environment variable (if any)</para></listitem>
       <listitem><para>all files in <literal>Dir::Etc::Parts</literal> in
-        alphanumeric ascending order which have no or "<literal>conf</literal>"
+        alphanumeric ascending order which have either no or "<literal>conf</literal>"
         as filename extension and which only contain alphanumeric,
-        hyphen (-), underscore (_) and period (.) characters -
-        otherwise they will be silently ignored.</para></listitem>
+        hyphen (-), underscore (_) and period (.) characters.
+        Otherwise APT will print a notice that it has ignored a file if the file
+        doesn't match a pattern in the <literal>Dir::Ignore-Files-Silently</literal>
+        configuration list - in this case it will be silently ignored.</para></listitem>
       <listitem><para>the main configuration file specified by
         <literal>Dir::Etc::main</literal></para></listitem>
       <listitem><para>the command line options are applied to override the
@@ -122,14 +126,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    <para>All of the APT tools take a -o option which allows an arbitrary configuration 
    directive to be specified on the command line. The syntax is a full option
    name (<literal>APT::Get::Assume-Yes</literal> for instance) followed by an equals
-   sign then the new value of the option. Lists can be appended too by adding 
-   a trailing :: to the list name. (As you might suspect: The scope syntax can't be used
-   on the command line.)</para>
+   sign then the new value of the option. To append a new element to a list, add a
+   trailing :: to the name of the list. (As you might suspect: The scope syntax can't
+   be used on the command line.)</para>
 
    <para>Note that you can use :: only for appending one item per line to a list and
    that you should not use it in combination with the scope syntax.
    (The scope syntax implicit insert ::) Using both syntaxes together will trigger a bug
-   which some users unfortunately relay on: An option with the unusual name "<literal>::</literal>"
+   which some users unfortunately depend on: An option with the unusual name "<literal>::</literal>"
    which acts like every other option with a name. These introduces many problems
    including that a user who writes multiple lines in this <emphasis>wrong</emphasis> syntax in
    the hope to append to a list will gain the opposite as only the last assignment for this option
@@ -143,31 +147,41 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    options for all of the tools.</para>
 
    <variablelist>
-     <varlistentry><term>Architecture</term>
+     <varlistentry><term><option>Architecture</option></term>
      <listitem><para>System Architecture; sets the architecture to use when fetching files and
      parsing package lists. The internal default is the architecture apt was 
      compiled for.</para></listitem>
      </varlistentry>
-     
-     <varlistentry><term>Default-Release</term>
+
+     <varlistentry><term><option>Architectures</option></term>
+     <listitem><para>All Architectures the system supports. Processors implementing the
+     <literal>amd64</literal> (also called <literal>x86-64</literal>) instruction set are
+     e.g. also able to execute binaries compiled for the <literal>i386</literal>
+     (<literal>x86</literal>) instruction set; This list is use when fetching files and
+     parsing package lists. The internal default is always the native architecture (<literal>APT::Architecture</literal>)
+     and all foreign architectures it can retrieve by calling <command>dpkg --print-foreign-architectures</command>.
+     </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>Default-Release</option></term>
      <listitem><para>Default release to install packages from if more than one
      version available. Contains release name, codename or release version. Examples: 'stable', 'testing',
      'unstable', '&stable-codename;', '&testing-codename;', '4.0', '5.0*'. See also &apt-preferences;.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Ignore-Hold</term>
+     <varlistentry><term><option>Ignore-Hold</option></term>
      <listitem><para>Ignore Held packages; This global option causes the problem resolver to
      ignore held packages in its decision making.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Clean-Installed</term>
+     <varlistentry><term><option>Clean-Installed</option></term>
      <listitem><para>Defaults to on. When turned on the autoclean feature will remove any packages
      which can no longer be downloaded from the cache. If turned off then
      packages that are locally installed are also excluded from cleaning - but
      note that APT provides no direct means to reinstall them.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Immediate-Configure</term>
+     <varlistentry><term><option>Immediate-Configure</option></term>
      <listitem><para>Defaults to on which will cause APT to install essential and important packages
      as fast as possible in the install/upgrade operation. This is done to limit the effect of a failing
      &dpkg; call: If this option is disabled APT does treat an important package in the same way as
@@ -190,7 +204,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      improving or correcting the upgrade process.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Force-LoopBreak</term>
+     <varlistentry><term><option>Force-LoopBreak</option></term>
      <listitem><para>Never Enable this option unless you -really- know what you are doing. It
      permits APT to temporarily remove an essential package to break a
      Conflicts/Conflicts or Conflicts/Pre-Depend loop between two essential
@@ -199,14 +213,14 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      anything that those packages depend on.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Cache-Start, Cache-Grow and Cache-Limit</term>
+     <varlistentry><term><option>Cache-Start</option></term><term><option>Cache-Grow</option></term><term><option>Cache-Limit</option></term>
      <listitem><para>APT uses since version 0.7.26 a resizable memory mapped cache file to store the 'available'
      information. <literal>Cache-Start</literal> acts as a hint to which size the Cache will grow
      and is therefore the amount of memory APT will request at startup. The default value is
-     20971520 bytes (~20 MB). Note that these amount of space need to be available for APT
-     otherwise it will likely fail ungracefully, so for memory restricted devices these value should
-     be lowered while on systems with a lot of configured sources this might be increased.
-     <literal>Cache-Grow</literal> defines in byte with the default of 1048576 (~1 MB) how much
+     20971520 bytes (~20 MB). Note that this amount of space needs to be available for APT
+     otherwise it will likely fail ungracefully, so for memory restricted devices this value should
+     be lowered while on systems with a lot of configured sources it should be increased.
+     <literal>Cache-Grow</literal> defines in bytes with the default of 1048576 (~1 MB) how much
      the Cache size will be increased in the event the space defined by <literal>Cache-Start</literal>
      is not enough. These value will be applied again and again until either the cache is big
      enough to store all information or the size of the cache reaches the <literal>Cache-Limit</literal>.
@@ -215,21 +229,21 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      </para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Build-Essential</term>
+     <varlistentry><term><option>Build-Essential</option></term>
      <listitem><para>Defines which package(s) are considered essential build dependencies.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Get</term>
+     <varlistentry><term><option>Get</option></term>
      <listitem><para>The Get subsection controls the &apt-get; tool, please see its
      documentation for more information about the options here.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Cache</term>
+     <varlistentry><term><option>Cache</option></term>
      <listitem><para>The Cache subsection controls the &apt-cache; tool, please see its
      documentation for more information about the options here.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>CDROM</term>
+     <varlistentry><term><option>CDROM</option></term>
      <listitem><para>The CDROM subsection controls the &apt-cdrom; tool, please see its
      documentation for more information about the options here.</para></listitem>
      </varlistentry>
@@ -241,7 +255,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    and the URI handlers. 
 
    <variablelist>
-     <varlistentry><term>Check-Valid-Until</term>
+     <varlistentry><term><option>Check-Valid-Until</option></term>
         <listitem><para>Security related option defaulting to true as an
         expiring validation for a Release file prevents longtime replay attacks
         and can e.g. also help users to identify no longer updated mirrors -
@@ -252,33 +266,42 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
         </para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Max-ValidTime</term>
+     <varlistentry><term><option>Max-ValidTime</option></term>
         <listitem><para>Seconds the Release file should be considered valid after
-        it was created. The default is "for ever" (0) if the Release file of the
-        archive doesn't include a <literal>Valid-Until</literal> header.
-        If it does then this date is the default. The date from the Release file or
-        the date specified by the creation time of the Release file
-        (<literal>Date</literal> header) plus the seconds specified with this
-        options are used to check if the validation of a file has expired by using
-        the earlier date of the two. Archive specific settings can be made by
-        appending the label of the archive to the option name.
+        it was created (indicated by the <literal>Date</literal> header).
+        If the Release file itself includes a <literal>Valid-Until</literal> header
+        the earlier date of the two is used as the expiration date.
+        The default value is <literal>0</literal> which stands for "for ever valid".
+        Archive specific settings can be made by appending the label of the archive
+        to the option name.
+        </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>Min-ValidTime</option></term>
+        <listitem><para>Minimum of seconds the Release file should be considered
+        valid after it was created (indicated by the <literal>Date</literal> header).
+        Use this if you need to use a seldomly updated (local) mirror of a more
+        regular updated archive with a <literal>Valid-Until</literal> header
+        instead of completely disabling the expiration date checking.
+        Archive specific settings can and should be used by appending the label of
+        the archive to the option name.
         </para></listitem>
      </varlistentry>
 
-     <varlistentry><term>PDiffs</term>
+     <varlistentry><term><option>PDiffs</option></term>
         <listitem><para>Try to download deltas called <literal>PDiffs</literal> for
         Packages or Sources files instead of downloading whole ones. True
         by default.</para>
         <para>Two sub-options to limit the use of PDiffs are also available:
         With <literal>FileLimit</literal> can be specified how many PDiff files
-        are downloaded at most to patch a file. <literal>SizeLimit</literal>
-        on the other hand is the maximum precentage of the size of all patches
+        are downloaded at most to update a file. <literal>SizeLimit</literal>
+        on the other hand is the maximum percentage of the size of all patches
         compared to the size of the targeted file. If one of these limits is
         exceeded the complete file is downloaded instead of the patches.
         </para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Queue-Mode</term>
+     <varlistentry><term><option>Queue-Mode</option></term>
      <listitem><para>Queuing mode; <literal>Queue-Mode</literal> can be one of <literal>host</literal> or 
      <literal>access</literal> which determines how  APT parallelizes outgoing 
      connections. <literal>host</literal> means that one connection per target host 
@@ -286,17 +309,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      will be opened.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Retries</term>
+     <varlistentry><term><option>Retries</option></term>
      <listitem><para>Number of retries to perform. If this is non-zero APT will retry failed 
      files the given number of times.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Source-Symlinks</term>
+     <varlistentry><term><option>Source-Symlinks</option></term>
      <listitem><para>Use symlinks for source archives. If set to true then source archives will
      be symlinked when possible instead of copying. True is the default.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>http</term>
+     <varlistentry><term><option>http</option></term>
      <listitem><para>HTTP URIs; http::Proxy is the default http proxy to use. It is in the 
      standard form of <literal>http://[[user][:pass]@]host[:port]/</literal>. Per 
      host proxies can also be specified by using the form 
@@ -318,13 +341,15 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      <para>The option <literal>timeout</literal> sets the timeout timer used by the method, 
      this applies to all things including connection timeout and data timeout.</para>
 
-     <para>One setting is provided to control the pipeline depth in cases where the
-     remote server is not RFC conforming or buggy (such as Squid 2.0.2).
-     <literal>Acquire::http::Pipeline-Depth</literal> can be a value from 0 to 5 
-     indicating how many outstanding requests APT should send. A value of
-     zero MUST be specified if the remote host does not properly linger
-     on TCP connections - otherwise data corruption will occur. Hosts which
-     require this are in violation of RFC 2068.</para>
+     <para>The setting <literal>Acquire::http::Pipeline-Depth</literal> can be used to
+     enabled HTTP pipeling (RFC 2616 section 8.1.2.2) which can be beneficial e.g. on
+     high-latency connections. It specifies how many requests are send in a pipeline.
+     Previous APT versions had a default of 10 for this setting, but the default value
+     is now 0 (= disabled) to avoid problems with the ever-growing amount of webservers
+     and proxies which choose to not conform to the HTTP/1.1 specification.</para>
+
+     <para><literal>Acquire::http::AllowRedirect</literal> controls if APT will follow
+     redirects, which is enabled by default.</para>
 
      <para>The used bandwidth can be limited with <literal>Acquire::http::Dl-Limit</literal>
      which accepts integer values in kilobyte. The default value is 0 which deactivates
@@ -337,7 +362,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      </listitem>
      </varlistentry>
 
-     <varlistentry><term>https</term>
+     <varlistentry><term><option>https</option></term>
         <listitem><para>HTTPS URIs. Cache-control, Timeout, AllowRedirect, Dl-Limit and
         proxy options are the same as for <literal>http</literal> method and will also
         default to the options from the <literal>http</literal> method if they are not
@@ -362,7 +387,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
         <literal>&lt;host&gt;::SslForceVersion</literal> is corresponding per-host option.
         </para></listitem></varlistentry>
 
-     <varlistentry><term>ftp</term>
+     <varlistentry><term><option>ftp</option></term>
      <listitem><para>FTP URIs; ftp::Proxy is the default ftp proxy to use. It is in the 
      standard form of <literal>ftp://[[user][:pass]@]host[:port]/</literal>. Per 
      host proxies can also be specified by using the form 
@@ -401,7 +426,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      do not support RFC2428.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>cdrom</term>
+     <varlistentry><term><option>cdrom</option></term>
      <listitem><para>CDROM URIs; the only setting for CDROM URIs is the mount point, 
      <literal>cdrom::Mount</literal> which must be the mount point for the CDROM drive 
      as specified in <filename>/etc/fstab</filename>. It is possible to provide 
@@ -412,13 +437,13 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      commands can be specified using UMount.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>gpgv</term>
+     <varlistentry><term><option>gpgv</option></term>
      <listitem><para>GPGV URIs; the only option for GPGV URIs is the option to pass additional parameters to gpgv.
      <literal>gpgv::Options</literal> Additional options passed to gpgv.
      </para></listitem>
      </varlistentry>
 
-     <varlistentry><term>CompressionTypes</term>
+     <varlistentry><term><option>CompressionTypes</option></term>
      <listitem><para>List of compression types which are understood by the acquire methods.
      Files like <filename>Packages</filename> can be available in various compression formats.
      Per default the acquire methods can decompress <command>bzip2</command>, <command>lzma</command>
@@ -436,18 +461,26 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      It is not needed to add <literal>bz2</literal> explicit to the list as it will be added automatic.</para>
      <para>Note that at run time the <literal>Dir::Bin::<replaceable>Methodname</replaceable></literal> will
      be checked: If this setting exists the method will only be used if this file exists, e.g. for
-     the bzip2 method (the inbuilt) setting is <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>
+     the bzip2 method (the inbuilt) setting is: <literallayout>Dir::Bin::bzip2 "/bin/bzip2";</literallayout>
      Note also that list entries specified on the command line will be added at the end of the list
      specified in the configuration files, but before the default entries. To prefer a type in this case
-     over the ones specified in in the configuration files you can set the option direct - not in list style.
+     over the ones specified in the configuration files you can set the option direct - not in list style.
      This will not override the defined list, it will only prefix the list with this type.</para>
-     <para>While it is possible to add an empty compression type to the order list, but APT in its current
-     version doesn't understand it correctly and will display many warnings about not downloaded files -
-     these warnings are most of the time false negatives. Future versions will maybe include a way to
-     really prefer uncompressed files to support the usage of local mirrors.</para></listitem>
+     <para>The special type <literal>uncompressed</literal> can be used to give uncompressed files a
+     preference, but note that most archives don't provide uncompressed files so this is mostly only
+     useable for local mirrors.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Languages</term>
+     <varlistentry><term><option>GzipIndexes</option></term>
+        <listitem><para>
+        When downloading <literal>gzip</literal> compressed indexes (Packages, Sources, or
+        Translations), keep them gzip compressed locally instead of unpacking
+        them. This saves quite a lot of disk space at the expense of more CPU
+        requirements when building the local package caches. False by default.
+        </para></listitem>
+     </varlistentry>
+
+     <varlistentry><term><option>Languages</option></term>
      <listitem><para>The Languages subsection controls which <filename>Translation</filename> files are downloaded
      and in which order APT tries to display the Description-Translations. APT will try to display the first
      available Description in the Language which is listed at first. Languages can be defined with their
@@ -464,7 +497,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      actually use them if the environment doesn't specify this languages. So the following example configuration will
      result in the order "en, de" in an english and in "de, en" in a german localization. Note that "fr" is downloaded,
      but not used if APT is not used in a french localization, in such an environment the order would be "fr, de, en".
-     <programlisting>Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };</programlisting></para></listitem>
+     <programlisting>Acquire::Languages { "environment"; "de"; "en"; "none"; "fr"; };</programlisting></para>
+     <para>Note: To prevent problems resulting from APT being executed in different environments
+     (e.g. by different users or by other programs) all Translation files which are found in
+     <filename>/var/lib/apt/lists/</filename> will be added to the end of the list
+     (after an implicit "<literal>none</literal>").</para>
+     </listitem>
      </varlistentry>
 
    </variablelist>
@@ -476,7 +514,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    <para>The <literal>Dir::State</literal> section has directories that pertain to local 
    state information. <literal>lists</literal> is the directory to place downloaded 
    package lists in and <literal>status</literal> is the name of the dpkg status file.
-   <literal>preferences</literal> is the name of the APT preferences file.
+   <literal>preferences</literal> is the name of the APT <filename>preferences</filename> file.
    <literal>Dir::State</literal> contains the default directory to prefix on all sub 
    items if they do not start with <filename>/</filename> or <filename>./</filename>.</para>
 
@@ -535,7 +573,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    control the default behaviour. These are in the <literal>DSelect</literal> section.</para>
    
    <variablelist>
-     <varlistentry><term>Clean</term>
+     <varlistentry><term><option>Clean</option></term>
      <listitem><para>Cache Clean mode; this value may be one of always, prompt, auto,
      pre-auto and never.  always and prompt will remove all packages from
      the cache after upgrading, prompt (the default) does so conditionally. 
@@ -544,17 +582,17 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      action before downloading new packages.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>options</term>
+     <varlistentry><term><option>options</option></term>
      <listitem><para>The contents of this variable is passed to &apt-get; as command line
      options when it is run for the install phase.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Updateoptions</term>
+     <varlistentry><term><option>Updateoptions</option></term>
      <listitem><para>The contents of this variable is passed to &apt-get; as command line
      options when it is run for the update phase.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>PromptAfterUpdate</term>
+     <varlistentry><term><option>PromptAfterUpdate</option></term>
      <listitem><para>If true the [U]pdate operation in &dselect; will always prompt to continue. 
      The default is to prompt only on error.</para></listitem>
      </varlistentry>
@@ -566,20 +604,20 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
    in the <literal>DPkg</literal> section.</para>
 
    <variablelist>
-     <varlistentry><term>options</term>
+     <varlistentry><term><option>options</option></term>
      <listitem><para>This is a list of options to pass to dpkg. The options must be specified
      using the list notation and each list item is passed as a single argument
      to &dpkg;.</para></listitem>
      </varlistentry>
      
-     <varlistentry><term>Pre-Invoke</term><term>Post-Invoke</term>
+     <varlistentry><term><option>Pre-Invoke</option></term><term><option>Post-Invoke</option></term>
      <listitem><para>This is a list of shell commands to run before/after invoking &dpkg;. 
      Like <literal>options</literal> this must be specified in list notation. The 
      commands are invoked in order using <filename>/bin/sh</filename>, should any 
      fail APT will abort.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Pre-Install-Pkgs</term>
+     <varlistentry><term><option>Pre-Install-Pkgs</option></term>
      <listitem><para>This is a list of shell commands to run before invoking dpkg. Like
      <literal>options</literal> this must be specified in list notation. The commands
      are invoked in order using <filename>/bin/sh</filename>, should any fail APT 
@@ -593,12 +631,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      command given to <literal>Pre-Install-Pkgs</literal>.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Run-Directory</term>
+     <varlistentry><term><option>Run-Directory</option></term>
      <listitem><para>APT chdirs to this directory before invoking dpkg, the default is 
      <filename>/</filename>.</para></listitem>
      </varlistentry>
 
-     <varlistentry><term>Build-options</term>
+     <varlistentry><term><option>Build-options</option></term>
      <listitem><para>These options are passed to &dpkg-buildpackage; when compiling packages,
      the default is to disable signing and produce all binaries.</para></listitem>
      </varlistentry>
@@ -606,7 +644,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
 
    <refsect2><title>dpkg trigger usage (and related options)</title>
      <para>APT can call dpkg in a way so it can make aggressive use of triggers over
-     multiply calls of dpkg. Without further options dpkg will use triggers only in between his
+     multiple calls of dpkg. Without further options dpkg will use triggers only in between his
      own run. Activating these options can therefore decrease the time needed to perform the
      install / upgrade. Note that it is intended to activate these options per default in the
      future, but as it changes the way APT calling dpkg drastically it needs a lot more testing.
@@ -626,7 +664,7 @@ DPkg::ConfigurePending "true";
 DPkg::TriggersPending "true";</literallayout></para>
 
      <variablelist>
-       <varlistentry><term>DPkg::NoTriggers</term>
+       <varlistentry><term><option>DPkg::NoTriggers</option></term>
        <listitem><para>Add the no triggers flag to all dpkg calls (except the ConfigurePending call).
        See &dpkg; if you are interested in what this actually means. In short: dpkg will not run the
        triggers when this flag is present unless it is explicitly called to do so in an extra call.
@@ -634,7 +672,7 @@ DPkg::TriggersPending "true";</literallayout></para>
        meaning: Previously these option only append --no-triggers to the configure calls to dpkg -
        now apt will add these flag also to the unpack and remove calls.</para></listitem>
        </varlistentry>
-       <varlistentry><term>PackageManager::Configure</term>
+       <varlistentry><term><option>PackageManager::Configure</option></term>
        <listitem><para>Valid values are "<literal>all</literal>", "<literal>smart</literal>" and "<literal>no</literal>".
        "<literal>all</literal>" is the default value and causes APT to configure all packages explicit.
        The "<literal>smart</literal>" way is it to configure only packages which need to be configured before
@@ -645,20 +683,20 @@ DPkg::TriggersPending "true";</literallayout></para>
        default as otherwise the system could end in an unconfigured status which could be unbootable!
        </para></listitem>
        </varlistentry>
-       <varlistentry><term>DPkg::ConfigurePending</term>
+       <varlistentry><term><option>DPkg::ConfigurePending</option></term>
        <listitem><para>If this option is set apt will call <command>dpkg --configure --pending</command>
        to let dpkg handle all required configurations and triggers. This option is activated automatic
        per default if the previous option is not set to <literal>all</literal>, but deactivating could be useful
        if you want to run APT multiple times in a row - e.g. in an installer. In these sceneries you could
        deactivate this option in all but the last run.</para></listitem>
        </varlistentry>
-       <varlistentry><term>DPkg::TriggersPending</term>
+       <varlistentry><term><option>DPkg::TriggersPending</option></term>
        <listitem><para>Useful for <literal>smart</literal> configuration as a package which has pending
        triggers is not considered as <literal>installed</literal> and dpkg treats them as <literal>unpacked</literal>
        currently which is a dealbreaker for Pre-Dependencies (see debbugs #526774). Note that this will
        process all triggers, not only the triggers needed to configure this package.</para></listitem>
        </varlistentry>
-       <varlistentry><term>PackageManager::UnpackAll</term>
+       <varlistentry><term><option>PackageManager::UnpackAll</option></term>
        <listitem><para>As the configuration can be deferred to be done at the end by dpkg it can be
        tried to order the unpack series only by critical needs, e.g. by Pre-Depends. Default is true
        and therefore the "old" method of ordering in various steps by everything. While both method
@@ -666,7 +704,7 @@ DPkg::TriggersPending "true";</literallayout></para>
        this method is very experimental and needs further improvements before becoming really useful.
        </para></listitem>
        </varlistentry>
-       <varlistentry><term>OrderList::Score::Immediate</term>
+       <varlistentry><term><option>OrderList::Score::Immediate</option></term>
        <listitem><para>Essential packages (and there dependencies) should be configured immediately
        after unpacking. It will be a good idea to do this quite early in the upgrade process as these
        these configure calls require currently also <literal>DPkg::TriggersPending</literal> which
@@ -749,7 +787,7 @@ DPkg::TriggersPending "true";</literallayout></para>
 
    <variablelist>
      <varlistentry>
-       <term><literal>Debug::Acquire::cdrom</literal></term>
+       <term><option>Debug::Acquire::cdrom</option></term>
 
        <listitem>
         <para>
@@ -760,7 +798,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::Acquire::ftp</literal></term>
+       <term><option>Debug::Acquire::ftp</option></term>
 
        <listitem>
         <para>
@@ -771,7 +809,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::Acquire::http</literal></term>
+       <term><option>Debug::Acquire::http</option></term>
 
        <listitem>
         <para>
@@ -782,7 +820,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::Acquire::https</literal></term>
+       <term><option>Debug::Acquire::https</option></term>
 
        <listitem>
         <para>
@@ -793,7 +831,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::Acquire::gpgv</literal></term>
+       <term><option>Debug::Acquire::gpgv</option></term>
 
        <listitem>
         <para>
@@ -804,7 +842,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::aptcdrom</literal></term>
+       <term><option>Debug::aptcdrom</option></term>
 
        <listitem>
         <para>
@@ -815,7 +853,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::BuildDeps</literal></term>
+       <term><option>Debug::BuildDeps</option></term>
        <listitem>
         <para>
           Describes the process of resolving build-dependencies in
@@ -825,7 +863,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::Hashes</literal></term>
+       <term><option>Debug::Hashes</option></term>
        <listitem>
         <para>
           Output each cryptographic hash that is generated by the
@@ -835,7 +873,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::IdentCDROM</literal></term>
+       <term><option>Debug::IdentCDROM</option></term>
        <listitem>
         <para>
           Do not include information from <literal>statfs</literal>,
@@ -846,7 +884,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::NoLocking</literal></term>
+       <term><option>Debug::NoLocking</option></term>
        <listitem>
         <para>
           Disable all file locking.  For instance, this will allow
@@ -857,7 +895,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAcquire</literal></term>
+       <term><option>Debug::pkgAcquire</option></term>
 
        <listitem>
         <para>
@@ -868,7 +906,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAcquire::Auth</literal></term>
+       <term><option>Debug::pkgAcquire::Auth</option></term>
        <listitem>
         <para>
           Output status messages and errors related to verifying
@@ -878,7 +916,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAcquire::Diffs</literal></term>
+       <term><option>Debug::pkgAcquire::Diffs</option></term>
        <listitem>
         <para>
           Output information about downloading and applying package
@@ -889,7 +927,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAcquire::RRed</literal></term>
+       <term><option>Debug::pkgAcquire::RRed</option></term>
 
        <listitem>
         <para>
@@ -900,7 +938,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAcquire::Worker</literal></term>
+       <term><option>Debug::pkgAcquire::Worker</option></term>
 
        <listitem>
         <para>
@@ -911,7 +949,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgAutoRemove</literal></term>
+       <term><option>Debug::pkgAutoRemove</option></term>
 
        <listitem>
         <para>
@@ -922,7 +960,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgDepCache::AutoInstall</literal></term>
+       <term><option>Debug::pkgDepCache::AutoInstall</option></term>
        <listitem>
         <para>
           Generate debug messages describing which packages are being
@@ -936,7 +974,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgDepCache::Marker</literal></term>
+       <term><option>Debug::pkgDepCache::Marker</option></term>
        <listitem>
         <para>
            Generate debug messages describing which package is marked
@@ -958,7 +996,7 @@ DPkg::TriggersPending "true";</literallayout></para>
 
      <!-- Question: why doesn't this do anything?  The code says it should. -->
      <varlistentry>
-       <term><literal>Debug::pkgInitConfig</literal></term>
+       <term><option>Debug::pkgInitConfig</option></term>
        <listitem>
         <para>
           Dump the default configuration to standard error on
@@ -968,7 +1006,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgDPkgPM</literal></term>
+       <term><option>Debug::pkgDPkgPM</option></term>
        <listitem>
         <para>
           When invoking &dpkg;, output the precise command line with
@@ -979,7 +1017,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgDPkgProgressReporting</literal></term>
+       <term><option>Debug::pkgDPkgProgressReporting</option></term>
        <listitem>
         <para>
           Output all the data received from &dpkg; on the status file
@@ -989,7 +1027,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgOrderList</literal></term>
+       <term><option>Debug::pkgOrderList</option></term>
 
        <listitem>
         <para>
@@ -1001,7 +1039,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgPackageManager</literal></term>
+       <term><option>Debug::pkgPackageManager</option></term>
 
        <listitem>
         <para>
@@ -1012,7 +1050,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgPolicy</literal></term>
+       <term><option>Debug::pkgPolicy</option></term>
 
        <listitem>
         <para>
@@ -1022,7 +1060,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgProblemResolver</literal></term>
+       <term><option>Debug::pkgProblemResolver</option></term>
 
        <listitem>
         <para>
@@ -1034,7 +1072,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::pkgProblemResolver::ShowScores</literal></term>
+       <term><option>Debug::pkgProblemResolver::ShowScores</option></term>
        <listitem>
         <para>
           Display a list of all installed packages with their calculated score
@@ -1045,7 +1083,7 @@ DPkg::TriggersPending "true";</literallayout></para>
      </varlistentry>
 
      <varlistentry>
-       <term><literal>Debug::sourceList</literal></term>
+       <term><option>Debug::sourceList</option></term>
 
        <listitem>
         <para>