Annotation of src/usr.bin/which/whereis.1, Revision 1.8
1.8 ! millert 1: .\" $OpenBSD: whereis.1,v 1.7 2000/03/14 14:58:26 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.
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: .\"
33: .Dd April 27, 1995
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.3 aaron 41: .Ar name Op Ar ...
1.1 millert 42: .Sh DESCRIPTION
43: The
1.7 aaron 44: .Nm
1.1 millert 45: utility checks the standard binary directories for the specified name,
46: printing out the paths of any it finds that are executable by the
47: user.
48: .Pp
49: The path searched is the string returned by the
50: .Xr sysctl 8
51: utility for the
52: .Dq user.cs_path
53: string.
1.7 aaron 54: .Pp
1.1 millert 55: The
56: .Nm
57: utility exits with one of the following values:
1.5 aaron 58: .Pp
59: .Bl -tag -width 4n -compact
1.1 millert 60: .It 0
1.3 aaron 61: All names were successfully resolved.
1.1 millert 62: .It 1
1.3 aaron 63: Some names were resolved but not all.
1.1 millert 64: .It 2
1.3 aaron 65: No names were resolved.
1.7 aaron 66: .It \-1
1.1 millert 67: A system error occurred.
68: .El
69: .Sh SEE ALSO
1.5 aaron 70: .Xr apropos 1 ,
71: .Xr find 1 ,
72: .Xr locate 1 ,
1.1 millert 73: .Xr which 1 ,
74: .Xr sysctl 8
1.7 aaron 75: .Sh COMPATIBILITY
76: The historic flags and arguments for the
77: .Nm
78: utility are no longer available in this version.
1.1 millert 79: .Sh HISTORY
80: The
1.7 aaron 81: .Nm
1.2 mickey 82: command appeared in
83: .Bx 3.0 .