xref: /openbsd/usr.bin/which/whereis.1 (revision 404b540a)
1.\"	$OpenBSD: whereis.1,v 1.11 2007/08/14 17:41:10 sobrado 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: August 14 2007 $
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
44The
45.Nm
46utility checks the standard binary directories for the specified name,
47printing out the paths of any it finds that are executable by the
48user.
49.Pp
50The path searched is the string returned by the
51.Xr sysctl 8
52utility for the
53.Dq user.cs_path
54string.
55.Pp
56If the
57.Fl a
58flag is given,
59.Nm
60will return a list of all matches instead of just the first match.
61.Pp
62The
63.Nm
64utility exits with one of the following values:
65.Pp
66.Bl -tag -width 4n -compact
67.It 0
68All names were successfully resolved.
69.It 1
70Some names were resolved but not all.
71.It 2
72No names were resolved.
73.It \-1
74A system error occurred.
75.El
76.Sh SEE ALSO
77.Xr apropos 1 ,
78.Xr find 1 ,
79.Xr locate 1 ,
80.Xr which 1 ,
81.Xr sysctl 8
82.Sh STANDARDS
83The historic flags and arguments for the
84.Nm
85utility are no longer available in this version.
86.Sh HISTORY
87The
88.Nm
89command appeared in
90.Bx 3.0 .
91