local-lib5/man/man3/File::Which.3pm

   1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "File::Which 3"
 127 .TH File::Which 3 "2009-09-26" "perl v5.8.7" "User Contributed Perl Documentation"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 File::Which \- Portable implementation of the `which' utility
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 .Vb 2
 137 \&  use File::Which;                  # exports which()
 138 \&  use File::Which qw(which where);  # exports which() and where()
 139 \&
 140 \&  my $exe_path = which(\*(Aqperldoc\*(Aq);
 141 \&
 142 \&  my @paths = where(\*(Aqperl\*(Aq);
 143 \&  \- Or \-
 144 \&  my @paths = which(\*(Aqperl\*(Aq); # an array forces search for all of them
 145 .Ve
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 \&\f(CW\*(C`File::Which\*(C'\fR was created to be able to get the paths to executable programs
 149 on systems under which the `which' program wasn't implemented in the shell.
 150 .PP
 151 \&\f(CW\*(C`File::Which\*(C'\fR searches the directories of the user's \f(CW\*(C`PATH\*(C'\fR (as returned by
 152 \&\f(CW\*(C`File::Spec\->path()\*(C'\fR), looking for executable files having the name
 153 specified as a parameter to \f(CW\*(C`which()\*(C'\fR. Under Win32 systems, which do not have a
 154 notion of directly executable files, but uses special extensions such as \f(CW\*(C`.exe\*(C'\fR
 155 and \f(CW\*(C`.bat\*(C'\fR to identify them, \f(CW\*(C`File::Which\*(C'\fR takes extra steps to assure that
 156 you will find the correct file (so for example, you might be searching for
 157 \&\f(CW\*(C`perl\*(C'\fR, it'll try \fIperl.exe\fR, \fIperl.bat\fR, etc.)
 158 .SH "Steps Used on Win32, DOS, OS2 and VMS"
 159 .IX Header "Steps Used on Win32, DOS, OS2 and VMS"
 160 .SS "Windows \s-1NT\s0"
 161 .IX Subsection "Windows NT"
 162 Windows \s-1NT\s0 has a special environment variable called \f(CW\*(C`PATHEXT\*(C'\fR, which is used
 163 by the shell to look for executable files. Usually, it will contain a list in
 164 the form \f(CW\*(C`.EXE;.BAT;.COM;.JS;.VBS\*(C'\fR etc. If \f(CW\*(C`File::Which\*(C'\fR finds such an
 165 environment variable, it parses the list and uses it as the different
 166 extensions.
 167 .SS "Windows 9x and other ancient Win/DOS/OS2"
 168 .IX Subsection "Windows 9x and other ancient Win/DOS/OS2"
 169 This set of operating systems don't have the \f(CW\*(C`PATHEXT\*(C'\fR variable, and usually
 170 you will find executable files there with the extensions \f(CW\*(C`.exe\*(C'\fR, \f(CW\*(C`.bat\*(C'\fR and
 171 (less likely) \f(CW\*(C`.com\*(C'\fR. \f(CW\*(C`File::Which\*(C'\fR uses this hardcoded list if it's running
 172 under Win32 but does not find a \f(CW\*(C`PATHEXT\*(C'\fR variable.
 173 .SS "\s-1VMS\s0"
 174 .IX Subsection "VMS"
 175 Same case as Windows 9x: uses \f(CW\*(C`.exe\*(C'\fR and \f(CW\*(C`.com\*(C'\fR (in that order).
 176 .SH "Functions"
 177 .IX Header "Functions"
 178 .SS "which($short_exe_name)"
 179 .IX Subsection "which($short_exe_name)"
 180 Exported by default.
 181 .PP
 182 \&\f(CW$short_exe_name\fR is the name used in the shell to call the program (for
 183 example, \f(CW\*(C`perl\*(C'\fR).
 184 .PP
 185 If it finds an executable with the name you specified, \f(CW\*(C`which()\*(C'\fR will return
 186 the absolute path leading to this executable (for example, \fI/usr/bin/perl\fR or
 187 \&\fIC:\ePerl\eBin\eperl.exe\fR).
 188 .PP
 189 If it does \fInot\fR find the executable, it returns \f(CW\*(C`undef\*(C'\fR.
 190 .PP
 191 If \f(CW\*(C`which()\*(C'\fR is called in list context, it will return \fIall\fR the
 192 matches.
 193 .SS "where($short_exe_name)"
 194 .IX Subsection "where($short_exe_name)"
 195 Not exported by default.
 196 .PP
 197 Same as \f(CW\*(C`which($short_exe_name)\*(C'\fR in array context. Same as the
 198 \&\f(CW\`where\*(Aq\fR utility, will return an array containing all the path names
 199 matching \f(CW$short_exe_name\fR.
 200 .SH "BUGS AND CAVEATS"
 201 .IX Header "BUGS AND CAVEATS"
 202 Not tested on \s-1VMS\s0 or MacOS, although there is platform specific code
 203 for those. Anyone who haves a second would be very kind to send me a
 204 report of how it went.
 205 .PP
 206 File::Spec adds the current directory to the front of \s-1PATH\s0 if on
 207 Win32, \s-1VMS\s0 or MacOS. I have no knowledge of those so don't know if the
 208 current directory is searced first or not. Could someone please tell
 209 me?
 210 .SH "SUPPORT"
 211 .IX Header "SUPPORT"
 212 Bugs should be reported via the \s-1CPAN\s0 bug tracker at
 213 .PP
 214 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File\-Which>
 215 .PP
 216 For other issues, contact the maintainer.
 217 .SH "AUTHOR"
 218 .IX Header "AUTHOR"
 219 Adam Kennedy <adamk@cpan.org>
 220 .PP
 221 Per Einar Ellefsen <pereinar@cpan.org>
 222 .PP
 223 Originated in \fImodperl\-2.0/lib/Apache/Build.pm\fR. Changed for use in DocSet
 224 (for the mod_perl site) and Win32\-awareness by me, with slight modifications
 225 by Stas Bekman, then extracted to create \f(CW\*(C`File::Which\*(C'\fR.
 226 .PP
 227 Version 0.04 had some significant platform-related changes, taken from
 228 the Perl Power Tools \f(CW\`which\*(Aq\fR implementation by Abigail with
 229 enhancements from Peter Prymmer. See
 230 <http://www.perl.com/language/ppt/src/which/index.html> for more
 231 information.
 232 .SH "COPYRIGHT"
 233 .IX Header "COPYRIGHT"
 234 Copyright 2002 Per Einar Ellefsen.
 235 .PP
 236 Some parts copyright 2009 Adam Kennedy.
 237 .PP
 238 This program is free software; you can redistribute it and/or modify
 239 it under the same terms as Perl itself.
 240 .SH "SEE ALSO"
 241 .IX Header "SEE ALSO"
 242 File::Spec, \fIwhich\fR\|(1), Perl Power Tools:
 243 <http://www.perl.com/language/ppt/index.html>.