Linha de Comando · Lição 17

whatis

Aprenda a obter descrições concisas das páginas de manual e interpretar seus números de seção.

Quando você reconhece o nome de um comando, mas esquece sua finalidade, whatis pode fornecer um breve lembrete com base no banco de dados das páginas de manual.

Consulta de um Nome Exato

Forneça um ou mais nomes exatos de tópicos a whatis. Cada resultado deriva da seção NAME registrada em uma página de manual instalada:

$ whatis cat
cat (1)              - concatenate files and print on the standard output

A saída é uma descrição, não uma lista de opções ou exemplos do comando. Use man cat ou cat --help quando precisar de mais detalhes.

Você conhece o nome cat e quer sua descrição de uma linha na página de manual. Qual comando deve executar?

Leitura dos Números de Seção

Se o mesmo tópico tiver páginas de manual em várias seções, whatis poderá mostrar mais de um resultado:

$ whatis passwd
passwd (1)           - change user password
passwd (5)           - the password file

O número entre parênteses é a seção do manual. Aqui, passwd(1) descreve o comando de usuário, e passwd(5) descreve um formato de arquivo. Você pode abrir uma delas explicitamente com man 1 passwd ou man 5 passwd.

Na saída passwd (5) - the password file, o que (5) identifica?

Escolha entre whatis, man e apropos

whatis NAME: mostra descrições concisas de um nome exato de tópico do manual.
man NAME: abre uma página de manual completa.
apropos KEYWORD: pesquisa uma palavra-chave nos nomes e nas descrições das páginas.

Por exemplo:

$ apropos password

Use apropos quando conhecer a tarefa, mas não o nome do comando. Use whatis quando já souber o nome.

Você não conhece o nome de um comando, mas quer pesquisar a palavra-chave password nas descrições dos manuais. Qual comando é adequado?

Quando Nenhuma Descrição Aparece

Se whatis informar que nada é apropriado, talvez o tópico não possua uma página de manual instalada ou o banco de dados esteja desatualizado. Esse resultado não comprova a inexistência de um executável, alias, função ou comando interno com esse nome. Use type NAME para descobrir como o Bash resolve o nome e então escolha a fonte de ajuda apropriada.

whatis deploy não encontra uma descrição de manual. Qual comando verifica se o Bash resolve deploy como alias, função, comando interno ou executável?

Lição concluída

Você concluiu whatis

Agora você sabe obter e interpretar descrições concisas no banco de dados dos manuais.

Consulte um tópico exato com whatis.
Leia a seção do manual mostrada entre parênteses.
Use man quando precisar da página completa.
Use apropos quando conhecer uma palavra-chave, mas não o nome.

Salve seu progresso

Crie uma conta gratuita para salvar esta lição e continuar em qualquer dispositivo.

Criar uma conta gratuita

Próxima Lição

Voltar para Linha de Comando