Как прочитать синтаксис примера команды в разделах синопсиса на страницах MAN?

Я пытаюсь лучше разобраться в использовании документации для понимания синтаксиса команды, но я понял, что не до конца понимаю используемые символы, которые показывают все опции и параметры, которые можно передать команде.

Например man zip:

SYNOPSIS

   zip  [-aABcdDeEfFghjklLmoqrRSTuvVwXyz!@$] [--longoption ...]  [-b path]
   [-n suffixes] [-t date] [-tt date] [zipfile [file ...]]  [-xi list]

Или же man bzip2:

SYNOPSIS
       bzip2 [ -cdfkqstvzVL123456789 ] [ filenames ...  ]
       bzip2 [ -h|--help ]
       bunzip2 [ -fkvsVL ] [ filenames ...  ]
       bunzip2 [ -h|--help ]
       bzcat [ -s ] [ filenames ...  ]
       bzcat [ -h|--help ]
       bzip2recover filename

Есть ли ресурс, который рассказывает, как читать этот синтаксис и может сказать мне, что означает каждый символ?

Источник

2 ответа

Решение

Хороший ресурс это (я беззастенчиво скопировал)

Одна из самых сложных частей Unix для начинающих - это поиск документации. Когда вы слышите, что система поставляется с онлайн-руководством, она обычно вызывает облегчение. Чего вы не знаете, так это того, что справочные страницы являются техническими ссылками. Хотя это может звучать очень плохо - это не так! Как только вы изучите основы man-страниц, вы поймете, как они написаны. Если вам нужна информация, и вы не можете терять время, команда man - это то, к кому вы обращаетесь.

Этот документ пытается научить вас читать руководство по Unix, которое часто называют man-страницами. Общие цитаты

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

Основное использование man-страницы - поиск параметров программы. Поскольку большинство параметров являются необязательными, они будут заключены в квадратные скобки.

[optional]
[-abcgln]

Некоторые варианты будут иметь ограниченный список вариантов. Список вариантов будет разделен запятой и заключен в фигурные скобки.

{choice1,choice2}
{yes,no}

Многие источники справочной документации заключают обязательные параметры между символами "меньше / больше".

<manditory>
<program_name>

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

Источник

От man справочная страница:

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

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

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

Источник
Другие вопросы по тегам