Есть ли стандарт для написания синопсиса команды?

14

Мне кажется, что у каждого есть своя идея о том, как написать резюме, описывающее использование команды для конечного пользователя.

Например, это формат из man grep:

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

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

Но люди используют |или /для ИЛИ, и есть другие, которые полностью изменят, что []означает. Или они не дают никаких указаний относительно того, куда [OPTIONS]идет.

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

Существует ли действительно стандартный способ написания синопсисов, или это просто соглашение о том, что люди делают со временем?

command-line man Tormyst
источник
Выберите один и придерживайтесь его.
Кевин
По некоторым причинам я не думаю, что это помогло бы. У каждого человека был бы свой стандарт, и тогда с этим ничего бы не сделали.
Tormyst
4
Вы имеете в виду стандарт? pubs.opengroup.org/onlinepubs/009695399/basedefs/…
Марк Плотник
Да, это именно то, что я искал. Спасибо.
Tormyst
1
@MarkPlotnick - я бы сделал это, чтобы ОП мог принять его. Это стандарт, если когда-либо был. Ссылка на ссылку, на которую ссылаются.
SLM

Ответы:

8

Классическим стандартом для этого является POSIX, Utility Argument Syntax (спасибо @lightÉ за обновленную ссылку). Он описывает синтаксис, который будет использоваться на страницах руководства, например

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

Будучи классическим, он рекомендует использовать односимвольные параметры, -Wрекомендуемые для использования поставщиками, и именно так учитываются многосимвольные параметры (см., Например, Сводка параметров gcc ).

Программное обеспечение GNU представило многосимвольные опции, которые начинаются с --. Некоторые рекомендации GNU по форматированию man-страниц с этими опциями можно найти в справке help2man .

Марк Плотник
источник