usr.bin/whereis/whereis.1

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Copyright 2002      Joerg Wunsch
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)whereis.1   8.2 (Berkeley) 12/30/93
  31 .\"
  32 .\" $FreeBSD: src/usr.bin/whereis/whereis.1,v 1.21 2002/11/26 17:33:36 ru Exp $
  33 .\"
  34 .Dd October 10, 2014
  35 .Dt WHEREIS 1
  36 .Os
  37 .Sh NAME
  38 .Nm whereis
  39 .Nd locate programs
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl abmqsux
  43 .Op Fl BMS Ar dir ... Fl f
  44 .Ar program ...
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility checks the standard binary, manual page, and source
  49 directories for the specified programs, printing out the paths of any
  50 it finds.
  51 The supplied program names are first stripped of leading
  52 path name components, any single trailing extension added by
  53 .Xr gzip 1 ,
  54 .Xr compress 1 ,
  55 or
  56 .Xr bzip2 1 ,
  57 and the leading
  58 .Ql s.\&
  59 or trailing
  60 .Ql ,v
  61 from a source code control system.
  62 .Pp
  63 The default path searched is the string returned by the
  64 .Xr sysctl 8
  65 utility for the
  66 .Va user.cs_path
  67 string, with
  68 .Pa /usr/libexec ,
  69 .Pa /usr/games
  70 and the current user's
  71 .Ev $PATH
  72 appended.
  73 Manual pages are searched by default along the
  74 .Ev $MANPATH .
  75 Program sources are located in a list of known standard places,
  76 including all the subdirectories of
  77 .Pa /usr/src
  78 and
  79 .Pa /usr/dports .
  80 .Pp
  81 The following options are available:
  82 .Bl -tag -width indent
  83 .It Fl B
  84 Specify directories to search for binaries.
  85 Requires the
  86 .Fl f
  87 option.
  88 .It Fl M
  89 Specify directories to search for manual pages.
  90 Requires the
  91 .Fl f
  92 option.
  93 .It Fl S
  94 Specify directories to search for program sources.  Requires the
  95 .Fl f
  96 option.
  97 .It Fl a
  98 Report all matches instead of only the first of each requested type.
  99 .It Fl b
 100 Search for binaries.
 101 .It Fl f
 102 Delimits the list of directories after the
 103 .Fl B ,
 104 .Fl M ,
 105 or
 106 .Fl S
 107 options, and indicates the beginning of the
 108 .Ar program
 109 list.
 110 .It Fl m
 111 Search for manual pages.
 112 .It Fl q
 113 .Pq Dq quiet .
 114 Suppress the output of the utility name in front of the normal
 115 output line.
 116 This can become handy for use in a backquote substitution of a
 117 shell command line, see
 118 .Sx EXAMPLES .
 119 .It Fl s
 120 Search for source directories.
 121 .It Fl u
 122 Search for
 123 .Dq unusual
 124 entries.
 125 A file is said to be unusual if it does not have at least
 126 one entry of each requested type.
 127 Only the name of the unusual entry is printed.
 128 .It Fl x
 129 Do not use
 130 .Dq expensive
 131 tools when searching for source directories.
 132 Normally, after unsuccessfully searching all the first-level
 133 subdirectories of the source directory list,
 134 .Nm
 135 will ask
 136 .Xr locate 1
 137 to find the entry on its behalf.
 138 Since this can take much longer, it can be turned off with
 139 .Fl x .
 140 .El
 141 .Sh EXAMPLES
 142 The following finds all utilities under
 143 .Pa /usr/bin
 144 that do not have documentation:
 145 .Pp
 146 .Dl whereis -m -u /usr/bin/*
 147 .Pp
 148 Change to the source code directory of
 149 .Xr ls 1 :
 150 .Pp
 151 .Dl cd `whereis -sq ls`
 152 .Sh SEE ALSO
 153 .Xr find 1 ,
 154 .Xr locate 1 ,
 155 .Xr man 1 ,
 156 .Xr which 1 ,
 157 .Xr sysctl 8
 158 .Sh HISTORY
 159 The
 160 .Nm
 161 utility appeared in
 162 .Bx 3.0 .
 163 This version re-implements the historical
 164 functionality that was lost in
 165 .Bx 4.4 .
 166 .Sh AUTHORS
 167 This implementation of the
 168 .Nm
 169 command was written by
 170 .An J\(:org Wunsch .
 171 .Sh BUGS
 172 This re-implementation of the
 173 .Nm
 174 utility is not bug-for-bug compatible with historical versions.
 175 It is believed to be compatible with the version that was shipping with
 176 .Fx 2.2
 177 through
 178 .Fx 4.5
 179 though.
 180 .Pp
 181 The
 182 .Nm
 183 utility can report some unrelated source entries when the
 184 .Fl a
 185 option is specified.