Есть ли спецификация для раздела справки справочной страницы?

Question

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

Из Wikimedia Commons, вот пример страницы руководства с разделом SYNOPSIS, о котором я говорю, где команда указана с обязательными и необязательными аргументами, которые она понимает.

Answer 1

Формального определения man-страницы нет нигде, даже в стандарте POSIX. Страница man man(1) в вашем примере довольно типична: вы пишете различные способы использования программы (часто только один) с [], обозначая необязательный, жирный шрифт (или шрифт пишущей машинки с mdoc макросы), обозначающие буквенный ввод командной строки и курсив, обозначающий переменные.

Справочные страницы man(7) и mdoc(7) объяснят наиболее важные соглашения. man(7) предназначен для старых страниц Unix в старом стиле и все еще популярен в Linux (см. man-pages(7)); mdoc(7) взято из 4.4BSD и популярно среди производных. Последний поддерживает более строгое разделение контента и представления и может создавать (ИМХО) более симпатичный вывод PDF / HTML

Answer 2

человек 7 man-страниц:

кратко описывает интерфейс команды или функции. Для команд это показывает синтаксис команды и ее аргументы (включая опции); жирный шрифт используется для текста как есть, а курсив - для указать заменяемые аргументы. Кронштейны ([]) окружают дополнительно аргументы, вертикальные черты (|), отдельные варианты и эллипсы (...) могут быть повторенным. Для функций он показывает любые требуемые объявления данных или директивы #include, за которыми следует объявление функции.

Answer 3

Условные обозначения утилит описаны в Глава 12. Условные обозначения стандарта IEEE Std 1003.1, издание 2004 г. .

Существует более новая редакция этого документа здесь