.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "MooseX::Runnable 3pm" .TH MooseX::Runnable 3pm "2019-02-20" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" MooseX::Runnable \- Tag a class as a runnable application .SH "VERSION" .IX Header "VERSION" version 0.10 .SH "SYNOPSIS" .IX Header "SYNOPSIS" Create a class, tag it runnable, and provide a \f(CW\*(C`run\*(C'\fR method: .PP .Vb 3 \& package App::HelloWorld; \& use feature \*(Aqsay\*(Aq; \& use Moose; \& \& with \*(AqMooseX::Runnable\*(Aq; \& \& sub run { \& my ($self,$name) = @_; \& say "Hello, $name."; \& return 0; # success \& } .Ve .PP Then you can run this class as an application with the included \&\f(CW\*(C`mx\-run\*(C'\fR script: .PP .Vb 3 \& $ mx\-run App::HelloWorld jrockway \& Hello, jrockway. \& $ .Ve .PP \&\f(CW\*(C`MooseX::Runnable\*(C'\fR supports MooseX::Getopt, and other similar systems (and is extensible, in case you have written such a system). .SH "DESCRIPTION" .IX Header "DESCRIPTION" MooseX::Runnable is a framework for making classes runnable applications. This role doesn't do anything other than tell the rest of the framework that your class is a runnable application that has a \&\f(CW\*(C`run\*(C'\fR method which accepts arguments and returns the process' exit code. .PP This is a convention that the community has been using for a while. This role tells the computer that your class uses this convention, and let's the computer abstract away some of the tedium this entails. .SH "REQUIRED METHODS" .IX Header "REQUIRED METHODS" .SS "run" .IX Subsection "run" Your class must implement \f(CW\*(C`run\*(C'\fR. It accepts the command-line args (that were not consumed by another parser, if applicable) and returns an integer representing the \s-1UNIX\s0 exit value. \f(CW\*(C`return 0\*(C'\fR means success. .SH "THINGS YOU GET" .IX Header "THINGS YOU GET" .ie n .SS """mx\-run""" .el .SS "\f(CWmx\-run\fP" .IX Subsection "mx-run" This is a script that accepts a \f(CW\*(C`MooseX::Runnable\*(C'\fR class and tries to run it, using \f(CW\*(C`MooseX::Runnable::Run\*(C'\fR. .PP The syntax is: .PP .Vb 1 \& mx\-run Class::Name \& \& mx\-run \-\- Class::Name .Ve .PP for example: .PP .Vb 1 \& mx\-run \-Ilib App::HelloWorld \-\-args \-\-go \-\-here .Ve .PP or: .PP .Vb 1 \& mx\-run \-Ilib +Persistent \-\-port 8080 \-\- App::HelloWorld \-\-args \-\-go \-\-here .Ve .ie n .SS """MooseX::Runnable::Run""" .el .SS "\f(CWMooseX::Runnable::Run\fP" .IX Subsection "MooseX::Runnable::Run" If you don't want to invoke your app with \f(CW\*(C`mx\-run\*(C'\fR, you can write a custom version using MooseX::Runnable::Run. .SH "ARCHITECTURE" .IX Header "ARCHITECTURE" \&\f(CW\*(C`MX::Runnable\*(C'\fR is designed to be extensible; users can run plugins from the command-line, and application developers can add roles to their class to control behavior. .PP For example, if you consume MooseX::Getopt, the command-line will be parsed with \f(CW\*(C`MooseX::Getopt\*(C'\fR. Any recognized args will be used to instantiate your class, and any extra args will be passed to \f(CW\*(C`run\*(C'\fR. .SH "CAVEATS" .IX Header "CAVEATS" Many of the plugins shipped are unstable; they may go away, change, break, etc. If there is no documentation for a plugin, it is probably just a prototype. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker (or bug\-MooseX\-Runnable@rt.cpan.org ). .PP There is also a mailing list available for users of this distribution, at . .PP There is also an irc channel available for users of this distribution, at \&\f(CW\*(C`#moose\*(C'\fR on \f(CW\*(C`irc.perl.org\*(C'\fR . .SH "AUTHOR" .IX Header "AUTHOR" Jonathan Rockway .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Jonathan Rockway .IP "\(bu" 4 Karen Etheridge .IP "\(bu" 4 Doug Bell .IP "\(bu" 4 Duke Leto .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2009 by Jonathan Rockway. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.