This is the core function. The only mandatory argument is the name of
a file to be located. The filename should not be absolute although it
can include directory specifications.
If only two arguments are provided, it is assumed that the second argument is a path-like string. This interface is provided for backwards compatibility with File::SearchPath version 0.01. It is not as portable as specifying the name of the environment variable. Note also that no specific attempt will be made to check whether the file is executable when the subroutine is called in this way.
By default, this will search in $PATH for executable files and is equivalent to:
Hash-like options can be used to alter the behaviour of the search:
In scalar context the first match is returned. In list context all matches are returned in the order corresponding to the directories listed in the environment variable.
Returns undef (or empty list) if no match could be found.
If an absolute file name is provided, that filename is returned if it exists and is readable, else undef is returned.
File::SearchPath used to exist on CPAN (now on backpan) and was written by Robert Spier. This version is completely new but retains an interface that is compatible with Roberts version. Thanks to Robert for allowing me to reuse this module name.
If Env::Path module is installed it will be used. This allows for more flexibility than simply assuming colon-separated paths.
Env::Path, File::Which, File::Find, File::Find::Run, File::Where.
Tim Jenness <email@example.com>
Copyright (C) 2005,2006, 2008 Particle Physics and Astronomy Research Council. Copyright (C) 2009-2010 Science and Technology Facilities Council. Copyright (C) 2015 Tim Jenness All Rights Reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place,Suite 330, Boston, MA 02111-1307, USA
|perl v5.20.3||FILE::SEARCHPATH (3)||2016-03-17|