Node:Argp User Customization, Previous:Argp Examples, Up:Argp



Argp User Customization

The way formatting of argp --help output may be controlled to some extent by a program's users, by setting the ARGP_HELP_FMT environment variable to a comma-separated list (whitespace is ignored) of the following tokens:

dup-args
no-dup-args
Turn duplicate-argument-mode on or off. In duplicate argument mode, if an option which accepts an argument has multiple names, the argument is shown for each name; otherwise, it is only shown for the first long option, and a note is emitted later so the user knows that it applies to the other names as well. The default is no-dup-args, which is less consistent, but prettier.
dup-args-note
no-dup-args-note
Enable or disable the note informing the user of suppressed option argument duplication. The default is dup-args-note.
short-opt-col=n
Show the first short option in column n (default 2).
long-opt-col=n
Show the first long option in column n (default 6).
doc-opt-col=n
Show `documentation options' (see Argp Option Flags) in column n (default 2).
opt-doc-col=n
Show the documentation for options starting in column n (default 29).
header-col=n
Indent group headers (which document groups of options) to column n (default 1).
usage-indent=n
Indent continuation lines in Usage: messages to column n (default 12).
rmargin=n
Word wrap help output at or before column n (default 79).