MANPATH(5)

NOME
manpath - formato do ficheiro /etc/manpath.config

DESCRIÇÃO
O ficheiro de configuração de manpath é usado pelos utilitários das páginas do manual para avaliar os manpath do utilizador em tempo de execução, para indicar quais as hierarquias de páginas do manual (manpaths) devem ser tratadas como hierarquias do sistema e como atribuir-lhes pastas a usar para armazenar ficheiros cat.

Se a variável de ambiente $MANPATH já estiver definida, a informação contida em /etc/manpath.config não se lhe sobrepõe.

CAMINHO DE PROCURA
Por pré-definição, o man-db examina a $PATH do utilizador. Para cada elemento path_element ali encontrado, adiciona manpath_element ao caminho de procura.

Se não houver uma lnha MANPATH_MAP no ficheiro de configuração para um dado path_element, adiciona todos os path_element/../man, path_element/man, path_element/../share/man, e path_element/share/man que existam como pastas do caminho de procura.

Depois, adiciona qualquer entrada MANDATORY_MANPATH do ficheiro de configuração ao caminho de procura.

Finalmente, se a opção --systems for usada, ou a variável de ambiente $SYSTEM estiver definida, tal deverá consistir numa sequência de nomes de sistemas operativos, separados por vírgulas ou dois pontos. Isto age como modelo, expandindo o caminho de procura mais uma vez para permitir acesso a páginas de manual de outros sistemas operativos: para cada nome de sistema, o man-db procura esse nome como sub-pasta de cada entrada no caminho de procura, e adiciona-a ao caminho de procura final, se existir. Um nome de sistema de man insere o caminho de procura normal sem sub-pastas. Por exemplo, se o caminho de procura tivesse sido /usr/share/man:/usr/local/man, e $SYSTEM estiver definida como newOS:man, o caminho de procura final será /usr/share/man/newOS:/usr/share/man:/usr/local/man/newOS:/usr/local/man.

A variável de ambiente $MANPATH subsitui os caminhos de procura pré-definidos para páginas do manual do man-db. A maioria dos utilizadores não terá de a definir. A sua sintaxe é similar à variável de ambiente $PATH : consiste numa sequência de nomes de pastas separados por dois pontos. Substitui o caminho de procura pré-definido descrito acima.

Se o valor de $MANPATH começar com dois pontos, o caminho pré-definido de procura é adicionado ao seu início. Se o valor de $MANPATH terminar com dois pontos, o caminho de procura pré-definido é adicionado ao seu final. Se o valor de $MANPATH contiver duplos dois pontos (::), o caminho de procura pré-definido é inserido no meio do valor, entre os duplos dois pontos.

FORMATO
Actualmente são reconhecidos os seguintes tipos:

# comentário
    Linhas em branco ou começadas com # serão tratadas como comentários e ignoradas.

MANDATORY_MANPATH manpath_element
    Linhas desta forma indicam manpaths que todo o $MANPATH gerado automaticamente deve conter. Isto incluirá tipicamente /usr/man.

MANPATH_MAP path_element manpath_element
    Linhas desta forma configuram $PATH para mapas $MANPATH. Para cada path_element encontrado no $PATH do utilizador, será adicionado manpath_element a $MANPATH.

MANDB_MAP manpath_element [ catpath_element ]
    Linhas desta forma indicam que manpaths devem ser tratados como manpaths de sistema e, opcionalmente, onde devem ser armazenados os seus ficheiros cat. Este tipo de campo é particularmente importante se man for um programa setuid, porque (quando no ficheiro de configuração do sistema /etc/manpath.config em vez no ficheiro de configuração .manpath por utilizador) indica quais hierarquias de páginas do manual aceder como utilizador setuid e quais aceder como o utilizador chamador.

    As hierarquias das páginas de manual do sistema estão habitualmente armazenadas em /usr, tal como /usr/man, /usr/local/man e /usr/X11R6/man.

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

    A colocação tradicional de cat seria impossível para hierarquias de páginas do manual montadas como só de leitura e, por causa disto, é possível especificar qualquer hierarquia válida para o seu armazenamento. Para observação de Linux FSSTND, a palavra-chave FSSTND pode ser usada em vez da pasta real.

    Infelizmente, é necessário especificar todos os caminhos de sistema de árvores do manual, incluindo caminhos de sistemas operativos alternativos, tais como /usr/man/sun e quaisquer caminhos NLS locale, tais como /usr/man/de_DE.88591.

    Como a informação é analisada linha a linha na ordem de escrita, é necessário que qualquer manpath que seja uma sub-hierarquia de outra hierarquia seja listado primeiro, senão será feita uma correspondência incorrecta. Um exemplo disto seria que /usr/man/de_DE.88591 tem de vir antes de /usr/man.

DEFINE valor de chave
    Linhas desta forma definem diversas variáveis de configuração; veja o ficheiro de configuração predefinido para consultar as variáveis usadas pelos utilitários das páginas do manual. Incluem caminhos predefinidos para vários programas (tais co grep e tbl) e vários conjuntos predefinidos de argumentos para esses programas.

SECTION secção ...
    Linhas desta forma definem a ordem em que as secções do manual devem ser procuradas. Se não houver directivas SECTION no ficheiro de configuração, a predefinição é:

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

    Se forem indicadas múltiplas directivas SECTION, as suas listas de secções serão concatenadas.

    Se uma extensão em particular não estiver na lista (digamos, 1mh), será mostrada com o resto da secção a que pertence. O efeito disto é que só precisa de listar explicitamente extensões se pretender forçar uma determinada ordem. Secções com extensões devem habitualmente ser adjacentes à sua secção principal (e.g. "1 1mh 8 ...").

    SECTIONS é aceite como nome alternativo para esta directiva.

MINCATWIDTH largura
    Se a largura do terminal for menor que largura, as páginas cat não serão criadas (se em falta) ou mostradas. A predefinição é 80.

MAXCATWIDTH largura
    Se a largura do terminal for maior que largura, as páginas cat não serão criadas (se em falta) ou mostradas. A predefinição é 80.

CATWIDTH largura
    Se width for não-zero, as páginas cat serão sempre formatadas para um terminal da largura indicada, independentemente da largura do terminal actualmente em uso. Isto substitui MINCATWIDTH e MAXCATWIDTH.

NOCACHE
    Esta bandeira impede que man(1) crie páginas cat automaticamente.

ERROS
A não ser que as regras acima sejam rigorosamente seguidas e observadas, os utilitários das páginas do manual não funcionarão como desejável. As regras são excessivamente complicadas.

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