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. Neither the name of the University nor the names of its contributors
13 .\" may be used to endorse or promote products derived from this software
14 .\" without specific prior written permission.
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" @(#)script.1 8.1 (Berkeley) 6/6/93
36 .Nd make typescript of terminal session
42 .Op Ar file Op Ar command ...
46 utility makes a typescript of everything printed on your terminal.
47 It is useful for students who need a hardcopy record of an interactive
48 session as proof of an assignment, as the typescript file
49 can be printed out later with
58 If no file name is given, the typescript is saved in the file
65 will run the specified command with an optional argument vector
66 instead of an interactive shell.
68 The following options are available:
69 .Bl -tag -width indent
75 retaining the prior contents.
77 When playing back a session with the
79 flag, do not sleep between records when playing back a timestamped session.
81 Accepted for compatibility with
84 The child command exit status is always the exit status of
87 Immediately flush output after each write.
88 This will allow a user to create a named pipe using
90 and another user may watch the live session using a utility like
96 .Pa typescript.filemon
100 Log keys sent to the program as well as output.
102 Play back a session recorded with the
106 Run in quiet mode, omit the start, stop and command status messages.
108 Record a session with input, output, and timestamping.
110 Specify the interval at which the script output file will be flushed
115 to flush after every character I/O event.
116 The default interval is
120 The script ends when the forked shell (or command) exits (a
136 Certain interactive commands, such as
138 create garbage in the typescript file.
141 utility works best with commands that do not manipulate the screen.
142 The results are meant to emulate a hardcopy terminal, not an addressable one.
144 The following environment variables are utilized by
146 .Bl -tag -width SHELL
150 environment variable is added to the sub-shell.
153 already existed in the users environment,
154 its value is overwritten within the sub-shell.
163 exists, the shell forked by
168 is not set, the Bourne shell
170 .Pq Most shells set this variable automatically .
191 options first appeared in
200 in the log file, including linefeeds and backspaces.
201 This is not what the naive user expects.
203 It is not possible to specify a command without also naming the script file
204 because of argument parsing compatibility issues.
208 mode, echo cancelling is far from ideal.
209 The slave terminal mode is checked
210 for ECHO mode to check when to avoid manual echo logging.
212 work when the terminal is in a raw mode where
213 the program being run is doing manual echo.
217 reads zero bytes from the terminal, it switches to a mode when it
218 only attempts to read
219 once a second until there is data to read.
222 from spinning on zero-byte reads, but might cause a 1-second delay in
223 processing of user input.