1App::Cmd::Command::commUasnedrs(C3o)ntributed Perl DocumAepnpt:a:tCimodn::Command::commands(3)
2
3
4
6 App::Cmd::Command::commands - list the application's commands
7
9 version 0.335
10
12 This command will list all of the application commands available and
13 their abstracts.
14
16 This library should run on perls released even a long time ago. It
17 should work on any version of perl released in the last five years.
18
19 Although it may work on older versions of perl, no guarantee is made
20 that the minimum required version will not be increased. The version
21 may be increased for any reason, and there is no promise that patches
22 will be accepted to lower the minimum required perl.
23
25 execute
26 This is the command's primary method and raison d'etre. It prints the
27 application's usage text (if any) followed by a sorted listing of the
28 application's commands and their abstracts.
29
30 The commands are printed in sorted groups (created by "sort_commands");
31 each group is set off by blank lines.
32
33 "sort_commands"
34 my @sorted = $cmd->sort_commands(@unsorted);
35
36 This method orders the list of commands into groups which it returns as
37 a list of arrayrefs, and optional group header strings.
38
39 By default, the first group is for the "help" and "commands" commands,
40 and all other commands are in the second group.
41
42 This method can be overridden by implementing the "commands_groups"
43 method in your application base clase.
44
46 Ricardo Signes <cpan@semiotic.systems>
47
49 This software is copyright (c) 2022 by Ricardo Signes.
50
51 This is free software; you can redistribute it and/or modify it under
52 the same terms as the Perl 5 programming language system itself.
53
54
55
56perl v5.36.0 2023-01-19 App::Cmd::Command::commands(3)