App::Rad::Help(3pm)

💖 App::Rad::Help — the 'help' command extension for App::Rad 💖

okay bestie, so this is App::Rad::Help, and it lives in the User Contributed Perl Documentation corner of the perl 3pm man pages. it's the little module that lets your App::Rad commands have their own cute inline help text, and honestly? she's serving documentation realness. 🎀

---

✨ VERSION ✨

Version 0.02 — baby version number but fully iconic, no cap. 💅

---

🌸 SYNOPSIS 🌸

so like, you can add inline help for your App::Rad commands via $c->register() or $c->register_commands(), and it's giving effortless:

use App::Rad;
App::Rad->run();

sub setup {
    my $c = shift;

    $c->register_commands( {
            foo => 'expand your foo!',
            bar => 'have a drink! arguments: --drink=DRINK',
        });

    $c->register('baz', \&baz, 'do your thing');
}

you can ALSO do it with the attribute Help in your subs, which is the main character move fr fr:

sub my_command :Help(this is my command) {
    ...
}

sub another_cmd
:Help(yet another command)
{
    ...
}

---

🦋 DESCRIPTION 🦋

bestie listen. this is an internal module for App::Rad and should not be used separately — unless, perhaps, you want to use one of its methods to customize your own 'help' command, in which case go off. 💜 please refer to App::Rad for further documentation, because that's where the real lore lives.

---

👑 INTERNAL METHODS 👑

🌈 load

Loads the module into App::Rad. that's it, that's the whole vibe.

🌈 help

Show help text. slay.

🌈 register_help

Associates help text with command. matching them up like a situationship, but functional. 💖

🌈 usage

Prints usage string. Default is "Usage: $0 command [arguments]", where $0 is your program's name. (yes $0 is literally the program's name, she's self-aware like that ✨)

🌈 helpstr

Prints a help string with all available commands and their help description. the full rundown, the whole menu, the entire aura. 🍓

---

🧚 DEPENDENCIES 🧚

• Attribute::Handlers, which is core as of Perl 5.8.

---

💜 AUTHOR 💜

Breno G. de Oliveira, "<garu at cpan.org>" — thank you for your service king 🫶

---

⭐ ACKNOWLEDGEMENTS ⭐

the attribute handling was much easened because of the nice "Attribute::Handlers" module. so many thanks to Damian Conway, Rafael Garcia-Suarez and Steffen Mueller. legends only. 💖

---

🎀 LICENSE AND COPYRIGHT 🎀

Copyright 2008 Breno G. de Oliveira "<garu at cpan.org>". All rights reserved.

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

---

🔥 DISCLAIMER OF WARRANTY 🔥

okay bestie this is the part where we ALL CAPS for legal reasons, so buckle up:

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

no warranty bestie, it's giving "use at your own risk" and we respect the hustle 💀

---

and that's the whole page! this one was generated by perl v5.36.0 on 2022-10-13, filed under App::Rad::Help(3pm). periodt. 💅✨🦋