Provided by: manpages-ru-dev_4.17.0-2_all 
ИМЯ
getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt - разбираю параметры
командной строки
LIBRARY
Standard C library (libc, -lc)
СИНТАКСИС
#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);
Требования макроса тестирования свойств для glibc (см. feature_test_macros(7)):
getopt():
_POSIX_C_SOURCE >= 2 || _XOPEN_SOURCE
getopt_long(), getopt_long_only():
_GNU_SOURCE
ОПИСАНИЕ
Функция getopt() разбирает аргументы командной строки. Её аргументы argc и argv являются
счётчиком и массивом аргументов, которые передаются функции main() при запуске программы.
Элемент argv, начинающийся с «-» (и не являющийся «-» или «--»), считается параметром.
Символы этого элемента (не считая начального «-») являются символами параметра. При каждом
повторном вызове getopt() возвращают следующий символ параметра и так для каждого
следующего параметра.
Переменная optind — это индекс следующего обрабатываемого элемента argv. Система
инициализирует это значение 1. Вызывающий может сбросить его в 1 для перезапуска
сканирования того же argv, или при сканировании нового вектора аргументов.
Если getopt() встречает символ другого параметра, она возвращает этот символ, обновляя
внешнюю переменную optind и статическую переменную nextchar, так что следующий вызов
getopt() может продолжить проверку с символа следующего параметра или элемента argv.
Если символов параметров больше нет, то getopt() возвращает -1. При этом optind станет
индексом первого элемента argv, не являющегося параметром.
optstring is a string containing the legitimate option characters. A legitimate option
character is any visible one byte ascii(7) character (for which isgraph(3) would return
nonzero) that is not '-', ':', or ';'. 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 '+' is
not the first character of optstring, it is treated as a normal option. If
POSIXLY_CORRECT behaviour is required in this case optstring will contain two '+' symbols.
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.
При обработке списка параметров getopt() может определить два типа ошибок: (1) — символ
параметра, не заданный в optstring и (2) — отсутствующий аргумент параметра (т. е.,
параметра в конце командной строки без ожидаемого аргумента). Эти ошибки обрабатываются и
о них сообщается следующем образом:
• По умолчанию, getopt() печатает сообщение об ошибке в стандартный поток ошибок,
помещает ошибочный символ параметра в optopt и возвращает '?' как результат функции.
• Если вызывающий присвоил глобальной переменной opterr значение 0, то getopt() не
печатает сообщение об ошибке. Вызывающий может определить, что произошла ошибка,
сравнив возвращаемое значение функции с '?' (по умолчанию opterr имеет ненулевое
значение).
• Если первый символ (после необязательных '+' или '-', описанных выше) optstring —
двоеточие (':'), то getopt() также не печатает сообщение об ошибке. При этом
возвращается ':' вместо '?', что показывает отсутствие аргумента параметра. Это
позволяет вызывающему отличить один тип ошибок от другого.
getopt_long() и getopt_long_only()
Функция getopt_long() работает так же, как getopt(), за исключением того, что она
воспринимает и длинные параметры, начинающиеся с двух дефисов (если программа принимает
только длинные параметры, то значение optstring должно быть равно пустой строке (""), не
NULL). Длинные параметры можно сокращать, если сокращение сохраняет уникальность параметра
или полностью совпадает с одним из определённых параметров. Длинный параметр может иметь
значение вида --параметр=значение или --параметр значение.
Аргумент longopts является указателем на первый элемент массива структур struct option,
объявленного в <getopt.h> следующим образом
struct option {
const char *name;
int has_arg;
int *flag;
int val;
};
Значения различных полей:
имя имя длинного параметра
has_arg
может быть: no_argument (или 0), если параметр не требует значения;
required_argument (или 1), если параметр требует значения; optional_argument (или
2), если параметр может иметь необязательное значение.
flag способ возвращения результатов для длинного параметра. Если flag равен NULL, то
getopt_long() возвращает val (например, вызывающая программа может назначить val
эквивалентом символа короткого параметра). В противном случае getopt_long()
возвращает 0, а flag указывает на переменную, устанавливаемое значение которой
равно val, если параметр найден; и оставляемую без изменений, если параметр не
найден.
val значение, которое возвращается или загружается в переменную, на которую указывает
flag.
Последний элемент массива должен быть заполнен нулями.
Если longindex не равен NULL, то он указывает на переменную, содержащую индекс длинного
параметра в соответствии с longopts.
Функция getopt_long_only() работает так же, как getopt_long(), но в качестве указателя
длинного параметра может служить не только «--», но и «-». Если параметр, начинающийся с
«-» (не с «--»), не совпадает с длинным параметром, но совпадает с коротким, то он
обрабатывается как короткий параметр.
ВОЗВРАЩАЕМОЕ ЗНАЧЕНИЕ
Если параметр найден, то getopt() возвращает символ параметра. Если все параметры
командной строки обработаны, то getopt() возвращает -1. Если getopt() находит символ,
которого нет в optstring, то возвращается «?». Если getopt() находит символ с
отсутствующим аргументом, то возвращаемое значение зависит от первого символа optstring:
если это «:», то возвращается «:», в противном случае возвращается «?».
Функции getopt_long() и getopt_long_only() также возвращают символ параметра, если
распознан короткий параметр. Для длинного параметра они возвращают val, если flag равен
NULL, и 0 в противном случае. Возвращаемые ошибки и -1 имеют то же значение, что и для
getopt(), кроме того, «?» возвращается при двусмысленном толковании параметра.
ОКРУЖЕНИЕ
POSIXLY_CORRECT
Если установлена эта переменная, то обработка параметров прерывается на первом
аргументе, не являющемся параметром.
_<PID>_GNU_nonoption_argv_flags_
This variable was used by bash(1) 2.0 to communicate to glibc which arguments are
the results of wildcard expansion and so should not be considered as options. This
behavior was removed in bash(1) 2.01, but the support remains in glibc.
АТРИБУТЫ
Описание терминов данного раздела смотрите в attributes(7).
┌─────────────────────────┬──────────────────────┬────────────────────────────────────────┐
│Интерфейс │ Атрибут │ Значение │
├─────────────────────────┼──────────────────────┼────────────────────────────────────────┤
│getopt(), getopt_long(), │ Безвредность в нитях │ MT-Unsafe race:getopt env │
│getopt_long_only() │ │ │
└─────────────────────────┴──────────────────────┴────────────────────────────────────────┘
СТАНДАРТЫ
getopt():
POSIX.1-2001, POSIX.1-2008, and POSIX.2, provided the environment variable
POSIXLY_CORRECT is set. Otherwise, the elements of argv aren't really const,
because these functions permute them. Nevertheless, const is used in the prototype
to be compatible with other systems.
Использование «+» и «-» в optstring является расширением GNU.
В некоторых старых реализациях getopt() объявлялась в <stdio.h>. В SUSv1 разрешено
её объявлять в <unistd.h> или <stdio.h>. В POSIX.1-1996 отмечено, что использование
<stdio.h> УСТАРЕЛО. В POSIX.1-2001 не требуется объявлять эту функцию в <stdio.h>.
getopt_long() и getopt_long_only():
Эти функции являются расширениями GNU.
ЗАМЕЧАНИЯ
В программе, где анализируется несколько векторов параметров, или разбирается один вектор
более одного раза и нужно использовать расширения GNU «+» и «-» в начале optstring или
изменять значение POSIXLY_CORRECT между разборами, должна повторно инициализировать
getopt() сбрасывая optind в 0, а не в обычное значение 1 (сброс в 0 вызывает
принудительный вызов внутренней процедуры, повторно проверяющей POSIXLY_CORRECT и
расширения GNU в optstring).
Command-line arguments are parsed in strict order meaning that an option requiring an
argument will consume the next argument, regardless of whether that argument is the
correctly specified option argument or simply the next option (in the scenario the user
mis-specifies the command line). For example, if optstring is specified as "1n:" and the
user specifies the command line arguments incorrectly as prog -n -1, the -n option will be
given the optarg value "-1", and the -1 option will be considered to have not been
specified.
ПРИМЕРЫ
getopt()
В приведённом ниже пример программы getopt() используется два параметра программы: -n без
значения и -t значение со значением.
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
int
main(int argc, char *argv[])
{
int flags, opt;
int nsecs, tfnd;
nsecs = 0;
tfnd = 0;
flags = 0;
while ((opt = getopt(argc, argv, "nt:")) != -1) {
switch (opt) {
case 'n':
flags = 1;
break;
case 't':
nsecs = atoi(optarg);
tfnd = 1;
break;
default: /* '?' */
fprintf(stderr, "Использование: %s [-t nsecs] [-n] имя\n",
argv[0]);
exit(EXIT_FAILURE);
}
}
printf("flags=%d; tfnd=%d; nsecs=%d; optind=%d\n",
flags, tfnd, nsecs, optind);
if (optind >= argc) {
fprintf(stderr, "После параметра требуется значение\n");
exit(EXIT_FAILURE);
}
printf("параметр = %s\n", argv[optind]);
/* остальной код не показан */
exit(EXIT_SUCCESS);
}
getopt_long()
Приведённый ниже пример программы иллюстрирует использование большинства возможностей
getopt_long().
#include <getopt.h>
#include <stdio.h> /* for printf */
#include <stdlib.h> /* for exit */
int
main(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", required_argument, 0, 0 },
{"append", no_argument, 0, 0 },
{"delete", required_argument, 0, 0 },
{"verbose", no_argument, 0, 0 },
{"create", required_argument, 0, 'c'},
{"file", required_argument, 0, 0 },
{0, 0, 0, 0 }
};
c = getopt_long(argc, argv, "abc:d:012",
long_options, &option_index);
if (c == -1)
break;
switch (c) {
case 0:
printf("параметр %s", long_options[option_index].name);
if (optarg)
printf(" со значением %s", optarg);
printf("\n");
break;
case '0':
case '1':
case '2':
if (digit_optind != 0 && digit_optind != this_option_optind)
printf("Встречена цифра в двух различных элементах argv.\n");
digit_optind = this_option_optind;
printf("параметр %c\n", c);
break;
case 'a':
printf("параметр a\n");
break;
case 'b':
printf("параметр b\n");
break;
case 'c':
printf("параметр c со значением «%s»\n", optarg);
break;
case 'd':
printf("параметр d со значением «%s»\n", optarg);
break;
case '?':
break;
default:
printf("?? getopt вернула код символа 0%o ??\n", c);
}
}
if (optind < argc) {
printf("элементы ARGV не параметры: ");
while (optind < argc)
printf("%s ", argv[optind++]);
printf("\n");
}
exit(EXIT_SUCCESS);
}
СМ. ТАКЖЕ
getopt(1), getsubopt(3)
ПЕРЕВОД
Русский перевод этой страницы руководства был сделан Azamat Hackimov
<azamat.hackimov@gmail.com>, Dmitry Bolkhovskikh <d20052005@yandex.ru>, Vladislav
<ivladislavefimov@gmail.com>, Yuri Kozlov <yuray@komyakino.ru> и Иван Павлов
<pavia00@gmail.com>
Этот перевод является бесплатной документацией; прочитайте Стандартную общественную
лицензию GNU версии 3 ⟨https://www.gnu.org/licenses/gpl-3.0.html⟩ или более позднюю, чтобы
узнать об условиях авторского права. Мы не несем НИКАКОЙ ОТВЕТСТВЕННОСТИ.
Если вы обнаружите ошибки в переводе этой страницы руководства, пожалуйста, отправьте
электронное письмо на ⟨man-pages-ru-talks@lists.sourceforge.net⟩.