suggestion for superformat usage message

Jochen Voss jvoss at rhrk.uni-kl.de
Tue Jun 4 18:39:22 CEST 2002


Hallo Alain,

some user of the Debian version of superformat noted
the following inconsistency: most programs include
a synopsis line in the output of the --help option.
Examples:

    voss at automatix [~] ls --help | head
    Usage: ls [OPTION]... [FILE]...
    List information about the FILEs (the current directory by default).
    Sort entries alphabetically if none of -cftuSUX nor --sort.

      -a, --all                  do not hide entries starting with .
      -A, --almost-all           do not list implied . and ..
      -b, --escape               print octal escapes for nongraphic characters
	  --block-size=SIZE      use SIZE-byte blocks
      -B, --ignore-backups       do not list implied entries ending with ~
      -c                         with -lt: sort by, and show, ctime (time of last
    voss at automatix [~] grep --help | head
    Usage: grep [OPTION]... PATTERN [FILE] ...
    Search for PATTERN in each FILE or standard input.
    Example: grep -i 'hello world' menu.h main.c

    Regexp selection and interpretation:
      -E, --extended-regexp     PATTERN is an extended regular expression
      -F, --fixed-strings       PATTERN is a set of newline-separated strings
      -G, --basic-regexp        PATTERN is a basic regular expression
      -e, --regexp=PATTERN      use PATTERN as a regular expression
      -f, --file=FILE           obtain PATTERN from FILE

Superformat does not follow this convention.

    voss at automatix [~] superformat --help | head
    -D --dosdrive       set the dos drive
    -v --verbosity      set verbosity level
    -f --noverify       skip verification
    -B --dosverify      verify disk using mbadblocks
    -V --verify_later   verify floppy after all formatting is done
    -b --begin_cylinder set cylinder where to begin formatting
    -e --end_cylinder   set cylinder where to end formatting
    -G --fmt_gap        set the formatting gap
    -F --final_gap      set the final gap
    -i --interleave     set the interleave factor

Maybe you could add an additional line to the
"superformat --help" output, to make it more friedly.

I hope this helps,

Jochen

PS: If you answer to this mail, the Debian bug tracking system would
be glad to receive a copy (via Cc:) of your mail to the address
88297-forwarded at bugs.debian.org.
-- 
http://www.mathematik.uni-kl.de/~wwwstoch/voss/



More information about the Fdutils mailing list