255 lines
7.2 KiB
HTML
255 lines
7.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of LEXGROG</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>LEXGROG</H1>
|
|
Section: Utilidades do paginador do 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>
|
|
|
|
lexgrog - analisar informação de cabeçalho em páginas do manual
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SINOPSE</H2>
|
|
|
|
<B>lexgrog</B> [<B>-m</B>|<B>-c</B>] [<B>-dfw?V</B>] [<B>-E</B> <I>codificação</I>]
|
|
<I>ficheiro</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIÇÃO</H2>
|
|
|
|
<B>lexgrog</B> é uma implementação do utilitário tradicional "groff
|
|
guess") em <B>lex</B>. Ele lê a lista de ficheiros na linha de comandos como
|
|
ficheiros fonte de páginas do manual ou páginas pré-formatadas "cat" e
|
|
mostra o seu nome e descrição conforme utilizados por <B>apropos</B> e
|
|
<B>whatis</B>, a lista de filtros de pré-processamento exigidos pela página do
|
|
manual antes de ser passada para <B>noff</B> ou <B>troff</B>, ou ambos.
|
|
<P>
|
|
|
|
Se a entrada estiver mal formatada, <B>lexgrog</B> imprime "a análise
|
|
falhou"; isto pode ser útil para programas externos que precisam
|
|
verificar as páginas do manual para correcção. Se um dos ficheiros de
|
|
entrada do <B>lexgrog</B> for "-", lerá da entrada padrão; se algum
|
|
ficheiro de entrada for comprimido, será lida automaticamente uma versão
|
|
descomprimida).
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPÇÕES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
imprime informação de depuração.
|
|
<DT id="2"><B>-m</B>, <B>--man</B>
|
|
|
|
|
|
<DD>
|
|
Analisar entrada como ficheiros fonte de páginas do manual. É a predefinição
|
|
se nem <B>--man</B> nem <B>--cat</B> forem indicados.
|
|
<DT id="3"><B>-c</B>, <B>--cat</B>
|
|
|
|
|
|
<DD>
|
|
Analisar entrada como páginas do manual pré-formatadas ("páginas
|
|
cat"). <B>--man</B> e <B>--cat</B> não podem ser indicados em simultâneo.
|
|
<DT id="4"><B>-w</B>, <B>--whatis</B>
|
|
|
|
|
|
<DD>
|
|
Mostra o nome e descrição do cabeçalho da página do manual, como usado por
|
|
<B>apropos</B> e <B>whatis</B>. É a predefinição se nem <B>--whatis</B> nem <B>--filters</B>
|
|
forem indicados.
|
|
<DT id="5"><B>-f</B>, <B>--filters</B>
|
|
|
|
|
|
<DD>
|
|
Mostra a lista de filtros necessários ao pré-processamento da página do
|
|
manual antes de a formatar com <B>nroff</B> ou <B>troff</B>.
|
|
<DT id="6"><B>-E</B> <I>codificação</I>, <B>--encoding</B> <I>codificação</I><DD>
|
|
Sobrepor o conjunto de caracteres adivinhado para a página com
|
|
<I>codificação</I>.
|
|
<DT id="7"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
mostra uma mensagem de ajuda e sai.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
mostra uma mensagem curta de uso e sai.
|
|
<DT id="9"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
mostra informação da versão.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ESTADO DE SAÍDA</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Execução de programa com sucesso.
|
|
<DT id="11"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Erro de utilização.
|
|
<DT id="12"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
<B>lexgrog</B> falhou ao analisar um ou mais dos seus ficheiros de entrada..
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXEMPLOS</H2>
|
|
|
|
<PRE>
|
|
$ lexgrog man.1
|
|
man.1: "man - um ambiente para os manuais de referência do sistema"
|
|
$ lexgrog -fw man.1
|
|
man.1 (t): "man - um ambiente para os manuais de referência do sistema"
|
|
$ lexgrog -c whatis.cat1
|
|
whatis.cat1: "whatis - mostra as descrições das páginas do manual"
|
|
$ lexgrog broken.1
|
|
broken.1: análise falhou
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ANÁLISE WHATIS</H2>
|
|
|
|
<B>mandb</B> (que usa o mesmo código que <B>lexgrog</B>) analisa a secção <B>NOME</B>
|
|
ao cimo de cada página do manual, procurando nomes e descrições das
|
|
funcionalidades documentadas em cada uma delas. Embora o analisador seja
|
|
muito tolerante, dado que tem de lidar com um número de diferentes formas
|
|
que foram antes utilizadas, pode, às vezes, falhar a extracção da informação
|
|
necessária.
|
|
<P>
|
|
|
|
Ao utilizar o conjunto de macros tradicional <I>man</I>, uma secção <B>NOME</B>
|
|
correcta parece-se com isto:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<PRE>
|
|
<TT>.SH NOME
|
|
foo \- programa para fazer algo</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Algumas páginas do manual requerem que '\-' seja exactamente como
|
|
mostrado; <B>mandb</B> é mais tolerante, mas para compatibilidade com outros
|
|
sistemas, é sempre boa ideia reter a barra invertida.
|
|
<P>
|
|
|
|
No lado esquerdo, pode haver vários nomes, separados por vírgulas. Nomes com
|
|
espaços serão ignorados, para evitar comportamentos patológicos em certas
|
|
secções <B>NOME</B> mal formadas. O texto no lado direito é livre, e pode ser
|
|
dividido em várias linhas. Se estão a ser documentadas várias
|
|
funcionalidades com diferentes descrições na mesma página do manual, é usado
|
|
o seguinte formulário:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="14"><DD>
|
|
<PRE>
|
|
<TT>.SH NOME
|
|
foo, bar \- programas para fazer algo
|
|
.br
|
|
baz \- programa para não fazer nada</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
(pode usar uma macro que inicia um novo parágrafo, como <TT>.PP</TT>, em vez da
|
|
macro de quebra <TT>.br</TT>)
|
|
<P>
|
|
|
|
Ao utilizar o conjunto de macros <I>mdoc</I> derivado de BSD, a secção <B>NOME</B>
|
|
correcta parece-se com algo como isto:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="15"><DD>
|
|
<PRE>
|
|
<TT>.Sh NOME
|
|
.Nm foo
|
|
.Nd programa para fazer algo</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Há várias razões para a falha da análise do whatis. Por vezes, os autores
|
|
das páginas do manual substituem '.SH NOME' por '.SH
|
|
MEUPROGRAMA', o que leva a que <B>mandb</B> não consiga encontra a secção
|
|
de onde extrair a informação necessária. Outras vezes, incluem uma secção
|
|
NOME mas colocam aqui texto livre, em vez de 'nome \-
|
|
descrição'. Contudo, qualquer sintaxe parecida com o acima deverá ser
|
|
aceite.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>VEJA TAMBÉM</H2>
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+man">man</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+whatis">whatis</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></I>(8)
|
|
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>NOTAS</H2>
|
|
|
|
<B>lexgrog</B> tenta analisar ficheiros contendo pedidos .so, mas só o poderá
|
|
correctamente fazer se os ficheiros estiverem devidamente instalados numa
|
|
hierarquia de páginas do manual.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>AUTOR</H2>
|
|
|
|
O código usado por <B>lexgrog</B> para analisar quem escreveu as páginas do
|
|
manual:
|
|
<P>
|
|
|
|
<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>
|
|
|
|
Colin Watson escreveu a encarnação actual da linha de comandos, assim como
|
|
esta página do manual.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NOME</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SINOPSE</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">DESCRIÇÃO</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">OPÇÕES</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">ESTADO DE SAÍDA</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">EXEMPLOS</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">ANÁLISE WHATIS</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">VEJA TAMBÉM</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">NOTAS</A><DD>
|
|
<DT id="25"><A HREF="#lbAK">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:22 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|