bin/which/whereis.1

   1 .\"     $OpenBSD: whereis.1,v 1.18 2013/04/15 16:22:51 jmc Exp $
   2 .\"     $NetBSD: whereis.1,v 1.4 1995/08/31 21:54:51 jtc Exp $
   3 .\"
   4 .\" Copyright (c) 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)whereis.1   8.3 (Berkeley) 4/27/95
  32 .\"
  33 .Dd $Mdocdate: April 15 2013 $
  34 .Dt WHEREIS 1
  35 .Os
  36 .Sh NAME
  37 .Nm whereis
  38 .Nd locate programs
  39 .Sh SYNOPSIS
  40 .Nm whereis
  41 .Op Fl a
  42 .Ar name ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility checks the standard binary directories for the specified
  47 .Ar name ,
  48 printing out the paths of any it finds that are executable by the
  49 user.
  50 .Pp
  51 The path searched is:
  52 .\" The path below should be the expansion of _PATH_STDPATH from <paths.h>
  53 .D1 /usr/bin:/bin:/usr/sbin:/sbin
  54 .Pp
  55 If the
  56 .Fl a
  57 flag is given,
  58 .Nm
  59 will return a list of all matches instead of just the first match.
  60 .Sh EXIT STATUS
  61 The
  62 .Nm
  63 utility exits with one of the following values:
  64 .Pp
  65 .Bl -tag -width Ds -offset indent -compact
  66 .It 0
  67 All names were successfully resolved.
  68 .It 1
  69 Some names were resolved but not all.
  70 .It 2
  71 No names were resolved.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr apropos 1 ,
  75 .Xr find 1 ,
  76 .Xr locate 1 ,
  77 .Xr which 1
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 command first appeared in
  82 .Bx 2 ,
  83 but the original version was legally tainted
  84 and was not included as part of the
  85 .Bx 4.4
  86 release, such that most of the original functionality was lost.
  87 .Pp
  88 The
  89 .Fl a
  90 option first appeared in
  91 .Ox 2.3 .
  92 .Sh AUTHORS
  93 The original version was written by
  94 .An Bill Joy .