Ricardo SIGNES > App-Cmd > App::Cmd::Command::commands

Download:
App-Cmd-0.328.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.328   Source  

NAME ^

App::Cmd::Command::commands - list the application's commands

VERSION ^

version 0.328

DESCRIPTION ^

This command will list all of the application commands available and their abstracts.

METHODS ^

execute

This is the command's primary method and raison d'etre. It prints the application's usage text (if any) followed by a sorted listing of the application's commands and their abstracts.

The commands are printed in sorted groups (created by sort_commands); each group is set off by blank lines.

sort_commands

  my @sorted = $cmd->sort_commands(@unsorted);

This method orders the list of commands into groups which it returns as a list of arrayrefs, and optional group header strings.

By default, the first group is for the "help" and "commands" commands, and all other commands are in the second group.

This method can be overriden by implementing the commands_groups method in your application base clase.

AUTHOR ^

Ricardo Signes <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2015 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: