1 '\" te 2 .\" Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved 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 APROPOS 1 "Dec 20, 1996" 7 .SH NAME 8 apropos \- locate commands by keyword lookup 9 .SH SYNOPSIS 10 .LP 11 .nf 12 \fBapropos\fR \fIkeyword\fR... 13 .fi 14 15 .SH DESCRIPTION 16 .sp 17 .LP 18 The \fBapropos\fR utility displays the man page name, section number, and a 19 short description for each man page whose \fBNAME\fR line contains 20 \fIkeyword\fR. This information is contained in the \fB/usr/share/man/windex\fR 21 database created by \fBcatman\fR(1M). If \fBcatman\fR(1M) was not run, or was 22 run with the \fB-n\fR option, \fBapropos\fR fails. Each word is considered 23 separately and the case of letters is ignored. Words which are part of other 24 words are considered; for example, when looking for `compile', \fBapropos\fR 25 finds all instances of `compiler' also. 26 .sp 27 .LP 28 \fBapropos\fR is actually just the \fB-k\fR option to the \fBman\fR(1) command. 29 .SH EXAMPLES 30 .LP 31 \fBExample 1 \fRTo find a man page whose NAME line contains a keyword 32 .sp 33 .LP 34 Try 35 36 .sp 37 .in +2 38 .nf 39 example% \fBapropos password\fR 40 .fi 41 .in -2 42 .sp 43 44 .sp 45 .LP 46 and 47 48 .sp 49 .in +2 50 .nf 51 example% \fBapropos editor\fR 52 .fi 53 .in -2 54 .sp 55 56 .sp 57 .LP 58 If the line starts `\fIfilename\fR(\fIsection\fR) .\|.\|.' you can run 59 60 .sp 61 .in +2 62 .nf 63 man -s \fIsection filename\fR 64 .fi 65 .in -2 66 .sp 67 68 .sp 69 .LP 70 to display the man page for \fIfilename\fR. 71 72 .LP 73 \fBExample 2 \fRTo find the man page for the subroutine \fBprintf()\fR 74 .sp 75 .LP 76 Try 77 78 .sp 79 .in +2 80 .nf 81 example% \fBapropos format\fR 82 .fi 83 .in -2 84 .sp 85 86 .sp 87 .LP 88 and then 89 90 .sp 91 .in +2 92 .nf 93 example% \fBman -s 3s printf\fR 94 .fi 95 .in -2 96 .sp 97 98 .sp 99 .LP 100 to get the manual page on the subroutine \fBprintf()\fR. 101 102 .SH FILES 103 .sp 104 .ne 2 105 .na 106 \fB\fB/usr/share/man/windex\fR \fR 107 .ad 108 .RS 26n 109 table of contents and keyword database 110 .RE 111 112 .SH ATTRIBUTES 113 .sp 114 .LP 115 See \fBattributes\fR(5) for descriptions of the following attributes: 116 .sp 117 118 .sp 119 .TS 120 box; 121 c | c 122 l | l . 123 ATTRIBUTE TYPE ATTRIBUTE VALUE 124 _ 125 CSI Enabled 126 .TE 127 128 .SH SEE ALSO 129 .sp 130 .LP 131 \fBman\fR(1), \fBwhatis\fR(1), \fBcatman\fR(1M), \fBattributes\fR(5) 132 .SH DIAGNOSTICS 133 .sp 134 .ne 2 135 .na 136 \fB\f(CW/usr/share/man/windex: No such file or directory\fR\fR 137 .ad 138 .sp .6 139 .RS 4n 140 This database does not exist. \fBcatman\fR(1M) must be run to create it. 141 .RE 142