Man page - whatis(1)

Packages contains this manual

Available languages:

en fr pt_BR es it pl pt ko nl da tr sv ja uk id ru ro sr zh_CN de

Manual

WHATIS

NOME
SINOPSE
DESCRIƇƃO
OPƇƕES
STATUS DE SAƍDA
AMBIENTE
ARQUIVOS
VEJA TAMBƉM
AUTOR
PROBLEMAS

NOME

whatis - exibe descriƧƵes de uma linha de pƔginas de manual

SINOPSE

whatis [ -dlv?V ] [ -r | -w ] [ -s lista ] [ -m sistema [,...]] [ -M caminho ] [ -L localidade ] [ -C arquivo ] nome ...

DESCRIƇƃO

Cada pĆ”gina de manual possui uma descriĆ§Ć£o curta disponĆ­vel. whatis pesquisa os nomes de pĆ”ginas de manual e exibe as descriƧƵes de pĆ”gina de manual de qualquer nome correspondido.

nome pode conter curingas ( -w ) ou ser uma expressĆ£o regular ( -r ). Ao usar essas opƧƵes, pode ser necessĆ”rio colocar nome entre aspas ou escapar (\) os caracteres especiais para impedir o shell de interpretĆ”-las.

Banco de dados index 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 periĆ³dico do cron, ou pode ser necessĆ”rio executar manualmente apĆ³s novas pĆ”ginas de manual serem instaladas. Para produzir um banco de dados do whatis no estilo texto antigo a partir do banco de dados index , use o comando:

whatis -M caminho man -w ā€™*ā€™ | sort > manpath/whatis

sendo que caminho man Ʃ a hierarquia de pƔgina de manual tal como /usr/man .

OPƇƕES

-d , --debug

Emite mensagens de depuraĆ§Ć£o.

-v , --verbose

Emite mensagens de aviso detalhadas.

-r , --regex

Interpreta cada nome como uma expressĆ£o regular. Se um nome corresponde a qualquer parte de um nome de pĆ”gina, uma correspondĆŖncia serĆ” feita. Essa opĆ§Ć£o faz com que whatis seja um pouco mais lento devido Ć  natureza das pesquisas a banco de dados.

-w , --wildcard

Interpreta cada nome como um padrĆ£o contendo caracteres curingas do tipo shell. Para uma correspondĆŖncia ser feita, um nome expandido deve corresponder a todo um nome de pĆ”gina. Essa opĆ§Ć£o faz com que whatis seja um pouco mais lento devido Ć  natureza das pesquisa a banco de dados.

-l , --long

NĆ£o apara a saĆ­da Ć  largura do terminal. Normalmente, a saĆ­da serĆ” truncada Ć  largura do terminal para evitar resultados causados por seƧƵes NAME mal escritas.

-s lista , --sections= lista , --section= lista

Pesquisa apenas as seƧƵes de manual fornecidas. lista Ć© uma lista de seƧƵes separada pelo caractere de dois pontos ou vĆ­rgula. Se uma entrada na lista for uma Ćŗnica seĆ§Ć£o, por exemplo "3", entĆ£o a lista de descriƧƵes exibida incluirĆ” pĆ”ginas nas seƧƵes "3", "3perl", "3x" e por aĆ­ vai; se uma entrada na lista possuir uma extensĆ£o, por exemplo "3perl", entĆ£o a lista incluirĆ” apenas pĆ”ginas naquela parte exata da seĆ§Ć£o de manual.

-m sistema [,...], --systems= sistema [,...]

Se esse sistema possui acesso aos nomes de pĆ”ginas de manual de outros sistemas operacionais, Ć© possĆ­vel acessĆ”-las usando essa opĆ§Ć£o. Para pesquisar os nomes de pĆ”gina 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 aos nomes de pĆ”ginas de manual do sistema operacional nativo, inclua man como nome do sistema no texto do argumento. Essa opĆ§Ć£o vai sobrescrever a variĆ”vel de ambiente $ SYSTEM .

-M caminho , --manpath= caminho

Especifica um conjunto alternativo de hierarquias de pĆ”ginas de manual, separadas por caractere de dois pontos, a ser pesquisado. Por padrĆ£o, whatis usa a variĆ”vel de ambiente $ MANPATH , a menos que esteja vazia ou nĆ£o definida, caso em que ele vai determinar um manpath apropriado baseado em sua variĆ”vel de ambiente $ PATH . Essa opĆ§Ć£o sobrescreve o conteĆŗdo de $ MANPATH .

-L localidade , --locale= localidade

whatis geralmente vai determinar sua localidade atual por uma chamada Ć  funĆ§Ć£o C setlocale (3), a qual pergunta a vĆ”rias variĆ”veis de ambiente, possibilitando incluir $ LC_MESSAGES e $ LANG . Para temporariamente substituir o valor determinado, use essa opĆ§Ć£o para fornecer uma localidade diretamente para whatis . Note que isso nĆ£o surtirĆ” efeito atĆ© que a pesquisa por pĆ”ginas seja iniciada. SaĆ­da como a mensagem de ajuda sempre serĆ” exibida na localidade inicialmente determinada.

-C arquivo , --config-file= arquivo

Usa esse arquivo de configuraĆ§Ć£o de usuĆ”rio em vez do padrĆ£o ~/.manpath .

-? , --help

Imprime uma mensagem de ajuda e sai.

--usage

Imprime uma mensagem curta e sai.

-V , --version

Exibe informaĆ§Ć£o da versĆ£o.

STATUS DE SAƍDA

0

ExecuĆ§Ć£o com sucesso do programa.

1

Erro de uso, de sintaxe ou no arquivo de configuraĆ§Ć£o.

2

Erro operacional.

16

Nada foi localizado que correspondesse aos critƩrios especificados.

AMBIENTE

SYSTEM

Se $ SYSTEM estiver definido, ele terĆ” o mesmo efeito que se fosse especificado como um argumento da opĆ§Ć£o -m .

MANPATH

Se $ MANPATH estiver definido, seu valor Ʃ interpretado como um caminho de pesquisa de hierarquia de pƔginas de manual, separadas por caractere de dois pontos, a ser usado.

Veja a seĆ§Ć£o CAMINHO DE PESQUISA de manpath (5) para o comportamento padrĆ£o e detalhes de como essa variĆ”vel de ambiente Ć© manipulada.

MANWIDTH

Se $ MANWIDTH estiver definido, seu valor Ć© usado como largura do terminal (veja a opĆ§Ć£o --long ). Se nĆ£o estiver definido, a largura do terminal serĆ” calculada usando o valor de $ COLUMNS e ioctl (2), se disponĆ­vel, ou recorrendo ao padrĆ£o de 80 caracteres se todo resto falhar.

ARQUIVOS

/usr/share/man/index.(bt|db|dir|pag)

Um cache global de banco de dados index tradicional.

/var/cache/man/index.(bt|db|dir|pag)

Um cache global de banco de dados index compatĆ­vel com FHS.

/usr/share/man/.../whatis

Um banco de dados de texto tradicional do whatis .

VEJA TAMBƉM

apropos (1), man (1), mandb (8)

AUTOR

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

PROBLEMAS

https://gitlab.com/man-db/man-db/-/issues
https://savannah.nongnu.org/bugs/?group=man-db