/usr/share/perl5/App/Cmd/Command/help.pm is in libapp-cmd-perl 0.324-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | use strict;
use warnings;
package App::Cmd::Command::help;
$App::Cmd::Command::help::VERSION = '0.324';
use App::Cmd::Command;
BEGIN { our @ISA = 'App::Cmd::Command'; }
# ABSTRACT: display a command's help screen
#pod =head1 DESCRIPTION
#pod
#pod This command plugin implements a "help" command. This command will either list
#pod all of an App::Cmd's commands and their abstracts, or display the usage screen
#pod for a subcommand with its description.
#pod
#pod =head1 USAGE
#pod
#pod The help text is generated from three sources:
#pod
#pod =for :list
#pod * The C<usage_desc> method
#pod * The C<description> method
#pod * The C<opt_spec> data structure
#pod
#pod The C<usage_desc> method provides the opening usage line, following the
#pod specification described in L<Getopt::Long::Descriptive>. In some cases,
#pod the default C<usage_desc> in L<App::Cmd::Command> may be sufficient and
#pod you will only need to override it to provide additional command line
#pod usage information.
#pod
#pod The C<opt_spec> data structure is used with L<Getopt::Long::Descriptive>
#pod to generate the description of the options.
#pod
#pod Subcommand classes should override the C<discription> method to provide
#pod additional information that is prepended before the option descriptions.
#pod
#pod For example, consider the following subcommand module:
#pod
#pod package YourApp::Command::initialize;
#pod
#pod # This is the default from App::Cmd::Command
#pod sub usage_desc {
#pod my ($self) = @_;
#pod my $desc = $self->SUPER::usage_desc; # "%c COMMAND %o"
#pod return "$desc [DIRECTORY]";
#pod }
#pod
#pod sub description {
#pod return "The initialize command prepares the application...";
#pod }
#pod
#pod sub opt_spec {
#pod return (
#pod [ "skip-refs|R", "skip reference checks during init", ],
#pod [ "values|v=s@", "starting values", { default => [ 0, 1, 3 ] } ],
#pod );
#pod }
#pod
#pod ...
#pod
#pod That module would generate help output like this:
#pod
#pod $ yourapp help initialize
#pod yourapp initialize [-Rv] [long options...] [DIRECTORY]
#pod
#pod The initialize command prepares the application...
#pod
#pod --help This usage screen
#pod -R --skip-refs skip reference checks during init
#pod -v --values starting values
#pod
#pod =cut
sub usage_desc { '%c help [subcommand]' }
sub command_names { qw/help --help -h -?/ }
sub description {
"This command will either list all of the application commands and their
abstracts, or display the usage screen for a subcommand with its
description.\n"
}
sub execute {
my ($self, $opts, $args) = @_;
if (!@$args) {
my $usage = $self->app->usage->text;
my $command = $0;
# chars normally used to describe options
my $opt_descriptor_chars = qr/[\[\]<>\(\)]/;
if ($usage =~ /^(.+?) \s* (?: $opt_descriptor_chars | $ )/x) {
# try to match subdispatchers too
$command = $1;
}
# evil hack ;-)
bless
$self->app->{usage} = sub { return "$command help <command>\n" }
=> "Getopt::Long::Descriptive::Usage";
$self->app->execute_command( $self->app->_prepare_command("commands") );
} else {
my ($cmd, $opt, $args) = $self->app->prepare_command(@$args);
local $@;
my $desc = $cmd->description;
$desc = "\n$desc" if length $desc;
my $ut = join "\n",
eval { $cmd->usage->leader_text },
$desc,
eval { $cmd->usage->option_text };
print "$ut\n";
}
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
App::Cmd::Command::help - display a command's help screen
=head1 VERSION
version 0.324
=head1 DESCRIPTION
This command plugin implements a "help" command. This command will either list
all of an App::Cmd's commands and their abstracts, or display the usage screen
for a subcommand with its description.
=head1 USAGE
The help text is generated from three sources:
=over 4
=item *
The C<usage_desc> method
=item *
The C<description> method
=item *
The C<opt_spec> data structure
=back
The C<usage_desc> method provides the opening usage line, following the
specification described in L<Getopt::Long::Descriptive>. In some cases,
the default C<usage_desc> in L<App::Cmd::Command> may be sufficient and
you will only need to override it to provide additional command line
usage information.
The C<opt_spec> data structure is used with L<Getopt::Long::Descriptive>
to generate the description of the options.
Subcommand classes should override the C<discription> method to provide
additional information that is prepended before the option descriptions.
For example, consider the following subcommand module:
package YourApp::Command::initialize;
# This is the default from App::Cmd::Command
sub usage_desc {
my ($self) = @_;
my $desc = $self->SUPER::usage_desc; # "%c COMMAND %o"
return "$desc [DIRECTORY]";
}
sub description {
return "The initialize command prepares the application...";
}
sub opt_spec {
return (
[ "skip-refs|R", "skip reference checks during init", ],
[ "values|v=s@", "starting values", { default => [ 0, 1, 3 ] } ],
);
}
...
That module would generate help output like this:
$ yourapp help initialize
yourapp initialize [-Rv] [long options...] [DIRECTORY]
The initialize command prepares the application...
--help This usage screen
-R --skip-refs skip reference checks during init
-v --values starting values
=head1 AUTHOR
Ricardo Signes <rjbs@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014 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.
=cut
|