add config setting for User-Agent in http and https to the Acquire group,

[apt.git] / doc / apt.conf.5.xml

diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml
index 6ee7199877bdab410586d00752edd2f6fc5e36b8..726bca2cc0f75ff16f148a82f70fcce9946d4e0e 100644 (file)
--- a/doc/apt.conf.5.xml
+++ b/doc/apt.conf.5.xml
@@ -48,9 +48,9 @@
    loading even more config files.</para>
 
    <para>The configuration file is organized in a tree with options organized into
-   functional groups. option specification is given with a double colon
+   functional groups. Option specification is given with a double colon
    notation, for instance <literal>APT::Get::Assume-Yes</literal> is an option within 
-   the APT tool group, for the Get tool. options do not inherit from their 
+   the APT tool group, for the Get tool. Options do not inherit from their 
    parent groups.</para> 
 
    <para>Syntactically the configuration language is modeled after what the ISC tools
@@ -58,7 +58,7 @@
    <literal>//</literal> are treated as comments (ignored), as well as all text
    between <literal>/*</literal> and <literal>*/</literal>, just like C/C++ comments.
    Each line is of the form
-   <literal>APT::Get::Assume-Yes "true";</literal> The trailing 
+   <literal>APT::Get::Assume-Yes "true";</literal>. The trailing 
    semicolon and the quotes are required. The value must be on one line, and
    there is no kind of string concatenation. It must not include inside quotes.
    The behavior of the backslash "\" and escaped characters inside a value is
@@ -265,7 +265,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      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)
+     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
@@ -275,7 +275,12 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";};
      <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
      the limit and tries uses as much as possible of the bandwidth (Note that this option implicit
-     deactivates the download from multiple servers at the same time.)</para></listitem>
+     deactivates the download from multiple servers at the same time.)</para>
+
+     <para><literal>Acquire::http::User-Agent</literal> can be used to set a different
+     User-Agent for the http download method as some proxies allow access for clients
+     only if the client uses a known identifier.</para>
+     </listitem>
      </varlistentry>
 
      <varlistentry><term>https</term>
@@ -536,9 +541,9 @@ DPkg::TriggersPending "true";</literallayout></para>
 
      <variablelist>
        <varlistentry><term>DPkg::NoTriggers</term>
-       <listitem><para>Add the no triggers flag to all dpkg calls (expect the ConfigurePending call).
+       <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 then this flag is present unless it is explicit called to do so in an extra call.
+       triggers when this flag is present unless it is explicitly called to do so in an extra call.
        Note that this option exists (undocumented) also in older apt versions with a slightly different
        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>
@@ -549,8 +554,8 @@ DPkg::TriggersPending "true";</literallayout></para>
        The "<literal>smart</literal>" way is it to configure only packages which need to be configured before
        another package can be unpacked (Pre-Depends) and let the rest configure by dpkg with a call generated
        by the next option. "<literal>no</literal>" on the other hand will not configure anything and totally
-       relay on dpkg for configuration (which will at the moment fail if a Pre-Depends is encountered).
-       Setting this option to another than the all value will implicit activate also the next option per
+       rely on dpkg for configuration (which will at the moment fail if a Pre-Depends is encountered).
+       Setting this option to another than the all value will implicitly activate also the next option per
        default as otherwise the system could end in an unconfigured status which could be unbootable!
        </para></listitem>
        </varlistentry>
@@ -558,7 +563,7 @@ DPkg::TriggersPending "true";</literallayout></para>
        <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 this sceneries you could
+       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>