* [PATCH] doc: nft.8 simplify initial SYNOPSIS line
@ 2017-10-20 11:29 Duncan Roe
2017-10-24 16:08 ` Pablo Neira Ayuso
0 siblings, 1 reply; 2+ messages in thread
From: Duncan Roe @ 2017-10-20 11:29 UTC (permalink / raw)
To: netfilter-devel
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>
---
doc/nft.xml | 66 +++++++++++++------------------------------------------------
1 file changed, 14 insertions(+), 52 deletions(-)
diff --git a/doc/nft.xml b/doc/nft.xml
index 86b4bd9..2dec0aa 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>
--
2.9.0
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] doc: nft.8 simplify initial SYNOPSIS line
2017-10-20 11:29 [PATCH] doc: nft.8 simplify initial SYNOPSIS line Duncan Roe
@ 2017-10-24 16:08 ` Pablo Neira Ayuso
0 siblings, 0 replies; 2+ messages in thread
From: Pablo Neira Ayuso @ 2017-10-24 16:08 UTC (permalink / raw)
To: Duncan Roe; +Cc: netfilter-devel
On Fri, Oct 20, 2017 at 10:29:15PM +1100, Duncan Roe wrote:
> 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).
Applied, thanks Duncan.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2017-10-24 16:08 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-10-20 11:29 [PATCH] doc: nft.8 simplify initial SYNOPSIS line Duncan Roe
2017-10-24 16:08 ` Pablo Neira Ayuso
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.