batctl: include ping -R in manpage

Message ID 4B8FA44B.3020808@tiwoc.de (mailing list archive)
State Accepted, archived
Commit e111eec40afe51745b35a8ded339dc43cf591248
Headers

Commit Message

Daniel Seither March 4, 2010, 12:15 p.m. UTC
  This patch adds documentation for the ping -R option to the batctl manpage.

Signed-off-by: Daniel Seither <post@tiwoc.de>
---
  

Comments

Marek Lindner March 4, 2010, 12:45 p.m. UTC | #1
On Thursday 04 March 2010 20:15:07 Daniel Seither wrote:
> This patch adds documentation for the ping -R option to the batctl manpage.

Applied in revision 1580.

Thanks,
Marek
  

Patch

Index: batctl/man/batctl.8
===================================================================
--- batctl/man/batctl.8	(revision 1579)
+++ batctl/man/batctl.8	(working copy)
@@ -126,14 +126,15 @@ 
 Otherwise the parameter is used to enable or disable packet
 aggregation.
 .br
-.IP "\fBping\fP|\fBp\fP [\fB\-c \fP\fIcount\fP][\fB\-i \fP\fIinterval\fP][\fB\-t \fP\fItime\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
+.IP "\fBping\fP|\fBp\fP [\fB\-c \fP\fIcount\fP][\fB\-i \fP\fIinterval\fP][\fB\-t \fP\fItime\fP][\fB\-R\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
 Layer 2 ping of a MAC address or bat\-host name.  batctl will try to
 find the bat\-host name if the given parameter was not a MAC
 address. The "\-c" option tells batctl how man pings should be sent
 before the program exits. Without the "\-c" option batctl will continue
 pinging without end. Use CTRL + C to stop it.  With "\-i" and "\-t"
 you can set the default interval between pings and the timeout time
-for replies, both in seconds.
+for replies, both in seconds. When run with "\-R", the route taken by
+the ping messages will be recorded.
 .br
 .IP "\fBtraceroute\fP|\fBtr\fP  [\fB\-n\fP] \fIMAC_address\fP|\fIbat\-host_name\fP"
 Layer 2 traceroute to a MAC address or bat\-host name. batctl will try