]> git.ipfire.org Git - thirdparty/util-linux.git/blob - term-utils/scriptreplay.1
build-sys: move script and scriptreplay to term-utils/
[thirdparty/util-linux.git] / term-utils / scriptreplay.1
1 .\" Automatically generated by Pod::Man version 1.02
2 .\" Mon Sep 3 02:16:06 2001
3 .\"
4 .\" Standard preamble:
5 .\" ======================================================================
6 .de Sh \" Subsection heading
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp \" Vertical space (when we can't use .PP)
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip \" List item
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb \" Begin verbatim text
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve \" End verbatim text
30 .ft R
31
32 .fi
33 ..
34 .\" Set up some character translations and predefined strings. \*(-- will
35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
36 .\" double quote, and \*(R" will give a right double quote. | will give a
37 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
38 .\" to do unbreakable dashes and therefore won't be available. \*(C` and
39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
40 .tr \(*W-|\(bv\*(Tr
41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
42 .ie n \{\
43 . ds -- \(*W-
44 . ds PI pi
45 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
46 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
47 . ds L" ""
48 . ds R" ""
49 . ds C` `
50 . ds C' '
51 'br\}
52 .el\{\
53 . ds -- \|\(em\|
54 . ds PI \(*p
55 . ds L" ``
56 . ds R" ''
57 'br\}
58 .\"
59 .\" If the F register is turned on, we'll generate index entries on stderr
60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
61 .\" index entries marked with X<> in POD. Of course, you'll have to process
62 .\" the output yourself in some meaningful fashion.
63 .if \nF \{\
64 . de IX
65 . tm Index:\\$1\t\\n%\t"\\$2"
66 . .
67 . nr % 0
68 . rr F
69 .\}
70 .\"
71 .\" For nroff, turn off justification. Always turn off hyphenation; it
72 .\" makes way too many mistakes in technical documents.
73 .hy 0
74 .if n .na
75 .\"
76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
77 .\" Fear. Run. Save yourself. No user-serviceable parts.
78 .bd B 3
79 . \" fudge factors for nroff and troff
80 .if n \{\
81 . ds #H 0
82 . ds #V .8m
83 . ds #F .3m
84 . ds #[ \f1
85 . ds #] \fP
86 .\}
87 .if t \{\
88 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
89 . ds #V .6m
90 . ds #F 0
91 . ds #[ \&
92 . ds #] \&
93 .\}
94 . \" simple accents for nroff and troff
95 .if n \{\
96 . ds ' \&
97 . ds ` \&
98 . ds ^ \&
99 . ds , \&
100 . ds ~ ~
101 . ds /
102 .\}
103 .if t \{\
104 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
105 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
106 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
107 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
108 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
109 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
110 .\}
111 . \" troff and (daisy-wheel) nroff accents
112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
119 .ds ae a\h'-(\w'a'u*4/10)'e
120 .ds Ae A\h'-(\w'A'u*4/10)'E
121 . \" corrections for vroff
122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
124 . \" for low resolution devices (crt and lpr)
125 .if \n(.H>23 .if \n(.V>19 \
126 \{\
127 . ds : e
128 . ds 8 ss
129 . ds o a
130 . ds d- d\h'-1'\(ga
131 . ds D- D\h'-1'\(hy
132 . ds th \o'bp'
133 . ds Th \o'LP'
134 . ds ae ae
135 . ds Ae AE
136 .\}
137 .rm #[ #] #H #V #F C
138 .\" ======================================================================
139 .\"
140 .IX Title "REPLAY 1"
141 .TH REPLAY 1 "perl v5.6.0" "2001-09-03" "User Contributed Perl Documentation"
142 .UC
143 .SH "NAME"
144 scriptreplay \- play back typescripts, using timing information
145 .SH "SYNOPSIS"
146 .IX Header "SYNOPSIS"
147 .B scriptreplay
148 .I timingfile
149 .RI [ typescript
150 .RI [ divisor ]]
151 .SH "DESCRIPTION"
152 .IX Header "DESCRIPTION"
153 This program replays a typescript, using timing information to ensure that
154 output happens at the same speed as it originally appeared when the script
155 was recorded.
156 .PP
157 The replay simply displays the information again; the programs
158 that were run when the typescript was being recorded are not run again.
159 Since the same information is simply being displayed,
160 .B scriptreplay
161 is only guaranteed to work properly if run on the same type of
162 terminal the typescript was recorded on. Otherwise, any escape characters
163 in the typescript may be interpreted differently by the terminal to
164 which
165 .B scriptreplay
166 is sending its output.
167 .PP
168 The timings information is what
169 .BR script (1)
170 outputs to standard error if it is
171 run with the
172 .B \-t
173 parameter.
174 .PP
175 By default, the typescript to display is assumed to be named \*(L"typescript\*(R",
176 but other filenames may be specified, as the second parameter.
177 .PP
178 If the third parameter is specified, it is used as a speed-up multiplier. For
179 example, a speed-up of 2 makes
180 .B scriptreplay
181 go twice as fast and a speed-up of 0.1 makes it go ten times slower
182 than the original session.
183 .SH "EXAMPLE"
184 .IX Header "EXAMPLE"
185 .Vb 7
186 \& % script -t 2> timingfile
187 \& Script started, file is typescript
188 \& % ls
189 \& <etc, etc>
190 \& % exit
191 \& Script done, file is typescript
192 \& % scriptreplay timingfile
193 .Ve
194 .SH "SEE ALSO"
195 .IX Header "SEE ALSO"
196 .BR script (1)
197 .SH "COPYRIGHT"
198 .IX Header "COPYRIGHT"
199 Copyright \(co 2008 James Youngman
200 .PP
201 Copyright \(co 2008 Karel Zak
202 .PP
203 This is free software; see the source for copying conditions. There is NO
204 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
205 PURPOSE.
206 .PP
207 Released under the GNU General Public License version 2 or later.
208 .SH "AUTHOR"
209 .IX Header "AUTHOR"
210 The original
211 .B scriptreplay
212 program was written by Joey Hess <joey@kitenet.net>.
213 The program was re-written in C by James Youngman <jay@gnu.org> and Karel Zak <kzak@redhat.com>.
214 .SH AVAILABILITY
215 The
216 .B scriptreplay
217 command is part of the util-linux package and is available from
218 ftp://ftp.kernel.org/pub/linux/utils/util-linux/.