1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one.
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date. The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein. The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" Modified Sat Jul 24 19:27:50 1993 by Rik Faith (faith@cs.unc.edu)
24 .\" Modified Mon Aug 30 22:02:34 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
25 .\" longindex is a pointer, has_arg can take 3 values, using consistent
26 .\" names for optstring and longindex, "\n" in formats fixed. Documenting
27 .\" opterr and getopt_long_only. Clarified explanations (borrowing heavily
28 .\" from the source code).
29 .\" Modified 8 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
30 .\" Modified 990715, aeb: changed `EOF' into `-1' since that is what POSIX
31 .\" says; moreover, EOF is not defined in <unistd.h>.
32 .\" Modified 2002-02-16, joey: added information about nonexisting
33 .\" option character and colon as first option character
34 .\" Modified 2004-07-28, Michael Kerrisk <mtk.manpages@gmail.com>
35 .\" Added text to explain how to order both '[-+]' and ':' at
36 .\" the start of optstring
37 .\" Modified 2006-12-15, mtk, Added getopt() example program.
39 .\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
40 .\" Translated 1998-08-12, NAKANO Takeo <nakano@apm.seikei.ac.jp>
41 .\" Updated & Modified 1999-08-21, NAKANO Takeo <nakano@apm.seikei.ac.jp>
42 .\" Updated & Modified 2001-07-01, Yuichi SATO <ysato@h4.dion.ne.jp>
43 .\" Updated & Modified 2002-03-23, Yuichi SATO
44 .\" Updated & Modified 2003-09-07, Yuichi SATO <ysato444@yahoo.co.jp>
45 .\" Updated & Modified 2005-01-10, Yuichi SATO
46 .\" Updated & Modified 2005-10-28, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
47 .\" Updated & Modified 2006-01-18, Akihiro MOTOKI
48 .\" Updated & Modified 2007-05-01, Akihiro MOTOKI, LDP v2.46
49 .\" Updated 2008-08-11, Akihiro MOTOKI, LDP v3.05
51 .\"WORD: argv-element argv Í×ÁÇ
53 .TH GETOPT 3 2010-02-03 "GNU" "Linux Programmer's Manual"
56 .\"O getopt, getopt_long, getopt_long_only,
57 .\"O optarg, optind, opterr, optopt \- Parse command-line options
58 getopt, getopt_long, getopt_long_only,
59 optarg, optind, opterr, optopt \- ¥³¥Þ¥ó¥É¥é¥¤¥ó¥ª¥×¥·¥ç¥ó¤ò²ò¼á¤¹¤ë
63 .B #include <unistd.h>
65 .BI "int getopt(int " argc ", char * const " argv[] ,
66 .BI " const char *" optstring );
68 .BI "extern char *" optarg ;
69 .BI "extern int " optind ", " opterr ", " optopt ;
71 .B #include <getopt.h>
73 .BI "int getopt_long(int " argc ", char * const " argv[] ,
74 .BI " const char *" optstring ,
75 .BI " const struct option *" longopts ", int *" longindex );
77 .BI "int getopt_long_only(int " argc ", char * const " argv[] ,
78 .BI " const char *" optstring ,
79 .BI " const struct option *" longopts ", int *" longindex );
83 .\"O Feature Test Macro Requirements for glibc (see
84 .\"O .BR feature_test_macros (7)):
85 glibc ¸þ¤±¤Îµ¡Ç½¸¡ºº¥Þ¥¯¥í¤ÎÍ×·ï
86 .RB ( feature_test_macros (7)
92 _POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE
95 .BR getopt_long_only ():
102 .\"O function parses the command-line arguments.
107 .\"O are the argument count and array as passed to the
109 .\"O function on program invocation.
111 ´Ø¿ô¤Ï¥³¥Þ¥ó¥É¥é¥¤¥ó°ú¤¿ô¤ò²ò¼á¤¹¤ë¡£
117 ¤Ï¡¢¤½¤ì¤¾¤ì¥×¥í¥°¥é¥à¤Îµ¯Æ°»þ¤Ë
119 ´Ø¿ô¤ËÅϤµ¤ì¤¿°ú¤¿ô¤Î¸Ä¿ô¤ÈÇÛÎó¤Ç¤¢¤ë¡£
120 .\"O An element of \fIargv\fP that starts with \(aq\-\(aq
121 .\"O (and is not exactly "\-" or "\-\-")
122 .\"O is an option element.
123 .\"O The characters of this element
124 .\"O (aside from the initial \(aq\-\(aq) are option characters.
127 .\"O is called repeatedly, it returns successively each of the option characters
128 .\"O from each of the option elements.
129 \fIargv\fP ¤ÎÍ×ÁǤΤ¦¤Á \(aq\-\(aq ¤Ç»Ï¤Þ¤ë¤â¤Î
130 (¤«¤Ä "\-" ñÆȤä "\-\-" ñÆȤǤϤʤ¤¤â¤Î) ¤Ï
131 ¥ª¥×¥·¥ç¥óÍ×ÁÇ (option element) ¤È¤ß¤Ê¤µ¤ì¤ë¡£
132 ¤³¤ÎÍ×ÁǤ«¤éÀèƬ¤Î \(aq\-\(aq ¤ò½ü¤¤¤¿Ê¸»ú¤Ï
133 ¥ª¥×¥·¥ç¥óʸ»ú (option character) ¤È¤µ¤ì¤ë¡£
135 ¤Ï¡¢·«¤êÊÖ¤·¸Æ¤Ó½Ð¤µ¤ì¤ë¤´¤È¤Ë¡¢¼¡¤Î¥ª¥×¥·¥ç¥óʸ»ú¤òÊÖ¤¹¡£
139 .\"O is the index of the next element to be processed in
141 .\"O The system initializes this value to 1.
142 .\"O The caller can reset it to 1 to restart scanning of the same
144 .\"O or when scanning a new argument vector.
149 ¤Î¼¡¤Ë½èÍý¤µ¤ì¤ëÍ×ÁǤΥ¤¥ó¥Ç¥Ã¥¯¥¹¤Ç¤¢¤ë¡£
150 ¥·¥¹¥Æ¥à¤Ë¤è¤ê¤³¤ÎÊÑ¿ô¤ÎÃÍ¤Ï 1 ¤Ë½é´ü²½¤µ¤ì¤ë¡£
151 ¸Æ¤Ó½Ð¤·Â¦¤Ç¤³¤ÎÃͤò 1 ¤Ë¥ê¥»¥Ã¥È¤¹¤ë¤³¤È¤Ç¡¢Æ±¤¸
153 ¤Î¥¹¥¥ã¥ó¤ò¤ä¤êľ¤·¤¿¤ê¡¢¿·¤·¤¤°ú¤¿ô¥Ù¥¯¥È¥ë¤ò¥¹¥¥ã¥ó¤¹¤ë¤³¤È¤¬¤Ç¤¤ë¡£
157 .\"O finds another option character, it returns that
158 .\"O character, updating the external variable \fIoptind\fP and a static
159 .\"O variable \fInextchar\fP so that the next call to
162 .\"O resume the scan with the following option character or
163 .\"O \fIargv\fP-element.
164 ¿·¤¿¤Ê¥ª¥×¥·¥ç¥óʸ»ú¤ò¸«¤Ä¤±¤ë¤È¡¢
167 ³°ÉôÊÑ¿ô \fIoptind\fP ¤È¥¹¥¿¥Æ¥£¥Ã¥¯¤ÊÊÑ¿ô \fInextchar\fP ¤ò¹¹¿·¤¹¤ë¡£
170 ¤Ï¼¡²ó¤Î¸Æ¤Ó½Ð¤·¤ÎºÝ¤Ë¡¢
171 °Ê¹ß¤Î¥ª¥×¥·¥ç¥óʸ»ú¤ä \fIargv\fP Í×ÁǤΥ¹¥¥ã¥ó¤ò·Ñ³¤Ç¤¤ë¡£
173 .\"O If there are no more option characters,
176 .\"O Then \fIoptind\fP is the index in \fIargv\fP of the first
177 .\"O \fIargv\fP-element that is not an option.
178 ¥ª¥×¥·¥ç¥óʸ»ú¤¬¤½¤ì°Ê¾å¸«¤Ä¤«¤é¤Ê¤¯¤Ê¤ë¤È¡¢
181 \-1 ¤òÊÖ¤¹¡£¤½¤·¤Æ \fIoptind\fP ¤Ï¡¢\fIargv\fP ¤ÎÍ×ÁǤΤ¦¤Á¡¢
182 ¥ª¥×¥·¥ç¥ó¤Ç¤Ê¤¤ºÇ½é¤ÎÍ×ÁǤò¼¨¤¹¤è¤¦¤Ë¤Ê¤ë¡£
185 .\"O is a string containing the legitimate option characters.
187 .\"O character is followed by a colon, the option requires an argument, so
189 .\"O places a pointer to the following text in the same
190 .\"O \fIargv\fP-element, or the text of the following \fIargv\fP-element, in
193 ¤Ï¼õ¤±ÉÕ¤±¤ë¥ª¥×¥·¥ç¥óʸ»ú¤«¤é¤Ê¤ëʸ»úÎó¤Ç¤¢¤ë¡£
194 ʸ»ú¤Î¤¢¤È¤Ë¥³¥í¥ó (:) ¤¬ÃÖ¤«¤ì¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢
195 ¥ª¥×¥·¥ç¥ó¤Ë¤Ï°ú¤¿ô¤¬É¬ÍפǤ¢¤ë¤³¤È¤ò¼¨¤¹¡£
199 \fIargv\fP Í×ÁǤǡ¢¥ª¥×¥·¥ç¥óʸ»ú¤Ë°ú¤Â³¤¯¥Æ¥¥¹¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤«¡¢
200 ¤¢¤ë¤¤¤Ï¼¡¤Î \fIargv\fP Í×ÁǤΥƥ¥¹¥È¤Ø¤Î¥Ý¥¤¥ó¥¿¤ò
203 .\"O Two colons mean an option takes
204 .\"O an optional arg; if there is text in the current \fIargv\fP-element
205 .\"O (i.e., in the same word as the option name itself, for example, "\-oarg"),
206 .\"O then it is returned in \fIoptarg\fP, otherwise \fIoptarg\fP is set to zero.
207 .\"O This is a GNU extension.
212 .\"O followed by a semicolon, then
214 .\"O is treated as the long option
216 2 ¸ÄϢ³¤·¤Æ¥³¥í¥ó¤¬ÃÖ¤«¤ì¤Æ¤¤¤ë¾ì¹ç¤Ï¡¢
217 ¤½¤Î¥ª¥×¥·¥ç¥ó¤Ï°ú¤¿ô¤ò¤È¤Ã¤Æ¤â¤È¤é¤Ê¤¯¤Æ¤â¤è¤¤¡£
218 ¸½ºß¤Î \fIargv\fP Í×ÁǤ˥ƥ¥¹¥È¤¬¤¢¤ì¤Ð
219 (¤Ä¤Þ¤ê¡¢"\-oarg" ¤Î¤è¤¦¤Ë¡¢¥ª¥×¥·¥ç¥ó̾¼«¿È¤ÈƱ¤¸¥ï¡¼¥ÉÆâ¤Ë
220 ¥Æ¥¥¹¥È¤¬¤¢¤ë¾ì¹ç)¡¢¤½¤ì¤¬ \fIoptarg\fP ¤ËÊÖ¤µ¤ì¤ë¡£
221 ¤Ê¤±¤ì¤Ð \fIoptarg\fP ¤Ï 0 ¤ËÀßÄꤵ¤ì¤ë¡£
222 ¤³¤ì¤Ï GNU ¤Ë¤è¤ë³ÈÄ¥¤Ç¤¢¤ë¡£
226 ¤È¤½¤ì¤Ë³¤¯¥»¥ß¥³¥í¥ó¤¬Æþ¤Ã¤Æ¤¤¤ë¤È¡¢
233 .\"O option is reserved by POSIX.2 for implementation extensions.)
234 .\"O This behavior is a GNU extension, not available with libraries before
238 ¥ª¥×¥·¥ç¥ó¤ò¼ÂÁõ°Í¸¤Î³ÈÄ¥¤È¤·¤ÆͽÌ󤷤Ƥ¤¤ë)¡£
239 ¤³¤ÎÆ°ºî¤Ï GNU ¤Ë¤è¤ë³ÈÄ¥¤Ç¤¢¤ê¡¢glibc 2 °ÊÁ°¤Î¥é¥¤¥Ö¥é¥ê¤Ç¤Ï
244 .\"O permutes the contents of \fIargv\fP as it
245 .\"O scans, so that eventually all the nonoptions are at the end.
246 .\"O Two other modes are also implemented.
247 .\"O If the first character of
248 .\"O \fIoptstring\fP is \(aq+\(aq or the environment variable
249 .\"O .B POSIXLY_CORRECT
250 .\"O is set, then option processing stops as soon as a nonoption argument is
252 .\"O If the first character of \fIoptstring\fP is \(aq\-\(aq, then
253 .\"O each nonoption \fIargv\fP-element is handled as if it were the argument of
254 .\"O an option with character code 1. (This is used by programs that were
255 .\"O written to expect options and other \fIargv\fP-elements in any order
256 .\"O and that care about the ordering of the two.)
257 .\"O The special argument "\-\-" forces an end of option-scanning regardless
258 .\"O of the scanning mode.
261 ¤Ï \fIargv\fP ¤ò¥¹¥¥ã¥ó¤¹¤ëºÝ¤Ë½ç½ø¤òÊѹ¹¤·¡¢
262 ¥ª¥×¥·¥ç¥ó°Ê³°¤ÎÍ×ÁǤòºÇ¸å¤Ë°ÜÆ°¤¹¤ë¡£
263 ¾¤Ë¤â 2 ¤Ä¤Î¥â¡¼¥É¤¬¼ÂÁõ¤µ¤ì¤Æ¤¤¤ë¡£
264 \fIoptstring\fP ¤ÎÀèƬʸ»ú¤¬ \(aq+\(aq ¤Ç¤¢¤ë¤«¡¢´Ä¶ÊÑ¿ô
266 ¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ë¤Ï¡¢¥ª¥×¥·¥ç¥ó¤òÂоݤȤ¹¤ëÆ°ºî¤Ï¡¢
267 È󥪥ץ·¥ç¥ó¤Î°ú¤¿ô¤¬¸½¤ì¤¿Ãʳ¬¤Ç½ªÎ»¤¹¤ë¡£
268 \fIoptstring\fP ¤ÎÀèƬʸ»ú¤¬ \(aq\-\(aq ¤Ç¤¢¤ë¾ì¹ç¤Ë¤Ï¡¢
269 ¥ª¥×¥·¥ç¥ó¤Ç¤Ê¤¤ \fIargv\fP Í×ÁǤϡ¢
270 ʸ»ú¥³¡¼¥É 1 ¤Î¥ª¥×¥·¥ç¥ó¤Ç¤¢¤ë¤«¤Î¤è¤¦¤Ë°·¤ï¤ì¤ë (¤³¤ì¤òÍѤ¤¤ë¥×¥í¥°¥é¥à¤Ï¡¢
271 ¥ª¥×¥·¥ç¥ó¤ä \fIargv\fP Í×ÁǤòǤ°Õ¤Î½ç½ø¤Ç¼õ¤±Æþ¤ì¡¢¤«¤Ä¤½¤ì¤é¤Î½ç½ø¤¬
272 °ÕÌ£¤ò»ý¤Ä¤è¤¦¤Ë½ñ¤«¤ì¤Æ¤¤¤ëɬÍפ¬¤¢¤ë)¡£
273 "\-\-" ¤ÏÆüì¤Ê°ú¤¿ô¤Ç¡¢¥¹¥¥ã¥ó¤Î¥â¡¼¥É¤Ë¤è¤é¤º¡¢
274 ¥ª¥×¥·¥ç¥ó¤Î¥¹¥¥ã¥ó¤ò¶¯À©Åª¤Ë½ªÎ»¤µ¤»¤ë¡£
278 .\"O does not recognize an option character, it prints an
279 .\"O error message to \fIstderr\fP, stores the character in \fIoptopt\fP, and
280 .\"O returns \(aq?\(aq.
281 .\"O The calling program may prevent the error message by
282 .\"O setting \fIopterr\fP to 0.
283 ǧ¼±¤Ç¤¤Ê¤¤¥ª¥×¥·¥ç¥óʸ»ú¤¬¤¢¤ë¤È¡¢
285 ¤Ï¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤òɸ½à¥¨¥é¡¼½ÐÎÏ \fIstderr\fP ¤Ëɽ¼¨¤·¡¢
286 ¤½¤Îʸ»ú¤ò \fIoptopt\fP ¤ËÊݸ¤·¤Æ \(aq?\(aq ¤òÊÖ¤¹¡£
287 ¸Æ¤Ó½Ð¤·¤¿¥×¥í¥°¥é¥à¤Ç \fIopterr\fP ¤ò 0 ¤Ë¤·¤Æ¤ª¤±¤Ð¡¢
288 ¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤Îɽ¼¨¤òÍÞÀ©¤Ç¤¤ë¡£
292 .\"O finds an option character in \fIargv\fP that was not
293 .\"O included in \fIoptstring\fP, or if it detects a missing option argument,
294 .\"O it returns \(aq?\(aq and sets the external variable \fIoptopt\fP to the
295 .\"O actual option character.
296 .\"O If the first character
297 .\"O (following any optional \(aq+\(aq or \(aq\-\(aq described above)
298 .\"O of \fIoptstring\fP
299 .\"O is a colon (\(aq:\(aq), then
301 .\"O returns \(aq:\(aq instead of \(aq?\(aq to
302 .\"O indicate a missing option argument.
303 .\"O If an error was detected, and
304 .\"O the first character of \fIoptstring\fP is not a colon, and
305 .\"O the external variable \fIopterr\fP is nonzero (which is the default),
307 .\"O prints an error message.
310 \fIoptstring\fP ¤Ë¤Ê¤¤¥ª¥×¥·¥ç¥óʸ»ú¤ò¸«¤Ä¤±¤¿¾ì¹ç¡¢
311 ¤Þ¤¿¤Ï¥ª¥×¥·¥ç¥ó°ú¤¿ô¤¬Â¤ê¤Ê¤¤¤³¤È¤¬Ê¬¤«¤Ã¤¿¾ì¹ç¡¢
312 \&\(aq?\(aq ¤òÊÖ¤·¤Æ³°ÉôÊÑ¿ô \fIoptopt\fP ¤ò¤½¤Î¥ª¥×¥·¥ç¥óʸ»ú¤ËÀßÄꤹ¤ë¡£
313 \fIoptstring\fP ¤Î (¾å¤ÇÀâÌÀ¤·¤¿¥ª¥×¥·¥ç¥ó¤Ç»ØÄê¤Ç¤¤ë
314 \&\(aq+\(aq ¤Þ¤¿¤Ï \(aq\-\(aq ¸å¤Ë³¤¯) ºÇ½é¤Îʸ»ú¤¬
315 ¥³¥í¥ó (\(aq:\(aq) ¤Î¤È¤¡¢
317 ¤Ï¥ª¥×¥·¥ç¥ó°ú¤¿ô¤¬Â¤ê¤Ê¤¤¾ì¹ç¤Ë \(aq?\(aq ¤Ç¤Ï¤Ê¤¯ \(aq:\(aq ¤òÊÖ¤¹¡£
318 ¥¨¥é¡¼¤ò¸«¤Ä¤±¤¿¾ì¹ç¤Ç¡¢¤«¤Ä \fIoptstring\fP ¤ÎºÇ½é¤Îʸ»ú¤¬¥³¥í¥ó¤Ç¤Ê¤¯¡¢
319 ¤«¤Ä³°ÉôÊÑ¿ô \fIopterr\fP ¤¬ 0 ¤Ç¤Ê¤¤¾ì¹ç (¤³¤ì¤¬¥Ç¥Õ¥©¥ë¥È)¡¢
321 ¤Ï¥¨¥é¡¼¥á¥Ã¥»¡¼¥¸¤òɽ¼¨¤¹¤ë¡£
322 .\"O .SS getopt_long() and getopt_long_only()
323 .SS getopt_long() ¤È getopt_long_only()
325 .\"O .BR getopt_long ()
326 .\"O function works like
328 .\"O except that it also accepts long options, started with two dashes.
329 .\"O (If the program accepts only long options, then
331 .\"O should be specified as an empty string (""), not NULL.)
332 .\"O Long option names may be abbreviated if the abbreviation is
333 .\"O unique or is an exact match for some defined option.
335 .\"O may take a parameter, of the form
336 .\"O .B \-\-arg=param
338 .\"O .BR "\-\-arg param" .
340 ´Ø¿ô¤Ï¡¢Ä¹¤¤¥ª¥×¥·¥ç¥ó (2 ¤Ä¤Î¥À¥Ã¥·¥å "\-\-" ¤Ç»Ï¤Þ¤ë¥ª¥×¥·¥ç¥ó) ¤ò
341 ¼õ¤±Æþ¤ì¤ë¤³¤È¤ò½ü¤¤¤Æ
344 (¥×¥í¥°¥é¥à¤ËŤ¤¥ª¥×¥·¥ç¥ó¤À¤±¤¬ÅϤµ¤ì¤¿¾ì¹ç¡¢
346 ¤Ï NULL ¤Ç¤Ï¤Ê¤¯¶õʸ»úÎó ("") ¤È¤Ê¤ë)¡£
347 Ť¤¥ª¥×¥·¥ç¥ó¤Î̾Á°¤Ï¡¢Â¾¤È½Å¤Ê¤é¤Ê¤¤ÈϰϤˤª¤¤¤Æû½Ì¤Ç¤¤ë¡£
348 ¤¢¤ë¤¤¤ÏÄêµÁ¤µ¤ì¤¿¥ª¥×¥·¥ç¥ó¤ËÀµ³Î¤Ë¥Þ¥Ã¥Á¤¹¤ë¤â¤Î¤Ç¤â (ÅöÁ³) ¤«¤Þ¤ï¤Ê¤¤¡£
349 Ť¤¥ª¥×¥·¥ç¥ó¤Ï°ú¤¿ô¤ò¼è¤ë¤³¤È¤¬¤Ç¤¡¢
353 ¤È¸À¤¦·Á¼°¤Ç»ØÄꤹ¤ë¡£
356 .\"O is a pointer to the first element of an array of
357 .\"O .I struct option
364 ¤ÎÍ×ÁǤ«¤é¤Ê¤ëÇÛÎó¤Î¡¢ÀèƬÍ×ÁǤؤΥݥ¤¥ó¥¿¤Ç¤¢¤ë¡£
368 ¤Ç°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤µ¤ì¤Æ¤¤¤ë¡£
381 .\"O The meanings of the different fields are:
382 ¤½¤ì¤¾¤ì¤Î¥Õ¥£¡¼¥ë¥É¤Î°ÕÌ£¤Ï°Ê²¼¤ÎÄ̤ꡣ
385 .\"O is the name of the long option.
386 Ť¤¥ª¥×¥·¥ç¥ó¤Î̾Á°¡£
390 .\"O \fBno_argument\fP (or 0) if the option does not take an argument;
391 .\"O \fBrequired_argument\fP (or 1) if the option requires an argument; or
392 .\"O \fBoptional_argument\fP (or 2) if the option takes an optional argument.
393 \fBno_argument\fP (¤Þ¤¿¤Ï 0) ¤Ê¤é¡¢¥ª¥×¥·¥ç¥ó¤Ï°ú¤¿ô¤ò¤È¤é¤Ê¤¤¡£
394 \fBrequired_argument\fP (¤Þ¤¿¤Ï 1) ¤Ê¤é¡¢¥ª¥×¥·¥ç¥ó¤Ï°ú¤¿ô¤òɬÍפȤ¹¤ë¡£
395 \fBoptional_argument\fP (¤Þ¤¿¤Ï 2) ¤Ê¤é¡¢¥ª¥×¥·¥ç¥ó¤Ï°ú¤¿ô¤ò¤È¤Ã¤Æ¤â
399 .\"O specifies how results are returned for a long option.
402 .\"O .BR getopt_long ()
403 .\"O returns \fIval\fP. (For
404 .\"O example, the calling program may set \fIval\fP to the equivalent short
405 .\"O option character.)
407 .\"O .BR getopt_long ()
409 .\"O \fIflag\fP points to a variable which is set to \fIval\fP if the
410 .\"O option is found, but left unchanged if the option is not found.
411 Ť¤¥ª¥×¥·¥ç¥ó¤ËÂФ¹¤ë·ë²Ì¤ÎÊÖ¤·Êý¤ò»ØÄꤹ¤ë¡£\fIflag\fP ¤¬
415 (Î㤨¤Ð¸Æ¤Ó½Ð¤·¸µ¤Î¥×¥í¥°¥é¥à¤Ï¡¢
416 \fIval\fP ¤ËÅù²Á¤Ê¥ª¥×¥·¥ç¥óʸ»ú¤òÂåÆþ¤¹¤ë¤³¤È¤¬¤Ç¤¤ë)¡£
417 NULL °Ê³°¤Î¾ì¹ç¤Ë¤Ï¡¢
420 ¤³¤Î¤È¤¥ª¥×¥·¥ç¥ó¤¬¸«¤Ä¤«¤ë¤È \fIflag\fP ¤¬¥Ý¥¤¥ó¥È¤¹¤ëÊÑ¿ô¤Ë
421 \fIval\fP ¤¬ÂåÆþ¤µ¤ì¤ë¡£¸«¤Ä¤«¤é¤Ê¤¤¤È¤³¤ÎÊÑ¿ô¤ÏÊѹ¹¤µ¤ì¤Ê¤¤¡£
424 .\"O is the value to return, or to load into the variable pointed
425 .\"O to by \fIflag\fP.
426 ÊÖ¤êÃÍ¡¢¤Þ¤¿¤Ï \fIflag\fP ¤¬¥Ý¥¤¥ó¥È¤¹¤ëÊÑ¿ô¤Ø¥í¡¼¥É¤µ¤ì¤ëÃÍ¡£
428 .\"O The last element of the array has to be filled with zeros.
429 ÇÛÎó¤ÎºÇ¸å¤ÎÍ×ÁǤϡ¢Á´¤Æ 0 ¤ÇËä¤á¤é¤ì¤Æ¤¤¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤¡£
431 .\"O If \fIlongindex\fP is not NULL, it
432 .\"O points to a variable which is set to the index of the long option relative to
434 \fIlongindex\fP ¤Ï¡¢NULL ¤Ç¤Ê¤±¤ì¤Ð¡¢
435 Ť¤¥ª¥×¥·¥ç¥ó¤Î¥¤¥ó¥Ç¥Ã¥¯¥¹¤ò
437 ¤«¤é¤ÎÁêÂаÌÃ֤Ȥ·¤ÆÊÝ»ý¤·¤Æ¤¤¤ëÊÑ¿ô¤Ø¤Î¥Ý¥¤¥ó¥¿¤È¤Ê¤ë¡£
439 .\"O .BR getopt_long_only ()
441 .\"O .BR getopt_long (),
442 .\"O but \(aq\-\(aq as well
443 .\"O as "\-\-" can indicate a long option.
444 .\"O If an option that starts with \(aq\-\(aq
445 .\"O (not "\-\-") doesn't match a long option, but does match a short option,
446 .\"O it is parsed as a short option instead.
447 .BR getopt_long_only ()
450 ¤ÈƱÍͤÎÆ°ºî¤ò¤¹¤ë¤¬¡¢ \(aq\-\(aq ¤â "\-\-" ¤ÈƱÍͤˡ¢
451 Ť¤¥ª¥×¥·¥ç¥ó¤È¤·¤Æ°·¤ï¤ì¤ë¡£\(aq\-\(aq ¤Ç»Ï¤Þ¤ë
452 ("\-\-" °Ê³°¤Î) ¥ª¥×¥·¥ç¥ó¤¬¡¢Ä¹¤¤¤â¤Î¤Ë¤Ï¥Þ¥Ã¥Á¤·¤Ê¤¤¤¬Ã»¤¤¤â¤Î¤Ë
453 ¥Þ¥Ã¥Á¤¹¤ë¾ì¹ç¤Ë¤ª¤¤¤Æ¤Ï¡¢¤½¤ì¤Ïû¤¤¥ª¥×¥·¥ç¥ó¤È¤·¤Æ²ò¼á¤µ¤ì¤ë¡£
454 .\"O .SH "RETURN VALUE"
456 .\"O If an option was successfully found, then
458 .\"O returns the option character.
459 .\"O If all command-line options have been parsed, then
464 .\"O encounters an option character that was not in
466 .\"O then \(aq?\(aq is returned.
469 .\"O encounters an option with a missing argument,
470 .\"O then the return value depends on the first character in
472 .\"O if it is \(aq:\(aq, then \(aq:\(aq is returned; otherwise \(aq?\(aq is returned.
473 ¥ª¥×¥·¥ç¥ó¤¬Àµ¾ï¤Ë¸«¤Ä¤«¤ì¤Ð
475 ¤Ï¤½¤Î¥ª¥×¥·¥ç¥óʸ»ú¤òÊÖ¤¹¡£
476 ¤¹¤Ù¤Æ¤Î¥³¥Þ¥ó¥É¥é¥¤¥ó¥ª¥×¥·¥ç¥ó¤Î²òÀϤ¬½ª¤ï¤Ã¤¿¤é¡¢
480 ¤Ë´Þ¤Þ¤ì¤Ê¤¤¥ª¥×¥·¥ç¥óʸ»ú¤¬¸«¤Ä¤«¤ë¤È¡¢\(aq?\(aq ¤òÊÖ¤¹¡£
481 °ú¤¿ô¤¬Â¤ê¤Ê¤¤¥ª¥×¥·¥ç¥ó¤¬¸«¤Ä¤«¤Ã¤¿¾ì¹ç¡¢
484 ¤ÎºÇ½é¤Îʸ»ú¤Ë¤è¤ë°Û¤Ê¤ë: ºÇ½é¤Îʸ»ú¤¬ \(aq:\(aq ¤Ç¤¢¤ì¤Ð \(aq:\(aq ¤òÊÖ¤·¡¢
485 ¤½¤ì°Ê³°¤Î¾ì¹ç¤Ï \(aq?\(aq ¤òÊÖ¤¹¡£
487 .\"O .BR getopt_long ()
489 .\"O .BR getopt_long_only ()
490 .\"O also return the option
491 .\"O character when a short option is recognized.
492 .\"O For a long option, they
493 .\"O return \fIval\fP if \fIflag\fP is NULL, and 0 otherwise.
494 .\"O Error and \-1 returns are the same as for
496 .\"O plus \(aq?\(aq for an
497 .\"O ambiguous match or an extraneous parameter.
500 .BR getopt_long_only ()
502 û¤¤¥ª¥×¥·¥ç¥óʸ»ú¤òǧ¼±¤·¤¿¾ì¹ç¤Ë¤Ï¤½¤Îʸ»ú¤òÊÖ¤¹¡£
503 Ť¤¥ª¥×¥·¥ç¥ó¤ËÂФ·¤Æ¤Ï¡¢
504 \fIflag\fP ¤¬ NULL ¤Ê¤é \fIval\fP ¤òÊÖ¤·¡¢
505 \fIflag\fP ¤¬ NULL °Ê³°¤Ê¤é 0 ¤òÊÖ¤¹¡£
506 ¥¨¥é¡¼¤È \-1 ¤ÎÊÖ¤êÃͤÏ
509 ¤µ¤é¤Ë \(aq?\(aq ¤Ï¡¢¥Þ¥Ã¥Á¤¬³ÎÄê¤Ç¤¤Ê¤¤¾ì¹ç¤ä;ʬ¤Ê¥Ñ¥é¥á¡¼¥¿¡¼¤¬¤¢¤ë¾ì¹ç¤Ë¤âÊ֤롣
514 .\"O If this is set, then option processing stops as soon as a nonoption
515 .\"O argument is encountered.
516 ¤³¤ì¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ë¤È¡¢È󥪥ץ·¥ç¥ó¤Î°ú¤¿ô¤ËÅþ㤷¤¿»þÅÀ¤Ç¥ª¥×¥·¥ç¥ó
517 ¤ËÂФ¹¤ëÁàºî¤¬Ää»ß¤µ¤ì¤ë¡£
519 .B _<PID>_GNU_nonoption_argv_flags_
520 .\"O This variable was used by
522 .\"O 2.0 to communicate to glibc which arguments are the results of
523 .\"O wildcard expansion and so should not be considered as options.
524 .\"O This behavior was removed in
526 .\"O version 2.01, but the support remains in glibc.
529 2.0 ¤¬ glibc ¤ÈÄÌ¿®¤¹¤ë¤¿¤á¤ËÍѤ¤¤é¤ì¤¿¡£
530 ¤É¤Î°ú¤¿ô¤¬¥ï¥¤¥ë¥É¥«¡¼¥É¤òŸ³«¤·¤¿·ë²Ì¤Ç¡¢
531 ¤·¤¿¤¬¤Ã¤Æ¥ª¥×¥·¥ç¥ó¤È¤ß¤Ê¤¹¤Ù¤¤Ç¤Ê¤¤¤«¤òÃΤ餻¤ë¤â¤Î¤Ç¤¢¤ë¡£
534 ¤Î¥Ð¡¼¥¸¥ç¥ó 2.01 ¤Çºï½ü¤µ¤ì¤¿¤¬¡¢glibc ¤Ë¤Ï¤Þ¤À»Ä¤Ã¤Æ¤¤¤ë¡£
535 .\"O .SH "CONFORMING TO"
539 .\"O POSIX.2 and POSIX.1-2001,
540 .\"O provided the environment variable
541 .\"O .B POSIXLY_CORRECT
543 .\"O Otherwise, the elements of \fIargv\fP aren't really const, because we
545 .\"O We pretend they're const in the prototype to be
546 .\"O compatible with other systems.
549 ¤¬ÀßÄꤵ¤ì¤Æ¤¤¤ë¾ì¹ç¤Ï POSIX.2 ¤È POSIX.1-2001 ¤Ë½àµò¤¹¤ë¡£
550 ¾¤Î¾ì¹ç¤Ï \fIargv\fP ¤ÎÍ×ÁǤÏËÜÅö¤Î°ÕÌ£¤Ç¤ÎÄê¿ô¤Ë¤Ï¤Ê¤é¤Ê¤¤¡£
551 ¤Ê¤¼¤Ê¤é½ç½ø¤¬Êѹ¹¤µ¤ì¤Æ¤·¤Þ¤¦¤«¤é¤Ç¤¢¤ë¡£
552 ¤¿¤À¤·¤½¤ì¤é¤Ï¡¢¥×¥í¥È¥¿¥¤¥×¤Ç¤ÏÄê¿ô¤Ç¤¢¤ë¤«¤Î¤è¤¦¤Ë¤·¤Æ¤¢¤ë¡£
553 ¤³¤ì¤Ï¾¤Î¥·¥¹¥Æ¥à¤È¤Î¸ß´¹À¤Î¤¿¤á¤Ç¤¢¤ë¡£
555 .\"O The use of \(aq+\(aq and \(aq\-\(aq in
557 .\"O is a GNU extension.
559 ¤Ç \(aq+\(aq ¤ä \(aq\-\(aq ¤ò»È¤¦¤Î¤Ï GNU ¤Ë¤è¤ë³ÈÄ¥¤Ç¤¢¤ë.
561 .\"O On some older implementations,
565 .\"O SUSv1 permitted the declaration to appear in either
569 .\"O POSIX.1-2001 marked the use if
571 .\"O for this purpose as LEGACY.
572 .\"O POSIX.1-2001 does not allow the declaration to appear in
574 ¸Å¤¤¼ÂÁõ¤Î¤¤¤¯¤Ä¤«¤Ç¤Ï¡¢
589 ¤Ç¹Ô¤¦¤Î¤Ï¡Ö²áµî¤Î̾»Ä¡×¤Ç¤¢¤ë¤È¤µ¤ì¤¿¡£
592 ¤ÇÀë¸À¤ò¹Ô¤¦¤³¤È¤òǧ¤á¤Æ¤¤¤Ê¤¤¡£
594 .\"O .BR getopt_long "() and " getopt_long_only ():
595 .\"O These functions are GNU extensions.
596 .BR getopt_long "(), " getopt_long_only ():
597 ¤³¤ì¤é¤Î´Ø¿ô¤Ï GNU ¤Ë¤è¤ë³ÈÄ¥¤Ç¤¢¤ë¡£
600 .\"O A program that scans multiple argument vectors,
601 .\"O or rescans the same vector more than once,
602 .\"O and wants to make use of GNU extensions such as \(aq+\(aq
603 .\"O and \(aq\-\(aq at the start of
605 .\"O or changes the value of
606 .\"O .B POSIXLY_CORRECT
608 .\"O must reinitialize
612 .\"O to 0, rather than the traditional value of 1.
613 .\"O (Resetting to 0 forces the invocation of an internal initialization
614 .\"O routine that rechecks
615 .\"O .B POSIXLY_CORRECT
616 .\"O and checks for GNU extensions in
617 .\"O .IR optstring .)
618 Ê£¿ô¤Î°ú¤¿ô¥Ù¥¯¥È¥ë¤ò¥¹¥¥ã¥ó¤·¤¿¤ê¡¢Æ±¤¸°ú¤¿ô¥Ù¥¯¥È¥ë¤òÆó²ó°Ê¾å
619 ¥¹¥¥ã¥ó¤¹¤ë¤è¤¦¤Ê¥×¥í¥°¥é¥à¤Ç¡¢
621 ¤ÎÀèƬ¤Ç \(aq+\(aq ¤ä \(aq\-\(aq ¤È¤¤¤Ã¤¿ GNU ¤Ë¤è¤ë³ÈÄ¥µ¡Ç½¤ò»ÈÍѤ·¤¿¤ê¡¢
622 °ú¤¿ô¥Ù¥¯¥È¥ë¤ÎÀÚ¤êÂؤ¨»þ¤Ë
624 ¤ÎÃͤòÊѹ¹¤·¤¿¤ê¤¹¤ë¾ì¹ç¤Ë¤Ï¡¢
626 ¤òÅÁÅýŪ¤Ê 1 ¤Ç¤Ï¤Ê¤¯ 0 ¤Ë¥ê¥»¥Ã¥È¤¹¤ë¤³¤È¤Ç
628 ¤òºÆ½é´ü²½¤·¤Ê¤±¤ì¤Ð¤Ê¤é¤Ê¤¤
629 (0 ¤Ë¥ê¥»¥Ã¥È¤¹¤ë¤³¤È¤Ç¡¢
633 ¤Î GNU ³ÈÄ¥µ¡Ç½¤Î¥Á¥§¥Ã¥¯¤ò¹Ô¤¦ÆâÉô½é´ü²½¥ë¡¼¥Á¥ó¤¬µ¯Æ°¤µ¤ì¤ë)¡£
636 .\"O The POSIX.2 specification of
638 .\"O has a technical error described in POSIX.2 Interpretation 150.
640 .\"O implementation (and probably all other implementations) implements the
641 .\"O correct behavior rather than that specified.
644 ¤Î»ÅÍͤˤϵ»½ÑŪ¤ÊÌäÂ꤬¤¢¤ê¡¢
645 ¤½¤ÎÆâÍÆ¤Ï POSIX.2 Interpretation 150 ¤Ëµ¤µ¤ì¤Æ¤¤¤ë¡£
646 GNU ¤Ë¤è¤ë¼ÂÁõ¤Ç¤Ï (¤ª¤½¤é¤¯Â¾¤Î¤¹¤Ù¤Æ¤Î¼ÂÁõ¤Ç¤â)¡¢
647 »ÅÍͤȰۤʤëÀµ¤·¤¤Æ°ºî¤ò¤¹¤ë¤è¤¦¤Ë¼ÂÁõ¤µ¤ì¤Æ¤¤¤ë¡£
650 .\"O The following trivial example program uses
652 .\"O to handle two program options:
654 .\"O with no associated value; and
656 .\"O which expects an associated value.
657 °Ê²¼¤Ë¼¨¤¹´Êñ¤Ê¥µ¥ó¥×¥ë¥×¥í¥°¥é¥à¤Ç¤Ï¡¢
658 Æó¼ïÎà¤Î¥×¥í¥°¥é¥à¥ª¥×¥·¥ç¥ó¤ò°·¤¦¤Î¤Ë
660 ¤ò»ÈÍѤ·¤Æ¤¤¤ë¡£°ì¤Ä¤ÏÃͤòȼ¤ï¤Ê¤¤
662 ¤Ç¡¢¤â¤¦°ì¤Ä¤ÏÂбþ¤¹¤ëÃͤ¬É¬ÍפÊ
672 main(int argc, char *argv[])
680 while ((opt = getopt(argc, argv, "nt:")) != \-1) {
686 nsecs = atoi(optarg);
689 default: /* \(aq?\(aq */
690 fprintf(stderr, "Usage: %s [\-t nsecs] [\-n] name\\n",
696 printf("flags=%d; tfnd=%d; optind=%d\\n", flags, tfnd, optind);
698 if (optind >= argc) {
699 fprintf(stderr, "Expected argument after options\\n");
703 printf("name argument = %s\\n", argv[optind]);
705 /* Other code omitted */
711 .\"O The following example program illustrates the use of
712 .\"O .BR getopt_long ()
713 .\"O with most of its features.
716 ¤Î»ÈÍÑË¡¤ò¡¢¤Û¤Ü¤¹¤Ù¤Æ¤Îµ¡Ç½¤Ë¤Ä¤¤¤Æ¼¨¤·¤¿¥×¥í¥°¥é¥à¤ÎÎã¤Ç¤¢¤ë¡£
719 #include <stdio.h> /* for printf */
720 #include <stdlib.h> /* for exit */
724 main(int argc, char **argv) {
726 int digit_optind = 0;
729 int this_option_optind = optind ? optind : 1;
730 int option_index = 0;
731 static struct option long_options[] = {
735 {"verbose", 0, 0, 0},
736 {"create", 1, 0, \(aqc\(aq},
741 c = getopt_long(argc, argv, "abc:d:012",
742 long_options, &option_index);
748 printf("option %s", long_options[option_index].name);
750 printf(" with arg %s", optarg);
757 if (digit_optind != 0 && digit_optind != this_option_optind)
758 printf("digits occur in two different argv\-elements.\\n");
759 digit_optind = this_option_optind;
760 printf("option %c\\n", c);
764 printf("option a\\n");
768 printf("option b\\n");
772 printf("option c with value \(aq%s\(aq\\n", optarg);
776 printf("option d with value \(aq%s\(aq\\n", optarg);
783 printf("?? getopt returned character code 0%o ??\\n", c);
788 printf("non-option ARGV\-elements: ");
789 while (optind < argc)
790 printf("%s ", argv[optind++]);
800 .BR feature_test_macros (7)