xref: /minix/usr.bin/whereis/whereis.1 (revision 83133719)
1.\"	$NetBSD: whereis.1,v 1.14 2003/08/07 11:17:17 agc Exp $
2.\"
3.\" Copyright (c) 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. Neither the name of the University nor the names of its contributors
15.\"    may be used to endorse or promote products derived from this software
16.\"    without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\"	@(#)whereis.1	8.3 (Berkeley) 4/27/95
31.\"
32.Dd April 3, 2003
33.Dt WHEREIS 1
34.Os
35.Sh NAME
36.Nm whereis
37.Nd locate programs
38.Sh SYNOPSIS
39.Nm
40.Op Fl p
41.Ar program
42.Op Ar program ...
43.Sh DESCRIPTION
44The
45.Nm
46utility checks the standard binary directories for the specified programs,
47printing out the paths of any it finds.
48.Pp
49The default path searched is the string returned by the
50.Xr sysctl 8
51utility for the
52.Dq user.cs_path
53string.
54If the
55.Op Fl p
56option is specified, then the value of the environment
57variable
58.Ev PATH
59is used instead.
60.Sh EXIT STATUS
61The
62.Nm
63utility exits 0 on success, 1 on general error, 2 if only some
64programs were located and 3 if none were.
65.Sh SEE ALSO
66.Xr whatis 1 ,
67.Xr which 1 ,
68.Xr sysctl 8
69.Sh COMPATIBILITY
70The historic flags and arguments for the
71.Nm
72utility are no longer available in this version.
73.Sh HISTORY
74The
75.Nm
76command appeared in
77.Bx 3.0 .
78