Файлы страниц man

Страницы man форматируются с помощью специального языка разметки ROFF. В GNU была создана собственная программа groff, реализующая функции программы nroff, предназначенной для интерпретации ROFF и ис- пользующейся в коммерческих UNIX-системах.

Страницы помощи man хранятся в отдельных файлах, имя которых состоит из имени раздела и суффикса — секции man. Например, файл rm.1 относится к разделу информации о команде rm, раздел принадлежит первой секции сис- темы man. Чаще всего страницы man хранятся в сжатом с помощью утилит gzip или bzip2 виде, поэтому к расширению имени файла добавляется, соот- ветственно, gz или bz2. Стандартное место хранения страниц man — каталог

/usr/share/man.

В каталоге /usr/share/man имеются подкаталоги с именами man1, man2, ..., man9. Несложно догадаться, что это — каталоги, в которых хранят- ся страницы соответствующих разделов. Так, например, в каталоге

/usr/share/man/man8 хранятся страницы помощи по восьмой секции man. В случае если система локализована и в ней установлены национальные страницы помощи, например, русифицированная система man, то в каталоге

/usr/share/man создается специальный подкаталог с локализованными стра- ницами. Русские страницы man установлены в каталоге /usr/share/man/ru. До- полнительные приложения и команды, установленные в системе, обычно размещают свои страницы помощи в каталоге /usr/share/local/man.

Часто стандартного списка секций не достаточно, поэтому используют спе- циальные секции, предназначенные для помощи по таким программам, как

графическая подсистема X Window. Для этой подсистемы выделена специ- альная секция — 1x.

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

Имеется специальный файл конфигурации /etc/man.config, который позволяет настраивать параметры системы man.

Для разработки собственных страниц man можно использовать любой тек- стовый редактор, однако файл страницы помощи должен следовать формату groff. Для этого в файле должны быть выделены разделы, приведенные в табл. 3.3, и он должен быть размечен с помощью макросов groff.

Таблица 3.3. Стандартные разделы страниц man