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 .Nm Committed . 74 .Sh CODE SET INDEPENDENCE 75 Enabled. 76 .Sh SEE ALSO 77 .Xr man 1 , 78 .Xr mandoc 1