Annotation of src/usr.bin/which/whereis.1, Revision 1.5
1.5 ! aaron 1: .\" $OpenBSD: whereis.1,v 1.4 1999/06/05 01:21:50 aaron 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.
15: .\" 3. All advertising materials mentioning features or use of this software
16: .\" must display the following acknowledgement:
17: .\" This product includes software developed by the University of
18: .\" California, Berkeley and its contributors.
19: .\" 4. Neither the name of the University nor the names of its contributors
20: .\" may be used to endorse or promote products derived from this software
21: .\" without specific prior written permission.
22: .\"
23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26: .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33: .\" SUCH DAMAGE.
34: .\"
35: .\" @(#)whereis.1 8.3 (Berkeley) 4/27/95
36: .\"
37: .Dd April 27, 1995
38: .Dt WHEREIS 1
1.4 aaron 39: .Os
1.1 millert 40: .Sh NAME
41: .Nm whereis
42: .Nd locate programs
43: .Sh SYNOPSIS
44: .Nm whereis
1.3 aaron 45: .Ar name Op Ar ...
1.1 millert 46: .Sh DESCRIPTION
47: The
48: .Nm whereis
49: utility checks the standard binary directories for the specified name,
50: printing out the paths of any it finds that are executable by the
51: user.
52: .Pp
53: The path searched is the string returned by the
54: .Xr sysctl 8
55: utility for the
56: .Dq user.cs_path
57: string.
58: .Sh RETURN VALUES
59: The
60: .Nm
61: utility exits with one of the following values:
1.5 ! aaron 62: .Pp
! 63: .Bl -tag -width 4n -compact
1.1 millert 64: .It 0
1.3 aaron 65: All names were successfully resolved.
1.1 millert 66: .It 1
1.3 aaron 67: Some names were resolved but not all.
1.1 millert 68: .It 2
1.3 aaron 69: No names were resolved.
1.1 millert 70: .It -1
71: A system error occurred.
72: .El
73: .Sh SEE ALSO
1.5 ! aaron 74: .Xr apropos 1 ,
! 75: .Xr find 1 ,
! 76: .Xr locate 1 ,
1.1 millert 77: .Xr which 1 ,
78: .Xr sysctl 8
79: .Sh COMPATIBILITY
80: The historic flags and arguments for the
81: .Nm whereis
82: utility are no longer available in this version.
83: .Sh HISTORY
84: The
85: .Nm whereis
1.2 mickey 86: command appeared in
87: .Bx 3.0 .