]> git.ipfire.org Git - thirdparty/util-linux.git/blobdiff - term-utils/scriptreplay.1
scriptreplay: add --cr-mode
[thirdparty/util-linux.git] / term-utils / scriptreplay.1
index 257589cb9da8daaf29e46fc26dcad00238a2326f..71c6def58dfd8b8f1f94dafd277d0d96f5cc2c78 100644 (file)
@@ -3,18 +3,18 @@
 scriptreplay \- play back typescripts, using timing information
 .SH "SYNOPSIS"
 .B scriptreplay
-.RI [ options ]
+[options]
 .RB [ \-t ]
 .I timingfile
 .RI [ typescript
 .RI [ divisor ]]
 .SH "DESCRIPTION"
 This program replays a typescript, using timing information to ensure that
-output happens at the same speed as it originally appeared when the script
+output happens in the same rhythm as it originally appeared when the script
 was recorded.
 .PP
 The replay simply displays the information again; the programs
-that were run when the typescript was being recorded are not run again.
+that were run when the typescript was being recorded are \fBnot run again\fR.
 Since the same information is simply being displayed,
 .B scriptreplay
 is only guaranteed to work properly if run on the same type of
@@ -26,57 +26,78 @@ is sending its output.
 .PP
 The timing information is what
 .BR script (1)
-outputs to standard error if it is
-run with the
-.B \-t
-parameter.
+outputs to file specified by
+.BR \-\-log-timing .
 .PP
 By default, the typescript to display is assumed to be named
 .BR typescript ,
 but other filenames may be specified, as the second parameter or with option
-.BR \-s .
+.BR \-\-log\-out .
 .PP
-If the third parameter is specified, it is used as a speed-up multiplier.
+If the third parameter or
+.BR \-\-divisor
+is specified, it is used as a speed-up multiplier.
 For example, a speed-up of 2 makes
 .B scriptreplay
 go twice as fast, and a speed-up of 0.1 makes it go ten times slower
 than the original session.
 .SH OPTIONS
-The first three options will overide old-style arguments.
+.TP
+.BR \-I , " \-\-log-in " \fIfile\fR
+File containing \fBscript\fR's terminal input.
+.TP
+.BR \-O , " \-\-log-out " \fIfile\fR
+File containing \fBscript\fR's terminal output.
+.TP
+.BR \-B , " \-\-log-io " \fIfile\fR
+File containing \fBscript\fR's terminal output and input.
 .TP
 .BR \-t , " \-\-timing " \fIfile\fR
-File containing script timing output.
+File containing \fBscript\fR's timing output.  This option overrides old-style arguments.
 .TP
 .BR \-s , " \-\-typescript " \fIfile\fR
-File containing the script terminal output.
+File containing \fBscript\fR's terminal output.  Deprecated alias to \fB\-\-log-out\fR.
+This option overrides old-style arguments.
+.TP
+.BR \-c , " \-\-cr\-mode " \fImode\fR
+Specifies how to use CR (0x0D, carriage return) character from log files.
+The default mode is "auto", in this case CR is replaced with line break for
+stdin log, because otherwise scriptreplay will overwrite the same line.
+The another modes are "never" and "always".
 .TP
 .BR \-d , " \-\-divisor " \fInumber\fR
 Speed up the replay displaying this
 .I number
 of times.  The argument is a floating point number.  It's called divisor
-because it divides the timings by this factor.
+because it divides the timings by this factor.  This option overrides old-style arguments.
+.TP
+.BR \-m , " \-\-maxdelay " \fInumber\fR
+Set the maximum delay between transcript updates to
+.I number
+of seconds.  The argument is a floating point number.  This can be used to
+avoid long pauses in the transcript replay.
 .TP
 .BR \-V , " \-\-version"
 Display version information and exit.
 .TP
 .BR \-h , " \-\-help"
-Display a help message and exit.
+Display help text and exit.
 .SH "EXAMPLE"
 .nf
-% script --timing=file.tm script.out
+% script --log-timing file.tm --log-out script.out
 Script started, file is script.out
 % ls
 <etc, etc>
 % exit
 Script done, file is script.out
-% scriptreplay --timing file.tm --typescript script.out
+% scriptreplay --timing file.tm --log-out script.out
 .nf
 .SH "SEE ALSO"
 .BR script (1)
 .SH "COPYRIGHT"
 Copyright \(co 2008 James Youngman
 .br
-Copyright \(co 2008 Karel Zak
+Copyright \(co 2008-2019 Karel Zak
 .PP
 This is free software; see the source for copying conditions.  There is NO
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
@@ -87,21 +108,19 @@ Released under the GNU General Public License version 2 or later.
 The original
 .B scriptreplay
 program was written by
-.UR joey\@\:kitenet.net
+.MT joey@\:kitenet.net
 Joey Hess
-.UE .
+.ME .
 The program was re-written in C by
-.UR jay\@\:gnu.org
+.MT jay@\:gnu.org
 James Youngman
-.UE
+.ME
 and
-.UR kzak\@\:redhat.com
+.MT kzak@\:redhat.com
 Karel Zak
-.UE .
+.ME .
 .SH AVAILABILITY
-The
-.B scriptreplay
-command is part of the util-linux package and is available from
-.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
+The scriptreplay command is part of the util-linux package and is available from
+.UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
 Linux Kernel Archive
 .UE .