catman(1M)                                                       catman(1M)

NAME
     catman - create the "cat" files for the online man pages

SYNOPSIS
     /usr/bin/catman [-v] [-f] [-n] [-m manpathdot] [-u] [-d altmandb]

DESCRIPTION
     The catman commands create the preformatted versions of the online man
     page from the nroff(1M) input files. Each man page is examined and
     those whose preformatted versions are missing or out of date are
     recreated. If any changes are made, catman recreates the mandb data-
     base.

OPTIONS
     -v   The -v option turns on debug.

     -f   The -f option forces "cat" pages to be built, even if the "cat"
          page is newer.

     -n   If the -n option is set, German umlauts in the nroff source files
          are replaced by ae, oe, ue, etc.

     -u   If the -u option is given, catman will only attempt to rebuild
          all mandb files along the $MANPATH.

     -d   If the -d option is given, catman will NOT attempt to rebuild any
          mandb file along the $MANPATH. It will use the altmandb to
          determine what should be built, and how to build it (neqn, tbl,
          ...).

     The directory search for man pages is controlled by the $MANPATH envi-
     ronment variable, or its default:

          /usr/share/man/mrd:/usr/share/man:/usr/share/man/mrd/$LANG

     One of 2 methods will be used to look for man pages, based on whether
     or not the top level directory contains a .mandb directory.

     If no .mandb subdirectory is found, man pages are assumed to be all
     files under subdirectories beginning with man or ending with man.

     If a .mandb subdirectory is found, then the file mandb will be used to
     locate man pages. If mandb does not exist, or is older than the modif-
     ication time of .mandb, then mandb will be constructed from all files
     under .mandb. The mandb file is used to locate man pages.

     NOTE:  Even though altmandb may be an absolute path, the paths within
            it must be relative to the $MANPATH location. The $MANPATH
            location must have a .mandb directory, though its contents are
            not used explicitly.





Page 1                       Reliant UNIX 5.44                Printed 11/98

catman(1M)                                                       catman(1M)

     This utility makes use of both "cat" pages from man pages. A man page
     is an nroff file written with the man macro set. A "cat" page is
     formed by formatting a man page with nroff.

     A "cat" page path is of the form:

          ./catman/somepath/filename.Z

     corresponds to a man page of the form:

          ./somepath/filename

     where "." is the top level search directory. If the option -m
     manpathdot is used, then the corresponding man page is:

          manpathdot/somepath/filename

     By default, all "cat" pages that are older than existing and corre-
     sponding man pages are rebuilt. The -f option forces all "cat" pages
     corresponding to existing man pages to be rebuilt.

NOTES
     catman analyzes the following data from the header of the nroff source
     files to create the mandb: title, section, and shortcomment [cf.
     man(1)]. For example:

          .nr X 2
          .if \nX=0 .ds x} title section "" ""
          .if \nX=1 .ds x} title section ""
          .if \nX=2 .ds x} title section "" "\&"
          .TH \*(x}
          .SH NAME
          title \- shortcomment

ENVIRONMENT
     MANPATH   Path under which a search is performed for the mandb and the
               preformatted man pages. Default:

               /usr/share/man/mrd:/usr/share/man:/usr/share/man/mrd/$LANG.

     LANG      Environment variable for the language setting. Default:
               EnUS.ASCII.

     NROFF     The nroff formatter used is taken from the $NROFF environ-
               ment variable. If $NROFF does not exist, or is empty, then
               /usr/ucb/nroff or /usr/bin/nroff (if /usr/ucb/nroff does not
               exist) will be used.







Page 2                       Reliant UNIX 5.44                Printed 11/98

catman(1M)                                                       catman(1M)

FILES
     /usr/share/man/mrd
          Default manual directory location

     /usr/share/man/mrd/EnUS.ASCII
          Directory for the English mandb and the preformatted man pages

     /usr/share/man/mrd/DeDE.646
          Directory for the German mandb and the preformatted man pages

     /usr/share/man/mrd/$LANG/mandb
          Path containing the complete mandb

     /usr/share/man/mrd/$LANG/.mandb
          Directory containing the man pages belonging to add-on packages
          (required for the complete mandb)

     /usr/share/man/mrd/$LANG/catman
          Directory containing the preformatted and compressed man pages
          (filename.Z)

SEE ALSO
     man(1), man(1-ucb), neqn(1M), nroff(1M), tbl(1M), man(5).































Page 3                       Reliant UNIX 5.44                Printed 11/98