.\" 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 docs/COPYING.GPLv2 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 2023-09-23 2.12.0 /etc/manpath.config
.SH NOME
manpath \- formata o arquivo /etc/manpath.config
.SH 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 $\fBMANPATH\fP já estiver definida, as informações
contidas em /etc/manpath.config não a sobrescreverão.
.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 FORMATO
Os seguintes tipos de campos são atualmente reconhecidos:
.TP 
\fB#\fP\fI\ comentário\fP
Linhas em branco ou aquelas iniciando com uma cerquilha (\fB#\fP) serão
tratadas como comentários ou ignoradas.
.TP 
\fBMANDATORY_MANPATH\fP\fI\ manpath_element\fP
Linhas nesta forma indicam caminhos man que toda $\fBMANPATH\fP gerada
automaticamente deve conter. Isso geralmente incluirá \fI/usr/man\fP.
.TP 
\fBMANPATH_MAP\fP\fI\ path_element\ manpath_element\fP
Linhas nesta forma configuram mapeamentos de $\fBPATH\fP para $\fBMANPATH\fP. Para
cada \fIpath_element\fP localizado no $\fBPATH\fP do usuários, \fImanpath_element\fP
será adicionado ao $\fBMANPATH\fP.
.TP 
\fBMANDB_MAP \fP\fImanpath_element \fP\|[\| \fIcatpath_element\fP \|]
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 \fBman\fP é 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 \fI/usr\fP tal como \fI/usr/man\fP, \fI/usr/local/man\fP e
\fI/usr/X11R6/man\fP.

Se páginas cat de um \fImanpath_element\fP em particular não devem ser
armazenadas ou devem ser armazenadas na localização traducional,
\fIcatpath_element\fP 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 \fBLinux FSSTND\fP, a palavra\-chave \fBFSSTND\fP pode
ser usada no lugar de um diretório real.

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

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 \fI/usr/man/de_DE.88591\fP deve vir antes de \fI/usr/man\fP.
.TP 
\fBDEFINE\fP\fI\ valor\ da\ chave\fP
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 \fIgrep\fP e \fItbl\fP) e conjuntos padrões de
argumentos daqueles programas.
.TP 
\fBSECTION\fP \fIseção\fP .\|.\|.
.RS
Linhas nesta forma definem a ordem na qual seções de manual devem ser
pesquisadas. Caso não há diretivas \fBSECTION\fP no arquivo de configuração, o
padrão é:
.PP
.RS
.nf
.if  !'po4a'hide' SECTION 1 n l 8 3 0 2 3type 5 4 9 6 7
.fi
.RE
.PP
Se múltiplas diretivas \fBSECTION\fP forem fornecidas, suas listas de seções
serão concatenadas.
.PP
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 ...").
.PP
\fBSECTIONS\fP é aceito como um nome alternativo para essa diretiva.
.RE
.TP 
\fBMINCATWIDTH\fP\fI\ largura\fP
Se a largura do terminal é menor que \fIlargura\fP, páginas cat não serão
criadas (se estiverem faltando) ou exibidas. O padrão é 80.
.TP 
\fBMAXCATWIDTH\fP\fI\ largura\fP
Se a largura do terminal é maior que \fIlargura\fP, páginas cat não serão
criadas (se estiverem faltando) ou exibidas. O padrão é 80.
.TP 
\fBCATWIDTH\fP\fI\ largura\fP
If \fIwidth\fP 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 \fBMINCATWIDTH\fP and \fBMAXCATWIDTH\fP.
.TP 
.if  !'po4a'hide' .B NOCACHE
Essa opção evita que \fBman\fP(1) crie páginas cat automaticamente.
.SH 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.
.PP
.if  !'po4a'hide' https://gitlab.com/man-db/man-db/-/issues
.br
.if  !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db