man - uma interface para os manuais de referência
on-line
man [-C arquivo] [-d] [-D]
[--warnings[=avisos]] [-R
codificação] [-L localidade] [-m
sistema[,...]] [-M caminho] [-S lista]
[-e extensão] [-i|-I]
[--regex|--wildcard] [--names-only] [-a]
[-u] [--no-subpages] [-P paginador] [-r
texto] [-7] [-E codificação]
[--no-hyphenation] [--no-justification] [-p
texto] [-t] [-T[dispositivo]]
[-H[navegador]] [-X[dpi]] [-Z]
[[seção]
página[.seção] ...] ...
man -k [opções do apropos ]
expressão-regular ...
man -K [-w|-W] [-S lista]
[-i|-I] [--regex] [seção]
terminal ...
man -f [opções do whatis]
página ...
man -l [-C arquivo] [-d] [-D]
[--warnings[=avisos]] [-R
codificação] [-L localidade] [-P
paginador] [-r texto] [-7] [-E
codificação] [-p texto] [-t]
[-T[dispositivo]] [-H[navegador]]
[-X[dpi]] [-Z] arquivo ...
man -w|-W [-C arquivo] [-d]
[-D] paginador ...
man -c [-C arquivo] [-d] [-D]
página ...
man [-?V]
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 ("1 n l 8 3 2 3posix 3pm
3perl 3am 5 4 9 6 7" por padrão, a menos que seja sobrescrita
pela diretiva SECTION em /etc/manpath.config), e para mostrar
apenas a primeira página localizada, mesmo se
página existir em várias
seções.
A tabela abaixo mostra os números
seção do manual seguido pelos tipos de páginas
que eles contêm.
| 1 |
Comandos shell ou programas executáveis |
| 2 |
Chamadas de sistema (funções fornecidas pelo kernel) |
| 3 |
Chamadas de biblioteca (funções dentro de bibliotecas de
programa) |
| 4 |
Arquivos especiais (geralmente localizados em /dev) |
| 5 |
Formatos de arquivo e convenções (ex.:
/etc/passwd) |
| 6 |
Jogos |
| 7 |
Miscelânea (incluindo convenções e pacotes macro),
(ex.: man(7), groff(7)) |
| 8 |
Comandos de administração do sistema (geralmente apenas
para root) |
| 9 |
Rotinas do kernel [não padrão] |
Uma página de manual consiste em várias
seções.
Nomes de seção convencional incluem NAME,
SYNOPSIS, CONFIGURATION, DESCRIPTION, OPTIONS,
EXIT STATUS, RETURN VALUE, ERRORS,
ENVIRONMENT, FILES, VERSIONS,
CONFORMING TO, NOTES, BUGS, EXAMPLE,
AUTHORS e SEE ALSO.
As convenções a seguir se aplicam à
seção SYNOPSIS e podem ser usadas como uma guia em
outras seções.
| texto em negrito |
digite exatamente como mostrado. |
| texto em itálico |
substitua com o argumento apropriado. |
| [-abc] |
qualquer ou todos os argumentos dentro de [ ] são opcionais. |
| -a|-b |
opções delimitadas por | não podem ser usadas
juntas. |
| argumento ... |
argumento é repetível. |
| [expressão] ... |
toda a expressão dentro [ ] é
repetível. |
Renderização exata pode variar dependendo do
dispositivo de saída. Por exemplo, man geralmente não é
capaz de renderizar itálicos ao ser executado em um terminal e
normalmente usará um texto sublinhado ou colorizado.
A ilustração de comando ou função
é um padrão que deve corresponder a todas
invocações possíveis. Em alguns casos, é
recomendável ilustrar invocações exclusivas como
é mostrar na seção SYNOPSIS desta página
de manual.
- 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.
- 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 -t apelido
| lpr -Pps
- Formata a página de manual referenciada por
"apelido", geralmente uma página de manual shell,
em um formato padrão troff ou groff e redireciona-o
para o nome da impressora ps. A saída padrão para
groff geralmente é PostScript. man --help deve avisar
sobre qual processador está vinculado à opção
-t.
- man -l -Tdvi
./foo.1x.gz > ./foo.1x.dvi
- Esse comando vai descomprimir e formatar a página de manual fonte
nroff ./foo.1x.gz em um arquivo device independent (dvi). O
redirecionamento é necessária, pois a opção
-T causa a saída ser direcionada à stdout
(saída padrão) com nenhum paginador. A saída pode ser
visto com um programa tal como xdvi ou processado para PostScript
usando um programa como dvips.
- 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.
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.
Se definidas, várias variáveis de ambiente
serão interrogadas para determinar a operação do
man. É possível definir a variável
"mãe" $MANOPT para qualquer texto no formato de
linha de comando com a exceção de que quaisquer espaços
usados como parte de um argumento da opção devem ser escapado
(precedido por uma barra invertida). man analisará
$MANOPT antes de analisar sua própria linha de comando.
Aquelas opções exigindo um argumento serão sobrescritas
pelas mesmas opções localizadas na linha de comando. Para
redefinir todas as opções em $MANOPT, -D pode
ser especificada como uma opção inicial de linha comando. Isso
vai permitir que man "esqueça" sobre as
opções especificadas em $MANOPT, apesar delas ainda
precisarem ser válidas.
Os utilitários de paginação de manual
empacotados como man-db fazem uso extensivo dos caches de banco de
dados index. Esses caches contêm informações
como, por exemplo, onde cada página de manual pode ser localizada no
sistema de arquivos e o que seu whatis (descrição curta
de uma linha das páginas de manual), e permite que man execute
mais rapidamente do que se ele tivesse que pesquisar no sistema de arquivos
toda vez para localizar a página de manual apropriada. Se requisitado
o uso da opção -u, man vai assegurar que os
caches permaneçam consistentes, o que pode evitar a necessidade de
executar manualmente software para atualizar os tradicionais bancos de dados
de texto do whatis.
Se man não puder localizar um banco de dados
index iniciado pelo mandb para uma hierarquia de
páginas de manual em particular, ele ainda pode pesquisar pelas
páginas de manual, apesar de que uma busca por arquivos será
necessária para pesquisar dentro daquela hierarquia. Se whatis
ou apropos falhar em localizar um index, ele tentará
extrair informações a partir de um banco de dados tradicional
do whatis.
Esses utilitários oferecem suporte a arquivos-fonte nroff
comprimidos tendo, por padrão, as extensões de .Z,
.z e .gz. É possível lidar com qualquer
extensão comprimida, mas essas informações devem ser
conhecidas em tempo de compilação. Também, por
padrão, qualquer página cat produzida é comprimida
usando gzip. Cada hierarquia "global" de página de
manual, tal como /usr/share/man ou /usr/X11R6/man, pode conter
qualquer diretório como sua hierarquia de diretório cat.
Tradicionalmente, as páginas cat são armazenadas sob a mesma
hierarquia que as páginas man, mas, por motivos como aqueles
especificados no Filesystem Hierarchy Standard (FHS) (Padrão
de Hierarquia de Sistema de Arquivos), pode ser melhor armazená-los
em outro lugar. Para detalhes sobre como fazer isso, por favor leia
manpath(5). Para detalhes sobre como fazer isso, leia o
padrão.
Suporte internacional está disponível com esse
pacote. Páginas de manual com idiomas nativos estão
acessíveis (se disponível sem seu sistema) por meio do uso de
funções de localidade. Para ativar tal suporte,
é necessário definir $LC_MESSAGES, $LANG ou
outra variável de ambiente dependente do sistema para a localidade de
seu idioma, geralmente especificado no formato baseado no POSIX
1003.1:
<idioma>[_<território>[.<conjunto-de-caracteres>[,<versão>]]]
Se a página desejada estiver disponível em sua
localidade, ela será exibida em vez da página
padrão (geralmente, inglês americano).
Suporte a catálogos internacionais de mensagens
também é disponibilizado por este pacote e pode ser ativado da
mesma forma, novamente, se disponível. Se você descobrir que
as páginas de manual e catálogos de mensagens fornecidos com
este pacote não estejam disponíveis em seu idioma nativo e
gostaria de fornecê-los, por favor contate o mantenedor que
estará coordenando tal atividade.
Para informações a respeito de outros recursos e
extensões disponíveis com este paginador de manual, por favor
leia os documentos fornecidos com o pacote.
man vai pesquisar pelas páginas de manual desejadas
dentro dos caches de banco de dados index. Se a opção
-u for fornecida, uma verificação de
consistência do cache é realizada para assegurar de que os
bancos de dados reflitam precisamente o sistema de arquivos. Se essa
opção sempre for fornecida, geralmente não é
necessário executar mandb após os caches terem sido
inicialmente criados, a menos que um cache tenha se corrompido.
Porém, a verificação de consistência do cache
pode ser lenta em sistemas com muitas páginas de manual instaladas,
então ela não é executada por padrão, e
administradores de sistema podem preferir executar mandb toda semana
ou mais para manter os caches de banco de dados atualizados. Para se evitar
problemas causados por caches não atualizados, man
voltará para busca por arquivos se uma procura no cache falhar,
exatamente como faria se não houvesse cache presente.
Uma vez que uma página de manual tenha sido localizada, uma
verificação é realizada para descobrir se um arquivo
"cat" relativo pré-formatado já existe e é
mais novo que o arquivo nroff. Se ele existe e é mais novo, esse
arquivo pré-formatado (geralmente) é descomprimido e,
então, exigido usando um paginador. O paginador pode ser especificado
de várias formas ou senão um padrão é usado
(veja a opção -P para detalhes). Se nenhum cat for
localizado ou é mais antigo que o arquivo nroff, o nroff é
filtrado por meio de vários programas e é mostrado
imediatamente.
Se um arquivo cat puder ser produzido (um diretório cat
relativo existe e possui permissões apropriadas), man vai
comprimir e armazenar o arquivo cat em plano de fundo.
Os filtros são decifrados por várias formas.
Primeiramente, a opção de linha de comando -p ou a
variável de ambiente $MANROFFSEQ é interrogada. Se
-p não foi usada e a variável de ambiente não
foi definida, a linha inicial do arquivo nroff é analisada para um
texto de pré-processador. Para conter um texto válido de
pré-processador, a primeira linha deve se parecer com
'\" <texto>
onde texto pode ser qualquer combinação de
letras descritas pela opção -p abaixo.
Se nenhum dos métodos acima fornece qualquer
informação de filtro, uma definição
padrão é usada.
Um fluxo de formatação é formado a partir dos
filtros e o formatador primário (nroff ou
[tg]roff com -t) é executado. Alternativamente,
se um programa executável mandb_nfmt (ou mandb_tfmt com
-t) existir na árvore raiz do man, ele é executado.
É passado o arquivo-fonte do manual, o texto de
pré-processador e, opcionalmente, o dispositivo especificado com
-T ou -E como argumentos.
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.
- -C arquivo, --config-file=arquivo
- Use 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 é redefinir aquelas opções que
podem ter sido definidas no $MANOPT. Quaisquer opções
que segue -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.
- -f, --whatis
- Equivalente a whatis. Exibe uma descrição curta da
página de manual, se disponível. Veja whatis(1) para
detalhes.
- -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 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.
- -w, --where,
--path, --location
- Não exatamente exibe as páginas de manual, mas não
imprime as localizações dos arquivos-fonte nroff que seria
formatadas.
- -W, --where-cat,
--location-cat
- Não exatamente exibe as páginas de manual, mas não
imprime as localizações dos arquivos cat que seriam
exibidos. Se -w e -W forem ambos especificados, imprime ambos separados
por um espaço.
- -c, --catman
- Essa opção não é para uso geral e deveria 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.
- -L localidade, --locale=localidade
- man geralmente vai determinar sua localidade atual por uma chamada
à função C setlocale(3), a qual pergunta a
várias variáveis de ambiente, possibilitando incluir
$LC_MESSAGES e $LANG. Para temporariamente substituir o
valor determinado, use essa opção para fornecer uma
localidade diretamente para man. Note que isso não
surtirá efeito até que a pesquisa por páginas seja
iniciada. Saída como a mensagem de ajuda sempre será exibida
na localidade inicialmente determinada.
-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.
O sistema especificado pode ser uma
combinação de nomes de sistemas operacionais delimitados por
vírgula. Para incluir uma pesquisa às páginas de manual
do sistema operacional nativo, inclua man como nome do sistema no
texto do argumento. Essa opção vai sobrescrever a
variável de ambiente $SYSTEM.
- -M caminho, --manpath=caminho
- Especifica um caminho man a ser usado. Por padrão, man usa
código derivado de manpath para determinar o caminho a ser
pesquisado. Essa opção sobrescreve a variável de
ambiente $MANPATH e causa a opção -m a ser
ignorada.
O caminho especificado como um caminho man deve ser a raiz de
uma hierarquia estruturada de página de manual para as
seções conforme descrito no manual de man-db (sob
"The manual page system"). Para visualizar páginas de
manual fora de tais hierarquias, veja a opção
-l.
- -S lista, -s lista, --sections=lista
- Lista é uma lista separada por caractere de vírgula ou de
dois pontos com seções de manual de "ordem
específica" para pesquisa. Essa opção
sobrescreve a variável de ambiente $MANSECT. (A alternativa
-s é para compatibilidade com System V.)
- -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 realize uma
verificação de consistência a "nível de
inode" em seus caches de banco de dados para garantir que eles sejam
uma representação fiel do sistema de arquivos. Ele apenas
terá um efeito útil se man estiver instalado com o
bit de setuid definido.
- --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:
$ man -aw git diff
/usr/share/man/man1/git-diff.1.gz
Para desabilitar esse 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
- -P paginador, --pager=paginador
- Especifica qual paginador de saída deve ser usado. Por
padrão, man usa pager, usando subsidiariamente o
cat se o pager for localizado ou for um executável.
Essa opção sobrescreve a variável de ambiente
$MANPAGER, a qual, por sua vez, sobrescreve a variável de
ambiente $PAGER. Ela não é usada em conjunto com
-f ou -k.
Esse valor pode ser um único nome de comando ou um
comando com argumentos, e pode usar barra invertida, aspas simples ou
aspas duplas, como no shell. Ele não pode usar "pipes"
para conectar múltiplos comandos; se você precisar disso,
use um script "wrapper", que pode levar o arquivo e exibir
como um argumento ou na entrada padrão.
- -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
como
Manual
pagel nome(seção) line x
sendo que nome denota o nome da página de
manual, seção denota a seção que foi
localizada sob a qual foi localizada e x é o número
da linha atual. Isso é alcançado usando a variável
de ambiente $LESS.
Fornecer -r com um texto sobrescreverá esse
padrão. O texto pode conter $MAN_PN que será
expandido para o nome da página manual atual e o nome de sua
seção envolto por "(" e ")". O texto
usado para produzir o padrão poderia se expressado como
\ Manual\ page\ \$MAN_PN\ ?ltline\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(press h for help or q to quit)
Ele é quebrado aqui em três linhas apenas para
melhor legibilidade. Para seu significado, veja a página de
manual do less(1). O texto do prompt é primeiro avaliado
pelo shell. Todas as ocorrências de aspa dupla, acento grave e
barra invertida no prompt devem ser escapadas por uma barra invertida. O
texto do prompt pode terminar em um $ escapado, o qual pode ser seguido
por outras opções para o less. Por padrão
man define as opções -ix8.
A variável de ambiente $MANLESS descrita abaixo
pode ser usada para definir um texto padrão de prompt se nenhuma
for fornecida na linha de comando.
- -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.
| Descrição |
Octal |
latin1 |
ascii |
| hífen de continuação |
255 |
‐ |
- |
| ponto lista (ponto no meio) |
267 |
• |
o |
| acento agudo |
264 |
´ |
' |
| sinal de multiplicação |
327 |
× |
x |
Se a coluna em latin1 é exibida corretamente,
seu terminal pode estar configurado para caracteres latin1 e essa
opção não é necessária. Se as colunas
latin1 e ascii são idênticas, você
está lendo essa página usando essa opção ou
man não formatou essa página usando uma
descrição de dispositivo latin1. Se a coluna
latin1 estiver faltando ou corrompida, você pode precisar
ver as páginas de manual com essa opção.
Essa opção é ignorada ao usar as
opções -t, -H, -T ou -Z e pode
ser inútil para nroff que não seja do
GNU.
- -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.
Se você está escrevendo uma página de
manual e só deseja evitar que nroff hifenize uma palavra
em um ponto inapropriado, não use essa opção; em
vez disso, 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 começo de uma palavra para evitar que ela seja
hifenizada.
- --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.
Se você está escrevendo uma página de
manual e só deseja evitar que nroff justifique certos
parágrafos, não use essa opção; em vez
disso, consulte a documentação do nroff. Por
exemplo, você pode usar as requisições
".na", ".nf", ".fi" e ".ad" para
temporariamente desabilitar ajuste de preenchimento.
- -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.
- -?, --help
- Imprime uma mensagem de ajuda e sai.
- --usage
- Imprime uma mensagem curta e sai.
- -V, --version
- Exibe informação da versão.
- 0
- Execução com sucesso do programa.
- 1
- Erro de uso, de sintaxe ou no 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, palavras-chaves ou arquivos não
existem ou não correspondeu.
- MANPATH
- Se $MANPATH estiver definido, seu valor é usado como o
caminho a ser pesquisado por páginas de manual.
- MANROFFOPT
- O conteúdo de $MANROFFOPT é adicionado à linha
de comando toda vez em que man invoca o formatador (nroff,
troff ou groff).
- 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.
- 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.
Esse valor pode ser um único nome de comando ou um
comando com argumentos, e pode usar barra invertida, aspas simples ou
aspas duplas, como no shell. Ele não pode usar "pipes"
para conectar múltiplos comandos; se você precisar disso,
use um script "wrapper", que pode levar o arquivo e exibir
como um argumento ou na entrada padrão.
- 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.
- SYSTEM
- Se $SYSTEM estiver definido, ele surte o mesmo efeito que se fosse
especificado como um argumento da opção -m.
- MANOPT
- Se $MANOPT estiver definido, ele será analisado antes da
linha de comando do man e é esperado que tenha um formato
similar. Como todas as outras variáveis de ambiente
específicas do man podem ser expressadas como
opções de linha de comando e, portanto, são
candidatos de serem incluídos em $MANOPT, é esperado
que elas se tornem obsoletas. NOTA: Todos os espaços deveriam ser
interpretados como parte de um argumento da opção tem que
ser escapados.
- 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, um 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.
- /etc/manpath.config
- O arquivo de configuração do man-db.
- /usr/share/man
- Uma hierarquia global de páginas de manual.
- /usr/share/man/index.(bt|db|dir|pag)
- Um cache global de banco de dados index tradicional.
- /var/cache/man/index.(bt|db|dir|pag)
- Um cache global de banco de dados index compatível com
FHS.
apropos(1), groff(1), less(1),
manpath(1), nroff(1), troff(1), whatis(1),
zsoelim(1), setlocale(3), manpath(5), ascii(7),
latin1(7), man(7), catman(8), mandb(8), o manual
do pacote man-db, FSSTND
1990, 1991 – Originalmente escrito por John W. Eaton
(jwe@che.utexas.edu).
23 de dezembro de 1992: Rik Faith (faith@cs.unc.edu) aplicou
correções de erros fornecidos por Willem Kasdorp
(wkasdo@nikhefk.nikef.nl).
30 de abril de 1994 – 23 de fevereiro de 2000: Wilf.
(G.Wilford@ee.surrey.ac.uk) desenvolveu e manteve este pacote com ajuda de
algumas pessoas dedicadas.
30 de outubro de 1996 – 30 de março de 2001:
Fabrizio Polacco <fpolacco@debian.org> manteve e aprimorou este pacote
para o projeto Debian, com a ajuda de toda a comunidade.
31 de março de 2001 – atualmente: Colin Watson
<cjwatson@debian.org> agora está desenvolvendo e mantendo
man-db.