Section (1) script
script — make typescript of terminal session
script [options] [file]
script makes a typescript of everything displayed on your terminal. It is useful for students who need a hardcopy record of an interactive session as proof of an assignment, as the typescript file can be printed out later with lpr(1).
If the argument
file is given, script saves the dialogue
file. If no
filename is given, the dialogue is saved in the file
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.
Append the output to
fileor to typescript, retaining the prior contents.
Run the 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 tty.
Return the exit code of the child process. Uses the same format as bash termination on signal termination exit code is 128+n. The exit code of the child process is always stored in type script file too.
Flush output after each write. This is nice for telecooperation: one person does `mkfifo foo; script -f foo_zsingle_quotesz_, and another can supervise real-time what is being done using `cat foo_zsingle_quotesz_.
Allow the default output destination, i.e. the typescript file, to be a hard or symbolic link. The command will follow a symbolic link.
Limit the size of the typescript and timing files to size and stop the child process after this size is exceeded. The calculated file size does not include the start and done messages that the script command prepends and appends to the child process output. Due to buffering, the resulting output file might be larger than the specified value.
Be quiet (do not write start and done messages to standard output).
Output timing data to standard error, or to
filewhen given. This data 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. This information can be used to replay typescripts with realistic typing and output delays.
Display version information and exit.
Display help text and exit.
The script ends when the forked shell exits (a
control-D for the Bourne
not set) for the C-shell, csh(1)).
Certain interactive commands, such as vi(1), create garbage in the typescript file. script 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 script in non-interactive
shells. The inner shell of script is always
interactive, and this could lead to unexpected results. If
you use script
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 script exit fi
You should also avoid use of script in command pipes, as script can read more input than you would expect.
The following environment variable is utilized by script:
If the variable
SHELLexists, the shell forked by script will be that shell. If
SHELLis not set, the Bourne shell is assumed. (Most shells set this variable automatically).
csh(1) (for the history mechanism), scriptreplay(1)
script places everything in the log file, including linefeeds and backspaces. This is not what the naive user expects.
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 script 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
Copyright (c) 1980, 1990 Regents of the University of California.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. All advertising materials mentioning features or use of this software
must display the following acknowledgement:
This product includes software developed by the University of
California, Berkeley and its contributors.
4. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS_zsingle_quotesz__zsingle_quotesz_ AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
(#)script.1 6.5 (Berkeley) 7/27/91