X-Git-Url: https://git.saurik.com/apt.git/blobdiff_plain/81cf16a26fa162ac672b084a88148b822e645665..cb7fce24492ff6e0b7df0f33e2ac47970b4281dd:/doc/apt-config.8.xml diff --git a/doc/apt-config.8.xml b/doc/apt-config.8.xml index a7164b4e7..cf2e87c62 100644 --- a/doc/apt-config.8.xml +++ b/doc/apt-config.8.xml @@ -1,13 +1,9 @@ <?xml version="1.0" encoding="utf-8" standalone="no"?> <!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; - -<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> -%aptverbatiment; - +<!ENTITY % aptent SYSTEM "apt.ent"> %aptent; +<!ENTITY % aptverbatiment SYSTEM "apt-verbatim.ent"> %aptverbatiment; +<!ENTITY % aptvendor SYSTEM "apt-vendor.ent"> %aptvendor; ]> <refentry> @@ -18,7 +14,7 @@ &apt-email; &apt-product; <!-- The last update date --> - <date>2012-05-11T00:00:00Z</date> + <date>2013-11-30T00:00:00Z</date> </refentryinfo> <refmeta> @@ -39,7 +35,7 @@ <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. @@ -48,11 +44,11 @@ <variablelist> <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> @@ -93,11 +89,11 @@ eval $RES <varlistentry> <term><option>--format '<replaceable>%f "%v";%n</replaceable>'</option></term> - <listitem><para>Defines the output of each config option. %t will be replaced with the name of the option, - %f with the complete optionname and %v with the value of the option. + <listitem><para>Defines the output of each config option. %t will be replaced with its individual name, + %f with its full hierarchical name and %v with its value. Use uppercase letters and special characters in the value will be encoded to ensure that - it can e.g. be savely used in a quoted-string as defined by RFC822. Additionally - %n will be replaced by a newline, %N by a tab. A % can be + it can e.g. be safely used in a quoted-string as defined by RFC822. Additionally + %n will be replaced by a newline, and %N by a tab. A % can be printed by using %%.</para></listitem> </varlistentry>