]> git.ipfire.org Git - thirdparty/iproute2.git/commitdiff
man: add examples to ip.8
authorAlexander Alemayhu <alexander@alemayhu.com>
Sun, 12 Mar 2017 20:41:16 +0000 (21:41 +0100)
committerStephen Hemminger <stephen@networkplumber.org>
Tue, 14 Mar 2017 23:41:13 +0000 (16:41 -0700)
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>
man/man8/ip.8

index 8ecb1996da92deeb8d8fabd418b2bf36eca39c00..1c5a7419e4fc258f969bd5316380789e1b7b3773 100644 (file)
@@ -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.