summaryrefslogtreecommitdiffstats
path: root/extensions/libxt_rateest.man
diff options
context:
space:
mode:
authorJan Engelhardt <jengelh@medozas.de>2009-01-12 04:53:18 +0100
committerPatrick McHardy <kaber@trash.net>2009-01-12 04:53:18 +0100
commitfea74bf74ff524431ce65145f1523584edf99dc9 (patch)
treee0ddfbeca93e159dcb0cc7c77df34206fbea26f9 /extensions/libxt_rateest.man
parent0c2b5a4aff8ee61529aca8541f7fdae18500470f (diff)
doc: escape minus sign in manpages
groff formats '-' as a hyphen, and '\-' is needed for a minus. Signed-off-by: Jan Engelhardt <jengelh@medozas.de> Signed-off-by: Patrick McHardy <kaber@trash.net>
Diffstat (limited to 'extensions/libxt_rateest.man')
-rw-r--r--extensions/libxt_rateest.man42
1 files changed, 21 insertions, 21 deletions
diff --git a/extensions/libxt_rateest.man b/extensions/libxt_rateest.man
index 6d32d51d..24c0673b 100644
--- a/extensions/libxt_rateest.man
+++ b/extensions/libxt_rateest.man
@@ -2,32 +2,32 @@ The rate estimator can match on estimated rates as collected by the RATEEST
target. It supports matching on absolute bps/pps values, comparing two rate
estimators and matching on the difference between two rate estimators.
.TP
-\fB--rateest1\fP \fIname\fP
+\fB\-\-rateest1\fP \fIname\fP
Name of the first rate estimator.
.TP
-\fB--rateest2\fP \fIname\fP
+\fB\-\-rateest2\fP \fIname\fP
Name of the second rate estimator (if difference is to be calculated).
.TP
-\fB--rateest-delta\fP
+\fB\-\-rateest\-delta\fP
Compare difference(s) to given rate(s)
.TP
-\fB--rateest1-bps\fP \fIvalue\fP
+\fB\-\-rateest1\-bps\fP \fIvalue\fP
.TP
-\fB--rateest2-bps\fP \fIvalue\fP
+\fB\-\-rateest2\-bps\fP \fIvalue\fP
Compare bytes per second.
.TP
-\fB--rateest1-pps\fP \fIvalue\fP
+\fB\-\-rateest1\-pps\fP \fIvalue\fP
.TP
-\fB--rateest2-pps\fP \fIvalue\fP
+\fB\-\-rateest2\-pps\fP \fIvalue\fP
Compare packets per second.
.TP
-[\fB!\fP] \fB--rateest-lt\fP
+[\fB!\fP] \fB\-\-rateest\-lt\fP
Match if rate is less than given rate/estimator.
.TP
-[\fB!\fP] \fB--rateest-gt\fP
+[\fB!\fP] \fB\-\-rateest\-gt\fP
Match if rate is greater than given rate/estimator.
.TP
-[\fB!\fP] \fB--rateest-eq\fP
+[\fB!\fP] \fB\-\-rateest\-eq\fP
Match if rate is equal to given rate/estimator.
.PP
Example: This is what can be used to route outgoing data connections from an
@@ -36,20 +36,20 @@ connection was started:
.PP
# Estimate outgoing rates
.PP
-iptables -t mangle -A POSTROUTING -o eth0 -j RATEEST --rateest-name eth0
---rateest-interval 250ms --rateest-ewma 0.5s
+iptables \-t mangle \-A POSTROUTING \-o eth0 \-j RATEEST \-\-rateest\-name eth0
+\-\-rateest\-interval 250ms \-\-rateest\-ewma 0.5s
.PP
-iptables -t mangle -A POSTROUTING -o ppp0 -j RATEEST --rateest-name ppp0
---rateest-interval 250ms --rateest-ewma 0.5s
+iptables \-t mangle \-A POSTROUTING \-o ppp0 \-j RATEEST \-\-rateest\-name ppp0
+\-\-rateest\-interval 250ms \-\-rateest\-ewma 0.5s
.PP
# Mark based on available bandwidth
.PP
-iptables -t mangle -A balance -m conntrack --ctstate NEW -m helper --helper ftp
--m rateest --rateest-delta --rateest1 eth0 --rateest-bps1 2.5mbit --rateest-gt
---rateest2 ppp0 --rateest-bps2 2mbit -j CONNMARK --set-mark 1
+iptables \-t mangle \-A balance \-m conntrack \-\-ctstate NEW \-m helper \-\-helper ftp
+\-m rateest \-\-rateest\-delta \-\-rateest1 eth0 \-\-rateest\-bps1 2.5mbit \-\-rateest\-gt
+\-\-rateest2 ppp0 \-\-rateest\-bps2 2mbit \-j CONNMARK \-\-set\-mark 1
.PP
-iptables -t mangle -A balance -m conntrack --ctstate NEW -m helper --helper ftp
--m rateest --rateest-delta --rateest1 ppp0 --rateest-bps1 2mbit --rateest-gt
---rateest2 eth0 --rateest-bps2 2.5mbit -j CONNMARK --set-mark 2
+iptables \-t mangle \-A balance \-m conntrack \-\-ctstate NEW \-m helper \-\-helper ftp
+\-m rateest \-\-rateest\-delta \-\-rateest1 ppp0 \-\-rateest\-bps1 2mbit \-\-rateest\-gt
+\-\-rateest2 eth0 \-\-rateest\-bps2 2.5mbit \-j CONNMARK \-\-set\-mark 2
.PP
-iptables -t mangle -A balance -j CONNMARK --restore-mark
+iptables \-t mangle \-A balance \-j CONNMARK \-\-restore\-mark