CATMAN(8) | Утилиты просмотра справочных страниц | CATMAN(8) |
НАЗВАНИЕ¶
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, то её значением является список разделов, указанных через двоеточие, и она используется для задания разделов справочных страниц, в которых будет производится поиск и в каком порядке. Значением по умолчанию является «0 1 n l 8 3 2 5 4 9 6 7 1x 3x 4x 5x 6x 8x 1bind 3bind 5bind 7bind 8bind 1cn 8cn 1m 1mh 5mh 8mh 1netpbm 3netpbm 5netpbm 0p 1p 3p 3posix 1pgsql 3pgsql 5pgsql 3C++ 8C++ 3blt 3curses 3ncurses 3form 3menu 3db 3gdbm 3f 3gk 3paper 3mm 5mm 3perl 3pm 3pq 3qt 3pub 3readline 1ssl 3ssl 5ssl 7ssl 3t 3tk 3tcl 3tclx 3tix 7l 7nr 8c Cg g s m», если оно не заменено директивой SECTION в /etc/manpath.config.
- MANPATH
- Если
установлена
переменная
окружения
$MANPATH, то она
рассматривается
как набор
каталогов
(через
двоеточие)
иерархии
справочных
страниц
для
использования
при поиске.
О том, как используется эта переменная окружения и поведение по умолчанию, смотрите раздел ПУТЬ ПОИСКА в manpath(5).
ФАЙЛЫ¶
- /etc/manpath.config
- Файл настройки man-db.
- /usr/man/index.(bt|db|dir|pag)
- Традиционный кэш глобальной базы данных index.
- /var/catman/index.(bt|db|dir|pag)
- Альтернативный или соответствующий FSSTND, глобальный кэш базы данных index.
СМОТРИТЕ ТАКЖЕ¶
АВТОР¶
Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org). Colin Watson (cjwatson@debian.org).
ОШИБКИ¶
https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db
2024-08-29 | 2.13.0 |