[texdoc] help msg

Manuel Pégourié-Gonnard mpg at elzevir.fr
Mon Feb 22 11:13:00 CET 2010

Karl Berry a écrit :
> 1) --help says:
>   -a, --alias           Use the alias table.
>   -A, --noalias         Don't use the alias table.
> It should say (default) on the -a line.
> Ditto for whichever of -i/-I is the default.
Right, I'll add it. OTOH, if you have 'interact_switch = false' in your config
file, should it try to display (default) on the -I line or just keep the "real"

> 2) it is standard for the --help message to have --help and --verbose in
> the list.

Do you mean --version or actually --verbose?

> 2b) I'd also suggest a blank line before/after the option list,
> 2c) and putting the synopsis after the usage: line.
> 2d) It's conventional not to pluralize "OPTION" with the ... (NAME was
> not plural).
> 2e) please state the default mode of operation.  (I'm not actually sure
>     what it is.)
Ok. Currently, I tried hard to have the --help output fit on a "standard" 24
lines high terminal, but maybe it's not as important as being readable
(concerning the blank line).

By the way, to you think I should still display the deprecated options in the
list? (Currently, using a deprecated option works but issues a big fat warning.)

> Something like:
> Usage: texdoc [OPTION]... [NAME]...
> Try to find appropriate TeX documentation for the specified NAME(s).
> The default is view mode to display the documentation.
> With no NAME, it can print configuration information (-f, --files);
> the usual --help and --version options are also accepted.
>   -w, --view            Use view mode: start a viewer.
> [...]
>   -M, --machine         Use a more machine-friendly output format.
>   -f, --files           Print the name of the config files being used.
>   -h, --help            Display this help and exit.
>       --version         Display version information and exit.
> Files: <texmf>/texdoc/texdoc.cnf files; see the -f option.
> Home page: http://tug.org/texdoc/
> Manual: displayed by `texdoc texdoc'.
Ok. I'll probably need to hack again to get the output accepted by help2man, but

Thanks for your suggestions,

More information about the texdoc mailing list