catman(1M-BSD)    MISC. REFERENCE MANUAL PAGES     catman(1M-BSD)



NAME
     catman - create the cat files for the manual

SYNOPSIS
     /usr/ucb/catman [ -nptw ] [ -M directory ] [ -T tmac.an ]  [
     sections ]

DESCRIPTION
     The catman commands creates the preformatted versions of the
     on-line  manual  from the nroff(1) 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 subdirec-
          tories instead of nroffing into the cat subdirectories.

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

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

     -T   Use tmac.an in place of the standard manual  page  mac-
          ros.

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

FILES
     /usr/share/man                default manual directory loca-
                                   tion
     /usr/share/man/X11            X window default manual direc-
                                   tory location
     /usr/share/man/Motif          Motif default manual directory
                                   location
     /usr/share/man/man?/*.*       raw (nroff input) manual  sec-
                                   tions
     /usr/share/man/cat?/*.*       preformatted  nroffed   manual
                                   pages
     /usr/share/man/fmt?/*.*       preformatted  troffed   manual



                                                                1

catman(1M-BSD)    MISC. REFERENCE MANUAL PAGES     catman(1M-BSD)



                                   pages
     /usr/share/man/bsdman?/*.*   BSD raw (nroff  input)  manual
                                   sections
     /usr/share/man/bsdcat?/*.*   preformatted    BSD    nroffed
                                   manual pages
     /usr/share/man/bsdfmt?/*.*   preformatted    BSD    troffed
                                   manual pages
     /usr/share/man/whatis         whatis database location
     /usr/share/man/X11/whatis     X window whatis database loca-
                                   tion
     /usr/share/man/Motif/whatis   Motif whatis database location
     /usr/ucblib/makewhatis        command script to make  whatis
                                   database

SEE ALSO
     man(1), nroff(1), troff(1), whatis(1)

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/share/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.

     /usr/ucblib/makewhatis: whatis: cannot create
          you need to have  write  permission  to  the  following
          default           directories:          /usr/share/man,
          /usr/share/man/X11,  and  /usr/share/man/Motif  or  the
          directory specified by the -M option.
















                                                                2