Manual pages: script.1: Miscellaneous wording, grammar, and formatting fixes
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>
This commit is contained in:
parent
3575089b16
commit
1dd82d5491
|
@ -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
|
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
|
to another (optional) structured log file. The timing log file is necessary to replay
|
||||||
the session later by
|
the session later by
|
||||||
.B scriptreplay (1)
|
.BR scriptreplay (1)
|
||||||
and to store additional information about the session.
|
and to store additional information about the session.
|
||||||
.PP
|
.PP
|
||||||
Since version 2.35
|
Since version 2.35,
|
||||||
.B script
|
.B script
|
||||||
supports multiple streams and allows the logging of input and output to separate
|
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
|
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
|
saves the dialogue in this
|
||||||
.IR file .
|
.IR file .
|
||||||
If no filename is given, the dialogue is saved in the file
|
If no filename is given, the dialogue is saved in the file
|
||||||
.BR typescript .
|
.IR typescript .
|
||||||
.PP
|
.PP
|
||||||
Note that log input by \fB\-\-log\-in\fR or \fB\-\-log\-io\fR may be security
|
Note that logging input using \fB\-\-log\-in\fR or \fB\-\-log\-io\fR
|
||||||
sensitive operation as the log file contains all terminal session input (it
|
may record security-sensitive information
|
||||||
means also passwords) independently on the terminal echo flag setting.
|
as the log file contains all terminal session input
|
||||||
|
(e.g., passwords)
|
||||||
|
independently of the terminal echo flag setting.
|
||||||
.SH OPTIONS
|
.SH OPTIONS
|
||||||
Below, the \fIsize\fR argument may be followed by the multiplicative
|
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
|
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
|
Append the output to
|
||||||
.I file
|
.I file
|
||||||
or to
|
or to
|
||||||
.BR typescript ,
|
.IR typescript ,
|
||||||
retaining the prior contents.
|
retaining the prior contents.
|
||||||
.TP
|
.TP
|
||||||
\fB\-c\fR, \fB\-\-command\fR \fIcommand\fR
|
\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.
|
tty.
|
||||||
.TP
|
.TP
|
||||||
\fB\-E\fR, \fB\-\-echo\fR \fIwhen\fR
|
\fB\-E\fR, \fB\-\-echo\fR \fIwhen\fR
|
||||||
This option controls the ECHO flag for pseudoterminal within the session. The
|
This option controls the ECHO flag for the pseudoterminal within the session.
|
||||||
supported modes are
|
The supported modes are
|
||||||
.IR always ,
|
.IR always ,
|
||||||
.IR never ,
|
.IR never ,
|
||||||
or
|
or
|
||||||
|
@ -98,25 +100,28 @@ or
|
||||||
The default is
|
The default is
|
||||||
.I auto
|
.I auto
|
||||||
-- in this case, ECHO is disabled if the current standard input is a
|
-- 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:
|
(for example pipe:
|
||||||
.BR "echo date | script" )
|
.BR "echo date | script" )
|
||||||
to avoid missing input in the session log.
|
to avoid missing input in the session log.
|
||||||
.TP
|
.TP
|
||||||
\fB\-e\fR, \fB\-\-return\fR
|
\fB\-e\fR, \fB\-\-return\fR
|
||||||
Return the exit status of the child process. Uses the same format as bash
|
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
|
termination on signal termination
|
||||||
the child process is always stored in type script file too.
|
(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
|
.TP
|
||||||
\fB\-f\fR, \fB\-\-flush\fR
|
\fB\-f\fR, \fB\-\-flush\fR
|
||||||
Flush output after each write. This is nice for telecooperation: one person
|
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
|
does `mkfifo foo; script \-f foo',
|
||||||
being done using `cat foo'. Note that flush has an impact on performance, it's
|
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.
|
possible to use SIGUSR1 to flush logs on demand.
|
||||||
.TP
|
.TP
|
||||||
\fB\-\-force\fR
|
\fB\-\-force\fR
|
||||||
Allow the default output file
|
Allow the default output file
|
||||||
.B typescript
|
.I typescript
|
||||||
to be a hard or symbolic link. The command will follow a symbolic link.
|
to be a hard or symbolic link. The command will follow a symbolic link.
|
||||||
.TP
|
.TP
|
||||||
\fB\-B\fR, \fB\-\-log\-io\fR \fIfile\fR
|
\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.
|
specified.
|
||||||
.sp
|
.sp
|
||||||
Use this logging functionality carefully as it logs all input, including input
|
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
|
.TP
|
||||||
\fB\-O\fR, \fB\-\-log\-out\fR \fIfile\fR
|
\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
|
Log output to the \fIfile\fR. The default is to log output to the file with
|
||||||
name
|
name
|
||||||
.B typescript
|
.I typescript
|
||||||
if the option \fB\-\-log\-out\fR or \fB\-\-log\-in\fR is not given. The log
|
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.
|
output is disabled if only \fB\-\-log\-in\fR specified.
|
||||||
.TP
|
.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.
|
See also \fB\-\-logging\-format\fR.
|
||||||
.TP
|
.TP
|
||||||
\fB\-m\fR, \fB\-\-logging\-format\fR \fIformat\fR
|
\fB\-m\fR, \fB\-\-logging\-format\fR \fIformat\fR
|
||||||
Force use
|
Force use of
|
||||||
.I advanced
|
.I advanced
|
||||||
or
|
or
|
||||||
.I classic
|
.I classic
|
||||||
|
@ -163,8 +168,10 @@ field indicates how many characters were output this time.
|
||||||
.sp
|
.sp
|
||||||
.B Advanced (multi-stream) format
|
.B Advanced (multi-stream) format
|
||||||
.PP
|
.PP
|
||||||
The first field is entry type itentifier ('I'nput, 'O'utput, 'H'eader, 'S'ignal).
|
The first field is an entry type identifier
|
||||||
The socond field is how much time elapsed since the previous entry, and rest of the entry is type specific data.
|
('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
|
.RE
|
||||||
.TP
|
.TP
|
||||||
\fB\-o\fR, \fB\-\-output-limit\fR \fIsize\fR
|
\fB\-o\fR, \fB\-\-output-limit\fR \fIsize\fR
|
||||||
|
@ -252,7 +259,9 @@ fi
|
||||||
.RE
|
.RE
|
||||||
.ad
|
.ad
|
||||||
.PP
|
.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
|
.B script
|
||||||
can read more input than you would expect.
|
can read more input than you would expect.
|
||||||
.SH HISTORY
|
.SH HISTORY
|
||||||
|
|
Loading…
Reference in New Issue