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 18, 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 the
  45 .Xr man 1
  46 command.
  47 .Sh OPTIONS
  48 .Bl -tag -width ".Fl d"
  49 .It Fl M Ar path
  50 Force a specific colon separated manual path instead of the default search path.
  51 Overrides the
  52 .Ev MANPATH
  53 environment variable.
  54 .It Fl s Ar section
  55 Restrict search to specified
  56 .Ar section .
  57 .El
  58 .Sh ENVIRONMENT
  59 The following environment variables affect the execution of
  60 .Nm :
  61 .Bl -tag -width ".Ev MANPATH , PATH"
  62 .It Ev MANPATH , PATH
  63 Used to find the location of the
  64 .Nm whatis
  65 database files.
  66 .El
  67 .Sh DIAGNOSTICS
  68 The
  69 .Nm
  70 utility exits 0 if a keyword matched and 1 if no keywords are matched or no
  71 .Nm whatis
  72 databases are found.
  73 .Sh INTERFACE STABILITY
  74 .Nm Committed .
  75 .Sh CODE SET INDEPENDENCE
  76 Enabled.
  77 .Sh SEE ALSO
  78 .Xr man 1 ,
  79 .Xr mandoc 1