app::cmd::command::help(3pm) [debian man page]
App::Cmd::Command::help(3pm) User Contributed Perl Documentation App::Cmd::Command::help(3pm) NAME
App::Cmd::Command::help - display a command's help screen VERSION
version 0.318 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. USAGE
The help text is generated from three sources: o The "usage_desc" method o The "description" method o The "opt_spec" data structure The "usage_desc" method provides the opening usage line, following the specification described in Getopt::Long::Descriptive. In some cases, the default "usage_desc" in App::Cmd::Command may be sufficient and you will only need to override it to provide additional command line usage information. The "opt_spec" data structure is used with Getopt::Long::Descriptive to generate the description of the optons. Subcommand classes should override the "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 AUTHOR
Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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. perl v5.14.2 2012-05-05 App::Cmd::Command::help(3pm)
Check Out this Related Man Page
App::Cmd::Tester(3pm) User Contributed Perl Documentation App::Cmd::Tester(3pm) NAME
App::Cmd::Tester - for capturing the result of running an app VERSION
version 0.318 SYNOPSIS
use Test::More tests => 4; use App::Cmd::Tester; use YourApp; my $result = test_app(YourApp => [ qw(command --opt value) ]); like($result->stdout, qr/expected output/, 'printed what we expected'); is($result->stderr, '', 'nothing sent to sderr'); is($result->error, undef, 'threw no exceptions'); my $result = test_app(YourApp => [ qw(command --opt value --quiet) ]); is($result->output, '', 'absolutely no output with --quiet'); DESCRIPTION
One of the reasons that user-executed programs are so often poorly tested is that they are hard to test. App::Cmd::Tester is one of the tools App-Cmd provides to help make it easy to test App::Cmd-based programs. It provides one routine: test_app. METHODS
test_app Note: while "test_app" is a method, it is by default exported as a subroutine into the namespace that uses App::Cmd::Tester. In other words: you probably don't need to think about this as a method unless you want to subclass App::Cmd::Tester. my $result = test_app($app_class => @argv_contents); This will locally set @ARGV to simulate command line arguments, and will then call the "run" method on the given application class (or application). Output to the standard output and standard error filehandles will be captured. $result is an App::Cmd::Tester::Result object, which has methods to access the following data: stdout - the output sent to stdout stderr - the output sent to stderr output - the combined output of stdout and stderr error - the exception thrown by running the application, or undef run_rv - the return value of the run method (generally irrelevant) exit_code - the numeric exit code that would've been issued (0 is 'okay') AUTHOR
Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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. perl v5.14.2 2012-05-05 App::Cmd::Tester(3pm)