Man pages sections > man3 > App::Cleo

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

App::Cleo(3pm) User Contributed Perl Documentation App::Cleo(3pm)

NAME

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

SYNOPSIS

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

DESCRIPTION

App::Cleo is the back-end for the cleo utility. Please see the cleo 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 milliseconds to wait before displaying each character of the command. The default is "25_000".
prompt
String to use for the artificial prompt. The token %d will be substituted with the number of the current command. The default is "(%d)$".
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> Copyright (c) 2014, Imaginative Software Systems
2017-10-31 perl v5.26.1