Comando whatis do Linux
Nos sistemas operacionais do tipo Unix, o comando whatis exibe descrições curtas de páginas manuais .
Este documento cobre a versão Linux do whatis .
Descrição
Cada página do manual possui uma breve descrição disponível. O whatis pesquisa os nomes das páginas manuais e exibe as descrições das páginas manuais de qualquer nome correspondente.
name pode conter curingas ( -w ) ou ser uma expressão regular ( -r ). Usando essas opções, pode ser necessário citar o nome ou escapar ( \ ) os caracteres especiais para impedir o shell de interpretá-los.
Os bancos de dados de índice são usados durante a pesquisa e são atualizados pelo programa mandb. Dependendo da sua instalação, isso pode ser executado por um trabalho cron periódico ou manualmente após a instalação de novas páginas de manual. Para produzir um texto com estilo antigo, o que é um banco de dados a partir do banco de dados de índice relativo, emita o comando abaixo:
whatis -M manpath -w '*' | classificar> manpath / whatis
… em que manpath é uma hierarquia de páginas manual como / usr / man .
Sintaxe
whatis [-dlhvV] [-r | -w] [-s list ] [-m system [, ...]] [-M path ] [-L locale ]Nome
[do arquivo -C ] ...
Opções
| -d , –debug | Imprimir informações de depuração. |
| -v , –verbose | Imprima mensagens de aviso detalhadas. |
| -r , –regex | Interprete cada nome como uma expressão regular. Se um nome corresponder a qualquer parte do nome de uma página, será feita uma correspondência. Essa opção faz com que o que seja um pouco mais lento devido à natureza das pesquisas no banco de dados. |
| -w , –wildcard | Interprete cada nome como um padrão que contém curingas no estilo de shell. Para que uma correspondência seja feita, um nome expandido deve corresponder ao nome da página inteira. Essa opção faz com que o que seja um pouco mais lento devido à natureza das pesquisas no banco de dados. |
| -l , –longo | Não apare a saída na largura do terminal. Normalmente, a saída será truncada na largura do terminal para evitar resultados feios de seções NAME mal escritas. |
| -s lista , – lista de seções , – lista de seções | Pesquise apenas as seções do manual fornecidas. A lista é uma lista de seções separadas por vírgula ou vírgula. Se uma entrada na lista for uma seção simples, por exemplo ” 3 “, a lista de descrições exibida incluirá páginas nas seções ” 3 “, ” 3perl “, ” 3x ” e assim por diante; embora se uma entrada na lista tiver uma extensão, por exemplo ” 3perl “, a lista incluirá apenas páginas na parte exata da seção do manual. |
| -m sistema [ , …], –systems = sistema [ , …] | Se este sistema tiver acesso aos nomes das páginas de manual de outros sistemas operacionais, eles poderão ser acessados usando esta opção. Para pesquisar os nomes das páginas de manual do NewOS, use a opção ” -m NewOS “. O sistema especificado pode ser uma combinação de nomes de sistemas operacionais delimitados por vírgula. Para incluir uma pesquisa nos nomes de página do manual do sistema operacional nativo, inclua o nome do sistema man na sequência de argumentos. Esta opção substituirá a variável de ambiente $ SYSTEM . |
| -M caminho , –manpath = caminho | Especifique um conjunto alternativo de hierarquias de páginas manuais delimitadas por dois pontos para pesquisar. Por padrão, o whatis usa a variável de ambiente $ MANPATH , a menos que esteja vazia ou não configurada; nesse caso, ele determinará um caminho de manuseio apropriado com base na sua variável de ambiente $ PATH . Esta opção substitui o conteúdo de $ MANPATH . |
| -L localidade , –locale = localidade | Whatis normalmente determinar sua localidade atual por uma chamada para a função C setlocale que interroga várias variáveis de ambiente, incluindo possivelmente $ LC_MESSAGES e $ LANG . Para substituir temporariamente o valor determinado, use esta opção para fornecer uma sequência de código de idioma diretamente ao whatis. Observe que isso não entrará em vigor até que a pesquisa por páginas realmente comece. Saída como a mensagem de ajuda sempre será exibida no código do idioma inicialmente determinado. |
| Arquivo -C , –config-file = file | Use este arquivo de configuração do usuário em vez do padrão ~ / .manpath . |
| -h , –help | Imprima uma mensagem de ajuda e saia. |
| -V , –version | Exibir informações da versão. |
Status de saída:
| 0 0 | Execução bem sucedida do programa. |
| 1 | Erro de uso, sintaxe ou arquivo de configuração. |
| 2 | Erro operacional. |
| 16 | Não foi encontrado nada que correspondesse aos critérios especificados. |
Meio Ambiente
| SISTEMA | Se $ SYSTEM estiver definido, terá o mesmo efeito como se tivesse sido especificado como o argumento para a opção -m . |
| MANPATH | Se $ MANPATH estiver definido, seu valor será interpretado como o caminho de pesquisa da hierarquia de páginas manual delimitado por dois pontos. |
| LARGURA DO HOMEM | Se $ MANWIDTH estiver definido, seu valor será usado como a largura do terminal (consulte a opção –long ). Se não estiver definido, a largura do terminal será calculada usando um ioctl, se disponível, o valor de $ COLUMNS ou retornando a 80 caracteres, se tudo mais falhar. |
Exemplos
whatis whatis
Exibir uma descrição do que whatis é.
Comandos relacionados
info – Leia documentos Info.
man – Exibe a página de manual de um determinado comando.
