Print this page
feedback from Hans
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/man/man1/apropos.1
+++ new/usr/src/man/man1/apropos.1
1 1 .\"
2 2 .\" This file and its contents are supplied under the terms of the
3 3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
4 4 .\" You may only use this file in accordance with the terms of version
5 5 .\" 1.0 of the CDDL.
6 6 .\"
7 7 .\" A full copy of the text of the CDDL should have accompanied this
8 8 .\" source. A copy of the CDDL is also available via the Internet at
9 9 .\" http://www.illumos.org/license/CDDL.
10 10 .\"
11 11 .\"
12 12 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
13 13 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
14 14 .\"
15 15 .Dd Jul 13, 2014
16 16 .Dt APROPOS 1
17 17 .Os
18 18 .Sh NAME
19 19 .Nm apropos ,
20 20 .Nm whatis
21 21 .Nd keyword search in
22 22 .Nm whatis
23 23 database files
24 24 .Sh SYNOPSIS
25 25 .Nm
26 26 .Op Fl M Ar path
27 27 .Op Fl s Ar section
28 28 .Ar keyword ...
29 29 .Nm whatis
30 30 .Op Fl M Ar path
31 31 .Op Fl s Ar section
32 32 .Ar keyword ...
33 33 .Sh DESCRIPTION
34 34 The
35 35 .Nm
36 36 utility searches a set of
37 37 .Nm whatis
38 38 database files matching each
39 39 .Ar keyword .
40 40 The
41 41 .Nm whatis
42 42 utility does the same search but only on complete words. The
43 43 .Nm whatis
44 44 database files are created using
45 45 .Xr man 1
46 46 command.
47 47 .Bl -tag -width ".Fl d"
48 48 .It Fl M Ar path
49 49 Force a specific colon separated manual path instead of the default search path.
50 50 Overrides the
51 51 .Ev MANPATH
52 52 environment variable.
53 53 .It Fl s Ar section
54 54 Restrict search to specified
55 55 .Ar section .
56 56 .El
57 57 .Sh ENVIRONMENT
58 58 The following environment variables affect the execution of
59 59 .Nm :
60 60 .Bl -tag -width ".Ev MANPATH , PATH"
61 61 .It Ev MANPATH , PATH
62 62 Used to find the location of the
↓ open down ↓ |
62 lines elided |
↑ open up ↑ |
63 63 .Nm whatis
64 64 database files.
65 65 .El
66 66 .Sh DIAGNOSTICS
67 67 The
68 68 .Nm
69 69 utility exits 0 if a keyword matched and 1 if no keywords are matched or no
70 70 .Nm whatis
71 71 databases are found.
72 72 .Sh INTERFACE STABILITY
73 -Committed.
73 +.Nm Committed .
74 74 .Sh CODE SET INDEPENDENCE
75 75 Enabled.
76 76 .Sh SEE ALSO
77 77 .Xr man 1 ,
78 78 .Xr mandoc 1
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX