ADC Home > Reference Library > Reference > Mac OS X > Mac OS X Man Pages

 

This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).



App::CLI::Command(3)                 User Contributed Perl Documentation                App::CLI::Command(3)



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

SYNOPSIS
         package MyApp;
         use base 'App::CLI';

         package main;

         MyApp->dispatch;

         package MyApp::Help;
         use base 'App::CLI::Command';

         sub options {
           ('verbose' => 'verbose');
         }

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

DESCRIPTION
       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 POD.

       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.

TODO
       More documentation

SEE ALSO
       App::CLI

AUTHORS
       Chia-liang Kao <clkao@clkao.org>

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 <http://www.perl.com/perl/misc/Artistic.html



perl v5.8.8                                      2006-11-24                             App::CLI::Command(3)

Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.