Penguin
Recent Changes
Annotated edit history of catman(8) version 1, including all changes. View license author blame.
Rev Author # Line
1 perry 1 catman
2 !!!catman
3 NAME
4 SYNOPSIS
5 DESCRIPTION
6 OPTIONS
7 ENVIRONMENT
8 FILES
9 SEE ALSO
10 AUTHOR
11 ----
12 !!NAME
13
14
15 catman - create or update the pre-formatted manual pages
16 !!SYNOPSIS
17
18
19 __catman__ [[__-dhV__] [[__-M__ ''path'']
20 [[''section''] ...
21 !!DESCRIPTION
22
23
24 __catman__ is used to create an up to date set of
25 pre-formatted manual pages known as cat pages. Cat pages are
26 generally much faster to display than the original manual
27 pages, but require extra storage space. The decision to
28 support cat pages is that of the local administrator, who
29 must provide suitable directories to contain
30 them.
31
32
33 The options available to __catman__ are the manual page
34 hierarchies and sections to pre-format. The default
35 hierarchies are those specified as system hierarchies in the
36 man_db configuration file, and the default sections are
37 either the colon-delimited contents of the environment
38 variable $__MANSECT__ or the standard set compiled into
39 __man__ if $__MANSECT__ is undefined. Supplying
40 __catman__ with a set of whitespace-delimited section
41 names will override both of the above.
42
43
44 __catman__ makes use of the __index__ database cache
45 associated with each hierarchy to determine which files need
46 to be formatted.
47 !!OPTIONS
48
49
50 __-d, --debug__
51
52
53 Print debugging information.
54
55
56 __-M__ ''path''__,
57 --manpath=__''path''
58
59
60 Specify an alternate colon-delimited manual page hierarchy
61 search path. By default, this is all paths indicated as
62 system hierarchies in the man_db configuration
63 file.
64
65
66 __-h, --help__
67
68
69 Print a help message and exit.
70
71
72 __-V, --version__
73
74
75 Display version information.
76 !!ENVIRONMENT
77
78
79 __MANSECT__
80
81
82 If $__MANSECT__ is set, its value is a colon-delimited
83 list of sections and it is used to determine which manual
84 sections to search and in what order.
85
86
87 __MANPATH__
88
89
90 If $__MANPATH__ is set, its value is interpreted as the
91 colon-delimited manual page hierarchy search path to
92 use.
93 !!FILES
94
95
96 ''/etc/manpath.config''
97
98
99 man_db configuration file.
100
101
102 ''/usr/man/index.(bt|db|dir|pag)''
103
104
105 A traditional global ''index'' database
106 cache.
107
108
109 ''/var/catman/index.(bt|db|dir|pag)''
110
111
112 An alternate or FSSTND compliant global ''index''
113 database cache.
114 !!SEE ALSO
115
116
117 man(1), manpath(5),
118 mandb(8).
119 !!AUTHOR
120
121
122 Wilf. (G.Wilford@ee.surrey.ac.uk).
123 Fabrizio Polacco (fpolacco@debian.org).
124 ----
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.