[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
These option attributes do not fit well with other categories.
TEMPL_DIRS
is a settable option for AutoGen, so a macro named
SET_OPT_TEMPL_DIRS(a)
appears in the interface file. This
attribute interacts with the documentation attribute.
For an option equivalence class, there is a single occurrence counter for all the members of the class. All members of the equivalence class must contain the same equivalenced-to option, including the equivalenced-to option itself. Thus, it must be a member. Such options may not be preset (be set from `rc' files or environment variables) and always conflict with each other (two members of the same equivalence class may not appear together).
Also, please take careful note: since the options are mapped to the equivalenced-to option descriptor, any option argument values are mapped to that descriptor also. Be sure you know which "equivalent option" was selected before getting the option argument value!
As an example, cpio(1)
has three options -o
, -i
,
and -p
that define the operational mode of the program
(create
, extract
and pass-through
, respectively).
They form an equivalence class from which one and only one member must
appear on the command line. If cpio
were an AutoOpt-ed program,
then each of these option definitions would contain:
equivalence = create; |
and the program would be able to determine the operating mode with code that worked something like this:
switch (WHICH_IDX_CREATE) { case INDEX_OPT_CREATE: ... case INDEX_OPT_EXTRACT: ... case INDEX_OPT_PASS_THROUGH: ... default: /* cannot happen */ } |
If present, this option disables all other attributes except settable
,
call-proc
and flag_-ode
. settable
must be and is only
specified if call-proc
, extract-code
or flag-code
has
been specified. When present, the descrip
attribute will be displayed
only when the --help
option has been specified. It will be displayed
flush to the left hand margin and may consist of one or more lines of text.
The name of the option will not be printed.
Documentation options are for clarifying the usage text and will not appear in generated man pages or in the generated invoking texinfo doc.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |