lexgrog - parse header information in man pages
lexgrog [-m|-c] [-dfw?V] [-E encoding] file ...
lexgrog is an implementation of the traditional "groff guess" utility in lex. It reads the list of files on its command line as either man page source files or preformatted "cat" pages, and displays their name and description as used by apropos and whatis, the list of preprocessing filters required by the man page before it is passed to nroff or troff, or both. If its input is badly formatted, lexgrog will print "parse failed"; this may be useful for external programs that need to check man pages for correctness. If one of lexgrog's input files is "-", it will read from standard input; if any input file is compressed, a decompressed version will be read automatically.
-d, --debug Print debugging information. -m, --man Parse input as man page source files. This is the default if neither --man nor --cat is given. -c, --cat Parse input as preformatted man pages ("cat pages"). --man and --cat may not be given simultaneously. -w, --whatis Display the name and description from the man page's header, as used by apropos and whatis. This is the default if neither --whatis nor --filters is given. -f, --filters Display the list of filters needed to preprocess the man page before formatting with nroff or troff. -E encoding, --encoding encoding Override the guessed character set for the page to encoding. -?, --help Print a help message and exit. --usage Print a short usage message and exit. -V, --version Display version information.
0 Successful program execution. 1 Usage error. 2 lexgrog failed to parse one or more of its input files.
$ lexgrog man.1 man.1: "man - an interface to the on-line reference manuals" $ lexgrog -fw man.1 man.1 (t): "man - an interface to the on-line reference manuals" $ lexgrog -c whatis.cat1 whatis.cat1: "whatis - display manual page descriptions" $ lexgrog broken.1 broken.1: parse failed
mandb (which uses the same code as lexgrog) parses the NAME section at the top of each manual page looking for names and descriptions of the features documented in each. While the parser is quite tolerant, as it has to cope with a number of different forms that have historically been used, it may sometimes fail to extract the required information. When using the traditional man macro set, a correct NAME section looks something like this: .SH NAME foo \- program to do something Some manual pagers require the '\-' to be exactly as shown; mandb is more tolerant, but for compatibility with other systems it is nevertheless a good idea to retain the backslash. On the left-hand side, there may be several names, separated by commas. Names containing whitespace will be ignored to avoid pathological behaviour on certain ill-formed NAME sections. The text on the right- hand side is free-form, and may be spread over multiple lines. If several features with different descriptions are being documented in the same manual page, the following form is therefore used: .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.) When using the BSD-derived mdoc macro set, a correct NAME section looks something like this: .Sh NAME .Nm foo .Nd program to do something There are several common reasons why whatis parsing fails. Sometimes authors of manual pages replace '.SH NAME' with '.SH MYPROGRAM', and then mandb cannot find the section from which to extract the information it needs. Sometimes authors include a NAME section, but place free-form text there rather than 'name \- description'. However, any syntax resembling the above should be accepted.
apropos(1), man(1), whatis(1), mandb(8)
lexgrog attempts to parse files containing .so requests, but will only be able to do so correctly if the files are properly installed in a manual page hierarchy.
The code used by lexgrog to scan man pages was written by: Wilf. (G.Wilford@ee.surrey.ac.uk). Fabrizio Polacco (email@example.com). Colin Watson (firstname.lastname@example.org). Colin Watson wrote the current incarnation of the command-line front- end, as well as this man page.
More Linux Commands
pgmtoy4m(1) - Convert mpeg2dec pgm and pgmpipe output to YUV
pgmtoy4m repacks the PGM output from mpeg2dec into YUV4MPEG2 4:2:0p. No actual changes to the data are made. The data is unpacked from the quasi-PGM format and
sane-sceptre(5) - SANE backend for SCEPTRE scanners.........
The sane-sceptre library implements a SANE (Scanner Access Now Easy) backend that provides access to Sceptre flatbed scanners. This backend should be considered
tcl_traceCompile(n) Variables used by Tcl __________________
The following global variables are created and managed automatically by the Tcl library. Except where noted below, these variables should normally be treated as
systemd-suspend.service(8) System sleep state logic.........
systemd-suspend.service is a system service that is pulled in by suspend.target and is responsible for the actual system suspend. Similarly, systemd-hibernate.s
realpath(3) - return the canonicalized absolute pathname....
realpath() expands all symbolic links and resolves references to /./, /../ and extra / characters in the null-terminated string named by path to produce a canon
xdg-desktop-icon(1) - command line tool for (un)installing i
The xdg-desktop-icon program can be used to install an application launcher or other file on the desktop of the current user. An application launcher is represe
XOpenDevice(3) - open or close an extension input device....
The XOpenDevice request makes an input device accessible to a client through input extension protocol requests. If successful, it returns a pointer to an XDevic
gcc-4.8(1) GNU project C and C compiler - Linux manual page
When you invoke GCC, it normally does preprocessing, compilation, assembly and linking. The overall options allow you to stop this process at an intermediate st
podofoxmp(1) Modify or extract XMP information from a PDF fi
podofoxmp is one of the command line tools from the PoDoFo library that provide several useful operations to work with PDF files. It can extract or modify XMP i
malloc_set_state(3) record and restore state of malloc imple
The malloc_get_state() function records the current state of all malloc(3) internal bookkeeping variables (but not the actual contents of the heap or the state
sane-u12(5) - SANE backend for Plustek USB flatbed scanners,
The sane-u12 library implements a SANE (Scanner Access Now Easy) backend that provides access to USB flatbed scanners based on Plusteks ASIC 98003 (parallel-por
vorbiscomment(1) - List or edit comments in Ogg Vorbis files
vorbiscomment Reads, modifies, and appends Ogg Vorbis audio file metadata tags. OPTIONS -a, --append Append comments. -c file, --commentfile file Take comments