NAME

App::Cleo - Play back shell commands for live demonstrations

SYNOPSIS

  use App::Cleo::Patra
  my $patra = App::Cleo::Patra->new(%options);
  $patra->run($commands);

DESCRIPTION

Important: patra is an experimental fork from cleo. You should check the current differences from App-Cleo and decide, which one you want to use. It may be, that in your current time, patra is merged back into cleo or obsolete for other reasons.

App::Cleo::Patra is the back-end for the patra utility. Please see the patra documentation for details on how to use this.

CONSTRUCTOR

The constructor accepts arguments as key-value pairs. The following keys are supported:

delay

Number of microseconds to wait before displaying each character of the command. The default is 25_000.

ps1

String to use for the artificial prompt. The token %d will be substituted with the number of the current command. The default is (%d)$.

ps2

String to use for the artificial prompt that appears for multiline commands. The token %d will be substituted with the number of the current command. The default is >.

shell

Path to the shell command that will be used to run the commands. Defaults to either the SHELL environment variable or /bin/bash.

METHODS

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.

AUTHOR

Jeffrey Ryan Thalhammer <thaljef@cpan.org>

Boris Däppeb (BORISD) <bdaeppen.perl@gmail.com>

COPYRIGHT

cleo - Copyright (c) 2014, Imaginative Software Systems

patra - Boris Däppen (BORISD) 2018