From 763e85820b91f11cac8930a6613b6da334755830 Mon Sep 17 00:00:00 2001 From: Elliott Hughes Date: Sat, 1 Feb 2020 22:09:49 -0800 Subject: Canonicalize the usage: lines for the POSIX toys. This only touches 24 of the 68 toys/posix/ files --- the others were already canonical. Potentially contentious, so worth stating explicitly, is that there were 8 matches for "COMMAND..." amongst all existing help output, with 7 matches for various inconsistent variants involving something with "ARG", so I resolved that in favor of using "COMMAND..." (which is also shorter overall, and avoids nested []s). --- toys/posix/cal.c | 2 +- toys/posix/cat.c | 4 ++-- toys/posix/chgrp.c | 2 +- toys/posix/cksum.c | 2 +- toys/posix/df.c | 2 +- toys/posix/du.c | 2 +- toys/posix/echo.c | 2 +- toys/posix/env.c | 2 +- toys/posix/file.c | 2 +- toys/posix/head.c | 2 +- toys/posix/kill.c | 2 +- toys/posix/logger.c | 2 +- toys/posix/ls.c | 2 +- toys/posix/mkdir.c | 2 +- toys/posix/nice.c | 2 +- toys/posix/nohup.c | 2 +- toys/posix/patch.c | 2 +- toys/posix/renice.c | 2 +- toys/posix/rmdir.c | 2 +- toys/posix/tar.c | 2 +- toys/posix/tee.c | 2 +- toys/posix/time.c | 2 +- toys/posix/uniq.c | 2 +- toys/posix/uuencode.c | 4 ++-- 24 files changed, 26 insertions(+), 26 deletions(-) diff --git a/toys/posix/cal.c b/toys/posix/cal.c index aaed5933..33b15a17 100644 --- a/toys/posix/cal.c +++ b/toys/posix/cal.c @@ -10,7 +10,7 @@ config CAL bool "cal" default y help - usage: cal [[month] year] + usage: cal [[MONTH] YEAR] Print a calendar. diff --git a/toys/posix/cat.c b/toys/posix/cat.c index a0e2d56b..6daba7a2 100644 --- a/toys/posix/cat.c +++ b/toys/posix/cat.c @@ -14,7 +14,7 @@ config CAT bool "cat" default y help - usage: cat [-u] [file...] + usage: cat [-u] [FILE...] Copy (concatenate) files to stdout. If no files listed, copy from stdin. Filename "-" is a synonym for stdin. @@ -37,7 +37,7 @@ config CATV bool "catv" default y help - usage: catv [-evt] [filename...] + usage: catv [-evt] [FILE...] Display nonprinting characters as escape sequences. Use M-x for high ascii characters (>127), and ^x for other nonprinting chars. diff --git a/toys/posix/chgrp.c b/toys/posix/chgrp.c index 8c2e95b4..20a2e0e7 100644 --- a/toys/posix/chgrp.c +++ b/toys/posix/chgrp.c @@ -12,7 +12,7 @@ config CHGRP bool "chgrp" default y help - usage: chgrp/chown [-RHLP] [-fvh] group file... + usage: chgrp/chown [-RHLP] [-fvh] GROUP FILE... Change group of one or more files. diff --git a/toys/posix/cksum.c b/toys/posix/cksum.c index ee7c6f54..6e5b915c 100644 --- a/toys/posix/cksum.c +++ b/toys/posix/cksum.c @@ -11,7 +11,7 @@ config CKSUM bool "cksum" default y help - usage: cksum [-IPLN] [file...] + usage: cksum [-IPLN] [FILE...] For each file, output crc32 checksum value, length and name of file. If no files listed, copy from stdin. Filename "-" is a synonym for stdin. diff --git a/toys/posix/df.c b/toys/posix/df.c index a6beda18..a93a762c 100644 --- a/toys/posix/df.c +++ b/toys/posix/df.c @@ -10,7 +10,7 @@ config DF bool "df" default y help - usage: df [-HPkhi] [-t type] [FILESYSTEM ...] + usage: df [-HPkhi] [-t type] [FILE...] The "disk free" command shows total/used/available disk space for each filesystem listed on the command line, or all currently mounted diff --git a/toys/posix/du.c b/toys/posix/du.c index 4c3867b2..e7334d1a 100644 --- a/toys/posix/du.c +++ b/toys/posix/du.c @@ -12,7 +12,7 @@ config DU bool "du" default y help - usage: du [-d N] [-askxHLlmc] [file...] + usage: du [-d N] [-askxHLlmc] [FILE...] Show disk usage, space consumed by files and directories. diff --git a/toys/posix/echo.c b/toys/posix/echo.c index 70f4ce5e..c78c2c01 100644 --- a/toys/posix/echo.c +++ b/toys/posix/echo.c @@ -15,7 +15,7 @@ config ECHO bool "echo" default y help - usage: echo [-neE] [args...] + usage: echo [-neE] [ARG...] Write each argument to stdout, with one space between each, followed by a newline. diff --git a/toys/posix/env.c b/toys/posix/env.c index 19cd18a0..73c8951a 100644 --- a/toys/posix/env.c +++ b/toys/posix/env.c @@ -12,7 +12,7 @@ config ENV bool "env" default y help - usage: env [-i] [-u NAME] [NAME=VALUE...] [COMMAND [ARG...]] + usage: env [-i] [-u NAME] [NAME=VALUE...] [COMMAND...] Set the environment for command invocation, or list environment variables. diff --git a/toys/posix/file.c b/toys/posix/file.c index f2cd3af8..4e84e1d4 100644 --- a/toys/posix/file.c +++ b/toys/posix/file.c @@ -10,7 +10,7 @@ config FILE bool "file" default y help - usage: file [-bhLs] [file...] + usage: file [-bhLs] [FILE...] Examine the given files and describe their content types. diff --git a/toys/posix/head.c b/toys/posix/head.c index ab8467e4..d5c0700c 100644 --- a/toys/posix/head.c +++ b/toys/posix/head.c @@ -12,7 +12,7 @@ config HEAD bool "head" default y help - usage: head [-n number] [file...] + usage: head [-n NUM] [FILE...] Copy first lines from files to stdout. If no files listed, copy from stdin. Filename "-" is a synonym for stdin. diff --git a/toys/posix/kill.c b/toys/posix/kill.c index 3c129b04..27676593 100644 --- a/toys/posix/kill.c +++ b/toys/posix/kill.c @@ -18,7 +18,7 @@ config KILL bool "kill" default y help - usage: kill [-l [SIGNAL] | -s SIGNAL | -SIGNAL] pid... + usage: kill [-l [SIGNAL] | -s SIGNAL | -SIGNAL] PID... Send signal to process(es). diff --git a/toys/posix/logger.c b/toys/posix/logger.c index bae07b4d..3bcfb174 100644 --- a/toys/posix/logger.c +++ b/toys/posix/logger.c @@ -12,7 +12,7 @@ config LOGGER bool "logger" default y help - usage: logger [-s] [-t TAG] [-p [FACILITY.]PRIORITY] [message...] + usage: logger [-s] [-t TAG] [-p [FACILITY.]PRIORITY] [MESSAGE...] Log message (or stdin) to syslog. diff --git a/toys/posix/ls.c b/toys/posix/ls.c index 9b382590..dda82d40 100644 --- a/toys/posix/ls.c +++ b/toys/posix/ls.c @@ -18,7 +18,7 @@ config LS bool "ls" default y help - usage: ls [-ACFHLRSZacdfhiklmnpqrstuwx1] [--color[=auto]] [directory...] + usage: ls [-ACFHLRSZacdfhiklmnpqrstuwx1] [--color[=auto]] [FILE...] List files. diff --git a/toys/posix/mkdir.c b/toys/posix/mkdir.c index 770300d4..932635a6 100644 --- a/toys/posix/mkdir.c +++ b/toys/posix/mkdir.c @@ -10,7 +10,7 @@ config MKDIR bool "mkdir" default y help - usage: mkdir [-vp] [-m mode] [dirname...] + usage: mkdir [-vp] [-m MODE] [DIR...] Create one or more directories. diff --git a/toys/posix/nice.c b/toys/posix/nice.c index c26f66d3..1803e611 100644 --- a/toys/posix/nice.c +++ b/toys/posix/nice.c @@ -10,7 +10,7 @@ config NICE bool "nice" default y help - usage: nice [-n PRIORITY] COMMAND [ARG...] + usage: nice [-n PRIORITY] COMMAND... Run a command line at an increased or decreased scheduling priority. diff --git a/toys/posix/nohup.c b/toys/posix/nohup.c index e5b526f7..90d374ef 100644 --- a/toys/posix/nohup.c +++ b/toys/posix/nohup.c @@ -10,7 +10,7 @@ config NOHUP bool "nohup" default y help - usage: nohup COMMAND [ARG...] + usage: nohup COMMAND... Run a command that survives the end of its terminal. diff --git a/toys/posix/patch.c b/toys/posix/patch.c index 3a708a71..f26e0d70 100644 --- a/toys/posix/patch.c +++ b/toys/posix/patch.c @@ -21,7 +21,7 @@ config PATCH bool "patch" default y help - usage: patch [-d DIR] [-i PATCH] [-p depth] [-F FUZZ] [-Rlsu] [--dry-run] [FILE [PATCH]] + usage: patch [-d DIR] [-i PATCH] [-p DEPTH] [-F FUZZ] [-Rlsu] [--dry-run] [FILE [PATCH]] Apply a unified diff to one or more files. diff --git a/toys/posix/renice.c b/toys/posix/renice.c index c1167c8c..4736d4ea 100644 --- a/toys/posix/renice.c +++ b/toys/posix/renice.c @@ -10,7 +10,7 @@ config RENICE bool "renice" default y help - usage: renice [-gpu] -n increment ID ... + usage: renice [-gpu] -n INCREMENT ID... */ #define FOR_renice diff --git a/toys/posix/rmdir.c b/toys/posix/rmdir.c index d04cf0d9..3bece15f 100644 --- a/toys/posix/rmdir.c +++ b/toys/posix/rmdir.c @@ -10,7 +10,7 @@ config RMDIR bool "rmdir" default y help - usage: rmdir [-p] [dirname...] + usage: rmdir [-p] [DIR...] Remove one or more directories. diff --git a/toys/posix/tar.c b/toys/posix/tar.c index b214b44c..1ac9400a 100644 --- a/toys/posix/tar.c +++ b/toys/posix/tar.c @@ -23,7 +23,7 @@ config TAR bool "tar" default y help - usage: tar [-cxt] [-fvohmjkOS] [-XTCf NAME] [FILES] + usage: tar [-cxt] [-fvohmjkOS] [-XTCf NAME] [FILE...] Create, extract, or list files in a .tar (or compressed t?z) file. diff --git a/toys/posix/tee.c b/toys/posix/tee.c index ff8a29dc..43529426 100644 --- a/toys/posix/tee.c +++ b/toys/posix/tee.c @@ -10,7 +10,7 @@ config TEE bool "tee" default y help - usage: tee [-ai] [file...] + usage: tee [-ai] [FILE...] Copy stdin to each listed file, and also to stdout. Filename "-" is a synonym for stdout. diff --git a/toys/posix/time.c b/toys/posix/time.c index 3d7d2ba7..d99d2db5 100644 --- a/toys/posix/time.c +++ b/toys/posix/time.c @@ -11,7 +11,7 @@ config TIME default y depends on TOYBOX_FLOAT help - usage: time [-pv] COMMAND [ARGS...] + usage: time [-pv] COMMAND... Run command line and report real, user, and system time elapsed in seconds. (real = clock on the wall, user = cpu used by command's code, diff --git a/toys/posix/uniq.c b/toys/posix/uniq.c index 0ca01783..3091af72 100644 --- a/toys/posix/uniq.c +++ b/toys/posix/uniq.c @@ -10,7 +10,7 @@ config UNIQ bool "uniq" default y help - usage: uniq [-cduiz] [-w maxchars] [-f fields] [-s char] [input_file [output_file]] + usage: uniq [-cduiz] [-w MAXCHARS] [-f FIELDS] [-s CHAR] [INFILE [OUTFILE]] Report or filter out repeated lines in a file diff --git a/toys/posix/uuencode.c b/toys/posix/uuencode.c index 44e38bcb..160954d8 100644 --- a/toys/posix/uuencode.c +++ b/toys/posix/uuencode.c @@ -10,9 +10,9 @@ config UUENCODE bool "uuencode" default y help - usage: uuencode [-m] [file] encode-filename + usage: uuencode [-m] [INFILE] ENCODE_FILENAME - Uuencode stdin (or file) to stdout, with encode-filename in the output. + Uuencode stdin (or INFILE) to stdout, with ENCODE_FILENAME in the output. -m Base64 */ -- cgit v1.2.3