2010-07-06 3 views
3

В системе Linux типично вводить progname --help, чтобы просмотреть выход справки для этой программы. После этого вы увидите описание как: progname [SWITCHES] [FILES]... [ETC]Есть ли стандартизованный синтаксис для Linux prognam?

Мой вопрос: существует ли стандартизованный синтаксис для его вида (использование командной строки)?

Чтобы описать такие вещи, как дополнительные ключи, несколько параметров (например, список файлов), шаблоны переключения и т. Д. Похоже, что существует стандарт, чтобы любой, кто его знает, мог точно интерпретировать вашу документацию.

Примечание: речь идет только о написании моей собственной документации, а не в анализе аргументов.

ответ

1

GNU Getopt Library, пожалуй, самый стандартный способ анализа аргументов. Для большинства языков, которые вы будете использовать, есть привязки библиотек.

+0

Спасибо, но я собирался писать собственную документацию, а не разбирать аргументы. Просто отредактирован для ясности. – sigint

+1

Если вы используете GNU libc, вы можете использовать 'argp', который похож на getopt, но автоматически генерирует вывод' --help' для вас: http://www.gnu.org/s/libc/manual/html_node /Argp.html –

2

Я просмотрел много страниц man linux, и вот несколько вещей, которые у меня есть я видел, что они кажутся стандартными для страниц руководства, которые поставляются стандартно с Linux. Как и некоторые из вышеперечисленных авторов, не существует опубликованного стандарта документации. Я видел некоторые различия в Интернете, но страницы, которые поставляются с Linux, выглядят довольно последовательно.

  1. Эта проблема возникает в первую очередь.
  2. Вещи, которые являются параметрами, предоставленными пользователем, помещаются в угловые скобки «<>» с именем, указанным внутри скобок, описывающим параметр. ех.
  3. Параметры, которые являются необязательными, помещаются в квадратные скобки, «[]».
  4. Если значение параметра должно быть выбрано из определенного набора, то различные параметры разделяются символом трубы, «|», представляющим «или».
  5. Вы можете использовать dot dot dot "...", чтобы упростить список, если его содержимое следует логической прогрессии. ех. [...].
  6. Осторожно с пространством. Пространства разделяют вещи, поэтому нет пробелов во имя отдельных вещей. Используйте «filename» или «file_name», а не «имя файла».

Это все, о чем я могу думать прямо сейчас. Не стесняйтесь добавлять и исправлять, если сочтете нужным.

Смежные вопросы