From: Alexander Alemayhu <alexander@alemayhu.com>
To: netdev@vger.kernel.org
Cc: stephen@networkplumber.org, dsa@cumulusnetworks.com,
jidanni@jidanni.org, Alexander Alemayhu <alexander@alemayhu.com>
Subject: [PATCH iproute2] man: add examples to ip.8
Date: Sun, 12 Mar 2017 21:41:16 +0100 [thread overview]
Message-ID: <20170312204116.11943-1-alexander@alemayhu.com> (raw)
Having some examples in the top level man page might make it a little bit easier
for new users to get started. Reused some words / sentences from the existing
man pages.
Suggested-by: 積丹尼 Dan Jacobson <jidanni@jidanni.org>
Signed-off-by: Alexander Alemayhu <alexander@alemayhu.com>
---
This is my first man page patch, hopefully I've done everything correctly.
If not please let me know, thanks.
man/man8/ip.8 | 28 ++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/man/man8/ip.8 b/man/man8/ip.8
index 8ecb1996da92..1c5a7419e4fc 100644
--- a/man/man8/ip.8
+++ b/man/man8/ip.8
@@ -319,6 +319,34 @@ or, if the objects of this class cannot be listed,
Exit status is 0 if command was successful, and 1 if there is a syntax error.
If an error was reported by the kernel exit status is 2.
+.SH "EXAMPLES"
+.PP
+ip addr
+.RS 4
+Shows addresses assigned to all network interfaces.
+.RE
+.PP
+ip neigh
+.RS 4
+Shows the current neighbour table in kernel.
+.RE
+.PP
+ip link set x up
+.RS 4
+Bring up interface x.
+.RE
+.PP
+ip link set x down
+.RE
+.RS 4
+Bring down interface x.
+.RE
+.PP
+ip route
+.RS 4
+Show table routes.
+.RE
+
.SH HISTORY
.B ip
was written by Alexey N. Kuznetsov and added in Linux 2.2.
--
2.9.3
next reply other threads:[~2017-03-12 20:41 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-03-12 20:41 Alexander Alemayhu [this message]
2017-03-14 23:42 ` [PATCH iproute2] man: add examples to ip.8 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=20170312204116.11943-1-alexander@alemayhu.com \
--to=alexander@alemayhu.com \
--cc=dsa@cumulusnetworks.com \
--cc=jidanni@jidanni.org \
--cc=netdev@vger.kernel.org \
--cc=stephen@networkplumber.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