App::Cleo(3pm)

App::Cleo3pm

Play back shell commands for live demonstrations

Usage

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

Overview

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.

Releases

6 releases since Debian 8 (Jessie); the text changed 3 times.

  1. 8–9
  2. 10
  3. 11
  4. 12–13

Author

Jeffrey Ryan Thalhammer <[email protected]>

From cleo 0.004-4 in Debian 13 (Trixie). Parsed by carta from the page's man source.