Differences between current version and previous revision of getopt(1).
Other diffs: Previous Major Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 3 | Last edited on Sunday, November 2, 2003 6:37:06 pm | by CraigBox | |
| Older page: | version 2 | Last edited on Sunday, November 2, 2003 6:36:31 pm | by CraigBox | Revert |
@@ -3,10 +3,10 @@
getopt - parse command options (enhanced)
!!SYNOPSIS
-__getopt__ optstring parameters
-__getopt__ [[options] [[__--__] optstring parameters
+__getopt__ optstring parameters %%%
+__getopt__ [[options] [[__--__] optstring parameters %%%
__getopt__ [[options] __-o__|__--options__ optstring [[options] [[__--__] parameters
!!DESCRIPTION
@@ -28,15 +28,13 @@
; __-a, --alternative__ : Allow long options to start with a single `__-__'.
; __-h, --help__ : Output a small usage guide and exit succesfully. No other output is generated.
; __-l, --longoptions longopts__ : The long (multi-character) options to be recognized. More than one option name may be specified at once, by separating the names with commas. This option may be given more than once, the ''longopts'' are cummulative. Each long option name in ''longopts'' may be followed by one colon to indicate it has a required argument,and by two colons to indicate it has an optional argument.
; __-n, --name progname__ : The name that will be used by the getopt(3) routines when it reports errors. Note that errors of getopt(1) are still reported as coming from getopt.
-; __-o, --options shortopts__ : The short (one-character) options to be recognized. If this options is not found, the first parameter of __getopt__ that does not start with a `__-__' (and is not an option argument) is used as the short options string. Each short option character in ''shortopts'' may be followed by one colon to indicate it has a required argument, and by two colons to indicate it has an optional argument. The first character of shortopts may be `__+__' or `__-__' to
-
+; __-o, --options shortopts__ : The short (one-character) options to be recognized. If this options is not found, the first parameter of __getopt__ that does not start with a `__-__' (and is not an option argument) is used as the short options string. Each short option character in ''shortopts'' may be followed by one colon to indicate it has a required argument, and by two colons to indicate it has an optional argument. The first character of shortopts may be `__+__' or `__-__' to influence the way options are parsed and output is generated (see section __SCANNING MODES__ for details).
; __-q, --quiet__ : Disable error reporting by getopt(3).
; __-Q, --quiet-output__ : Do not generate normal output. Errors are still reported by getopt(3), unless you also use ''-q''.
; __-s, --shell shell__ : Set quoting conventions to those of shell. If no -s argument is found, the BASH conventions are used. Valid arguments are currently `__sh__' `__bash__', `__csh__', and `__tcsh__'.
-; __-u, --unquoted__ : Do not quote the output. Note that whitespace and special (shell-dependent) characters can cause havoc in this mode (like they do with other getopt(1)
-
+; __-u, --unquoted__ : Do not quote the output. Note that whitespace and special (shell-dependent) characters can cause havoc in this mode (like they do with other getopt(1) implementations).
; __-T --test__ : Test if your getopt(1) is this enhanced version or an old version. This generates no output, and sets the error status to 4. Other implementations of getopt(1), and this version if the environment variable __GETOPT_COMPATIBLE__ is set, will return `__--__' and error status 0.
; __-V, --version__ : Output version information and exit succesfully. No other output is generated.
!!PARSING
