catman(1M_BSD)       (BSD System Compatibility)       catman(1M_BSD)


       NAME
             catman - (BSD) create the cat files and whatis database for
             the manual

       SYNOPSIS
             /usr/ucb/catman [-nptw] [-M directory] [-T mac_file] [sections]

       DESCRIPTION
             The catman command creates the preformatted versions of the
             online manual from the nroff(1BSD) input files.  Each manual
             page is examined and those whose preformatted versions are
             missing or out of date are recreated.  If any changes are
             made, catman recreates the whatis database.

             If there is one parameter not starting with a ``-'', it is
             taken to be a list of manual sections to look in.  For example
                   catman 123

             only updates manual sections 1, 2, and 3.

             The following options are available:

             -n    Do not (re)create the whatis database.

             -p    Print what would be done instead of doing it.

             -t    Create troffed entries in the appropriate fmt
                   subdirectories instead of nroffing into the cat
                   subdirectories.

             -w    Only create the whatis database.  No manual reformatting
                   is done.

             -M    Update manual pages located in the specified directory
                   (/usr/share/man by default).

             -T    Use mac_file in place of the standard manual page
                   macros.

          Files
             /usr/share/man                default manual directory
             /usr/share/man/man?/*.*       raw (nroff/troff input) manual
                                           pages
             /usr/share/man/cat?/*.*       preformatted nroffed manual
                                           pages



                           Copyright 1994 Novell, Inc.               Page 1

      catman(1M_BSD)       (BSD System Compatibility)       catman(1M_BSD)


            /usr/share/man/fmt?/*.*       preformatted troffed manual
                                          pages
            /usr/share/man/whatis         whatis database
            /usr/ucblib/makewhatis        command script to make whatis
                                          database

         Environment Variables
            TROFF     The name of the formatter to use when the -t flag is
                      given.  If not set, ``troff'' is used.

         Diagnostics
            man?/xxx.? (.so'ed from man?/yyy.?): No such file or directory
                  The file outside the parentheses is missing, and is
                  referred to by the file inside them.

            target of .so in man?/xxx.? must be relative to /usr/man
                  catman only allows references to filenames that are
                  relative to the directory /usr/share/man.

            opendir:man?: No such file or directory
                  A harmless warning message indicating that one of the
                  directories catman normally looks for is missing.

            *.*: No such file or directory
                  A harmless warning message indicating catman came across
                  an empty directory.

      USAGE
            catman and man assume that manual pages are named with an
            alphanumeric extension, as in the following: cat.1, uucp.1c,
            open.2, string.3s.

            Here's how to add new pages to the cat directories and update
            the whatis database (in directory /usr/share/man):

                  Save the original whatis database:

                              cp /usr/share/man/whatis /usr/share/man/whatis.bak

                  Place the new pages in the appropriate  man  directories
                  with    appropriate   names,   such   as   man1/addme.1,
                  man4/metoo.4.

                  Run catman to nroff the pages into the  appropriate  cat
                  directories  and  create  a  new  whatis  database.  (By



                          Copyright 1994 Novell, Inc.               Page 2

       catman(1M_BSD)       (BSD System Compatibility)       catman(1M_BSD)


                   default, nroff is in /usr/ucb.)

                               catman -p       # show what catman would do
                               catman          # do it

                   Sort together the original and the new whatis files into
                   a new whatis database:

                               sort -o whatis -df whatis whatis.bak

       REFERENCES
             man(1), nroff(1BSD), troff(1BSD), whatis(1BSD)




































                           Copyright 1994 Novell, Inc.               Page 3