LEXGROG(1)            Utilidades de paginador del manual            LEXGROG(1)

NOMBRE
       lexgrog - analiza la informacion de cabecera en paginas man

SINOPSIS
       lexgrog [-m|-c] [-dfw?V] [-E codificacion] archivo ...

DESCRIPCION
       lexgrog es una implementacion de la tradicional utilidad "groff guess"
       en lex.  Lee la lista de archivos en su linea de ordenes bien como
       archivos fuente de pagina man, bien como paginas preformateadas "cat",
       y muestra su nombre y descripcion como se utilizo por apropos y whatis,
       la lista de filtros preprocesados requeridos por la pagina man antes de
       que sea pasada por nroff o troff, o ambos.

       Si esta entrada esta formateada equivocadamente, lexgrog escribira
       "parse fallado"; esto puede ser util para programas externos que
       necesiten comprobar la correccion de paginas man.  Si uno de los
       archivos de entrada de lexgrog es "-", leera desde la entrada estandar;
       si algun archivo de entrada esta comprimido, se leera automaticamente
       una version descomprimida.

OPCIONES
       -d, --debug
              Escribe informacion de depuracion.

       -m, --man
              Interpreta la entrada como archivos fuente de pagina man.  Esto
              es lo predefinido si ni --man ni --cat es dado.

       -c, --cat
              Entrada interpretada como paginas ("cat") man preformateadas.
              --man y --cat pueden no darse simultaneamente.

       -w, --whatis
              Muestra el nombre y la descripcion desde la cabecera de la
              pagina man, tal y como la usan apropos y whatis.  Esto es lo
              predeterminado si ni --watis ni --filters esta dado.

       -f, --filters
              Muestra la lista de filtros necesarios para preprocesar la
              pagina man antes de formatear con nroff o troff.

       -E codificacion, --encoding codificacion
              Anula el conjunto de caracteres supuesto para la pagina
              sustituyendolo por codificacion.

       -?, --help
              Escribe un mensaje de ayuda y termina.

       --usage
              Escribe mensaje breve sobre uso del programa y termina.

       -V, --version
              Muestra informacion sobre la version.

ESTADO DE SALIDA
       0      Ejecucion del programa correcta.

       1      Error de uso.

       2      lexgrog fallo al analizar uno o varios de sus archivos de
              entrada.

EJEMPLOS
         $ lexgrog man.1
         man.1: <<man - interfaz para los manuales de referencia del sistema>>
         $ lexgrog -fw man.1
         man.1 (t): <<man - interfaz para los manuales de referencia del sistema>>
         $ lexgrog -c whatis.cat1
         whatis.cat1: <<whatis - muestra las descripciones de las paginas de manual>>
         $ lexgrog broken.1
         broken.1: fallo del analizador

ANALISIS WHATIS
       mandb (el cual emplea el mismo codigo que lexgrog)  analiza la seccion
       NOMBRE situada en la parte superior de cada pagina de manual buscando
       nombres y descripciones de las caracteristicas documentadas en cada
       una.  Aunque el analizador es bastante tolerante, como tiene que hacer
       frente a un gran numero de formatos diferentes que historicamente se
       han empleado, algunas veces puede fallar al extraer la informacion
       requerida.

       Al utilizar el conjunto de macros tradicional de man, una seccion
       correcta NOMBRE tiene el siguiente aspecto:

              .SH NAME
              foo \- program to do something

       Algunos paginadores del manual requieren que la `\-' este exactamente
       como se muestra; mandb es mas tolerante; sin embargo, por
       compatibilidad con otros sistemas, no es buena idea retener la barra
       invertida.

       En el lado izquierdo puede haber varios nombres separados por comas.
       Los nombres que contengan espacios en blanco seran ignorados para
       evitar comportamiento patologico en ciertas secciones NOMBRE mal
       formadas.  El texto en el lado derecho tiene formato libre y puede
       ocupar varias lineas.  Si se estan documentando diversas
       caracteristicas con descripciones diferentes en la misma pagina de
       manual, en tal caso se utiliza la siguiente forma:

              .SH NAME
              foo, bar \- programs to do something
              .br
              baz \- program to do nothing

       (A macro which starts a new paragraph, like .PP, may be used instead of
       the break macro .br.)

       Cuando se utiliza el conjunto de macros mdoc derivadas de BSD, una
       seccion NOMBRE correcta tiene el siguiente aspecto:

              .Sh NAME
              .Nm foo
              .Nd program to do something

       Hay distintas razones por las que el analisis de whatis suele fallar.
       A veces los autores de las paginas de manual sustituyen  `.SH NOMBRE'
       por `.SH MIPROGRAMA', y entonces mandb no puede encontrar la seccion
       desde la cual extraer la informacion que necesita.  A veces los autores
       incluyen una seccion NOMBRE, pero colocan texto en formato-libre en
       lugar de `name \- description'.  Sin embargo, deberia aceptarse
       cualquier sintaxis parecida a la de arriba.

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

ANOTACIONES
       lexgrog trata de analizar archivos que contienen peticiones .so, pero
       solo podra hacerlo correctamente si los archivos estan debidamente
       instalados en la jerarquia de una pagina de manual.

AUTOR
       El codigo utilizado por lexgrog para analizar paginas man fue escrito
       por:

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

       Colin Watson escribio la actual encarnacion del frontal de la linea de
       ordenes, asi como esta pagina man.

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

2.12.1                            2024-04-05                        LEXGROG(1)