Есть ли спецификация раздела "СИНТАКСИС" справочной страницы?

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

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

Unix manual page on the "man" command

Ответы

Ответ 1

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

В файлах man(7) и mdoc(7) будут описаны наиболее важные соглашения. man(7) предназначен для man файлов Unix старого стиля и по-прежнему пользуется популярностью в Linux (см. man-pages(7)); mdoc(7) поступает из 4.4BSD и популярен в его производных. Последний поддерживает более строгое разделение контента и представления и может производить (IMHO) более красивый PDF/HTML-вывод

Ответ 3

человек 7 человек:

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