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
41 .Op Ar file Op Ar command ...
50 utility makes a typescript of everything printed on your terminal.
51 It is useful for students who need a hardcopy record of an interactive
52 session as proof of an assignment, as the typescript file
53 can be printed out later with
62 If no file name is given, the typescript is saved in the file
69 will run the specified command with an optional argument vector
70 instead of an interactive shell.
72 The following options are available:
73 .Bl -tag -width "-F pipe"
79 retaining the prior contents.
81 When playing back a session with the
83 flag, do not sleep between records when playing back a timestamped session.
85 Accepted for compatibility with
88 The child command exit status is always the exit status of
91 Immediately flush output after each write.
92 This will allow a user to create a named pipe using
94 and another user may watch the live session using a utility like
100 .Pa typescript.filemon
104 Log keys sent to the program as well as output.
106 Play back a session recorded with the
110 Run in quiet mode, omit the start, stop and command status messages.
112 Record a session with input, output, and timestamping.
114 Specify the interval at which the script output file will be flushed
119 to flush after every character I/O event.
120 The default interval is
125 but just reports the time-stamp of each output.
126 This is very useful for assessing the timing of events.
132 characters, it indicates the default format:
133 .Ql %n@ %s [%Y-%m-%d %T]%n ,
134 which is useful for both tools and humans to read, should be used.
135 Note that time-stamps will only be output when different from the
139 The script ends when the forked shell (or command) exits (a
155 Certain interactive commands, such as
157 create garbage in the typescript file.
160 utility works best with commands that do not manipulate the screen.
161 The results are meant to emulate a hardcopy terminal, not an addressable one.
163 The following environment variables are utilized by
165 .Bl -tag -width SCRIPT
169 environment variable is added to the sub-shell.
172 already existed in the users environment,
173 its value is overwritten within the sub-shell.
182 exists, the shell forked by
187 is not set, the Bourne shell
189 .Pq Most shells set this variable automatically .
194 session with no additional details like input, output, and timestamping:
195 .Bd -literal -offset indent
196 $ SHELL=/bin/csh script
197 Script started, output file is typescript
199 Tue Jan 5 15:08:10 UTC 2021
203 Script done, output file is typescript
206 Now, replay the session recorded in the previous example:
207 .Bd -literal -offset indent
209 Script started on Tue Jan 5 15:08:08 2021
211 Tue Jan 5 15:08:10 UTC 2021
215 Script done on Tue Jan 5 15:08:13 2021
220 session, but this time with additional details like timestamping:
221 .Bd -literal -offset indent
222 $ SHELL=/bin/csh script -r
223 Script started, output file is typescript
225 Tue Jan 5 15:17:11 UTC 2021
229 Script done, output file is typescript
232 In order to replay a sessions recorded with the
234 flag, it is necessary to specify
238 will not work because of all the aditional information stored in the session file
242 to print the whole session at once:
243 .Bd -literal -offset indent
244 $ script -dp ./typescript
245 Script started on Tue Jan 5 15:17:09 2021
247 Tue Jan 5 15:17:11 UTC 2021
251 Script done on Tue Jan 5 15:17:14 2021
272 options first appeared in
281 in the log file, including linefeeds and backspaces.
282 This is not what the naive user expects.
284 It is not possible to specify a command without also naming the script file
285 because of argument parsing compatibility issues.
289 mode, echo cancelling is far from ideal.
290 The slave terminal mode is checked
291 for ECHO mode to check when to avoid manual echo logging.
293 work when the terminal is in a raw mode where
294 the program being run is doing manual echo.
298 reads zero bytes from the terminal, it switches to a mode when it
299 only attempts to read
300 once a second until there is data to read.
303 from spinning on zero-byte reads, but might cause a 1-second delay in
304 processing of user input.