From mboxrd@z Thu Jan 1 00:00:00 1970 From: Kees van Reeuwijk Subject: [PATCH v2 4/5] iproute2: clarification of various man8 pages Date: Fri, 08 Feb 2013 14:32:36 +0100 Message-ID: Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit To: netdev@vger.kernel.org Return-path: Received: from mail-wi0-f172.google.com ([209.85.212.172]:56150 "EHLO mail-wi0-f172.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1946075Ab3BHNel (ORCPT ); Fri, 8 Feb 2013 08:34:41 -0500 Received: by mail-wi0-f172.google.com with SMTP id ez12so846761wid.11 for ; Fri, 08 Feb 2013 05:34:40 -0800 (PST) Received: from reeuwijk by babylon.few.vu.nl with local (Exim 4.72) (envelope-from ) id 1U3o4C-0000c1-OV for netdev@vger.kernel.org; Fri, 08 Feb 2013 14:32:36 +0100 Sender: netdev-owner@vger.kernel.org List-ID: From: Kees van Reeuwijk Rephrasing for clarity. Note that in ip-rule.8 I rephrased a sentence to "The RPDB is scanned in order of decreasing priority." The original version talked about *in*creasing priority, but from the context that didn't make sense. Signed-off-by: Kees van Reeuwijk --- arpd.8 | 38 +++++++++++++++++++------------------- bridge.8 | 10 +++++----- ip-addrlabel.8 | 16 ++++++++-------- ip-maddress.8 | 10 +++++----- ip-monitor.8 | 25 ++++++++++++++++--------- ip-mroute.8 | 4 ++-- ip-neighbour.8 | 2 +- ip-netconf.8 | 6 +++--- ip-netns.8 | 4 ++-- ip-rule.8 | 6 +++--- ip.8 | 20 ++++++++++---------- tc.8 | 6 +++--- 12 files changed, 77 insertions(+), 70 deletions(-) diff --git a/man/man8/arpd.8 b/man/man8/arpd.8 index a14044b..6b9a43a 100644 --- a/man/man8/arpd.8 +++ b/man/man8/arpd.8 @@ -4,12 +4,12 @@ arpd \- userspace arp daemon. .SH SYNOPSIS -Usage: arpd [ -lkh? ] [ -a N ] [ -b dbase ] [ -B number ] [ -f file ] [-p interval ] [ -n time ] [ -R rate ] [ interfaces ] +Usage: arpd [ -lkh? ] [ -a N ] [ -b dbase ] [ -B number ] [ -f file ] [-p interval ] [ -n time ] [ -R rate ] [ ] .SH DESCRIPTION The .B arpd -daemon collects gratuitous ARP information, saving it on local disk and feeding it to kernel on demand to avoid redundant broadcasting due to limited size of kernel ARP cache. +daemon collects gratuitous ARP information, saving it on local disk and feeding it to the kernel on demand to avoid redundant broadcasting due to limited size of the kernel ARP cache. .SH OPTIONS .TP @@ -17,41 +17,41 @@ daemon collects gratuitous ARP information, saving it on local disk and feeding Print help .TP -l -Dump arpd database to stdout and exit. Output consists of three columns: interface index, IP address and MAC address. Negative entries for dead hosts are also shown, in this case MAC address is replaced by word FAILED followed by colon and time when the fact that host is dead was proven the last time. +Dump the arpd database to stdout and exit. The output consists of three columns: the interface index, the IP address of the interface, and the MAC address of the interface. Negative entries for dead hosts are also shown, in this case the MAC address is replaced by the word FAILED followed by a colon and the most recent time when the fact that the host is dead was proven. .TP -f -Read and load arpd database from FILE in text format similar dumped by option -l. Exit after load, probably listing resulting database, if option -l is also given. If FILE is -, stdin is read to get ARP table. +Read and load an arpd database from FILE in a text format similar to that dumped by option -l. Exit after load, possibly listing resulting database, if option -l is also given. If FILE is -, stdin is read to get the ARP table. .TP -b -location of database file. Default location is /var/lib/arpd/arpd.db +the location of the database file. The default location is /var/lib/arpd/arpd.db .TP -a -arpd not only passively listens ARP on wire, but also send brodcast queries itself. NUMBER is number of such queries to make before destination is considered as dead. When arpd is started as kernel helper (i.e. with app_solicit enabled in sysctl or even with option -k) without this option and still did not learn enough information, you can observe 1 second gaps in service. Not fatal, but not good. +With this option, arpd not only passively listens for ARP packets on the interface, but also sends brodcast queries itself. NUMBER is the number of such queries to make before a destination is considered dead. When arpd is started as kernel helper (i.e. with app_solicit enabled in sysctl or even with option -k) without this option and still did not learn enough information, you can observe 1 second gaps in service. Not fatal, but not good. .TP -k -Suppress sending broadcast queries by kernel. It takes sense together with option -a. +Suppress sending broadcast queries by the kernel. This option only makes sense together with option -a. .TP -n