getopt_long (3) - Linux Manuals
getopt_long: Parse command-line options
NAME
getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt - Parse command-line options
SYNOPSIS
#include <unistd.h>
int getopt(int argc, char * const argv[],
const char *optstring);
extern char *optarg;
extern int optind, opterr, optopt;
#include <getopt.h>
int getopt_long(int argc, char * const argv[],
const char *optstring,
const struct option *longopts, int *longindex);
int getopt_long_only(int argc, char * const argv[],
const char *optstring,
const struct option *longopts, int *longindex);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
getopt():
_POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE
getopt_long(),
getopt_long_only():
_GNU_SOURCE
DESCRIPTION
The getopt() function parses the command-line arguments. Its arguments argc and argv are the argument count and array as passed to the main() function on program invocation. An element of argv that starts with '-' (and is not exactly "-" or "--") is an option element. The characters of this element (aside from the initial '-') are option characters. If getopt() is called repeatedly, it returns successively each of the option characters from each of the option elements.The variable optind is the index of the next element to be processed in argv. The system initializes this value to 1. The caller can reset it to 1 to restart scanning of the same argv, or when scanning a new argument vector.
If getopt() finds another option character, it returns that character, updating the external variable optind and a static variable nextchar so that the next call to getopt() can resume the scan with the following option character or argv-element.
If there are no more option characters, getopt() returns -1. Then optind is the index in argv of the first argv-element that is not an option.
optstring is a string containing the legitimate option characters. If such a character is followed by a colon, the option requires an argument, so getopt() places a pointer to the following text in the same argv-element, or the text of the following argv-element, in optarg. Two colons mean an option takes an optional arg; if there is text in the current argv-element (i.e., in the same word as the option name itself, for example, "-oarg"), then it is returned in optarg, otherwise optarg is set to zero. This is a GNU extension. If optstring contains W followed by a semicolon, then -W foo is treated as the long option --foo. (The -W option is reserved by POSIX.2 for implementation extensions.) This behavior is a GNU extension, not available with libraries before glibc 2.
By default, getopt() permutes the contents of argv as it scans, so that eventually all the nonoptions are at the end. Two other scanning modes are also implemented. If the first character of optstring is '+' or the environment variable POSIXLY_CORRECT is set, then option processing stops as soon as a nonoption argument is encountered. If the first character of optstring is '-', then each nonoption argv-element is handled as if it were the argument of an option with character code 1. (This is used by programs that were written to expect options and other argv-elements in any order and that care about the ordering of the two.) The special argument "--" forces an end of option-scanning regardless of the scanning mode.
While processing the option list, getopt() can detect two kinds of errors: (1) an option character that was not specified in optstring and (2) a missing option argument (i.e., an option at the end of the command line without an expected argument). Such errors are handled and reported as follows:
- *
- By default, getopt() prints an error message on standard error, places the erroneous option character in optopt, and returns '?' as the function result.
- *
- If the caller has set the global variable opterr to zero, then getopt() does not print an error message. The caller can determine that there was an error by testing whether the function return value is '?'. (By default, opterr has a nonzero value.)
- *
- If the first character (following any optional '+' or '-' described above) of optstring is a colon (':'), then getopt() likewise does not print an error message. In addition, it returns ':' instead of '?' to indicate a missing option argument. This allows the caller to distinguish the two different types of errors.
getopt_long() and getopt_long_only()
The getopt_long() function works like getopt() except that it also accepts long options, started with two dashes. (If the program accepts only long options, then optstring should be specified as an empty string (""), not NULL.) Long option names may be abbreviated if the abbreviation is unique or is an exact match for some defined option. A long option may take a parameter, of the form --arg=param or --arg param.longopts is a pointer to the first element of an array of struct option declared in <getopt.h> as
struct option {
The meanings of the different fields are:
The last element of the array has to be filled with zeros.
If longindex is not NULL, it
points to a variable which is set to the index of the long option relative to
longopts.
getopt_long_only()
is like
getopt_long(),
but '-' as well
as "--" can indicate a long option.
If an option that starts with '-'
(not "--") doesn't match a long option, but does match a short option,
it is parsed as a short option instead.
getopt_long()
and
getopt_long_only()
also return the option
character when a short option is recognized.
For a long option, they
return val if flag is NULL, and 0 otherwise.
Error and -1 returns are the same as for
getopt(),
plus '?' for an
ambiguous match or an extraneous parameter.
#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
int
main(int argc, char *argv[])
{
#include <stdio.h> /* for printf */
#include <stdlib.h> /* for exit */
#include <getopt.h>
int
main(int argc, char **argv)
{
RETURN VALUE
If an option was successfully found, then
getopt()
returns the option character.
If all command-line options have been parsed, then
getopt()
returns -1.
If
getopt()
encounters an option character that was not in
optstring,
then '?' is returned.
If
getopt()
encounters an option with a missing argument,
then the return value depends on the first character in
optstring:
if it is ':', then ':' is returned; otherwise '?' is returned.
ENVIRONMENT
ATTRIBUTES
For an explanation of the terms used in this section, see
attributes(7).
Interface Attribute Value
getopt(),
getopt_long(),
getopt_long_only()
Thread safety MT-Unsafe race:getopt env CONFORMING TO
NOTES
A program that scans multiple argument vectors,
or rescans the same vector more than once,
and wants to make use of GNU extensions such as '+'
and '-' at the start of
optstring,
or changes the value of
POSIXLY_CORRECT
between scans,
must reinitialize
getopt()
by resetting
optind
to 0, rather than the traditional value of 1.
(Resetting to 0 forces the invocation of an internal initialization
routine that rechecks
POSIXLY_CORRECT
and checks for GNU extensions in
optstring.)
EXAMPLES
getopt()
The following trivial example program uses
getopt()
to handle two program options:
-n,
with no associated value; and
-t val,
which expects an associated value.
getopt_long()
The following example program illustrates the use of
getopt_long()
with most of its features.