1Dist::Zilla::Plugin::GaUtsheerrDCiorn(t3r)ibuted Perl DoDciusmte:n:tZaitliloan::Plugin::GatherDir(3)
2
3
4

NAME

6       Dist::Zilla::Plugin::GatherDir - gather all the files in a directory
7

VERSION

9       version 4.300002
10

DESCRIPTION

12       This is a very, very simple FileGatherer plugin.  It looks in the
13       directory named in the "root" attribute and adds all the files it finds
14       there.  If the root begins with a tilde, the tilde is replaced with the
15       current user's home directory according to File::HomeDir.
16
17       Almost every dist will be built with one GatherDir plugin, since it's
18       the easiest way to get files from disk into your dist.  Most users just
19       need:
20
21         [GatherDir]
22
23       ...and this will pick up all the files from the current directory into
24       the dist.  You can use it multiple times, as you can any other plugin,
25       by providing a plugin name.  For example, if you want to include
26       external specification files into a subdir of your dist, you might
27       write:
28
29         [GatherDir]
30         ; this plugin needs no config and gathers most of your files
31
32         [GatherDir / SpecFiles]
33         ; this plugin gets all the files in the root dir and adds them under ./spec
34         root   = ~/projects/my-project/spec
35         prefix = spec
36

ATTRIBUTES

38   root
39       This is the directory in which to look for files.  If not given, it
40       defaults to the dist root -- generally, the place where your dist.ini
41       or other configuration file is located.
42
43   prefix
44       This parameter can be set to gather all the files found under a common
45       directory.  See the description above for an example.
46
47   include_dotfiles
48       By default, files will not be included if they begin with a dot.  This
49       goes both for files and for directories relative to the "root".
50
51       In almost all cases, the default value (false) is correct.
52
53   follow_symlinks
54       By default, directories that are symlinks will not be followed. Note on
55       the other hand that in all followed directories, files which are
56       symlinks are always gathered.
57
58   exclude_filename
59       To exclude certain files from being gathered, use the
60       "exclude_filename" option. This may be used multiple times to specify
61       multiple files to exclude.
62
63   exclude_match
64       This is just like "exclude_filename" but provides a regular expression
65       pattern.  Files matching the pattern are not gathered.  This may be
66       used multiple times to specify multiple patterns to exclude.
67

AUTHOR

69       Ricardo SIGNES <rjbs@cpan.org>
70

72       This software is copyright (c) 2011 by Ricardo SIGNES.
73
74       This is free software; you can redistribute it and/or modify it under
75       the same terms as the Perl 5 programming language system itself.
76
77
78
79perl v5.12.4                      2011-09-22 Dist::Zilla::Plugin::GatherDir(3)
Impressum