xref: /openbsd/usr.bin/which/which.1 (revision 73471bf0)
1.\"	$OpenBSD: which.1,v 1.25 2016/01/14 21:54:24 millert Exp $
2.\"
3.\" Copyright (c) 1980, 1991 Regents of the University of California.
4.\" 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.\"     from: @(#)which.1	6.3 (Berkeley) 4/23/91
31.\"
32.Dd $Mdocdate: January 14 2016 $
33.Dt WHICH 1
34.Os
35.Sh NAME
36.Nm which
37.Nd locate a program file (or files) in the path
38.Sh SYNOPSIS
39.Nm which
40.Op Fl a
41.Ar name ...
42.Sh DESCRIPTION
43.Nm
44takes a list of names and looks for the files which would be
45executed had these names been given as commands.
46Each argument is searched for along the user's path.
47.Pp
48If the
49.Fl a
50flag is given,
51.Nm
52will return a list of all matches instead of just the first match.
53.Sh ENVIRONMENT
54The following environment variables affect the execution of
55.Nm which :
56.Bl -tag -width PATH
57.It Ev PATH
58A colon-separated list of directories in which to find executables.
59If
60.Ev PATH
61is not set or is empty,
62.Nm
63will use the system's default search path.
64.El
65.Sh EXIT STATUS
66The
67.Nm
68utility exits with one of the following values:
69.Pp
70.Bl -tag -width Ds -offset indent -compact
71.It 0
72All names were successfully resolved.
73.It 1
74Some names were resolved but not all.
75.It 2
76No names were resolved.
77.El
78.Sh DIAGNOSTICS
79A diagnostic is given if an executable file with the argument
80name was not found in the path.
81.Sh SEE ALSO
82.Xr csh 1 ,
83.Xr find 1 ,
84.Xr locate 1 ,
85.Xr whereis 1 ,
86.Xr environ 7
87.Sh STANDARDS
88.Nm
89also exists as a built-in to
90.Xr csh 1 ,
91though with a different syntax.
92.Sh HISTORY
93A
94.Nm
95command first appeared in
96.Bx 3.0 .
97.Pp
98The
99.Fl a
100option first appeared in
101.Ox 2.3 .
102