Ricardo SIGNES > App-Cmd-0.321 > App::Cmd::Command::help

Download:
App-Cmd-0.321.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.321   Source   Latest Release: App-Cmd-0.324

NAME ^

App::Cmd::Command::help - display a command's help screen

VERSION ^

version 0.321

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:

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) 2013 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.

syntax highlighting: