comando do homem

Propósito

Exibe entradas manuais online.

Sintaxe

homem [ [ [ -c ] [ -t ] [ seção ] ] | [ -k | -f ] ] [ -F ] [ -m ] [ -Mcaminho ] [ -r ] [ -a ] title ...

Descrição

O comando man fornece informações de referência sobre tópicos, tais como comandos, subroutines e arquivos. O comando man fornece descrições de linha one-line de comandos especificados por nome. O comando man também fornece informações sobre todos os comandos cujas descrições contêm um conjunto de palavras-chave especificadas pelo usuário.

O comando man formata um conjunto especificado de páginas manuais. Se você especificar uma seção para o parâmetro section , o comando man procura na referida seção das páginas manuais para o título especificado pelo parâmetro título. O valor do parâmetro section pode ser um número de árabe de 1 até 8 ou uma letra.

As letras da seção são:

Item	Descrição
C	Especifica comandos (incluindo comandos de gerenciamento do sistema).
f	Especifica páginas manuais do tipo arquivo.
L	Especifica funções da biblioteca.
n	Especifica novo.
l	Especifica local.
o	Especifica antigo.
P	Especifica público.

Nota: Os especificadores de seção n, l, oe p não são válidos para leitura das bases de informações do hipertexto, que contêm a documentação do sistema operacional.

Os números da seção são:

Item	Descrição
1	Indica comandos do usuário e daemons.
3	Indica chamadas de sistema e serviços de kernel.
3	Indica subroutines.
4	Indica arquivos especiais, drivers de dispositivo e hardware.
5	Indica arquivos de configuração.
6	Indica jogos.
7	Indica comandos diversos.
8	Indica comandos administrativos e daemons.

Nota: A documentação do sistema operacional nos bancos de dados de informações de hipertexto é agrupada em três seções apenas: páginas manuais de comando (na seção 1, equivalente à seção C), páginas manuais subroutine (na seção 3, equivalente à seção L) e páginas manuais de arquivo (na seção 4, equivalente à seção F). Ao pesquisar por informações de hipertexto, especificando a seção 1, 6, 7 ou 8 será padrão para as páginas manuais de comandos, a seção 2 ou 3 será padrão para as páginas manuais da subroutine, e a seção 4 ou 5 será padrão para as páginas manuais do arquivo.

Se o parâmetro section for omitido, o comando man procura todas as seções do manual.

O caminho de pesquisa que o comando man usa é uma lista de diretórios separados por um: (colon) em que os subdiretórios manuais podem ser encontrados.

O comando man exibe as páginas manuais da seguinte forma:

O comando man procura os diretórios nroff (man?) sob o diretório /usr/share/man .
O comando man procura os diretórios de versão formatados (cat?) sob o diretório /usr/share/man . Se a versão formatada estiver disponível, e se ela tiver um tempo de modificação mais recente do que a fonte de comando nroff , o comando man exibe a versão formatada. Caso contrário, a página manual é formatada com o comando nroff e exibida. Se o usuário tiver permissão, a página manual formatada será depositada no local adequado, de modo que posteriormente as chamadas do comando man não formem a página novamente.
Nota: Não há nenhuma fonte nroff para as páginas manuais fornecidas. No entanto, você pode colocar a fonte nroff para páginas manuais nos diretórios man e o comando man pode localizar e processar a fonte nroff .
Se o comando man não encontrar uma página manual no diretório /usr/share/man/man ou /usr/share/man/cat , o comando man procura os caminhos especificados através da opção -M ou MANPATH ambiente variável para diretórios nroff (man?) e diretórios de versão formatados (cat?).
Se o comando homem não encontrar uma página manual no /usr/share/man/man ou /usr/share/man/cat ou o diretório homem / gato especificado pelo usuário, o comando homem lê a partir das bases de informações do hipertexto. As bases de informações do hipertexto residem na estrutura de diretórios /usr/share/man/info e contêm a documentação do sistema operacional. Ao ler a partir dos bancos de dados do hipertexto, o comando man não coloca nenhuma página manual na estrutura de diretórios /usr/share/man/cat . O comando man converte o arquivo HTML em um arquivo de texto formatado para se encaixar no display, e exibe a página manual usando o comando descrito pela variável de ambiente PAGER.
Se o comando man não encontrar uma página manual nas bases de informações de hipertexto que residam na estrutura de diretórios /usr/share/man/info , procura por base de informações de hipertexto especificada pelo usuário (através de -M ou MANPATH). A base de informações de hipertexto definida pelo usuário, deve seguir a seguinte estrutura de diretórios:
```
BasePath[/%{ L | l }]/DocLibraryname/Section/command_or_routine_or_filename.htm
```
Em que:
- %L representa a notação de linguagem ISO especificada usando o LC_MESSAGES, %l representa os primeiros 2 caracteres da notação de idioma ISO especificados usando o LC_MENSAGENS. Por exemplo, para LC_MESSAGES=en_US os documentos podem ser colocados em Path/en_US ou Path/en.
- DocLibraryname representa o nome da biblioteca de documentação.
- Section representa o nome da seção, que deve ser um dos seguintes:
  - cmds -Representa Seção de Comandos
  - libs -Reapresenta Seção de Biblioteca
  - files -Reapresenta Seção de Arquivos
Nota: Se a opção -m for especificada, então a busca por páginas manuais será feita apenas na ordem de caminhos especificados através de -M ou da variável de ambiente MANPATH.

Ao acessar os bancos de dados HTML, man procura a biblioteca do sistema operacional antes que ela renda para outras bibliotecas do LPP. Dentro dessas bibliotecas, ele processa informações na seguinte ordem:

Item	Descrição
cmds	Referência de Comandos
bibliotecas	Subroutines, Chamadas de Sistema
arquivos	Referência de Arquivos

Se a saída padrão for uma tty, o comando homem canos sua saída usando o comando mais com as bandeiras -s e -v . A sinalização -s elimina várias linhas em branco e pára depois de cada página na tela. A sinalização -v suprime a exibição de caracteres não imprimidos à tela. Para continuar rolando, pressione a barra de espaço. Para rolar um adicional de 11 linhas quando a saída parar, pressione a sequência de chaves Ctrl-D.

A variável de ambiente PAGER pode ser configurada para qualquer que seja o pager desejado. O valor padrão é o comando more . Para alterar o pager padrão, digite:

PAGER=Somepager
export PAGER

Por exemplo, se há páginas manuais customizadas que são formatadas com feeds de linha reversa ou fracionada, a variável de ambiente PAGER pode ser configurada como /usr/bin/pg para que os feeds de linha não sejam impressos como caracteres de controle. Este procedimento não é necessário para as páginas manuais.

Quando o comando man usa um banco de dados de hipertexto, ele pode recuperar vários artigos. Por exemplo,man openexibe vários artigos. O uso de SIGINT (Ctrl-C) sai do comando man completamente. Por outro lado,man open closeexibe também vários artigos mas o uso de SIGINT (Ctrl-C) faz com que man exiba as informações de comandos close em vez de sair. Usando o SIGINT (Ctrl-C) novamente sai o comando man completamente.

Ao especificar uma das rotinas da biblioteca do Sistema de Computação da Rede que contém um $ (sinal de dólar) em seu nome, digite a \ (backslash) precedendo os $.

Sinalizações

Item	Descrição
-a	Exibir todas as entradas correspondentes.
-C	Exibe as informações manuais usando o comando cat .
-f	Exibe entradas no banco de dados de palavras-chave relacionadas apenas ao nome de comando dado como parâmetro final. Você pode inserir mais de um nome de comando, cada um separado por um espaço. Use esta sinalização para procurar apenas artigos de comando. Para usar a sinalização -f , um usuário root deve ter digitado anteriormente `catman` `-w` para criar o arquivo /usr/share/man/whatis .
-F	Exibir apenas a primeira entrada correspondente.
-k	Exibe cada linha no banco de dados de palavra-chave que contém uma sequência de caracteres que correspondem ao título dado como parâmetro final. Você pode inserir mais de um título, cada um separado por um espaço. Para usar a sinalização -k , um usuário root deve ter digitado anteriormente `catman` `-w` para criar o arquivo /usr/share/man/whatis .
-m	Basta pesquisar nos caminhos especificados em MANPATH ou -M.
-M caminho	Altera o local padrão onde o comando man procura informações manuais. O caminho é uma lista de caminhos separados por dois pontos, onde podem ser utilizados os seguintes símbolos especiais: %D- Os caminhos padrão AIX® para páginas de manual. %L-Um local de diretório específico locale-specific correspondente à categoria LC_MENSAGENS do locale atual. %l-Um local de diretório específico locale-specific correspondente aos primeiros 2 caracteres da categoria LC_MENSAGENS da corrente.
-r	Pesquisa remotamente para as informações manuais. Se por qualquer motivo a pesquisa remota falhar, então man realiza uma busca local para a página do homem solicitada. Qualquer uma das condições a seguir pode fazer com que a busca remota falhe: A máquina remota não é alcançável. Há um problema na leitura do site URL. Um applet Java™ não é instalado ou ele não é encontrado no caminho de pesquisa do usuário, especificado na variável de ambiente PATH . Nota: A variável de ambiente DOCUMENT_SERVER_MACHINE_NAME deve ser definida com o nome da máquina do servidor de busca de documentação que o usuário deseja utilizar. Se a Documentação básica AIX não for compatível com a localidade do host, o comando man procurará a documentação para uma localidade alternativa. Se a busca for bem-sucedida, a página da documentação será exibida após a conversão para o locale do host local. Se o locale alternativo não for instalado no host local, o comando man falha ao exibir a página da documentação.
-t	Formata as informações manuais usando o comando troff . Esta sinalização é ignorada se a página manual for encontrada em uma base de informações de hipertexto.

Status de saída

Esse comando retorna os valores de saída a seguir:

Item	Descrição
0	Conclusão bem-sucedida.
>0	Ocorreu um erro.

Exemplos

Para exibir informações sobre o comando grep , digite o seguinte comando:
```
man grep
```
Para exibir informações sobre a rotina da biblioteca rpc_$register , digite o seguinte comando:
```
man rpc_\$register
```
Para exibir todas as entradas no banco de dados de palavra-chave /usr/share/man/whatis que contêm a string "mkdir", digite o seguinte comando:
```
man -k mkdir
```
A saída é equivalente ao comando apropos . Você recebe saída da sinalização -k apenas quando o banco de dados de palavras-chave /usr/share/man/whatis já existe.
Para exibir todas as entradas a partir do banco de dados de palavras-chave relacionadas aos comandos nroff e troff , digite o seguinte comando:
```
man -f nroff troff
```
A saída é equivalente ao comando whatis . Você recebe saída da sinalização -f apenas quando o banco de dados de palavras-chave /usr/share/man/whatis já existe.
Para exibir todos os ftp artigos relacionados ao comando no caminho /usr/share/man ou /usr/share/man/local , digite o seguinte comando:
```
man -M/usr/share/man:/usr/share/man/local ftp
```
Para exibir todas as entradas correspondentes, digite o seguinte comando:
```
man -a title
```
Para exibir apenas a primeira entrada correspondente, digite o seguinte comando:
```
man -F title
```
Para pesquisar apenas nos caminhos especificados em MANPATH ou -M, digite o seguinte comando:
```
man -m -M PATH title
```
Para pesquisar no PATH definido pelo usuário, digite o seguinte comando:
```
man -M PATH title
```

Arquivos

Item	Descrição
/usr/bin/man	Contém o comando man .
/usr/share/man	Estrutura de diretórios manuais padrão.
/usr/share/man/cat?/*	Diretório contendo páginas pré-formatadas.
/usr/share/man/whatis	Contém o banco de dados de palavra-chave.
/usr/share/man/man?/*	Diretório contendo páginas manuais de formato nroff .