mirrors/pv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Restructure and reformat the manual to be more in line with man-pages(7), with some small wording changes; move -8 and -k to the modifiers section rather than display switches; adjust "--help" output to report the options in the same order the manual lists them.

Browse Source
This commit is contained in:
Andrew Wood
2024-12-02 00:02:18 +00:00
parent c08349517b
commit d7d87fed76
3 changed files with 959 additions and 1194 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/pv.1
+428 -652
View File
File diff suppressed because it is too large Load Diff
docs/pv.1.md
+519 -528
View File
File diff suppressed because it is too large Load Diff
src/main/help.c
+12 -14
View File
@@ -298,18 +298,9 @@ void display_help(void)
{ "-a", "--average-rate", NULL,
N_("show data transfer average rate counter"),
{ 0, 0, 0, 0} },
{ "-m", "--average-rate-window", N_("SEC"),
N_("compute average rate over past SEC seconds (default 30s)"),
{ 0, 0, 0, 0} },
{ "-b", "--bytes", NULL,
N_("show number of bytes transferred"),
{ 0, 0, 0, 0} },
{ "-8", "--bits", NULL,
N_("show number of bits transferred"),
{ 0, 0, 0, 0} },
{ "-k", "--si", NULL,
N_("treat suffixes as multiples of 1000 rather than 1024"),
{ 0, 0, 0, 0} },
{ "-T", "--buffer-percent", NULL,
N_("show percentage of transfer buffer in use"),
{ 0, 0, 0, 0} },
@@ -332,6 +323,12 @@ void display_help(void)
N_("do not output any transfer information at all"),
{ 0, 0, 0, 0} },
{ "", NULL, NULL, NULL, { 0, 0, 0, 0} },
{ "-8", "--bits", NULL,
N_("show number of bits transferred"),
{ 0, 0, 0, 0} },
{ "-k", "--si", NULL,
N_("treat suffixes as multiples of 1000 rather than 1024"),
{ 0, 0, 0, 0} },
{ "-W", "--wait", NULL,
N_("display nothing until first byte transferred"),
{ 0, 0, 0, 0} },
@@ -353,6 +350,9 @@ void display_help(void)
{ "-i", "--interval", N_("SEC"),
N_("update every SEC seconds"),
{ 0, 0, 0, 0} },
{ "-m", "--average-rate-window", N_("SEC"),
N_("compute average rate over past SEC seconds (default 30s)"),
{ 0, 0, 0, 0} },
{ "-w", "--width", N_("WIDTH"),
N_("assume terminal is WIDTH characters wide"),
{ 0, 0, 0, 0} },
@@ -402,6 +402,9 @@ void display_help(void)
{ "-U", "--store-and-forward", N_("FILE"),
N_("write all input to FILE before writing to output"),
{ 0, 0, 0, 0} },
{ "-d", "--watchfd", N_("PID[:FD]"),
N_("watch file FD opened by process PID"),
{ 0, 0, 0, 0} },
#ifdef SIGINFO_PROVIDES_PID
{ "-R", "--remote", N_("PID"),
N_("update settings of process PID"),
@@ -411,11 +414,6 @@ void display_help(void)
{ "-P", "--pidfile", N_("FILE"),
N_("save process ID in FILE"),
{ 0, 0, 0, 0} },
{ "", NULL, NULL, NULL, { 0, 0, 0, 0} },
{ "-d", "--watchfd", N_("PID[:FD]"),
N_("watch file FD opened by process PID"),
{ 0, 0, 0, 0} },
{ "", NULL, NULL, NULL, { 0, 0, 0, 0} },
{ "-h", "--help", NULL,
N_("show this help and exit"),
{ 0, 0, 0, 0} },