No ambiente Linux, saber como obter ajuda é essencial para produtividade. Os comandos e utilitários possuem documentação embutida que pode ser acessada de várias formas, desde resumos rápidos até manuais completos. Nesta aula, você aprenderá a usar as principais ferramentas de ajuda: man, --help, apropos, whatis e info.

Dominar esses recursos permite que você resolva dúvidas sem sair do terminal, consultando sintaxes, opções e exemplos diretamente. Vamos explorar cada um deles com exemplos práticos.

man

O comando man (manual) é a principal fonte de documentação no Linux. Ele exibe páginas de manual detalhadas para comandos, funções de biblioteca, arquivos de configuração e muito mais. As páginas são organizadas em seções numeradas (1 a 8), como comandos do usuário (1), chamadas de sistema (2) e administração (3).

Para usar, digite man seguido do nome do comando. Por exemplo, man ls mostra o manual do comando ls. Você pode navegar com as setas, Page Up/Page Down, e sair com q. A página inclui nome, sinopse, descrição, opções e exemplos.

man ls

Para buscar uma palavra dentro da página, pressione / e digite o termo. Use n para próximo resultado e N para anterior. Você também pode especificar a seção: man 5 crontab para ver a página da seção 5 sobre o formato do arquivo crontab.

--help

A opção --help (ou -h) é um resumo rápido disponível na maioria dos comandos. Ela exibe uma lista das opções e sintaxe básica, sem detalhes extensos. É útil para uma consulta rápida quando você já conhece o comando mas esqueceu uma opção.

Exemplo: ls --help mostra todas as opções do ls de forma concisa. Diferente do man, não requer navegação; o texto é impresso diretamente no terminal.

ls --help

Alguns comandos usam -h em vez de --help, como tar -h. Verifique a documentação ou tente ambos. Essa opção é ideal para lembretes rápidos.

apropos e whatis

Os comandos apropos e whatis ajudam a encontrar páginas de manual relevantes quando você não sabe o nome exato do comando.

whatis exibe uma breve descrição de um comando específico. Por exemplo, whatis ls retorna algo como "ls (1) - list directory contents". Ele consulta o banco de dados das páginas de manual.

whatis ls

apropos pesquisa nas descrições das páginas de manual por uma palavra-chave. Por exemplo, apropos copy lista todos os comandos relacionados a cópia, como cp, dd, rsync. Use apropos -a para exigir que todas as palavras-chave estejam na descrição.

apropos copy

Esses comandos são úteis quando você não lembra o nome do comando ou quer explorar ferramentas relacionadas a uma tarefa.

info

O comando info é uma alternativa ao man para documentação mais estruturada e hipertextual, especialmente usada pelo projeto GNU. As páginas info podem conter links, menus e nós, permitindo navegação não linear.

Para abrir, digite info seguido do comando. Exemplo: info ls. A navegação é diferente: use Tab para pular entre links, Enter para segui-los, u para subir, n e p para próximo/anterior. Saia com q.

info ls

Muitos comandos GNU têm páginas info mais completas que as man. Por exemplo, info bash fornece um manual extenso do Bash. Se a página info não existir, o comando info pode redirecionar para a página man.

Boas Práticas

  • Sempre comece com --help para uma visão rápida.
  • Use man para detalhes completos.
  • Utilize apropos para descobrir comandos relacionados a uma tarefa.
  • Prefira info para documentação GNU, pois é mais rica.
  • Mantenha o banco de dados de man atualizado com mandb (como root).

Referências

Exercícios

  1. Use o comando man para descobrir qual opção do comando ls lista arquivos em ordem de tamanho (do maior para o menor).

    ✓ Resposta: A opção é -S (ou --sort=size). No manual, procure por "sort" ou "size".

  2. Qual comando você usaria para obter uma descrição rápida do utilitário grep?

    ✓ Resposta: whatis grep ou grep --help.

  3. Use apropos para listar comandos relacionados a "compressão". Escreva o comando e um dos resultados.

    ✓ Resposta: Comando: apropos compress. Resultado possível: gzip (1) - compress or expand files.

  4. Navegue até a página info do Bash. Qual tecla você usa para seguir um link?

    ✓ Resposta: Enter ou Tab para selecionar e Enter para seguir.

  5. Explique a diferença entre man e info.

    ✓ Resposta: man exibe páginas de manual em formato tradicional, com navegação linear (setas, busca). info oferece documentação hipertextual com links e menus, permitindo navegação não linear. Muitos comandos GNU possuem páginas info mais detalhadas.