GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  APP::CMD::SIMPLE (3)

.ds Aq ’

NAME

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

CONTENTS

VERSION

version 0.330

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

<B>This should be considered experimental!B> 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.

<B>One specific warning...B> if you are writing a program with the App::Cmd::Simple class embedded in it, you <B>mustB> 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) 2015 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 APP::CMD::SIMPLE (3) 2015-10-24

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.