Return to which.1 CVS log

Up to [local] / src / usr.bin / which

Annotation of src/usr.bin/which/which.1, Revision 1.25

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