Escolar Documentos
Profissional Documentos
Cultura Documentos
NOME
man - uma interface para os manuais de referência do sistema
SINOPSE
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 paginador de manual do sistema. Cada argumento página fornecido
ao man é normalmente o nome de um programa, utilitário ou função. A
página de manual associada com esses argumentos é, então, localizada e
exibida. Uma seção, se fornecida, direcionará man para procurar apenas
naquela seção do manual. A ação padrão é para pesquisar em todas as
seções disponíveis seguindo a seguinte ordem pré-definida (veja
DEFAULTS), e para mostrar apenas a primeira página localizada, mesmo se
página existir em várias seções.
EXEMPLOS
man ls
Exibe a página de manual para o item (programa) ls.
man man.7
Exibe a página de manual para o pacote macro man para a seção 7.
(Esta é uma escrita alternativa de "man 7 man".)
man 'man(7)'
Exibe a página de manual do pacote de macro man da seção 7. (Essa é
outra grafia alternativa de "man 7 man". Pode ser mais conveniente
copiar e colar referências cruzadas em páginas de manual. Observe
que os parênteses normalmente devem ser colocado entre aspas para
evitar que o shell interprete-os.)
man -a intro
Exibe, em sucessão, todas as páginas de manual de intro disponíveis
contidos no manual. É possível sair entre exibições sucessivas ou
pular qualquer uma delas.
man -k printf
Pesquisa por descrições curtas e nomes de páginas de manual para a
palavra-chave printf como expressão regular. Emite qualquer
correspondência. Equivalente a apropos printf.
man -f smail
Procura as páginas de manual referenciadas por smail e imprime as
descrições curtas de qualquer uma que tenha sido localizada.
Equivalente a whatis smail.
VISÃO GERAL
Muitas opções estão disponíveis para man para fornecer tanta
flexibilidade quanto for possível para o usuário. Alterações podem ser
feitas ao caminho de pesquisa, ordem de seção, processador de saída e
outros comportamentos e operações detalhados abaixo.
<idioma>[_<território>[.<conjunto-de-caracteres>[,<versão>]]]
Se você descobrir que as traduções fornecidas com este pacote não estão
disponíveis em seu idioma nativo e quiser fornecê-las, contate o
mantenedor que estará coordenando tal atividade.
PADRÕES
A ordem das seções para pesquisar pode ser substituída pela variável de
ambiente $MANSECT ou pela diretiva SECTION em /etc/manpath.config. Por
padrão, é o seguinte:
onde texto pode ser qualquer combinação de letras descritas pela opção
-p abaixo.
OPÇÕES
Opções não-argumentos que são duplicadas na linha de comando, em
$MANOPT ou ambos, não são prejudiciais. Para opções que exigem um
argumento, cada duplicação sobrescreverá o valor do argumento anterior.
Opções gerais
-C arquivo, --config-file=arquivo
Usa esse arquivo de configuração de usuário em vez do padrão
~/.manpath.
-d, --debug
Emite mensagens de depuração.
-D, --default
Essa opção normalmente é chamada como a primeira opção e
redefine o comportamento do man para seu padrão. Seu uso é para
redefinir aquelas opções que podem ter sido definidas no
$MANOPT. Quaisquer opções que venham após -D terão seu efeito
comum.
--warnings[=avisos]
Habilita avisos do groff. Isso pode ser usado para realizar
verificações de sanidade no texto fonte de páginas de manual.
avisos é uma lista separada por vírgulas de nomes de avisos; se
ela não for fornecida, o padrão é "mac". Veja o nó “Warnings” em
info groff para uma lista de nomes de avisos disponíveis.
-k, --apropos
Equivalente a apropos. Pesquisa as descrições curtas de página
de manual para palavras-chave e exibe quaisquer
correspondências. Veja apropos(1) para detalhes.
-K, --global-apropos
Pesquisa por texto em todas as páginas de manual. Essa é uma
pesquisa de força bruta, e é provável que leve algum tempo; se
possível, você deveria especificar uma seção para reduzir o
número de páginas que precisam ser pesquisadas. Termos de
pesquisa podem ser textos simples (o padrão) ou expressões
regulares se a opção --regex for usada.
Note que isso pesquisa os fontes das páginas de manual, não o
texto renderizado e, portanto, pode incluir falso positivos em
razão de coisas como comentários nos arquivos-fontes. Pesquisar
o texto renderizado seria ainda mais lento.
-l, --local-file
Ativa o modo "local". Formata e exibe arquivos locais de manual
em vez de pesquisar na coleção de manuais do sistema. Cada
argumento de página de manual será interpretado como um
arquivo-fonte nroff no formato correto. Nenhum arquivo cat é
produzido. Se "-" é listado como um dos argumentos, a entrada
será obtida de stdin (entrada padrão). Quando essa opção não é
usada, e o man falha em localizar a página solicitada, antes de
exibir a mensagem de erro, ele tenta agir como se essa opção
tivesse sido fornecida, usando o nome como um nome de arquivo e
procurando por uma correspondência exata.
-c, --catman
Essa opção não é para uso geral e deve ser usado apenas pelo
programa catman.
-R codificação, --recode=codificação
Em vez de formatar a página de manual na forma normal, emite seu
fonte convertido para a codificação especificada. Se você já
sabe a codificação do arquivo-fonte, você também pode usar
manconv(1) diretamente. Porém, essa opção permite que você
converta várias páginas de manual para uma única codificação sem
ter que declarar explicitamente a codificação de cada uma, desde
que elas já tenham sido instaladas em uma estrutura similar a
uma hierarquia de página de manual.
-m sistema[,...], --systems=sistema[,...]
Se esse sistema possui acesso às páginas de manual de outro
sistema operacional, é possível acessá-las usando essa opção.
Para pesquisar por uma página de manual da coleção de páginas de
manual do NewOS, use a opção -m NewOS.
-M caminho, --manpath=caminho
Especifica um caminho man a ser usado. Por padrão, man usa um
código derivado de manpath para determinar o caminho a ser
pesquisado. Essa opção sobrescreve a variável de ambiente
$MANPATH e faz com que a opção -m a ser ignorada.
-e subextensão, --extension=subextensão
Alguns sistemas incorporam pacotes grandes de páginas de manual,
como aquelas que acompanham o pacote Tcl, à 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 atribuídas à seção l. Como isso não é uma boa
ideia, agora é possível colocar as páginas na seção correta, e
atribuir uma "extensão" específica a elas (ex.: exit(3tcl). Sob
operação normal, man exibirá exit(3) como preferência em relação
a exit(3tcl). Para negociar essa situação e para evitar de ter
que saber em qual seção de página você deseja está, agora é
possível fornecer ao man um texto subextensão indicando a qual
pacote a página deve pertencer. Usando o exemplo acima, fornecer
a opção -e tcl para man vai restringir a pesquisa a páginas
tendo uma extensão de *tcl.
-i, --ignore-case
Ignora diferença maiúsculo/minúsculo para páginas de manual.
Esse é o padrão.
-I, --match-case
Pesquisa por páginas de manual diferenciando
maiúsculo/minúsculo.
--regex
Mostra todas as páginas com qualquer parte de seus nomes ou suas
descrições correspondendo a cada argumento de página como uma
expressão regular, como ocorre com apropos(1). Já que geralmente
não há uma forma razoável de pegar a "melhor" página ao
pesquisar por uma expressão regular, essa opção resulta em -a.
--wildcard
Mostra todas as páginas com qualquer parte de seus nomes ou suas
descrições correspondendo a cada argumento de página usando
caracteres curingas do tipo shell, como ocorre com a opção
--wildcard de apropos(1). O argumento de página deve
corresponder ao nome completo ou descrição completa, ou
corresponder a limites de uma palavra na descrição. Já que
geralmente não há uma forma razoável de pegar a "melhor" página
ao pesquisar por um curinga, essa opção resulta em -a.
--names-only
Se a opção --regex ou --wildcard for usada, corresponde apenas a
nomes de páginas, e não a descrições de páginas, como ocorre com
whatis(1). Do contrário, nenhum efeito.
-a, --all
Por padrão, man sairá após exibir a página de manual encontrada
que seja mais adequada. Usar essa opção força man a exibir todas
as páginas de manual com nomes que correspondam aos critérios de
pesquisa.
-u, --update
Essa opção faz com que man atualize os caches de seus banco de
dados das páginas de manual instaladas. Isso é necessário apenas
em situações raras e, normalmente, é melhor executar mandb(8).
--no-subpages
Por padrão, man tentará interpretar pares de nomes de página de
manual fornecidos na linha de comando como equivalentes a um
único nome de página de manual contendo um hífen ou sublinhado.
Isso oferece suporte ao padrão comum de programas que
implementam uma gama de subcomandos, permitindo-lhes fornecer
páginas de manual para cada um que possam ser acessadas usando
sintaxe similar ao que seria usado para invocar os próprios
subcomandos. Por exemplo:
-r prompt, --prompt=prompt
Se uma versão recente do less for usada como paginador, man
tentará definir seu prompt e algumas opções sensíveis. O prompt
padrão se parece com
-7, --ascii
Ao visualizar uma página de manual em ascii(7) puro em um
terminal de 7 bits ou emulador de terminal, alguns caracteres
podem não ser exibidos corretamente quando se usa a descrição de
dispositivo com latin1(7) com GNU nroff. Essa opção permite que
páginas de manual em ascii puro seja exibidas em ascii com o
dispositivo latin1. Nenhum texto em latin1 será traduzido. A
tabela a seguir mostra as traduções realizadas: algumas partes
dela só podem ser exibidas adequadamente usando um dispositivo
latin1(7) do GNU nroff.
-E codificação, --encoding=codificação
Gera a saída para uma codificação de caracteres diversa do
padrão. Para compatibilidade reversa, codificação pode ser um
dispositivo nroff tal como ascii, latin1 ou utf8 assim como uma
codificação de caracteres de verdade, como UTF-8.
--no-hyphenation, --nh
Normalmente, nroff vai hifenizar automaticamente o texto na
quebra de linha mesmo em palavras que não contêm hífenes, se
isso for necessário para manter palavras em uma linha sem
espaçamento excessivo. Essa opção desabilita hifenização
automática, de forma que as palavras serão hifenizadas somente
se elas já contiverem hífenes.
--no-justification, --nj
Normalmente, nroff justificará automaticamente um texto em ambas
margens. Essa opção desabilita toda justificação, deixando como
justificada apenas a margem esquerda, o que é chamado de texto
"ragged-right" em inglês.
-p texti, --preprocessor=texto
Especifica a sequência de pré-processadores a serem executados
antes de nroff ou troff/groff. Nem todas instalações terão um
conjunto completo de pré-processadores. Alguns dos
pré-processadores e das letras usadas para designá-los são: eqn
(e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Essa
opção sobrescreve a variável de ambiente $MANROFFSEQ. zsoelim é
sempre executado como o primeiro pré-processador.
-t, --troff
Usa groff -mandoc para formatar a página manual para stdout
(saída padrão). Essa opção não é necessária em conjunto com -H,
-T ou -Z.
-T[dispositivo], --troff-device[=dispositivo]
Essa opção é usada para alterar a saída do groff (ou,
possivelmente, troff) para ser adequado para um dispositivo
diferente do padrão. Essa opção resulta em -t. Exemplos (com
Groff-1.17) incluem dvi, latin1, ps, utf8, X75 e X100.
-H[navegador], --html[=navegador]
Essa opção fará com que groff produza uma saída HTML e exiba-a
em um navegador web. A escolha do navegador é determinada pelo
argumento opcional navegador, caso este seja fornecido, obtido
pela variável de ambiente $BROWSER ou por um padrão em tempo de
compilação, se a primeira alternativa não estiver definida
(geralmente lynx). Essa opção resulta em -t e funcionará apenas
com o GNU troff.
-X[dpi], --gxditview[=dpi]
Essa opção exibe a saída de groff em uma janela gráfica usando o
programa gxditview. O dpi (pontos por polegada ou, em inglês,
"dots per inch") pode ser 75, 75-12, 100 ou 100-12, tendo como
padrão o 75; as variantes -12 usam uma fonte de base de 12
pontos. Essa opção resulta em -T com o dispositivo X75, X75-12,
X100 ou X100-12, respectivamente.
-Z, --ditroff
groff executará troff e, então, usará um pós-processador
adequado para produzir uma saída adequada para o dispositivo
escolhido. Se groff -mandoc for groff, essa opção é passada para
groff e suprimirá o uso de um pós-processador. Ela resulta em
-t.
Obtendo ajuda
-?, --help
Imprime uma mensagem de ajuda e sai.
--usage
Imprime uma mensagem curta e sai.
-V, --version
Exibe informação da versão.
STATUS DE SAÍDA
0 Execução com sucesso do programa.
2 Erro operacional.
AMBIENTE
MANPATH
Se $MANPATH estiver definido, seu valor é usado como o caminho a
ser pesquisado por páginas de manual.
MANROFFOPT
Toda vez que man invoca o formatador (nroff, troff ou groff),
ele adiciona o conteúdo de $MANROFFOPT para a linha de comando
do formatador.
MANROFFSEQ
Se $MANROFFSEQ estiver definido, seu valor é usado para
determinar o conjunto de pré-processadores por meio do qual será
passada cada página de manual. A lista padrão de
pré-processadores depende do sistema.
MANSECT
Se $MANSECT estiver definido, seu valor é uma lista delimitada
por caractere de dois pontos contendo seções que é usada para
determinar quais seções de manual devem ser pesquisadas e em
qual ordem. O padrão é "1 n l 8 3 2 3posix 3pm 3perl 3am 5 4 9 6
7", a menos que seja sobrescrito pela diretiva SECTION em
/etc/manpath.config.
MANPAGER, PAGER
Se $MANPAGER ou $PAGER estiverem definidos ($MANPAGER é usado
preferencialmente), seu valor é usado como o nome do programa
para exibir a página de manual. Por padrão, pager é usado,
usando subsidiariamente o cat se o pager for localizado ou for
um executável.
MANLESS
Se $MANLESS estiver definido, seu valor será usado como o texto
de prompt padrão para o paginador less, como se ele tivesse sido
passado usando a opção -r (de forma que quaisquer ocorrências do
texto $MAN_PN serão expandidas da mesma forma). Por exemplo, se
você deseja definir o texto de prompt incondicionalmente para
“meu texto de prompt”, definida $MANLESS com
‘-Psmeu texto de prompt’. Usar a opção -r sobrescreve essa
variável de ambiente.
BROWSER
Se $BROWSER estiver definido, seu valor é uma lista delimitada
por caractere de dois pontos contendo os comandos, cada um dos
quais, por sua vez, é 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 um %c é substituído pelo
caractere de dois pontos.
MANWIDTH
Se $MANWIDTH estiver definido, seu valor é usado como o
comprimento de linha para o qual as páginas de manual deveriam
ser formatadas. Se ele não estiver definido, as páginas de
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 retrocedendo para 80 caracteres se as duas
anteriores não estiverem disponíveis). Páginas cat serão salvas
somente quando a formatação padrão puder ser usada, que é quando
o comprimento da linha de terminal está entre 66 e 80
caracteres.
MAN_KEEP_FORMATTING
Normalmente, quando a saída não está sendo direcionada para um
terminal (ex.: para um arquivo ou um "pipe"), caracteres de
formatação são descartados para facilitar a leitura do resultado
sem ferramentas especiais. Porém, se $MAN_KEEP_FORMATTING
estiver definido para um valor diferente de vazio, esses
caracteres de formatação são mantidos. Isso pode ser útil para
scripts de interfaceamento do man ("wrappers") que possam
interpretar caracteres de formatação.
MAN_KEEP_STDERR
Normalmente, quando a saída está sendo direcionada para um
terminal (geralmente um paginador), qualquer saída de erro do
comando usado para produzir versões formatadas de páginas de
manual é descartada para evitar interferência com a exibição da
página. Programas tal como o groff frequentemente produzem
relativamente poucas mensagens de erro sobre problemas
tipográficos, (ex.: alinhamento ruim), o que é geralmente um
pouco confuso quando exibido junto com a página de manual.
Porém, alguns usuários desejam vê-los mesmo assim; então, se
$MAN_KEEP_STDERR estiver definido para qualquer valor diferente
de vazio, a saída de erro será exibida como normalmente faria.
LANG, LC_MESSAGES
Dependendo do sistema e implementação, $LANG e/ou $LC_MESSAGES
serão interrogados para obter a localidade atual das mensagens.
man exibirá suas mensagens naquela localidade (se disponível).
Veja setlocale(3) para detalhes precisos.
ARQUIVOS
/etc/manpath.config
O arquivo de configuração do man-db.
/usr/share/man
Uma hierarquia global de páginas de manual.
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)
HISTÓRICO
1990, 1991 – Originalmente escrito por John W. Eaton
(jwe@che.utexas.edu).