From: Benno Schulenberg Date: Mon, 24 Feb 2025 13:08:38 +0000 (+0100) Subject: scriptreplay: mark literal values in the man page in bold, not italic X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=df2353c92ed5ea632826a4b81f22cb38f944407c;p=thirdparty%2Futil-linux.git scriptreplay: mark literal values in the man page in bold, not italic Also, mention which keys can be used to speed up, slow down, and pause the replay. Shorten the description of '-s' as it is deprecated. And improve the description of '-t': it does not override the _timingfile_ positional argument, but takes the place of it, makes it unneeded. Signed-off-by: Benno Schulenberg --- diff --git a/term-utils/scriptreplay.1.adoc b/term-utils/scriptreplay.1.adoc index 7665d28f8..deabb7b16 100644 --- a/term-utils/scriptreplay.1.adoc +++ b/term-utils/scriptreplay.1.adoc @@ -23,11 +23,14 @@ The replay simply displays the information again; the programs that were run whe The timing information is what *script*(1) outputs to file specified by *--log-timing*. -By default, the typescript to display is assumed to be named _typescript_, but other filenames may be specified, as the second parameter or with option *--log-out*. +By default, the _typescript_ to display is assumed to be named *typescript*, +but other filenames may be specified, as the second parameter or with option +*--log-out*. If the third parameter or *--divisor* is specified, it is used as a speed-up multiplier. For example, a speed-up of 2 makes *scriptreplay* go twice as fast, and a speed-down of 0.1 makes it go ten times slower than the original session. -During the replay, you can interactively speed up, slow down, or pause the playback using key bindings. +During the replay, you can interactively speed up, slow down, or pause the +playback using the Up, Down, and Space keys. == OPTIONS @@ -41,16 +44,20 @@ File containing *script*'s terminal output. File containing *script*'s terminal output and input. *-t*, *--timing* _file_:: -File containing *script*'s timing output. This option overrides old-style arguments. +File containing *script*'s timing output. +This option replaces the _timingfile_ positional argument. *-T*, *--log-timing* _file_:: This is an alias for *-t*, maintained for compatibility with *script*(1) command-line options. *-s*, *--typescript* _file_:: -File containing *script*'s terminal output. Deprecated alias to *--log-out*. This option overrides old-style arguments. +Deprecated alias of *--log-out*. *-c*, *--cr-mode* _mode_:: -Specifies how to use the 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* would overwrite the same line. The other modes are _never_ and _always_. +Specifies how to handle the CR (carriage return, 0x0D) character from log +files. The default mode is *auto*, in which case CR is replaced with a +line break for the stdin log, because otherwise *scriptreplay* would +overwrite the same line. The other modes are *never* and *always*. *-d*, *--divisor* _number_:: Speed up the replay displaying this _number_ of times. The argument is a floating-point number. It's called divisor because it divides the timings by this factor. This option overrides old-style arguments. @@ -59,10 +66,15 @@ Speed up the replay displaying this _number_ of times. The argument is a floatin Set the maximum delay between updates to _number_ of seconds. The argument is a floating-point number. This can be used to avoid long pauses in the typescript replay. *--summary*:: -Display details about the session recorded in the specified timing file and exit. The session has to be recorded using _advanced_ format (see *script*(1) option *--logging-format* for more details). +Display details about the session recorded in the specified timing file and +exit. The session must have been recorded using the *advanced* format (see +*script*(1) option *--logging-format* for more details). *-x*, *--stream* _type_:: -Forces *scriptreplay* to print only the specified stream. The supported stream types are _in_, _out_, _signal_, or _info_. This option is recommended for multi-stream logs (e.g., *--log-io*) in order to print only specified data. +Forces *scriptreplay* to print only the specified stream. The supported stream +types are *in*, *out*, *signal*, and *info*. This option is recommended for +multi-stream logs (created with *--log-io*) in order to print only the desired +data. include::man-common/help-version.adoc[]