Obtendo ajuda
Esta aula ensina como obter ajuda e documentação no terminal Linux, cobrindo os comandos man, --help, apropos, whatis e info. O aluno aprenderá a navegar, pesquisar e entender manuais e páginas de ajuda de forma eficiente.
No ambiente Linux, saber onde e como buscar ajuda é essencial para qualquer desenvolvedor ou administrador de sistemas. Diferentemente de sistemas gráficos, o terminal oferece ferramentas poderosas de documentação que, quando dominadas, aceleram o aprendizado e a resolução de problemas. Nesta aula, exploraremos os principais comandos e recursos para obter ajuda: man, --help, apropos, whatis e info. Cada um tem seu propósito e contexto de uso, e saber combiná-los é uma habilidade fundamental.
man
O comando man (abreviação de manual) é a principal fonte de documentação no Linux. Ele exibe páginas de manual detalhadas sobre comandos, funções de sistema, arquivos de configuração e muito mais. As páginas são organizadas em seções numeradas (1 a 8), cada uma cobrindo um tipo específico de conteúdo: seção 1 para comandos do usuário, seção 2 para chamadas de sistema, seção 3 para funções de biblioteca C, seção 4 para dispositivos especiais, seção 5 para formatos de arquivo, seção 6 para jogos, seção 7 para miscelânea e seção 8 para comandos de administração. Para usar, basta digitar man <nome-do-comando>. Por exemplo, man ls exibe o manual do comando ls.
A navegação dentro de uma página man é feita com as teclas de seta, Page Up/Page Down, ou com j/k (como no Vim). Para sair, pressione q. Você também pode pesquisar texto com / seguido do termo e n para próximo resultado. O manual é aberto em um paginador (geralmente less), que oferece essas funcionalidades. Além disso, é possível especificar a seção: man 5 passwd mostra o formato do arquivo /etc/passwd, e não o comando passwd. Se o comando existir em várias seções, o man exibe a primeira encontrada; para ver todas, use man -a.
# Exemplo básico
man ls
# Abrir manual de uma seção específica
man 5 crontab
# Listar todas as páginas com nome 'passwd'
man -f passwd # equivalente a 'whatis passwd'
--help
A opção --help (ou -h em muitos comandos) fornece um resumo rápido de uso, geralmente exibindo a sintaxe, as opções principais e uma breve descrição. Diferente do man, que é detalhado e extenso, o --help é conciso e ideal para consultas rápidas. Muitos comandos aceitam --help ou -h, mas nem sempre ambos; é comum que -h tenha outro significado (ex.: head -h exibe ajuda, enquanto ls -h usa formato legível). Por isso, --help é mais padronizado. Exemplo: grep --help mostra um resumo das opções do grep. O --help geralmente exibe a saída no terminal e sai imediatamente, sem paginação.
# Exemplo com grep
grep --help
# Exemplo com tar (versão resumida)
tar --help | head -20
apropos e whatis
Os comandos apropos e whatis são ferramentas de busca no banco de dados das páginas de manual. whatis exibe uma descrição de uma linha para cada página de manual que corresponde exatamente ao nome fornecido. Já apropos busca por palavras-chave nos títulos e descrições das páginas, retornando todas as correspondências. Ambos são úteis quando você não sabe o nome exato do comando ou quer explorar comandos relacionados. Exemplo: whatis ls retorna "list directory contents". apropos editor lista todos os comandos relacionados a editores de texto. O banco de dados é atualizado periodicamente; se necessário, execute mandb (ou makewhatis em alguns sistemas) como root para reindexar.
# whatis: descrição exata
whatis cp
# apropos: busca por palavra-chave
apropos compress
# Exemplo de uso combinado
apropos "list files"
info
O comando info é um sistema de documentação baseado em hipertexto, mais rico que o man para alguns programas (como o GNU Coreutils). Ele organiza a documentação em nós (nodes) que podem ser navegados através de links. O info é especialmente útil para programas GNU, que muitas vezes possuem manuais extensos com exemplos e explicações detalhadas. Para abrir, use info <comando>. A navegação é diferente do man: use n (próximo), p (anterior), u (subir), l (voltar), e Tab para pular entre links. Para sair, q. Se o comando não tiver página info, o sistema redireciona para o man automaticamente. Exemplo: info ls exibe o manual info do ls, que costuma ser mais completo que a página man.
# Abrir info de um comando
info grep
# Navegar para um nó específico
info -n "Regular Expressions" grep
Boas práticas
Para otimizar seu aprendizado, comece com --help para uma visão geral rápida. Se precisar de detalhes, consulte o man. Se o comando for GNU e você quiser um tutorial mais aprofundado, prefira info. Use apropos quando não lembrar o nome exato do comando. Lembre-se de que nem todos os comandos têm página info; nesse caso, o info redireciona para o man. Além disso, você pode usar man -k como atalho para apropos. Dominar essas ferramentas torna você autossuficiente no terminal.
Referências
- man(1) — Linux manual page
- GNU Coreutils manual (info)
- apropos(1) — Linux man page
- whatis(1) — Linux man page
- GNU Info manual
- Man Page HOWTO (TLDP)
- Man page — ArchWiki
Exercícios
- Use o comando
manpara descobrir qual é a opção dolsque exibe o tamanho dos arquivos em formato humano (ex.: 1K, 234M). Em seguida, teste o comando. - Explique a diferença entre
mane--help. Dê um exemplo de situação em que cada um é mais adequado. - Usando
apropos, encontre comandos relacionados a "compressão" (compress). Liste pelo menos dois comandos que apareçam. - O que o comando
whatisfaz? Use-o para descobrir a descrição do comandotar. - Acesse a página info do comando
grepe navegue até a seção que explica expressões regulares. Qual é o nome do nó que você encontrou?
-h ou --human-readable. Execute ls -lh para ver os tamanhos legíveis.
man fornece documentação completa e detalhada, enquanto --help exibe um resumo rápido. Use --help para consultas rápidas (ex.: lembrar uma opção) e man para estudar o comando aprofundadamente.
apropos compress. Exemplos de saída: gzip (1) - compress or expand files, compress (1) - compress and expand data.
whatis tar retorna algo como "tar (1) - an archiving utility".
info grep e navegue até "Regular Expressions" (ou pressione m e digite "Regular Expressions"). O nó se chama "Regular Expressions".