From: Phil Sutter <phil@nwl.cc>
To: Pablo Neira Ayuso <pablo@netfilter.org>
Cc: netfilter-devel@vger.kernel.org
Subject: [nft PATCH 1/2] nft.8: Fix and enhance synopsis section
Date: Thu, 17 Aug 2017 15:38:59 +0200 [thread overview]
Message-ID: <20170817133900.21946-2-phil@nwl.cc> (raw)
In-Reply-To: <20170817133900.21946-1-phil@nwl.cc>
This patch addresses shortcomings in the main synopsis section
illustrating possible invocations of nft command:
- Fix font styles to correctly put options into bold font and meta
characters (brackets, pipes) into normal font.
- Add missing options to synopsis line.
- Use curly braces where either one of the alternatives is required.
- Remove choice="opt" attribute since that is the default anyway.
- Note that --includepath option is allowed to be given multiple times.
Signed-off-by: Phil Sutter <phil@nwl.cc>
---
doc/nft.xml | 74 +++++++++++++++++++++++++++++++++++++++++--------------------
1 file changed, 50 insertions(+), 24 deletions(-)
diff --git a/doc/nft.xml b/doc/nft.xml
index d7aae3f03b8c1..191a4c12f8487 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -45,40 +45,66 @@ vi:ts=4 sw=4
<refsynopsisdiv>
<cmdsynopsis>
<command>nft</command>
- <arg choice="opt">
- <option>-n | --numeric</option>
- </arg>
- <arg choice="opt">
- <option>-s | --stateless</option>
- </arg>
- <arg choice="opt">
- <option>-c | --check</option>
- </arg>
- <arg choice="opt">
- <option>[-I | --includepath]</option>
+ <group>
+ <arg><option>-n</option></arg>
+ <arg><option>--numeric</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>
<replaceable>directory</replaceable>
</arg>
<group>
- <arg choice="opt">
- <option>[-f | --file]</option>
+ <arg>
+ <group choice="req">
+ <arg><option>-f</option></arg>
+ <arg><option>--file</option></arg>
+ </group>
<replaceable>filename</replaceable>
</arg>
- <arg choice="opt">
- <option>[-i | --interactive]</option>
+ <arg>
+ <group choice="req">
+ <arg><option>-i</option></arg>
+ <arg><option>--interactive</option></arg>
+ </group>
</arg>
- <arg choice="opt" rep="repeat">
+ <arg rep="repeat">
<replaceable>cmd</replaceable>
</arg>
</group>
</cmdsynopsis>
<cmdsynopsis>
<command>nft</command>
- <arg choice="opt">
- <option>-h | --help</option>
- </arg>
- <arg choice="opt">
- <option>-v | --version</option>
- </arg>
+ <group>
+ <arg><option>-h</option></arg>
+ <arg><option>--help</option></arg>
+ </group>
+ <group>
+ <arg><option>-v</option></arg>
+ <arg><option>--version</option></arg>
+ </group>
</cmdsynopsis>
</refsynopsisdiv>
@@ -141,7 +167,7 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-N</option></term>
+ <term><option>-N, --reversedns</option></term>
<listitem>
<para>
Translate IP addresses to names. Usually requires network traffic for DNS lookup.
@@ -170,7 +196,7 @@ vi:ts=4 sw=4
<term><option>-I, --includepath <replaceable>directory</replaceable></option></term>
<listitem>
<para>
- Add the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files.
+ Add the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files. This option may be specified multiple times.
</para>
</listitem>
</varlistentry>
--
2.13.1
next prev parent reply other threads:[~2017-08-17 13:39 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-17 13:38 [nft PATCH 0/2] First attempt at synopsis fixup Phil Sutter
2017-08-17 13:38 ` Phil Sutter [this message]
2017-08-28 16:58 ` [nft PATCH 1/2] nft.8: Fix and enhance synopsis section Pablo Neira Ayuso
2017-08-28 21:25 ` Phil Sutter
2017-08-17 13:39 ` [nft PATCH RFC 2/2] nft.8: Make use of synopfragment in " Phil Sutter
2017-08-28 16:58 ` Pablo Neira Ayuso
2017-08-17 17:37 ` [nft PATCH 0/2] First attempt at synopsis fixup Phil Sutter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170817133900.21946-2-phil@nwl.cc \
--to=phil@nwl.cc \
--cc=netfilter-devel@vger.kernel.org \
--cc=pablo@netfilter.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).