Псевдонимы справочных страниц

В OpenBSD каждый manкаталог (, например. /usr/share/manдля руководства по базовой системе )содержитmandoc.dbбазу данных, созданную еженедельным запуском задания cronmakewhatis.

Эти базы данных создаются путем разбора различных ручных источников (исходных файлов roff )для определенных строк, и они используются утилитой man. Одной из вещей, которые индексируются, являются строки, на которые ссылается макрос.Nm("имя" )в разделе .Sh NAMEруководств, набранных с использованием макросовmdocOpenBSD.

Например, часть самого начала исходниковmalloc(3)руководства в/usr/share/man/man3/malloc.3выглядит так:

.Dd $Mdocdate: May 19 2019 $
.Dt MALLOC 3
.Os
.Sh NAME
.Nm malloc,
.Nm calloc,
.Nm realloc,
.Nm free,
.Nm reallocarray,
.Nm recallocarray,
.Nm freezero,
.Nm aligned_alloc,
.Nm malloc_conceal,
.Nm calloc_conceal
.Nd memory allocation and deallocation
.Sh SYNOPSIS

Инструмент makewhatisбудет индексировать каждое значение .Nm, а команда manпокажет обработанную версию источника malloc.3, когда пользователь запрашивает руководство по любой из перечисленных функций (, например.man free).

Руководства, не относящиеся к базовой системе OpenBSD (, т. е. руководства сторонних производителей под /usr/local/man), также анализируются с помощью makewhatis, но поскольку в них часто используется разметка roff, которая неmdoc(обычно пишется для Linux, использующего другую пакет макросов ), он индексирует значения, используемые другими макросами (макросом заголовка .TH).

Некоторые сторонние программы, кажется, распространяют отдельное руководство или для каждого отдельного инструмента или функции, хотя это означает дублирование руководств и просто присвоение им разных имен. Использование символических и/или жестких ссылок также является распространенным решением.

Другие немного умнее. Это полный исходный кодzzip_fread(3)(части пакета zziplib):

.so man3/zzip_read.3

То есть содержит макрос, который заставляет парсер читать другой файл.