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