CATMAN

Section: Утилиты просмотра справочных страниц (8)
Updated: 2020-06-22
Page Index

НАЗВАНИЕ

catman - создаёт или обновляет уже отформатированные справочные страницы

СИНТАКСИС

catman [-d?V] [-M путь] [-C файл] [раздел] ...

ОПИСАНИЕ

catman используется для создания новейших отформатированных справочных страниц, называемых cat страницами. Cat страницы, обычно, намного быстрее отображаются, чем исходные справочные страницы, но для их хранения требуется дополнительное место. Решение о существовании определённых cat страниц принимает локальный администратор, который должен предоставить подходящие каталоги для их хранения.

В параметрах catman задаются иерархии справочных страниц и разделы, которые должны быть отформатированы заранее. Иерархиями по умолчанию считаются системные иерархии, указанные в файле настроек man-db, а разделы по умолчанию берутся из значения переменной окружения $MANSECT (список значений через двоеточие) или из значения, заданного при компиляции man, если переменная окружения $MANSECT не установлена. При указании catman списка имён разделов через пробельный символ, он заменит оба эти значения по умолчанию.

При определении файлов для форматирования по каждой иерархии catman использует кэш базы данных index.

ПАРАМЕТРЫ

-d, --debug: Показывать отладочную информацию.
-M путь, --manpath=путь: Задаёт альтернативный путь поиска иерархии справочных страниц (указываются через двоеточие). По умолчанию, используются все пути, отмеченные как системные иерархии в файле настроек man-db.
-C файл, --config-file=файл: Использовать указанный пользовательский файл настройки вместо значения по умолчанию ~/.manpath.
-?, --help: Показать справочное сообщение и закончить работу.
--usage: Показать короткое сообщение об использовании и завершить работу.
-V, --version: Показать информацию о версии.

ОКРУЖЕНИЕ

MANSECT: Если установлена переменная окружения $MANSECT, то её значением является список разделов, указанных через двоеточие, и она используется для задания разделов справочных страниц, в которых будет производится поиск и в каком порядке. Значением по умолчанию является «1 1p 8 2 3 3p 3pm 4 5 6 7 9 0p n l p o 1x 2x 3x 4x 5x 6x 7x 8x», если оно не заменено директивой SECTION в /etc/man_db.conf.
MANPATH: Если установлена переменная окружения $MANPATH, то она рассматривается как набор каталогов (через двоеточие) иерархии справочных страниц для использования при поиске.

ФАЙЛЫ

/etc/man_db.conf: Файл настройки man-db.
/usr/man/index.(bt|db|dir|pag): Традиционный кэш глобальной базы данных index.
/var/catman/index.(bt|db|dir|pag): Альтернативный или соответствующий FSSTND, глобальный кэш базы данных index.

СМОТРИТЕ ТАКЖЕ

man(1), manpath(5), mandb(8)

АВТОР

Wilf. (G.Wilford@ee.surrey.ac.uk).Fabrizio Polacco (fpolacco@debian.org).Colin Watson (cjwatson@debian.org).

ОШИБКИ

https://savannah.nongnu.org/bugs/?group=man-db