App::CLI::Command (3)

Leading comments

Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/App::CLI::Command.3pm".)

NAME

App::CLI::Command - Base class for App::CLI commands

SYNOPSIS

    package MyApp::List;
    use base qw(App::CLI::Command);

    use constant options => (
        'verbose'   => 'verbose',
        'n|name=s'  => 'name',
    );

    sub run {
        my ( $self, $arg ) = @_;

        print "verbose" if $self->{verbose};

        my $name = $self->{name}; # get arg following long option --name

        # any thing your want this command do
    }

    # See App::CLI for information of how to invoke (sub)command.

DESCRIPTION

subcommand()

    return old genre subcommand of $self;

cascading()

return instance of cascading subcommand invoked if it was listed in your constant subcommands.

cascadable()

return package name of subcommand if the subcommand invoked is in you constant subcommands

otherwise, return undef

brief_usage ($file)

Display an one-line brief usage of the command object. Optionally, a file could be given to extract the usage from the

usage ($want_detail)

Display usage. If $want_detail is true, the "DESCRIPTION" section is displayed as well.

loc_text $text

Localizes the body of (formatted) text in $text, and returns the localized version.

filename

Return the filename for the command module.

SEE ALSO

App::CLI Getopt::Long

AUTHORS

Chia-liang Kao <clkao@clkao.org> Cornelius Lin <cornelius.howl@gmail.com> shelling <navyblueshellingford@gmail.com>

COPYRIGHT

Copyright 2005-2006 by Chia-liang Kao <clkao@clkao.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See <www.perl.com/perl/misc/Artistic.html>