Annotation of src/usr.bin/which/whereis.1, Revision 1.16
1.16 ! guenther 1: .\" $OpenBSD: whereis.1,v 1.15 2012/01/29 17:37:58 lum Exp $
1.1 millert 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.
1.8 millert 15: .\" 3. Neither the name of the University nor the names of its contributors
1.1 millert 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: .\"
1.16 ! guenther 33: .Dd $Mdocdate: January 29 2012 $
1.1 millert 34: .Dt WHEREIS 1
1.4 aaron 35: .Os
1.1 millert 36: .Sh NAME
37: .Nm whereis
38: .Nd locate programs
39: .Sh SYNOPSIS
40: .Nm whereis
1.11 sobrado 41: .Op Fl a
42: .Ar name ...
1.1 millert 43: .Sh DESCRIPTION
44: The
1.7 aaron 45: .Nm
1.15 lum 46: utility checks the standard binary directories for the specified
47: .Ar name ,
1.1 millert 48: printing out the paths of any it finds that are executable by the
49: user.
50: .Pp
1.16 ! guenther 51: The path searched is
! 52: .Pa _PATH_STDPATH .
1.11 sobrado 53: .Pp
54: If the
55: .Fl a
56: flag is given,
57: .Nm
58: will return a list of all matches instead of just the first match.
1.12 jmc 59: .Sh EXIT STATUS
1.1 millert 60: The
61: .Nm
62: utility exits with one of the following values:
1.5 aaron 63: .Pp
1.12 jmc 64: .Bl -tag -width Ds -offset indent -compact
1.1 millert 65: .It 0
1.3 aaron 66: All names were successfully resolved.
1.1 millert 67: .It 1
1.3 aaron 68: Some names were resolved but not all.
1.1 millert 69: .It 2
1.3 aaron 70: No names were resolved.
1.1 millert 71: .El
72: .Sh SEE ALSO
1.5 aaron 73: .Xr apropos 1 ,
74: .Xr find 1 ,
75: .Xr locate 1 ,
1.16 ! guenther 76: .Xr which 1
1.1 millert 77: .Sh HISTORY
78: The
1.7 aaron 79: .Nm
1.14 schwarze 80: command first appeared in
81: .Bx 2 ,
82: but the original version was legally tainted
83: and was not included as part of the
84: .Bx 4.4
85: release, such that most of the original functionality was lost.
86: .Pp
87: The
88: .Fl a
89: option first appeared in
90: .Ox 2.3 .
91: .Sh AUTHORS
92: The original version was written by
93: .An Bill Joy .