Стандарт кодирования GNU. : Стандарты для командной строки

Вперед Назад Содержание

---

18. Стандарты для командной строки

Не следует делать поведение утилиты зависящим от имени, использованного для ее вызова. Иногда бывает полезно сделать ссылки на утилиту с различными именами, но работа программы не должна зависеть от этого имени.

Вместо этого следует использовать передачу опции программе при запуске, либо по разному ее компилировать, либо и то, и другое для выбора разных вариантов поведения программы.

Точно так же, не надо делать поведение программы зависящим от типа используемого выходного устройства. Независимость от устройств является важным принципом разработки систем; не следует пренебрегать им только для того, чтобы уберечь кого-либо от необходимости задать лишнюю опцию.

Если Вы считаете, что один вариант работы программы более полезен при выводе на терминал, а другой - при выводе в файл или конвейер, то обычно лучше сделать, чтобы умолчанию подразумевался вывод на терминал, и ввести опции для запроса других вариантов поведения программы.

Соображения совместимости требуют, чтобы некоторые программы зависели от типа устройства вывода. Будет ужасно, если ls или sh не будут делать то, к чему привыкли и чего ожидают от них все пользователи. В некоторых из этих случаев, мы добавляем альтернативную версию утилит, которая не зависит от типа выходного устройства. Например, мы предоставляем программу dir, которая работает почти как ls, но всегда имеет по умолчанию многоколоночный формат вывода.

Стоит следовать требованиям POSIX для опций командной строки в программах. Простейший способ сделать это состоит в использовании getopt для их разбора. Заметим, что GNU-версия getopt обычно допускает опции везде до тех пор, пока не встретится специальный аргумент '--'. Это не входит в требования POSIX и является GNU-расширением.

Следует определять опции с длинными именами, которые эквивалентны однобуквенным опциям в стиле Unix. Мы считаем, что это делает GNU более дружественным. Проще всего удовлетворить это требование, воспользовавшись функцией GNU getopt_long.

Одно из преимуществ опций с длинными именами состоит в том, что они могут быть последовательно согласованы в различных программах. Например, пользователь ожидает, что режим подробной выдачи информации о работе программы будет включаться в любой программе с помощью одной и той же опции, записываемой '--verbose'. Для достижения подобной совместимости загляните в таблицу длинных общих имен опций, когда будете выбирать названия опций в своей программе. Таблица приводится ниже.

Если Вы используете имена, которые еще не присутствуют в этой таблице, пошлите их список по электронной почте по адресу 'gnu@prep.ai.mit.edu' для того, чтобы их можно было внести в эту таблицу.

Обычно принято в качестве обычных аргументов программы задавать имена входных файлов; имена выходных файлов должны быть заданы с помощью опции (лучше всего выбрать для этого опцию -o). Даже если Вы разрешаете указывать имена выходных файлов как обычные аргументы в командной строке из соображений совместимости, все равно следует ввести дополнительно соответствующую опцию. Это приведет к большей согласованности различных GNU-утилит друг с другом, и упростит пользователям жизнь.

Программы должны поддерживать опцию '--version', которая приводит к печати номера версии программы на стандартный вывод и последующему успешному завершению, и опцию '--help', которая печатает информацию об использовании опций на стандартный вывод и так же успешно завершает выполнение программы. При использовании этих опций не должна выполняться ничего, кроме печати запрошенной информации.

'auto-check'

'-a' в 'recode'.

'auto-reference'

'-A' в 'ptx'.

'after-date'

'-N' в 'tar'.

'all'

'-a' в 'du', 'ls', 'nm', 'stty', 'uname', и 'unexpand'.

'all-text'

'-a' в 'diff'.

'almost-all'

'-A' в 'ls'.

'append'

'-a' в 'etags', 'tee', 'time'; '-r' в 'tar'.

'archive'

'-a' в 'cp'.

'arglength'

'-l' в 'm4'.

'ascii'

'-a' в 'diff'.

'assume-new'

'-W' в Make.

'assume-old'

'-o' в Make.

'backward-search'

'-B' в etags.

'batch'

Используется в GDB.

'baud'

Используется в GDB.

'before'

'-b' в 'tac'.

'binary'

'-b' в 'cpio' и 'diff'.

'block-size'

используется в 'cpio' и 'tar'.

'blocks'

'-b' в 'head' и 'tail'.

'break-file'

'-b' в 'ptx'.

'brief'

Используется в различных программах для того, чтобы уменьшить объем выдаваемой информации.

'bytes'

'-c' в 'head', 'split', и 'tail'.

'c++'

'-C' в 'etags'.

'catenate'

'-A' в 'tar'.

'cd'

Используется в различных программах для указания используемого каталога.

'changes'

'-c' в 'chgrp' и 'chown'.

'classify'

'-F' в 'ls'.

'colons'

'-c' в 'recode'.

'command'

'-c' в 'su'; '-x' в GDB.

'compare'

'-d' в 'tar'.

'compress'

'-Z' в 'tar'.

'concatenate'

'-A' в 'tar'.

'confirmation'

'-w' в 'tar'.

'context'

Используется в 'diff'.

'copyright'

'-C' в 'ptx' и 'recode'.

'core'

Используется в GDB.

'count'

'-q' в 'who'.

'count-links'

'-l' в 'du'.

'create'

Используется в 'tar' и 'cpio'.

'cxref'

'-x' в 'etags'.

'date'

'-d' в 'touch'.

'debug'

'-d' в Make и 'm4'; '-t' в Bison.

'define'

'-D' в 'm4'.

'defines'

'-d' в Bison и 'etags'.

'delete'

'-D' в 'tar'.

'dereference'

'-L' в 'chgrp', 'chown', 'cpio', 'du', 'ls', и 'tar'.

'dereference-args'

'-D' в 'du'.

'diacritics'

'-d' в 'recode'.

'dictionary-order'

'-d' в 'look'.

'diff'

'-d' в 'tar'.

'digits'

'-n' в 'csplit'.

'directory'

Указывается каталог для использования, применяется в различных программах. В 'ls' это означает показать сам каталог, а не его содержимое. В 'rm' и 'ln' это означает, что не надо особым образом обрабатывать ссылки на каталоги.

'discard-all'

'-x' в 'strip'.

'discard-locals'

'-X' в 'strip'.

'diversions'

'-N' в 'm4'.

'dry-run'

'-n' в Make.

'ed'

'-e' в 'diff'.

'elide-empty-files'

'-z' в 'csplit'.

'entire-new-file'

'-N' в 'diff'.

'environment-overrides'

'-e' в Make.

'eof'

'-e' в 'xargs'.

'epoch'

Используется в GDB.

'error-limit'

Используется в Makeinfo.

'error-output'

'-o' в 'm4'.

'escape'

'-b' в 'ls'.

'exclude-from'

'-X' в 'tar'.

'exec'

Используется в GDB.

'exit'

'-x' в 'xargs'.

'expand-tabs'

'-t' в 'diff'.

'expression'

'-e' в 'sed'.

'extern-only'

'-g' в 'nm'.

'extract'

'-i' в 'cpio'; '-x' в 'tar'.

'faces'

'-f' в 'finger'.

'fast'

'-f' в 'su'.

'file'

'-f' в 'info', Make, 'mt', и 'tar'; '-n' в 'sed'; '-r' в 'touch'.

'file-prefix'

'-b' в Bison.

'file-type'

'-F' в 'ls'.

'files-from'

'-T' в 'tar'.

'fill-column'

Используется в Makeinfo.

'flag-truncation'

'-F' в 'ptx'.

'fixed-output-files'

'-y' в Bison.

'follow'

'-f' в 'tail'.

'footnote-style'

Используется в Makeinfo.

'force'

'-f' в 'cp', 'ln', 'mv', и 'rm'.

'format'

Используется в 'ls', 'time', и 'ptx'.

'forward-search'

'-F' в 'etags'.

'fullname'

Используется в GDB.

'gap-size'

'-g' в 'ptx'.

'get'

'-x' в 'tar'.

'graphic'

'-i' в 'ul'.

'graphics'

'-g' в 'recode'.

'group'

'-g' в 'install'.

'gzip'

'-z' в 'tar'.

'hashsize'

'-H' в 'm4'.

'header'

'-h' в 'objdump' и 'recode'

'heading'

'-H' в 'who'.

'help'

Используется для запроса краткой информации по использованию.

'hide-control-chars'

'-q' в 'ls'.

'idle'

'-u' в 'who'.

'ifdef'

'-D' в 'diff'.

'ignore'

'-I' в 'ls'; '-x' в 'recode'.

'ignore-all-space'

'-w' в 'diff'.

'ignore-backups'

'-B' в 'ls'.

'ignore-blank-lines'

'-B' в 'diff'.

'ignore-case'

'-f' в 'look' и 'ptx'; '-i' в 'diff'.

'ignore-errors'

'-i' в Make.

'ignore-file'

'-i' в 'ptx'.

'ignore-indentation'

'-S' в 'etags'.

'ignore-init-file'

'-f' в Oleo.

'ignore-interrupts'

'-i' в 'tee'.

'ignore-matching-lines'

'-I' в 'diff'.

'ignore-space-change'

'-b' в 'diff'.

'ignore-zeros'

'-i' в 'tar'.

'include'

'-i' в 'etags'; '-I' в 'm4'.

'include-dir'

'-I' в Make.

'incremental'

'-G' в 'tar'.

'info'

'-i', '-l', и '-m' в Finger.

'initial'

'-i' в 'expand'.

'initial-tab'

'-T' в 'diff'.

'inode'

'-i' в 'ls'.

'interactive'

'-i' в 'cp', 'ln', 'mv', 'rm'; '-e' в 'm4'; '-p' в 'xargs'; '-w' в 'tar'.

'jobs'

'-j' в Make.

'just-print'

'-n' в Make.

'keep-going'

'-k' в Make.

'keep-files'

'-k' в 'csplit'.

'kilobytes'

'-k' в 'du' и 'ls'.

'line-bytes'

'-C' в 'split'.

'lines'

Используется в 'split', 'head', и 'tail'.

'link'

'-l' в 'cpio'.

'list'

'-t' в 'cpio'; '-l' в 'recode'.

'list'

'-t' в 'tar'.

'literal'

'-N' в 'ls'.

'load-average'

'-l' в Make.

'login'

Используется в 'su'.

'machine'

Список использующих программ не составлен.

'macro-name'

'-M' в 'ptx'.

'mail'

'-m' в 'hello' и 'uname'.

'make-directories'

'-d' в 'cpio'.

'makefile'

'-f' в Make.

'mapped'

Используется в GDB.

'max-args'

'-n' в 'xargs'.

'max-chars'

'-n' в 'xargs'.

'max-lines'

'-l' в 'xargs'.

'max-load'

'-l' в Make.

'max-procs'

'-P' в 'xargs'.

'mesg'

'-T' в 'who'.

'message'

'-T' в 'who'.

'minimal'

'-d' в 'diff'.

'mode'

'-m' вn 'install', 'mkdir', и 'mkfifo'.

'modification-time'

'-m' в 'tar'.

'multi-volume'

'-M' в 'tar'.

'name-prefix'

'-a' в Bison.

'new-file'

'-W' в Make.

'no-builtin-rules'

'-r' в Make.

'no-create'

'-c' в 'touch'.

'no-defines'

'-D' в 'etags'.

'no-dereference'

'-d' в 'cp'.

'no-keep-going'

'-S' в Make.

'no-lines'

'-l' в Bison.

'no-prof'

'-e' в 'gprof'.

'no-sort'

'-p' в 'nm'.

'no-split'

Используется в Makeinfo.

'no-static'

'-a' в 'gprof'.

'no-time'

'-E' в 'gprof'.

'no-validate'

Используется в Makeinfo.

'no-warn'

Используется в различных программах для подавления вывода предупреждающих сообщений.

'node'

'-n' в 'info'.

'nodename'

'-n' в 'uname'.

'nonmatching'

'-f' в 'cpio'.

'nstuff'

'-n' в 'objdump'.

'null'

'-0' в 'xargs'.

'number'

'-n' в 'cat'.

'number-nonblank'

'-b' в 'cat'.

'numeric-sort'

'-n' в 'nm'.

'numeric-uid-gid'

'-n' в 'cpio' и 'ls'.

'nx'

Используется в GDB.

'old-archive'

'-o' в 'tar'.

'old-file'

'-o' в Make.

'one-file-system'

'-l' в 'tar', 'cp', и 'du'.

'only-file'

'-o' в 'ptx'.

'only-prof'

'-f' в 'gprof'.

'only-time'

'-F' в 'gprof'.

'output'

В различных программах определяет имя выходного файла.

'override'

'-o' в 'rm'.

'owner'

'-o' в 'install'.

'paginate'

'-l' в 'diff'.

'paragraph-indent'

Используется в Makeinfo.

'parents'

'-p' в 'mkdir' и 'rmdir'.

'pass-all'

'-p' в 'ul'.

'pass-through'

'-p' в 'cpio'.

'port'

'-P' в 'finger'.

'portability'

'-c' в 'cpio' и 'tar'.

'prefix-builtins'

'-P' в 'm4'.

'prefix'

'-f' в 'csplit'.

'preserve'

Используется в 'tar' и 'cp'.

'preserve-environment'

'-p' в 'su'.

'preserve-modification-time'

'-m' в 'cpio'.

'preserve-order'

'-s' в 'tar'.

'preserve-permissions'

'-p' в 'tar'.

'print'

'-l' в 'diff'.

'print-chars'

'-L' в 'cmp'.

'print-data-base'

'-p' в Make.

'print-directory'

'-w' в Make.

'print-file-name'

'-o' в 'nm'.

'print-symdefs'

'-s' в 'nm'.

'question'

'-q' в Make.

'quiet'

Используется во многих программах для отключения вывода необязательных сообщений. Замечание: каждая программа, принимающая '--quiet', должна также принимать '--silent' как синоним.

'quote-name'

'-Q' в 'ls'.

'rcs'

'-n' в 'diff'.

'read-full-blocks'

'-B' в 'tar'.

'readnow'

Используется в GDB.

'recon'

'-n' в Make.

'record-number'

'-R' в 'tar'.

'recursive'

Используется в 'chgrp', 'chown', 'cp', 'ls', 'diff', и 'rm'.

'reference-limit'

Используется в Makeinfo.

'references'

'-r' в 'ptx'.

'regex'

'-r' в 'tac'.

'release'

'-r' в 'uname'.

'relocation'

'-r' в 'objdump'.

'rename'

'-r' в 'cpio'.

'replace'

'-i' в 'xargs'.

'report-identical-files'

'-s' в 'diff'.

'reset-access-time'

'-a' в 'cpio'.

'reverse'

'-r' в 'ls' и 'nm'.

'reversed-ed'

'-f' в 'diff'.

'right-side-defs'

'-R' в 'ptx'.

'same-order'

'-s' в 'tar'.

'same-permissions'

'-p' в 'tar'.

'save'

'-g' в 'stty'.

'se'

Используется в GDB.

'sentence-regexp'

'-S' в 'ptx'.

'separate-dirs'

'-S' в 'du'.

'separator'

'-s' в 'tac'.

'sequence'

Используется 'recode' для выбора файлов или потоков для последовательной обработки.

'shell'

'-s' в 'su'.

'show-all'

'-A' в 'cat'.

'show-c-function'

'-p' в 'diff'.

'show-ends'

'-E' в 'cat'.

'show-function-line'

'-F' в 'diff'.

'show-tabs'

'-T' в 'cat'.

'silent'

Используется во многих программах для отключения вывода необязательных сообщений. Замечание: каждая программа, принимающая '--silent', должна также принимать '--quiet' как синоним.

'size'

'-s' в 'ls'.

'sort'

Используется в 'ls'.

'sparse'

'-S' в 'tar'.

'speed-large-files'

'-H' в 'diff'.

'squeeze-blank'

'-s' в 'cat'.

'starting-file'

Используется в 'tar' и 'diff' для указания, с какого файла в каком каталоге следует начать обработку.

'stop'

'-S' в Make.

'strict'

'-s' в 'recode'.

'strip'

'-s' в 'install'.

'strip-all'

'-s' в 'strip'.

'strip-debug'

'-S' в 'strip'.

'suffix'

'-S' в 'cp', 'ln', 'mv'.

'suffix-format'

'-b' в 'csplit'.

'sum'

'-s' в 'gprof'.

'summarize'

'-s' в 'du'.

'symbolic'

'-s' в 'ln'.

'symbols'

Используется в GDB и 'objdump'.

'synclines'

'-s' в 'm4'.

'sysname'

'-s' в 'uname'.

'tabs'

'-t' в 'expand' и 'unexpand'.

'tabsize'

'-T' в 'ls'.

'terminal'

'-T' в 'tput' и 'ul'.

'text'

'-a' в 'diff'.

'time'

Используется в 'ls' и 'touch'.

'to-stdout'

'-O' в 'tar'.

'total'

'-c' в 'du'.

'touch'

'-t' в Make, 'ranlib', и 'recode'.

'trace'

'-t' в 'm4'.

'traditional'

'-t' в 'hello'; '-G' в 'm4' и 'ptx'.

'tty'

Используется в GDB.

'typedefs'

'-t' в 'etags'.

'typedefs-and-c++'

'-T' в 'etags'.

'typeset-mode'

'-t' в 'ptx'.

'uncompress'

'-z' в 'tar'.

'unconditional'

'-u' в 'cpio'.

'undefine'

'-U' в 'm4'.

'undefined-only'

'-u' в 'nm'.

'update'

'-u' в 'cp', 'etags', 'mv', 'tar'.

'verbose'

Печатать дополнительную информацию о работе программы. Многие программы поддерживают эту опцию.

'verify'

'-W' в 'tar'.

'version'

Печать номера версии программы.

'version-control'

'-V' в 'cp', 'ln', 'mv'.

'vgrind'

'-v' в 'etags'.

'volume'

'-V' в 'tar'.

'what-if'

'-W' в Make.

'width'

'-w' в 'ls' и 'ptx'.

'word-regexp'

'-W' в 'ptx'.

'writable'

'-T' в 'who'.

'zeros'

'-z' в 'gprof'.

---

Вперед Назад Содержание