Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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::CLI::Command(3)					User Contributed Perl Documentation				      App::CLI::Command(3)

NAME

       App::CLI::Command - Base class for App::CLI commands

SYNOPSIS

	   package MyApp::List;
	   use base qw(App::CLI::Command);

	   use constant options => (
	       'verbose'   => 'verbose',
	       'n|name=s'  => 'name',
	   );

	   sub run {
	       my ( $self, $arg ) = @_;

	       print "verbose" if $self->{verbose};

	       my $name = $self->{name}; # get arg following long option --name

	       # any thing your want this command do
	   }

	   # See App::CLI for information of how to invoke (sub)command.

DESCRIPTION

       subcommand()

	   return old genre subcommand of $self;

       cascading()

       return instance of cascading subcommand invoked if it was listed in your constant subcommands.

       cascadable()

       return package name of subcommand if the subcommand invoked is in you constant subcommands

       otherwise, return undef

       brief_usage ($file)

       Display an one-line brief usage of the command object.  Optionally, a file could be given to extract the usage from the POD.

       usage ($want_detail)

       Display usage.  If $want_detail is true, the "DESCRIPTION" section is displayed as well.

       loc_text $text

       Localizes the body of (formatted) text in $text, and returns the localized version.

       filename

       Return the filename for the command module.

SEE ALSO

       App::CLI Getopt::Long

AUTHORS

       Chia-liang Kao <clkao@clkao.org> Cornelius Lin  <cornelius.howl@gmail.com> shelling	 <navyblueshellingford@gmail.com>

COPYRIGHT

       Copyright 2005-2006 by Chia-liang Kao <clkao@clkao.org>.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

       See <http://www.perl.com/perl/misc/Artistic.html>

perl v5.18.2							    2010-12-02						      App::CLI::Command(3)
Man Page