*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->HP-UX 11i man pages -> catman (1m)              


 catman(1M)                                                       catman(1M)

 NAME    [Toc]    [Back]
      catman - create the cat files for the manual

 SYNOPSIS    [Toc]    [Back]
      /usr/sbin/catman [-A alt-path] [-p] [-m] [-n] [-w] [-z] [sections]

 DESCRIPTION    [Toc]    [Back]
      The catman command creates the formatted versions of the online manual
      from nroff(1)-compatible source files.  Each manual entry in the
      man*.Z and man* directories is examined, and those whose formatted
      versions are missing or out-of-date are recreated.  catman formats the
      most recent of the entries, compresses it, and puts it into the
      appropriate cat*.Z directory.

      If any changes are made, catman recreates the /usr/share/lib/whatis
      database.  By default, the /usr/share/lib/whatis database is
      overwritten.  If the MANPATH environment variable is set to a nondefault
 set of paths, the old database file is saved in
      /usr/share/lib/whatis.old so that, if desired, the system
      administrator may merge them together.

      By default, catman searches the man*.Z and man* subdirectories under
      the following man directories:
           +  /usr/share/man
           +  /usr/contrib/man
           +  /usr/local/man
      If MANPATH is set in the environment, the directories given in MANPATH
      are checked instead of the default.  See environ(5) for a description
      of the MANPATH environment variable.

      Before running catman, remove any existing cat* directories.  If the
      -z option is used, cat*.Z directories should be removed instead.  If
      both cat*.Z and cat* directories exist, man(1) updates both
      directories and more space is used.

      Any command-line parameters not starting with - are interpreted as a
      list of manual sections (directories) to search.  For example:

           catman 123

      restricts updating to manual sections 1, 2, and 3 (directories man1,
      man2, and man3).

    Options    [Toc]    [Back]
      catman supports the following options:

           -m             Create a merged /usr/share/lib/whatis database;
                          i.e., information on new manual entries (added
                          since the last time catman was run) is merged into
                          the current database rather than overwriting it.
                          Ignored if selected with the -n option.

 Hewlett-Packard Company            - 1 -   HP-UX 11i Version 2: August 2003

 catman(1M)                                                       catman(1M)

           -n             Prevents creation of /usr/share/lib/whatis.

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

           -w             Causes only the /usr/share/lib/whatis database to
                          be created.  No manual reformatting is done.

           -z             Puts the formatted entries in the cat* directories
                          rather than in the cat*.Z directories.

           -A alt-path    Perform actions based on the given alternate root.
                          With this option, alt-path will be prepended to
                          all directory paths, including default paths, the
                          paths defined by MANPATH, and the path to

    Environment Variables
      MANPATH defines parent directories to be used when searching man* and
      man*.Z directories.

 WARNINGS    [Toc]    [Back]
      If unformatted manual entries (those in the ../man* subdirectories)
      have been removed since the last time catman was run, information in
      the /usr/share/lib/whatis database may be lost.  The -m option may be
      used to override this, but may result in repeated lines in the
      database for the same manual entry.

 EXAMPLES    [Toc]    [Back]
      Create uncompressed cat* files for sections 1 and 1m of the manual,
      but don't create the /usr/share/lib/whatis database:

           catman -z -n 11m

      Run catman from a server to create cat* entries for a diskless client
      under the alternate root /export/shared_roots/OS_700:

           catman -A /export/shared_roots/OS_700

      This will create cat* manpages under:


      and a whatis file in:


      Create cat* entries for an application and merge the information with
      the /usr/share/lib/whatis database:

 Hewlett-Packard Company            - 2 -   HP-UX 11i Version 2: August 2003

 catman(1M)                                                       catman(1M)

           catman -m

      Note that you may wish to save MANPATH before doing this, so as not to
      lose your current MANPATH.

 AUTHOR    [Toc]    [Back]
      catman was developed by HP and the University of California, Berkeley.

 FILES    [Toc]    [Back]
      /usr/share/man/man*[.Z]/*     Unformatted (nroff(1)-compatible source)
                                    manual entry files [compressed].
      /usr/share/man/cat*[.Z]/*     Formatted manual pages [compressed].
      /usr/share/lib/whatis         Database of manpage entry summaries;
                                    utilized by the man -k command.
      /usr/lbin/mkwhatis            Command to make whatis database.

 SEE ALSO    [Toc]    [Back]
      compress(1), fixman(1M), man(1), environ(5).

 Hewlett-Packard Company            - 3 -   HP-UX 11i Version 2: August 2003
[ Back ]
 Similar pages
Name OS Title
catman Linux create or update the pre-formatted manual pages
mandb Linux create or update the manual page index caches
man HP-UX find manual information by keywords; print out a manual entry
whereis Linux locate the binary, source, and manual page files for a command
dcl2inc Linux postprocess ftnchek .dcl files to create separate INCLUDE files
mkboot OpenBSD create LIF files
mknod HP-UX create special files
badsect OpenBSD create files to contain bad sectors
dpkg-scanpackages Linux create Packages files
badsect FreeBSD create files to contain bad sectors
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service