Чи існує стандарт написання конспекту команд?

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

Наприклад, це формат від man grep:

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

Тепер це має деякий синтаксис, який з’являється в інших мапажах. []розпізнається як необов'язковий і ...має сенс як множина одного входу.

Але люди використовують |або /для АБО, і є інші, які скасують, що []означає. Або вони не дають жодної вказівки щодо того, куди [OPTIONS]йде.

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

Чи існує фактичний стандартний спосіб написання конспектів, чи це умова лише те, що люди робили з часом?

command-line man

— Торміст
джерело

Виберіть один і дотримуйтесь його.

— Кевін

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

— Тормист

Це такий тип стандарту? pubs.opengroup.org/onlinepubs/009695399/basedefs/…

— Марк Plotnick

Так, саме це я шукав. Дякую.

— Торміст

@MarkPlotnick - Я б зробив це А, щоб ОП міг його прийняти. Це стандарт, якщо коли-небудь був такий. Посилайтеся на посилання, на яке посилалося IlluminÉ.

— slm

Класичний стандарт для цього - POSIX, Utility Argument Syntax (завдяки @ illuminÉ за оновлене посилання). Він описує синтаксис, який використовується, наприклад, на сторінках man

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

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

Програмне забезпечення GNU представило багато символьні параметри, які починаються з --. Деякі вказівки від GNU щодо форматування довідкових сторінок із цими параметрами можна знайти в довідці до help2man .

— Марк Плотнік
джерело