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 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 the first character of \fIoptstring\fP is \(aq\-\(aq, then
 170 each nonoption \fIargv\fP-element is handled as if it were the argument of
 171 an option with character code 1.  (This is used by programs that were
 172 written to expect options and other \fIargv\fP-elements in any order
 173 and that care about the ordering of the two.)
 174 The special argument "\-\-" forces an end of option-scanning regardless
 175 of the scanning mode.
 176 .PP
 177 While processing the option list,
 178 .BR getopt ()
 179 can detect two kinds of errors:
 180 (1) an option character that was not specified in
 181 .IR optstring
 182 and (2) a missing option argument
 183 (i.e., an option at the end of the command line without an expected argument).
 184 Such errors are handled and reported as follows:
 185 .IP * 3
 186 By default,
 187 .BR getopt ()
 188 prints an error message on standard error,
 189 places the erroneous option character in
 190 .IR optopt ,
 191 and returns \(aq?\(aq as the function result.
 192 .IP *
 193 If the caller has set the global variable
 194 .IR opterr
 195 to zero, then
 196 .BR getopt ()
 197 does not print an error message.
 198 The caller can determine that there was an error by testing whether
 199 the function return value is \(aq?\(aq.
 200 (By default,
 201 .IR opterr
 202 has a nonzero value.)
 203 .IP *
 204 If the first character
 205 (following any optional \(aq+\(aq or \(aq\-\(aq described above)
 206 of \fIoptstring\fP
 207 is a colon (\(aq:\(aq), then
 208 .BR getopt ()
 209 likewise does not print an error message.
 210 In addition, it returns \(aq:\(aq instead of \(aq?\(aq to
 211 indicate a missing option argument.
 212 This allows the caller to distinguish the two different types of errors.
 213 .\"
 214 .SS getopt_long() and getopt_long_only()
 215 The
 216 .BR getopt_long ()
 217 function works like
 218 .BR getopt ()
 219 except that it also accepts long options, started with two dashes.
 220 (If the program accepts only long options, then
 221 .I optstring
 222 should be specified as an empty string (""), not NULL.)
 223 Long option names may be abbreviated if the abbreviation is
 224 unique or is an exact match for some defined option.
 225 A long option
 226 may take a parameter, of the form
 227 .B \-\-arg=param
 228 or
 229 .BR "\-\-arg param" .
 230 .PP
 231 .I longopts
 232 is a pointer to the first element of an array of
 233 .I struct option
 234 declared in
 235 .I <getopt.h>
 236 as
 237 .PP
 238 .in +4n
 239 .EX
 240 struct option {
 241     const char *name;
 242     int         has_arg;
 243     int        *flag;
 244     int         val;
 245 };
 246 .EE
 247 .in
 248 .PP
 249 The meanings of the different fields are:
 250 .TP
 251 .I name
 252 is the name of the long option.
 253 .TP
 254 .I has_arg
 255 is:
 256 \fBno_argument\fP (or 0) if the option does not take an argument;
 257 \fBrequired_argument\fP (or 1) if the option requires an argument; or
 258 \fBoptional_argument\fP (or 2) if the option takes an optional argument.
 259 .TP
 260 .I flag
 261 specifies how results are returned for a long option.
 262 If \fIflag\fP
 263 is NULL, then
 264 .BR getopt_long ()
 265 returns \fIval\fP.
 266 (For example, the calling program may set \fIval\fP to the equivalent short
 267 option character.)
 268 Otherwise,
 269 .BR getopt_long ()
 270 returns 0, and
 271 \fIflag\fP points to a variable which is set to \fIval\fP if the
 272 option is found, but left unchanged if the option is not found.
 273 .TP
 274 \fIval\fP
 275 is the value to return, or to load into the variable pointed
 276 to by \fIflag\fP.
 277 .PP
 278 The last element of the array has to be filled with zeros.
 279 .PP
 280 If \fIlongindex\fP is not NULL, it
 281 points to a variable which is set to the index of the long option relative to
 282 .IR longopts .
 283 .PP
 284 .BR getopt_long_only ()
 285 is like
 286 .BR getopt_long (),
 287 but \(aq\-\(aq as well
 288 as "\-\-" can indicate a long option.
 289 If an option that starts with \(aq\-\(aq
 290 (not "\-\-") doesn't match a long option, but does match a short option,
 291 it is parsed as a short option instead.
 292 .SH RETURN VALUE
 293 If an option was successfully found, then
 294 .BR getopt ()
 295 returns the option character.
 296 If all command-line options have been parsed, then
 297 .BR getopt ()
 298 returns \-1.
 299 If
 300 .BR getopt ()
 301 encounters an option character that was not in
 302 .IR optstring ,
 303 then \(aq?\(aq is returned.
 304 If
 305 .BR getopt ()
 306 encounters an option with a missing argument,
 307 then the return value depends on the first character in
 308 .IR optstring :
 309 if it is \(aq:\(aq, then \(aq:\(aq is returned; otherwise \(aq?\(aq is returned.
 310 .PP
 311 .BR getopt_long ()
 312 and
 313 .BR getopt_long_only ()
 314 also return the option
 315 character when a short option is recognized.
 316 For a long option, they
 317 return \fIval\fP if \fIflag\fP is NULL, and 0 otherwise.
 318 Error and \-1 returns are the same as for
 319 .BR getopt (),
 320 plus \(aq?\(aq for an
 321 ambiguous match or an extraneous parameter.
 322 .SH ENVIRONMENT
 323 .TP
 324 .B POSIXLY_CORRECT
 325 If this is set, then option processing stops as soon as a nonoption
 326 argument is encountered.
 327 .TP
 328 .B _<PID>_GNU_nonoption_argv_flags_
 329 This variable was used by
 330 .BR bash (1)
 331 2.0 to communicate to glibc which arguments are the results of
 332 wildcard expansion and so should not be considered as options.
 333 This behavior was removed in
 334 .BR bash (1)
 335 version 2.01, but the support remains in glibc.
 336 .SH ATTRIBUTES
 337 For an explanation of the terms used in this section, see
 338 .BR attributes (7).
 339 .ad l
 340 .nh
 341 .TS
 342 allbox;
 343 lb lb lbx
 344 l l l.
 345 Interface       Attribute       Value
 346 T{
 347 .BR getopt (),
 348 .BR getopt_long (),
 349 .BR getopt_long_only ()
 350 T}      Thread safety   T{
 351 MT-Unsafe race:getopt env
 352 T}
 353 .TE
 354 .hy
 355 .ad
 356 .sp 1
 357 .SH CONFORMING TO
 358 .TP
 359 .BR getopt ():
 360 POSIX.1-2001, POSIX.1-2008, and POSIX.2,
 361 provided the environment variable
 362 .B POSIXLY_CORRECT
 363 is set.
 364 Otherwise, the elements of \fIargv\fP aren't really
 365 .IR const ,
 366 because these functions permute them.
 367 Nevertheless,
 368 .I const
 369 is used in the prototype to be compatible with other systems.
 370 .IP
 371 The use of \(aq+\(aq and \(aq\-\(aq in
 372 .I optstring
 373 is a GNU extension.
 374 .IP
 375 On some older implementations,
 376 .BR getopt ()
 377 was declared in
 378 .IR <stdio.h> .
 379 SUSv1 permitted the declaration to appear in either
 380 .I <unistd.h>
 381 or
 382 .IR <stdio.h> .
 383 POSIX.1-1996 marked the use of
 384 .I <stdio.h>
 385 for this purpose as LEGACY.
 386 POSIX.1-2001 does not require the declaration to appear in
 387 .IR <stdio.h> .
 388 .TP
 389 .BR getopt_long "() and " getopt_long_only ():
 390 These functions are GNU extensions.
 391 .SH NOTES
 392 A program that scans multiple argument vectors,
 393 or rescans the same vector more than once,
 394 and wants to make use of GNU extensions such as \(aq+\(aq
 395 and \(aq\-\(aq at the start of
 396 .IR optstring ,
 397 or changes the value of
 398 .B POSIXLY_CORRECT
 399 between scans,
 400 must reinitialize
 401 .BR getopt ()
 402 by resetting
 403 .I optind
 404 to 0, rather than the traditional value of 1.
 405 (Resetting to 0 forces the invocation of an internal initialization
 406 routine that rechecks
 407 .B POSIXLY_CORRECT
 408 and checks for GNU extensions in
 409 .IR optstring .)
 410 .PP
 411 Command-line arguments are parsed in strict order
 412 meaning that an option requiring an argument will consume the next argument,
 413 regardless of whether that argument is the correctly specified option argument
 414 or simply the next option
 415 (in the scenario the user mis-specifies the command line).
 416 For example, if
 417 .I optstring
 418 is specified as "1n:"
 419 and the user specifies the command line arguments incorrectly as
 420 .IR "prog\ \-n\ \-1" ,
 421 the
 422 .I \-n
 423 option will be given the
 424 .B optarg
 425 value "\-1", and the
 426 .I \-1
 427 option will be considered to have not been specified.
 428 .SH EXAMPLES
 429 .SS getopt()
 430 The following trivial example program uses
 431 .BR getopt ()
 432 to handle two program options:
 433 .IR \-n ,
 434 with no associated value; and
 435 .IR "\-t val" ,
 436 which expects an associated value.
 437 .PP
 438 .EX
 439 #include <unistd.h>
 440 #include <stdlib.h>
 441 #include <stdio.h>
 442
 443 int
 444 main(int argc, char *argv[])
 445 {
 446     int flags, opt;
 447     int nsecs, tfnd;
 448
 449     nsecs = 0;
 450     tfnd = 0;
 451     flags = 0;
 452     while ((opt = getopt(argc, argv, "nt:")) != \-1) {
 453         switch (opt) {
 454         case \(aqn\(aq:
 455             flags = 1;
 456             break;
 457         case \(aqt\(aq:
 458             nsecs = atoi(optarg);
 459             tfnd = 1;
 460             break;
 461         default: /* \(aq?\(aq */
 462             fprintf(stderr, "Usage: %s [\-t nsecs] [\-n] name\en",
 463                     argv[0]);
 464             exit(EXIT_FAILURE);
 465         }
 466     }
 467
 468     printf("flags=%d; tfnd=%d; nsecs=%d; optind=%d\en",
 469             flags, tfnd, nsecs, optind);
 470
 471     if (optind >= argc) {
 472         fprintf(stderr, "Expected argument after options\en");
 473         exit(EXIT_FAILURE);
 474     }
 475
 476     printf("name argument = %s\en", argv[optind]);
 477
 478     /* Other code omitted */
 479
 480     exit(EXIT_SUCCESS);
 481 }
 482 .EE
 483 .SS getopt_long()
 484 The following example program illustrates the use of
 485 .BR getopt_long ()
 486 with most of its features.
 487 .PP
 488 .EX
 489 #include <stdio.h>     /* for printf */
 490 #include <stdlib.h>    /* for exit */
 491 #include <getopt.h>
 492
 493 int
 494 main(int argc, char *argv[])
 495 {
 496     int c;
 497     int digit_optind = 0;
 498
 499     while (1) {
 500         int this_option_optind = optind ? optind : 1;
 501         int option_index = 0;
 502         static struct option long_options[] = {
 503             {"add",     required_argument, 0,  0 },
 504             {"append",  no_argument,       0,  0 },
 505             {"delete",  required_argument, 0,  0 },
 506             {"verbose", no_argument,       0,  0 },
 507             {"create",  required_argument, 0, \(aqc\(aq},
 508             {"file",    required_argument, 0,  0 },
 509             {0,         0,                 0,  0 }
 510         };
 511
 512         c = getopt_long(argc, argv, "abc:d:012",
 513                  long_options, &option_index);
 514         if (c == \-1)
 515             break;
 516
 517         switch (c) {
 518         case 0:
 519             printf("option %s", long_options[option_index].name);
 520             if (optarg)
 521                 printf(" with arg %s", optarg);
 522             printf("\en");
 523             break;
 524
 525         case \(aq0\(aq:
 526         case \(aq1\(aq:
 527         case \(aq2\(aq:
 528             if (digit_optind != 0 && digit_optind != this_option_optind)
 529               printf("digits occur in two different argv\-elements.\en");
 530             digit_optind = this_option_optind;
 531             printf("option %c\en", c);
 532             break;
 533
 534         case \(aqa\(aq:
 535             printf("option a\en");
 536             break;
 537
 538         case \(aqb\(aq:
 539             printf("option b\en");
 540             break;
 541
 542         case \(aqc\(aq:
 543             printf("option c with value \(aq%s\(aq\en", optarg);
 544             break;
 545
 546         case \(aqd\(aq:
 547             printf("option d with value \(aq%s\(aq\en", optarg);
 548             break;
 549
 550         case \(aq?\(aq:
 551             break;
 552
 553         default:
 554             printf("?? getopt returned character code 0%o ??\en", c);
 555         }
 556     }
 557
 558     if (optind < argc) {
 559         printf("non\-option ARGV\-elements: ");
 560         while (optind < argc)
 561             printf("%s ", argv[optind++]);
 562         printf("\en");
 563     }
 564
 565     exit(EXIT_SUCCESS);
 566 }
 567 .EE
 568 .SH SEE ALSO
 569 .BR getopt (1),
 570 .BR getsubopt (3)