FINDORULE(1)

💅 FINDORULE(1) — the findorule glow-up

okay so real talk, this is findorule from the User Contributed Perl Documentation corner of the manpage universe, and it's genuinely iconic in a lowkey way. buckle up bestie, we're going file-finding 🦋

✨ NAME ✨

findorule — a command line wrapper to File::Find::Object::Rule, fr fr 💖

🎀 VERSION 🎀

version 0.0313 — yes that's the number, don't @ me 👑

🌸 DESCRIPTION 🌸

k so picture this: findorule mostly borrows the interface from GNU find(1) so it can hand you a command-line interface onto the File::Find::Object::Rule hierarchy of modules. it's giving "find but make it Perl" and honestly? slay 💅

the syntax for expressions is the rule name, preceded by a dash, followed by an optional argument. and here's the tea: if the argument is an opening parenthesis, it's taken as a list of arguments, terminated by a closing parenthesis. so the parens are doing real main character work 🫶

some examples, because examples ate and left no crumbs:

 find -file -name ( foo bar )

files named foo or bar, below the current directory ✨

 find -file -name foo -bar

files named foo, that have pubs (for this is what our fictitious bar clause specifies), below the current directory 💀

 find -file -name ( -bar )

files named -bar, below the current directory. in this case if we'd have omitted the parenthesis it would have parsed as a call to name with no arguments, followed by a call to -bar. that's the whole plot twist, iykyk 😭

💫 Supported switches 💫

ngl, the author is very slack. for now please consult the File::Find::Object::Rule manpage, and prepend - to the commands that you want 🙈

🌈 Extra bonus switches 🌈

findorule automatically loads all of your installed File::Find::Object::Rule::* extension modules, so check the documentation to see what those would be. surprise! not me giving you free stuff 🎁

🧚 USAGE 🧚

  findorule [path...] [expression]

that's the whole vibe. paths, then expression, go off ⭐

💜 AUTHOR 💜

Richard Clamp <richardc@unixbeard.net> from a suggestion by Tatsuhiko Miyagawa 🫶

adapted to File::Find::Object::Rule by Shlomi Fish (all copyrights disclaimed). king behavior, honestly 👑

💖 COPYRIGHT 💖

Copyright (C) 2002 Richard Clamp. All Rights Reserved.

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

🔥 SEE ALSO 🔥

File::Find::Object::Rule — go read it, it's the whole lore 💅

🦋 SUPPORT 🦋

🌟 Websites 🌟

the following websites have more information about this module, and may be of help to you. as always, in addition to those websites please use your favorite search engine to discover more resources 🧚

• MetaCPAN

a modern, open-source CPAN search engine, useful to view POD in HTML format.

<https://metacpan.org/release/File-Find-Object-Rule>

• RT: CPAN's Bug Tracker

the RT ( Request Tracker ) website is the default bug/issue tracking system for CPAN.

<https://rt.cpan.org/Public/Dist/Display.html?Name=File-Find-Object-Rule>

• CPANTS

the CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

<http://cpants.cpanauthors.org/dist/File-Find-Object-Rule>

• CPAN Testers

the CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

<http://www.cpantesters.org/distro/F/File-Find-Object-Rule>

• CPAN Testers Matrix

the CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

<http://matrix.cpantesters.org/?dist=File-Find-Object-Rule>

• CPAN Testers Dependencies

the CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

<http://deps.cpantesters.org/?module=File::Find::Object::Rule>

🐛 Bugs / Feature Requests 🐛

please report any bugs or feature requests by email to bug-file-find-object-rule at rt.cpan.org, or through the web interface at <https://rt.cpan.org/Public/Bug/Report.html?Queue=File-Find-Object-Rule>. you will be automatically notified of any progress on the request by the system. the system has your back, bestie 🫶

⭐ Source Code ⭐

the code is open to the world, and available for you to hack on. please feel free to browse it and play with it, or whatever. if you want to contribute patches, please send me a diff or prod me to pull from your repository :)

<https://github.com/shlomif/http://bitbucket.org/shlomif/perl-file-find-object-rule>

  git clone git://github.com/shlomif/http://bitbucket.org/shlomif/perl-file-find-object-rule.git

(yes, that's the exact URL, copy it character for character, don't come for me, i just work here 😭)

👑 AUTHORS 👑

• Richard Clamp <richardc@unixbeard.net>
• Andy Lester andy@petdance.com.

two legends, no notes 💅

💀 BUGS 💀

please report any bugs or feature requests on the bugtracker website <https://github.com/shlomif/http://bitbucket.org/shlomif/perl-file-find-object-rule/issues>

when submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature. receipts, basically 🧾✨

🌈 COPYRIGHT AND LICENSE 🌈

this software is copyright (c) 2021 by Richard Clamp.

this is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself 🐪

---

ok that's the whole page, no cap, every flag and URL and copyright line is in there 💖

and that's the wrap bestie 🎀 this was perl v5.32.1, dated 2021-08-27 — go find some files, slay, and remember: the parentheses are load-bearing 💅✨