File: README

package info (click to toggle)
libfile-share-perl 0.27-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 204 kB
  • sloc: perl: 85; makefile: 2
file content (55 lines) | stat: -rw-r--r-- 1,711 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
NAME

    File::Share - Extend File::ShareDir to Local Libraries

SYNOPSIS

        use File::Share ':all';
    
        my $dir = dist_dir('Foo-Bar');
        my $file = dist_file('Foo-Bar', 'file.txt');

DESCRIPTION

    This module is a dropin replacement for File::ShareDir. It supports the
    dist_dir and dist_file functions, except these functions have been
    enhanced to understand when the developer's local ./share/ directory
    should be used.

    NOTE: 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.

PROBLEM AND SOLUTION

    Module::Install has an install_share directive that allows you to
    install various files associated with a distribution. By convention,
    module authors always put these in a directory called share/. However,
    File::ShareDir can only find files after they have been installed. This
    can be problematic when running development tests.

    File::Share will look for a local share directory, if it notices that
    the module corresponding was loaded from a development path.

    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. File::Share lets you play along with that.

SEE ALSO

      * File::ShareDir

AUTHOR

    Ingy döt Net <ingy@cpan.org>

COPYRIGHT AND LICENSE

    Copyright 2011-2014. Ingy döt Net.

    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

    See http://www.perl.com/perl/misc/Artistic.html