[texdoc] --help tweaks
mpg at elzevir.fr
Sat Mar 7 00:04:32 CET 2009
Karl Berry a écrit :
> I suggest that the --help message have an extra line saying what the
> program does. Also, I don't think it's worth the text to bother listing
> the help/version/files options in the synopsis. Suggestion:
> Usage: texdoc [OPTION]... [NAME]...
> texdoc tries to find appropriate TeX documentation for the specified NAME(s).
> With no NAME, it can print configuration information (-f, --files);
> the usual --help and --version options are also accepted.
Sounds good to me.
I'd like to add some indication that you can sometimes use [NAME]-[suffix] to
disambiguate. Eg, <engine>-ref show the reference manual (for <engine> in (etex,
pdftex, luatex and soon xetex). As soon as I'll have time do straighten out the
man stuff, <engine>-man will be for the man page (fwiw).
Of course there is nothing systematic now, but the few existing aliases might be
helpful, and are probably not advertised enough.
> -h, --help ... [I suggest indenting by two spaces to minimize space used]
> And finally, I suggest ending like this (minimizing line breaks):
IIRC, the indentation and lines break are here to make help2man happy. I'll see
what I can do on this side (suggestions welcome).
More information about the texdoc