.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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 .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . 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 .\" ======================================================================== .\" .IX Title "File::Share 3pm" .TH File::Share 3pm "2022-12-07" "perl v5.36.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" File::Share \- Extend File::ShareDir to Local Libraries .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use File::Share \*(Aq:all\*(Aq; \& \& my $dir = dist_dir(\*(AqFoo\-Bar\*(Aq); \& my $file = dist_file(\*(AqFoo\-Bar\*(Aq, \*(Aqfile.txt\*(Aq); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module is a dropin replacement for File::ShareDir. It supports the \&\f(CW\*(C`dist_dir\*(C'\fR and \f(CW\*(C`dist_file\*(C'\fR functions, except these functions have been enhanced to understand when the developer's local \f(CW\*(C`./share/\*(C'\fR directory should be used. .PP \&\s-1NOTE:\s0 module_dist and module_file are not yet supported, because (afaik) there is no well known way to populate per-module share files. This may change in the future. Please contact me if you know how to do this. .SH "PROBLEM AND SOLUTION" .IX Header "PROBLEM AND SOLUTION" Module::Install has an \f(CW\*(C`install_share\*(C'\fR directive that allows you to install various files associated with a distribution. By convention, module authors always put these in a directory called \f(CW\*(C`share/\*(C'\fR. However, File::ShareDir can only find files after they have been installed. This can be problematic when running development tests. .PP File::Share will look for a local \f(CW\*(C`share\*(C'\fR directory, if it notices that the module corresponding was loaded from a development path. .PP Devel::Local gives you an easy way to use a bunch of source repositories as though their lib and bin directories had already been installed. \&\f(CW\*(C`File::Share\*(C'\fR lets you play along with that. .SH "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 File::ShareDir .SH "AUTHOR" .IX Header "AUTHOR" Ingy döt Net .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2011\-2014. Ingy döt Net. .PP This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .PP See