<html><head><title>Footprintless::App::Action</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
<style type="text/css">
<!--/*--><![CDATA[/*><!--*/
BODY {
background: white;
color: black;
font-family: arial,sans-serif;
margin: 0;
padding: 1ex;
}
A:link, A:visited {
background: transparent;
color: #006699;
}
A[href="#POD_ERRORS"] {
background: transparent;
color: #FF0000;
}
DIV {
border-width: 0;
}
DT {
margin-top: 1em;
margin-left: 1em;
}
.pod { margin-right: 20ex; }
.pod PRE {
background: #eeeeee;
border: 1px solid #888888;
color: black;
padding: 1em;
white-space: pre;
}
.pod H1 {
background: transparent;
color: #006699;
font-size: large;
}
.pod H1 A { text-decoration: none; }
.pod H2 A { text-decoration: none; }
.pod H3 A { text-decoration: none; }
.pod H4 A { text-decoration: none; }
.pod H2 {
background: transparent;
color: #006699;
font-size: medium;
}
.pod H3 {
background: transparent;
color: #006699;
font-size: medium;
font-style: italic;
}
.pod H4 {
background: transparent;
color: #006699;
font-size: medium;
font-weight: normal;
}
.pod IMG {
vertical-align: top;
}
.pod .toc A {
text-decoration: none;
}
.pod .toc LI {
line-height: 1.2em;
list-style-type: none;
}
/*]]>*/-->
</style>
</head>
<body class='pod'>
<!--
generated by Pod::Simple::HTML v3.32,
using Pod::Simple::PullParser v3.32,
under Perl v5.025000 at Tue Feb 13 13:45:22 2018 GMT.
If you want to change this HTML document, you probably shouldn't do that
by changing it directly. Instead, see about changing the calling options
to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
then reconverting this document from the Pod source.
When in doubt, email the author of Pod::Simple::HTML for advice.
See 'perldoc Pod::Simple::HTML' for more info.
-->
<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>
<div class='indexgroup'>
<ul class='indexList indexList1'>
<li class='indexItem indexItem1'><a href='#NAME'>NAME</a>
<li class='indexItem indexItem1'><a href='#VERSION'>VERSION</a>
<li class='indexItem indexItem1'><a href='#FUNCTIONS'>FUNCTIONS</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#abstract(%24self_or_class)'>abstract($self_or_class)</a>
<li class='indexItem indexItem2'><a href='#description(%24self_or_class)'>description($self_or_class)</a>
<li class='indexItem indexItem2'><a href='#opt_spec()'>opt_spec()</a>
<li class='indexItem indexItem2'><a href='#prepare(%24class%2C_%24app%2C_%24footprintless%2C_%24coordinate%2C_%40args)'>prepare($class, $app, $footprintless, $coordinate, @args)</a>
</ul>
<li class='indexItem indexItem1'><a href='#METHODS'>METHODS</a>
<ul class='indexList indexList2'>
<li class='indexItem indexItem2'><a href='#execute(%24opts%2C_%24args)'>execute($opts, $args)</a>
<li class='indexItem indexItem2'><a href='#usage()'>usage()</a>
<li class='indexItem indexItem2'><a href='#usage_error(%24message%2C_%24coordinate)'>usage_error($message, $coordinate)</a>
<li class='indexItem indexItem2'><a href='#usage_desc()'>usage_desc()</a>
<li class='indexItem indexItem2'><a href='#validate_args(%24opts%2C_%24args)'>validate_args($opts, $args)</a>
</ul>
<li class='indexItem indexItem1'><a href='#AUTHOR'>AUTHOR</a>
<li class='indexItem indexItem1'><a href='#COPYRIGHT_AND_LICENSE'>COPYRIGHT AND LICENSE</a>
<li class='indexItem indexItem1'><a href='#SEE_ALSO'>SEE ALSO</a>
</ul>
</div>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="NAME"
>NAME</a></h1>
<p>Footprintless::App::Action - A base class for actions</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="VERSION"
>VERSION</a></h1>
<p>version 1.27</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="FUNCTIONS"
>FUNCTIONS</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="abstract($self_or_class)"
>abstract($self_or_class)</a></h2>
<p>Returns the abstract for the action.
By default it will pull it from the <code>ABSTRACT</code> section of the pod.
This function should be called using <i>method invokation</i>.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="description($self_or_class)"
>description($self_or_class)</a></h2>
<p>Returns the description for the action.
By default it will pull it from the <code>DESCRIPTION</code> section of the pod.
This function should be called using <i>method invokation</i>.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="opt_spec()"
>opt_spec()</a></h2>
<p>Returns an options specificatino for this action according to <a href="http://search.cpan.org/perldoc?Getopt%3A%3ALong%3A%3ADescriptive" class="podlinkpod"
>Getopt::Long::Descriptive</a>.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="prepare($class,_$app,_$footprintless,_$coordinate,_@args)"
>prepare($class,
$app,
$footprintless,
$coordinate,
@args)</a></h2>
<p>Processes <code>@args</code> to parse off the options,
then generates a new instance of the action implementation and returns the 3-tuple: action,
options,
remaining args.
See <a href="http://search.cpan.org/perldoc?App%3A%3ACmd%3A%3ACommand%3A%3Aprepare" class="podlinkpod"
>App::Cmd::Command::prepare</a> for inspiration.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="METHODS"
>METHODS</a></h1>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="execute($opts,_$args)"
>execute($opts,
$args)</a></h2>
<p>Executes the action.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="usage()"
>usage()</a></h2>
<p>Returns the usage object from <a href="http://search.cpan.org/perldoc?Getopt%3A%3ALong%3A%3ADescriptive" class="podlinkpod"
>Getopt::Long::Descriptive</a> for the action.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="usage_error($message,_$coordinate)"
>usage_error($message,
$coordinate)</a></h2>
<p>Die's with a generated message based on <code>$message</code> and <code>$coordinate</code>.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="usage_desc()"
>usage_desc()</a></h2>
<p>Returns the top level usage line.
See <a href="http://search.cpan.org/perldoc?App%3A%3ACmd%3A%3ACommand%3A%3Ausage_desc" class="podlinkpod"
>App::Cmd::Command::usage_desc</a> for inspiration.</p>
<h2><a class='u' href='#___top' title='click to go to top of document'
name="validate_args($opts,_$args)"
>validate_args($opts,
$args)</a></h2>
<p>Performs additional validation on <code>$opts</code> and <code>$args</code>.
Calls <a href="#usage_error(%24message%2C_%24coordinate)" class="podlinkpod"
>"usage_error($message,
$coordinate)"</a> if there is a problem.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="AUTHOR"
>AUTHOR</a></h1>
<p>Lucas Theisen <lucastheisen@pastdev.com></p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="COPYRIGHT_AND_LICENSE"
>COPYRIGHT AND LICENSE</a></h1>
<p>This software is copyright (c) 2016 by Lucas Theisen.</p>
<p>This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.</p>
<h1><a class='u' href='#___top' title='click to go to top of document'
name="SEE_ALSO"
>SEE ALSO</a></h1>
<p>Please see those modules/websites for more information related to this module.</p>
<ul>
<li><a href="http://search.cpan.org/perldoc?Footprintless" class="podlinkpod"
>Footprintless</a></li>
<li><a href="http://search.cpan.org/perldoc?Footprintless%3A%3AApp%3A%3ADocumentationUtil" class="podlinkpod"
>Footprintless::App::DocumentationUtil</a></li>
</ul>
<!-- end doc -->
</body></html>