1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
|
<TITLE>getopt</TITLE>
<body background=../../GRAPHICS/bg1.gif>
<hr>
<pre>
<h3>GETOPT(3) Linux Programmer's Manual GETOPT(3)
</h3>
<h3>NAME
</h3> getopt - Read command line options
<h3>SYNOPSIS
</h3> #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 *shortopts,
const struct option *longopts, int longind);
<h3>DESCRIPTION
</h3> 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 invoca-
tion. optstring is a list of available option characters.
If such a character is followed by a colon, the option
takes an argument, which is placed in optarg.
The external variable optind is the index of the next
array element of argv[] to be processed; it communicates
from one call of getopt() to the next which element to
process.
The getopt_long() function works like getopt() except that
it also accepts long options, started out by two dashes.
If these take values, it is either in the form --arg=value
or --arg value. It takes the additional arguments lon-
gopts which is a pointer to the first element of an array
of struct option declared in <getopt.h> as
struct option {
const char *name;
int has_arg;
int *flag;
int val;
};
The meaning of the different fields are:
name is the name of the long option.
has_arg
is a boolean value which should be set to nonzero
if the long option takes a value.
flag determines the return value if getopt_long()
<h3>GNU April 25, 1993 1
</h3>
<h3>GETOPT(3) Linux Programmer's Manual GETOPT(3)
</h3>
returns a value for a long option; if it is non-
zero, zero is returned as a function value, other-
wise val.
val determines the value to return if flag is zero.
The last element of the array has to be filled with
zeroes.
The option_index points to the index of the long option
relative to longopts.
<h3>RETURN VALUE
</h3> The getopt() function returns the option character if the
option was found successfully, ':' if there was a missing
parameter for one of the options, '?' for an unknown
option character and -1 for the end of the option list.
<h3>EXAMPLE
</h3> The following example program, from the source code,
illustrates the use of getopt_long() with most of its fea-
tures.
#include <stdio.h>
int
main (argc, argv)
int argc;
char **argv;
{
int c;
int digit_optind = 0;
while (1)
{
int this_option_optind = optind ? optind : 1;
int option_index = 0;
static struct option long_options[] =
{
{"add", 1, 0, 0},
{"append", 0, 0, 0},
{"delete", 1, 0, 0},
{"verbose", 0, 0, 0},
{"create", 1, 0, 'c'},
{"file", 1, 0, 0},
{0, 0, 0, 0}
};
c = getopt_long (argc, argv, "abc:d:012",
long_options, &option_index);
if (c == -1)
break;
switch (c)
<h3>GNU April 25, 1993 2
</h3>
<h3>GETOPT(3) Linux Programmer's Manual GETOPT(3)
</h3>
{
case 0:
printf ("option %s", long_options[option_index].name);
if (optarg)
printf (" with arg %s", optarg);
printf ("0);
break;
case '0':
case '1':
case '2':
if (digit_optind != 0 && digit_optind != this_option_optind)
printf ("digits occur in two different argv-elements.0);
digit_optind = this_option_optind;
printf ("option %c0, c);
break;
case 'a':
printf ("option a0);
break;
case 'b':
printf ("option b0);
break;
case 'c':
printf ("option c with value `%s'0, optarg);
break;
case 'd':
printf ("option d with value `%s'0, optarg);
break;
case '?':
break;
default:
printf ("?? getopt returned character code 0%o ??0, c);
}
}
if (optind < argc)
{
printf ("non-option ARGV-elements: ");
while (optind < argc)
printf ("%s ", argv[optind++]);
printf ("0);
}
exit (0);
}
<h3>BUGS
</h3> This manpage is confusing.
<h3>GNU April 25, 1993 3
</h3>
<h3>GETOPT(3) Linux Programmer's Manual GETOPT(3)
</h3>
<h3>CONFORMS TO
</h3> getopt() :
POSIX.1
<h3>GNU April 25, 1993 4
</h3>
</pre>
<P>
<hr>
<p>
<center>
<table border=2 width=80%>
<tr align=center>
<td width=25%>
<a href=../cref.html>Top</a>
</td><td width=25%>
<a href=../master_index.html>Master Index</a>
</td><td width=25%>
<a href=../SYNTAX/keywords.html>Keywords</a>
</td><td width=25%>
<a href=../FUNCTIONS/funcref.htm>Functions</a>
</td>
</tr>
</table>
</center>
<p>
<hr>
This manual page was brought to you by <i>mjl_man V-2.0</i>
|