240 lines
8.3 KiB
HTML
240 lines
8.3 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of WHATIS</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>WHATIS</H1>
|
|
Section: Utilitários de paginação de manual (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NOME</H2>
|
|
|
|
whatis - exibe descrições de uma linha de páginas de manual
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SINOPSE</H2>
|
|
|
|
<B>whatis</B> [<B>-dlv?V</B>] [<B>-r</B>|<B>-w</B>] [<B>-s</B> <I>lista</I>]
|
|
[<B>-m</B> <I>sistema</I>[,...]] [<B>-M</B> <I>caminho</I>] [<B>-L</B>
|
|
<I>localidade</I>] [<B>-C</B> <I>arquivo</I>] <I>nome</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIÇÃO</H2>
|
|
|
|
Cada página de manual possui uma descrição curta disponível. <B>whatis</B>
|
|
pesquisa os nomes de páginas de manual e exibe as descrições de página de
|
|
manual de qualquer <I>nome</I> correspondido.
|
|
<P>
|
|
<I>nome</I> pode conter curingas (<B>-w</B>) ou ser uma expressão regular
|
|
(<B>-r</B>). Ao usar essas opções, pode ser necessário colocar <I>nome</I> entre
|
|
aspas ou escapar (\) os caracteres especiais para impedir o shell de
|
|
interpretá-las.
|
|
<P>
|
|
Banco de dados <B>index</B> são usados durante a pesquisa e são atualizados pelo
|
|
programa <B>mandb</B>. 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 <B>whatis</B> no estilo texto antigo a partir do banco de
|
|
dados <B>index</B>, use o comando:
|
|
<P>
|
|
<B>whatis -M</B> <I>caminho man</I> <B>-w '*' | sort ></B> <I>manpath/whatis</I>
|
|
<P>
|
|
sendo que <I>caminho man</I> é a hierarquia de página de manual tal como
|
|
<I>/usr/man</I>.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPÇÕES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Emite mensagens de depuração.
|
|
<DT id="2"><B>-v</B>, <B>--verbose</B>
|
|
|
|
|
|
<DD>
|
|
Emite mensagens de aviso detalhadas.
|
|
<DT id="3"><B>-r</B>, <B>--regex</B>
|
|
|
|
|
|
<DD>
|
|
Interpreta cada <I>nome</I> como uma expressão regular. Se um <I>nome</I>
|
|
corresponde a qualquer parte de um nome de página, uma correspondência será
|
|
feita. Essa opção faz com que <B>whatis</B> seja um pouco mais lento devido à
|
|
natureza das pesquisas a banco de dados.
|
|
<DT id="4"><B>-w</B>, <B>--wildcard</B>
|
|
|
|
|
|
<DD>
|
|
Interpreta cada <I>nome</I> como um padrão contendo caracteres curingas do tipo
|
|
shell. Para uma correspondência ser feita, um <I>nome</I> expandido deve
|
|
corresponder a todo um nome de página. Essa opção faz com que <B>whatis</B>
|
|
seja um pouco mais lento devido à natureza das pesquisa a banco de dados.
|
|
<DT id="5"><B>-l</B>, <B>--long</B>
|
|
|
|
|
|
<DD>
|
|
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 <B>NAME</B> mal
|
|
escritas.
|
|
<DT id="6"><B>-s</B> <I>lista/</I>, <B>--sections=</B><I>lista/</I>, <B>--section=</B><I>lista</I><DD>
|
|
Pesquisa apenas as seções de manual fornecidas. <I>lista</I> é uma lista de
|
|
seções separada pelo caractere de dois pontos ou vírgula. Se uma entrada na
|
|
<I>lista</I> 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 <I>lista</I> possuir uma extensão, por exemplo "3perl", então a lista
|
|
incluirá apenas páginas naquela parte exata da seção de manual.
|
|
<DT id="7"><B>-m</B> <I>sistema</I>[,...], <B>--systems=</B><I>sistema</I>[,...]<DD>
|
|
Se esse sistema possui acesso aos nomes de páginas de manual do outro
|
|
sistema operacional, é possível acessá-las usando essa opção. Para pesquisar
|
|
os nomes de página de manual do NewOS, use a opção <B>-m</B> <B>NewOS</B>.
|
|
<P>
|
|
O <I>sistema</I> 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 <B>man</B> como nome do
|
|
sistema no texto do argumento. Essa opção vai sobrescrever a variável de
|
|
ambiente $<B>SYSTEM</B>.
|
|
<DT id="8"><B>-M </B><I>caminho</I>, <B>--manpath=</B><I>caminho</I><DD>
|
|
Especifica um conjunto alternativo de hierarquias de páginas de manual,
|
|
separadas por caractere de dois pontos, a ser pesquisado. Por padrão,
|
|
<B>whatis</B> usa a variável de ambiente $<B>MANPATH</B>, 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 $<B>PATH</B>. Essa opção sobrescreve o
|
|
conteúdo de $<B>MANPATH</B>.
|
|
<DT id="9"><B>-L </B><I>localidade</I>, <B>--locale=</B><I>localidade</I><DD>
|
|
<B>whatis</B> geralmente vai determinar sua localidade atual por uma chamada
|
|
à função C <B><A HREF="/cgi-bin/man/man2html?3+setlocale">setlocale</A></B>(3), a qual pergunta a várias variáveis de ambiente,
|
|
possibilitando incluir $<B>LC_MESSAGES</B> e $<B>LANG</B>. Para temporariamente
|
|
substituir o valor determinado, use essa opção para fornecer uma
|
|
<I>localidade</I> diretamente para <B>whatis</B>. 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.
|
|
<DT id="10"><B>-C </B><I>arquivo</I>, <B>--config-file=</B><I>arquivo</I><DD>
|
|
Usa esse arquivo de configuração de usuário em vez do padrão <I>~/.manpath</I>.
|
|
<DT id="11"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Imprime uma mensagem de ajuda e sai.
|
|
<DT id="12"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Imprime uma mensagem curta e sai.
|
|
<DT id="13"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Exibe informação da versão.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>STATUS DE SAÍDA</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="14"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Execução com sucesso do programa.
|
|
<DT id="15"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Erro de uso, de sintaxe ou no arquivo de configuração.
|
|
<DT id="16"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
Erro operacional.
|
|
<DT id="17"><B>16</B>
|
|
|
|
|
|
<DD>
|
|
Nada foi localizado que correspondesse aos critérios especificados.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>AMBIENTE</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="18"><B>SYSTEM</B>
|
|
|
|
|
|
<DD>
|
|
Se $<B>SYSTEM</B> estiver definido, ele terá o mesmo efeito que se fosse
|
|
especificado como um argumento da opção <B>-m</B>.
|
|
<DT id="19"><B>MANPATH</B>
|
|
|
|
|
|
<DD>
|
|
Se $<B>MANPATH</B> 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.
|
|
<DT id="20"><B>MANWIDTH</B>
|
|
|
|
|
|
<DD>
|
|
Se $<B>MANWIDTH</B> estiver definido, seu valor é usado como largura do terminal
|
|
(veja a opção <B>--long</B>). Se não estiver definido, a largura do terminal
|
|
será calculada usando o valor de $<B>COLUMNS</B> e <B><A HREF="/cgi-bin/man/man2html?2+ioctl">ioctl</A></B>(2), se disponível,
|
|
ou recorrendo ao padrão de 80 caracteres se todo resto falhar.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ARQUIVOS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="21"><I>/usr/share/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
Um cache global de banco de dados <I>index</I> tradicional.
|
|
<DT id="22"><I>/var/cache/man/index.(bt|db|dir|pag)</I>
|
|
|
|
|
|
<DD>
|
|
Um cache global de banco de dados <I>index</I> compatível com FHS.
|
|
<DT id="23"><I>/usr/share/man/.../whatis</I>
|
|
|
|
|
|
<DD>
|
|
Um banco de dados de texto tradicional do <B>whatis</B>.
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H2>VEJA TAMBÉM</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></B>(1),
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+man">man</A></B>(1),
|
|
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></B>(8)
|
|
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>AUTOR</H2>
|
|
|
|
<PRE>
|
|
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).</PRE>
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="24"><A HREF="#lbAB">NOME</A><DD>
|
|
<DT id="25"><A HREF="#lbAC">SINOPSE</A><DD>
|
|
<DT id="26"><A HREF="#lbAD">DESCRIÇÃO</A><DD>
|
|
<DT id="27"><A HREF="#lbAE">OPÇÕES</A><DD>
|
|
<DT id="28"><A HREF="#lbAF">STATUS DE SAÍDA</A><DD>
|
|
<DT id="29"><A HREF="#lbAG">AMBIENTE</A><DD>
|
|
<DT id="30"><A HREF="#lbAH">ARQUIVOS</A><DD>
|
|
<DT id="31"><A HREF="#lbAI">VEJA TAMBÉM</A><DD>
|
|
<DT id="32"><A HREF="#lbAJ">AUTOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:21 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|