Каков синтаксис для описания того, как вызвать команду?

Question

Если у меня есть эта команда:

do_something 

И требует 2 аргумента argument_1 argument_2

argument_1 может быть чем угодно argument_2 только может быть true или false

Может быть добавлен необязательный третий аргумент argument_3

Каков стандарт для описания шаблона вызова скрипта?

Я помню, что где-то читал о различных значениях <> и [] и {}. Например:

• <> среднее значение требуется
• [] значит не требуется
• {} содержит список возможных значений

Так что для моего примера это будет

do_someting <argument_1> {true,false} [argument_3]

Но я не нахожу места, подтверждающего этот синтаксис.

Answer 1

Я бы написал следующее:

do_someting argument_1 {true|false} [argument_3]

Я думаю, что аргументам, требующим объяснения, не нужны никакие скобки, это выглядит яснее. Кроме того, канал выглядит более стандартным для представления оператора "или".

Мне не известен такой стандарт, но вы можете взглянуть на рекомендации Google или docopt , например. Также, вот документ POSIX , который может вас заинтересовать.