Как считать синтаксис команды в качестве примера в разделах резюме Страниц справочника?
Я пытаюсь поправиться об использовании документации для понимания синтаксиса команды, но я понял, что не полностью понимаю символы, используемые, которые показывают все варианты и параметры, которые могут быть переданы команде.
Например, 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 для новичков находит документацию. Когда Вы слышите, что система идет с руководством онлайн, она обычно вызывает вздох облегчения. То, что Вы не знаете, - то, что страницы руководства являются техническими справочниками. В то время как это может звучать действительно плохим - нет! После того как Вы изучаете основы страниц справочника, Вы приедете, чтобы ценить, как они записаны. Если Вы нуждаетесь в информации и не имеете времени для траты, команда человека состоит в том, к кому Вы обращаетесь.
Этот документ пытается учить Вас, как прочитать руководство Unix - обычно называемый страницами справочника. Общие Кавычки
, Прежде чем мы вскочим в нашу первую страницу справочника, позволяют, смотрят на некоторые обычные символы, используемые в них. Эти символы иногда называются кавычками.
основное использование страницы справочника к параметрам поиска для программы. Так как большинство параметров является дополнительным, они будут включены в квадратные скобки.
[optional]
[-abcgln]
опции Some будут иметь ограниченный список выбора. Список выбора будет запятой, разделенной и помещенной между фигурными скобками.
{choice1,choice2}
{yes,no}
Много источников документации справки включают manditory параметры между less-than/greater-than символами.
<manditory>
<program_name>
, В то время как вышеупомянутое manditory кавычки обычно не используются в страницах справочника, это - хорошая вещь знать.
От man страница справочника:
Следующие конвенции относятся к разделу SYNOPSIS и могут использоваться в качестве руководства в других разделах.
Точный рендеринг может варьироваться в зависимости от устройства вывода. Например, человек не будет обычно мочь представить курсив при выполнении в терминале и будет обычно использовать подчеркнутый или окрашенный текст вместо этого.
Команда или функциональная иллюстрация являются шаблоном, который должен соответствовать всем возможным вызовам. В некоторых случаях желательно проиллюстрировать несколько эксклюзивных вызовов, как показан в разделе SYNOPSIS этой страницы руководства.
