Section: User Commands (1)
Updated: October 2019
script - make typescript of terminal session
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
and to store additional information about the session.
Since version 2.35,
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
which records additional information. The command
then provides all the information.
If the argument
or option --log-out file is given,
saves the dialogue in this
If no filename is given, the dialogue is saved in the file
Note that logging input using --log-in or --log-io
may record security-sensitive information
as the log file contains all terminal session input
independently of the terminal echo flag setting.
Below, the size
argument may be followed by the multiplicative
suffixes KiB (=1024), MiB (=1024*1024), and so on for GiB, TiB, PiB, EiB, ZiB and YiB
(the "iB" is optional, e.g., "K" has the same meaning as "KiB"), or the suffixes
KB (=1000), MB (=1000*1000), and so on for GB, TB, PB, EB, ZB and YB.
- -a, --append
Append the output to
retaining the prior contents.
- -c, --command command
rather than an interactive shell. This makes it easy for a script to capture
the output of a program that behaves differently when its stdout is not a
- -E, --echo when
This option controls the ECHO flag for the pseudoterminal within the session.
The supported modes are
The default is
-- in this case, ECHO is disabled if the current standard input is a
terminal iin order to avoid double-echo,
and enabled if standard input is not a terminal
(for example pipe:
echo date | script)
to avoid missing input in the session log.
- -e, --return
Return the exit status of the child process. Uses the same format as bash
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.
- -f, --flush
Flush output after each write. This is nice for telecooperation: one person
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.
Allow the default output file
to be a hard or symbolic link. The command will follow a symbolic link.
- -B, --log-io file
Log input and output to the same
file. Note, this option makes sense only if --log-timing is
also specified, otherwise it's impossible to separate output and input streams from
the log file.
- -I, --log-in file
Log input to the file. The log output is disabled if only --log-in
Use this logging functionality carefully as it logs all input, including input
when terminal has disabled echo flag (for example, password inputs).
- -O, --log-out file
Log output to the file. The default is to log output to the file with
if the option --log-out or --log-in is not given. The log
output is disabled if only --log-in specified.
- -T, --log-timing file
Log timing information to the file. Two timing file formats are supported
now. The classic format is used when only one stream (input or output) logging
is enabled. The multi-stream format is used on --log-io or when
--log-in and --log-out are used together.
See also --logging-format.
- -m, --logging-format format
Force use of
format. The default is the classic format to log only output and the
advanced format when input as well as output logging is requested.
The log contains two fields, separated by a space. The first
field indicates how much time elapsed since the previous output. The second
field indicates how many characters were output this time.
Advanced (multi-stream) format
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.
- -o, --output-limit size
Limit the size of the typescript and timing files to
and stop the child process after this size is exceeded. The calculated
file size does not include the start and done messages that the
command prepends and appends to the child process output.
Due to buffering, the resulting output file might be larger than the specified value.
- -q, --quiet
Be quiet (do not write start and done messages to standard output).
- -t[file], --timing[=file]
Output timing data to standard error, or to
when given. This option is deprecated in favour of --log-timing where
the file argument is not optional.
- -V, --version
Display version information and exit.
- -h, --help
Display help text and exit.
immediately flushes the output files.
The following environment variable is utilized by
If the variable
exists, the shell forked by
will be that shell. If
is not set, the Bourne shell is assumed. (Most shells set this variable
The script ends when the forked shell exits (a
for the Bourne shell
is not set) for the
Certain interactive commands, such as
create garbage in the typescript file.
works best with commands that do not manipulate the screen, the results are
meant to emulate a hardcopy terminal.
It is not recommended to run
in non-interactive shells. The inner shell of
is always interactive, and this could lead to unexpected results. If you use
in the shell initialization file, you have to avoid entering an infinite
loop. You can use for example the .profile file, which is read
by login shells only:
if test -t 0 ; then
You should also avoid use of
in command pipes, as
can read more input than you would expect.
command appeared in 3.0BSD.
in the log file, including linefeeds and backspaces. This is not what the
naive user expects.
is primarily designed for interactive terminal sessions. When stdin
is not a terminal (for example: echo foo | script), then the session
can hang, because the interactive shell within the script session misses EOF and
has no clue when to close the session. See the NOTES section for more information.
The script command is part of the util-linux package and is available from
Linux Kernel Archive