manual/man-db/original/man8/catman.8

   1 .\" Man page for catman
   2 .\"
   3 .\" Copyright (C), 1994, 1995, Graeme W. Wilford. (Wilf.)
   4 .\"
   5 .\" You may distribute under the terms of the GNU General Public
   6 .\" License as specified in the file COPYING that comes with the
   7 .\" man_db distribution.
   8 .\"
   9 .\" Sat Dec 10 14:17:29 GMT 1994  Wilf. (G.Wilford@ee.surrey.ac.uk)
  10 .\"
  11 .TH catman 8 "July 12th, 1995" "2.3.10" "Manual pager utils"
  12 .SH NAME
  13 catman \- create or update the pre-formatted manual pages
  14 .SH SYNOPSIS
  15 .B catman
  16 .RB [\| \-dhV \|]
  17 .RB [\| \-M
  18 .IR path \|]
  19 .RI [\| section \|]
  20 \&.\|.\|.
  21 .SH DESCRIPTION
  22 .B catman
  23 is used to create an up to date set of pre-formatted manual pages known as
  24 cat pages.
  25 Cat pages are generally much faster to display than the original
  26 manual pages, but require extra storage space. The decision to
  27 support cat pages is that of the local administrator, who must provide
  28 suitable directories to contain them.
  29
  30 The options available to
  31 .B catman
  32 are the manual page hierarchies and sections to pre-format. The
  33 default hierarchies are those specified as `global' in the man_db
  34 configuration file and the default sections are either
  35 the colon delimited contents of the environment variable
  36 .RB $ MANSECT
  37 or the standard set compiled into
  38 .B man
  39 if
  40 .RB $ MANSECT
  41 is undefined. Supplying
  42 .B catman
  43 with a set of whitespace delimited section names will override both of
  44 the above.
  45
  46 .B catman
  47 makes use of the
  48 .B index
  49 database cache associated with each hierarchy to determine which files
  50 need to be formatted.
  51 .SH OPTIONS
  52 .TP
  53 .B \-d, \-\-debug
  54 Print debugging information.
  55 .TP
  56 .BI \-M\  path ,\ \-\-manpath= path
  57 Specify an alternate colon delimited manual page hierarchy search path.
  58 By default, this is all paths indicated as `global'
  59 in the man_db configuration file.
  60 .TP
  61 .B \-h, \-\-help
  62 Print a help message and exit.
  63 .TP
  64 .B \-V, \-\-version
  65 Display version and author information.
  66 .SH ENVIRONMENT
  67 .TP
  68 .B MANSECT
  69 If
  70 .RB $ MANSECT
  71 is set, its value is a colon delimited list of sections and it is used to
  72 determine which manual sections to search and in what order.
  73 .TP
  74 .B MANPATH
  75 If
  76 .RB $ MANPATH
  77 is set, its value is interpreted as the colon delimited, manual page
  78 hierarchy search path to use.
  79 .SH FILES
  80 .TP
  81 .I /usr/local/etc/man_db.config
  82 man_db configuration file.
  83 .TP
  84 .I /usr/man/index.(bt|db|dir|pag)
  85 A traditional global
  86 .I index
  87 database cache.
  88 .TP
  89 .I /var/catman/index.(bt|db|dir|pag)
  90 An alternate or FSSTND
  91 compliant global
  92 .I index
  93 database cache.
  94 .SH "SEE ALSO"
  95 .BR man (1),
  96 .BR manpath (5),
  97 .BR mandb (8).
  98 .SH AUTHOR
  99 Wilf. (G.Wilford@ee.surrey.ac.uk)