term-utils/scriptreplay.1

   1 .TH SCRIPTREPLAY 1 "September 2011" "util-linux" "User Commands"
   2 .SH "NAME"
   3 scriptreplay \- play back typescripts, using timing information
   4 .SH "SYNOPSIS"
   5 .B scriptreplay
   6 [options]
   7 .RB [ \-t ]
   8 .I timingfile
   9 .RI [ typescript
  10 .RI [ divisor ]]
  11 .SH "DESCRIPTION"
  12 This program replays a typescript, using timing information to ensure that
  13 output happens in the same rhythm as it originally appeared when the script
  14 was recorded.
  15 .PP
  16 The replay simply displays the information again; the programs
  17 that were run when the typescript was being recorded are not run again.
  18 Since the same information is simply being displayed,
  19 .B scriptreplay
  20 is only guaranteed to work properly if run on the same type of
  21 terminal the typescript was recorded on.  Otherwise, any escape characters
  22 in the typescript may be interpreted differently by the terminal to
  23 which
  24 .B scriptreplay
  25 is sending its output.
  26 .PP
  27 The timing information is what
  28 .BR script (1)
  29 outputs to standard error if it is
  30 run with the
  31 .B \-t
  32 parameter.
  33 .PP
  34 By default, the typescript to display is assumed to be named
  35 .BR typescript ,
  36 but other filenames may be specified, as the second parameter or with option
  37 .BR \-s .
  38 .PP
  39 If the third parameter is specified, it is used as a speed-up multiplier.
  40 For example, a speed-up of 2 makes
  41 .B scriptreplay
  42 go twice as fast, and a speed-up of 0.1 makes it go ten times slower
  43 than the original session.
  44 .SH OPTIONS
  45 The first three options will override old-style arguments.
  46 .TP
  47 .BR \-t , " \-\-timing " \fIfile\fR
  48 File containing \fBscript\fR's timing output.
  49 .TP
  50 .BR \-s , " \-\-typescript " \fIfile\fR
  51 File containing \fBscript\fR's terminal output.
  52 .TP
  53 .BR \-d , " \-\-divisor " \fInumber\fR
  54 Speed up the replay displaying this
  55 .I number
  56 of times.  The argument is a floating point number.  It's called divisor
  57 because it divides the timings by this factor.
  58 .TP
  59 .BR \-m , " \-\-maxdelay " \fInumber\fR
  60 Set the maximum delay between transcript updates to
  61 .I number
  62 of seconds.  The argument is a floating point number.  This can be used to
  63 avoid long pauses in the transcript replay.
  64 .TP
  65 .BR \-V , " \-\-version"
  66 Display version information and exit.
  67 .TP
  68 .BR \-h , " \-\-help"
  69 Display help text and exit.
  70 .SH "EXAMPLE"
  71 .nf
  72 % script --timing=file.tm script.out
  73 Script started, file is script.out
  74 % ls
  75 <etc, etc>
  76 % exit
  77 Script done, file is script.out
  78 % scriptreplay --timing file.tm --typescript script.out
  79 .nf
  80 .SH "SEE ALSO"
  81 .BR script (1)
  82 .SH "COPYRIGHT"
  83 Copyright \(co 2008 James Youngman
  84 .br
  85 Copyright \(co 2008 Karel Zak
  86 .PP
  87 This is free software; see the source for copying conditions.  There is NO
  88 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
  89 PURPOSE.
  90 .PP
  91 Released under the GNU General Public License version 2 or later.
  92 .SH "AUTHOR"
  93 The original
  94 .B scriptreplay
  95 program was written by
  96 .MT joey@\:kitenet.net
  97 Joey Hess
  98 .ME .
  99 The program was re-written in C by
 100 .MT jay@\:gnu.org
 101 James Youngman
 102 .ME
 103 and
 104 .MT kzak@\:redhat.com
 105 Karel Zak
 106 .ME .
 107 .SH AVAILABILITY
 108 The scriptreplay command is part of the util-linux package and is available from
 109 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 110 Linux Kernel Archive
 111 .UE .