doc: correct and normalize --help output of several tools
authorBenno Schulenberg <bensberg@justemail.net>
Mon, 4 Aug 2008 08:44:47 +0000 (10:44 +0200)
committerJim Meyering <meyering@redhat.com>
Mon, 4 Aug 2008 09:10:14 +0000 (11:10 +0200)
* src/chroot.c (usage): Add "[ARG]" to synopsis.
* src/cut.c (usage): Remove an inconsistent period in an option
description.
* src/du.c (usage): Remove superfluous argument after short option -X.
Also remove inconsistent uppercase and final period.
Use a single indent level for prettiness.
* src/shred.c (usage): Normalize the synopsis.
* src/stty.c (usage): Options -F and --file are alternatives, cannot
both be used.
* src/sum.c (usage): -r does not overrule -s; the last one counts.
* src/uptime.c (usage): Remove inconsistent space from the synopsis.
* src/users.c: Likewise.

src/chroot.c
src/cut.c
src/du.c
src/shred.c
src/stty.c
src/sum.c
src/uptime.c
src/users.c

index 399f76c..d55db6e 100644 (file)
@@ -41,7 +41,7 @@ usage (int status)
   else
     {
       printf (_("\
-Usage: %s NEWROOT [COMMAND...]\n\
+Usage: %s NEWROOT [COMMAND [ARG]...]\n\
   or:  %s OPTION\n\
 "), program_name, program_name);
       fputs (_("\
index 0e151fd..99d2eaa 100644 (file)
--- a/src/cut.c
+++ b/src/cut.c
@@ -210,7 +210,7 @@ Mandatory arguments to long options are mandatory for short options too.\n\
 "), stdout);
       fputs (_("\
       --complement        complement the set of selected bytes, characters\n\
-                            or fields.\n\
+                            or fields\n\
 "), stdout);
       fputs (_("\
   -s, --only-delimited    do not print lines not containing delimiters\n\
index ee24269..fafcea0 100644 (file)
--- a/src/du.c
+++ b/src/du.c
@@ -311,9 +311,9 @@ Mandatory arguments to long options are mandatory for short options too.\n\
   -s, --summarize       display only a total for each argument\n\
 "), stdout);
       fputs (_("\
-  -x, --one-file-system  skip directories on different file systems\n\
-  -X FILE, --exclude-from=FILE  Exclude files that match any pattern in FILE.\n\
-      --exclude=PATTERN  Exclude files that match PATTERN.\n\
+  -x, --one-file-system    skip directories on different file systems\n\
+  -X, --exclude-from=FILE  exclude files that match any pattern in FILE\n\
+      --exclude=PATTERN    exclude files that match PATTERN\n\
       --max-depth=N     print the total for a directory (or file, with --all)\n\
                           only if it is N or fewer levels below the command\n\
                           line argument;  --max-depth=0 is the same as\n\
index 9e82cf2..d766405 100644 (file)
@@ -155,7 +155,7 @@ usage (int status)
             program_name);
   else
     {
-      printf (_("Usage: %s [OPTIONS] FILE [...]\n"), program_name);
+      printf (_("Usage: %s [OPTION]... FILE...\n"), program_name);
       fputs (_("\
 Overwrite the specified FILE(s) repeatedly, in order to make it harder\n\
 for even very expensive hardware probing to recover the data.\n\
index 5ac2cc6..a70fd95 100644 (file)
@@ -504,9 +504,9 @@ usage (int status)
   else
     {
       printf (_("\
-Usage: %s [-F DEVICE] [--file=DEVICE] [SETTING]...\n\
-  or:  %s [-F DEVICE] [--file=DEVICE] [-a|--all]\n\
-  or:  %s [-F DEVICE] [--file=DEVICE] [-g|--save]\n\
+Usage: %s [-F DEVICE | --file=DEVICE] [SETTING]...\n\
+  or:  %s [-F DEVICE | --file=DEVICE] [-a|--all]\n\
+  or:  %s [-F DEVICE | --file=DEVICE] [-g|--save]\n\
 "),
              program_name, program_name, program_name);
       fputs (_("\
index 4dfc867..314656f 100644 (file)
--- a/src/sum.c
+++ b/src/sum.c
@@ -62,7 +62,7 @@ Usage: %s [OPTION]... [FILE]...\n\
       fputs (_("\
 Print checksum and block counts for each FILE.\n\
 \n\
-  -r              defeat -s, use BSD sum algorithm, use 1K blocks\n\
+  -r              use BSD sum algorithm, use 1K blocks\n\
   -s, --sysv      use System V sum algorithm, use 512 bytes blocks\n\
 "), stdout);
       fputs (HELP_OPTION_DESCRIPTION, stdout);
index 9e3384f..56ad861 100644 (file)
@@ -193,7 +193,7 @@ usage (int status)
             program_name);
   else
     {
-      printf (_("Usage: %s [OPTION]... [ FILE ]\n"), program_name);
+      printf (_("Usage: %s [OPTION]... [FILE]\n"), program_name);
       printf (_("\
 Print the current time, the length of time the system has been up,\n\
 the number of users on the system, and the average number of jobs\n\
index 551616e..19ffce8 100644 (file)
@@ -103,7 +103,7 @@ usage (int status)
             program_name);
   else
     {
-      printf (_("Usage: %s [OPTION]... [ FILE ]\n"), program_name);
+      printf (_("Usage: %s [OPTION]... [FILE]\n"), program_name);
       printf (_("\
 Output who is currently logged in according to FILE.\n\
 If FILE is not specified, use %s.  %s as FILE is common.\n\