Scroll to navigation

MANPATH(5) /etc/manpath.config MANPATH(5)

NOME

manpath - formata o arquivo /etc/manpath.config

DESCRIÇÃO

O arquivo de configuração do manpath é usado pelos utilitários de página de manual para avaliar os caminhos man dos usuários em tempo de execução, para indicar quais hierarquias de página de manual (caminhos man) devem ser tratadas como hierarquias do sistema e para atribuí-las a diretórios para ser usados para armazenar arquivos cat.

Se a variável de ambiente $MANPATH já estiver definida, as informações contidas em /etc/manpath.config não a sobrescreverão.

SEARCH PATH

By default, man-db examines the user's $PATH. For each path_element found there, it adds manpath_element to the search path.

If there is no MANPATH_MAP line in the configuration file for a given path_element, then it adds all of path_element/../man, path_element/man, path_element/../share/man, and path_element/share/man that exist as directories to the search path.

It then adds any MANDATORY_MANPATH entries from the configuration file to the search path.

Finally, if the --systems option is used or the $SYSTEM 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 man inserts the normal search path without subdirectories. For example, if the search path would otherwise have been /usr/share/man:/usr/local/man, and $SYSTEM is set to newOS:man, then the final search path will be /usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man.

The $MANPATH 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 $PATH 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 $MANPATH starts with a colon, then the default search path is added at its start. If the value of $MANPATH ends with a colon, then the default search path is added at its end. If the value of $MANPATH contains a double colon (::), then the default search path is inserted in the middle of the value, between the two colons.

FORMATO

Os seguintes tipos de campos são atualmente reconhecidos:

# comentário
Linhas em branco ou aquelas iniciando com uma cerquilha (#) serão tratadas como comentários ou ignoradas.
Linhas nesta forma indicam caminhos man que toda $MANPATH gerada automaticamente deve conter. Isso geralmente incluirá /usr/man.
Linhas nesta forma configuram mapeamentos de $PATH para $MANPATH. Para cada path_element localizado no $PATH do usuários, manpath_element será adicionado ao $MANPATH.
Linhas nesta forma indicam quais caminhos man devem ser tratados como caminhos man do sistema e, opcionalmente, onde seus arquivos cat devem ser armazenados. Esse tipo de campo é particularmente importante se man é um programa setuid, como (quando no arquivo de configuração de sistema /etc/manpath.config em vez do arquivo de configuração per-usuário .manpath) ele indica quais hierarquias de página de manual devem ser acessadas como o usuário setuid e qual como usuário invocador.

As hierarquias de página de manual do sistema geralmente são aquelas armazenadas sob /usr tal como /usr/man, /usr/local/man e /usr/X11R6/man.

Se páginas cat de um manpath_element em particular não devem ser armazenadas ou devem ser armazenadas na localização traducional, catpath_element pode ser omitido.

Colocação de cat tradicional seria impossível para hierarquias de páginas de manual montadas como somente leituras e, por causa disso, é possível especificar qualquer hierarquia válida de diretórios para seu armazenamento. Para observar Linux FSSTND, a palavra-chave FSSTND pode ser usada no lugar de um diretório real.

Infelizmente, é necessário especificar todos os caminhos de árvore man do sistema, incluindo caminhos alternativos do sistema operacional, tais como /usr/man/sun e quaisquer caminhos localidade NLS tais como /usr/man/de_DE.88591.

Como a informação é analisada linha por linha na ordem escrita, é necessário para qualquer caminho man que é um subdiretório de uma outra hierarquia ser listado primeiro, do contrário uma correspondência incorreta será feita. Uma exemplo disso é que /usr/man/de_DE.88591 deve vir antes de /usr/man.

Linhas nesta forma definem diversas variáveis de configuração; veja o arquivo de configuração padrão para aquelas variáveis usadas pelos utilitários paginação de manual. Eles incluem caminhos de padrão para programas variados (tais como grep e tbl) e conjuntos padrões de argumentos daqueles programas.
Linhas nesta forma definem a ordem na qual seções de manual devem ser pesquisadas. Caso não há diretivas SECTION no arquivo de configuração, o padrão é: 

SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7

Se múltiplas diretivas SECTION forem fornecidas, suas listas de seções serão concatenadas.

Se uma extensão em particular não estiver nessa lista (digamos, 1mh), ela será exibida com o resto da seção à qual ela pertence. O efeito disso é que você apenas precisa listar explicitamente extensões se você deseja forçar uma ordem em particular. As seções com extensões geralmente devem ser adjacente às suas seções principais (ex.: "1 1mh 8 ...").

SECTIONS é aceito como um nome alternativo para essa diretiva.

Se a largura do terminal é menor que largura, páginas cat não serão criadas (se estiverem faltando) ou exibidas. O padrão é 80.
Se a largura do terminal é maior que largura, páginas cat não serão criadas (se estiverem faltando) ou exibidas. O padrão é 80.
If width is non-zero, cat pages will always be formatted for a terminal of the given width, regardless of the width of the terminal actually being used. This overrides MINCATWIDTH and MAXCATWIDTH.
Essa opção evita que man(1) crie páginas cat automaticamente.

PROBLEMAS

A menos que as regras acima sejam seguidas e observadas com muita atenção, os utilitários de paginação de manual não funcionarão como desejado. As regras são excessivamente complicadas.

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

2023-09-23 2.12.0