Man page - lexgrog(1)

Packages contains this manual

Available languages:

en fr pt_BR es pl pt ko nl da tr sv ja uk id ru ro sr zh_CN de

Manual

LEXGROG

NOME
SINOPSE
DESCRIƇƃO
OPƇƕES
STATUS DE SAƍDA
EXEMPLOS
ANƁLISE COM WHATIS
VEJA TAMBƉM
NOTAS
AUTOR
PROBLEMAS

NOME

lexgrog - analisa informaƧƵes do cabeƧalho em pƔginas man

SINOPSE

lexgrog [ -m | -c ] [ -dfw?V ] [ -E codificaĆ§Ć£o ] arquivo ...

DESCRIƇƃO

lexgrog Ć© uma implementaĆ§Ć£o do utilitĆ”rio ā€œgroff guessā€ tradicional em lex . 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 apropos e whatis . A lista de filtros de prĆ©-processamento sĆ£o exigidos pela pĆ”gina man antes dela ser passada para nroff ou troff , ou ambos.

Se sua entrada estiver mal formatada, lexgrog 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 lexgrog for ā€œ-ā€, ele lerĆ” a partir da entrada padrĆ£o; se algum arquivo de entrada estiver comprimido, uma versĆ£o descomprimida serĆ” lida automaticamente.

OPƇƕES

-d , --debug

Emite mensagens de depuraĆ§Ć£o.

-m , --man

Analisa a entrada como arquivos-fontes de pĆ”gina man. Esse Ć© o padrĆ£o se nĆ£o forem fornecidas as opƧƵes --man ou --cat .

-c , --cat

Analisa a entrada como pĆ”ginas man prĆ©-formatadas (ā€œpĆ”ginas catā€). As opƧƵes --man e --cat nĆ£o podem ser fornecidas simultaneamente.

-w , --whatis

Exibe o nome da descriĆ§Ć£o a partir do cabeƧalho da pĆ”gina man, como usado por apropos e whatis . Esse Ć© o padrĆ£o se nĆ£o forem fornecidas as opƧƵes --apropos ou --whatis .

-f , --filters

Exibe a lista de filtros necessƔrios para prƩ-processar a pƔgina man antes de formatar com nroff ou troff .

-E codificaĆ§Ć£o , --encoding codificaĆ§Ć£o

Sobrescreve o conjunto de caracteres adivinhado para a pĆ”gina usando codificaĆ§Ć£o .

-? , --help

Imprime uma mensagem de ajuda e sai.

--usage

Imprime uma mensagem curta e sai.

-V , --version

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

STATUS DE SAƍDA

0

ExecuĆ§Ć£o com sucesso do programa.

1

Erro de uso.

2

lexgrog nĆ£o conseguiu analisar um ou mais arquivos de entrada.

EXEMPLOS

$ 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

ANƁLISE COM WHATIS

mandb (que usa o mesmo cĆ³digo que o lexgrog ) analisa a seĆ§Ć£o NAME 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.

Ao usar o conjunto tradicional de macros do man , uma seĆ§Ć£o NAME correta se parece com algo como isto:

.SH NAME
foo \- programa para fazer alguma coisa

Alguns paginadores de manual exigem que ā€˜\-ā€™ seja exatamente como mostrado; mandb Ć© mais tolerante, mas, para que haja compatibilidade com outros sistemas, ainda Ć© uma boa ideia reter a barra invertida.

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 NAME 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:

.SH NAME
foo, bar \- programas para fazer alguma coisa
.br
baz \- programas para fazer nada

(Uma macro que se inicia com um novo parƔgrafo, como a .PP , pode ser usada em vez da macro de quebra de linha .br .)

Ao usar o conjunto de macros do mdoc , que Ć© derivado do BSD, uma seĆ§Ć£o NAME correta se parece com algo como isto:

.Sh NAME
.Nm foo
.Nd programa para fazer alguma coisa

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, mandb 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.

VEJA TAMBƉM

apropos (1), man (1), whatis (1), mandb (8)

NOTAS

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

AUTOR

O cĆ³digo usado por lexgrog para fazer uma varredura de pĆ”ginas de manual foi escrito por:

Wilf. (G.Wilford@ee.surrey.ac.uk).
Fabrizio Polacco (fpolacco@debian.org).
Colin Watson (cjwatson@debian.org).

Colin Watson escreveu a versĆ£o atual do front-end da linha de comando, assim como essa pĆ”gina de manual.

PROBLEMAS

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