Annotation of src/usr.bin/mandoc/whatis.1, Revision 1.3
1.3 ! schwarze 1: .\" $OpenBSD: whatis.1,v 1.2 2011/12/26 12:45:58 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.3 ! schwarze 32: .Dd $Mdocdate: December 26 2011 $
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.1 schwarze 45: .Ar command ...
46: .Sh DESCRIPTION
47: .Nm
48: looks up a given command and gives the header line from the manual page.
49: You can then use the
50: .Xr man 1
51: command to get more information.
52: .Nm
53: will match on a case insensitive basis and for multiple word entries
54: will match on each individual word.
55: .Pp
56: The options are as follows:
57: .Bl -tag -width Ds
58: .It Fl C Ar file
59: Specify an alternate configuration file in
60: .Xr man.conf 5
61: format.
62: The default is
63: .Pa /etc/man.conf .
64: .It Fl M Ar path
65: Override the list of standard directories
66: .Nm
67: searches for its database named
68: .Dq Pa whatis.db .
69: The supplied
70: .Ar path
71: must be a colon
72: .Pq Ql \&:
73: separated list of directories.
74: This search path may also be set using the environment variable
75: .Ev MANPATH .
76: .It Fl m Ar path
77: Augment the list of standard directories
78: .Nm
79: searches for its database named
80: .Dq Pa whatis.db .
81: The supplied
82: .Ar path
83: must be a colon-separated list of directories.
84: These directories will be searched before the standard directories
85: or the directories supplied with the
86: .Fl M
87: option or the
88: .Ev MANPATH
89: environment variable are searched.
1.2 schwarze 90: .It Fl S Ar arch
91: Restrict the search to pages for the specified
92: .Xr machine 1
93: architecture.
94: .Ar arch
95: is case insensitive.
96: By default, pages for all architectures are shown.
97: .It Fl s Ar section
98: Restrict the search to the specified section of the manual.
99: By default, pages from all sections are shown.
100: See
101: .Xr man 1
102: for a listing of sections.
1.1 schwarze 103: .El
104: .Sh ENVIRONMENT
105: .Bl -tag -width MANPATH
106: .It Ev MANPATH
107: The standard search path used by
108: .Xr man 1
1.2 schwarze 109: may be changed by specifying a path in the
1.1 schwarze 110: .Ev MANPATH
111: environment variable.
1.2 schwarze 112: If
113: .Ev MANPATH
114: begins with a colon, it is appended to the default list;
115: if it ends with a colon, it is prepended to the default list;
116: or if it contains two adjacent colons,
117: the standard search path is inserted between the colons.
118: If none of these conditions are met, it overrides the
119: standard search path.
1.1 schwarze 120: .El
121: .Sh FILES
122: .Bl -tag -width "/etc/man.conf" -compact
123: .It Pa whatis.db
1.2 schwarze 124: name of the
125: .Xr mandocdb 8
126: keyword database
127: .It Pa whatis.index
128: name of the
129: .Xr mandocdb 8
130: filename database
1.1 schwarze 131: .It Pa /etc/man.conf
132: default
133: .Xr man 1
134: configuration file
135: .El
1.3 ! schwarze 136: .Sh EXIT STATUS
! 137: .Ex -std
1.1 schwarze 138: .Sh SEE ALSO
139: .Xr apropos 1 ,
140: .Xr man 1 ,
141: .Xr whereis 1 ,
142: .Xr which 1 ,
143: .Xr man.conf 5 ,
144: .Xr makewhatis 8
145: .Sh HISTORY
146: The
147: .Nm
148: command first appeared in
149: .Bx 2 .
1.3 ! schwarze 150: It was rewritten from scratch as part of the
! 151: .Xr mandocdb 8
! 152: project for
! 153: .Ox 5.1 .
1.1 schwarze 154: .Pp
155: The
156: .Fl M
1.3 ! schwarze 157: option and the
! 158: .Ev MANPATH
! 159: variable first appeared in
! 160: .Bx 4.3 ;
1.1 schwarze 161: .Fl m
162: in
163: .Bx 4.3 Reno ;
1.3 ! schwarze 164: .Fl C
! 165: in
! 166: .Nx 1.0 ;
1.1 schwarze 167: and
1.3 ! schwarze 168: .Fl S
! 169: and
! 170: .Fl s
1.1 schwarze 171: in
1.3 ! schwarze 172: .Ox 5.1 .
1.1 schwarze 173: .Sh AUTHORS
1.3 ! schwarze 174: .An -nosplit
1.1 schwarze 175: .An Bill Joy
1.3 ! schwarze 176: wrote the original
! 177: .Bx
! 178: .Nm
! 179: in 1979.
! 180: The current version was written by
! 181: .An Kristaps Dzonsons ,
! 182: .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