1 .\" Copyright (c) 1980, 1990, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)script.1 8.1 (Berkeley) 6/6/93
35 .Dd September 28, 2011
40 .Nd make typescript of terminal session
45 .Op Ar file Op Ar command ...
49 utility makes a typescript of everything printed on your terminal.
50 It is useful for students who need a hardcopy record of an interactive
51 session as proof of an assignment, as the typescript file
52 can be printed out later with
61 If no file name is given, the typescript is saved in the file
68 will run the specified command with an optional argument vector
69 instead of an interactive shell.
71 The following options are available:
72 .Bl -tag -width indent
78 retaining the prior contents.
80 Log keys sent to the program as well as output.
82 Run in quiet mode, omit the start and stop status messages.
84 Specify the interval at which the script output file will be flushed
89 to flush after every character I/O event.
90 The default interval is
94 The script ends when the forked shell (or command) exits (a
110 Certain interactive commands, such as
112 create garbage in the typescript file.
115 utility works best with commands that do not manipulate the screen.
116 The results are meant to emulate a hardcopy terminal, not an addressable one.
118 The following environment variables are utilized by
120 .Bl -tag -width SHELL
124 environment variable is added to the sub-shell.
127 already existed in the users environment,
128 its value is overwritten within the sub-shell.
137 exists, the shell forked by
142 is not set, the Bourne shell
144 .Pq Most shells set this variable automatically .
163 in the log file, including linefeeds and backspaces.
164 This is not what the naive user expects.
166 It is not possible to specify a command without also naming the script file
167 because of argument parsing compatibility issues.
171 mode, echo cancelling is far from ideal.
172 The slave terminal mode is checked
173 for ECHO mode to check when to avoid manual echo logging.
175 work when the terminal is in a raw mode where
176 the program being run is doing manual echo.
180 reads zero bytes from the terminal, it switches to a mode when it
181 only attempts to read
182 once a second until there is data to read.
185 from spinning on zero-byte reads, but might cause a 1-second delay in
186 processing of user input.