Re: [PATCH iproute2] man: add examples to ip.8

[Stephen Hemminger]

On Sun, 12 Mar 2017 21:41:16 +0100
Alexander Alemayhu  wrote:

> 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 
> Signed-off-by: Alexander Alemayhu 
> ---
> 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(+)
> 

Sure looks good, applied.

[PATCH iproute2] man: add examples to ip.8

[Alexander Alemayhu]

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 
Signed-off-by: Alexander Alemayhu 
---
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