Return to which.1 CVS log

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

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

1.17    ! jmc         1: .\"    $OpenBSD: which.1,v 1.16 2007/08/14 17:41:10 sobrado 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.16      sobrado    32: .Dd $Mdocdate: May 31 2007 $
1.1       deraadt    33: .Dt WHICH 1
1.4       millert    34: .Os
1.1       deraadt    35: .Sh NAME
                     36: .Nm which
1.4       millert    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.12      aaron      53: .Pp
1.17    ! jmc        54: .Nm
        !            55: also exists as a built-in to
        !            56: .Xr csh 1 ,
        !            57: though with a different syntax.
        !            58: .Pp
1.3       niklas     59: The
1.4       millert    60: .Nm
1.3       niklas     61: utility exits with one of the following values:
1.11      aaron      62: .Pp
                     63: .Bl -tag -width 4n -compact
1.3       niklas     64: .It 0
1.8       aaron      65: All names were successfully resolved.
1.3       niklas     66: .It 1
1.8       aaron      67: Some names were resolved but not all.
1.3       niklas     68: .It 2
1.8       aaron      69: No names were resolved.
1.12      aaron      70: .It \-1
1.4       millert    71: A system error occurred.
1.3       niklas     72: .El
1.7       deraadt    73: .Sh ENVIRONMENT
1.12      aaron      74: The following environment variables affect the execution of
                     75: .Nm which :
1.4       millert    76: .Bl -tag -width PATH
                     77: .It Ev PATH
1.12      aaron      78: A colon-separated list of directories in which to find executables.
1.4       millert    79: If
                     80: .Ev PATH
1.9       aaron      81: is not set, and the given name is not a fully qualified
1.4       millert    82: or relative pathname,
                     83: .Nm
                     84: will fail.
1.1       deraadt    85: .El
1.14      jmc        86: .Sh DIAGNOSTICS
                     87: A diagnostic is given if an executable file with the argument
                     88: name was not found in the path.
1.12      aaron      89: .Sh SEE ALSO
                     90: .Xr csh 1 ,
                     91: .Xr find 1 ,
                     92: .Xr locate 1 ,
                     93: .Xr whereis 1 ,
                     94: .Xr environ 7
                     95: .Sh HISTORY
                     96: A
                     97: .Nm
                     98: command appeared in
                     99: .Bx 3.0 .