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)

   1 .\"
   2 .\" This file and its contents are supplied under the terms of the
   3 .\" Common Development and Distribution License ("CDDL"), version 1.0.
   4 .\" You may only use this file in accordance with the terms of version
   5 .\" 1.0 of the CDDL.
   6 .\"
   7 .\" A full copy of the text of the CDDL should have accompanied this
   8 .\" source.  A copy of the CDDL is also available via the Internet at
   9 .\" http://www.illumos.org/license/CDDL.
  10 .\"
  11 .\"
  12 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
  13 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  14 .\"
  15 .Dd Jul 13, 2014
  16 .Dt APROPOS 1
  17 .Os
  18 .Sh NAME
  19 .Nm apropos ,
  20 .Nm whatis
  21 .Nd keyword search in
  22 .Nm whatis
  23 database files
  24 .Sh SYNOPSIS
  25 .Nm
  26 .Op Fl M Ar path
  27 .Op Fl s Ar section
  28 .Ar keyword ...
  29 .Nm whatis
  30 .Op Fl M Ar path
  31 .Op Fl s Ar section
  32 .Ar keyword ...
  33 .Sh DESCRIPTION
  34 The
  35 .Nm
  36 utility searches a set of
  37 .Nm whatis
  38 database files matching each
  39 .Ar keyword .
  40 The
  41 .Nm whatis
  42 utility does the same search but only on complete words. The
  43 .Nm whatis
  44 database files are created using
  45 .Xr man 1
  46 command.
  47 .Bl -tag -width ".Fl d"
  48 .It Fl M Ar path
  49 Force a specific colon separated manual path instead of the default search path.
  50 Overrides the
  51 .Ev MANPATH
  52 environment variable.
  53 .It Fl s Ar section
  54 Restrict search to specified
  55 .Ar section .
  56 .El
  57 .Sh ENVIRONMENT
  58 The following environment variables affect the execution of
  59 .Nm :
  60 .Bl -tag -width ".Ev MANPATH , PATH"
  61 .It Ev MANPATH , PATH
  62 Used to find the location of the
  63 .Nm whatis
  64 database files.
  65 .El
  66 .Sh DIAGNOSTICS
  67 The
  68 .Nm
  69 utility exits 0 if a keyword matched and 1 if no keywords are matched or no
  70 .Nm whatis
  71 databases are found.
  72 .Sh INTERFACE STABILITY
  73 Committed.
  74 .Sh CODE SET INDEPENDENCE
  75 Enabled.
  76 .Sh SEE ALSO
  77 .Xr man 1 ,
  78 .Xr mandoc 1