usr/src/man/man1/whatis.1

   1 '\" te
   2 .\" Copyright (c) 1992, Sun Microsystems, Inc.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH WHATIS 1 "Sep 14, 1992"
   7 .SH NAME
   8 whatis \- display a one-line summary about a keyword
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBwhatis\fR \fIcommand\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBwhatis\fR looks up a given \fIcommand\fR and displays the header line from
  19 the manual section. You can then run the \fBman\fR(1) command to get more
  20 information. If the line starts \fBname(\fIsection\fR)\fR.\|.\|. you can do
  21 \fBman\fR \fB-s\fR\fB\fIsection\fR name\fR to get the documentation for it.
  22 Try \fBwhatis ed\fR and then you should do \fBman\fR \fB-s\fR \fB1 ed\fR to get
  23 the manual page for \fBed\fR(1).
  24 .sp
  25 .LP
  26 \fBwhatis\fR is actually just the \fB-f\fR option to the \fBman\fR(1) command.
  27 .sp
  28 .LP
  29 \fBwhatis\fR uses the \fB/usr/share/man/windex\fR database.  This database is
  30 created by \fBcatman\fR(1M). If this database does not exist, \fBwhatis\fR will
  31 fail.
  32 .SH FILES
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fB/usr/share/man/windex\fR\fR
  37 .ad
  38 .RS 25n
  39 Table of contents and keyword database
  40 .RE
  41
  42 .SH ATTRIBUTES
  43 .sp
  44 .LP
  45 See \fBattributes\fR(5) for descriptions of the following attributes:
  46 .sp
  47
  48 .sp
  49 .TS
  50 box;
  51 c | c
  52 l | l .
  53 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  54 _
  55 CSI     Enabled
  56 .TE
  57
  58 .SH SEE ALSO
  59 .sp
  60 .LP
  61 \fBapropos\fR(1), \fBman\fR(1), \fBcatman\fR(1M), \fBattributes\fR(5)