diff options
author | Patrick McHardy <kaber@trash.net> | 2008-06-02 12:48:48 +0200 |
---|---|---|
committer | Patrick McHardy <kaber@trash.net> | 2008-06-02 12:48:48 +0200 |
commit | 510aef98a56cdbfdb147f78b05d7554bb91770a9 (patch) | |
tree | e7a4c3413d83c2cb70bb457115001599e819066a /extensions/libxt_policy.man | |
parent | 8e1a12fba4008933ce9e89f98c12593e0d39ede3 (diff) |
manpages: consistent syntax
In the manpages, bold is used to denote characters the user has to
enter verbatim, italic denotes placeholders and non-highlighted
pieces are used as a structure: "[]" specifying an optional part,
"{}" a mandatory part, with "|" used for alternations. The "!" for
negation is better supported before the option than after it, too.
The patch makes a few files consistent with this style already used
in manpages.
Diffstat (limited to 'extensions/libxt_policy.man')
-rw-r--r-- | extensions/libxt_policy.man | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/extensions/libxt_policy.man b/extensions/libxt_policy.man index eed163e1..0c162736 100644 --- a/extensions/libxt_policy.man +++ b/extensions/libxt_policy.man @@ -1,6 +1,6 @@ This modules matches the policy used by IPsec for handling a packet. .TP -.BI "--dir " "in|out" +\fB--dir\fP {\fBin\fP|\fBout\fP} Used to select whether to match the policy used for decapsulation or the policy that will be used for encapsulation. .B in @@ -12,7 +12,7 @@ is valid in the .B POSTROUTING, OUTPUT and FORWARD chains. .TP -.BI "--pol " "none|ipsec" +\fB--pol\fP {\fBnone\fP|\fBipsec\fP} Matches if the packet is subject to IPsec processing. .TP .BI "--strict" @@ -29,20 +29,20 @@ as level. .BI "--spi " "spi" Matches the SPI of the SA. .TP -.BI "--proto " "ah|esp|ipcomp" +\fB--proto\fP {\fBah\fP|\fBesp\fP|\fBipcomp\fP} Matches the encapsulation protocol. .TP -.BI "--mode " "tunnel|transport" +\fB--mode\fP {\fBtunnel\fP|\fBtransport\fP} Matches the encapsulation mode. .TP -.BI "--tunnel-src " "addr[/mask]" +\fB--tunnel-src\fP \fIaddr\fP[\fB/\fP\fImask\fP] Matches the source end-point address of a tunnel mode SA. -Only valid with --mode tunnel. +Only valid with \fB--mode tunnel\fP. .TP -.BI "--tunnel-dst " "addr[/mask]" +\fB--tunnel-dst\fP \fIaddr\fP[\fB/\fP\fImask\fP] Matches the destination end-point address of a tunnel mode SA. -Only valid with --mode tunnel. +Only valid with \fB--mode tunnel\fP. .TP .BI "--next" Start the next element in the policy specification. Can only be used with ---strict +\fB--strict\fP. |