ipset/doc: escape dashes in manpage

(Hyphens remain unescaped.)

Signed-off-by: Jan Engelhardt <jengelh@medozas.de>
This commit is contained in:
Jan Engelhardt
2009-11-11 13:31:20 +01:00
parent 24bb655130
commit a4afc4159e

View File

@@ -18,7 +18,7 @@
.\" .\"
.\" .\"
.SH NAME .SH NAME
ipset \- administration tool for IP sets ipset \(em administration tool for IP sets
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBipset \-N\fP \fIset\fP \fItype-specification\fP [\fIoptions\fP...] \fBipset \-N\fP \fIset\fP \fItype-specification\fP [\fIoptions\fP...]
@@ -87,10 +87,10 @@ type supports the operation).
.TP .TP
\fB\-S\fP, \fB\-\-save\fP [\fIsetname\fP] \fB\-S\fP, \fB\-\-save\fP [\fIsetname\fP]
Save the given set, or all sets if none is given Save the given set, or all sets if none is given
to stdout in a format that --restore can read. to stdout in a format that \fB\-\-restore\fP can read.
.TP .TP
\fB\-R\fP, \fB\-\-restore\fP \fB\-R\fP, \fB\-\-restore\fP
Restore a saved session generated by --save. The saved session Restore a saved session generated by \fB\-\-save\fP. The saved session
can be fed from stdin. can be fed from stdin.
When generating a session file please note that the supported commands When generating a session file please note that the supported commands
@@ -145,7 +145,7 @@ The ipmap set type uses a memory range, where each bit represents
one IP address. An ipmap set can store up to 65536 (B-class network) one IP address. An ipmap set can store up to 65536 (B-class network)
IP addresses. The ipmap set type is very fast and memory cheap, great IP addresses. The ipmap set type is very fast and memory cheap, great
for use when one want to match certain IPs in a range. If the optional for use when one want to match certain IPs in a range. If the optional
.B "--netmask" \fB\-\-netmask\fP
parameter is specified with a CIDR netmask value between 1-31 then parameter is specified with a CIDR netmask value between 1-31 then
network addresses are stored in the given set: i.e an network addresses are stored in the given set: i.e an
IP address will be in the set if the network address, which is resulted IP address will be in the set if the network address, which is resulted
@@ -163,7 +163,7 @@ Create an ipmap set from the specified network.
.TP .TP
\fB\-\-netmask\fP \fIcidr-netmask\fP \fB\-\-netmask\fP \fIcidr-netmask\fP
When the optional When the optional
.B "--netmask" \fB\-\-netmask\fP
parameter specified, network addresses will be parameter specified, network addresses will be
stored in the set instead of IP addresses, and the \fIfrom-ip\fP parameter stored in the set instead of IP addresses, and the \fIfrom-ip\fP parameter
must be a network address. The \fIcidr-netmask\fP value must be between 1-31. must be a network address. The \fIcidr-netmask\fP value must be between 1-31.
@@ -191,9 +191,9 @@ Create a macipmap set from the specified range.
\fB\-\-network\fP \fIip\fP\fB/\fP\fImask\fP \fB\-\-network\fP \fIip\fP\fB/\fP\fImask\fP
Create a macipmap set from the specified network. Create a macipmap set from the specified network.
.TP .TP
.BR "--matchunset" \fB\-\-matchunset\fP
When the optional When the optional
.B "--matchunset" \fB\-\-matchunset\fP
parameter specified, IP addresses which could be stored parameter specified, IP addresses which could be stored
in the set but not set yet, will always match. in the set but not set yet, will always match.
.P .P
@@ -222,7 +222,7 @@ The iphash set type uses a hash to store IP addresses.
In order to avoid clashes in the hash double-hashing, and as a last In order to avoid clashes in the hash double-hashing, and as a last
resort, dynamic growing of the hash performed. The iphash set type is resort, dynamic growing of the hash performed. The iphash set type is
great to store random addresses. If the optional great to store random addresses. If the optional
.B "--netmask" \fB\-\-netmask\fP
parameter is specified with a CIDR netmask value between 1-31 then parameter is specified with a CIDR netmask value between 1-31 then
network addresses are stored in the given set: i.e an network addresses are stored in the given set: i.e an
IP address will be in the set if the network address, which is resulted IP address will be in the set if the network address, which is resulted
@@ -245,7 +245,7 @@ number of double-hashing.
.TP .TP
\fB\-\-netmask\fP \fIcidr-netmask\fP \fB\-\-netmask\fP \fIcidr-netmask\fP
When the optional When the optional
.B "--netmask" \fB\-\-netmask\fP
parameter specified, network addresses will be parameter specified, network addresses will be
stored in the set instead of IP addresses. The \fIcidr-netmask\fP value must stored in the set instead of IP addresses. The \fIcidr-netmask\fP value must
be between 1-31. be between 1-31.
@@ -437,7 +437,7 @@ Options to use when creating an iptree set:
The timeout value for the entries in seconds (default 0) The timeout value for the entries in seconds (default 0)
.P .P
If a set was created with a nonzero valued If a set was created with a nonzero valued
.B "--timeout" \fB\-\-timeout\fP
parameter then one may add IP addresses to the set with a specific parameter then one may add IP addresses to the set with a specific
timeout value using the syntax timeout value using the syntax
"\fIip\fP\fB,\fP\fItimeout-value\fP". "\fIip\fP\fB,\fP\fItimeout-value\fP".