podpath - Man Page

print the path to the Pod

Description

podpath prints the path to the Pod. podpath calls stdpods underneath if the Pod name includes 'perl'. Otherwise, it searches down @INC, printing the '.pod' filename if there is a separate Pod file, otherwise printing the 'pm' filename. This accommodates systems where the Pod lives in a separate file from the module file.

Examples

    $ podpath Cwd
    /usr/local/devperl/lib/5.00554/Cwd.pm

It works with alternate installations, too:

    $ devperl -S podpath perlfunc
    /usr/local/devperl/lib/5.00554/pod/perlfunc.pod

    $ oldperl -S podpath IO::Handle
    /usr/lib/perl5/i386-linux/5.00404/IO/Handle.pm

    $ filsperl -S podpath Thread
    /usr/local/filsperl/lib/5.00554/i686-linux-thread/Thread.pm

See Also

stdpods(1), pmpath(1), perlmodlib(1).

AUTHORS and COPYRIGHTS

Copyright (C) 1999 Tom Christiansen.

Copyright (C) 2006-2014, 2018 Mark Leighton Fisher.

License

This is free software; you can redistribute it and/or modify it under the terms of either: (a) the GNU General Public License as published by the Free Software Foundation; either version 1, or (at your option) any later version, or (b) the Perl "Artistic License". (This is the Perl 5 licensing scheme.)

Please note this is a change from the original pmtools-1.00 (still available on CPAN), as pmtools-1.00 were licensed only under the Perl "Artistic License".

Referenced By

basepods(1), faqpods(1), modpods(1), podgrep(1), pods(1), sitepods(1), stdpods(1).

2024-07-19 perl v5.40.0 User Contributed Perl Documentation