NAME¶

App::Spec::Plugin::Help - App::Spec Plugin for help subcommand and options

DESCRIPTION¶

This plugin is enabled in App::Spec by default.

This is a plugin which adds "-h|--help" options to your app. Also for apps with subcommands it adds a subcommand "help".

The help command can then be called with all existing subcommands, like this:

    % app cmd1
    % app cmd2
    % app cmd2 cmd2a
    % app help
    % app help cmd1
    % app help cmd2
    % app help cmd2 cmd2a

METHODS¶

cmd_help

This is the code which is executed when using "-h|--help" or the subcommand help.

install_options

This method is required by App::Spec::Role::Plugin::GlobalOptions.

See App::Spec::Role::Plugin::GlobalOptions#install_options.

install_subcommands

This is required by App::Spec::Role::Plugin::Subcommand.

See App::Spec::Role::Plugin::Subcommand#install_subcommands.

global_options

This method is called by App::Spec::Run after global options have been read.

For apps without subcommands it just sets the method to execute to App::Spec::Plugin::Help::cmd_help. No further processing is done.

For apps with subcommands it inserts "help" at the beginning of the commandline arguments and continues processing.

init_run

See App::Spec::Plugin