add a vendor specific file to have configurable entities

[apt.git] / doc / apt-config.8.xml

diff --git a/doc/apt-config.8.xml b/doc/apt-config.8.xml
index 94aeec0591c6b2108c07c49451d15f87daa7d39e..b84d25f7aa2e02b57d50309c50563100af182040 100644 (file)
--- a/doc/apt-config.8.xml
+++ b/doc/apt-config.8.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
-  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
 <!ENTITY % aptent SYSTEM "apt.ent">
 %aptent;
@@ -8,6 +8,8 @@
 <!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent">
 %aptverbatiment;
 
+<!ENTITY % aptvendor SYSTEM "apt-vendor.ent">
+%aptvendor;
 ]>
 
 <refentry>
@@ -18,7 +20,7 @@
    &apt-email;
    &apt-product;
    <!-- The last update date -->
-   <date>29 February 2004</date>
+   <date>2012-06-09T00:00:00Z</date>
  </refentryinfo>
  
  <refmeta>
@@ -39,20 +41,20 @@
    <para><command>apt-config</command> is an internal program used by various
    portions of the APT suite to provide consistent configurability. It accesses
    the main configuration file <filename>/etc/apt/apt.conf</filename> in a
-   manner that is easy to use by scripted applications.</para>
+   manner that is easy to use for scripted applications.</para>
 
    <para>Unless the <option>-h</option>, or <option>--help</option> option is
-   given one of the commands below must be present.
+   given, one of the commands below must be present.
    </para>
    
    <variablelist>
-     <varlistentry><term>shell</term>
+     <varlistentry><term><option>shell</option></term>
      <listitem><para>
-     shell is used to access the configuration information from a shell 
-     script. It is given pairs of arguments, the first being a shell 
-     variable and the second the configuration value to query. As output 
-     it lists a series of shell assignments commands for each present value. 
-     In a shell script it should be used like:
+     shell is used to access the configuration information from a shell
+     script. It is given pairs of arguments, the first being a shell
+     variable and the second the configuration value to query. As output
+     it lists shell assignment commands for each value present.
+     In a shell script it should be used as follows:
      </para>
      
 <informalexample><programlisting>
@@ -72,7 +74,7 @@ eval $RES
      </listitem>
      </varlistentry>
 
-     <varlistentry><term>dump</term>
+     <varlistentry><term><option>dump</option></term>
      <listitem><para>
      Just show the contents of the configuration space.</para>
      </listitem>
@@ -93,10 +95,11 @@ eval $RES
 
      <varlistentry>
       <term><option>--format '<replaceable>&percnt;f &#x0022;&percnt;v&#x0022;;&percnt;n</replaceable>'</option></term>
-      <listitem><para>Defines the output of each config option. &percnt;t will be replaced with the tagname,
-                     &percnt;f with the complete tagname and &percnt;v with the value of the option.
-                     Use uppercase letters and the respective values will be quoted. Additionally
-                     &percnt;n will be replaced by a newline, &percnt;N by a tab. A &percnt; can be
+      <listitem><para>Defines the output of each config option. &percnt;t will be replaced with its individual name,
+                     &percnt;f with its full hierarchical name and &percnt;v with its value.
+                     Use uppercase letters and special characters in the value will be encoded to ensure that
+                     it can e.g. be safely used in a quoted-string as defined by RFC822. Additionally
+                     &percnt;n will be replaced by a newline, and &percnt;N by a tab. A &percnt; can be
                      printed by using &percnt;&percnt;.</para></listitem>
      </varlistentry>