Annotation of src/usr.bin/whatis/whatis.1, Revision 1.17
1.17 ! schwarze 1: .\" $OpenBSD: whatis.1,v 1.16 2011/10/09 14:39:49 jmc Exp $
1.2 deraadt 2: .\"
1.1 deraadt 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.
1.10 millert 14: .\" 3. Neither the name of the University nor the names of its contributors
1.1 deraadt 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.16 jmc 32: .Dd $Mdocdate: October 9 2011 $
1.1 deraadt 33: .Dt WHATIS 1
1.4 aaron 34: .Os
1.1 deraadt 35: .Sh NAME
36: .Nm whatis
37: .Nd describe what a command is
38: .Sh SYNOPSIS
39: .Nm whatis
1.12 jmc 40: .Op Fl C Ar file
1.1 deraadt 41: .Op Fl M Ar path
42: .Op Fl m Ar path
1.14 sobrado 43: .Ar command ...
1.1 deraadt 44: .Sh DESCRIPTION
1.17 ! schwarze 45: The
1.6 aaron 46: .Nm
1.17 ! schwarze 47: utility looks up the given commands and shows the header lines
! 48: from the manual pages.
1.1 deraadt 49: You can then use the
50: .Xr man 1
51: command to get more information.
1.7 millert 52: .Nm
53: will match on a case insensitive basis and for multiple word entries
54: will match on each individual word.
1.1 deraadt 55: .Pp
56: The options are as follows:
1.8 aaron 57: .Bl -tag -width Ds
1.7 millert 58: .It Fl C Ar file
1.17 ! schwarze 59: Specify an alternate configuration
! 60: .Ar file
! 61: in
1.7 millert 62: .Xr man.conf 5
1.11 jmc 63: format.
64: The default is
1.7 millert 65: .Pa /etc/man.conf .
1.1 deraadt 66: .It Fl M Ar path
67: Override the list of standard directories
1.6 aaron 68: .Nm
1.1 deraadt 69: searches for its database named
70: .Dq Pa whatis.db .
71: The supplied
72: .Ar path
73: must be a colon
1.6 aaron 74: .Pq Ql \&:
1.1 deraadt 75: separated list of directories.
76: This search path may also be set using the environment variable
77: .Ev MANPATH .
78: .It Fl m Ar path
79: Augment the list of standard directories
1.6 aaron 80: .Nm
1.1 deraadt 81: searches for its database named
82: .Dq Pa whatis.db .
83: The supplied
84: .Ar path
1.6 aaron 85: must be a colon-separated list of directories.
1.1 deraadt 86: These directories will be searched before the standard directories
87: or the directories supplied with the
88: .Fl M
89: option or the
90: .Ev MANPATH
91: environment variable are searched.
92: .El
93: .Sh ENVIRONMENT
94: .Bl -tag -width MANPATH
95: .It Ev MANPATH
96: The standard search path used by
97: .Xr man 1
98: may be overridden by specifying a path in the
99: .Ev MANPATH
100: environment variable.
101: .El
102: .Sh FILES
1.12 jmc 103: .Bl -tag -width "/etc/man.conf" -compact
1.1 deraadt 104: .It Pa whatis.db
105: name of the whatis database
1.12 jmc 106: .It Pa /etc/man.conf
107: default
108: .Xr man 1
109: configuration file
1.1 deraadt 110: .El
111: .Sh SEE ALSO
112: .Xr apropos 1 ,
113: .Xr man 1 ,
1.5 aaron 114: .Xr whereis 1 ,
1.7 millert 115: .Xr which 1 ,
1.12 jmc 116: .Xr man.conf 5 ,
117: .Xr makewhatis 8
1.1 deraadt 118: .Sh HISTORY
1.17 ! schwarze 119: Part of the functionality of
! 120: .Nm
! 121: was already provided by the former
! 122: .Nm manwhere
! 123: utility in
! 124: .Bx 1 .
1.1 deraadt 125: The
126: .Nm
1.15 schwarze 127: command first appeared in
128: .Bx 2 .
1.16 jmc 129: .Pp
1.15 schwarze 130: The
131: .Fl M
1.17 ! schwarze 132: option and the
! 133: .Ev MANPATH
! 134: variable first appeared in
! 135: .Bx 4.3 ;
1.15 schwarze 136: .Fl m
137: in
138: .Bx 4.3 Reno ;
139: and
140: .Fl C
141: in
1.17 ! schwarze 142: .Bx 4.4 Lite1 .
1.15 schwarze 143: .Sh AUTHORS
144: .An Bill Joy
1.17 ! schwarze 145: wrote
! 146: .Nm manwhere
! 147: in 1977
! 148: and the original
! 149: .Bx
! 150: .Nm
! 151: in February 1979.
![[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 / whatis