Util-Linux Archive on lore.kernel.org
 help / color / Atom feed
* [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes
@ 2020-07-15  8:15 Michael Kerrisk (man-pages)
  2020-07-15  8:15 ` [PATCH 2/3] Manual pages: scriptlive.1: " Michael Kerrisk (man-pages)
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-07-15  8:15 UTC (permalink / raw)
  To: mtk.manpages, Karel Zak; +Cc: util-linux

Nothing too contentious here, I think, so I'm rolling all
of the edits into one patch.

Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
---
 term-utils/script.1 | 51 ++++++++++++++++++++++++++-------------------
 1 file changed, 30 insertions(+), 21 deletions(-)

diff --git a/term-utils/script.1 b/term-utils/script.1
index 8eda4a58b..49ba58224 100644
--- a/term-utils/script.1
+++ b/term-utils/script.1
@@ -44,10 +44,10 @@ makes a typescript of everything on your terminal session.  The terminal
 data are stored in raw form to the log file and information about timing
 to another (optional) structured log file.  The timing log file is necessary to replay
 the session later by
-.B scriptreplay (1)
+.BR scriptreplay (1)
 and to store additional information about the session.
 .PP
-Since version 2.35
+Since version 2.35,
 .B script
 supports multiple streams and allows the logging of input and output to separate
 files or all the one file.  This version also supports new timing file
@@ -63,11 +63,13 @@ or option \fB\-\-log\-out\fR \fIfile\fR is given,
 saves the dialogue in this
 .IR file .
 If no filename is given, the dialogue is saved in the file
-.BR typescript .
+.IR typescript .
 .PP
-Note that log input by \fB\-\-log\-in\fR or \fB\-\-log\-io\fR may be security
-sensitive operation as the log file contains all terminal session input (it
-means also passwords) independently on the terminal echo flag setting.
+Note that logging input using \fB\-\-log\-in\fR or \fB\-\-log\-io\fR
+may record security-sensitive information
+as the log file contains all terminal session input
+(e.g., passwords)
+independently of the terminal echo flag setting.
 .SH OPTIONS
 Below, the \fIsize\fR argument may be followed by the multiplicative
 suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB
@@ -78,7 +80,7 @@ KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
 Append the output to
 .I file
 or to
-.BR typescript ,
+.IR typescript ,
 retaining the prior contents.
 .TP
 \fB\-c\fR, \fB\-\-command\fR \fIcommand\fR
@@ -89,8 +91,8 @@ the output of a program that behaves differently when its stdout is not a
 tty.
 .TP
 \fB\-E\fR, \fB\-\-echo\fR \fIwhen\fR
-This option controls the ECHO flag for pseudoterminal within the session.  The
-supported modes are
+This option controls the ECHO flag for the pseudoterminal within the session.
+The supported modes are
 .IR always ,
 .IR never ,
 or
@@ -98,25 +100,28 @@ or
 The default is
 .I auto
 -- in this case, ECHO is disabled if the current standard input is a
-terminal to avoid double-echo, and enabled if standard input is not terminal
+terminal iin order to avoid double-echo,
+and enabled if standard input is not a terminal
 (for example pipe:
 .BR "echo date | script" )
 to avoid missing input in the session log.
 .TP
 \fB\-e\fR, \fB\-\-return\fR
 Return the exit status of the child process.  Uses the same format as bash
-termination on signal termination exit status is 128+n.  The exit status of
-the child process is always stored in type script file too.
+termination on signal termination
+(i.e., exit status is 128 + the signal number).  The exit status of
+the child process is always stored in the type script file too.
 .TP
 \fB\-f\fR, \fB\-\-flush\fR
 Flush output after each write.  This is nice for telecooperation: one person
-does `mkfifo foo; script \-f foo', and another can supervise real-time what is
-being done using `cat foo'.  Note that flush has an impact on performance, it's
+does `mkfifo foo; script \-f foo',
+and another can supervise in real-time what is
+being done using `cat foo'.  Note that flush has an impact on performance; it's
 possible to use SIGUSR1 to flush logs on demand.
 .TP
 \fB\-\-force\fR
 Allow the default output file
-.B typescript
+.I typescript
 to be a hard or symbolic link.  The command will follow a symbolic link.
 .TP
 \fB\-B\fR, \fB\-\-log\-io\fR \fIfile\fR
@@ -130,12 +135,12 @@ Log input to the \fIfile\fR.  The log output is disabled if only \fB\-\-log\-in\
 specified.
 .sp
 Use this logging functionality carefully as it logs all input, including input
-when terminal has disabled echo flag (for example password inputs).
+when terminal has disabled echo flag (for example, password inputs).
 .TP
 \fB\-O\fR, \fB\-\-log\-out\fR \fIfile\fR
 Log output to the \fIfile\fR.  The default is to log output to the file with
 name
-.B typescript
+.I typescript
 if the option \fB\-\-log\-out\fR or \fB\-\-log\-in\fR is not given.  The log
 output is disabled if only \fB\-\-log\-in\fR specified.
 .TP
@@ -147,7 +152,7 @@ is enabled.  The multi-stream format is used on \fB\-\-log\-io\fR or when
 See also \fB\-\-logging\-format\fR.
 .TP
 \fB\-m\fR, \fB\-\-logging\-format\fR \fIformat\fR
-Force use
+Force use of
 .I advanced
 or
 .I classic
@@ -163,8 +168,10 @@ field indicates how many characters were output this time.
 .sp
 .B Advanced (multi-stream) format
 .PP
-The first field is entry type itentifier ('I'nput, 'O'utput, 'H'eader, 'S'ignal).
-The socond field is how much time elapsed since the previous entry, and rest of the entry is type specific data.
+The first field is an entry type identifier
+('I'nput, 'O'utput, 'H'eader, 'S'ignal).
+The socond field is how much time elapsed since the previous entry,
+and the rest of the entry is type-specific data.
 .RE
 .TP
 \fB\-o\fR, \fB\-\-output-limit\fR \fIsize\fR
@@ -252,7 +259,9 @@ fi
 .RE
 .ad
 .PP
-You should also avoid use of script in command pipes, as
+You should also avoid use of
+.B script
+in command pipes, as
 .B script
 can read more input than you would expect.
 .SH HISTORY
-- 
2.26.2


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 2/3] Manual pages: scriptlive.1: Miscellaneous wording, grammar, and formatting fixes
  2020-07-15  8:15 [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes Michael Kerrisk (man-pages)
@ 2020-07-15  8:15 ` Michael Kerrisk (man-pages)
  2020-07-15  8:15 ` [PATCH 3/3] Manual pages: scriptreplay.1: " Michael Kerrisk (man-pages)
  2020-07-20  8:36 ` [PATCH 1/3] Manual pages: script.1: " Karel Zak
  2 siblings, 0 replies; 4+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-07-15  8:15 UTC (permalink / raw)
  To: mtk.manpages, Karel Zak; +Cc: util-linux

Nothing too contentious here, I think, so I'm rolling all
of the edits into one patch.

Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
---
 term-utils/scriptlive.1 | 19 +++++++++++++------
 1 file changed, 13 insertions(+), 6 deletions(-)

diff --git a/term-utils/scriptlive.1 b/term-utils/scriptlive.1
index 236868b8f..fd553ad01 100644
--- a/term-utils/scriptlive.1
+++ b/term-utils/scriptlive.1
@@ -9,17 +9,23 @@ scriptlive \- re-run session typescripts, using timing information
 .RB [ \-I|\-B ]
 .I typescript
 .SH DESCRIPTION
-This program re-run a typescript, using stdin typescript and timing information to ensure that
+This program re-runs a typescript,
+using stdin typescript and timing information to ensure that
 input happens in the same rhythm as it originally appeared when the script
 was recorded.
 .PP
-The \fBsession is executed\fR in newly created pseudo terminal with user's $SHELL
+The \fBsession is executed\fR in a newly created pseudoterminal with
+the user's $SHELL
 (or defaults to /bin/bash).
 .PP
 .B Be careful!
 Do not forget that the typescript may contains arbitrary commands.
 It is recommended to use \fB"scriptreplay \-\-stream in \-\-log\-in typescript"\fR
-(or with --log-io instead of --log-in) to verify the typescript before it is executed by
+(or with
+.B \-\-log\-io
+instead of
+.BR \-\-log\-in\)
+to verify the typescript before it is executed by
 .BR scriptlive (1).
 .PP
 The timing information is what
@@ -47,17 +53,18 @@ File containing \fBscript\fR's timing output.  This option overrides old-style a
 .BR \-T , " \-\-log\-timing " \fIfile\fR
 Aliased to \fB\-t\fR, maintained for compatibility with
 .BR script (1)
-command line options.
+command-line options.
+.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
+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.
 .TP
 .BR \-m , " \-\-maxdelay " \fInumber\fR
 Set the maximum delay between updates to
 .I number
-of seconds.  The argument is a floating point number.  This can be used to
+of seconds.  The argument is a floating-point number.  This can be used to
 avoid long pauses in the typescript replay.
 .TP
 .BR \-V , " \-\-version"
-- 
2.26.2


^ permalink raw reply	[flat|nested] 4+ messages in thread

* [PATCH 3/3] Manual pages: scriptreplay.1: Miscellaneous wording, grammar, and formatting fixes
  2020-07-15  8:15 [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes Michael Kerrisk (man-pages)
  2020-07-15  8:15 ` [PATCH 2/3] Manual pages: scriptlive.1: " Michael Kerrisk (man-pages)
@ 2020-07-15  8:15 ` Michael Kerrisk (man-pages)
  2020-07-20  8:36 ` [PATCH 1/3] Manual pages: script.1: " Karel Zak
  2 siblings, 0 replies; 4+ messages in thread
From: Michael Kerrisk (man-pages) @ 2020-07-15  8:15 UTC (permalink / raw)
  To: mtk.manpages, Karel Zak; +Cc: util-linux

Nothing too contentious here, I think, so I'm rolling all
of the edits into one patch.

Signed-off-by: Michael Kerrisk (man-pages) <mtk.manpages@gmail.com>
---
 term-utils/scriptreplay.1 | 30 +++++++++++++++++-------------
 1 file changed, 17 insertions(+), 13 deletions(-)

diff --git a/term-utils/scriptreplay.1 b/term-utils/scriptreplay.1
index 99bf9c3d2..18aadd5f4 100644
--- a/term-utils/scriptreplay.1
+++ b/term-utils/scriptreplay.1
@@ -30,7 +30,7 @@ outputs to file specified by
 .BR \-\-log-timing .
 .PP
 By default, the typescript to display is assumed to be named
-.BR typescript ,
+.IR typescript ,
 but other filenames may be specified, as the second parameter or with option
 .BR \-\-log\-out .
 .PP
@@ -56,20 +56,21 @@ File containing \fBscript\fR's terminal output and input.
 File containing \fBscript\fR's timing output.  This option overrides old-style arguments.
 .TP
 .BR \-T , " \-\-log\-timing " \fIfile\fR
-aliast to \fB\-t\fR, maintained for compatibility with
-.B script (1)
-command line options.
+This is an alias for \fB\-t\fR, maintained for compatibility with
+.BR script (1)
+command-line options.
 .TP
 .BR \-s , " \-\-typescript " \fIfile\fR
 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.
+Specifies how to use the CR (0x0D, carriage return) character from log files.
 The default mode is
 .IR auto ,
 in this case CR is replaced with line break for stdin log, because otherwise
-scriptreplay will overwrite the same line.  The other modes are
+.B scriptreplay
+would overwrite the same line.  The other modes are
 .I never
 and
 .IR always .
@@ -77,33 +78,36 @@ and
 .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
+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.
 .TP
 .BR \-m , " \-\-maxdelay " \fInumber\fR
 Set the maximum delay between updates to
 .I number
-of seconds.  The argument is a floating point number.  This can be used to
+of seconds.  The argument is a floating-point number.  This can be used to
 avoid long pauses in the typescript replay.
 .TP
 .B \-\-summary
-Display details about session recorded in the specified timing file and exit.  The session has
-to be recorded by
+Display details about the session recorded in the specified timing file
+and exit.  The session has to be recorded using
 .I advanced
 format (see
 .BR script (1))
 option \fB\-\-logging\-format\fR for more details).
 .TP
 .BR \-x , " \-\-stream " \fItype\fR
-Forces scriptreplay to print only specified stream.  The supported stream types
+Forces
+.B scriptreplay
+to print only the specified stream.  The supported stream types
 are
 .IR in ,
 .IR out ,
 .IR signal ,
 or
 .IR info .
-This option is recommended for multi-stream logs (e.g., \-\-log-io)
-to print only specified data.
+This option is recommended for multi-stream logs (e.g.,
+.BR \-\-log-io )
+in order to print only specified data.
 .TP
 .BR \-V , " \-\-version"
 Display version information and exit.
-- 
2.26.2


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes
  2020-07-15  8:15 [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes Michael Kerrisk (man-pages)
  2020-07-15  8:15 ` [PATCH 2/3] Manual pages: scriptlive.1: " Michael Kerrisk (man-pages)
  2020-07-15  8:15 ` [PATCH 3/3] Manual pages: scriptreplay.1: " Michael Kerrisk (man-pages)
@ 2020-07-20  8:36 ` Karel Zak
  2 siblings, 0 replies; 4+ messages in thread
From: Karel Zak @ 2020-07-20  8:36 UTC (permalink / raw)
  To: Michael Kerrisk (man-pages); +Cc: util-linux

On Wed, Jul 15, 2020 at 10:15:44AM +0200, Michael Kerrisk (man-pages) wrote:
>  term-utils/script.1 | 51 ++++++++++++++++++++++++++-------------------
>  1 file changed, 30 insertions(+), 21 deletions(-)

All three patches applied. Thanks!

    Karel

-- 
 Karel Zak  <kzak@redhat.com>
 http://karelzak.blogspot.com


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, back to index

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-07-15  8:15 [PATCH 1/3] Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes Michael Kerrisk (man-pages)
2020-07-15  8:15 ` [PATCH 2/3] Manual pages: scriptlive.1: " Michael Kerrisk (man-pages)
2020-07-15  8:15 ` [PATCH 3/3] Manual pages: scriptreplay.1: " Michael Kerrisk (man-pages)
2020-07-20  8:36 ` [PATCH 1/3] Manual pages: script.1: " Karel Zak

Util-Linux Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/util-linux/0 util-linux/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 util-linux util-linux/ https://lore.kernel.org/util-linux \
		util-linux@vger.kernel.org
	public-inbox-index util-linux

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.util-linux


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git