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

   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 .pc
  12 .TH %thcatman% 8 "%date%" "%version%" "Manual pager utils"
  13 .SH NAME
  14 %catman% \- create or update the pre-formatted manual pages
  15 .SH SYNOPSIS
  16 .B %catman%
  17 .RB [\| \-d?V \|]
  18 .RB [\| \-M
  19 .IR path \|]
  20 .RB [\| \-C
  21 .IR file \|]
  22 .RI [\| section \|]
  23 \&.\|.\|.
  24 .SH DESCRIPTION
  25 .B %catman%
  26 is used to create an up to date set of pre-formatted manual pages known as
  27 cat pages.
  28 Cat pages are generally much faster to display than the original
  29 manual pages, but require extra storage space.
  30 The decision to support cat pages is that of the local administrator, who
  31 must provide suitable directories to contain them.
  32
  33 The options available to
  34 .B %catman%
  35 are the manual page hierarchies and sections to pre-format.
  36 The default hierarchies are those specified as system hierarchies in the
  37 man-db configuration file, and the default sections are either the
  38 colon-delimited contents of the environment variable
  39 .RB $ MANSECT
  40 or the standard set compiled into
  41 .B %man%
  42 if
  43 .RB $ MANSECT
  44 is undefined.
  45 Supplying
  46 .B %catman%
  47 with a set of whitespace-delimited section names will override both of
  48 the above.
  49
  50 .B %catman%
  51 makes use of the
  52 .B index
  53 database cache associated with each hierarchy to determine which files
  54 need to be formatted.
  55 .SH OPTIONS
  56 .TP
  57 .if !'po4a'hide' .BR \-d ", " \-\-debug
  58 Print debugging information.
  59 .TP
  60 .BI \-M\  path \fR,\ \fB\-\-manpath= path
  61 Specify an alternate colon-delimited manual page hierarchy search path.
  62 By default, this is all paths indicated as system hierarchies
  63 in the man-db configuration file.
  64 .TP
  65 .BI \-C\  file \fR,\ \fB\-\-config\-file= file
  66 Use this user configuration file rather than the default of
  67 .IR ~/.manpath .
  68 .TP
  69 .if !'po4a'hide' .BR \-? ", " \-\-help
  70 Print a help message and exit.
  71 .TP
  72 .if !'po4a'hide' .B \-\-usage
  73 Print a short usage message and exit.
  74 .TP
  75 .if !'po4a'hide' .BR \-V ", " \-\-version
  76 Display version information.
  77 .SH ENVIRONMENT
  78 .TP
  79 .if !'po4a'hide' .B MANSECT
  80 If
  81 .RB $ MANSECT
  82 is set, its value is a colon-delimited list of sections and it is used to
  83 determine which manual sections to search and in what order.
  84 The default is "%sections%", unless overridden by the
  85 .B SECTION
  86 directive in
  87 .IR %manpath_config_file% .
  88 .TP
  89 .if !'po4a'hide' .B MANPATH
  90 If
  91 .RB $ MANPATH
  92 is set, its value is interpreted as the colon-delimited manual page
  93 hierarchy search path to use.
  94
  95 See the
  96 .B SEARCH PATH
  97 section of
  98 .BR manpath (5)
  99 for the default behaviour and details of how this environment variable is
 100 handled.
 101 .SH FILES
 102 .TP
 103 .if !'po4a'hide' .I %manpath_config_file%
 104 man-db configuration file.
 105 .TP
 106 .if !'po4a'hide' .I /usr/man/index.(bt|db|dir|pag)
 107 A traditional global
 108 .I index
 109 database cache.
 110 .TP
 111 .if !'po4a'hide' .I /var/catman/index.(bt|db|dir|pag)
 112 An alternate or FSSTND
 113 compliant global
 114 .I index
 115 database cache.
 116 .SH "SEE ALSO"
 117 .if !'po4a'hide' .BR %man% (1),
 118 .if !'po4a'hide' .BR manpath (5),
 119 .if !'po4a'hide' .BR %mandb% (8)
 120 .SH AUTHOR
 121 .nf
 122 .if !'po4a'hide' Wilf.\& (G.Wilford@ee.surrey.ac.uk).
 123 .if !'po4a'hide' Fabrizio Polacco (fpolacco@debian.org).
 124 .if !'po4a'hide' Colin Watson (cjwatson@debian.org).
 125 .fi
 126 .SH BUGS
 127 .if !'po4a'hide' https://gitlab.com/cjwatson/man-db/-/issues
 128 .br
 129 .if !'po4a'hide' https://savannah.nongnu.org/bugs/?group=man-db