From d588ba74439604cf29100aec7cd1da640a5d6fe5 Mon Sep 17 00:00:00 2001 From: Elliott Hughes Date: Sat, 2 Mar 2019 11:21:25 -0800 Subject: Improve help consistency. More consistent tense, capitalization, and punctuation. A few commands were missing an introductory line, so I copied those from the first comment line. --- toys/lsb/passwd.c | 4 ++-- toys/net/netcat.c | 2 ++ toys/other/blkid.c | 4 ++-- toys/other/hwclock.c | 2 ++ toys/other/i2ctools.c | 8 ++++---- toys/other/mkswap.c | 2 +- toys/other/pmap.c | 2 +- toys/other/reset.c | 2 +- toys/posix/comm.c | 2 +- toys/posix/cp.c | 2 +- toys/posix/cpio.c | 2 +- toys/posix/ls.c | 2 +- toys/posix/od.c | 2 ++ toys/posix/unlink.c | 2 +- 14 files changed, 22 insertions(+), 16 deletions(-) (limited to 'toys') diff --git a/toys/lsb/passwd.c b/toys/lsb/passwd.c index 73024832..8ff010e2 100644 --- a/toys/lsb/passwd.c +++ b/toys/lsb/passwd.c @@ -12,9 +12,9 @@ config PASSWD default y depends on TOYBOX_SHADOW help - usage: passwd [-a ALGO] [-dlu] + usage: passwd [-a ALGO] [-dlu] [USER] - update user's authentication tokens. Default : current user + Update user's authentication tokens. Defaults to current user. -a ALGO Encryption method (des, md5, sha256, sha512) default: des -d Set password to '' diff --git a/toys/net/netcat.c b/toys/net/netcat.c index 673d5d19..833d32ae 100644 --- a/toys/net/netcat.c +++ b/toys/net/netcat.c @@ -15,6 +15,8 @@ config NETCAT help usage: netcat [-46] [-u] [-wpq #] [-s addr] {IPADDR PORTNUM|-f FILENAME} + Forward stdin/stdout to a file or network connection. + -4 Force IPv4 -6 Force IPv6 -f Use FILENAME (ala /dev/ttyS0) instead of network diff --git a/toys/other/blkid.c b/toys/other/blkid.c index 98055b41..b791fa62 100644 --- a/toys/other/blkid.c +++ b/toys/other/blkid.c @@ -13,7 +13,7 @@ config BLKID help usage: blkid [-UL] DEV... - Prints type, label and UUID of filesystem on a block device or image. + Print type, label and UUID of filesystem on a block device or image. -U Show UUID only (or device with that UUID) -L Show LABEL only (or device with that LABEL) @@ -24,7 +24,7 @@ config FSTYPE help usage: fstype DEV... - Prints type of filesystem on a block device or image. + Print type of filesystem on a block device or image. */ #define FOR_blkid diff --git a/toys/other/hwclock.c b/toys/other/hwclock.c index 94877f9e..52e71604 100644 --- a/toys/other/hwclock.c +++ b/toys/other/hwclock.c @@ -12,6 +12,8 @@ config HWCLOCK help usage: hwclock [-rswtluf] + Get/set the hardware clock. + -f FILE Use specified device file instead of /dev/rtc (--rtc) -l Hardware clock uses localtime (--localtime) -r Show hardware clock time (--show) diff --git a/toys/other/i2ctools.c b/toys/other/i2ctools.c index 15578665..c9a11466 100644 --- a/toys/other/i2ctools.c +++ b/toys/other/i2ctools.c @@ -24,7 +24,7 @@ config I2CDETECT usage: i2cdetect -F BUS usage: i2cdetect -l - Detects i2c devices. + Detect i2c devices. -a All addresses (0x00-0x7f rather than 0x03-0x77) -F Show functionality @@ -38,7 +38,7 @@ config I2CDUMP help usage: i2cdump [-fy] BUS CHIP - Dumps i2c registers. + Dump i2c registers. -f Force access to busy devices -y Answer "yes" to confirmation prompts (for script use) @@ -49,7 +49,7 @@ config I2CGET help usage: i2cget [-fy] BUS CHIP ADDR - Reads an i2c register. + Read an i2c register. -f Force access to busy devices -y Answer "yes" to confirmation prompts (for script use) @@ -60,7 +60,7 @@ config I2CSET help usage: i2cset [-fy] BUS CHIP ADDR VALUE... MODE - Writes an i2c register. MODE is b for byte, w for 16-bit word, i for I2C block. + Write an i2c register. MODE is b for byte, w for 16-bit word, i for I2C block. -f Force access to busy devices -y Answer "yes" to confirmation prompts (for script use) diff --git a/toys/other/mkswap.c b/toys/other/mkswap.c index 49e0b942..3106ea8e 100644 --- a/toys/other/mkswap.c +++ b/toys/other/mkswap.c @@ -10,7 +10,7 @@ config MKSWAP help usage: mkswap [-L LABEL] DEVICE - Sets up a Linux swap area on a device or file. + Set up a Linux swap area on a device or file. */ #define FOR_mkswap diff --git a/toys/other/pmap.c b/toys/other/pmap.c index 1641c95c..02260dbd 100644 --- a/toys/other/pmap.c +++ b/toys/other/pmap.c @@ -13,7 +13,7 @@ config PMAP help usage: pmap [-xq] [pids...] - Reports the memory map of a process or processes. + Report the memory map of a process or processes. -x Show the extended format -q Do not display some header/footer lines diff --git a/toys/other/reset.c b/toys/other/reset.c index 5fc59706..4d16a4a3 100644 --- a/toys/other/reset.c +++ b/toys/other/reset.c @@ -12,7 +12,7 @@ config RESET help usage: reset - reset the terminal + Reset the terminal. */ #include "toys.h" diff --git a/toys/posix/comm.c b/toys/posix/comm.c index 33c056d3..c5c8f851 100644 --- a/toys/posix/comm.c +++ b/toys/posix/comm.c @@ -13,7 +13,7 @@ config COMM help usage: comm [-123] FILE1 FILE2 - Reads FILE1 and FILE2, which should be ordered, and produces three text + Read FILE1 and FILE2, which should be ordered, and produce three text columns as output: lines only in FILE1; lines only in FILE2; and lines in both files. Filename "-" is a synonym for stdin. diff --git a/toys/posix/cp.c b/toys/posix/cp.c index 5e1a0163..ddbfe125 100644 --- a/toys/posix/cp.c +++ b/toys/posix/cp.c @@ -66,7 +66,7 @@ config MV bool "mv" default y help - usage: mv [-fivn] SOURCE... DEST" + usage: mv [-fivn] SOURCE... DEST -f Force copy by deleting destination file -i Interactive, prompt before overwriting existing DEST diff --git a/toys/posix/cpio.c b/toys/posix/cpio.c index 80567fd6..97b4035f 100644 --- a/toys/posix/cpio.c +++ b/toys/posix/cpio.c @@ -25,7 +25,7 @@ config CPIO usage: cpio -{o|t|i|p DEST} [-v] [--verbose] [-F FILE] [--no-preserve-owner] [ignored: -mdu -H newc] - copy files into and out of a "newc" format cpio archive + Copy files into and out of a "newc" format cpio archive. -F FILE Use archive FILE instead of stdin/stdout -p DEST Copy-pass mode, copy stdin file list to directory DEST diff --git a/toys/posix/ls.c b/toys/posix/ls.c index d24168d6..287c3da6 100644 --- a/toys/posix/ls.c +++ b/toys/posix/ls.c @@ -20,7 +20,7 @@ config LS help usage: ls [-ACFHLRSZacdfhiklmnpqrstux1] [--color[=auto]] [directory...] - list files + List files. what to show: -a all files including .hidden -b escape nongraphic chars diff --git a/toys/posix/od.c b/toys/posix/od.c index f45c8654..f0edcd76 100644 --- a/toys/posix/od.c +++ b/toys/posix/od.c @@ -13,6 +13,8 @@ config OD help usage: od [-bcdosxv] [-j #] [-N #] [-w #] [-A doxn] [-t acdfoux[#]] + Dump data in octal/hex. + -A Address base (decimal, octal, hexadecimal, none) -j Skip this many bytes of input -N Stop dumping after this many bytes diff --git a/toys/posix/unlink.c b/toys/posix/unlink.c index 4faef9dc..f5faab06 100644 --- a/toys/posix/unlink.c +++ b/toys/posix/unlink.c @@ -12,7 +12,7 @@ config UNLINK help usage: unlink FILE - Deletes one file. + Delete one file. */ #include "toys.h" -- cgit v1.2.3