summaryrefslogtreecommitdiff
path: root/doc/apt-config.8.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/apt-config.8.xml')
-rw-r--r--doc/apt-config.8.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/apt-config.8.xml b/doc/apt-config.8.xml
index 94aeec059..0295cb193 100644
--- a/doc/apt-config.8.xml
+++ b/doc/apt-config.8.xml
@@ -93,9 +93,10 @@ 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
+ <listitem><para>Defines the output of each config option. &percnt;t will be replaced with the name of the option,
+ &percnt;f with the complete optionname and &percnt;v with the value of the option.
+ 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
&percnt;n will be replaced by a newline, &percnt;N by a tab. A &percnt; can be
printed by using &percnt;&percnt;.</para></listitem>
</varlistentry>