From patchwork Sun Mar 12 20:41:16 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Alexander Alemayhu X-Patchwork-Id: 737867 X-Patchwork-Delegate: shemminger@vyatta.com Return-Path: X-Original-To: patchwork-incoming@ozlabs.org Delivered-To: patchwork-incoming@ozlabs.org Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by ozlabs.org (Postfix) with ESMTP id 3vhCZs6vjfz9s7B for ; Mon, 13 Mar 2017 07:41:25 +1100 (AEDT) Authentication-Results: ozlabs.org; dkim=pass (2048-bit key; unprotected) header.d=alemayhu-com.20150623.gappssmtp.com header.i=@alemayhu-com.20150623.gappssmtp.com header.b="noS0NRrx"; dkim-atps=neutral Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S935377AbdCLUlX (ORCPT ); Sun, 12 Mar 2017 16:41:23 -0400 Received: from mail-lf0-f53.google.com ([209.85.215.53]:33773 "EHLO mail-lf0-f53.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S934692AbdCLUlV (ORCPT ); Sun, 12 Mar 2017 16:41:21 -0400 Received: by mail-lf0-f53.google.com with SMTP id a6so56894437lfa.0 for ; Sun, 12 Mar 2017 13:41:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=alemayhu-com.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=HVKxaK3Kr2pxMiFEldP0oNrI/Sd8ln7zHO0yY6WX9Fg=; b=noS0NRrxnSHq7Yasr0hGQ6geuf0/x6Umvzf92jziwx5sC2TdZVf4+P/N+WyZfJLus+ UsaWoHuvUNIfXnG1zAtycKDdLXbzo2P4Hih4+wNtrPJ16wOIYyGsFjYJ+i5WgCEI7RQc 5sMFdjPxPx+HPQi2R68biuA7lsWjgDga0D7beRrfLQ9s8rEKc9T03ChUIAVuiKHmlsIB gUuDB6ywbOSB5E68TCt9Pi7TVxmsc4kqO3z7lCXXlFLTG8ENYu1Ezz82L5uFknNDoH40 fUdDtJX+6PBXf8TnSF+J86HWdosfOP/5niRp4Tehezjgt+gBmlagNN1UWTV0Wi1+sL38 /6fQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=HVKxaK3Kr2pxMiFEldP0oNrI/Sd8ln7zHO0yY6WX9Fg=; b=VMVmqsOJ6LHTRA9xAFMlwEbl716lNNuSEbDnsGnw6U1S0+Qa5qzBVOgtHgaYK+4vRB YifI/yiRPUe+jaZX/rTX2LhsZEe2csFxgCYf7kL2OL5EHRC7egr55bz4Zt7qg0mpie3k DvTYQTwPPWbZcJ/LcUAnu/AMwTbWAU8XKi/WgaoqfkI6Hbz8QS26TtK4JuyXf+nUHKf5 ajVPbiGWoWOsjBbBjtBwE3T+ELBBn61d5/vUsZov6HJeUckTd3lDnjPro7gOTsvsj/5x gen++4UwiUhRBbngMC6RxrwnvB00aXP88FFYGleC7+nMKAwOjl2gdqLHWWXMs+YPsQMy 1NFQ== X-Gm-Message-State: AMke39kVp1k4mF+goycfgkh2oSAdKz192V5DXZMYRe0hxdAbpiwKG328JydC/49FNNfwfA== X-Received: by 10.25.215.89 with SMTP id o86mr8065773lfg.92.1489351279266; Sun, 12 Mar 2017 13:41:19 -0700 (PDT) Received: from localhost ([2a02:fe0:c020:1110::5]) by smtp.gmail.com with ESMTPSA id 9sm359177ljt.25.2017.03.12.13.41.18 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sun, 12 Mar 2017 13:41:18 -0700 (PDT) From: Alexander Alemayhu To: netdev@vger.kernel.org Cc: stephen@networkplumber.org, dsa@cumulusnetworks.com, jidanni@jidanni.org, Alexander Alemayhu Subject: [PATCH iproute2] man: add examples to ip.8 Date: Sun, 12 Mar 2017 21:41:16 +0100 Message-Id: <20170312204116.11943-1-alexander@alemayhu.com> X-Mailer: git-send-email 2.9.3 MIME-Version: 1.0 Sender: netdev-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: netdev@vger.kernel.org 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.