netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Phil Sutter <phil@nwl.cc>
To: Stephen Hemminger <shemming@brocade.com>
Cc: netdev@vger.kernel.org
Subject: [iproute PATCH 10/20] man: ip-link.8: Fix and improve synopsis
Date: Wed, 24 Feb 2016 09:21:23 +0100	[thread overview]
Message-ID: <1456302093-697-11-git-send-email-phil@nwl.cc> (raw)
In-Reply-To: <1456302093-697-1-git-send-email-phil@nwl.cc>

Reflect that it is possible to pass multiple parameters at the same
time, also use the same trick the help text uses to emphasize vf
specific parameters.

Signed-off-by: Phil Sutter <phil@nwl.cc>
---
 man/man8/ip-link.8.in | 97 ++++++++++++++++++++++++++++-----------------------
 1 file changed, 53 insertions(+), 44 deletions(-)

diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index 27c9a321c2af8..cc0842f01ab59 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -92,78 +92,87 @@ ip-link \- network device configuration
 .BR "ip link set " {
 .IR DEVICE " | "
 .BI "group " GROUP
-.RB "} { " up " | " down " | " arp " { " on " | " off " } |"
+.RB "} [ { " up " | " down " } ]"
 .br
-.BR promisc " { " on " | " off " } |"
+.RB "[ " arp " { " on " | " off " } ]"
 .br
-.BR allmulticast " { " on " | " off " } |"
+.RB "[ " dynamic " { " on " | " off " } ]"
 .br
-.BR dynamic " { " on " | " off " } |"
+.RB "[ " multicast " { " on " | " off " } ]"
 .br
-.BR multicast " { " on " | " off " } |"
+.RB "[ " allmulticast " { " on " | " off " } ]"
 .br
-.BR protodown " { " on " | " off " } |"
+.RB "[ " promisc " { " on " | " off " } ]"
 .br
-.B  txqueuelen
-.IR PACKETS " |"
+.RB "[ " protodown " { " on " | " off " } ]"
 .br
-.B  name
-.IR NEWNAME " |"
+.RB "[ " trailers " { " on " | " off " } ]"
 .br
-.B  address
-.IR LLADDR " |"
-.B  broadcast
-.IR LLADDR " |"
+.RB "[ " txqueuelen
+.IR PACKETS " ]"
 .br
-.B  mtu
-.IR MTU " |"
+.RB "[ " name
+.IR NEWNAME " ]"
 .br
-.B  netns
-.IR PID " |"
+.RB "[ " address
+.IR LLADDR " ]"
 .br
-.B  netns
-.IR NETNSNAME " |"
+.RB "[ " broadcast
+.IR LLADDR " ]"
 .br
-.B alias
-.IR NAME  " |"
+.RB "[ " mtu
+.IR MTU " ]"
 .br
-.B vf
+.RB "[ " netns " {"
+.IR PID " | " NETNSNAME " } ]"
+.br
+.RB "[ " link-netnsid
+.IR ID " ]"
+.br
+.RB "[ " alias
+.IR NAME  " ]"
+.br
+.RB "[ " vf
 .IR NUM " ["
 .B  mac
-.IR LLADDR " ] ["
-.B vlan
+.IR LLADDR " ]"
+.br
+.in +9
+.RB "[ " vlan
 .IR VLANID " [ "
 .B qos
-.IR VLAN-QOS " ] ] ["
-.B rate
-.IR TXRATE " ] ["
-.B max_tx_rate
-.IR TXRATE " ] ["
-.B min_tx_rate
-.IR TXRATE " ] ["
-.B spoofchk { on | off } ] [
-.B state { auto | enable | disable}
-] |
+.IR VLAN-QOS " ] ]"
 .br
-.B master
-.IR DEVICE " |"
+.RB "[ " rate
+.IR TXRATE " ]"
+.br
+.RB "[ " max_tx_rate
+.IR TXRATE " ]"
 .br
-.B nomaster " |"
+.RB "[ " min_tx_rate
+.IR TXRATE " ]"
 .br
-.B addrgenmode { eui64 | none | stable_secret | random }
+.RB "[ " spoofchk " { " on " | " off " } ]"
 .br
-.B link-netnsid ID
-.BR " }"
+.RB "[ " state " { " auto " | " enable " | " disable " } ] ]"
+.br
+.in -9
+.RB "[ " master
+.IR DEVICE " ]"
+.br
+.RB "[ " nomaster " ]"
+.br
+.RB "[ " addrgenmode " { " eui64 " | " none " | " stable_secret " | " random " } ]"
 
 
 .ti -8
 .B ip link show
 .RI "[ " DEVICE " | "
 .B group
-.IR GROUP " | "
-.BR up " | "
+.IR GROUP " ] ["
+.BR up " ] ["
 .B master
-.IR DEVICE " | "
+.IR DEVICE " ] ["
 .B type
 .IR TYPE " ]"
 
-- 
2.6.4

  parent reply	other threads:[~2016-02-24  8:22 UTC|newest]

Thread overview: 47+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-24  8:21 [iproute PATCH 00/20] Sync man pages and help texts Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 01/20] ip: align help text with manpage Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 02/20] ipaddrlabel: Improve help text precision Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 03/20] iplink: fix help text syntax Phil Sutter
2016-03-02 17:38   ` Stephen Hemminger
2016-03-02 18:19     ` [iproute PATCH v2 00/20] Sync man pages and help texts Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 01/20] ip: align help text with manpage Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 02/20] ipaddrlabel: Improve help text precision Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 03/20] iplink: fix help text syntax Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 04/20] ipneigh: add missing proxy keyword to help text Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 05/20] ipntable: Fix typo in " Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 06/20] iproute: TYPE keyword is not optional, fix help text accordingly Phil Sutter
2016-03-03 14:21         ` Jamal Hadi Salim
2016-03-03 15:05           ` Phil Sutter
2016-03-07 11:23             ` Jamal Hadi Salim
2016-03-02 18:19       ` [iproute PATCH v2 07/20] iprule: add missing nat keyword to help text Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 08/20] man: ip-address.8: Minor syntax fixes Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 09/20] man: ip-link.8: minor font fix Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 10/20] man: ip-link.8: Fix and improve synopsis Phil Sutter
2016-03-02 18:19       ` [iproute PATCH v2 11/20] man: ip-neighbour: Fix for missing NUD_STATE description Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 12/20] man: ip-netns.8: Clarify synopsis a bit Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 13/20] man: ip-ntable.8: Review synopsis section Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 14/20] man: ip-rule.8: " Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 15/20] man: ip-token.8: " Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 16/20] man: ip-tunnel.8: Document missing 6rd action Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 17/20] man: ip-xfrm.8: Document missing parameters Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 18/20] man: ip.8: Add missing flags and token subcommand description Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 19/20] man: ip-l2tp.8: Fix BNF syntax Phil Sutter
2016-03-02 18:20       ` [iproute PATCH v2 20/20] man: ip-*.8: drop any reference to generic ip options Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 04/20] ipneigh: add missing proxy keyword to help text Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 05/20] ipntable: Fix typo in " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 06/20] iproute: TYPE keyword is not optional, fix help text accordingly Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 07/20] iprule: add missing nat keyword to help text Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 08/20] man: ip-address.8: Minor syntax fixes Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 09/20] man: ip-link.8: minor font fix Phil Sutter
2016-02-24  8:21 ` Phil Sutter [this message]
2016-02-24  8:21 ` [iproute PATCH 11/20] man: ip-neighbour: Fix for missing NUD_STATE description Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 12/20] man: ip-netns.8: Clarify synopsis a bit Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 13/20] man: ip-ntable.8: Review synopsis section Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 14/20] man: ip-rule.8: " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 15/20] man: ip-token.8: " Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 16/20] man: ip-tunnel.8: Document missing 6rd action Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 17/20] man: ip-xfrm.8: Document missing parameters Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 18/20] man: ip.8: Add missing flags and token subcommand description Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 19/20] man: ip-l2tp.8: Fix BNF syntax Phil Sutter
2016-02-24  8:21 ` [iproute PATCH 20/20] man: ip-*.8: drop any reference to generic ip options Phil Sutter
2016-03-02 19:59 ` [iproute PATCH 00/20] Sync man pages and help texts Stephen Hemminger

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=1456302093-697-11-git-send-email-phil@nwl.cc \
    --to=phil@nwl.cc \
    --cc=netdev@vger.kernel.org \
    --cc=shemming@brocade.com \
    /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).