From: Stephen Hemminger <shemminger@vyatta•com>
To: Alex Juncu <ajuncu@ixiacom•com>
Cc: <netdev@vger•kernel.org>
Subject: Re: [PATCH 1/1] Adding examples in ip man page on basic use of the ip command.
Date: Mon, 28 Nov 2011 17:39:17 -0800 [thread overview]
Message-ID: <20111128173917.30e7a025@nehalam.linuxnetplumber.net> (raw)
In-Reply-To: <4ECE31F6.4070002@ixiacom.com>
On Thu, 24 Nov 2011 14:00:54 +0200
Alex Juncu <ajuncu@ixiacom•com> wrote:
> ---
> man/man8/ip.8 | 43 +++++++++++++++++++++++++++++++++++++++++++
> 1 files changed, 43 insertions(+), 0 deletions(-)
>
> diff --git a/man/man8/ip.8 b/man/man8/ip.8
> index a20eca7..99c8953 100644
> --- a/man/man8/ip.8
> +++ b/man/man8/ip.8
> @@ -2855,6 +2855,49 @@ can be
> .SS ip xfrm monitor - state monitoring for xfrm objects
> The xfrm objects to monitor can be optionally specified.
>
> +.SH EXAMPLES
> +.LP
> +To turn on an interface:
> +.RS
> +.nf
> +.B ip link set up dev eth0
> +.fi
> +.RE
> +.LP
> +To add an IPv4 address to an interface:
> +.RS
> +.nf
> +.B ip address add 141.85.37.42/24 dev eth0
> +.fi
> +.RE
> +.LP
> +To add a default route in the IPv4 routing table using a next hop IP
> address:
> +.RS
> +.nf
> +.B ip route add default via 141.85.37.1
> +.fi
> +.RE
> +.LP
> +Equivalent ways of listing address information for all the interfaces:
> +.RS
> +.nf
> +.B ip addr show
> +.fi
> +.RE
> +.LP
> +.RS
> +.nf
> +.B ip a s
> +.fi
> +.RE
> +.LP
> +.RS
> +.nf
> +.B ip a
> +.fi
> +.RE
> +.LP
> +
Simple examples at bottom of page are good, but it is unnecessary
to show how to abbreviate. That just confuses the newbie reading the examples.
Give one example of each of the basic normal tasks. See the git man pages
for good examples.
prev parent reply other threads:[~2011-11-29 1:39 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-11-24 12:00 [PATCH 1/1] Adding examples in ip man page on basic use of the ip command Alex Juncu
2011-11-24 19:12 ` Ben Hutchings
2011-11-29 1:39 ` Stephen Hemminger [this message]
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=20111128173917.30e7a025@nehalam.linuxnetplumber.net \
--to=shemminger@vyatta$(echo .)com \
--cc=ajuncu@ixiacom$(echo .)com \
--cc=netdev@vger$(echo .)kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
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