projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| b8489f53 | 1 | .\" Copyright (c) 1980, 1987 Regents of the University of California. |
| ff5e54c1 KM |
2 | .\" All rights reserved. The Berkeley software License Agreement |
| 3 | .\" specifies the terms and conditions for redistribution. | |
| 4 | .\" | |
| b8489f53 | 5 | .\" @(#)whatis.1 6.4 (Berkeley) %G% |
| ff5e54c1 | 6 | .\" |
| 5e1ce5c1 | 7 | .TH WHATIS 1 "" |
| ff5e54c1 KM |
8 | .UC 4 |
| 9 | .SH NAME | |
| 10 | whatis \- describe what a command is | |
| 11 | .SH SYNOPSIS | |
| 12 | .B whatis | |
| b8489f53 KB |
13 | [ |
| 14 | .B -M | |
| 15 | .I path | |
| 16 | ] | |
| ff5e54c1 KM |
17 | command ... |
| 18 | .SH DESCRIPTION | |
| b8489f53 KB |
19 | \fIWhatis\fP looks up a given command and gives the header line from the |
| 20 | manual page. You can then use the \fIman\fP(1) command to get more | |
| 21 | information. | |
| ff5e54c1 | 22 | .PP |
| b8489f53 KB |
23 | Normally \fIwhatis\fP checks in a standard location (/usr/man) for its |
| 24 | database ``whatis''. This can be changed by supplying a \fIpath\fP (a | |
| 25 | la the Bourne shell) with the \fB-M\fP flag. This search path must be | |
| 26 | a colon (``:'') separated list of directories which \fIwhatis\fP will | |
| 27 | search for files named ``whatis''. The path can also be set with the | |
| 28 | environmental variable \fIMANPATH\fP. | |
| ff5e54c1 KM |
29 | .SH FILES |
| 30 | .DT | |
| b8489f53 | 31 | /usr/man/whatis data base |
| ff5e54c1 | 32 | .SH "SEE ALSO" |
| b8489f53 | 33 | apropos(1), man(1) |