From a8f70fe1a943bd72234d399b8527ab4216259625 Mon Sep 17 00:00:00 2001 Message-Id: From: Mark Wooding Date: Thu, 14 Sep 2017 09:38:04 +0100 Subject: [PATCH] pathmtu/pathmtu.c: Document the `--verbose' option. Organization: Straylight/Edgeware From: Mark Wooding It wasn't supposed to be a secret. --- pathmtu/pathmtu.1.in | 7 +++++++ pathmtu/pathmtu.c | 3 ++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/pathmtu/pathmtu.1.in b/pathmtu/pathmtu.1.in index 942c6b1e..03cd5331 100644 --- a/pathmtu/pathmtu.1.in +++ b/pathmtu/pathmtu.1.in @@ -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 diff --git a/pathmtu/pathmtu.c b/pathmtu/pathmtu.c index 7c4f1d8d..6d988031 100644 --- a/pathmtu/pathmtu.c +++ b/pathmtu/pathmtu.c @@ -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\ -- [mdw]