jammy (3) App::Cmd::Command::commands.3pm.gz

Provided by: libapp-cmd-perl_0.334-1_all bug

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


VERSION
       version 0.334


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


PERL VERSION SUPPORT
       This module has a long-term perl support period.  That means it will not require a version of perl
       released fewer than five years ago.

       Although it may work on older versions of perl, no guarantee is made that the minimum required version
       will not be increased.  The version may be increased for any reason, and there is no promise that patches
       will be accepted to lower the minimum required perl.


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 overridden by implementing the "commands_groups" method in your application base
       clase.


AUTHOR
       Ricardo Signes <rjbs@semiotic.systems>


       This software is copyright (c) 2021 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.