Revision [1325]
This is an old revision of CommandXgetopts made by DavidLee on 2010-03-23 08:04:06.
Command xgetopts
Name
xgetopts parses command line optionsSynopsis
xgetopts [options] [--] argsDescription
xgetopts runs the internal shell command option processor (Options) and omits the result as an XML document.
This is useful to be able to parse arguments from within shell scripts in a form similar to internal commands.
Options
| a,argindex | Exit with argument index |
| o,optdef optstring | Option string |
| c,command cmdname | Command name |
| p,passthrough optstring | pass through options |
| [+]s,serialize | Add (+ do not add) standard serialization options to optstring |
| [+]ps=pass-serialize | Add (+ do not add) standard serialization options to passthrough |
| noargs | Do no output additional arguments |
| novalues | Do not output argument values |
optstring A string containing the allowed options seperated by "," described below
args 0 or more arguments to be parsed using the optstring, typically $*
optstring
optstring is a single string describing the available options. It take the form of option_def "," option_def ...
Each "option_def" is the option name, optionally followed by "=longname" optionally followed by ":" or ":+".
If "=longname" is used then "longname" is an alias for the option.
If the option is followed by ":" the the option requires a value which is taken from the next argument.
If the option is followed by ":+" then the option can be specified multiple times and a list of values is produced.
If no -o or -p is given then the first argument is the optstring.
If -p is specified then an additional optstring (which should be a subset of the main optstring) is used as a "pass through". All arguments which match the passthrough optstring are serialized as is and remaining arguments are ignored. This is useful for a command to 'pass through' known arguments to another command.
if -novalues is specified then the character content of values are not output. This is useful for parameters which are not serializable or may be very large.
if -noargs is specified then the args element is omitted.
Examples
Example
xgetopts "a=all,b:,c:+" -all -c c1 -c c2 arg1 arg2
Result
<xgetopts> <options> <option name="a"/> <option name="c"> <value>c1</value> <value>c2</value> </option> </options> <args> <arg>arg1</arg> <arg>arg2</arg> </args> </xgetopts>
Commands
CategoryCommands
