1. В имени программы должно быть не менее двух и не более девяти символов.
2. Имена программ должны содержать лишь строчные символы и цифры.
3. Имя опции должно быть простым буквенно-цифровым символом. Опции с множеством цифр не должны допускаться. Для производителей, реализующих утилиты POSIX, опция -W
зарезервирована для специфичных для производителя опций.
4. Все опции должны начинаться с символа '-
'.
5. Для опций, не требующих аргументов, должно быть возможно объединение нескольких опций после единственного символа '-
'. (Например, 'foo -a -b -c
' и 'foo -abc
' должны интерпретироваться одинаково.)
6. Когда опции все же требуется аргумент, он должен быть отделен от опции пробелом (например, 'fgrep -f patfile
').
Однако, стандарт допускает историческую практику, при которой иногда опция и ее операнд могут находиться в одной строке: 'fgrep -fpatfile
'. На практике функции getopt()
и getopt_long()
интерпретируют '-fpatfile
' как '-f patfile
', а не как '-f -p -a -t ...
'.
7. Аргументы опций не должны быть необязательными.
Это означает, что если в документации программы указано, что опции требуется аргумент, этот аргумент должен присутствовать всегда, иначе программа потерпит неудачу GNU getopt()
все же предусматривает необязательные аргументы опций, поскольку иногда они полезны
8. Если опция принимает аргумент, который может иметь несколько значений, программа должна получать этот аргумент в виде одной строки со значениями, разделенными запятыми или разделителем.
Например, предположим, что гипотетической программе myprog
требуется список пользователей для опции -u
. Далее она может быть вызвана одним из двух способов:
myprog -u "arnold,joe,jane" /* Разделение запятыми */
myprog -u "arnold joe jane" /* Разделение пробелами */
В таком случае вы должны самостоятельно отделить и обработать каждое значение (т.е. здесь нет стандартной процедуры), но ручная реализация обычно проста.
9. Опции должны находиться в командной строке первыми, перед операндами. Версии getopt()
Unix проводят в жизнь это соглашение. GNU getopt()
по умолчанию этого не делает, хотя вы можете настроить его на это.
10. Специальный аргумент '--
' указывает на окончание всех опций. Все последующие аргументы командной строки рассматриваются как операнды, даже если они начинаются с черточки.
11. Порядок, в котором приведены опции, не должен играть роли. Однако, для взаимно исключающих опций, когда одна опция перекрывает установки другой, тогда (так сказать) последняя побеждает. Если опция, имеющая аргумент, повторяется, программа должна обработать аргументы по порядку. Например, 'myprog -u arnold -u jane
' то же самое, что и 'myprog -u "arnold, jane"
'. (Вам придется осуществить это самостоятельно; getopt()
вам не поможет.)
12. Нормально, когда порядок аргументов имеет для программы значение. Каждая программа должна документировать такие вещи.
13. Программы, читающие или записывающие именованные файлы, должны трактовать единственный аргумент '-
' как означающий стандартный ввод или стандартный вывод, в зависимости от того, что подходит программе.
Отметим, что многие стандартные программы не следуют всем указанным соглашениям. Главной причиной является историческая совместимость; многие такие программы предшествовали систематизации этих соглашений.
2.1.2. Длинные опции GNU
Как мы видели в разделе 1.4.2 «Поведение программ», программам GNU рекомендуется использовать длинные опции в форме --help
, --verbose
и т.д. Такие опции, поскольку они начинаются с '--
', не конфликтуют с соглашениями POSIX. Их также легче запомнить, и они предоставляют возможность последовательности среди всех утилит GNU. (Например, --help
является везде одним и тем же, в отличие от -h
для «help», -i
для «information» и т.д.) Длинные опции GNU имеют свои собственные соглашения, реализованные в функции getopt_long()
:
1. У программ, реализующих инструменты POSIX, каждая короткая опция (один символ) должна иметь также свой вариант в виде длинной опции.
2. Дополнительные специфические для GNU опции не нуждаются в соответствующей короткой опции, но мы рекомендуем это сделать.
3. Длинную опцию можно сократить до кратчайшей строки, которая остается уникальной. Например, если есть две опции --verbose
и --verbatim
, самыми короткими сокращениями будут --verbo
и --verba
.
4. Аргументы опции отделяются от длинных опций либо разделителем, либо символом =
. Например, --sourcefile=/some/file
или --sourcefile /some/file
.
5. Опции и аргументы могут быть заинтересованы в операндах командной строки, getopt_long()
переставляет аргументы таким образом, что сначала обрабатываются все опции, а затем все операнды доступны последовательно. (Такое поведение можно запретить.)
6. Аргументы опций могут быть необязательными. Для таких опций считается, что аргумент присутствует, если он находится в одной строке с опцией. Это работает лишь для коротких опций. Например, если -х такая опция и дана строка 'foo -хYANKEES -y
', аргументом -х
является 'YANKEES
'. Для 'foo -х -y
' у -х
нет аргументов.
7. Программы могут разрешить длинным опциям начинаться с одной черточки (Это типично для многих программ X Window.)
Многое из этого станет яснее, когда позже в этой главе мы рассмотрим getopt_long()
.
GNU Coding Standards уделяет значительное место перечислению всех длинных и коротких опций, используемых программами GNU. Если вы пишете программу, использующую длинные опции, посмотрите, нет ли уже использующихся имен опций, которые имело бы смысл использовать и вам.
2.2. Базовая обработка командной строки
Программа на С получает доступ к своим аргументам командной строки через параметры argc
и argv
. Параметр argc
является целым, указывающим число имеющихся аргументов, включая имя команды. Есть два обычных способа определения main()
, отличающихся способом объявления argc
:
int main(int argc, char *argv[]) int main(int argc, char **argv)
{ {
... ...
} }
Практически между двумя этими объявлениями нет разницы, хотя первое концептуально более понятно: argc
является массивом указателей на символы. А второе определение технически более корректно, это то, что мы используем. На рис. 2.2 изображена эта ситуация.
Рис. 2.2. Память для argc
По соглашению, argv[0]
является именем программы. (Детали см. в разделе 9.1.4.3. «Имена программ и argv[0]
».) Последующие элементы являются аргументами командной строки. Последним элементом массива argv
является указатель NULL
.