man3/getopt.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\" and Copyright 2006-2008, Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" Modified Sat Jul 24 19:27:50 1993 by Rik Faith (faith@cs.unc.edu)
  27 .\" Modified Mon Aug 30 22:02:34 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
  28 .\"  longindex is a pointer, has_arg can take 3 values, using consistent
  29 .\"  names for optstring and longindex, "\n" in formats fixed.  Documenting
  30 .\"  opterr and getopt_long_only.  Clarified explanations (borrowing heavily
  31 .\"  from the source code).
  32 .\" Modified 8 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
  33 .\" Modified 990715, aeb: changed `EOF' into `-1' since that is what POSIX
  34 .\"  says; moreover, EOF is not defined in <unistd.h>.
  35 .\" Modified 2002-02-16, joey: added information about nonexistent
  36 .\"  option character and colon as first option character
  37 .\" Modified 2004-07-28, Michael Kerrisk <mtk.manpages@gmail.com>
  38 .\"     Added text to explain how to order both '[-+]' and ':' at
  39 .\"             the start of optstring
  40 .\" Modified 2006-12-15, mtk, Added getopt() example program.
  41 .\"
  42 .TH GETOPT 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  43 .SH NAME
  44 getopt, getopt_long, getopt_long_only,
  45 optarg, optind, opterr, optopt \- Parse command-line options
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <unistd.h>
  49 .PP
  50 .BI "int getopt(int " argc ", char *const " argv [],
  51 .BI "           const char *" optstring );
  52 .PP
  53 .BI "extern char *" optarg ;
  54 .BI "extern int " optind ", " opterr ", " optopt ;
  55 .PP
  56 .B #include <getopt.h>
  57 .PP
  58 .BI "int getopt_long(int " argc ", char *const " argv [],
  59 .BI "           const char *" optstring ,
  60 .BI "           const struct option *" longopts ", int *" longindex );
  61 .BI "int getopt_long_only(int " argc ", char *const " argv [],
  62 .BI "           const char *" optstring ,
  63 .BI "           const struct option *" longopts ", int *" longindex );
  64 .fi
  65 .PP
  66 .RS -4
  67 Feature Test Macro Requirements for glibc (see
  68 .BR feature_test_macros (7)):
  69 .RE
  70 .PP
  71 .BR getopt ():
  72 .nf
  73     _POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE
  74 .fi
  75 .PP
  76 .BR getopt_long (),
  77 .BR getopt_long_only ():
  78 .nf
  79     _GNU_SOURCE
  80 .fi
  81 .SH DESCRIPTION
  82 The
  83 .BR getopt ()
  84 function parses the command-line arguments.
  85 Its arguments
  86 .I argc
  87 and
  88 .I argv
  89 are the argument count and array as passed to the
  90 .IR main ()
  91 function on program invocation.
  92 An element of \fIargv\fP that starts with \(aq\-\(aq
  93 (and is not exactly "\-" or "\-\-")
  94 is an option element.
  95 The characters of this element
  96 (aside from the initial \(aq\-\(aq) are option characters.
  97 If
  98 .BR getopt ()
  99 is called repeatedly, it returns successively each of the option characters
 100 from each of the option elements.
 101 .PP
 102 The variable
 103 .I optind
 104 is the index of the next element to be processed in
 105 .IR argv .
 106 The system initializes this value to 1.
 107 The caller can reset it to 1 to restart scanning of the same
 108 .IR argv ,
 109 or when scanning a new argument vector.
 110 .PP
 111 If
 112 .BR getopt ()
 113 finds another option character, it returns that
 114 character, updating the external variable \fIoptind\fP and a static
 115 variable \fInextchar\fP so that the next call to
 116 .BR getopt ()
 117 can
 118 resume the scan with the following option character or
 119 \fIargv\fP-element.
 120 .PP
 121 If there are no more option characters,
 122 .BR getopt ()
 123 returns \-1.
 124 Then \fIoptind\fP is the index in \fIargv\fP of the first
 125 \fIargv\fP-element that is not an option.
 126 .PP
 127 .I optstring
 128 is a string containing the legitimate option characters.
 129 A legitimate option character is any visible one byte
 130 .BR ascii (7)
 131 character (for which
 132 .BR isgraph (3)
 133 would return nonzero) that is not \(aq\-\(aq, \(aq:\(aq, or \(aq;\(aq.
 134 If such a
 135 character is followed by a colon, the option requires an argument, so
 136 .BR getopt ()
 137 places a pointer to the following text in the same
 138 \fIargv\fP-element, or the text of the following \fIargv\fP-element, in
 139 .IR optarg .
 140 Two colons mean an option takes
 141 an optional arg; if there is text in the current \fIargv\fP-element
 142 (i.e., in the same word as the option name itself, for example, "\-oarg"),
 143 then it is returned in \fIoptarg\fP, otherwise \fIoptarg\fP is set to zero.
 144 This is a GNU extension.
 145 If
 146 .I optstring
 147 contains
 148 .B W
 149 followed by a semicolon, then
 150 .B \-W foo
 151 is treated as the long option
 152 .BR \-\-foo .
 153 (The
 154 .B \-W
 155 option is reserved by POSIX.2 for implementation extensions.)
 156 This behavior is a GNU extension, not available with libraries before
 157 glibc 2.
 158 .PP
 159 By default,
 160 .BR getopt ()
 161 permutes the contents of \fIargv\fP as it
 162 scans, so that eventually all the nonoptions are at the end.
 163 Two other scanning modes are also implemented.
 164 If the first character of
 165 \fIoptstring\fP is \(aq+\(aq or the environment variable
 166 .B POSIXLY_CORRECT
 167 is set, then option processing stops as soon as a nonoption argument is
 168 encountered.
 169 If \(aq+\(aq is not the first character of
 170 .IR optstring ,
 171 it is treated as a normal option.
 172 If
 173 .B POSIXLY_CORRECT
 174 behaviour is required in this case
 175 .I optstring
 176 will contain two \(aq+\(aq symbols.
 177 If the first character of \fIoptstring\fP is \(aq\-\(aq, then
 178 each nonoption \fIargv\fP-element is handled as if it were the argument of
 179 an option with character code 1.
 180 (This is used by programs that were
 181 written to expect options and other \fIargv\fP-elements in any order
 182 and that care about the ordering of the two.)
 183 The special argument "\-\-" forces an end of option-scanning regardless
 184 of the scanning mode.
 185 .PP
 186 While processing the option list,
 187 .BR getopt ()
 188 can detect two kinds of errors:
 189 (1) an option character that was not specified in
 190 .IR optstring
 191 and (2) a missing option argument
 192 (i.e., an option at the end of the command line without an expected argument).
 193 Such errors are handled and reported as follows:
 194 .IP * 3
 195 By default,
 196 .BR getopt ()
 197 prints an error message on standard error,
 198 places the erroneous option character in
 199 .IR optopt ,
 200 and returns \(aq?\(aq as the function result.
 201 .IP *
 202 If the caller has set the global variable
 203 .IR opterr
 204 to zero, then
 205 .BR getopt ()
 206 does not print an error message.
 207 The caller can determine that there was an error by testing whether
 208 the function return value is \(aq?\(aq.
 209 (By default,
 210 .IR opterr
 211 has a nonzero value.)
 212 .IP *
 213 If the first character
 214 (following any optional \(aq+\(aq or \(aq\-\(aq described above)
 215 of \fIoptstring\fP
 216 is a colon (\(aq:\(aq), then
 217 .BR getopt ()
 218 likewise does not print an error message.
 219 In addition, it returns \(aq:\(aq instead of \(aq?\(aq to
 220 indicate a missing option argument.
 221 This allows the caller to distinguish the two different types of errors.
 222 .\"
 223 .SS getopt_long() and getopt_long_only()
 224 The
 225 .BR getopt_long ()
 226 function works like
 227 .BR getopt ()
 228 except that it also accepts long options, started with two dashes.
 229 (If the program accepts only long options, then
 230 .I optstring
 231 should be specified as an empty string (""), not NULL.)
 232 Long option names may be abbreviated if the abbreviation is
 233 unique or is an exact match for some defined option.
 234 A long option
 235 may take a parameter, of the form
 236 .B \-\-arg=param
 237 or
 238 .BR "\-\-arg param" .
 239 .PP
 240 .I longopts
 241 is a pointer to the first element of an array of
 242 .I struct option
 243 declared in
 244 .I <getopt.h>
 245 as
 246 .PP
 247 .in +4n
 248 .EX
 249 struct option {
 250     const char *name;
 251     int         has_arg;
 252     int        *flag;
 253     int         val;
 254 };
 255 .EE
 256 .in
 257 .PP
 258 The meanings of the different fields are:
 259 .TP
 260 .I name
 261 is the name of the long option.
 262 .TP
 263 .I has_arg
 264 is:
 265 \fBno_argument\fP (or 0) if the option does not take an argument;
 266 \fBrequired_argument\fP (or 1) if the option requires an argument; or
 267 \fBoptional_argument\fP (or 2) if the option takes an optional argument.
 268 .TP
 269 .I flag
 270 specifies how results are returned for a long option.
 271 If \fIflag\fP
 272 is NULL, then
 273 .BR getopt_long ()
 274 returns \fIval\fP.
 275 (For example, the calling program may set \fIval\fP to the equivalent short
 276 option character.)
 277 Otherwise,
 278 .BR getopt_long ()
 279 returns 0, and
 280 \fIflag\fP points to a variable which is set to \fIval\fP if the
 281 option is found, but left unchanged if the option is not found.
 282 .TP
 283 \fIval\fP
 284 is the value to return, or to load into the variable pointed
 285 to by \fIflag\fP.
 286 .PP
 287 The last element of the array has to be filled with zeros.
 288 .PP
 289 If \fIlongindex\fP is not NULL, it
 290 points to a variable which is set to the index of the long option relative to
 291 .IR longopts .
 292 .PP
 293 .BR getopt_long_only ()
 294 is like
 295 .BR getopt_long (),
 296 but \(aq\-\(aq as well
 297 as "\-\-" can indicate a long option.
 298 If an option that starts with \(aq\-\(aq
 299 (not "\-\-") doesn't match a long option, but does match a short option,
 300 it is parsed as a short option instead.
 301 .SH RETURN VALUE
 302 If an option was successfully found, then
 303 .BR getopt ()
 304 returns the option character.
 305 If all command-line options have been parsed, then
 306 .BR getopt ()
 307 returns \-1.
 308 If
 309 .BR getopt ()
 310 encounters an option character that was not in
 311 .IR optstring ,
 312 then \(aq?\(aq is returned.
 313 If
 314 .BR getopt ()
 315 encounters an option with a missing argument,
 316 then the return value depends on the first character in
 317 .IR optstring :
 318 if it is \(aq:\(aq, then \(aq:\(aq is returned; otherwise \(aq?\(aq is returned.
 319 .PP
 320 .BR getopt_long ()
 321 and
 322 .BR getopt_long_only ()
 323 also return the option
 324 character when a short option is recognized.
 325 For a long option, they
 326 return \fIval\fP if \fIflag\fP is NULL, and 0 otherwise.
 327 Error and \-1 returns are the same as for
 328 .BR getopt (),
 329 plus \(aq?\(aq for an
 330 ambiguous match or an extraneous parameter.
 331 .SH ENVIRONMENT
 332 .TP
 333 .B POSIXLY_CORRECT
 334 If this is set, then option processing stops as soon as a nonoption
 335 argument is encountered.
 336 .TP
 337 .B _<PID>_GNU_nonoption_argv_flags_
 338 This variable was used by
 339 .BR bash (1)
 340 2.0 to communicate to glibc which arguments are the results of
 341 wildcard expansion and so should not be considered as options.
 342 This behavior was removed in
 343 .BR bash (1)
 344 version 2.01, but the support remains in glibc.
 345 .SH ATTRIBUTES
 346 For an explanation of the terms used in this section, see
 347 .BR attributes (7).
 348 .ad l
 349 .nh
 350 .TS
 351 allbox;
 352 lb lb lbx
 353 l l l.
 354 Interface       Attribute       Value
 355 T{
 356 .BR getopt (),
 357 .BR getopt_long (),
 358 .BR getopt_long_only ()
 359 T}      Thread safety   T{
 360 MT-Unsafe race:getopt env
 361 T}
 362 .TE
 363 .hy
 364 .ad
 365 .sp 1
 366 .SH CONFORMING TO
 367 .TP
 368 .BR getopt ():
 369 POSIX.1-2001, POSIX.1-2008, and POSIX.2,
 370 provided the environment variable
 371 .B POSIXLY_CORRECT
 372 is set.
 373 Otherwise, the elements of \fIargv\fP aren't really
 374 .IR const ,
 375 because these functions permute them.
 376 Nevertheless,
 377 .I const
 378 is used in the prototype to be compatible with other systems.
 379 .IP
 380 The use of \(aq+\(aq and \(aq\-\(aq in
 381 .I optstring
 382 is a GNU extension.
 383 .IP
 384 On some older implementations,
 385 .BR getopt ()
 386 was declared in
 387 .IR <stdio.h> .
 388 SUSv1 permitted the declaration to appear in either
 389 .I <unistd.h>
 390 or
 391 .IR <stdio.h> .
 392 POSIX.1-1996 marked the use of
 393 .I <stdio.h>
 394 for this purpose as LEGACY.
 395 POSIX.1-2001 does not require the declaration to appear in
 396 .IR <stdio.h> .
 397 .TP
 398 .BR getopt_long "() and " getopt_long_only ():
 399 These functions are GNU extensions.
 400 .SH NOTES
 401 A program that scans multiple argument vectors,
 402 or rescans the same vector more than once,
 403 and wants to make use of GNU extensions such as \(aq+\(aq
 404 and \(aq\-\(aq at the start of
 405 .IR optstring ,
 406 or changes the value of
 407 .B POSIXLY_CORRECT
 408 between scans,
 409 must reinitialize
 410 .BR getopt ()
 411 by resetting
 412 .I optind
 413 to 0, rather than the traditional value of 1.
 414 (Resetting to 0 forces the invocation of an internal initialization
 415 routine that rechecks
 416 .B POSIXLY_CORRECT
 417 and checks for GNU extensions in
 418 .IR optstring .)
 419 .PP
 420 Command-line arguments are parsed in strict order
 421 meaning that an option requiring an argument will consume the next argument,
 422 regardless of whether that argument is the correctly specified option argument
 423 or simply the next option
 424 (in the scenario the user mis-specifies the command line).
 425 For example, if
 426 .I optstring
 427 is specified as "1n:"
 428 and the user specifies the command line arguments incorrectly as
 429 .IR "prog\ \-n\ \-1" ,
 430 the
 431 .I \-n
 432 option will be given the
 433 .B optarg
 434 value "\-1", and the
 435 .I \-1
 436 option will be considered to have not been specified.
 437 .SH EXAMPLES
 438 .SS getopt()
 439 The following trivial example program uses
 440 .BR getopt ()
 441 to handle two program options:
 442 .IR \-n ,
 443 with no associated value; and
 444 .IR "\-t val" ,
 445 which expects an associated value.
 446 .PP
 447 .EX
 448 #include <unistd.h>
 449 #include <stdlib.h>
 450 #include <stdio.h>
 451
 452 int
 453 main(int argc, char *argv[])
 454 {
 455     int flags, opt;
 456     int nsecs, tfnd;
 457
 458     nsecs = 0;
 459     tfnd = 0;
 460     flags = 0;
 461     while ((opt = getopt(argc, argv, "nt:")) != \-1) {
 462         switch (opt) {
 463         case \(aqn\(aq:
 464             flags = 1;
 465             break;
 466         case \(aqt\(aq:
 467             nsecs = atoi(optarg);
 468             tfnd = 1;
 469             break;
 470         default: /* \(aq?\(aq */
 471             fprintf(stderr, "Usage: %s [\-t nsecs] [\-n] name\en",
 472                     argv[0]);
 473             exit(EXIT_FAILURE);
 474         }
 475     }
 476
 477     printf("flags=%d; tfnd=%d; nsecs=%d; optind=%d\en",
 478             flags, tfnd, nsecs, optind);
 479
 480     if (optind >= argc) {
 481         fprintf(stderr, "Expected argument after options\en");
 482         exit(EXIT_FAILURE);
 483     }
 484
 485     printf("name argument = %s\en", argv[optind]);
 486
 487     /* Other code omitted */
 488
 489     exit(EXIT_SUCCESS);
 490 }
 491 .EE
 492 .SS getopt_long()
 493 The following example program illustrates the use of
 494 .BR getopt_long ()
 495 with most of its features.
 496 .PP
 497 .EX
 498 #include <stdio.h>     /* for printf */
 499 #include <stdlib.h>    /* for exit */
 500 #include <getopt.h>
 501
 502 int
 503 main(int argc, char *argv[])
 504 {
 505     int c;
 506     int digit_optind = 0;
 507
 508     while (1) {
 509         int this_option_optind = optind ? optind : 1;
 510         int option_index = 0;
 511         static struct option long_options[] = {
 512             {"add",     required_argument, 0,  0 },
 513             {"append",  no_argument,       0,  0 },
 514             {"delete",  required_argument, 0,  0 },
 515             {"verbose", no_argument,       0,  0 },
 516             {"create",  required_argument, 0, \(aqc\(aq},
 517             {"file",    required_argument, 0,  0 },
 518             {0,         0,                 0,  0 }
 519         };
 520
 521         c = getopt_long(argc, argv, "abc:d:012",
 522                  long_options, &option_index);
 523         if (c == \-1)
 524             break;
 525
 526         switch (c) {
 527         case 0:
 528             printf("option %s", long_options[option_index].name);
 529             if (optarg)
 530                 printf(" with arg %s", optarg);
 531             printf("\en");
 532             break;
 533
 534         case \(aq0\(aq:
 535         case \(aq1\(aq:
 536         case \(aq2\(aq:
 537             if (digit_optind != 0 && digit_optind != this_option_optind)
 538               printf("digits occur in two different argv\-elements.\en");
 539             digit_optind = this_option_optind;
 540             printf("option %c\en", c);
 541             break;
 542
 543         case \(aqa\(aq:
 544             printf("option a\en");
 545             break;
 546
 547         case \(aqb\(aq:
 548             printf("option b\en");
 549             break;
 550
 551         case \(aqc\(aq:
 552             printf("option c with value \(aq%s\(aq\en", optarg);
 553             break;
 554
 555         case \(aqd\(aq:
 556             printf("option d with value \(aq%s\(aq\en", optarg);
 557             break;
 558
 559         case \(aq?\(aq:
 560             break;
 561
 562         default:
 563             printf("?? getopt returned character code 0%o ??\en", c);
 564         }
 565     }
 566
 567     if (optind < argc) {
 568         printf("non\-option ARGV\-elements: ");
 569         while (optind < argc)
 570             printf("%s ", argv[optind++]);
 571         printf("\en");
 572     }
 573
 574     exit(EXIT_SUCCESS);
 575 }
 576 .EE
 577 .SH SEE ALSO
 578 .BR getopt (1),
 579 .BR getsubopt (3)