Opções gerais¶

-C ficheiro, --config-file=ficheiro

usa este ficheiro do utilizador em vez do predefinido de ~/.manpath.

-d, --debug

imprime informação de depuração.

-D, --default

Esta opção é normalmente emitida como a primeira opção e repõe o comportamento de man na predefinição. A sua finalidade é repor as opções que possam ter sido definidas em $MANOPT. Quaisquer opções a seguir a -D terão o seu efeito habitual.

--warnings[=avisos]

Activa os avisos de groff. Pode ser usado para realizar testes de sanidade no texto fonte das páginas do manual. warnings é uma lista de nomes de aviso, separados por vírgulas; se não for indicada, a predefinição é "mac". Veja “Avisos” em info groff para uma lista de nomes de avisos disponíveis.

Modos principais de operação¶

-f, --whatis

Equivalente a whatis. Mostra uma breve descrição da página do manual, se disponível. Veja whatis(1) para detalhes.

-k, --apropos

Equivalente a apropos. Procura nas descrições curtas das páginas do manual por palavras-chave e mostra as correspondências. Veja apropos(1) para detalhes.

-K, --global-apropos

Procura texto em todas as páginas do manual. Esta é uma procura brutal e provavelmente levará algum tempo; Se puder, especifique uma secção para reduzir o número de páginas a procurar. Os termos de procura podem ser cadeias simples (predefinição) ou expressões regulares, se a opção --regex for usada.

Note que isto procura as fontes das páginas do manual, não o texto produzido, pelo que pode incluir falsos positivos devido a comentários nas fontes. Procurar no texto formatado, seria muito mais lento.

-l, --local-file

Activa o modo "local". Formata e mostra ficheiros locais do manual, em vez de procurar na colecção de manuais do sistema. Cada argumento de página do manual será interpretado como um ficheiro-fonte nroff no formato correcto. Nenhum ficheiro cat é produzido. Se '-' for um dos argumentos, a entrada será lida de stdin. Quando esta opção não é usada e o manual não encontra a página necessária, antes de mostrar a mensagem de erro, tenta agir como se a opção fosse fornecida, usando o nome como nome de ficheiro e procurando uma correspondência exacta.

-w, --where, --path, --location

Não mostra realmente a página do manual, mas imprime a localização do ficheiro fonte nroff que seria formatado. Se -a for também usada, imprime as localizações de todos os ficheiros fonte que cumprem o critério de procura.

-W, --where-cat, --location-cat

Não mostra realmente a página do manual, mas imprime a localização do ficheiro cat pré-formatado que seria mostrado. Se -a for também usada, imprime as localizações de todos os ficheiros cat pré-formatados que cumprem o critério de procura.

Se -w e -W forem ambas usadas, imprime o ficheiro-fonte e o ficheiro cat separados por um espaço. Se forem usadas -w, -W e -a, faz isto para todas as correspondências possíveis.

-c, --catman

Esta opção não é para uso geral e só deve ser usada pelo programa catman.

-R codificação, --recode=codificação

Em vez de formatar a página do manual da maneira usual, envia a sua fonte convertida para a codificação especificada. Se já conhece a codificação do ficheiro fonte, também pode usar manconv(1) directamente. No entanto, essa opção permite converter várias páginas do manual numa única codificação sem ter de declarar explicitamente a codificação de cada uma, desde que já tenham sido instaladas numa estrutura semelhante a uma hierarquia de página do manual.

Considere usar antes man-recode(1) para converter múltiplas páginas do manual, dado que tem um ambiente desenhado para conversão em lote e, como tal, pode ser bastante mais rápido.

Encontrar páginas do manual¶

-L idioma, --locale=idioma

O man normalmente determinará sua localidade actual por uma chamada à função C setlocale(3), que interroga várias variáveis de ambiente, possivelmente incluindo $LC_MESSAGES e $LANG. Para sobrepor temporariamente o valor determinado, use esta opção para fornecer uma cadeia idioma directamente a man. Note que isto não terá efeito até que a procura por páginas realmente comece. Saídas como a mensagem de ajuda serão sempre mostradas no idioma inicialmente determinado.

-m sistema[,...], --systems=sistema[,...]

If this system has access to other operating systems' manual pages, they can be accessed using this option. To search for a manual page from NewOS's manual page collection, use the option -m NewOS.

O sistema especificado pode ser uma combinação de nomes de sistemas operativos, separados por vírgulas. Para incluir uma procura de páginas do manual do sistema operativo nativo, inclua o nome do sistema man na cadeia de argumentos. Esta opção sobrepõe-se à variável de ambiente $SYSTEM.

-M caminho, --manpath=caminho

Especifica um caminho de manual alternativo. Por predefinição, man usa código derivado de manpath para determinar o caminho a procurar. Esta,opção sobrepõe-se à variável de ambiente $MANPATH e faz com que a opção -m seja ignorada.

Um caminho especificado como sendo caminho do manual,tem de ser a raiz de uma hierarquia de páginas do manual estruturada em secções, tal como descrito no manual do man-db (sob "O sistema de páginas do manual"). Para ver páginas do manual fora desta hierarquia, veja a opção -l.

-S lista, -s lista, --sections=lista

A lista é uma lista de secções separada por dois-pontos ou vírgulas, usada para determinar quais as secções do manual a procurar e em que ordem. Esta opção sobrepõe-se à variável de ambiente $MANSECT. A sintaxe -s é para compatibilidade com System V.

-e sub-extensão, --extension=sub-extensão

Alguns sistemas incorporam grandes pacotes de páginas do manual, tais como as que acompanham o pacote Tcl, na hierarquia principal das páginas do manual. Para contornar o problema de ter duas página de manual com o mesmo nome,, tais como exit(3), as páginas Tcl foram todas habitualmente atribuídas à secção l. Como isto era infeliz, é agora possível pôr as páginas na secção correcta e atribuir-lhes uma "extensão" específica, neste caso, exit(3tcl). Sob operação normal, man mostrará exit(3) preferencialmente a exit(3tcl). Para negociar esta situação e evitar ter de saber qual a secção em que está o que necessita, é agora possível dar a man uma cadeia sub-extensão indicando a que pacote a página tem de pertencer. Usando o exemplo acima, indicando a opção -e tcl a man restringe a procura a páginas com uma extensão *tcl.

-i, --ignore-case

Ignora maiúsculas ao procurar páginas do manual. É a predefinição.

-I, --match-case

Procura páginas do manual diferenciando maiúsculas.

--regex

Mostra todas as páginas com qualquer parte ou dos seus nomes ou das suas descrições correspondentes a cada argumento de página como expressão regular, como com apropos(1). Como não há habitualmente forma de escolher a "melhor" página ao procurar uma expressão regular, esta opção implica -a.

--wildcard

Mostra todas as páginas com qualquer parte ou dos seus nomes ou das suas descrições correspondentes a cada argumento page usando caracteres universais, como com apropos(1) -wildcard. O argumento page tem de corresponder ao nome ou descrição completos ou corresponder aos limites de palavras na descrição. Como não há habitualmente forma de escolher a "melhor" página ao procurar um carácter universal, esta opção implica -a.

--names-only

Se a opção --regex ou --wildcard forem usadas, compara só nomes de página, não descrições, como com whatis(1). Senão, não tem efeito.

-a, --all

Por predefinição, man sai após mostrar a página de manual mais adequada que encontrar. Usar esta opção força man a mostrar todas as páginas do manual com nomes que cumpram o critério de procura.

-u, --update

Esta opção faz com que man actualize as caches da sua base de dados de páginas do manual instaladas. Isto só é necessário em raras ocasiões e é normalmente melhor executar mandb(8).

--no-subpages

Por predefinição, man tentará interpretar pares de nomes de páginas do manual dados na linha de comandos como equivalentes a um único nome de página do manual contendo um hífen ou um sublinhado. Isto suporta o padrão comum de programas que implementam vários sub-comandos, permitindo que eles forneçam páginas de manual para cada um que possa ser acedido usando uma sintaxe semelhante à que seria usada para chamar os próprios sub-comandos. Por exemplo:

  $ man -aw git diff
  /usr/share/man/man1/git-diff.1.gz

Para desactivar 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

Controlar saída formatada¶

-P paginador, --pager=paginador

Especifica o paginador de saída a usar. Por predefinição, man usa pager, caindo em cat se o pager não for encontrado ou não for executável. Esta opção sobrepõe-se à variável de ambiente $MANPAGER, que, por sua vez, se sobrepõe à variável de ambiente $PAGER. Não é usada em conjunto com -f ou -k.

O valor pode ser um simples nome de comando ou um comando com argumentos e pode usar citações de shell (barras invertidas, aspas simples ou aspas duplas). Não pode usar túneis para ligar vários comandos; se for tal preciso, use um script, o que pode levar o ficheiro a ser visto como argumento ou na saída padrão.

-r prompt, --prompt=prompt

Se for usada uma versão recente do less como paginador, o man tentará definir o seu prompt e algumas opções sensíveis. O prompt predefinido parece-se com

Página do manual nome(sec) linha x

onde nome denota o nome da página do manual, sec denota a secção onde foi encontrada e x o número de linha actual. Isto consegue-se usando a variável de ambiente $LESS.

Fornecer -r com uma cadeia sobrepõe esta predefinição. A cadeia pode conter o texto $MAN_PN, que será expandido para o nome da página de manual actual e seu nome de secção, entre "(" e ")". A cadeia usada para produzir a predefinição pode ser expressa como

\ Página\ do\ manual\ \$MAN_PN\ ?ltlinha\ %lt?L/%L.:
byte\ %bB?s/%s..?\ (END):?pB\ %pB\\%..
(prima h para ajuda ou q para sair)

Está dividida em três linhas para melhorar a legibilidade. Para ver o seu significado, veja a página do less(1). A cadeia do prompt é primeiro avaliada pela shell. Todas as aspas e barras invertidas no prompt têm de ser escapadas com uma barra invertida precedente. A cadeia pode terminar num $ escapadoque pode ser seguido de mais opções do less. Por predefinição, man define as opções -ix8

A variável de ambiente $MANLESS descrita abaixo pode ser usada para definir uma cadeia de prompt predefinida, se nenhuma for indicada na linha de comandos.

-7, --ascii

Ao ver uma página do manual pura ascii(7) num terminal de 7 bitou num emulador de terminal, alguns caracteres podem não se ver corectamente ao usar a descrição de dispositivo latin1(7) com GNU nroff. Esta opção permite que páginas do manual puras ascii sejam mostradas em ascii com o dispositivo latin1. Não traduzirá nenhum texto latin1. A tabela seguinte mostra as traduções realizadas: algumas partes só poderão ser vistas adequadamente ao usar o dispositivo latin1(7) do GNU nroff.

Descrição	Octal	latin1	ascii
hífen de continuação	255	‐	-
lista (ponto central)	267	•	o
acento agudo	264	´	'
sinal de multiplicação	327	×	x

Se a coluna latin1 é mostrada correctamente, o seu terminal pode estar definido para caracteres latin1 e esta opção não é necessária. se as colunas latin1 e ascii são idênticas, está a ler esta página com esta opção ou o man não formatou esta página usando a descrição do dispositivo latin1 Se a coluna latin1 está em flata ou corrompida, poderá ter de ver 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 um nroff diferente do GNU nroffs.

-E codificação, --encoding=codificação

Gera saída para uma codificação de caracteres diferente da predefinida. Para compatibilidade, a codificação pode ser um dispositivo nroff tal como ascii, latin1, ou utf8, assim como uma verdadeira codificação de caracteres, como UTF-8.

--no-hyphenation, --nh

Normalmente, o nroff hifeniza o texto nas quebras de linha, mesmo com palavras que não contêm hífenes, se for necessário para dispor palavras numa linha sem espaço excessivo. Esta opção desactiva a hifenização automática, pelo que as palavras só serão divididas se já contiverem hífenes.

Se está a escrever uma página do manual e simplesmente quer impedir o nroff de hifenizar erradamente uma palavra, não use esta opção, consulte antes a documentação do nroff; e.g., pode pôr "\%" dentro de uma palavra para indicar que ela pode ser hifenizada nesse ponto, ou pôr "\%" no início da palavra para impedir que seja hifenizada.

--no-justification, --nj

Normalmente, o nroff alinha o texto a ambas as margens. Esta opção desactiva este alinhamento, alinhando o texto só à esquerda.

Se está a escrever uma página do manual e simplesmente quer impedir o nroff de alinhar assim determinados parágrafos, não use esta opção, consulte antes a documentação do nroff; e.g., pode usar os pedidos ".na", ".nf", ".fi" e ".ad" para desactivar temporariamente o ajuste e preenchimento.

-p cadeia, --preprocessor=cadeia

Especifica a sequência de pré-processadores a executar antes de nroff ou troff/groff. Nem todas as instalações terão um conjunto completo de pré-processadores. Alguns deles e as letras usadas para os designar são: eqn (e), grap (g), pic (p), tbl (t), vgrind (v), refer (r). Esta opção sobrepõe-se à variável de ambiente $MANROFFSEQ. zsoelim é sempre executado como primeiro pré-processador.

-t, --troff

Usa groff -mandoc para formatar a página do manual para a saída padrão. Esta opção não é requerida em conjunto com -H, -T, ou -Z.

-T[dispositivo], --troff-device[=dispositivo]

Esta opção é usada para alterar a saída de groff (ou possivelmente troff) para a adequar a outro dispositivo que não o predefinido. Implica -t. Exemplos (dados com Groff-1.17) incluem dvi, latin1, ps, utf8, X75 e X100.

-H[navegador], --html[=navegador]

Esta opção faz com que o groff produza saída HTML e mostra essa saída num navegador web. A escolha do navegador é determinada pelo argumento opcional navegador, se for fornecido pela variável de ambiente $BROWSER ou por valor predefinido compilado em tempo de execução, se aquela não estiver definida (normalmente o lynx). Esta opção implica -t e só funciona com o GNU troff.

-X[dpi], --gxditview[=dpi]

Esta opção mostra a saída do groff numa janela gráfica usando o programa gxditview. Os dpi (dots per inch) podem ser 75, 75-12, 100, ou 100-12, predefinidos para 75; as variantes -12 usam uma letra de 12-pontos. Esta opção implica -T com os dispositivos X75, X75-12, X100, ou X100-12, respectivamente.

-Z, --ditroff

O groff executará o troff e usará o pós-processador apropriado para produzir uma saída adequada ao dispositivo escolhido. Se o groff -mandoc for o groff, esta opção é passada ao groff e vai suprimir o uso de um pós-processador. Implica -t.

Obter ajuda¶

-?, --help

mostra uma mensagem de ajuda e sai.

--usage

mostra uma mensagem curta de uso e sai.

-V, --version

mostra informação da versão.