.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.48)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "Module::Path 3"
.TH Module::Path 3 2026-10-26 "perl v5.44.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Module::Path \- get the full path to a locally installed module
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& use Module::Path \*(Aqmodule_path\*(Aq;
\& 
\& $path = module_path(\*(AqTest::More\*(Aq);
\& if (defined($path)) {
\&   print "Test::More found at $path\en";
\& } else {
\&   print "Danger Will Robinson!\en";
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides a single function, \f(CWmodule_path()\fR,
which takes a module name and finds the first directory in your \f(CW@INC\fR path
where the module is installed locally.
It returns the full path to that file, resolving any symlinks.
It is portable and only depends on core modules.
.PP
It works by looking in all the directories in \f(CW@INC\fR
for an appropriately named file:
.IP \(bu 4
Foo::Bar becomes \f(CW\*(C`Foo/Bar.pm\*(C'\fR, using the correct directory path
separator for your operating system.
.IP \(bu 4
Iterate over \f(CW@INC\fR, ignoring any references
(see "require" in "perlfunc" if you\*(Aqre surprised to hear
that you might find references in \f(CW@INC\fR).
.IP \(bu 4
For each directory in \f(CW@INC\fR, append the partial path (\f(CW\*(C`Foo/Bar.pm\*(C'\fR),
again using the correct directory path separator.
If the resulting file exists, return this path.
.IP \(bu 4
If a directory in \f(CW@INC\fR is a symlink, then we resolve the path,
and return a path containing the linked\-to directory.
.IP \(bu 4
If no file was found, return \f(CW\*(C`undef\*(C'\fR.
.PP
I wrote this module because I couldn\*(Aqt find an alternative
which dealt with the points listed above, and didn\*(Aqt pull in
what seemed like too many dependencies to me.
.PP
The distribution for \f(CW\*(C`Module::Path\*(C'\fR includes the \f(CW\*(C`mpath\*(C'\fR
script, which lets you get the path for a module from the command\-line:
.PP
.Vb 1
\& % mpath Module::Path
.Ve
.PP
The \f(CWmodule_path()\fR function will also cope if the module name includes \f(CW\*(C`.pm\*(C'\fR;
this means you can pass a partial path, such as used as the keys in \f(CW%INC\fR:
.PP
.Vb 1
\&  module_path(\*(AqTest/More.pm\*(Aq) eq $INC{\*(AqTest/More.pm\*(Aq}
.Ve
.PP
The above is the basis for one of the tests.
.SH BUGS
.IX Header "BUGS"
Obviously this only works where the module you\*(Aqre after has its own \f(CW\*(C`.pm\*(C'\fR
file. If a file defines multiple packages, this won\*(Aqt work.
.PP
This also won\*(Aqt find any modules that are being loaded in some special
way, for example using a code reference in \f(CW@INC\fR, as described
in "require" in "perlfunc".
.SH "SEE ALSO"
.IX Header "SEE ALSO"
There are a number of other modules on CPAN which provide the
same or similar functionality:
App::whichpm,
Class::Inspector,
Module::Data,
Module::Filename,
Module::Finder,
Module::Info,
Module::Locate,
Module::Mapper,
Module::Metadata,
Module::Runtime,
Module::Util,
and Path::ScanINC.
.PP
I\*(Aqve written a review of all such modules that I\*(Aqm aware of:
.Sp
.RS 4
<http://neilb.org/reviews/module\-path.html>
.RE
.PP
Module::Path was written to be fast, portable, and have a low number of
core\-only runtime dependencies. It you only want to look up the path to
a module, it\*(Aqs a good choice.
.PP
If you want more information, such as the module\*(Aqs version, what functions
are provided, etc, then start by looking at Module::Info,
Module::Metadata, and Class::Inspector.
.PP
The following scripts can also give you the path:
perldoc,
whichpm <https://www.metacpan.org/module/whichpm>.
.SH REPOSITORY
.IX Header "REPOSITORY"
<https://github.com/neilbowers/Module\-Path>
.SH AUTHOR
.IX Header "AUTHOR"
Neil Bowers <neilb@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Neil Bowers <neilb@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.