| Name : perl-Getopt-Mixed-Help
| |
| Version : 0.26
| Vendor : obs://build_opensuse_org/devel:languages:perl
|
| Release : 6.69
| Date : 2024-08-05 18:13:03
|
| Group : Development/Libraries/Perl
| Source RPM : perl-Getopt-Mixed-Help-0.26-6.69.src.rpm
|
| Size : 0.04 MB
| |
| Packager : (none)
| |
| Summary : combine L< < C< Getopt::Mixed> >> with usage and help
|
Description :
The module uses a direct import mechanism called with a hash as parameter.
The structure of the hash is as follows:
The key is a combined (SHORT > LONG [ARGUMENT SPECIFIER [VALUE
IDENTIFIER]]) option description for the outdated module the
\'Getopt::Mixed\' manpage, except for the VALUE IDENTIFIER which is simply
included into the help text. The value following the key is simply the help
text for this option. The examples should make everything clear even if you
are not familiar with the \'Getopt::Mixed\' manpage.
If the second character of the first key is not \'>\', the first key is taken
as descriptive identifiers for additional parameters and the help for them.
Any key starting with \'(\' and ending with \')\' will be interpreted as a
footnote (additional help text) to the real options. They should be used at
the end of the list only.
A key equal to \'ENV\' is used to get default values for the remaining
options from the environment. For any option not initialised on the command
line an environment variable with the prefix of the value following \'ENV\'
and a rest of the name identical to the uppercase long option name (e.g.
\'SCRIPT_OPT_DEBUG\') will be checked. If this environment variable exists,
it will be used to set the option. Note that in the name of the rest of the
environment variable uppercase is used and hyphens are relaced with
underlines.
A key equal to \'ENV_\' is used in the same way as the key \'ENV\'. In addition
it allows for a special environment variable with the prefix of the value
following \'ENV\' followed by a single underline (\'_\') as combined
initialiser (for more than one option, e.g. \'export SCRIPT_OPT__=\'debug
verbose=2\'\'). Note that no whitespaces are allowed in the values of the
options initialised this way as the string in the environment variable is
parsed in a simple way.
The module defines the variable $optUsage containing the complete help
text.
If an option \'debug\' exists and is choosen on the command line, this module
will print all option values and all remaining parameters to standard
error. The name of this option may be changed, see \'\"changing the debug
option\"\' below in the the /\"CHANGING DEFAULT BEHAVIOUR\" manpage section.
Perl constants with the prefix \'DEBUG_\' and a name matching the option are
used as default values for the options, see below for details.
|
RPM found in directory: /packages/linux-pbone/ftp5.gwdg.de/pub/opensuse/repositories/devel:/languages:/perl:/CPAN-G/openSUSE_Tumbleweed/noarch |
