term-utils/scriptreplay.1

   1 .TH SCRIPTREPLAY 1 "October 2019" "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 .B \-\-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 \-T , " \-\-log\-timing " \fIfile\fR
  59 aliast to \fB\-t\fR, maintained for compatibility with
  60 .B script (1)
  61 command line options.
  62 .TP
  63 .BR \-s , " \-\-typescript " \fIfile\fR
  64 File containing \fBscript\fR's terminal output.  Deprecated alias to \fB\-\-log-out\fR.
  65 This option overrides old-style arguments.
  66 .TP
  67 .BR \-c , " \-\-cr\-mode " \fImode\fR
  68 Specifies how to use CR (0x0D, carriage return) character from log files.
  69 The default mode is
  70 .IR auto ,
  71 in this case CR is replaced with line break for stdin log, because otherwise
  72 scriptreplay will overwrite the same line.  The another modes are
  73 .I never
  74 and
  75 .IR always .
  76 .TP
  77 .BR \-d , " \-\-divisor " \fInumber\fR
  78 Speed up the replay displaying this
  79 .I number
  80 of times.  The argument is a floating point number.  It's called divisor
  81 because it divides the timings by this factor.  This option overrides old-style arguments.
  82 .TP
  83 .BR \-m , " \-\-maxdelay " \fInumber\fR
  84 Set the maximum delay between updates to
  85 .I number
  86 of seconds.  The argument is a floating point number.  This can be used to
  87 avoid long pauses in the typescript replay.
  88 .TP
  89 .B \-\-summary
  90 Display details about session recorded in the specified timing file and exit.  The session has
  91 to be recorded by
  92 .I advanced
  93 format (see
  94 .BR script (1))
  95 option \fB\-\-logging\-format\fR for more details).
  96 .TP
  97 .BR \-x , " \-\-stream " \fItype\fR
  98 Forces scriptreplay to print only specified stream.  The supported stream types
  99 are
 100 .IR in ,
 101 .IR out ,
 102 .IR signal ,
 103 or
 104 .IR info .
 105 This option is recommended for multi-stream logs (e.g., \-\-log-io)
 106 to print only specified data.
 107 .TP
 108 .BR \-V , " \-\-version"
 109 Display version information and exit.
 110 .TP
 111 .BR \-h , " \-\-help"
 112 Display help text and exit.
 113 .SH EXAMPLE
 114 .nf
 115 % script --log-timing file.tm --log-out script.out
 116 Script started, file is script.out
 117 % ls
 118 <etc, etc>
 119 % exit
 120 Script done, file is script.out
 121 % scriptreplay --log-timing file.tm --log-out script.out
 122 .nf
 123 .SH SEE ALSO
 124 .BR script (1),
 125 .BR scriptlive (1)
 126 .SH COPYRIGHT
 127 Copyright \(co 2008 James Youngman
 128 .br
 129 Copyright \(co 2008-2019 Karel Zak
 130 .PP
 131 This is free software; see the source for copying conditions.  There is NO
 132 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
 133 PURPOSE.
 134 .PP
 135 Released under the GNU General Public License version 2 or later.
 136 .SH AUTHOR
 137 The original
 138 .B scriptreplay
 139 program was written by
 140 .MT joey@\:kitenet.net
 141 Joey Hess
 142 .ME .
 143 The program was re-written in C by
 144 .MT jay@\:gnu.org
 145 James Youngman
 146 .ME
 147 and
 148 .MT kzak@\:redhat.com
 149 Karel Zak
 150 .ME .
 151 .SH AVAILABILITY
 152 The scriptreplay command is part of the util-linux package and is available from
 153 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 154 Linux Kernel Archive
 155 .UE .