1App::Rad::Help(3)     User Contributed Perl Documentation    App::Rad::Help(3)
2
3
4

NAME

6       App::Rad::Help - 'help' command extension for App::Rad
7

VERSION

9       Version 0.02
10

SYNOPSIS

12       you can add inline help for your App::Rad commands via "$c->register()"
13       or "$c->register_commands()":
14
15           use App::Rad;
16           App::Rad->run();
17
18           sub setup {
19               my $c = shift;
20
21               $c->register_commands( {
22                       foo => 'expand your foo!',
23                       bar => 'have a drink! arguments: --drink=DRINK',
24                   });
25
26               $c->register('baz', \&baz, 'do your thing');
27           }
28
29       you can also do it with the attribute 'Help' in your subs
30
31           sub my_command :Help(this is my command) {
32               ...
33           }
34
35           sub another_cmd
36           :Help(yet another command)
37           {
38               ...
39           }
40

DESCRIPTION

42       This is an internal module for App::Rad and should not be used
43       separately (unless, perhaps, you want to use one of its methods to
44       customize your own 'help' command). Please refer to App::Rad for
45       further documentation.
46

INTERNAL METHODS

48   load
49       Loads the module into App::Rad
50
51   help
52       Show help text
53
54   register_help
55       Associates help text with command
56
57   usage
58       Prints usage string. Default is "Usage: $0 command [arguments]", where
59       $0 is your program's name.
60
61   helpstr
62       Prints a help string with all available commands and their help
63       description.
64

DEPENDENCIES

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

AUTHOR

69       Breno G. de Oliveira, "<garu at cpan.org>"
70

ACKNOWLEDGEMENTS

72       The attribute handling was *much* easened because of the nice
73       "Attribute::Handlers" module. So many thanks to Damian Conway, Rafael
74       Garcia-Suarez and Steffen Mueller.
75

77       Copyright 2008 Breno G. de Oliveira "<garu at cpan.org>". All rights
78       reserved.
79
80       This module is free software; you can redistribute it and/or modify it
81       under the same terms as Perl itself. See perlartistic.
82

DISCLAIMER OF WARRANTY

84       BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
85       FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
86       WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
87       PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND,
88       EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
89       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
90       ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
91       YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
92       NECESSARY SERVICING, REPAIR, OR CORRECTION.
93
94       IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
95       WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
96       REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
97       TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
98       CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
99       SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
100       RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
101       FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
102       SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
103       DAMAGES.
104
105
106
107perl v5.36.0                      2022-07-22                 App::Rad::Help(3)
Impressum