/usr/bin/getopt: Difference between revisions

       getopt optstring parameters

       getopt [options] [--] optstring parameters

       getopt [options] -o|--options optstring [options] [--] parameters

       getopt  is  used  to break up (parse) options in command lines for easy parsing by shell procedures,

       and to check for valid options.  It uses the GNU getopt(3) routines to do this.

       tion (-T) can be used.

       -a, --alternative

               Allow long options to start with a single '-'.

               Display version information and exit.  No other output is generated.

       This  section specifies the format of the second part of the parameters of getopt (the parameters in

       the SYNOPSIS).  The next section (OUTPUT) describes the output that is generated.  These  parameters

       first non-option parameter is found.

       Output is generated for each element described in the previous section.  Output is done in the  same

       order  as  the elements are specified in the input, except for non-option parameters.  Output can be

       preceding occurrences of '-' and '+' are ignored).

       In compatible mode, whitespace or 'special' characters in arguments or non-option parameters are not

       handled correctly.  As the output is fed to the shell script, the script does not  know  how  it  is

       used.

       The first character of the short options string may be a '-' or a '+' to indicate a special scanning

       mode.  If the first calling form in the SYNOPSIS is used they are ignored; the environment  variable

       parameter in this mode.

       This version of getopt(1) is written to be as compatible as possible to other versions.  Usually you

       can just replace them with this version without any modifications, and with some advantages.

       In compatibility mode, leading '-' and '+' characters in the short options string are ignored.

       getopt  returns error code 0 for successful parsing, 1 if getopt(3) returns errors, 2 if it does not

       understand its own parameters, 3 if an internal error occurs like out-of-memory,  and  4  if  it  is

       called with -T.

       Example  scripts  for  (ba)sh  and  (t)csh are provided with the getopt(1) distribution, and are in‐

       stalled in /usr/share/doc/util-linux/getopt/ directory.

       POSIXLY_CORRECT

               This environment variable is examined by the getopt(3) routines.  If it is set, parsing stops

               Forces getopt to use the first calling format as specified in the SYNOPSIS.

       getopt(3)  can  parse long options with optional arguments that are given an empty optional argument

       (but cannot do this for short options).  This getopt(1) treats optional arguments that are empty  as

       set them explicitly to the empty string).

       Frodo Looijaard ⟨frodo@frodo.looijaard.name⟩

       bash(1), tcsh(1), getopt(3)

       The getopt command is part of the util-linux package and is  available  from  Linux  Kernel  Archive

       ⟨https://www.kernel.org/pub/linux/utils/util-linux/⟩.