hwclock: when cutting up help texts anyway, do it into small chunks

Also do it at sensible boundaries, improve some of the wording, and
indent continuation lines for clarity.  Also document -V instead of
-v for --version, to conform to the majority of utilities.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>

diff --git a/hwclock/hwclock.c b/hwclock/hwclock.c
index 021e5ac38fc4ea2143cb3f864dca01bc0d18746e..7bcb20c4d5bb9e84642191a283343891e1e11320 100644 (file)
--- a/hwclock/hwclock.c
+++ b/hwclock/hwclock.c
@@ -1372,26 +1372,30 @@ static void usage(const char *fmt, ...)
        usageto = fmt ? stderr : stdout;
 
        fprintf(usageto,
-               _("hwclock - query and set the hardware clock (RTC)\n\n"
-                 "Usage: hwclock [function] [options...]\n\n" "Functions:\n"
-                 "  -h | --help         show this help\n"
+               _("Usage: hwclock [function] [option...]\n\n"
+                 "Query or set the hardware clock (the RTC).\n\n"));
+       fprintf(usageto,
+               _( "Functions:\n"
+                 "  -h | --help         show this help text and exit\n"
                  "  -r | --show         read hardware clock and print result\n"
-                 "       --set          set the rtc to the time given with --date\n"
-                 "  -s | --hctosys      set the system time from the hardware clock\n"
-                 "  -w | --systohc      set the hardware clock to the current system time\n"
+                 "       --set          set the RTC to the time given with --date\n"));
+       fprintf(usageto,
+               _("  -s | --hctosys      set the system time from the hardware clock\n"
+                 "  -w | --systohc      set the hardware clock from the current system time\n"
                  "       --systz        set the system time based on the current timezone\n"
-                 "       --adjust       adjust the rtc to account for systematic drift since\n"
-                 "                      the clock was last set or adjusted\n"));
+                 "       --adjust       adjust the RTC to account for systematic drift since\n"
+                 "                        the clock was last set or adjusted\n"));
 #ifdef __linux__
        fprintf(usageto,
                _("       --getepoch     print out the kernel's hardware clock epoch value\n"
                  "       --setepoch     set the kernel's hardware clock epoch value to the \n"
-                 "                      value given with --epoch\n"));
+                 "                        value given with --epoch\n"));
 #endif
        fprintf(usageto,
-               _("       --predict      predict rtc reading at time given with --date\n"
-                 "  -v | --version      print out the version of hwclock to stdout\n"
-                 "\nOptions: \n"
+               _("       --predict      predict RTC reading at time given with --date\n"
+                 "  -V | --version      display version information and exit\n"));
+       fprintf(usageto,
+               _("\nOptions:\n"
                  "  -u | --utc          the hardware clock is kept in UTC\n"
                  "       --localtime    the hardware clock is kept in local time\n"));
 #ifdef __linux__
@@ -1400,22 +1404,22 @@ static void usage(const char *fmt, ...)
 #endif
        fprintf(usageto,
                _("       --directisa    access the ISA bus directly instead of %s\n"
-                 "       --badyear      ignore rtc's year because the bios is broken\n"
-                 "       --date         specifies the time to which to set the hardware clock\n"
-                 "       --epoch=year   specifies the year which is the beginning of the \n"
-                 "                      hardware clock's epoch value\n"
-                 "       --noadjfile    do not access %s. Requires the use of\n"
-                 "                      either --utc or --localtime\n"
-                 "       --adjfile=path specifies the path to the adjust file (default is\n"
-                 "                      %s)\n"
-                 "       --test         do everything except actually updating the hardware\n"
-                 "                      clock or anything else\n"
-                 "  -D | --debug        debug mode\n" "\n"), _PATH_RTC_DEV,
-                _PATH_ADJPATH, _PATH_ADJPATH);
+                 "       --badyear      ignore RTC's year because the BIOS is broken\n"
+                 "       --date=time    specifies the time to which to set the hardware clock\n"
+                 "       --epoch=year   specifies the year which is the beginning of the\n"
+                 "                        hardware clock's epoch value\n"), _PATH_RTC_DEV);
+       fprintf(usageto,
+               _("       --noadjfile    do not access %s; this requires the use of\n"
+                 "                        either --utc or --localtime\n"
+                 "       --adjfile=path specifies the path to the adjust file;\n"
+                 "                        the default is %s\n"), _PATH_ADJPATH, _PATH_ADJPATH);
+       fprintf(usageto,
+               _("       --test         do not update anything, just show what would happen\n"
+                 "  -D | --debug        debugging mode\n" "\n"));
 #ifdef __alpha__
        fprintf(usageto,
                _("  -J|--jensen, -A|--arc, -S|--srm, -F|--funky-toy\n"
-                 "       tell hwclock the type of alpha you have (see hwclock(8))\n"
+                 "       tell hwclock the type of Alpha you have (see hwclock(8))\n"
                  "\n"));
 #endif