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 \fBnot run again\fR.
  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 file specified by
  30 .BR \-\-log-timing .
  31 .PP
  32 By default, the typescript to display is assumed to be named
  33 .BR typescript ,
  34 but other filenames may be specified, as the second parameter or with option
  35 .BR \-\-log\-out .
  36 .PP
  37 If the third parameter or
  38 .BR \-\-divisor
  39 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 .TP
  46 .BR \-I , " \-\-log-in " \fIfile\fR
  47 File containing \fBscript\fR's terminal input.
  48 .TP
  49 .BR \-O , " \-\-log-out " \fIfile\fR
  50 File containing \fBscript\fR's terminal output.
  51 .TP
  52 .BR \-B , " \-\-log-io " \fIfile\fR
  53 File containing \fBscript\fR's terminal output and input.
  54 .TP
  55 .BR \-t , " \-\-timing " \fIfile\fR
  56 File containing \fBscript\fR's timing output.  This option overrides old-style arguments.
  57 .TP
  58 .BR \-s , " \-\-typescript " \fIfile\fR
  59 File containing \fBscript\fR's terminal output.  Deprecated alias to \fB\-\-log-out\fR.
  60 This option overrides old-style arguments.
  61 .TP
  62 .BR \-c , " \-\-cr\-mode " \fImode\fR
  63 Specifies how to use CR (0x0D, carriage return) character from log files.
  64 The default mode is "auto", in this case CR is replaced with line break for
  65 stdin log, because otherwise scriptreplay will overwrite the same line.
  66 The another modes are "never" and "always".
  67 .TP
  68 .BR \-d , " \-\-divisor " \fInumber\fR
  69 Speed up the replay displaying this
  70 .I number
  71 of times.  The argument is a floating point number.  It's called divisor
  72 because it divides the timings by this factor.  This option overrides old-style arguments.
  73 .TP
  74 .BR \-m , " \-\-maxdelay " \fInumber\fR
  75 Set the maximum delay between transcript updates to
  76 .I number
  77 of seconds.  The argument is a floating point number.  This can be used to
  78 avoid long pauses in the transcript replay.
  79 .TP
  80 .BR \-x , " \-\-stream " \fItype\fR
  81 Forces scriptreplay to print only specified stream.  The supported stream types
  82 are 'in' or 'out'.  This option is recommended for multi-stream logs (e.g. --log-io)
  83 to print only specified data.
  84 .TP
  85 .BR \-V , " \-\-version"
  86 Display version information and exit.
  87 .TP
  88 .BR \-h , " \-\-help"
  89 Display help text and exit.
  90 .SH "EXAMPLE"
  91 .nf
  92 % script --log-timing file.tm --log-out script.out
  93 Script started, file is script.out
  94 % ls
  95 <etc, etc>
  96 % exit
  97 Script done, file is script.out
  98 % scriptreplay --timing file.tm --log-out script.out
  99 .nf
 100 .SH "SEE ALSO"
 101 .BR script (1)
 102 .SH "COPYRIGHT"
 103 Copyright \(co 2008 James Youngman
 104 .br
 105 Copyright \(co 2008-2019 Karel Zak
 106 .PP
 107 This is free software; see the source for copying conditions.  There is NO
 108 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
 109 PURPOSE.
 110 .PP
 111 Released under the GNU General Public License version 2 or later.
 112 .SH "AUTHOR"
 113 The original
 114 .B scriptreplay
 115 program was written by
 116 .MT joey@\:kitenet.net
 117 Joey Hess
 118 .ME .
 119 The program was re-written in C by
 120 .MT jay@\:gnu.org
 121 James Youngman
 122 .ME
 123 and
 124 .MT kzak@\:redhat.com
 125 Karel Zak
 126 .ME .
 127 .SH AVAILABILITY
 128 The scriptreplay command is part of the util-linux package and is available from
 129 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 130 Linux Kernel Archive
 131 .UE .