NAME¶
App::Rad::Help - 'help' command extension for App::Rad
VERSION¶
Version 0.02
SYNOPSIS¶
you can add inline help for your App::Rad commands via
"$c->register()" or "$c->register_commands()":
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
sub my_command :Help(this is my command) {
...
}
sub another_cmd
:Help(yet another command)
{
...
}
DESCRIPTION¶
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). Please refer to App::Rad for further documentation.
INTERNAL METHODS¶
load¶
Loads the module into App::Rad
help¶
Show help text
register_help¶
Associates help text with command
usage¶
Prints usage string. Default is "Usage: $0 command [arguments]", where
$0 is your program's name.
helpstr¶
Prints a help string with all available commands and their help description.
DEPENDENCIES¶
- •
- Attribute::Handlers, which is core as of Perl 5.8.
AUTHOR¶
Breno G. de Oliveira, "<garu at cpan.org>"
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.
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¶
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.