Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

prophet::cli::command(3pm) [debian man page]

Prophet::CLI::Command(3pm)				User Contributed Perl Documentation				Prophet::CLI::Command(3pm)

   Registering argument translations
       This is the Prophet CLI's way of supporting short forms for arguments, e.g. you want to let '-v' be able to used for the same purpose as
       '--verbose' without dirtying your code checking both or manually setting them if they exist. We want it to be as easy as possible to have
       short commands.

       To use, have your command subclass do:

	   sub ARG_TRANSLATIONS { shift->SUPER::ARG_TRANSLATIONS(),  f => 'file' };

       You can register as many translations at a time as you want.  The arguments will be translated when the command object is instantiated. If
       an arg already exists in the arg translation table, it is overwritten with the new value.

   require_uuid
       Checks to make sure the uuid attribute is set. Prints an error and dies with the command's usage string if it is not set.

   edit_text [text] -> text
       Filters the given text through the user's $EDITOR using Proc::InvokeEditor.

   edit_hash hash => hashref, ordering => arrayref
       Filters the hash through the user's $EDITOR using Proc::InvokeEditor.

       No validation is done on the input or output.

       If the optional ordering argument is specified, hash keys will be presented in that order (with unspecified elements following) for edit.

       If the record class for the current type defines a "immutable_props" routine, those props will not be presented for editing.

       False values are not returned unless a prop is removed from the output.

   edit_props arg => str, defaults => hashref, ordering => arrayref
       Returns a hashref of the command's props mixed in with any default props.  If the "arg" argument is specified, (default "edit", use "undef"
       if you only want default arguments), then "edit_hash" is invoked on the property list.

       If the "ordering" argument is specified, properties will be presented in that order (with unspecified props following) if filtered through
       "edit_hash".

   prompt_choices question
       Asks user the question and returns 0 if answer was the second choice, 1 otherwise. (First choice is the default.)

   prompt_Yn question
       Asks user the question and returns true if answer was positive or false otherwise. Default answer is 'Yes' (returns true).

   print_usage
       Print the command's usage message to STDERR and die. Commands should implement "usage_msg", which returns the usage message.

       If the usage message method needs arguments passed in, use a closure.

   get_cmd_and_subcmd_names [no_type => 1]
       Gets the name of the script that was run and the primary commands that were specified on the command-line. If a true boolean is passed in
       as "no_type", won't add '<record-type>' to the subcmd if no type was passed in via the primary commands.

perl v5.10.1							    2009-08-19						Prophet::CLI::Command(3pm)

Check Out this Related Man Page

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.18.2							    2010-12-02						      App::CLI::Command(3)
Man Page