From a277479dc94fdcc340337b1683644cab40f57bf9 Mon Sep 17 00:00:00 2001
From: Arushi Singhal <arushisinghal19971997@gmail.com>
Date: Wed, 25 Jul 2018 16:56:43 +0530
Subject: nft: doc: Convert man page source to asciidoc

This patch converts nft.xml into asciidoc markup.

Signed-off-by: Arushi Singhal <arushisinghal19971997@gmail.com>
Signed-off-by: Florian Westphal <fw@strlen.de>
---
 doc/stateful-objects.txt | 71 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 71 insertions(+)
 create mode 100644 doc/stateful-objects.txt

(limited to 'doc/stateful-objects.txt')

diff --git a/doc/stateful-objects.txt b/doc/stateful-objects.txt
new file mode 100644
index 00000000..9d992647
--- /dev/null
+++ b/doc/stateful-objects.txt
@@ -0,0 +1,71 @@
+CT
+~~
+[verse]
+*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 mandatory, l3proto is derived from the table family by default, i.e. in the inet table the kernel will try to load both the ipv4 and ipv6 helper backends, if they are supported by the kernel.
+
+.conntrack helper specifications
+[options="header"]
+|=================
+|Keyword | Description | Type
+| type |
+name of helper type |
+quoted string (e.g. "ftp")
+|protocol |
+layer 4 protocol of the helper |
+address family (e.g. ip)
+|l3proto |
+layer 3 protocol of the helper |
+address family (e.g. ip)
+|=================
+
+.defining and assigning ftp helper
+----------------------------------
+Unlike iptables, helper assignment needs to be performed after the conntrack lookup has completed, for example with the default 0 hook priority.
+
+table inet myhelpers {
+  ct helper ftp-standard {
+     type "ftp" protocol tcp
+  }
+  chain prerouting {
+      type filter hook prerouting priority 0;
+      tcp dport 21 ct helper set "ftp-standard"
+  }
+}
+----------------------------------
+
+COUNTER
+~~~~~~~
+[verse]
+*counter* [packets bytes]
+
+.Counter specifications
+[options="header"]
+|=================
+|Keyword | Description | Type
+|packets |
+initial count of packets |
+unsigned integer (64 bit)
+|bytes |
+initial count of bytes |
+unsigned integer (64 bit)
+|=================
+
+QUOTA
+~~~~~
+[verse]
+*quota* [over | until] [used]
+
+.Quota specifications
+[options="header"]
+|=================
+|Keyword | Description | Type
+|quota |
+quota limit, used as the quota name |
+Two arguments, unsigned interger (64 bit) and string: bytes, kbytes, mbytes.
+"over" and "until" go before these arguments
+|used |
+initial value of used quota |
+Two arguments, unsigned interger (64 bit) and string: bytes, kbytes, mbytes
+|=================
-- 
cgit v1.2.3