usr/src/man/man1b/whereis.1b

   1 '\" te
   2 .\" Copyright (c) 2000, 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 WHEREIS 1B "Jan 10, 2000"
   7 .SH NAME
   8 whereis \- locate the binary, source, and manual page files for a command
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/ucb/whereis\fR [\fB-bmsu\fR] [\fB-BMS\fR \fIdirectory\fR... \fB-f\fR] \fIfilename\fR...
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBwhereis\fR utility locates source/binary and manuals sections for
  19 specified files. The supplied names are first stripped of leading pathname
  20 components and any (single) trailing extension of the form \fB\&.\fR\fIext\fR,
  21 for example, \fB\&.c\fR. Prefixes of \fBs.\fR resulting from use of source code
  22 control are also dealt with. \fBwhereis\fR then attempts to locate the desired
  23 program in a list of standard places:
  24 .sp
  25 .in +2
  26 .nf
  27 \fBetc
  28 /sbin
  29 /usr/bin
  30 /usr/ccs/bin
  31 /usr/ccs/lib
  32 /usr/lang
  33 /usr/lbin
  34 /usr/lib
  35 /usr/sbin
  36 /usr/ucb
  37 /usr/ucblib
  38 /usr/ucbinclude
  39 /usr/games
  40 /usr/local
  41 /usr/local/bin
  42 /usr/new
  43 /usr/old
  44 /usr/hosts
  45 /usr/include
  46 /usr/etc\fR
  47 .fi
  48 .in -2
  49 .sp
  50
  51 .SH OPTIONS
  52 .sp
  53 .LP
  54 The following options are supported:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fB-b\fR\fR
  59 .ad
  60 .RS 6n
  61 Searches only for binaries.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fB-B\fR\fR
  68 .ad
  69 .RS 6n
  70 Changes or otherwise limits the places where \fBwhereis\fR searches for
  71 binaries.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fB-f\fR\fR
  78 .ad
  79 .RS 6n
  80 Terminates the last directory list and signals the start of file names, and
  81 \fImust\fR be used when any of the \fB-B\fR, \fB-M\fR, or \fB-S\fR options are
  82 used.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fB-m\fR\fR
  89 .ad
  90 .RS 6n
  91 Searches only for manual sections.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fB\fB-M\fR\fR
  98 .ad
  99 .RS 6n
 100 Changes or otherwise limits the places where \fBwhereis\fR searches for manual
 101 sections.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB-s\fR\fR
 108 .ad
 109 .RS 6n
 110 Searches only for sources.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB-S\fR\fR
 117 .ad
 118 .RS 6n
 119 Changes or otherwise limit the places where \fBwhereis\fR searches for sources.
 120 .RE
 121
 122 .sp
 123 .ne 2
 124 .na
 125 \fB\fB-u\fR\fR
 126 .ad
 127 .RS 6n
 128 Searches for unusual entries. A file is said to be unusual if it does not have
 129 one entry of each requested type. Thus `\fBwhereis\fR \fB-m\fR \fB-u\fR
 130 \fB*\fR' asks for those files in the current directory which have no
 131 documentation.
 132 .RE
 133
 134 .SH EXAMPLES
 135 .LP
 136 \fBExample 1 \fRFinding files
 137 .sp
 138 .LP
 139 Find all files in \fB/usr/bin\fR which are not documented in
 140 \fB/usr/share/man/man1\fR with source in \fB/usr/src/cmd\fR:
 141
 142 .sp
 143 .in +2
 144 .nf
 145 example% \fBcd /usr/ucb\fR
 146 example% \fBwhereis -u -M /usr/share/man/man1 -S /usr/src/cmd -f *\fR
 147 .fi
 148 .in -2
 149 .sp
 150
 151 .SH FILES
 152 .RS +4
 153 .TP
 154 .ie t \(bu
 155 .el o
 156 \fB/usr/src/*\fR
 157 .RE
 158 .RS +4
 159 .TP
 160 .ie t \(bu
 161 .el o
 162 \fB/usr/{doc,man}/*\fR
 163 .RE
 164 .RS +4
 165 .TP
 166 .ie t \(bu
 167 .el o
 168 \fB/etc, /usr/{lib,bin,ucb,old,new,local}\fR
 169 .RE
 170 .SH SEE ALSO
 171 .sp
 172 .LP
 173 \fBchdir\fR(2), \fBattributes\fR(5)
 174 .SH BUGS
 175 .sp
 176 .LP
 177 Since \fBwhereis\fR uses \fBchdir\fR(2) to run faster, pathnames given with the
 178 \fB-M\fR, \fB-S\fR, or \fB-B\fR must be full; that is, they must begin with a
 179 `\fB/\fR'.