xref: /illumos-gate/usr/src/man/man8/catman.8 (revision 8119dad84d6416f13557b0ba8e2aaf9064cbcfd3)
1.\"
2.\" This file and its contents are supplied under the terms of the
3.\" Common Development and Distribution License ("CDDL"), version 1.0.
4.\" You may only use this file in accordance with the terms of version
5.\" 1.0 of the CDDL.
6.\"
7.\" A full copy of the text of the CDDL should have accompanied this
8.\" source.  A copy of the CDDL is also available via the Internet at
9.\" http://www.illumos.org/license/CDDL.
10.\"
11.\"
12.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
13.\"
14.Dd April 9, 2016
15.Dt CATMAN 8
16.Os
17.Sh NAME
18.Nm catman
19.Nd generate
20.Nm whatis
21database files
22.Sh SYNOPSIS
23.Nm
24.Op Fl M Ar path
25.Op Fl w
26.Sh DESCRIPTION
27The
28.Nm
29utility generates a set of
30.Nm whatis
31database files suitable for use with
32.Xr apropos 1
33and
34.Xr whatis 1 .
35It is supplied for compatibility reasons.
36The same databases can be generated using the
37.Fl w
38option with
39.Xr man 1 ,
40and that command should be used instead.
41.Sh OPTIONS
42.Bl -tag -width ".Fl d"
43.It Fl M Ar path
44Generate the
45.Nm whatis
46database files within the specified colon separated manual paths.
47Overrides the
48.Ev MANPATH
49environment variable.
50.It Fl w
51This option is present for backwards compatibility, and is ignored.
52.El
53.Sh ENVIRONMENT
54The following environment variables affect the execution of
55.Nm :
56.Bl -tag -width ".Ev MANPATH"
57.It Ev MANPATH
58Used to specify a colon separated list of manual paths within
59which to generate
60.Nm whatis
61database files.
62.El
63.Sh EXIT STATUS
64.Ex -std
65.Sh INTERFACE STABILITY
66.Nm "Obsolete Committed" .
67.Sh CODE SET INDEPENDENCE
68Enabled.
69.Sh SEE ALSO
70.Xr apropos 1 ,
71.Xr man 1 ,
72.Xr whatis 1
73