::clig::String - declare an option with parameters of type string

package require clig
namespace import ::clig::*
setSpec db

String -opt varname usage [-c min max] {[-d default ...] | [-m]}

The String command declares -opt to have zero or more string arguments.

varname

declares that arguments found for -opt are passed to the caller of the parser in a variable (tcl) or slot (C) of that name.

usage

is a short text describing -opt. It is used in the generated manual or in a usage-message printed by the parser if necessary.

-c

specifies the minimum and maximum number of parameters -opt may have. If less than min or more than max are found, the parser prints an error message to stderr and terminates the calling process. Use min==max to request exactly so many arguments. As a special value for max, oo is understood as positive infinity.

-d

stores a (list of) default value(s) for option -opt. The parser pretends these were found on the command line, if option -opt is not given.

WARNING: The number of default values is not checked against the minimum and maximum values given for -c.

-m

declares that -opt is mandatory. Put another way, the ``option'' is not really optional but must show up on the command line. If it does not, the parser prints an error message to stderr and exits the calling process. This can not be used together with -d.

tcl

C

clig(1), clig_Commandline(7), clig_Description(7), clig_Double(7), clig_Flag(7), clig_Float(7), clig_Int(7), clig_Long(7), clig_Name(7), clig_Rest(7), clig_Usage(7), clig_Version(7), clig_parseCmdline(7)