.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "App::Cleo 3pm"
.TH App::Cleo 3pm "2017-10-31" "perl v5.26.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"
App::Cleo \- Play back shell commands for live demonstrations
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&  use App::Cleo
\&  my $cleo = App::Cleo\->new(%options);
\&  $cleo\->run($commands);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
App::Cleo is the back-end for the cleo utility.  Please see the cleo
documentation for details on how to use this.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
The constructor accepts arguments as key-value pairs.  The following keys are
supported:
.IP "delay" 4
.IX Item "delay"
Number of milliseconds to wait before displaying each character of the command.
The default is \f(CW\*(C`25_000\*(C'\fR.
.IP "prompt" 4
.IX Item "prompt"
String to use for the artificial prompt.  The token \f(CW%d\fR will be substituted
with the number of the current command.  The default is \f(CW\*(C`(%d)$\*(C'\fR.
.IP "shell" 4
.IX Item "shell"
Path to the shell command that will be used to run the commands.  Defaults to
either the \f(CW\*(C`SHELL\*(C'\fR environment variable or \f(CW\*(C`/bin/bash\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "run( $commands )" 4
.el .IP "run( \f(CW$commands\fR )" 4
.IX Item "run( $commands )"
Starts playback of commands.  If the argument is a string, it will be treated
as a file name and commands will be read from the file. If the argument is a
scalar reference, it will be treated as a string of commands separated by
newlines.  If the argument is an array reference, then each element of the
array will be treated as a command.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <thaljef@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2014, Imaginative Software Systems