summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArushi Singhal <arushisinghal19971997@gmail.com>2018-07-31 19:04:33 +0530
committerPablo Neira Ayuso <pablo@netfilter.org>2018-08-03 17:58:04 +0200
commitcdb5655ee44da4113d1ee72fbd6afa6ca4ffaa14 (patch)
tree26d3de71f4bc9e040b51706435359e05b33b01ee
parent9ea0401e385e1dd3f1579a4e772aa876a5e21288 (diff)
doc: correct some typos in asciidoc
Correct some typo mistakes done while converting man page source to asciidoc. Signed-off-by: Arushi Singhal <arushisinghal19971997@gmail.com> Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
-rw-r--r--doc/data-types.txt30
-rw-r--r--doc/nft.txt17
-rw-r--r--doc/payload-expression.txt11
-rw-r--r--doc/primary-expression.txt4
-rw-r--r--doc/stateful-objects.txt2
-rw-r--r--doc/statements.txt4
6 files changed, 29 insertions, 39 deletions
diff --git a/doc/data-types.txt b/doc/data-types.txt
index 57aa3a40..2c6108fb 100644
--- a/doc/data-types.txt
+++ b/doc/data-types.txt
@@ -136,30 +136,18 @@ The boolean type is a syntactical helper type in user space. It's use is in the
right-hand side of a (typically implicit) relational expression to change the
expression on the left-hand side into a boolean check (usually for existence). +
-The following keywords will automatically resolve into a boolean type with given value:
-The bitmask type (bitmask) is used for bitmasks.
+.The following keywords will automatically resolve into a boolean type with given value
[options="header"]
|==================
|Keyword | Value
-|exits |
+|exists |
1 |
missing |
0
|===================
-[options="header"]
-|======================================
-|Expression | Behaviour
-|fib |
-Check route existence.
-|exthdr|
-Check IPv6 extension header existence.
-|tcp option |
-Check TCP option header existence.
-|===================
-
-.expressions support a boolean comparison:
+.expressions support a boolean comparison
[options="header"]
|======================================
|Expression | Behaviour
@@ -242,15 +230,15 @@ ICMP CODE TYPE
[options="header"]
|==================
|Name | Keyword | Size | Base type
-|ICMP Type |
-icmp_type |
+|ICMP Code |
+icmp_code |
8 bit |
integer
|===================
The ICMP Code type is used to conveniently specify the ICMP header's code field.
-.Keywords may be used when specifying the ICMP type
+.Keywords may be used when specifying the ICMP code
[options="header"]
|==================
|Keyword | Value
@@ -339,7 +327,7 @@ ICMPV6 CODE TYPE
|==================
|Name | Keyword | Size | Base type
|ICMPv6 Code |
-icmpv6_type |
+icmpv6_code |
8 bit |
integer
|===================
@@ -412,7 +400,7 @@ ct_status|
4 byte|
bitmask
|conntrack event bits|
-ct_events |
+ct_event |
4 byte |
bitmask
|conntrack label|
@@ -456,7 +444,7 @@ For each of the types above, keywords are available for convenience:
|expected|
1
|seen-reply|
-1
+2
|assured|
4
|confirmed|
diff --git a/doc/nft.txt b/doc/nft.txt
index d33d01cc..d1eaf3bd 100644
--- a/doc/nft.txt
+++ b/doc/nft.txt
@@ -218,7 +218,7 @@ RULESET
-------
[verse]
{list | flush} *ruleset* ['family']
-\{export\} [*ruleset*] {'format'}
+export [*ruleset*] 'format'
The *ruleset* keyword is used to identify the whole set of tables, chains, etc.
currently in place in kernel. The following *ruleset* commands exist:
@@ -373,18 +373,15 @@ rule index might change if a rule was inserted or deleted before the referred
one. If the referred rule was deleted, the command is rejected by the kernel
just as if an invalid 'handle' was given.
-*add*::
-Add a new rule described by the list of statements. The rule is appended to the
-given chain unless a position is specified, in which case the rule is appended
-to the rule given by the 'handle'. The alternative name position is deprecated
-and should not be used anymore.
-
+[horizontal]
+*add*:: Add a new rule described by the list of statements. The
+rule is appended to the given chain unless a position is specified, in which
+case the rule is appended to the rule given by the 'handle'. The alternative
+name position is deprecated and should not be used anymore.
*insert*:: Similar to the *add* command, but the rule is prepended to the
-beginning of the chain or before the rule at the given position.
-
+beginning of the chain or before the rule with the given 'handle'.
*replace*:: Similar to the add command, but the rule replaces the specified
rule.
-
*delete*:: Delete the specified rule.
.*add a rule to ip table input chain*
diff --git a/doc/payload-expression.txt b/doc/payload-expression.txt
index 3f47b4ec..0aae8ebf 100644
--- a/doc/payload-expression.txt
+++ b/doc/payload-expression.txt
@@ -41,7 +41,12 @@ EtherType|
ether_type
|==================
-.ARP HEADER EXPRESSION
+ARP HEADER EXPRESSION
+~~~~~~~~~~~~~~~~~~~~~
+[verse]
+*arp* ['ARP' 'header' 'field']
+
+.ARP header expression
[options="header"]
|==================
|Keyword| Description| Type
@@ -424,7 +429,7 @@ to match protocol fields of a transport header with protocol number 5, you need
to manually exclude packets that have a different transport header, for instance
my using meta l4proto 5 before the raw expression.
-.Support payload protocol bases
+.Supported payload protocol bases
[options="header"]
|==================
|Base| Description
@@ -603,6 +608,6 @@ average bytes per packet, see description for packets keyword |
integer (64 bit)
|zone|
conntrack zone |
-integer (64 bit)
+integer (16 bit)
|==========================================
A description of conntrack-specific types listed above can be found sub-section CONNTRACK TYPES above.
diff --git a/doc/primary-expression.txt b/doc/primary-expression.txt
index 88ea7edf..63493049 100644
--- a/doc/primary-expression.txt
+++ b/doc/primary-expression.txt
@@ -27,7 +27,7 @@ real hook protocol family, useful only in inet table|
integer (32 bit)
|l4proto|
layer 4 protocol, skips ipv6 extension headers|
-integer (32 bit)
+integer (8 bit)
|protocol|
EtherType protocol value|
ether_type
@@ -45,7 +45,7 @@ Input interface name |
ifname
|iiftype|
Input interface type|
-iface_itype
+iface_type
|oif|
Output interface index|
iface_index
diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt
index 57bf6272..c2bc2968 100644
--- a/doc/stateful-objects.txt
+++ b/doc/stateful-objects.txt
@@ -18,7 +18,7 @@ name of helper type |
quoted string (e.g. "ftp")
|protocol |
layer 4 protocol of the helper |
-address family (e.g. ip)
+string (e.g. ip)
|l3proto |
layer 3 protocol of the helper |
address family (e.g. ip)
diff --git a/doc/statements.txt b/doc/statements.txt
index 38d9982f..a0053e09 100644
--- a/doc/statements.txt
+++ b/doc/statements.txt
@@ -96,7 +96,7 @@ Number of packets to queue inside the kernel before sending them to userpace |
unsigned integer (32 bit)
|==================================
-.log statement options
+.log-flags
[options="header"]
|==================
| Flag | Description
@@ -265,7 +265,7 @@ that is optional, makes it match over the specified rate.
.limit statement values
[options="header"]
|==================
-|Value | Description | Type|
+|Value | Description | Type
|packet_number |
Number of packets |
unsigned integer (32 bit)