.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .\" ======================================================================== .\" .IX Title "CLEO 1p" .TH CLEO 1p "2022-08-28" "perl v5.34.0" "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" cleo \- Play back shell commands for live demonstrations .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& cleo COMMAND_FILE .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`cleo\*(C'\fR is a utility for playing back pre-recorded shell commands in a live demonstration. \f(CW\*(C`cleo\*(C'\fR displays the commands as if you had actually typed them and then executes them interactively. .PP There is probably an easy way to do this with \f(CW\*(C`expect\*(C'\fR or a similar tool. But I couldn't figure it out, so I built this. Your mileage may vary. .SH "PLAYBACK" .IX Header "PLAYBACK" \&\f(CW\*(C`cleo\*(C'\fR always pauses and waits for a keypress before displaying a command and before executing it. Pressing any key besides those listed below will advance the playback: .PP .Vb 6 \& Key Action \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& s skip the current command \& r redo the current command \& p redo the previous command \& q quit playback .Ve .SH "COMMANDS" .IX Header "COMMANDS" \&\f(CW\*(C`cleo\*(C'\fR reads commands from a file. Each line is treated as one command. Blank lines and those starting with \f(CW\*(C`#\*(C'\fR will be ignored. The commands themselves can be anything that you would type into an interactive shell. You can also add a few special tokens that \f(CW\*(C`cleo\*(C'\fR recognizes: .ie n .IP """!!!""" 4 .el .IP "\f(CW!!!\fR" 4 .IX Item "!!!" Commands starting with \f(CW\*(C`!!!\*(C'\fR (three exclamation points) are not displayed and will be executed immediately. This is useful for running setup commands at the beginning of your demonstration. .ie n .IP """%%%""" 4 .el .IP "\f(CW%%%\fR" 4 .IX Item "%%%" Within a command, \f(CW\*(C`%%%\*(C'\fR (three percent signs) will cause \f(CW\*(C`cleo\*(C'\fR to pause and wait for a keypress before displaying the rest of the command. This is useful if you want to stop in the middle of a command to give some explanation. .PP Otherwise, \f(CW\*(C`cleo\*(C'\fR displays and executes the commands verbatim. Note that some interactive commands like \f(CW\*(C`vim\*(C'\fR are picky about \s-1STDOUT\s0 and \s-1STDIN.\s0 To make them work properly with \f(CW\*(C`cleo\*(C'\fR, you may need to force them to attach to the terminal like this: .PP .Vb 1 \& (exec < /dev/tty vim) .Ve .SH "EXAMPLE" .IX Header "EXAMPLE" I use this for giving demonstrations of pinto, such as the one seen at (the live demonstration part starts around 10:47). .PP The command file that I use for that presentation is included inside this distribution at \fIexamples/pinto.demo\fR. This file is for illustration only, so don't expect it to actually work for you. .SH "LIMITATIONS" .IX Header "LIMITATIONS" \&\f(CW\*(C`cleo\*(C'\fR only works on Unix-like platforms. It may work on Windows if you use Cygwin. Personally, I have only used \f(CW\*(C`cleo\*(C'\fR on Mac \s-1OS X.\s0 .SH "TODO" .IX Header "TODO" .IP "Jump to arbitrary command number" 4 .IX Item "Jump to arbitrary command number" .PD 0 .IP "Support backspacing in recorded command" 4 .IX Item "Support backspacing in recorded command" .IP "Support multi-line recorded commands" 4 .IX Item "Support multi-line recorded commands" .IP "Write unit tests" 4 .IX Item "Write unit tests" .PD .SH "AUTHOR" .IX Header "AUTHOR" Jeffrey Ryan Thalhammer .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2014, Imaginative Software Systems