Dist::Z...therFile(3)

πŸ’– NAME πŸ’–

okay bestie, so this is Dist::Zilla::Plugin::GatherFile β€” it gathers individual file(s) ✨ one at a time, like, very deliberately. no cap.


🌸 VERSION 🌸

version 6.040 β€” she's on 6.040, bestie, keep up 🫢


πŸŽ€ SYNOPSIS πŸŽ€

[GatherFile]
filename = examples/file.txt

that's literally it. that's the whole vibe. πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

so this is a very, very simple FileGatherer plugin. like, very very. she's not doing the most, she's just doing her one job 🌈

what she does: she adds all the files referenced by the filename option that are found in the directory named in the root attribute. simple. iconic. periodt.

and if the root begins with a tilde, that tilde gets passed through glob() first, so it expands. 🧚

here's the important lore tho: normally every distribution will use a GatherDir plugin, so you would only need to use the GatherFile plugin if the file was already being excluded β€” e.g. from an exclude_match configuration. iykyk πŸ”₯


✨ PERL VERSION ✨

this module should work on any version of perl still receiving updates from the Perl 5 Porters. which means, bestie, any version of perl released in the last two to three years. (that is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.) πŸ‘‘

although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. the version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl. πŸ’€

so like... she might work on your crusty old perl. she might not. no promises fr fr.


πŸ’… ATTRIBUTES πŸ’…

🌟 root

this is the directory in which to look for files. if not given, it defaults to the dist root β€” generally, the place where your dist.ini or other configuration file is located. 🏠

🌸 prefix

this parameter can be set to place the gathered files under a particular directory. see the description above for an example. πŸŽ€

πŸ¦‹ filename

the name of the file to gather, relative to the root. can be used more than once. yes bestie, stack them up, she'll take them all 🫢


πŸ‘‘ AUTHOR πŸ‘‘

Ricardo SIGNES 😏 <cpan@semiotic.systems>

not me putting the 😏 in there, that's literally what the manpage says, i don't make the rules πŸ’€


this software is copyright (c) 2026 by Ricardo SIGNES.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. slay πŸŽ‰


and that's the whole page, bestie!! perl v5.42.3, dated 2026-10-19, straight from the User Contributed Perl Documentation section, file Dist::Z...therFile(3). go forth and gather those files πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from