diff options
author | Duncan Roe <duncan_roe@optusnet.com.au> | 2017-10-20 22:29:15 +1100 |
---|---|---|
committer | Pablo Neira Ayuso <pablo@netfilter.org> | 2017-10-24 18:07:38 +0200 |
commit | f8596968a650c66e0b4d5895b700d03d7518b245 (patch) | |
tree | ecee4a6d42ca4a5c7c8280511df88712d87991f2 /doc | |
parent | 6db6ec4d46270d1cd0b877bc03cd589789c53367 (diff) |
doc: nft.8 simplify initial SYNOPSIS line
In the style of tcpdump.8: where options have short and long forms, only show
short form in synopsis but mention long form in description.
Re-order option descriptions to match order in synopsis (move -N to just after -n).
Signed-off-by: Duncan Roe <duncan_roe@optusnet.com.au>
Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/nft.xml | 66 |
1 files changed, 14 insertions, 52 deletions
diff --git a/doc/nft.xml b/doc/nft.xml index 86b4bd91..2dec0aa1 100644 --- a/doc/nft.xml +++ b/doc/nft.xml @@ -46,49 +46,16 @@ vi:ts=4 sw=4 <cmdsynopsis> <command>nft</command> <group> - <arg><option>-n</option></arg> - <arg><option>--numeric</option></arg> + <arg><option> -nNscae </option></arg> </group> - <group> - <arg><option>-N</option></arg> - <arg><option>--reversedns</option></arg> - </group> - <group> - <arg><option>-s</option></arg> - <arg><option>--stateless</option></arg> - </group> - <group> - <arg><option>-c</option></arg> - <arg><option>--check</option></arg> - </group> - <group> - <arg><option>-a</option></arg> - <arg><option>--handle</option></arg> - </group> - <group> - <arg><option>-e</option></arg> - <arg><option>--echo</option></arg> - </group> - <arg> - <group choice="req"> - <arg><option>-I</option></arg> - <arg><option>--includepath</option></arg> - </group> + <arg> -I <replaceable>directory</replaceable> </arg> <group> - <arg> - <group choice="req"> - <arg><option>-f</option></arg> - <arg><option>--file</option></arg> - </group> + <arg> -f <replaceable>filename</replaceable> </arg> - <arg> - <group choice="req"> - <arg><option>-i</option></arg> - <arg><option>--interactive</option></arg> - </group> + <arg> -i </arg> <arg rep="repeat"> <replaceable>cmd</replaceable> @@ -96,15 +63,10 @@ vi:ts=4 sw=4 </group> </cmdsynopsis> <cmdsynopsis> - <command>nft</command> - <group> - <arg><option>-h</option></arg> - <arg><option>--help</option></arg> - </group> - <group> - <arg><option>-v</option></arg> - <arg><option>--version</option></arg> - </group> + <command>nft -h</command> + </cmdsynopsis> + <cmdsynopsis> + <command>nft -v</command> </cmdsynopsis> </refsynopsisdiv> @@ -151,26 +113,26 @@ vi:ts=4 sw=4 </listitem> </varlistentry> <varlistentry> - <term><option>-s, --stateless</option></term> + <term><option>-N, --reversedns</option></term> <listitem> <para> - Omit stateful information of rules and stateful objects. + Translate IP addresses to names. Usually requires network traffic for DNS lookup. </para> </listitem> </varlistentry> <varlistentry> - <term><option>-c, --check</option></term> + <term><option>-s, --stateless</option></term> <listitem> <para> - Check commands validity without actually applying the changes. + Omit stateful information of rules and stateful objects. </para> </listitem> </varlistentry> <varlistentry> - <term><option>-N, --reversedns</option></term> + <term><option>-c, --check</option></term> <listitem> <para> - Translate IP addresses to names. Usually requires network traffic for DNS lookup. + Check commands validity without actually applying the changes. </para> </listitem> </varlistentry> |