255 lines
7.4 KiB
HTML
255 lines
7.4 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: 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>
|
|
|
|
lexgrog - analisa informações do cabeçalho em páginas man
|
|
<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>arquivo</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIÇÃO</H2>
|
|
|
|
<B>lexgrog</B> é uma implementação do utilitário "groff guess" tradicional
|
|
em <B>lex</B>. Ele lê uma lista de arquivos em sua linha de comando como
|
|
arquivos-fonte de páginas man ou páginas "cat" pré-formatadas, e exibe
|
|
os respectivos nomes e descrições como usado por <B>apropos</B> e <B>whatis</B>. A
|
|
lista de filtros de pré-processamento são exigidos pela página man antes
|
|
dela ser passada para <B>nroff</B> ou <B>troff</B>, ou ambos.
|
|
<P>
|
|
|
|
Se sua entrada estiver mal formatada, <B>lexgrog</B> irá imprimir "parse
|
|
failed"; isso pode ser útil para programas externos que precisam
|
|
verificar se as páginas man estão corretas. Se um dos arquivos de entrada do
|
|
<B>lexgrog</B> for "-", ele lerá a partir da entrada padrão; se algum
|
|
arquivo de entrada estiver comprimido, uma versão descomprimida será lida
|
|
automaticamente.
|
|
<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>-m</B>, <B>--man</B>
|
|
|
|
|
|
<DD>
|
|
Analisa a entrada como arquivos-fontes de página man. Esse é o padrão se não
|
|
forem fornecidas as opções <B>--man</B> ou <B>--cat</B>.
|
|
<DT id="3"><B>-c</B>, <B>--cat</B>
|
|
|
|
|
|
<DD>
|
|
Analisa a entrada como páginas man pré-formatadas ("páginas cat"). As
|
|
opções <B>--man</B> e <B>--cat</B> não podem ser fornecidas simultaneamente.
|
|
<DT id="4"><B>-w</B>, <B>--whatis</B>
|
|
|
|
|
|
<DD>
|
|
Exibe o nome da descrição a partir do cabeçalho da página man, como usado
|
|
por <B>apropos</B> e <B>whatis</B>. Esse é o padrão se não forem fornecidas as
|
|
opções <B>--apropos</B> ou <B>--whatis</B>.
|
|
<DT id="5"><B>-f</B>, <B>--filters</B>
|
|
|
|
|
|
<DD>
|
|
Exibe a lista de filtros necessários para pré-processar a página man antes
|
|
de 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>
|
|
Sobrescreve o conjunto de caracteres adivinhado para a página usando
|
|
<I>codificação</I>.
|
|
<DT id="7"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Imprime uma mensagem de ajuda e sai.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Imprime uma mensagem curta e sai.
|
|
<DT id="9"><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="10"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Execução com sucesso do programa.
|
|
<DT id="11"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Erro de uso.
|
|
<DT id="12"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
<B>lexgrog</B> não conseguiu analisar um ou mais arquivos de entrada.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXEMPLOS</H2>
|
|
|
|
<PRE>
|
|
$ lexgrog man.1
|
|
man.1: "man - uma interface para os manuais de referência do sistema"
|
|
$ lexgrog -fw man.1
|
|
man.1 (t): "man - uma interface para os manuais de referência do sistema"
|
|
$ lexgrog -c whatis.cat1
|
|
whatis.cat1: "whatis - exibe descrições de uma linha de páginas de manual"
|
|
$ lexgrog broken.1
|
|
broken.1: parse failed
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ANÁLISE COM WHATIS</H2>
|
|
|
|
<B>mandb</B> (que usa o mesmo código que o <B>lexgrog</B>) analisa a seção <B>NAME</B>
|
|
no topo de cada página de manual procurando por nomes e descrições de
|
|
recursos documentados em cada um. Enquanto o analisador é bem tolerante, já
|
|
que ele tem que lidar com uma gama de formas diferentes que já se usou em
|
|
algum momento, ele pode falhar em alguns casos em extrair as informações
|
|
necessárias.
|
|
<P>
|
|
|
|
Ao usar o conjunto tradicional de macros do <I>man</I>, uma seção <B>NAME</B>
|
|
correta se parece com algo como isto:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<PRE>
|
|
<TT>.SH NAME
|
|
foo \- programa para fazer alguma coisa</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Alguns paginadores de manual exigem que '\-' seja exatamente como
|
|
mostrado; <B>mandb</B> é mais tolerante, mas, para que haja compatibilidade
|
|
com outros sistemas, ainda é uma boa ideia reter a barra invertida.
|
|
<P>
|
|
|
|
No lado esquerdo, pode haver vários nomes, separados por vírgulas. Nomes
|
|
contendo espaços em branco serão ignorados para evitar comportamento
|
|
patológico em certas seções <B>NAME</B> malformados. O texto no lado direito é
|
|
de formato livre, e pode se estendido por múltiplas linhas. Se vários
|
|
recursos com descrições diferentes estão sendo documentados na mesma página
|
|
de manual, então a seguinte forma é usado:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="14"><DD>
|
|
<PRE>
|
|
<TT>.SH NAME
|
|
foo, bar \- programas para fazer alguma coisa
|
|
.br
|
|
baz \- programas para fazer nada</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
(Uma macro que se inicia com um novo parágrafo, como a <TT>.PP</TT>, pode ser
|
|
usada em vez da macro de quebra de linha <TT>.br</TT>.)
|
|
<P>
|
|
|
|
Ao usar o conjunto de macros do <I>mdoc</I>, que é derivado do BSD, uma seção
|
|
<B>NAME</B> correta se parece com algo como isto:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="15"><DD>
|
|
<PRE>
|
|
<TT>.Sh NAME
|
|
.Nm foo
|
|
.Nd programa para fazer alguma coisa</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Há vários motivos comuns pelos quais a análise com whatis falha. Alguns
|
|
autores de páginas de manual substituem '.SH NAME' com '.SH
|
|
MEUPROGRAMA', e, então, <B>mandb</B> não é capaz de localizar a seção a
|
|
partir da qual se extrairia a informação que ele precisa. Alguns autores
|
|
incluem uma seção NAME, mas colocam um texto de forma livre ali em vez de
|
|
colocar em 'nome \- descrição'. Porém, qualquer sintaxe que se
|
|
assemelhe ao mencionado acima deve ser aceito.
|
|
<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 arquivos contendo requisições .so, mas só será
|
|
capaz de fazê-lo de forma correta se os arquivos estiverem instalados em uma
|
|
hierarquia de páginas de manual.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>AUTOR</H2>
|
|
|
|
O código usado por <B>lexgrog</B> para fazer uma varredura de páginas de manual
|
|
foi escrito por:
|
|
<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 versão atual do front-end da linha de comando, assim
|
|
como essa página de 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">STATUS DE SAÍDA</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">EXEMPLOS</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">ANÁLISE COM 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:20 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|