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/libip6t_ipv6header.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/libip6t_ipv6header.man')
-rw-r--r-- | extensions/libip6t_ipv6header.man | 58 |
1 files changed, 33 insertions, 25 deletions
diff --git a/extensions/libip6t_ipv6header.man b/extensions/libip6t_ipv6header.man index fe3fe98d..23478b4c 100644 --- a/extensions/libip6t_ipv6header.man +++ b/extensions/libip6t_ipv6header.man @@ -1,29 +1,37 @@ This module matches IPv6 extension headers and/or upper layer header. .TP -.BR "--header " "[!] \fIheader\fP[,\fIheader\fP...]" +\fB--soft\fP +Matches if the packet includes \fBany\fP of the headers specified with +\fB--header\fP. +.TP +[\fB!\fP] \fB--header\fP \fIheader\fP[\fB,\fP\fIheader\fP...] Matches the packet which EXACTLY includes all specified headers. The headers encapsulated with ESP header are out of scope. -.IR header -can be -.IR hop | hop-by-hop -(Hop-by-Hop Options header), -.IR dst -(Destination Options header), -.IR route -(Routing header), -.IR frag -(Fragment header), -.IR auth -(Authentication header), -.IR esp -(Encapsulating Security Payload header), -.IR none -(No Next header) which matches 59 in the 'Next Header field' of IPv6 header or any IPv6 extension headers, or -.IR proto -which matches any upper layer protocol header. A protocol name from /etc/protocols and numeric value also allowed. The number 255 is equivalent to -.IR proto . -.TP -.BR "[--soft]" -Matches if the packet includes all specified headers with -.BR --header , -AT LEAST. +Possible \fIheader\fP types can be: +.TP +\fBhop\fP|\fBhop-by-hop\fP +Hop-by-Hop Options header +.TP +\fBdst\fP +Destination Options header +.TP +\fBroute\fP +Routing header +.TP +\fBfrag\fP +Fragment header +.TP +\fBauth\fP +Authentication header +.TP +\fBesp\fP +Encapsulating Security Payload header +.TP +\fBnone\fP +No Next header which matches 59 in the 'Next Header field' of IPv6 header or +any IPv6 extension headers +.TP +\fBproto\fP +which matches any upper layer protocol header. A protocol name from +/etc/protocols and numeric value also allowed. The number 255 is equivalent to +\fBproto\fP. |