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