]>
Commit | Line | Data |
---|---|---|
1aa1fbae | 1 | .TH SCRIPTREPLAY 1 "September 2011" "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 | |
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. | |
e8f26419 | 26 | .PP |
557db9cd | 27 | The timing information is what |
fc6b5e0d PB |
28 | .BR script (1) |
29 | outputs to standard error if it is | |
30 | run with the | |
31 | .B \-t | |
32 | parameter. | |
e8f26419 | 33 | .PP |
1aa1fbae SK |
34 | By default, the typescript to display is assumed to be named |
35 | .BR typescript , | |
557db9cd BS |
36 | but other filenames may be specified, as the second parameter or with option |
37 | .BR \-s . | |
e8f26419 | 38 | .PP |
557db9cd BS |
39 | If the third parameter is specified, it is used as a speed-up multiplier. |
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 |
a55f60a1 | 45 | The first three options will override old-style arguments. |
ed66f515 | 46 | .TP |
557db9cd | 47 | .BR \-t , " \-\-timing " \fIfile\fR |
6e72fa59 | 48 | File containing \fBscript\fR's timing output. |
ed66f515 | 49 | .TP |
557db9cd | 50 | .BR \-s , " \-\-typescript " \fIfile\fR |
6e72fa59 | 51 | File containing \fBscript\fR's terminal output. |
ed66f515 | 52 | .TP |
557db9cd | 53 | .BR \-d , " \-\-divisor " \fInumber\fR |
1aa1fbae SK |
54 | Speed up the replay displaying this |
55 | .I number | |
56 | of times. The argument is a floating point number. It's called divisor | |
557db9cd | 57 | because it divides the timings by this factor. |
178365ef | 58 | .TP |
7f1d4836 | 59 | .BR \-m , " \-\-maxdelay " \fInumber\fR |
6e72fa59 | 60 | Set the maximum delay between transcript updates to |
7f1d4836 | 61 | .I number |
6e72fa59 | 62 | of seconds. The argument is a floating point number. This can be used to |
7f1d4836 JDN |
63 | avoid long pauses in the transcript replay. |
64 | .TP | |
178365ef | 65 | .BR \-V , " \-\-version" |
557db9cd | 66 | Display version information and exit. |
178365ef SK |
67 | .TP |
68 | .BR \-h , " \-\-help" | |
b4362b6f | 69 | Display help text and exit. |
e8f26419 | 70 | .SH "EXAMPLE" |
1aa1fbae SK |
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 | |
ffc43748 | 80 | .SH "SEE ALSO" |
ffc43748 | 81 | .BR script (1) |
e8f26419 | 82 | .SH "COPYRIGHT" |
18a706bd | 83 | Copyright \(co 2008 James Youngman |
1aa1fbae | 84 | .br |
18a706bd KZ |
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. | |
e8f26419 | 92 | .SH "AUTHOR" |
18a706bd KZ |
93 | The original |
94 | .B scriptreplay | |
1aa1fbae | 95 | program was written by |
79f84818 | 96 | .MT joey@\:kitenet.net |
1aa1fbae | 97 | Joey Hess |
79f84818 | 98 | .ME . |
1aa1fbae | 99 | The program was re-written in C by |
79f84818 | 100 | .MT jay@\:gnu.org |
1aa1fbae | 101 | James Youngman |
79f84818 | 102 | .ME |
1aa1fbae | 103 | and |
79f84818 | 104 | .MT kzak@\:redhat.com |
1aa1fbae | 105 | Karel Zak |
79f84818 | 106 | .ME . |
86d62711 | 107 | .SH AVAILABILITY |
9c91fc03 | 108 | The scriptreplay command is part of the util-linux package and is available from |
d673b74e | 109 | .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ |
1aa1fbae SK |
110 | Linux Kernel Archive |
111 | .UE . |