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
ESTADO DE SAƍDA
AMBIENTE
FICHEIROS
VEJA TAMBƉM
AUTOR
ERROS

NOME

whatis - mostra descriƧƵes das pƔginas do manual numa linha

SINOPSE

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

DESCRIƇƃO

Cada pĆ”gina do manual tem em si uma breve descriĆ§Ć£o. O whatis procura os nomes das pĆ”ginas do manual e mostra as descriƧƵes, caso encontre algum nome .

O nome pode conter caracteres universais ( -w ) ou ser uma expressĆ£o regular ( -r ). Se usar estas opƧƵes, poderĆ” ser necessĆ”rio pĆ“r o nome entre aspas ou escapar (\) os caracteres especiais para impedir que a shell os interprete.

Durante a procura, sĆ£o usadas bases de dados de Ć­ndice e sĆ£o actualizadas pelo programa mandb . Dependendo da sua instalaĆ§Ć£o, isto pode ser executado por uma tarefa cron periĆ³dica, ou pode ter de ser manualmente excutado apĆ³s a instalaĆ§Ć£o de novas pĆ”ginas do manual. Para produzir umbase de dados whatis em texto de estilo antigo a partir da base de dados de Ć­ndice relativa, emita o comando:

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

onde manpath Ʃ uma hierarquia de pƔginas do manual, tal como /usr/man .

OPƇƕES

-d , --debug

Imprime informaĆ§Ć£o de depuraĆ§Ć£o.

-v , --verbose

Imprime avisos verbosos.

-r , --regex

Interpreta cada nome como uma expressĆ£o regular. Se um nome corresponder a qualquer parte de um nome de pĆ”gina, serĆ” feita uma correspondĆŖncia. Esta opĆ§Ć£o faz com que o whatis seja algo mais lento devido Ć  natureza das bases de dados de procura.

-w , --wildcard

Interpreta cada nome como um padrĆ£o contendo caracteres universais ao estilo da shell. Para que haja uma correspondĆŖncia, um nome expandido tem de corresponder a todo o nome da pĆ”gina. Esta opĆ§Ć£o faz com que o whatis seja algo mais lento devido Ć  natureza das base de dados de procura.

-l , --long

NĆ£o corta a saĆ­da para a largura do terminal. Normalmente, isto Ć© feito para evitar resultados muito feios de secƧƵes NOME mal escritas.

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

Procura sĆ³ as secƧƵes do manual indicadas. lista Ć© uma lista de secƧƵes separadas por dois-pontos ou vĆ­rgula. Se uma entrada em lista for uma secĆ§Ć£o simples, por exemplo, "3", a lista de descriƧƵes mostrada incluirĆ” pĆ”ginas nas secƧƵes "3", "3perl", "3x" e assim por diante; enquanto se uma entrada em lista tiver uma extensĆ£o, por exemplo "3perl", a lista incluirĆ” sĆ³ pĆ”ginas nessa parte exacta da secĆ§Ć£o do manual.

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

Se este sistema tem acesso a nomes de pĆ”ginas de manual de outro sistema operativo, pode usar esta opĆ§Ć£o para lhes aceder. Para tal, use a opĆ§Ć£o -m NovoOS .

O sistema especificado pode ser uma combinaĆ§Ć£o de nomes de sistemas operativos, separados por vĆ­rgulas. Para incluir uma procura de nomes de pĆ”ginas do manual do sistema nativo, o nome de sistema man tem de estar incluĆ­do na cadeia de argumentos. Esta opĆ§Ć£o sobrepƵe-se Ć  variĆ”vel de ambiente $ SYSTEM .

-M caminho , --manpath= caminho

Especifique um conjunto alternativo de hierarquias de pĆ”ginas de manual delimitadas por dois-pontos para procurar. Por predefiniĆ§Ć£o, whatis usa a variĆ”vel de ambiente $ MANPATH , a menos que esteja vazia ou indefinida, caso em que determinarĆ” um manpath apropriado com base na variĆ”vel de ambiente $ PATH . Esta opĆ§Ć£o sobrescreve o conteĆŗdo de $ MANPATH .

-L idioma , --locale= idioma

O whatis normalmente determinarĆ” sua localidade actual por uma chamada Ć  funĆ§Ć£o C setlocale (3), que interroga vĆ”rias variĆ”veis de ambiente, possivelmente incluindo $ LC_MESSAGES e $ LANG . Para sobrepor temporariamente o valor determinado, use esta opĆ§Ć£o para fornecer uma cadeia idioma directamente a whatis . Note que isto nĆ£o terĆ” efeito atĆ© que a procura por pĆ”ginas realmente comece. SaĆ­das como a mensagem de ajuda serĆ£o sempre mostradas no idioma inicialmente determinado.

-C ficheiro , --config-file= ficheiro

Usa este ficheiro de configuraĆ§Ć£o do utilizador em vez do prĆ©-definido de ~/.manpath .

-? , --help

Mostra uma mensagem de ajuda e sai.

--usage

Mostra uma mensagem curta de uso e sai.

-V , --version

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

ESTADO DE SAƍDA

0

ExecuĆ§Ć£o de programa com sucesso.

1

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

2

Erro de operaĆ§Ć£o.

16

Nada encontrado que cumpra o critƩrio especificado.

AMBIENTE

SYSTEM

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

MANPATH

Se $ MANPATH estiver definido, o seu valor Ʃ interpretado como caminho de procura delimitado por dois-pontos de hierarquia de pƔginas do manual a usar.

Veja a secĆ§Ć£o SEARCH PATH de manpath (5) para o comportamento prĆ©-definido e detalhes sobre a gestĆ£o da variĆ”vel de ambiente.

MANWIDTH

Se $ MANWIDTH estiver definido, o seu valor serĆ” usado como largura do terminal (veja a opĆ§Ć£o --long ). SenĆ£o, a largura do terminal serĆ” calculada usando o valor de $ COLUMNS e ioctl (2) se disponĆ­vel ou retornando a 80 caracteres se tudo o mais falhar.

FICHEIROS

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

Uma cache de base de dados de Ć­ndice global tradicional.

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

Uma cache de base de dados de Ć­ndice global de acordo com FHS.

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

Uma base de dados de texto whatis tradicional.

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).

ERROS

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