Annotation of src/usr.bin/mandoc/whatis.1, Revision 1.5
1.5 ! schwarze 1: .\" $OpenBSD: whatis.1,v 1.4 2012/01/05 22:07:42 schwarze Exp $
1.1 schwarze 2: .\"
3: .\" Copyright (c) 1989, 1990, 1993
4: .\" The Regents of the University of California. All rights reserved.
5: .\"
6: .\" Redistribution and use in source and binary forms, with or without
7: .\" modification, are permitted provided that the following conditions
8: .\" are met:
9: .\" 1. Redistributions of source code must retain the above copyright
10: .\" notice, this list of conditions and the following disclaimer.
11: .\" 2. Redistributions in binary form must reproduce the above copyright
12: .\" notice, this list of conditions and the following disclaimer in the
13: .\" documentation and/or other materials provided with the distribution.
14: .\" 3. Neither the name of the University nor the names of its contributors
15: .\" may be used to endorse or promote products derived from this software
16: .\" without specific prior written permission.
17: .\"
18: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28: .\" SUCH DAMAGE.
29: .\"
30: .\" @(#)whatis.1 8.1 (Berkeley) 6/6/93
31: .\"
1.5 ! schwarze 32: .Dd $Mdocdate: January 5 2012 $
1.1 schwarze 33: .Dt WHATIS 1
34: .Os
35: .Sh NAME
36: .Nm whatis
37: .Nd describe what a command is
38: .Sh SYNOPSIS
39: .Nm whatis
40: .Op Fl C Ar file
41: .Op Fl M Ar path
42: .Op Fl m Ar path
1.2 schwarze 43: .Op Fl S Ar arch
44: .Op Fl s Ar section
1.4 schwarze 45: .Ar name ...
1.1 schwarze 46: .Sh DESCRIPTION
1.4 schwarze 47: The
1.1 schwarze 48: .Nm
1.4 schwarze 49: utility looks up the given commands and shows the header lines
50: from the manual pages.
1.1 schwarze 51: You can then use the
52: .Xr man 1
53: command to get more information.
54: .Nm
1.4 schwarze 55: will match manual page
56: .Ar names
57: on a case insensitive basis and for multiple word entries
1.1 schwarze 58: will match on each individual word.
59: .Pp
60: The options are as follows:
61: .Bl -tag -width Ds
62: .It Fl C Ar file
1.4 schwarze 63: Specify an alternate configuration
64: .Ar file
65: in
1.1 schwarze 66: .Xr man.conf 5
67: format.
68: The default is
69: .Pa /etc/man.conf .
70: .It Fl M Ar path
71: Override the list of standard directories
72: .Nm
73: searches for its database named
1.5 ! schwarze 74: .Dq Pa mandoc.db .
1.1 schwarze 75: The supplied
76: .Ar path
77: must be a colon
78: .Pq Ql \&:
79: separated list of directories.
80: This search path may also be set using the environment variable
81: .Ev MANPATH .
82: .It Fl m Ar path
83: Augment the list of standard directories
84: .Nm
85: searches for its database named
1.5 ! schwarze 86: .Dq Pa mandoc.db .
1.1 schwarze 87: The supplied
88: .Ar path
89: must be a colon-separated list of directories.
90: These directories will be searched before the standard directories
91: or the directories supplied with the
92: .Fl M
93: option or the
94: .Ev MANPATH
95: environment variable are searched.
1.2 schwarze 96: .It Fl S Ar arch
97: Restrict the search to pages for the specified
98: .Xr machine 1
99: architecture.
100: .Ar arch
101: is case insensitive.
102: By default, pages for all architectures are shown.
103: .It Fl s Ar section
104: Restrict the search to the specified section of the manual.
105: By default, pages from all sections are shown.
106: See
107: .Xr man 1
108: for a listing of sections.
1.1 schwarze 109: .El
110: .Sh ENVIRONMENT
111: .Bl -tag -width MANPATH
112: .It Ev MANPATH
113: The standard search path used by
114: .Xr man 1
1.2 schwarze 115: may be changed by specifying a path in the
1.1 schwarze 116: .Ev MANPATH
117: environment variable.
1.2 schwarze 118: If
119: .Ev MANPATH
120: begins with a colon, it is appended to the default list;
121: if it ends with a colon, it is prepended to the default list;
122: or if it contains two adjacent colons,
123: the standard search path is inserted between the colons.
124: If none of these conditions are met, it overrides the
125: standard search path.
1.1 schwarze 126: .El
127: .Sh FILES
128: .Bl -tag -width "/etc/man.conf" -compact
1.5 ! schwarze 129: .It Pa mandoc.db
1.2 schwarze 130: name of the
131: .Xr mandocdb 8
132: keyword database
1.5 ! schwarze 133: .It Pa mandoc.index
1.2 schwarze 134: name of the
135: .Xr mandocdb 8
136: filename database
1.1 schwarze 137: .It Pa /etc/man.conf
138: default
139: .Xr man 1
140: configuration file
141: .El
1.3 schwarze 142: .Sh EXIT STATUS
143: .Ex -std
1.1 schwarze 144: .Sh SEE ALSO
145: .Xr apropos 1 ,
146: .Xr man 1 ,
147: .Xr whereis 1 ,
148: .Xr which 1 ,
149: .Xr man.conf 5 ,
150: .Xr makewhatis 8
151: .Sh HISTORY
1.4 schwarze 152: Part of the functionality of
153: .Nm
154: was already provided by the former
155: .Nm manwhere
156: utility in
157: .Bx 1 .
1.1 schwarze 158: The
159: .Nm
160: command first appeared in
161: .Bx 2 .
1.3 schwarze 162: It was rewritten from scratch as part of the
163: .Xr mandocdb 8
164: project for
165: .Ox 5.1 .
1.1 schwarze 166: .Pp
167: The
168: .Fl M
1.3 schwarze 169: option and the
170: .Ev MANPATH
171: variable first appeared in
172: .Bx 4.3 ;
1.1 schwarze 173: .Fl m
174: in
175: .Bx 4.3 Reno ;
1.3 schwarze 176: .Fl C
177: in
178: .Nx 1.0 ;
1.1 schwarze 179: and
1.3 schwarze 180: .Fl S
181: and
182: .Fl s
1.1 schwarze 183: in
1.3 schwarze 184: .Ox 5.1 .
1.1 schwarze 185: .Sh AUTHORS
1.3 schwarze 186: .An -nosplit
1.1 schwarze 187: .An Bill Joy
1.4 schwarze 188: wrote
189: .Nm manwhere
190: in 1977
191: and the original
1.3 schwarze 192: .Bx
193: .Nm
194: in 1979.
195: The current version was written by
196: .An Kristaps Dzonsons ,
197: .Mt kristaps@bsd.lv .
![[BACK]](/icons/back.gif){kind=icon}
Return to whatis.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc