.\" Man page for format of the manpath.config data file .\" .\" Copyright (C) 1994, 1995 Graeme W. Wilford. (Wilf.) .\" Copyright (C) 2001-2019 Colin Watson. .\" .\" You may distribute under the terms of the GNU General Public .\" License as specified in the file COPYING that comes with the .\" man-db distribution. .\" .\" Sat Oct 29 13:09:31 GMT 1994 Wilf. (G.Wilford@ee.surrey.ac.uk) .\" .pc "" .\"******************************************************************* .\" .\" This file was generated with po4a. Translate the source file. .\" .\"******************************************************************* .TH MANPATH 5 2022-02-10 2.10.1 /etc/manpath.config .SH НАЗВАНИЕ manpath \- формат файла /etc/manpath.config .SH ОПИСАНИЕ Файл настройки manpath используется утилитами справочных страниц для доступа к пользовательским manpath во время работы; в нём определено какие иерархии справочных страниц (manpath) считать системными иерархиями, а также для них назначены каталоги хранения cat файлов. Если установлена переменная окружения $\fBMANPATH\fP, то информация из /etc/manpath.config использоваться не будет. .SH "SEARCH PATH" By default, man\-db examines the user's $\fBPATH\fP. For each \fIpath_element\fP found there, it adds \fImanpath_element\fP to the search path. If there is no \fBMANPATH_MAP\fP line in the configuration file for a given \fIpath_element\fP, then it adds all of \fIpath_element/../man\fP, \fIpath_element/man\fP, \fIpath_element/../share/man\fP, and \fIpath_element/share/man\fP that exist as directories to the search path. It then adds any \fBMANDATORY_MANPATH\fP entries from the configuration file to the search path. Finally, if the \fB\-\-systems\fP option is used or the $\fBSYSTEM\fP environment variable is set, then that should consist of a sequence of operating system names separated by commas or colons. This acts as a template, expanding the search path once more to allow access to other operating systems' manual pages: for each system name, man\-db looks for that name as a subdirectory of each entry in the search path, and adds it to the final search path if it exists. A system name of \fBman\fP inserts the normal search path without subdirectories. For example, if the search path would otherwise have been \fI/usr/share/man:/usr/local/man\fP, and $\fBSYSTEM\fP is set to \fInewOS:man\fP, then the final search path will be \fI/usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man\fP. The $\fBMANPATH\fP environment variable overrides man\-db's default manual page search paths. Most users should not need to set it. Its syntax is similar to the $\fBPATH\fP environment variable: it consists of a sequence of directory names separated by colons. It overrides the default search path described above. If the value of $\fBMANPATH\fP starts with a colon, then the default search path is added at its start. If the value of $\fBMANPATH\fP ends with a colon, then the default search path is added at its end. If the value of $\fBMANPATH\fP contains a double colon (\fB::\fP), then the default search path is inserted in the middle of the value, between the two colons. .SH ФОРМАТ В данный момент распознаются следующие типы полей: .TP \fB#\fP\fI\ комментарий\fP Пустые или начинающиеся с \fB#\fP строки считаются комментариями и игнорируются. .TP \fBMANDATORY_MANPATH\fP\fI\ manpath_элемент\fP Строки в этом формате содержат manpath, которые каждый раз генерируются автоматически для включения в $\fBMANPATH\fP. Обычно, сюда включается \fI/usr/man\fP. .TP \fBMANPATH_MAP\fP\fI\ элемент_пути\ manpath_элемент\fP Строки в этом формате содержат отображение $\fBPATH\fP в $\fBMANPATH\fP. Для каждого \fIэлемента_пути\fP, найденного в пользовательском $\fBPATH\fP, в $\fBMANPATH\fP будет добавляться \fImanpath_элемент\fP. .TP \fBMANDB_MAP \fP\fImanpath_элемент \fP\|[\| \fIcatpath_элемент\fP \|] Строки в этом формате определяют, какие manpath должны считаться системными manpath, а также можно задать для каких из них нужно хранить cat файлы. Этот тип поля особенно важен, если \fBman\fP является setuid программой, так как (когда задаются в системном файле настройки /etc/manpath.config, а не в персональном файле настройки пользователя .manpath) им определяется, к каким иерархиям справочных страниц имеет доступ setuid пользователь, а какие вызываются из\-под обычного пользователя. Системные иерархии справочных страниц обычно хранятся в подкаталогах \fI/usr\fP, например, \fI/usr/man\fP, \fI/usr/local/man\fP и \fI/usr/X11R6/man\fP. Если cat страницы из определённого \fImanpath_элемента\fP не нужно хранить, или они будут храниться в обычном месте, то \fIcatpath_элемент\fP можно не указывать. Традиционное размещение cat страниц было бы невозможным для смонтированных только на чтение каталогов иерархий справочных страниц, и поэтому возможно определить любую рабочую иерархию каталогов для их хранения. Допустимый каталог можно найти поиском в \fBLinux FSSTND\fP по ключевому слову \fBFSSTND\fP. К сожалению, требуется указать \fBвсе\fP пути системных справочных страниц, включая пути альтернативных операционных систем, такие как \fI/usr/man/sun\fP и все пути \fBлокалей NLS\fP, например \fI/usr/man/de_DE.88591\fP. Так как информация обрабатывается последовательно строка за строкой в порядке хранения, необходимо все manpath, которые являются субиерархиями другой иерархии, указывать в начале, иначе поиск может быть некорректным. Например, \fI/usr/man/de_DE.88591\fP должно быть указано раньше, чем \fI/usr/man\fP. .TP \fBDEFINE\fP\fI\ ключ\ значение\fP Строки в этом формате определяют различные переменные настройки; в файле настройки по умолчанию описаны переменные, которые используются утилитами пейджера справочных страниц. Они могут содержать пути по умолчанию к различным программам (например, \fIgrep\fP и \fItbl\fP) и параметры по умолчанию для этих программ. .TP \fBSECTION\fP \fIраздел\fP .\|.\|. .RS Строки данного формата определяют порядок поиска в справочных разделах. Если в файле настройки директивы \fBSECTION\fP не указаны, то по умолчанию используется: .PP .RS .nf .if !'po4a'hide' SECTION 1 n l 8 3 0 2 5 4 9 6 7 .fi .RE .PP Если указано несколько директив \fBSECTION\fP, то их значения объединяются в список. .PP Если какого\-то расширения не окажется в этом списке (например, 1mh), то страница будет показана вместе с оставшимся разделом, которому принадлежит. Смысл этого в том, что нужно указывать только расширения, для которых вы бы хотели жёстко задать определённый порядок. Разделы с расширениями, как правило, указываются рядом с их основным разделом (например, "1 1mh 8 ..."). .PP В качестве альтернативного имени этой директивы может использоваться \fBSECTIONS\fP. .RE .TP \fBMINCATWIDTH\fP\fI\ ширина\fP Если ширина терминала меньше чем \fIширина\fP, то cat страницы создаваться (если их нет) или отображаться не будут. Значение по умолчанию равно 80. .TP \fBMAXCATWIDTH\fP\fI\ ширина\fP Если ширина терминала больше чем \fIширина\fP, то cat страницы создаваться (если их нет) или отображаться не будут. Значение по умолчанию равно 80. .TP \fBCATWIDTH\fP\fI\ ширина\fP Если значение \fIширина\fP не равно 0, то cat страницы будут всегда форматироваться для терминала данной ширины, независимо от ширины терминала, который используется на самом деле. Обычно, это значение находится в рамках между \fBMINCATWIDTH\fP и \fBMAXCATWIDTH\fP. .TP .if !'po4a'hide' .B NOCACHE Этот параметр запрещает \fBman\fP(1) автоматически создавать cat страницы. .SH ОШИБКИ Если точно не следовать правилам, описанным ранее, то утилиты пейджера справочных страниц не будут работать как ожидалось. Правила чрезмерно запутаны. .PP .if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues .br .if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db