UNIX — универсальная среда программирования - Керниган Брайан Уилсон

9.4 Справочник

Основной документацией для команды является обычно справочная страничка (называемая далее справочником) одностраничное описание в справочном руководстве по UNIX (см. рис. 9.2). Справочник хранится в стандартном каталоге, как правило, в

, в подкаталоге, нумерованном в соответствии с разделом руководства. Например, наш справочник для хранится в .

Справочники печатаются с помощью команды

, т.е. файла , который запускает , поэтому печатает справочник . Если одно и то же имя появляется в нескольких разделах, как само man (раздел 1 описывает команду, тогда как раздел 7 описывает макрокоманды), то раздел можно определить для как

В результате печатается только описание макрокоманд пакета

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

Автор справочника создает файл в соответствующем подкаталоге

. Чтобы печатать справочник, команда вызывает или с пакетом макроопределений; это можно увидеть, отыскав команду для вызовов форматирующей программы. Мы получили бы такой результат:

Разнообразие достигается применением флагов:

или , запускается или нет и т.д. Справочник по макрокомандам, вызываемый , определяет команды , форматирующие в стиле данного руководства. В принципе они аналогичны макрокомандам , но есть и различия, особенно в установке названия и командах смены шрифта. Макрокоманды кратко документированы в , но основные из них легко запоминаются. Разметка справочника такова:

Если какой-то раздел пуст, его заголовок опускается. Строка.

и разделы , , не обязательны. Строка

называет команду и определяет номер раздела. Различные строки

идентифицируют разделы справочника. Разделы и являются специальными; остальные содержат обычный текст. Раздел называет команду (на этот раз строчными буквами) и дает ее описание в одной строке, а раздел называет флаги, но не описывает их. Как и в любом разделе, входной текст имеет произвольную форму, поэтому смену шрифта можно определять с помощью макрокоманд , , . В разделе и имя, и флаги выделены жирным шрифтом; прочая информация печатается обычным шрифтом. Разделы и , например, имеют вид и выводятся как