app::cmd::setup(3pm) [debian man page]
App::Cmd::Setup(3pm) User Contributed Perl Documentation App::Cmd::Setup(3pm) NAME
App::Cmd::Setup - helper for setting up App::Cmd classes VERSION
version 0.318 OVERVIEW
App::Cmd::Setup is a helper library, used to set up base classes that will be used as part of an App::Cmd program. For the most part you should refer to the tutorial for how you should use this library. This class is useful in three scenarios: when writing your App::Cmd subclass Instead of writing: package MyApp; use base 'App::Cmd'; ...you can write: package MyApp; use App::Cmd::Setup -app; The benefits of doing this are mostly minor, and relate to sanity-checking your class. The significant benefit is that this form allows you to specify plugins, as in: package MyApp; use App::Cmd::Setup -app => { plugins => [ 'Prompt' ] }; Plugins are described in App::Cmd::Tutorial and App::Cmd::Plugin. when writing abstract base classes for commands That is: when you write a subclass of App::Cmd::Command that is intended for other commands to use as their base class, you should use App::Cmd::Setup. For example, if you want all the commands in MyApp to inherit from MyApp::Command, you may want to write that package like this: package MyApp::Command; use App::Cmd::Setup -command; Do not confuse this with the way you will write specific commands: package MyApp::Command::mycmd; use MyApp -command; Again, this form mostly performs some validation and setup behind the scenes for you. You can use "base" if you prefer. when writing App::Cmd plugins App::Cmd::Plugin is a mechanism that allows an App::Cmd class to inject code into all its command classes, providing them with utility routines. To write a plugin, you must use App::Cmd::Setup. As seen above, you must also use App::Cmd::Setup to set up your App::Cmd subclass if you wish to consume plugins. For more information on writing plugins, see App::Cmd::Manual and App::Cmd::Plugin. AUTHOR
Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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. perl v5.14.2 2012-05-05 App::Cmd::Setup(3pm)
Check Out this Related Man Page
App::Cmd::Command(3pm) User Contributed Perl Documentation App::Cmd::Command(3pm) NAME
App::Cmd::Command - a base class for App::Cmd commands VERSION
version 0.318 METHODS
prepare my ($cmd, $opt, $args) = $class->prepare($app, @args); This method is the primary way in which App::Cmd::Command objects are built. Given the remaining command line arguments meant for the command, it returns the Command object, parsed options (as a hashref), and remaining arguments (as an arrayref). In the usage above, $app is the App::Cmd object that is invoking the command. new This returns a new instance of the command plugin. Probably only "prepare" should use this. execute $command_plugin->execute(\%opt, @args); This method does whatever it is the command should do! It is passed a hash reference of the parsed command-line options and an array reference of left over arguments. If no "execute" method is defined, it will try to call "run" -- but it will warn about this behavior during testing, to remind you to fix the method name! app This method returns the App::Cmd object into which this command is plugged. usage This method returns the usage object for this command. (See Getopt::Long::Descriptive). command_names This method returns a list of command names handled by this plugin. The first item returned is the 'canonical' name of the command. If this method is not overridden by an App::Cmd::Command subclass, it will return the last part of the plugin's package name, converted to lowercase. For example, YourApp::Cmd::Command::Init will, by default, handle the command "init". Subclasses should generally get the superclass value of "command_names" and then append aliases. usage_desc This method should be overridden to provide a usage string. (This is the first argument passed to "describe_options" from Getopt::Long::Descriptive.) If not overridden, it returns "%c COMMAND %o"; COMMAND is the first item in the result of the "command_names" method. opt_spec This method should be overridden to provide option specifications. (This is list of arguments passed to "describe_options" from Getopt::Long::Descriptive, after the first.) If not overridden, it returns an empty list. validate_args $command_plugin->validate_args(\%opt, @args); This method is passed a hashref of command line options (as processed by Getopt::Long::Descriptive) and an arrayref of leftover arguments. It may throw an exception (preferably by calling "usage_error", below) if they are invalid, or it may do nothing to allow processing to continue. usage_error $self->usage_error("This command must not be run by root!"); This method should be called to die with human-friendly usage output, during "validate_args". abstract This method returns a short description of the command's purpose. If this method is not overridden, it will return the abstract from the module's Pod. If it can't find the abstract, it will look for a comment starting with "ABSTRACT:" like the ones used by Pod::Weaver::Section::Name. description This method should be overridden to provide full option description. It is used by the built-in App::Cmd::Command::help command. If not overridden, it returns an empty string. AUTHOR
Ricardo Signes <rjbs@cpan.org> COPYRIGHT AND LICENSE
This software is copyright (c) 2012 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. perl v5.14.2 2012-05-05 App::Cmd::Command(3pm)