Понимать синопсис на man-странице


27

Я не смог понять раздел SYNOPSIS на странице руководства команды. Например, давайте посмотрим на страницу руководства man. По man man:

SYNOPSIS
       man  [-C  file]  [-d]  [-D]  [--warnings[=warnings]]  [-R encoding] [-L
       locale] [-m system[,...]] [-M path] [-S list]  [-e  extension]  [-i|-I]
       [--regex|--wildcard]   [--names-only]  [-a]  [-u]  [--no-subpages]  [-P
       pager] [-r prompt] [-7] [-E encoding] [--no-hyphenation] [--no-justifi‐
       cation]  [-p  string]  [-t]  [-T[device]]  [-H[browser]] [-X[dpi]] [-Z]
       [[section] page ...] ...
       man -k [apropos options] regexp ...
       man -K [-w|-W] [-S list] [-i|-I] [--regex] [section] term ...
       man -f [whatis options] page ...
       man -l [-C file] [-d] [-D] [--warnings[=warnings]]  [-R  encoding]  [-L
       locale]  [-P  pager]  [-r  prompt]  [-7] [-E encoding] [-p string] [-t]
       [-T[device]] [-H[browser]] [-X[dpi]] [-Z] file ...
       man -w|-W [-C file] [-d] [-D] page ...
       man -c [-C file] [-d] [-D] page ...
       man [-hV]
  1. Описывает ли секция SYNOPSIS синтаксис команды?
  2. что это значит [...]и [...]внутри [...]? Они имеют в виду что-то необязательное?
  3. Означает ли |ИЛИ?
  4. Что ,значит в [-m system[,...]]?
  5. Соответствует ли раздел SYNOPSIS правилам, используемым для регулярных выражений?

Связанный: «Соглашения об коммунальных услугах
Кусалананда

Ответы:


25
  1. В разделе синопсиса обычно приводятся примеры использования. Иногда подкоманды имеют разные параметры, поэтому может быть показано несколько примеров.
  2. Скобки []всегда обозначают необязательные ключи, аргументы, опции и т. Д.
  3. Да, труба |означает или, особенно когда внутри скобок или скобок.
  4. Скобки в скобках просто означают, что вторая часть зависит от первой, а также сама по себе необязательна. Некоторые переключатели вы можете использовать самостоятельно или добавить к ним значение. Запятые в начале скобки означают, что может быть несколько значений, разделенных запятыми.
  5. Они опираются на концепции Regex, но предназначены для удобства чтения человеком, поэтому не следуйте всем правилам побега и т. Д.

Благодарность! Есть ли ссылки, объясняющие синтаксис синопсиса?
Тим

@Tim: Это один из самых сумасшедших, которые я видел, я думаю, что если ты прочитаешь еще несколько, ты поймешь это. Это просто соглашение, а не магия.
Калеб


3

С manman-страницы:


Следующие соглашения применяются к разделу ОПИСАНИЕ и могут использоваться в качестве руководства в других разделах. описание синопсиса человека

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

Иллюстрация команды или функции - это шаблон, который должен соответствовать всем возможным вызовам. В некоторых случаях рекомендуется проиллюстрировать несколько исключительных вызовов, как показано в разделе «СИНПОЗИЦИЯ» этой страницы руководства.


3

Другим источником для понимания значения синтаксиса аргумента служебной программы командной строки могут быть соглашения о синтаксисе аргументов служебной программы, описанные в главе 12, и регулярные выражения, описанные в главе 9 стандарта POSIX.1-2008 (издание 2013 г.).

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.