Usando man, info e --help - Como Ler a Documentação Oficial

Usando man, info e --help - Como Ler a Documentação Oficial
Tempo de leitura: Cerca de 10 min Dificuldade: Introdução

O que você vai conseguir fazer

  • Escolher entre man, info e --help conforme a situação
  • Descobrir sozinho como usar um comando desconhecido

Pré-requisitos (leia estes primeiro)

O Que Você Vai Aprender

Lina: Toda vez que esqueço as opções de um comando, acabo pesquisando na web... Existe uma forma melhor?
Veterano Linny: O Linux tem ferramentas de documentação integradas! Aprenda --help, man e info e você poderá consultar quase qualquer coisa direto no terminalUm programa interativo que interpreta os comandos digitados e os executa..

Ao final deste artigo, você será capaz de:

  • Entender a diferença entre --help, man e info e quando usar cada um
  • Navegar em páginas man com atalhos de teclado e busca
  • Encontrar comandos por palavra-chave quando não lembrar o nome

Resumo rápido

  1. Verificação rápida de opções → command --help
  2. Referência completa → man command
  3. Não lembra o nome do comando → man -k palavra-chave

1. --help: O Jeito Mais Rápido

Conclusão: command --help funciona em quase qualquer comando e mostra as opções instantaneamente.

Lina: O que devo tentar primeiro?
Veterano Linny: Comece com --help. Quase todo comando o suporta e a saída aparece instantaneamente.

Uso

ls --help
Usage: ls [OPTION]... [FILE]...
List information about the FILEs (the current directory by default).

  -a, --all                  do not ignore entries starting with .
  -A, --almost-all           do not list implied . and ..
  -l                         use a long listing format
  ...(truncated)

Se a saída for longa demais para caber na tela, envie pelo less:

ls --help | less

Pressione q para sair.

Alguns comandos também aceitam -h como forma abreviada. Tente curl -h como exemplo.

Quando usar --help

Propriedade Detalhes
Velocidade Imediato
Quantidade Conciso (lista de opções)
Cobertura Quase todos os comandos
Ideal para Verificar nomes e sintaxe de opções

2. man: Páginas Completas do Manual

Conclusão: man command exibe o manual completo, navegado como o less com busca por /.

Lina: E se eu precisar de mais detalhes do que --help fornece?
Veterano Linny: É aí que você usa man — abreviação de manual. É a documentação oficial completa de cada comando.

Uso

man ls

Você navega nas páginas man com as mesmas teclas do less.

Atalhos de Teclado

Tecla Ação
Space / f Próxima página
b Página anterior
q Sair
/palavra Busca para frente (ex: /recursive)
n Próximo resultado da busca
N Resultado anterior da busca
g Ir para o início
G Ir para o final

O atalho / é o mais útil. Tente man chmod, depois digite /octal para ir direto à seção de permissões numéricas.

Estrutura de uma Página man

Cada página man segue o mesmo layout de seções:

Seção Conteúdo
NAME Nome do comando e descrição em uma linha
SYNOPSIS Sintaxe de uso
DESCRIPTION Explicação detalhada
OPTIONS Todas as opções disponíveis
EXAMPLES Exemplos de uso (quando incluídos)
SEE ALSO Comandos relacionados
Lina: Sempre vejo [OPTION]... e [FILE]... em SYNOPSIS, mas não sei bem o que significam os símbolos.
Veterano Linny: Colchetes [] significam que o argumento é opcional, e ... significa que você pode especificar múltiplos valores. Então ls [OPTION]... [FILE]... significa que você pode passar zero ou mais opções e zero ou mais arquivos.

Especificando Números de Seção

Alguns nomes têm entradas para um comando e para um arquivo de configuração. Use um número para obter o correto:

man 1 passwd   # O comando passwd
man 5 passwd   # O formato do arquivo /etc/passwd

Números de seção mais comuns:

Número Conteúdo
1 Comandos do usuário (o que você digita no shell)
5 Formatos de arquivo e arquivos de configuração
8 Comandos de administração do sistema

3. man -k: Busca por Palavra-chave

Conclusão: man -k palavra-chave (igual a apropos) encontra comandos pelo que eles fazem.

Lina: E se eu não lembrar o nome do comando de jeito nenhum?
Veterano Linny: Use man -k com uma palavra-chave relacionada ao que você quer fazer. Ele busca em todas as descrições das páginas man e mostra os comandos correspondentes.
man -k compress
bzip2 (1)       - a block-sorting file compressor, v1.0.8
compress (1)    - compress and expand data
gzip (1)        - compress or expand files
xz (1)          - Compress or decompress .xz and .lzma files
zip (1)         - package and compress (archive) files

man -k e apropos são o mesmo comando. Use o que for mais fácil de lembrar.

Se aparecer "nothing appropriate", execute sudo mandb primeiro para atualizar o banco de dados dos manuais.

4. info: Documentação Detalhada GNU

Conclusão: info command fornece documentação GNU detalhada, geralmente mais profunda que as páginas man.

Lina: Se as páginas man cobrem tudo, quando eu usaria info?
Veterano Linny: Ferramentas GNU como grep, awk e find geralmente têm documentação mais completa em info do que em man. Pense em man como referência rápida e info como um livro didático completo.

Uso

info grep

Atalhos de Teclado

Tecla Ação
Space / PageDown Próxima página
b / PageUp Página anterior
q Sair
n Próximo nó (seção)
p Nó anterior
u Nó pai (sumário)
Enter Seguir um link

Se info não estiver instalado, man será exibido no lugar. No Ubuntu, instale com sudo apt install info.

Lina Não Consegue Sair do man (Exemplo de Falha)

Lina: Abri o man chmod, mas não consigo voltar ao promptUm símbolo (como $ ou #) exibido quando o shell está esperando sua entrada.... Fiquei apertando Ctrl+C sem parar!
man chmod
CHMOD(1)                         User Commands                        CHMOD(1)

NAME
       chmod - change file mode bits
...(omitido)
(END)
Lina: Aparece (END) no final da tela, mas nada acontece por mais que eu aperte teclas...
Veterano Linny: Respira. O man usa os mesmos comandos de teclado que o less para sair. Em vez de Ctrl+C, tente pressionar q.
Lina: Ah, consegui sair com q! Então o man abre sua própria tela, e o Ctrl+C normal não funciona lá.
Veterano Linny: Exatamente. man, info e less usam o mesmo "pager" — uma ferramenta que exibe textos longos uma tela de cada vez — e q é a tecla comum para sair de qualquer um deles.

5. Pratique Você Mesmo

Conclusão: Pratique com cp --help, buscando /octal em man chmod, e com man -k owner para fixar o aprendizado.

Lina: Quero tentar o que aprendi!
Veterano Linny: Vamos fazer alguns exercícios. Cada um tem 3 dicas — abra uma de cada vez se ficar travada.

Exercício 1: Verifique as Opções do cp

Tarefa: Exiba a lista de opções do comando cp usando o jeito mais rápido.

Ver Dica 1 (Direção)

Lembre-se do jeito mais rápido de verificar as opções de um comando. É só adicionar algo depois do nome do comando.

Ver Dica 2 (Nome do comando)

Adicione --help depois de cp e execute.

Ver Resposta 
cp --help

A lista de opções aparece, incluindo -i (confirmar antes de sobrescrever) e -r (copiar diretórios recursivamente).

Exercício 2: Busque octal no Manual do chmod

Tarefa: Abra o manual do chmod e busque por octal.

Ver Dica 1 (Direção)

Lembre-se da tecla usada para buscar uma palavra específica dentro de uma página de manual. Ela estava na tabela de atalhos do man.

Ver Dica 2 (Nome do comando)

Abra o manual com man chmod, depois digite /octal.

Ver Resposta 
man chmod
  1. Abra o manual com man chmod
  2. Digite /octal e pressione Enter
  3. Isso leva à seção que explica as permissões numéricas (octais)
  4. Pressione q para sair

Exercício 3: Encontre o Comando Que Muda o Proprietário

Tarefa: Use man -k para encontrar o comando que muda o proprietário de um arquivo.

Ver Dica 1 (Direção)

Lembre-se de como procurar um comando quando você não se lembra do nome dele. É possível buscar por palavra-chave.

Ver Dica 2 (Nome do comando)

Execute man -k com uma palavra-chave como "owner" ou "ownership".

Ver Resposta 
man -k owner

Isso encontra chown, entre outros.

6. Qual Ferramenta Usar

Lina: Então quando exatamente devo usar cada uma?
Veterano Linny: Veja esta tabela de decisão simples.
Objetivo Use
Verificar uma opção rapidamente command --help
Ler a documentação completa do comando man command
Encontrar um comando pelo que ele faz man -k palavra-chave
Aprofundar-se em ferramentas GNU info command

Cenários comuns

  • Verificar opções do ls -la → ls --help
  • Entender como os números do chmod funcionam → man chmod
  • Encontrar um comando de compressão → man -k compress
  • Aprender uso avançado do awk → info awk
Lina: Eu costumava me intimidar com as páginas man por estarem em inglês. Mas agora que sei que posso buscar com /, parecem muito mais acessíveis!
Veterano Linny: Exatamente. Comece escaneando SYNOPSIS e EXAMPLES — só essas duas seções respondem a maioria das perguntas. O resto da página se torna útil conforme você ganha experiência.

Resumo em 3 Linhas

  1. Para uma verificação rápida, use command --help
  2. Para uma leitura completa, use man command (pressione q para sair)
  3. Quando não lembrar o nome do comando, use man -k palavra-chave para encontrá-lo

Próximas Leituras