term-utils/scriptlive.1

   1 .TH SCRIPTLIVE 1 "October 2019" "util-linux" "User Commands"
   2 .SH "NAME"
   3 scriptlive \- re-run session typescripts, using timing information
   4 .SH "SYNOPSIS"
   5 .B scriptlive
   6 [options]
   7 .RB [ \-t ]
   8 .I timingfile
   9 .RB [ \-I|\-B ]
  10 .I typescript
  11 .SH "DESCRIPTION"
  12 This program re-run a typescript, using stdin typescript and timing information to ensure that
  13 input happens in the same rhythm as it originally appeared when the script
  14 was recorded.
  15 .PP
  16 The \fBsession is executed\fR in newly created pseudo terminal with user's $SHELL
  17 (or defaults to /bin/bash).
  18 .PP
  19 .B Be careful!
  20 Do not forget that the typescript may contains arbitrary commands.
  21 It is recommended to use \fB"scriptreplay \-\-stream in \-\-log\-in typescript"\fR
  22 (or with --log-io instead of --log-in) to verify the typescript before it is executed by
  23 .BR scriptlive (1).
  24 .PP
  25 The timing information is what
  26 .BR script (1)
  27 outputs to file specified by
  28 .BR \-\-log\-timing .
  29 The typescript has to contain stdin information and it is what
  30 .BR script (1)
  31 outputs to file specified by
  32 .B \-\-log-in
  33 or
  34 .BR \-\-log\-io .
  35
  36 .SH OPTIONS
  37 .TP
  38 .BR \-I , " \-\-log-in " \fIfile\fR
  39 File containing \fBscript\fR's terminal input.
  40 .TP
  41 .BR \-B , " \-\-log-io " \fIfile\fR
  42 File containing \fBscript\fR's terminal output and input.
  43 .TP
  44 .BR \-t , " \-\-timing " \fIfile\fR
  45 File containing \fBscript\fR's timing output.  This option overrides old-style arguments.
  46 .TP
  47 .BR \-T , " \-\-log\-timing " \fIfile\fR
  48 Aliased to \fB\-t\fR, maintained for compatibility with
  49 .BR script (1)
  50 command line options.
  51 .BR \-d , " \-\-divisor " \fInumber\fR
  52 Speed up the replay displaying this
  53 .I number
  54 of times.  The argument is a floating point number.  It's called divisor
  55 because it divides the timings by this factor.  This option overrides old-style arguments.
  56 .TP
  57 .BR \-m , " \-\-maxdelay " \fInumber\fR
  58 Set the maximum delay between updates to
  59 .I number
  60 of seconds.  The argument is a floating point number.  This can be used to
  61 avoid long pauses in the typescript replay.
  62 .TP
  63 .BR \-V , " \-\-version"
  64 Display version information and exit.
  65 .TP
  66 .BR \-h , " \-\-help"
  67 Display help text and exit.
  68 .SH "EXAMPLE"
  69 .nf
  70 % script --log-timing file.tm --log-in script.in
  71 Script started, file is script.out
  72 % date
  73 <etc, etc>
  74 % exit
  75 Script done, file is script.out
  76 % scriptlive --log-timing file.tm --log-in script.in
  77 .nf
  78 .SH "SEE ALSO"
  79 .BR script (1),
  80 .BR scriptreplay (1)
  81 .SH "COPYRIGHT"
  82 Copyright \(co 2019 Karel Zak
  83 .PP
  84 This is free software; see the source for copying conditions.  There is NO
  85 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
  86 PURPOSE.
  87 .PP
  88 Released under the GNU General Public License version 2 or later.
  89 .SH "AUTHOR"
  90 .MT kzak@\:redhat.com
  91 Karel Zak
  92 .ME .
  93 .SH AVAILABILITY
  94 The scriptlive command is part of the util-linux package and is available from
  95 .UR https://\:www.kernel.org\:/pub\:/linux\:/utils\:/util-linux/
  96 Linux Kernel Archive
  97 .UE .