NAME

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

VERSION

$Id: /my/cs/projects/app-cmd/trunk/lib/App/Cmd/Command/commands.pm 25152 2006-08-25T23:34:47.955138Z rjbs  $

DESCRIPTION

This command plugin implements a "commands" command. This command will list all of an App::Cmd's commands and their abstracts.

METHODS

run

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 sets which it returns as a list of arrayrefs.

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