From: FaTe <gokuvsvegita@gmail.com>
To: Pablo Neira Ayuso <pablo@netfilter.org>
Cc: netfilter-devel@vger.kernel.org
Subject: [PATCH v2] doc: nft: Fixed a typo and added/changed punctuation
Date: Tue, 8 Mar 2016 19:57:15 +0530 [thread overview]
Message-ID: <56DEE143.60604@gmail.com> (raw)
In-Reply-To: <20160307180600.GA6777@salvia>
In nft's man page , instead of using '/' between shortopt and longopt in the
"SYNOPSIS" and "OPTIONS" section , use '|' and ',' respectively.
(just like the man pages of iptables, etc.)
Fixed a typo and added missing ',' .
Signed-off-by: Piyush Pangtey <gokuvsvegita@gmail.com>
---
doc/nft.xml | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/doc/nft.xml b/doc/nft.xml
index 7cc9988..e4d227c 100644
--- a/doc/nft.xml
+++ b/doc/nft.xml
@@ -34,19 +34,19 @@ vi:ts=4 sw=4
<cmdsynopsis>
<command>nft</command>
<arg choice="opt">
- <option>-n/--numeric</option>
+ <option>-n | --numeric</option>
</arg>
<arg choice="opt">
- <option>-I/--includepath</option>
+ <option>[-I | --includepath]</option>
<replaceable>directory</replaceable>
</arg>
<group>
<arg choice="opt">
- <option>-f/--file</option>
+ <option>[-f | --file]</option>
<replaceable>filename</replaceable>
</arg>
<arg choice="opt">
- <option>-i/--interactive</option>
+ <option>[-i | --interactive]</option>
</arg>
<arg choice="opt" rep="repeat">
<replaceable>cmd</replaceable>
@@ -56,10 +56,10 @@ vi:ts=4 sw=4
<cmdsynopsis>
<command>nft</command>
<arg choice="opt">
- <option>-h/--help</option>
+ <option>-h | --help</option>
</arg>
<arg choice="opt">
- <option>-v/--version</option>
+ <option>-v | --version</option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
@@ -80,7 +80,7 @@ vi:ts=4 sw=4
<variablelist>
<varlistentry>
- <term><option>-h/--help</option></term>
+ <term><option>-h, --help</option></term>
<listitem>
<para>
Show help message and all options.
@@ -88,7 +88,7 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-v/--version</option></term>
+ <term><option>-v, --version</option></term>
<listitem>
<para>
Show version.
@@ -96,7 +96,7 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-n/--numeric</option></term>
+ <term><option>-n, --numeric</option></term>
<listitem>
<para>
Numeric output: Addresses and other information
@@ -117,7 +117,7 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-a/--handle</option></term>
+ <term><option>-a, --handle</option></term>
<listitem>
<para>
Show rule handles in output.
@@ -125,15 +125,15 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-I/--includepath <replaceable>directory</replaceable></option></term>
+ <term><option>-I, --includepath <replaceable>directory</replaceable></option></term>
<listitem>
<para>
- Add the directory <replaceable>directory</replaceable> to the list of directories to by searched for included files.
+ Add the directory <replaceable>directory</replaceable> to the list of directories to be searched for included files.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-f/--file <replaceable>filename</replaceable></option></term>
+ <term><option>-f, --file <replaceable>filename</replaceable></option></term>
<listitem>
<para>
Read input from <replaceable>filename</replaceable>.
@@ -141,7 +141,7 @@ vi:ts=4 sw=4
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-i/--interactive</option></term>
+ <term><option>-i, --interactive</option></term>
<listitem>
<para>
Read input from an interactive readline CLI.
@@ -156,8 +156,8 @@ vi:ts=4 sw=4
<refsect2>
<title>Lexical conventions</title>
<para>
- Input is parsed line-wise. When the last character of a line just before
- the newline character is a non-quoted backslash (<literal>\</literal>),
+ Input is parsed line-wise. When the last character of a line, just before
+ the newline character, is a non-quoted backslash (<literal>\</literal>),
the next line is treated as a continuation. Multiple commands on the
same line can be separated using a semicolon (<literal>;</literal>).
</para>
--
1.9.1
next prev parent reply other threads:[~2016-03-08 14:27 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-03-07 14:54 [PATCH] doc: nft: Fixed a typo and added/changed punctuation Piyush Pangtey
2016-03-07 18:06 ` Pablo Neira Ayuso
2016-03-08 14:27 ` FaTe [this message]
2016-03-09 12:19 ` [PATCH v2] " Pablo Neira Ayuso
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=56DEE143.60604@gmail.com \
--to=gokuvsvegita@gmail.com \
--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).