-
-
19 Jun 2021 02:14:59 UTC
- Distribution: App-Cmd
- Module version: 0.334
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (2166 / 1 / 72)
- Kwalitee
Bus factor: 1- 87.27% Coverage
- License: perl_5
- Perl: v5.20.0
- Activity
24 month- Tools
- Download (49KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
and 28 contributors-
Ricardo Signes
-
Adam Prime
-
ambs
-
Andreas Hernitscheck
-
A. Sinan Unur
-
Chris 'BinGOs' Williams
-
David Golden
-
David Steinbrunner
-
Davor Cubranic
-
Denis Ibaev
-
Diab Jerius
-
Glenn Fowler
-
Ingy dot Net
-
Jakob Voss
-
Jérôme Quelin
-
John SJ Anderson
-
Karen Etheridge
-
Kent Fredric
-
Lucas Theisen
-
Matthew Astley
-
mokko
-
Olivier Mengué
-
Ryan C. Thompson
-
Salvatore Bonaccorso
-
Sergey Romanov
-
Stephan Loyd
-
Stephen Caldwell
-
Yuval Kogman
- Dependencies
- Capture::Tiny
- Carp
- Class::Load
- Data::OptList
- File::Basename
- Getopt::Long
- Getopt::Long::Descriptive
- IO::TieCombine
- Module::Pluggable::Object
- Pod::Usage
- String::RewritePrefix
- Sub::Exporter
- Sub::Exporter::Util
- Sub::Install
- Text::Abbrev
- constant
- experimental
- parent
- strict
- warnings
- Reverse dependencies
- CPAN Testers List
- Dependency graph
NAME
App::Cmd::Command::help - display a command's help screen
VERSION
version 0.334
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.
PERL VERSION SUPPORT
This module has a long-term perl support period. That means it will not require a version of perl released fewer than five years ago.
Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.
USAGE
The help text is generated from three sources:
The
usage_desc
methodThe
description
methodThe
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 defaultusage_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 options.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@semiotic.systems>
COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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.
Module Install Instructions
To install App::Cmd, copy and paste the appropriate command in to your terminal.
cpanm App::Cmd
perl -MCPAN -e shell install App::Cmd
For more information on module installation, please visit the detailed CPAN module installation guide.