Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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::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 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.

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

perl v5.24.1			  2010-12-02		  App::CLI::Command(3)

NAME | SYNOPSIS | DESCRIPTION | SEE ALSO | AUTHORS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=App::CLI::Command&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help