Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

app::cmd::simple(3pm) [debian man page]

App::Cmd::Simple(3pm)					User Contributed Perl Documentation				     App::Cmd::Simple(3pm)

NAME

       App::Cmd::Simple - a helper for building one-command App::Cmd applications

VERSION

       version 0.318

SYNOPSIS

       in simplecmd:

	 use YourApp::Cmd;
	 Your::Cmd->run;

       in YourApp/Cmd.pm:

	 package YourApp::Cmd;
	 use base qw(App::Cmd::Simple);

	 sub opt_spec {
	   return (
	     [ "blortex|X",  "use the blortex algorithm" ],
	     [ "recheck|r",  "recheck all results"	 ],
	   );
	 }

	 sub validate_args {
	   my ($self, $opt, $args) = @_;

	   # no args allowed but options!
	   $self->usage_error("No args allowed") if @$args;
	 }

	 sub execute {
	   my ($self, $opt, $args) = @_;

	   my $result = $opt->{blortex} ? blortex() : blort();

	   recheck($result) if $opt->{recheck};

	   print $result;
	 }

       and, finally, at the command line:

	 knight!rjbs$ simplecmd --recheck

	 All blorts successful.

SUBCLASSING

       When writing a subclass of App::Cmd:Simple, there are only a few methods that you might want to implement.  They behave just like the same-
       named methods in App::Cmd.

   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
	 $cmd->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") if they are invalid, or it may do nothing to allow processing to continue.

   execute
	 Your::App::Cmd::Simple->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.

WARNINGS

       This should be considered experimental!	Although it is probably not going to change much, don't build your business model around it yet,
       okay?

       App::Cmd::Simple is not rich in black magic, but it does do some somewhat gnarly things to make an App::Cmd::Simple look as much like an
       App::Cmd::Command as possible.  This means that you can't deviate too much from the sort of thing shown in the synopsis as you might like.
       If you're doing something other than writing a fairly simple command, and you want to screw around with the App::Cmd-iness of your program,
       Simple might not be the best choice.

       One specific warning...	if you are writing a program with the App::Cmd::Simple class embedded in it, you must call import on the class.
       That's how things work.	You can just do this:

	 YourApp::Cmd->import->run;

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::Simple(3pm)

Check Out this Related 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)
Man Page