]>
Commit | Line | Data |
---|---|---|
543f6b6c | 1 | .TH SCRIPTREPLAY 1 "October 2019" "util-linux" "User Commands" |
e8f26419 | 2 | .SH "NAME" |
c129767e | 3 | scriptreplay \- play back typescripts, using timing information |
e8f26419 | 4 | .SH "SYNOPSIS" |
fc6b5e0d | 5 | .B scriptreplay |
6e72fa59 | 6 | [options] |
557db9cd | 7 | .RB [ \-t ] |
fc6b5e0d PB |
8 | .I timingfile |
9 | .RI [ typescript | |
10 | .RI [ divisor ]] | |
e8f26419 | 11 | .SH "DESCRIPTION" |
e8f26419 | 12 | This program replays a typescript, using timing information to ensure that |
6e72fa59 | 13 | output happens in the same rhythm as it originally appeared when the script |
18a706bd KZ |
14 | was recorded. |
15 | .PP | |
16 | The replay simply displays the information again; the programs | |
cf0609a3 | 17 | that were run when the typescript was being recorded are \fBnot run again\fR. |
18a706bd KZ |
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. | |
e8f26419 | 26 | .PP |
557db9cd | 27 | The timing information is what |
fc6b5e0d | 28 | .BR script (1) |
cf0609a3 KZ |
29 | outputs to file specified by |
30 | .BR \-\-log-timing . | |
e8f26419 | 31 | .PP |
1aa1fbae SK |
32 | By default, the typescript to display is assumed to be named |
33 | .BR typescript , | |
557db9cd | 34 | but other filenames may be specified, as the second parameter or with option |
cf0609a3 | 35 | .BR \-\-log\-out . |
e8f26419 | 36 | .PP |
cf0609a3 | 37 | If the third parameter or |
2fb684f0 | 38 | .B \-\-divisor |
cf0609a3 | 39 | is specified, it is used as a speed-up multiplier. |
557db9cd | 40 | For example, a speed-up of 2 makes |
18a706bd | 41 | .B scriptreplay |
557db9cd | 42 | go twice as fast, and a speed-up of 0.1 makes it go ten times slower |
18a706bd | 43 | than the original session. |
178365ef | 44 | .SH OPTIONS |
cf0609a3 KZ |
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. | |
ed66f515 | 54 | .TP |
557db9cd | 55 | .BR \-t , " \-\-timing " \fIfile\fR |
cf0609a3 | 56 | File containing \fBscript\fR's timing output. This option overrides old-style arguments. |
ed66f515 | 57 | .TP |
a33f1fc4 KZ |
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 | |
557db9cd | 63 | .BR \-s , " \-\-typescript " \fIfile\fR |
cf0609a3 KZ |
64 | File containing \fBscript\fR's terminal output. Deprecated alias to \fB\-\-log-out\fR. |
65 | This option overrides old-style arguments. | |
ed66f515 | 66 | .TP |
88b8e9bf KZ |
67 | .BR \-c , " \-\-cr\-mode " \fImode\fR |
68 | Specifies how to use CR (0x0D, carriage return) character from log files. | |
543f6b6c SK |
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 . | |
88b8e9bf | 76 | .TP |
557db9cd | 77 | .BR \-d , " \-\-divisor " \fInumber\fR |
1aa1fbae SK |
78 | Speed up the replay displaying this |
79 | .I number | |
80 | of times. The argument is a floating point number. It's called divisor | |
cf0609a3 | 81 | because it divides the timings by this factor. This option overrides old-style arguments. |
178365ef | 82 | .TP |
7f1d4836 | 83 | .BR \-m , " \-\-maxdelay " \fInumber\fR |
6e72fa59 | 84 | Set the maximum delay between transcript updates to |
7f1d4836 | 85 | .I number |
6e72fa59 | 86 | of seconds. The argument is a floating point number. This can be used to |
7f1d4836 JDN |
87 | avoid long pauses in the transcript replay. |
88 | .TP | |
2fb684f0 BIG |
89 | .B \-\-summary |
90 | Display details about session recorded in the specified timing file and exit. The session has | |
543f6b6c SK |
91 | to be recorded by |
92 | .I advanced | |
93 | format (see | |
94 | .BR script (1)) | |
4a4f4a62 KZ |
95 | option \fB\-\-logging\-format\fR for more details). |
96 | .TP | |
70315772 KZ |
97 | .BR \-x , " \-\-stream " \fItype\fR |
98 | Forces scriptreplay to print only specified stream. The supported stream types | |
543f6b6c SK |
99 | are |
100 | .IR in , | |
101 | .IR out , | |
102 | .IR signal , | |
103 | or | |
104 | .IR info . | |
eb024893 | 105 | This option is recommended for multi-stream logs (e.g., \-\-log-io) |
70315772 KZ |
106 | to print only specified data. |
107 | .TP | |
178365ef | 108 | .BR \-V , " \-\-version" |
557db9cd | 109 | Display version information and exit. |
178365ef SK |
110 | .TP |
111 | .BR \-h , " \-\-help" | |
b4362b6f | 112 | Display help text and exit. |
e8f26419 | 113 | .SH "EXAMPLE" |
1aa1fbae | 114 | .nf |
cf0609a3 | 115 | % script --log-timing file.tm --log-out script.out |
1aa1fbae SK |
116 | Script started, file is script.out |
117 | % ls | |
118 | <etc, etc> | |
119 | % exit | |
120 | Script done, file is script.out | |
cb4631fc | 121 | % scriptreplay --log-timing file.tm --log-out script.out |
1aa1fbae | 122 | .nf |
ffc43748 | 123 | .SH "SEE ALSO" |
cb4631fc KZ |
124 | .BR script (1), |
125 | .BR scriptlive (1) | |
e8f26419 | 126 | .SH "COPYRIGHT" |
18a706bd | 127 | Copyright \(co 2008 James Youngman |
1aa1fbae | 128 | .br |
cf0609a3 | 129 | Copyright \(co 2008-2019 Karel Zak |
18a706bd KZ |
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. | |
e8f26419 | 136 | .SH "AUTHOR" |
18a706bd KZ |
137 | The original |
138 | .B scriptreplay | |
1aa1fbae | 139 | program was written by |
79f84818 | 140 | .MT joey@\:kitenet.net |
1aa1fbae | 141 | Joey Hess |
79f84818 | 142 | .ME . |
1aa1fbae | 143 | The program was re-written in C by |
79f84818 | 144 | .MT jay@\:gnu.org |
1aa1fbae | 145 | James Youngman |
79f84818 | 146 | .ME |
1aa1fbae | 147 | and |
79f84818 | 148 | .MT kzak@\:redhat.com |
1aa1fbae | 149 | Karel Zak |
79f84818 | 150 | .ME . |
86d62711 | 151 | .SH AVAILABILITY |
9c91fc03 | 152 | The scriptreplay command is part of the util-linux package and is available from |
d673b74e | 153 | .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ |
1aa1fbae SK |
154 | Linux Kernel Archive |
155 | .UE . |