lexgrog - Online na nuvem

PROGRAMA:

NOME

lexgrog - analisa as informações do cabeçalho nas páginas do manual

SINOPSE

Lexgrog [-m|-c] [-dfw? V] [-E codificação] lima ...

DESCRIÇÃO

Lexgrog é uma implementação do utilitário tradicional "groff guess" em lex. Lê
a lista de arquivos em sua linha de comando como arquivos fonte da página de manual ou pré-formatados
Páginas "cat" e exibe seu nome e descrição conforme usado por a propósito e o que é,
lista de filtros de pré-processamento exigidos pela página de manual antes de ser passada para nroff or
troff, ou ambos.

Se sua entrada estiver formatada incorretamente, Lexgrog irá imprimir “análise falhou”; isso pode ser útil para
programas externos que precisam verificar as páginas do manual quanto à exatidão. Se um de Lexgrogentrada de
os arquivos são “-”, serão lidos na entrada padrão; se algum arquivo de entrada for compactado, um
a versão descompactada será lida automaticamente.

OPÇÕES

-d, --depurar
Imprima informações de depuração.

-m, --cara
Analisa a entrada como arquivos de origem da página de manual. Este é o padrão se nenhum --cara nem
--gato é dada.

-c, --gato
Analisa a entrada como páginas de manual pré-formatadas (“páginas cat”). --cara e --gato talvez não seja
dado simultaneamente.

-w, --o que é
Exibe o nome e a descrição do cabeçalho da página do manual, conforme usado por a propósito e
o que é. Este é o padrão se nenhum --o que é nem --filtros é dada.

-f, --filtros
Mostra a lista de filtros necessários para pré-processar a página do manual antes de formatar
com nroff or troff.

-E codificação, --codificação codificação
Substitua o conjunto de caracteres adivinhados para a página para codificação.

-?, --Socorro
Imprima uma mensagem de ajuda e saia.

--uso
Imprima uma mensagem curta de uso e saia.

-V, --versão
Exibir informações da versão.

SAIR STATUS

0 Execução do programa com sucesso.

1 Erro de uso.

2 Lexgrog falhou ao analisar um ou mais de seus arquivos de entrada.

EXEMPLOS

$ lexgrog homem.1
man.1: "man - uma interface para os manuais de referência on-line"
$ lexgrog -fw homem.1
man.1 (t): "man - uma interface para os manuais de referência on-line"
$ lexgrog -c whatis.cat1
whatis.cat1: "whatis - exibe as descrições das páginas do manual"
$ lexgrog quebrado.1
quebrado.1: análise falhou

O QUE É ANÁLISE

mandb (que usa o mesmo código que Lexgrog) analisa o NOME seção no topo de cada
página do manual procurando nomes e descrições dos recursos documentados em cada um. Enquanto
o analisador é bastante tolerante, pois tem que lidar com uma série de formas diferentes que têm
historicamente usado, às vezes pode falhar ao extrair as informações necessárias.

Ao usar o tradicional homem conjunto de macro, um correto NOME seção parece algo como
esta:

.SH NOME
foo \ - programa para fazer algo

Alguns pagers manuais exigem que '\ -' seja exatamente como mostrado; mandb é mais tolerante, mas
para compatibilidade com outros sistemas, no entanto, é uma boa idéia manter o
barra invertida.

No lado esquerdo, podem haver vários nomes, separados por vírgulas. Nomes contendo
espaços em branco serão ignorados para evitar comportamento patológico em certas malformadas NOME
Seções. O texto do lado direito é de forma livre e pode ser distribuído por vários
linhas. Se vários recursos com descrições diferentes estão sendo documentados no mesmo
página de manual, o seguinte formulário é, portanto, usado:

.SH NOME
foo, bar \ - programas para fazer algo
.br
baz \ - programa para não fazer nada

(Uma macro que inicia um novo parágrafo, como .PP, pode ser usada em vez da macro de quebra
.br.)

Ao usar o derivado de BSD mdoc conjunto de macro, um correto NOME seção parece algo como
esta:

.Sh NOME
.Nm foo
.Nd programa para fazer algo

Existem vários motivos comuns pelos quais a análise de whatis falha. Às vezes, os autores do manual
páginas substituem '.SH NAME' por '.SH MYPROGRAM', e então mandb não consigo encontrar a seção de
qual extrair as informações de que precisa. Às vezes, os autores incluem uma seção NAME, mas
coloque texto de forma livre lá em vez de 'nome \ - descrição'. No entanto, qualquer sintaxe
semelhante ao acima deve ser aceito.

Use lexgrog online usando serviços onworks.net