Зрозумійте резюме в manpage


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 правилам, які використовуються для регулярних виразів?

Пов’язано: "Корисні умови" у стандарті POSIX: pubs.opengroup.org/onlinepubs/9699919799/basedefs/…
Kusalananda

Відповіді:


25
  1. У розділі конспекту зазвичай даються деякі приклади використання. Іноді підкоманди мають різні варіанти, тому може бути показано кілька прикладів.
  2. В дужках []завжди позначаються необов'язкові перемикачі, аргументи, параметри тощо.
  3. Так, труба |означає або, особливо, якщо в дужках або дужках.
  4. Дужки в дужках просто означають, що друга частина залежить від першої, а також сама по собі необов'язкова. Деякі комутатори ви можете використовувати самостійно або додавати їм значення. Коми на початку дужки означають, що може бути кілька значень, розділених комами.
  5. Вони спираються на концепції Regex, але мають бути зрозумілими для людини, тому не дотримуйтесь усіх уникнутих правил тощо.

Спасибі! Чи є деякі посилання, що пояснюють синтаксис конспекту?
Тім

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


3

З manчоловічої сторінки:


Наступні умови застосовуються до розділу SYNOPSIS і можуть використовуватися як керівництво в інших розділах. опис резюме людини

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

Ілюстрація команди чи функції - це шаблон, який повинен відповідати всім можливим викликам. У деяких випадках доцільно проілюструвати кілька ексклюзивних викликів, як показано в розділі SYNOPSIS цього посібника.


3

Іншим джерелом для розуміння значення синтаксису аргументу утиліти командного рядка були б конвенції синтаксису аргументації утиліти, задокументовані у главі 12, та регулярні вирази, задокументовані у розділі 9 стандарту POSIX.1-2008 (видання 2013).

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.