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 6.012
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         [PruneCruft]
23
24       ...and this will pick up all the files from the current directory into
25       the dist.  (PruneCruft is needed, here, to drop files that might
26       present as build artifacts, but should not be shipped.)  You can use it
27       multiple times, as you can any other plugin, by providing a plugin
28       name.  For example, if you want to include external specification files
29       into a subdir of your dist, you might write:
30
31         [GatherDir]
32         ; this plugin needs no config and gathers most of your files
33
34         [GatherDir / SpecFiles]
35         ; this plugin gets all the files in the root dir and adds them under ./spec
36         root   = ~/projects/my-project/spec
37         prefix = spec
38

ATTRIBUTES

40   root
41       This is the directory in which to look for files.  If not given, it
42       defaults to the dist root -- generally, the place where your dist.ini
43       or other configuration file is located.
44
45   prefix
46       This parameter can be set to place the gathered files under a
47       particular directory.  See the description above for an example.
48
49   include_dotfiles
50       By default, files will not be included if they begin with a dot.  This
51       goes both for files and for directories relative to the "root".
52
53       In almost all cases, the default value (false) is correct.
54
55   follow_symlinks
56       By default, symlinks pointing to directories will not be followed; set
57       "follow_symlinks = 1" to traverse these links as if they were normal
58       directories.
59
60       In all followed directories, files which are symlinks are always
61       gathered, with the link turning into a normal file.
62
63   exclude_filename
64       To exclude certain files from being gathered, use the
65       "exclude_filename" option.  The filename is matched exactly, relative
66       to "root".  This may be used multiple times to specify multiple files
67       to exclude.
68
69   exclude_match
70       This is just like "exclude_filename" but provides a regular expression
71       pattern.  Filenames matching the pattern (relative to "root")  are not
72       gathered.  This may be used multiple times to specify multiple patterns
73       to exclude.
74
75   prune_directory
76       While traversing, any directory matching the regular expression pattern
77       will not be traversed further. This may be used multiple times to
78       specify multiple directories to skip.
79

AUTHOR

81       Ricardo SIGNES 😏 <rjbs@cpan.org>
82

84       This software is copyright (c) 2018 by Ricardo SIGNES.
85
86       This is free software; you can redistribute it and/or modify it under
87       the same terms as the Perl 5 programming language system itself.
88
89
90
91perl v5.28.1                      2018-04-21 Dist::Zilla::Plugin::GatherDir(3)
Impressum