pathmtu/pathmtu.c: Document the `--verbose' option.
authorMark Wooding <mdw@distorted.org.uk>
Thu, 14 Sep 2017 08:38:04 +0000 (09:38 +0100)
committerMark Wooding <mdw@distorted.org.uk>
Thu, 28 Jun 2018 23:25:20 +0000 (00:25 +0100)
It wasn't supposed to be a secret.

pathmtu/pathmtu.1.in
pathmtu/pathmtu.c

index 942c6b1..03cd533 100644 (file)
@@ -37,6 +37,7 @@ pathmtu \- discover path MTU to a given host
 .SH "SYNOPSIS"
 .
 .B pathmtu
+.RB [ \-v ]
 .RB [ \-H
 .IR header ]
 .RB [ \-m
@@ -156,6 +157,12 @@ assumes that the timeout means that the remote host
 .I did
 receive the packet.  The default timeout is 8 seconds.
 .TP
+.B "\-v, \-\-verbose"
+Write a running human-readable commentary to standard error about the
+progress of the operation.  Usually,
+.B pathmtu
+does its job silently unless there are errors.
+.TP
 .BI "\-H, \-\-header=" header
 Sets the packet header, in hexadecimal.  If you set an explicit port
 number, it may be worth setting the packet header too, so as not to
index 7c4f1d8..6d98803 100644 (file)
@@ -695,7 +695,7 @@ static void version(FILE *fp)
 
 static void usage(FILE *fp)
 {
-  pquis(fp, "Usage: $ [-H HEADER] [-m METHOD]\n\
+  pquis(fp, "Usage: $ [-v] [-H HEADER] [-m METHOD]\n\
         [-r SECS] [-g FACTOR] [-t SECS] HOST [PORT]\n");
 }
 
@@ -718,6 +718,7 @@ Options in full:\n\
 -m, --method=METHOD    Use METHOD to probe for MTU.\n\
 -r, --retransmit=SECS  Retransmit if no reply after SEC.\n\
 -t, --timeout=SECS     Give up expecting a reply after SECS.\n\
+-v, --verbose          Write a running commentary to stderr.\n\
 -H, --header=HEX       Packet header, in hexadecimal.\n\
 \n\
 Probe methods:\n\