summaryrefslogtreecommitdiffstats
path: root/doc/stateful-objects.txt
diff options
context:
space:
mode:
authorPhil Sutter <phil@nwl.cc>2019-05-07 15:23:50 +0200
committerFlorian Westphal <fw@strlen.de>2019-05-08 16:32:01 +0200
commit590ba3efda281f3df125ede59fa547b30b97a643 (patch)
treeaacd0c65efab413ac4a0212e3d7cf0ecc2ba1d05 /doc/stateful-objects.txt
parent611a54199b72a0b02c9abc120b9488a4873dffeb (diff)
doc: Review man page synopses
Fix use of font typefaces: - *bold* for terminals - 'italic' for non-terminals - plain for meta-characters Apart from that: * Variable definitions require an equals sign * 'auto-merge' option in set spec does not take a parameter * List header fields in payload expressions instead of unexplained placeholder * Introduce non-terminals in some places to avoid repetitions or clarify syntax * Fix syntax for ip6 header expresssion example * Reorganize ct expression synopsis into four parts: 1) direction not allowed 2) direction optional 3) direction mandatory 4) direction and family mandatory * Add missing 'version' keyword to osf expression * Clarify verdict statements example topic * Add synopses for payload and exthdr statements * Fix typo: differv -> diffserv * Reorganize reject statement synopsis to point out which code type is required for which type arg * Counter statement requires either one of 'packets' or 'bytes' args or both, none is an invalid variant * Limit statement accepts a unit in burst, too * Improve language in limit statement description a bit Signed-off-by: Phil Sutter <phil@nwl.cc> Signed-off-by: Florian Westphal <fw@strlen.de>
Diffstat (limited to 'doc/stateful-objects.txt')
-rw-r--r--doc/stateful-objects.txt8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt
index 6de4e8bd..cc1b698d 100644
--- a/doc/stateful-objects.txt
+++ b/doc/stateful-objects.txt
@@ -1,7 +1,7 @@
CT HELPER
~~~~~~~~~
[verse]
-*ct* helper 'helper' {type 'type' protocol 'protocol' ; [l3proto 'family' ;] }
+*ct helper* 'helper' *{ type* 'type' *protocol* 'protocol' *;* [*l3proto* 'family' *;*] *}*
Ct helper is used to define connection tracking helpers that can then be used in
combination with the *ct helper set* statement. 'type' and 'protocol' are
@@ -43,7 +43,7 @@ table inet myhelpers {
CT TIMEOUT
~~~~~~~~~~
[verse]
-*ct* timeout 'name' {protocol 'protocol' ; policy = {'state': 'value'} ;[l3proto 'family' ;] }
+*ct timeout* 'name' *{ protocol* 'protocol' *; policy = {* 'state'*:* 'value' [*,* ...] *} ;* [*l3proto* 'family' *;*] *}*
Ct timeout is used to update connection tracking timeout values.Timeout policies are assigned
with the *ct timeout set* statement. 'protocol' and 'policy' are
@@ -98,7 +98,7 @@ sport=41360 dport=22
COUNTER
~~~~~~~
[verse]
-*counter* [packets bytes]
+*counter* ['packets bytes']
.Counter specifications
[options="header"]
@@ -115,7 +115,7 @@ unsigned integer (64 bit)
QUOTA
~~~~~
[verse]
-*quota* [over | until] [used]
+*quota* [*over* | *until*] ['used']
.Quota specifications
[options="header"]