table of contents
MANDB(8) | Утилиты просмотра справочных страниц | MANDB(8) |
НАЗВАНИЕ¶
mandb - создаёт или обновляет кэши index справочных страниц
СИНТАКСИС¶
mandb [-dqsucpt?V] [-C file]
[manpath]
mandb [-dqsut] [-C
файл] -f
имя_файла ...
ОПИСАНИЕ¶
mandb используется для инициализации или ручного обновления кэшей базы данных index, которые обычно поддерживаются man. В кэшах содержится информация о текущем состоянии системы справочных страниц, а хранящаяся в них информация используется утилитами man-db для повышения скорости работы и функциональности.
При создании или обновлении index, mandb предупреждает о неверных запросах ROFF .so, фиктивных именах файлов справочных страниц и справочных страницах, которые не удалось проанализировать с помощью whatis.
Указываемые при запуске mandb необязательные пути (через двоеточие) заменят внутренний путь поиска иерархии системных справочных страниц, определённый из файла настроек man-db.
КЭШИ БАЗЫ ДАННЫХ¶
mandb может быть собрана с поддержкой одного из следующих типов баз данных:
Название | Тип | Асинхронность | Имя файла |
Berkeley db | двоичное дерево | Да | index.bt |
GNU gdbm v >= 1.6 | Хэш | Да | index.db |
GNU gdbm v < 1.6 | Хэш | Нет | index.db |
UNIX ndbm | Хэш | Нет | index.(dir|pag) |
Типы баз данных, которые поддерживают асинхронные обновления, предоставляют лучшее отношение скорости к возможности повреждения в случае неожиданного прерывания работы. Если это происходит, может потребоваться перезапустить mandb с параметром -c, чтобы пересоздать базы данных с нуля.
ПАРАМЕТРЫ¶
- -d, --debug
- Показывать отладочную информацию.
- -q, --quiet
- Не выдавать предупреждения.
- -s, --no-straycats
- Не тратить время на поиск или добавление информации в базы данных по stray cats.
- -p, --no-purge
- Не тратить время на проверку удалённых справочных страниц или их вычистку из баз данных.
- -c, --create
- По умолчанию, mandb пытается обновить любые ранее созданные базы данных. Если база данных не существует, то она будет создана. Этот параметр заставляет mandb удалить имеющиеся базы данных и пересоздать их с нуля, и заключает в себе --no-purge. Это может быть необходимо при повреждении базы данных, или если в будущем будет использоваться новая схема хранения базы данных.
- -u, --user-db
- Создать только пользовательские базы данных, даже имея права на запись, необходимые для создания системных баз данных.
- -t, --test
- Выполнить проверку на правильность справочных страниц в иерархическом пути поиска. При указании этого параметра mandb не изменяет существующие базы данных.
- -f, --filename
- Обновить записи только для заданного файла. Этот параметр не для повседневного использования; он используется для служебных целей man, когда она собрана с параметром MAN_DB_UPDATES и обнаруживает, что страница устарела. Это подразумевает -p и выключает -c и -s.
- -C файл, --config-file=файл
- Использовать указанный пользовательский файл настройки вместо значения по умолчанию ~/.manpath.
- -?, --help
- Показать это справочное сообщение и закончить работу.
- --usage
- Print a short usage message and exit.
- -V, --version
- Показать версию и закончить работу.
КОД ВЫХОДА¶
- 0
- Успешное выполнение программы.
- 1
- Ошибка при использовании, в синтаксисе или файле настроек.
- 2
- Ошибка при работе.
- 3
- Работа процесса-потомка завершилась неудачно.
ДИАГНОСТИКА¶
Во время создания базы данных могут появляться следующие предупреждения.
- <имя файла>: ошибка анализа страниц(ы) программой whatis
- Программа whatis пыталась извлечь строки из указанного <файла>, но это не удалось. Обычно, эта ошибка возникает, если справочная страница плохо написана, а если таких сообщений возникает много, то, скорее всего, в системе содержатся нестандартные справочные страницы, несовместимые с анализатором man-db whatis. Более подробное описание смотрите в разделе ЧТО АНАЛИЗИРУЕТСЯ на странице lexgrog(1).
- <имя файла>: повисшая символическая ссылка
- <Файл> не существует, но на него ссылаются по символической ссылке. При дальнейшей диагностике, обычно, появятся сообщения, указывающие на <файл> с неправильной ссылкой.
- <имя файла>: неверная символическая ссылка или ROFF `.so' запрос
- <Файл>, или указывает на символическую ссылку, или содержит ROFF include запрос на несуществующий файл.
- <имя файла>: игнорируется фиктивное имя файла
- <Файл> может (или не может) быть допустимой справочной страницей, но это имя неправильно. Обычно, это происходит со справочными страницами, имеющими раздельческое расширение <x>, но лежащими в разделе <y>.
- <маска имени файла>: конкурирующие расширения
- Шаблон <маска имени файла> не является уникальным. Обычно, это происходит из-за существования одновременно сжатой и несжатой версии одной и той же справочной страницы. Все страницы кроме самой новой игнорируются.
ФАЙЛЫ¶
- /etc/man_db.conf
- Файл настройки man-db.
- /var/cache/man/index.(bt|db|dir|pag)
- Соответствующий FHS глобальный кэш базы данных index.
Места, где кэш базы данных находился ранее:
- /usr/man/index.(bt|db|dir|pag)
- Традиционный кэш глобальной базы данных index.
- /var/catman/index.(bt|db|dir|pag)
- Альтернативный или соответствующий FSSTND, глобальный кэш базы данных index.
СМОТРИТЕ ТАКЖЕ¶
lexgrog(1), man(1), manpath(5), catman(8)
Прежде в этой странице был раздел ЧТО АНАЛИЗИРУЕТСЯ, но теперь он перенесён в lexgrog(1).
АВТОР¶
Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (fpolacco@debian.org). Colin Watson (cjwatson@debian.org).
2012-09-17 | 2.6.3 |