Comando man do Linux: Como Ler e Pesquisar Páginas de Manual

No Linux, usar o comando man permite visualizar as páginas de manual de comandos instalados e funções do sistema. Por exemplo, executar man ls permite ler o uso e as opções de ls, e, geralmente, você pode pressionar q para sair da tela.

Abrindo uma página de manual

man significa manual e ajuda a encontrar e exibir páginas de manual instaladas no sistema. Além de programas, existem páginas relacionadas a formatos de arquivos de configuração, chamadas de sistema e funções de biblioteca. Por exemplo, o seguinte comando abre o manual para ls.

man ls

Os manuais geralmente incluem o nome e uma breve descrição em NAME, o formato do comando em SYNOPSIS e funções e opções em DESCRIPTION e OPTIONS. O conteúdo e os títulos das seções podem variar para cada programa. Ler o manual não executa os comandos descritos nem altera as configurações do sistema.

Navegação na Tela e Pesquisa

man usa um programa de paginação para exibir conteúdos longos uma página de cada vez. As instruções abaixo são baseadas no less, que é comumente usado. Se um programa diferente estiver configurado, as teclas podem variar.

• Setas para baixo e para cima: Mover uma linha por vez.
• Espaço ou Page Down: Mover uma tela para baixo. b ou Page Up move uma tela para cima.
• / seguido de um termo de busca e Enter: Buscar para frente a partir da posição atual. n move para o próximo resultado na mesma direção, N move para o resultado na direção oposta.
• g e G: Move para o início e o fim do documento, respectivamente. Sensível a maiúsculas e minúsculas.
• h e q: h abre a ajuda da operação, e q sai da tela de ajuda ou do manual.

Por exemplo, se você digitar /sort na tela man ls e pressionar Enter, ele procura adiante por essa expressão. O termo de pesquisa é inserido dentro da tela do manual, não como um comando do shell. Para teclas detalhadas e regras de pesquisa, consulte o manual do less.

Selecionando seções do manual com o mesmo nome

Os manuais são divididos em seções numeradas de acordo com os tópicos. Se um nome de página existir em várias seções, você pode especificar um número para abrir a página desejada. Por exemplo, passwd é usado tanto para comandos relacionados à senha do usuário quanto para os nomes dos arquivos de informações da conta.

man 1 passwd
man 5 passwd

O primeiro comando encontra o manual para o comando, e o segundo encontra o manual para o formato de arquivo. A página correspondente deve estar instalada no sistema para ser exibida. Se o número for omitido, a página que for encontrada primeiro de acordo com a ordem de pesquisa configurada será aberta.

• 1: Comandos gerais e programas executáveis
• 2: Chamadas de sistema
• 3: Funções da biblioteca
• 5: Formatos de arquivo e regras
• 8: Comandos de Gerenciamento do Sistema

A notação passwd(5) indica o nome da página e o número da seção. As seções completas e os métodos de pesquisa podem ser encontrados no manual man.

Encontrando uma página por nome ou tópico

Se você não conhece o nome exato do comando, você pode pesquisar pelo nome do manual e uma breve descrição usando man -k. O exemplo a seguir encontra itens relacionados a password.

man -k password

Os resultados exibirão o nome da página, número da seção e uma breve descrição. Os termos de pesquisa podem ser interpretados como expressões regulares, e esta pesquisa não cobre todo o texto do manual. Os itens encontrados podem ser abertos como man 5 passwd usando o nome e o número da seção.

Se você já conhece o nome e só quer ver a breve descrição, execute-o da seguinte forma.

man -f ls

man -k e man -f usam o índice do manual, portanto os resultados podem variar dependendo dos documentos instalados ou do status do índice.

Quando o manual não pode ser encontrado

• Página não encontrada: Verifique a ortografia do nome e confirme se o programa e o pacote de documentos associado estão instalados. O manual pode estar ausente em um ambiente de instalação mínima.
• Comandos incorporados: Comandos incorporados ao shell, como cd, podem não ter páginas separadas. No Bash, você pode verificar help cd ou man bash.
• Nenhum resultado de pesquisa: Certifique-se de que a documentação está instalada e que o índice do manual está preparado. Para regenerar o índice e gerenciar permissões, siga a documentação da distribuição.
• Idioma diferente: Dependendo da tradução instalada e das configurações de localidade, pode aparecer em inglês. Verifique as opções e exemplos com base na documentação da versão do software instalada.

Se você precisar de uma ajuda simples fornecida pelo próprio comando, também pode verificar a opção --help desse programa. O uso do próprio man pode ser visto em man man.