man - uma interface para os manuais de referência do sistema
SINTAXE
man [opções do man] [[seção] página ...] ...
man -k [opções do apropos] expressão regular ...
man -K [opções do man] [seção] termo ...
man -f [opções do whatis] página ...
man -l [opções do man] arquivo ...
man -w|-W [opções do man] página ...
DESCRIÇÃO
man é o visualizador de manuais do sistema. Cada argumento de página fornecido para man é normalmente o nome de um programa, utilitário ou função. A página de manual associada a cada um desses argumentos é então encontrada e exibida. Uma seção, se fornecida, direcionará o man a procurar apenas nessa seção do manual. A ação padrão é pesquisar em todas as seções disponíveis, seguindo uma ordem predefinida (veja PADRÕES), e exibir apenas a primeira página encontrada, mesmo que a página exista em várias seções.
A tabela abaixo mostra os números das seções do manual, seguidos pelos tipos de páginas que contêm.
1 Programas executáveis ou comandos de shell
2 Chamadas de sistema (funções fornecidas pelo kernel)
3 Chamadas de biblioteca (funções em bibliotecas de programas)
4 Arquivos especiais (geralmente encontrados em /dev)
5 Formatos de arquivo e convenções, por exemplo, /etc/passwd
6 Jogos
7 Diversos (incluindo pacotes de macros e convenções), por exemplo, man(7), groff(7), man-pages(7) 8 Comandos de administração do sistema (geralmente apenas para root) 9 Rotinas de kernel [Não padronizado]
Uma página de manual consiste em várias seções.
Os nomes de seção convencionais incluem NOME, SINTAXE, CONFIGURAÇÃO, DESCRIÇÃO, OPÇÕES, STATUS DE SAÍDA, VALOR DE RETORNO, ERROS, AMBIENTE, ARQUIVOS, VERSÕES, PADRÕES, NOTAS, BUGS, EXEMPLO, AUTORES e VEJA TAMBÉM.
As seguintes convenções se aplicam à seção SINTAXE e podem ser usadas como um guia em outras seções.
texto em negrito digite exatamente como mostrado.
texto em itálico substitua pelo argumento apropriado.
[-abc] qualquer um ou todos os argumentos dentro de [ ] são opcionais.
-a|-b as opções delimitadas por | não podem ser usadas juntas.
argumento ... o argumento é repetível.
[expressão] ... toda a expressão dentro de [ ] é repetível.
A renderização exata pode variar dependendo do dispositivo de saída. Por exemplo, man geralmente não poderá renderizar itálico quando estiver sendo executado em um terminal e, normalmente, usará texto sublinhado ou colorido em vez disso.
A ilustração do comando ou função é um padrão que deve corresponder a todas as possíveis invocações. Em alguns casos, é aconselhável ilustrar várias invocações exclusivas, como é mostrado na seção SINTAXE desta página de manual.
EXEMPLOS
man ls
Exibe a página de manual para o item (programa) ls.
man man.7
Exibe a página do manual para o pacote macro man da seção 7. (Esta é uma grafia alternativa de "man 7 man".)
man 'man(7)'
Exibe a página do manual para o pacote macro man da seção 7. (Esta é outra grafia alternativa de "man 7 man". Pode ser mais conveniente ao copiar e colar referências cruzadas para as páginas do manual. Observe que os parênteses normalmente devem ser colocados entre aspas para protegê-los do shell.)
man -a intro
Exibe, em sucessão, todas as páginas do manual intro disponíveis dentro do manual. É possível sair entre as exibições sucessivas ou ignorar qualquer uma delas.
man -t bash | lpr -Pps
Formata a página do manual para bash no formato troff ou groff padrão e a envia para a impressora chamada ps. A saída padrão para groff geralmente é PostScript. man --help deve informar qual processador está associado à opção -t.
man -l -Tdvi ./foo.1x.gz > ./foo.1x.dvi
Este comando irá descompactar e formatar a página do manual nroff ./foo.1x.gz em um arquivo independente de dispositivo (dvi). A redireção é necessária, pois a flag -T faz com que a saída seja direcionada para stdout sem o uso de um paginador. A saída pode ser visualizada com um programa como xdvi ou processada posteriormente em PostScript usando um programa como dvips.
man -k printf
Pesquisa as descrições curtas e os nomes das páginas do manual em busca da palavra-chave printf como uma expressão regular. Imprime quaisquer correspondências. Equivalente a apropos printf.
man -f smail
Localiza as páginas do manual referenciadas por smail e imprime as descrições curtas de todas as páginas encontradas. Equivalente a whatis smail.
VISÃO GERAL
Muitas opções estão disponíveis para man, a fim de oferecer o máximo de flexibilidade possível ao usuário. As alterações podem ser feitas no caminho de pesquisa, na ordem das seções, no processador de saída e em outros comportamentos e operações detalhados abaixo.
Se definido, várias variáveis de ambiente são consultadas para determinar a operação de man. É possível definir a variável "catch-all" $MANOPT como qualquer string no formato de linha de comando, com a exceção de que quaisquer espaços usados como parte de um argumento de opção devem ser escapados (precedidos por uma barra invertida). man irá analisar $MANOPT antes de analisar sua própria linha de comando. As opções que exigem um argumento serão substituídas pelas mesmas opções encontradas na linha de comando. Para redefinir todas as opções definidas em $MANOPT, -D pode ser especificado como a opção inicial da linha de comando. Isso permitirá que man "esqueça" as opções especificadas em $MANOPT, embora elas ainda devam ter sido válidas.
As páginas do manual são normalmente armazenadas no formato nroff(1) em um diretório como /usr/share/man. Em algumas instalações, também pode haver páginas cat pré-formatadas para melhorar o desempenho. Consulte manpath(5) para obter detalhes sobre onde esses arquivos são armazenados.
Este pacote oferece suporte a páginas de manual em vários idiomas, controladas pelo seu locale. Se o seu sistema não o configurou automaticamente, você pode precisar definir $LC_MESSAGES, $LANG ou outra variável de ambiente dependente do sistema para indicar seu locale preferido, geralmente especificado no formato POSIX:
<idioma>[_<território>[.<conjunto-de-caracteres>[,<versão>]]]
Se a página desejada estiver disponível em seu idioma, ela será exibida em vez da página padrão (geralmente em inglês americano).
Se você constatar que as traduções fornecidas com este pacote não estão disponíveis em seu idioma nativo e você gostaria de fornecê-las, entre em contato com o mantenedor, que coordenará essa atividade.
As páginas de manual individuais são normalmente escritas e mantidas pelos mantenedores do programa, função ou outro tópico que documentam e não estão incluídas neste pacote. Se você achar que uma página de manual está faltando ou é inadequada, informe isso aos mantenedores do pacote em questão.
Para obter informações sobre outros recursos e extensões disponíveis com esta ferramenta de manual, consulte os documentos fornecidos com o pacote.
PADRÕES
A ordem das seções a serem pesquisadas pode ser substituída pela variável de ambiente $MANSECT ou pela diretiva SECTION em /etc/manpath.config. Por padrão, é a seguinte:
1n l 8 3 0 2 3type 3posix 3pm 3perl 3am 5 4 9 6 7
A página de manual formatada é exibida usando um visualizador de páginas. Isso pode ser especificado de várias maneiras ou, caso contrário, será usado um valor padrão (consulte a opção -P para obter detalhes).
Os filtros são decifrados por vários meios. Primeiro, a opção de linha de comando -p ou a variável de ambiente $MANROFFSEQ são examinadas. Se -p não foi usado e a variável de ambiente não foi definida, a primeira linha do arquivo nroff é analisada para obter uma string de pré-processador. Para conter uma string de pré-processador válida, a primeira linha deve se assemelhar a:
'\" <string>
onde string pode ser qualquer combinação de letras descrita na opção -p abaixo.
Se nenhum dos métodos acima fornecer informações sobre o filtro, um conjunto padrão será usado.
Um pipeline de formatação é formado a partir dos filtros e do formatador primário (nroff ou [tg]roff
com -t) e executado. Alternativamente, se um programa executável mandb_nfmt (ou mandb_tfmt com
-t) existir na raiz da árvore de manual, ele será executado em vez disso. Ele recebe o arquivo de origem do manual,
a string do pré-processador e, opcionalmente, o dispositivo especificado com -T ou -E como argumentos.
OPÇÕES
As opções não argumentadas que são duplicadas na linha de comando, em $MANOPT ou em ambos não são prejudiciais. Para opções que exigem um argumento, cada duplicação substituirá o valor do argumento anterior.
Opções gerais
-C arquivo, --config-file=arquivo
Use este arquivo de configuração de usuário em vez do padrão \~/.manpath.
-d, --debug
Imprima informações de depuração.
-D, --default
Esta opção normalmente é emitida como a primeira opção e redefine o comportamento do man para o padrão. Seu uso é redefinir as opções que podem ter sido definidas em $MANOPT. Quaisquer opções que seguirem -D terão seu efeito usual.
--warnings[=warnings]
Habilita os avisos do groff. Isso pode ser usado para realizar verificações de integridade no texto de origem das páginas de manual. `warnings` é uma lista separada por vírgulas de nomes de avisos; se não for fornecida, o padrão é "mac". Para desativar um aviso do groff, prefixe-o com "!": por exemplo,
`--warnings=mac,!break` habilita os avisos na categoria "mac" e desativa os avisos na categoria "break". Consulte o nó "Warnings" em info groff para obter uma lista de nomes de avisos disponíveis.
Principais modos de operação
-f, --whatis
Aproximadamente equivalente a whatis. Exibe uma breve descrição da página do manual, se disponível. Consulte whatis(1) para obter detalhes.
-k, --apropos
Aproximadamente equivalente a apropos. Pesquisa as descrições resumidas das páginas do manual em busca de palavras-chave e exibe as correspondências. Consulte apropos(1) para obter detalhes.
-K, --global-apropos
Pesquisa o texto em todas as páginas do manual. Esta é uma pesquisa completa e provavelmente levará algum tempo; se possível, você deve especificar uma seção para reduzir o número de páginas que precisam ser pesquisadas. Os termos de pesquisa podem ser strings simples (o padrão) ou expressões regulares se a opção --regex for usada.
Observe que isso pesquisa as fontes das páginas do manual, e não o texto renderizado, e, portanto, pode incluir falsos positivos devido a coisas como comentários em arquivos de origem, ou falsos negativos devido a coisas como hífens escritos como "\-" nos arquivos de origem. A pesquisa do texto renderizado seria muito mais lenta.
-l, --local-file
Ativa o modo "local". Formata e exibe os arquivos de manual locais em vez de pesquisar a coleção de manual do sistema. Cada argumento de página de manual será interpretado como um arquivo de origem nroff no formato correto. Nenhum arquivo cat é produzido. Se '-' for listado como um dos argumentos, a entrada será obtida de stdin.
Se esta opção não for usada, o man também interpretará os argumentos da página do manual como nomes de arquivos locais se o argumento contiver um caractere "/", pois este é um bom indicador de que o argumento se refere a um caminho no sistema de arquivos.
-w, --where, --path, --location
Não exiba realmente a página do manual, mas imprima o local do arquivo de origem nroff que seria formatado. Se a opção -a também for usada, imprima os locais de todos os arquivos de origem que correspondem aos critérios de pesquisa.
-W, --where-cat, --location-cat
Não exiba realmente a página do manual, mas imprima o local do arquivo cat pré-formatado que seria exibido. Se a opção -a também for usada, imprima os locais de todos os arquivos cat pré-formatados que correspondem aos critérios de pesquisa.
Se -w e -W forem usados, imprima ambos os arquivos de origem e cat separados por um espaço.
Se todos os itens -w, -W e -a forem usados, faça isso para cada correspondência possível.
-c, --catman
Esta opção não é para uso geral e deve ser usada apenas pelo programa catman.
-R encoding, --recode=encoding
Em vez de formatar a página do manual da maneira usual, saída sua fonte convertida para a codificação especificada. Se você já souber a codificação do arquivo de origem, também poderá usar manconv(1) diretamente. No entanto, esta opção permite converter várias páginas de manual para uma única codificação sem precisar especificar explicitamente a codificação de cada uma, desde que elas já estejam instaladas em uma estrutura semelhante a uma hierarquia de página de manual.
Considere usar man-recode(1) para converter várias páginas de manual, pois ele possui uma interface projetada para conversão em massa e, portanto, pode ser muito mais rápido.
Encontrando páginas de manual
-L locale, --locale=locale
Normalmente, man determina seu locale atual por meio de uma chamada para a função C setlocale(3), que consulta várias variáveis de ambiente, possivelmente incluindo $LC_MESSAGES e $LANG. Para substituir temporariamente o valor determinado, use esta opção para fornecer uma string de locale diretamente para man. Observe que isso só terá efeito quando a busca por páginas realmente começar. A saída, como a mensagem de ajuda, sempre será exibida no locale determinado inicialmente.
-m system[,...], --systems=system[,...]
Se este sistema tiver acesso a páginas de manual de outros sistemas operacionais, elas poderão ser acessadas usando esta opção. Para pesquisar uma página de manual da coleção de páginas de manual do NewOS, use a opção -m NewOS.
O sistema especificado pode ser uma combinação de nomes de sistemas operacionais separados por vírgula. Para incluir uma pesquisa das páginas de manual do sistema operacional nativo, inclua o nome do sistema man na string de argumento. Esta opção substituirá a variável de ambiente $SYSTEM.
-M path, --manpath=path
Especifique um manpath alternativo a ser usado. Por padrão, man usa código derivado de manpath para determinar o caminho a ser pesquisado. Esta opção substitui a variável de ambiente $MANPATH e faz com que a opção -m seja ignorada.
Um caminho especificado como um manpath deve ser a raiz de uma hierarquia de páginas de manual estruturada em seções, conforme descrito no manual man-db (na seção "O sistema de páginas de manual"). Para visualizar páginas de manual fora dessas hierarquias, consulte a opção -l.
-S list, -s list, --sections=list
A lista fornecida é uma lista separada por dois pontos ou vírgulas de seções, usada para determinar quais seções de manual pesquisar e em que ordem. Esta opção substitui a variável de ambiente $MANSECT. (A grafia -s é para compatibilidade com o System V.)
-e sub-extension, --extension=sub-extension
Alguns sistemas incorporam grandes pacotes de páginas de manual, como os que acompanham o pacote Tcl, na hierarquia principal de páginas de manual. Para contornar o problema de ter duas páginas de manual com o mesmo nome, como exit(3), as páginas Tcl geralmente eram todas atribuídas à seção l. Como isso é lamentável, agora é possível colocar as páginas na seção correta e atribuir uma "extensão" específica a elas, neste caso, exit(3tcl). Em operação normal, man exibirá exit(3) em vez de exit(3tcl). Para resolver esta situação e evitar ter que saber em qual seção a página que você precisa reside, agora é possível fornecer a man uma string de subextensão indicando a qual pacote a página deve pertencer. Usando o exemplo acima, fornecer a opção -e tcl para man restringirá a pesquisa a páginas que tenham uma extensão de *tcl.
-i, --ignore-case
Ignora a distinção entre maiúsculas e minúsculas ao pesquisar páginas de manual. Este é o padrão.
-I, --match-case
Pesquisa páginas de manual com distinção entre maiúsculas e minúsculas.
--regex
Mostra todas as páginas cujos nomes ou descrições correspondam a cada argumento de página como uma expressão regular, como em apropos(1). Como geralmente não há uma maneira razoável de escolher a "melhor" página ao pesquisar uma expressão regular, esta opção implica -a.
--wildcard
Mostra todas as páginas cujos nomes ou descrições correspondam a cada argumento de página usando curingas no estilo shell, como em apropos(1) --wildcard. O argumento de página deve corresponder ao nome ou descrição inteira, ou corresponder aos limites de palavras na descrição. Como geralmente não há uma maneira razoável de escolher a "melhor" página ao pesquisar um curinga, esta opção implica -a.
--names-only
Se a opção --regex ou --wildcard for usada, corresponda apenas aos nomes das páginas, e não às descrições das páginas, como em whatis(1). Caso contrário, não tem efeito.
-a, --all
Por padrão, man sai após exibir a página de manual mais adequada que encontrar. Usar esta opção força man a exibir todas as páginas de manual cujos nomes correspondam aos critérios de pesquisa.
-u, --update
Esta opção faz com que man atualize seus caches de banco de dados de páginas de manual instaladas. Isso só é necessário em situações raras, e normalmente é melhor executar mandb(8) em vez disso.
--no-subpages
Por padrão, man tentará interpretar pares de nomes de páginas de manual fornecidos na linha de comando como equivalentes a um único nome de página de manual contendo um hífen ou um sublinhado. Isso suporta o padrão comum de programas que implementam vários subcomandos, permitindo que forneçam páginas de manual para cada um, que podem ser acessadas usando uma sintaxe semelhante à que seria usada para invocar os próprios subcomandos. Por exemplo:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Para desativar este comportamento, use a opção --no-subpages.
$ man -aw --no-subpages git diff
/usr/share/man/man1/git.1.gz
/usr/share/man/man3/Git.3pm.gz
/usr/share/man/man1/diff.1.gz
Controlando a saída formatada
-P pager, --pager=pager
Especifica qual programa de paginação de saída usar. Por padrão, man usa pager, voltando para cat se pager não for encontrado ou não for executável. Esta opção substitui a variável de ambiente $MANPAGER, que, por sua vez, substitui a variável de ambiente $PAGER. Não é usado em conjunto com -f ou -k.
O valor pode ser um nome de comando simples ou um comando com argumentos e pode usar aspas do shell (barras invertidas, aspas simples ou aspas duplas). Não pode usar pipes para conectar vários comandos; se precisar disso, use um script de wrapper, que pode receber o arquivo a ser exibido como um argumento ou na entrada padrão.
-r prompt, --prompt=prompt
Se uma versão recente de less for usada como paginador, man tentará definir seu prompt e algumas opções sensatas. O prompt padrão se parece com:
Nome da página do manual(seção) linha x
onde nome indica o nome da página do manual, seção indica a seção em que foi encontrada e x o número da linha atual. Isso é feito usando a variável de ambiente $LESS.
Fornecer -r com uma string substituirá esse padrão. A string pode conter o texto $MAN_PN, que será expandido para o nome da página do manual atual e seu nome de seção, envoltos entre parênteses. A string usada para produzir o padrão pode ser expressa como:
\ Página\ do\ manual\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(pressione h para obter ajuda ou q para sair)
Está dividido em três linhas aqui apenas para facilitar a leitura. Para seu significado, consulte a página do manual less(1). A string do prompt é primeiro avaliada pelo shell. Todas as aspas duplas, aspas simples e barras invertidas no prompt devem ser escapadas com uma barra invertida precedente. A string do prompt pode terminar com um $ escapado, que pode ser seguido por opções adicionais para less. Por padrão, man define as opções -ix8.
A variável de ambiente $MANLESS, descrita abaixo, pode ser usada para definir uma string de prompt padrão, caso nenhuma seja fornecida na linha de comando.
-7, --ascii
Ao visualizar uma página de manual ASCII pura em um terminal ou emulador de terminal de 7 bits, alguns caracteres podem não ser exibidos corretamente ao usar a descrição do dispositivo latin1(7) com GNU nroff. Esta opção permite que as páginas de manual ASCII puras sejam exibidas em ASCII com o dispositivo latin1. Não traduzirá nenhum texto latin1. A tabela a seguir mostra as traduções executadas: algumas partes podem ser exibidas corretamente somente quando você usa a descrição do dispositivo latin1(7) do GNU nroff.
Descrição Octal latin1 ascii
hífen de continuação 255 ‐ ponto (meio) 267 • o
acento agudo 264 ´ '
sinal de multiplicação 327 × x
Se a coluna latin1 for exibida corretamente, seu terminal pode estar configurado para caracteres latin1 e esta opção não é necessária. Se as colunas latin1 e ASCII forem idênticas, você está lendo esta página usando esta opção ou man não formatou esta página usando a descrição do dispositivo latin1. Se a coluna latin1 estiver ausente ou corrompida, você pode precisar visualizar as páginas do manual com esta opção.
Esta opção é ignorada ao usar as opções -t, -H, -T ou -Z e pode ser inútil para nroff diferente do GNU.
-E encoding, --encoding=encoding
Gera saída para uma codificação de caracteres diferente da padrão. Para compatibilidade com versões anteriores, a codificação pode ser um dispositivo nroff, como ascii, latin1 ou utf8, bem como uma codificação de caracteres real, como UTF-8.
--no-hyphenation, --nh
Normalmente, o nroff irá automaticamente hifenizar o texto nas quebras de linha, mesmo em palavras que não contêm hífens, se for necessário fazê-lo para dispor as palavras em uma linha sem espaçamento excessivo. Esta opção desativa a hifenização automática, para que as palavras sejam hifenizadas apenas se já contiverem hífens.
Se você estiver escrevendo uma página de manual e simplesmente quiser impedir que o nroff hifenize uma palavra em um ponto inadequado, não use esta opção, mas consulte a documentação do nroff; por exemplo, você pode colocar "\%" dentro de uma palavra para indicar que ela pode ser hifenizada naquele ponto, ou colocar "\%" no início de uma palavra para impedir que ela seja hifenizada.
--no-justification, --nj
Normalmente, o nroff irá automaticamente justificar o texto em ambas as margens. Esta opção desativa a justificação completa, deixando apenas a justificação na margem esquerda, às vezes chamada de texto "desalinhado à direita".
Se você estiver escrevendo uma página de manual e simplesmente quiser impedir que o nroff justifique certos parágrafos, não use esta opção, mas consulte a documentação do nroff; por exemplo, você pode usar as solicitações ".na", ".nf", ".fi" e ".ad" para desativar temporariamente o ajuste e o preenchimento.
-p string, --preprocessor=string
Especifica a sequência de pré-processadores a serem executados antes do nroff ou troff/groff. Nem todas as instalações terão um conjunto completo de pré-processadores. Alguns dos pré-processadores e as letras usadas para designá-los são: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Esta opção substitui a variável de ambiente $MANROFFSEQ. O zsoelim é sempre executado como o primeiro pré-processador.
-t, --troff
Use groff -mandoc para formatar a página de manual para a saída padrão. Esta opção não é necessária em conjunto com -H, -T ou -Z.
-T[device], --troff-device[=device]
Esta opção é usada para alterar a saída do groff (ou possivelmente do troff) para ser adequada a um dispositivo diferente do padrão. Ela implica -t. Exemplos (a partir do groff 1.23.0) incluem dvi, latin1, pdf, ps, utf8, X75 e X100.
-H[browser], --html[=browser]
Esta opção fará com que o groff produza saída HTML e exibirá essa saída em um navegador da web. A escolha do navegador é determinada pelo argumento opcional do navegador, se fornecido, pela variável de ambiente $BROWSER ou por um padrão de tempo de compilação, se isso não estiver definido (geralmente lynx). Esta opção implica -t e só funcionará com o GNU troff.
-X[dpi], --gxditview[=dpi]
Esta opção exibe a saída do groff em uma janela gráfica usando o programa gxditview. O dpi (pontos por polegada) pode ser 75, 75-12, 100 ou 100-12, com o padrão sendo 75; as variantes "-12" usam uma fonte base de 12 pontos. Esta opção implica -T com o dispositivo X75, X75-12, X100 ou X100-12, respectivamente.
-Z, --ditroff
O groff executará o troff e, em seguida, usará um pós-processador apropriado para produzir a saída adequada ao dispositivo escolhido. Se groff -mandoc for groff, esta opção será passada para o groff e suprimirá o uso de um pós-processador. Ela implica -t.
Obter ajuda
-?, --help
Imprime uma mensagem de ajuda e sai.
--usage
Imprime uma mensagem de uso curta e sai.
-V, --version
Exibe informações da versão.
STATUS DE SAÍDA
0 Execução bem-sucedida do programa.
1 Erro de uso, sintaxe ou arquivo de configuração.
2 Erro operacional.
3 Um processo filho retornou um status de saída diferente de zero.
16 Pelo menos uma das páginas/arquivos/palavras-chave não existiu ou não foi correspondida.
AMBIENTE
MANPATH
Se $MANPATH estiver definido, seu valor será usado como o caminho para pesquisar as páginas de manual.
Consulte a seção PATH DE PESQUISA de manpath(5) para obter o comportamento padrão e os detalhes de como essa variável de ambiente é tratada.
MANROFFOPT
Toda vez que o man invoca o formatador (nroff, troff ou groff), ele adiciona o conteúdo de $MANROFFOPT à linha de comando do formatador.
Por exemplo, MANROFFOPT=-P-i diz ao formatador para usar texto em itálico (que é suportado apenas por alguns terminais) em vez de texto sublinhado.
MANROFFSEQ
Se $MANROFFSEQ estiver definido, seu valor será usado para determinar o conjunto de pré-processadores a serem passados para cada página de manual. A lista padrão de pré-processadores depende do sistema.
MANSECT
Se $MANSECT estiver definido, seu valor será uma lista delimitada por dois pontos de seções e será usado para determinar quais seções de manual pesquisar e em que ordem. O padrão é "1 n l 8 3 0 2 3ype 3posix 3pm 3perl 3am 5 4 9 6 7", a menos que seja substituído pela diretiva SECTION em /etc/manpath.config.
MANPAGER, PAGER
Se $MANPAGER ou $PAGER estiver definido ($MANPAGER é usado com preferência), seu valor será usado como o nome do programa usado para exibir a página de manual. Por padrão, o pager é usado, voltando para o cat se o pager não for encontrado ou não for executável.
O valor pode ser um nome de comando simples ou um comando com argumentos e pode usar aspas do shell (barras invertidas, aspas simples ou aspas duplas). Não pode usar pipes para conectar múltiplos comandos; se precisar disso, use um script wrapper, que pode receber o arquivo a ser exibido como um argumento ou na entrada padrão.
MANLESS
Se $MANLESS estiver definido, seu valor será usado como a string de prompt padrão para o pager less, como se tivesse sido passado usando a opção -r (então todas as ocorrências do texto $MAN_PN serão expandidas da mesma forma). Por exemplo, se você quiser definir a string de prompt incondicionalmente para “minha string de prompt”, defina $MANLESS para ‘-Psminha string de prompt’. O uso da opção -r substitui esta variável de ambiente.
BROWSER
Se $BROWSER estiver definido, seu valor será uma lista delimitada por dois pontos de comandos, cada um dos quais será usado para tentar iniciar um navegador web para man --html. Em cada comando, %s é substituído por um nome de arquivo contendo a saída HTML de groff, %% é substituído por um único sinal de porcentagem (%) e %c é substituído por dois pontos (:).
SYSTEM Se $SYSTEM estiver definido, terá o mesmo efeito que especificá-lo como argumento para a opção -m.
MANOPT Se $MANOPT estiver definido, será analisado antes da linha de comando do man e espera-se que esteja em um formato semelhante. Como todas as outras variáveis de ambiente específicas do man podem ser expressas como opções da linha de comando, e, portanto, são candidatas a serem incluídas em $MANOPT, espera-se que elas se tornem obsoletas. Observação: todos os espaços que devem ser interpretados como parte do argumento de uma opção devem ser escapados.
MANWIDTH
Se $MANWIDTH estiver definido, seu valor será usado como o comprimento da linha para o qual as páginas do manual devem ser formatadas. Se não estiver definido, as páginas do manual serão formatadas com um comprimento de linha apropriado para o terminal atual (usando o valor de $COLUMNS e ioctl(2), se disponível, ou, caso contrário, voltando para 80 caracteres). As páginas de catálogo serão salvas apenas quando a formatação padrão puder ser usada, ou seja, quando o comprimento da linha do terminal estiver entre 66 e 80 caracteres.
MAN_KEEP_FORMATTING
Normalmente, quando a saída não está sendo direcionada para um terminal (como para um arquivo ou um pipe), os caracteres de formatação são descartados para facilitar a leitura do resultado sem ferramentas especiais. No entanto, se $MAN_KEEP_FORMATTING estiver definido para qualquer valor não vazio, esses caracteres de formatação serão mantidos. Isso pode ser útil para wrappers em torno do man que podem interpretar caracteres de formatação.
MAN_KEEP_STDERR
Normalmente, quando a saída está sendo direcionada para um terminal (geralmente para um visualizador de páginas), qualquer saída de erro do comando usado para produzir versões formatadas de páginas do manual é descartada para evitar interferência com a exibição do visualizador de páginas. Programas como groff geralmente produzem mensagens de erro relativamente pequenas sobre problemas tipográficos, como alinhamento ruim, que são desagradáveis e geralmente confusas quando exibidas junto com a página do manual. No entanto, alguns usuários desejam vê-los, portanto, se $MAN_KEEP_STDERR estiver definido para qualquer valor não vazio, a saída de erro será exibida como de costume.
MAN_DISABLE_SECCOMP
No Linux, o man normalmente confina os subprocessos que lidam com dados não confiáveis usando um sandbox seccomp(2). Isso torna mais seguro executar código de análise complexo em páginas de manual arbitrárias. Se isso der errado por algum motivo não relacionado ao conteúdo da página que está sendo exibida, você pode definir $MAN_DISABLE_SECCOMP para qualquer valor não vazio para desativar o sandbox.
PIPELINE_DEBUG
Se a variável de ambiente $PIPELINE_DEBUG estiver definida como "1", o man imprimirá mensagens de depuração no erro padrão, descrevendo cada subprocesso que executa.
LANG, LC_MESSAGES
Dependendo do sistema e da implementação, uma ou ambas das variáveis de ambiente $LANG e $LC_MESSAGES serão interrogadas para obter o local de mensagens atual. O man exibirá suas mensagens nesse local (se disponível). Consulte setlocale(3) para obter detalhes precisos.
ARQUIVOS
/etc/manpath.config
Arquivo de configuração do man-db.
/usr/share/man
Uma hierarquia global de páginas do manual.
PADRÕES
POSIX.1-2001, POSIX.1-2008, POSIX.1-2017.
VEJA TAMBÉM
apropos(1), groff(1), less(1), manpath(1), nroff(1), troff(1), whatis(1), zsoelim(1), manpath(5), man(7), catman(8), mandb(8)
A documentação de alguns pacotes pode estar disponível em outros formatos, como info(1) ou HTML.
HISTÓRICO
1990 1991 – Originalmente escrito por John W. Eaton (_).
23 de dezembro de 1992: Rik Faith (_) aplicou correções de bugs fornecidas por Willem Kasdorp (_).
30 de abril de 1994 – 23 de fevereiro de 2000: Wilf. (_) tem desenvolvido e mantido este pacote com a ajuda de algumas pessoas dedicadas.
30 de outubro de 1996 – 30 de março de 2001: Fabrizio Polacco <_> manteve e aprimorou este pacote para o projeto Debian, com a ajuda de toda a comunidade.
31 de março de 2001 – presente: Colin Watson <_> está agora desenvolvendo e mantendo o man-db.
BUGS
https://gitlab.com/man-db/man-db/-/issues https://savannah.nongnu.org/bugs/?group=man-db