From: Phil Sutter <phil@nwl.cc>
To: Stephen Hemminger <shemming@brocade.com>
Cc: netdev@vger.kernel.org
Subject: [iproute PATCH 3/6] ip-link.8: Extend type list in synopsis
Date: Sat, 9 Jul 2016 11:22:47 +0200 [thread overview]
Message-ID: <1468056170-6056-4-git-send-email-phil@nwl.cc> (raw)
In-Reply-To: <1468056170-6056-1-git-send-email-phil@nwl.cc>
'ip link set' supports passing a type to set type-specific parameters.
Add this missing piece of information to the synopsis section.
Signed-off-by: Phil Sutter <phil@nwl.cc>
---
man/man8/ip-link.8.in | 71 +++++++++++++++++++++++++++++----------------------
1 file changed, 40 insertions(+), 31 deletions(-)
diff --git a/man/man8/ip-link.8.in b/man/man8/ip-link.8.in
index ad18f7555d0a5..4fc5f3c6257e5 100644
--- a/man/man8/ip-link.8.in
+++ b/man/man8/ip-link.8.in
@@ -40,35 +40,6 @@ ip-link \- network device configuration
.RI "[ " ARGS " ]"
.ti -8
-.IR TYPE " := [ "
-.BR bridge " | "
-.BR bond " | "
-.BR can " | "
-.BR dummy " | "
-.BR hsr " | "
-.BR ifb " | "
-.BR ipoib " |"
-.BR macvlan " | "
-.BR macvtap " | "
-.BR vcan " | "
-.BR veth " | "
-.BR vlan " | "
-.BR vxlan " |"
-.BR ip6tnl " |"
-.BR ipip " |"
-.BR sit " |"
-.BR gre " |"
-.BR gretap " |"
-.BR ip6gre " |"
-.BR ip6gretap " |"
-.BR vti " |"
-.BR nlmon " |"
-.BR ipvlan " |"
-.BR lowpan " |"
-.BR geneve " |"
-.BR vrf " ]"
-
-.ti -8
.BR "ip link delete " {
.IR DEVICE " | "
.BI "group " GROUP
@@ -80,7 +51,12 @@ ip-link \- network device configuration
.BR "ip link set " {
.IR DEVICE " | "
.BI "group " GROUP
-.RB "} [ { " up " | " down " } ]"
+}
+.br
+.RB "[ { " up " | " down " } ]"
+.br
+.RB "[ " type
+.IR "ETYPE TYPE_ARGS" " ]"
.br
.RB "[ " arp " { " on " | " off " } ]"
.br
@@ -169,7 +145,7 @@ ip-link \- network device configuration
.B master
.IR DEVICE " ] ["
.B type
-.IR TYPE " ]"
+.IR ETYPE " ]"
.B vrf
.IR NAME " ]"
@@ -177,6 +153,39 @@ ip-link \- network device configuration
.B ip link help
.RI "[ " TYPE " ]"
+.ti -8
+.IR TYPE " := [ "
+.BR bridge " | "
+.BR bond " | "
+.BR can " | "
+.BR dummy " | "
+.BR hsr " | "
+.BR ifb " | "
+.BR ipoib " |"
+.BR macvlan " | "
+.BR macvtap " | "
+.BR vcan " | "
+.BR veth " | "
+.BR vlan " | "
+.BR vxlan " |"
+.BR ip6tnl " |"
+.BR ipip " |"
+.BR sit " |"
+.BR gre " |"
+.BR gretap " |"
+.BR ip6gre " |"
+.BR ip6gretap " |"
+.BR vti " |"
+.BR nlmon " |"
+.BR ipvlan " |"
+.BR lowpan " |"
+.BR geneve " |"
+.BR vrf " ]"
+
+.ti -8
+.IR ETYPE " := [ " TYPE " |"
+.BR bridge_slave " | " bond_slave " ]"
+
.SH "DESCRIPTION"
.SS ip link add - add virtual link
--
2.8.2
next prev parent reply other threads:[~2016-07-09 9:23 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-09 9:22 [iproute PATCH 0/6] iplink: Improve documentation Phil Sutter
2016-07-09 9:22 ` [iproute PATCH 1/6] iplink: List valid 'type' argument in ip link help text Phil Sutter
2016-07-09 9:22 ` [iproute PATCH 2/6] iplink: bond_slave: Add missing help functions Phil Sutter
2016-07-09 9:22 ` Phil Sutter [this message]
2016-07-09 9:22 ` [iproute PATCH 4/6] ip-link.8: Place 'ip link set' warning more prominently Phil Sutter
2016-07-09 9:22 ` [iproute PATCH 5/6] ip-link.8: Add slave type option descriptions Phil Sutter
2016-07-09 9:22 ` [iproute PATCH 6/6] ip-link.8: Fix font choices Phil Sutter
2016-07-20 19:13 ` [iproute PATCH 0/6] iplink: Improve documentation 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=1468056170-6056-4-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).