1.\" Copyright (c) 1980, 1990, 1993 2.\" The Regents of the University of California. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 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.\" 4. 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. 15.\" 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 26.\" SUCH DAMAGE. 27.\" 28.\" @(#)script.1 8.1 (Berkeley) 6/6/93 29.\" $FreeBSD$ 30.\" 31.Dd July 30, 2012 32.Dt SCRIPT 1 33.Os 34.Sh NAME 35.Nm script 36.Nd make typescript of terminal session 37.Sh SYNOPSIS 38.Nm 39.Op Fl adkpqr 40.Op Fl t Ar time 41.Op Ar file Op Ar command ... 42.Sh DESCRIPTION 43The 44.Nm 45utility makes a typescript of everything printed on your terminal. 46It is useful for students who need a hardcopy record of an interactive 47session as proof of an assignment, as the typescript file 48can be printed out later with 49.Xr lpr 1 . 50.Pp 51If the argument 52.Ar file 53is given, 54.Nm 55saves all dialogue in 56.Ar file . 57If no file name is given, the typescript is saved in the file 58.Pa typescript . 59.Pp 60If the argument 61.Ar command 62is given, 63.Nm 64will run the specified command with an optional argument vector 65instead of an interactive shell. 66.Pp 67The following options are available: 68.Bl -tag -width indent 69.It Fl a 70Append the output to 71.Ar file 72or 73.Pa typescript , 74retaining the prior contents. 75.It Fl d 76When playing back a session with the 77.Fl p 78flag, do not sleep between records when playing back a timestamped session. 79.It Fl k 80Log keys sent to the program as well as output. 81.It Fl p 82Play back a session recorded with the 83.Fl r 84flag in real time. 85.It Fl q 86Run in quiet mode, omit the start, stop and command status messages. 87.It Fl r 88Record a session with input, output, and timestamping. 89.It Fl t Ar time 90Specify the interval at which the script output file will be flushed 91to disk, in seconds. 92A value of 0 93causes 94.Nm 95to flush after every character I/O event. 96The default interval is 9730 seconds. 98.El 99.Pp 100The script ends when the forked shell (or command) exits (a 101.Em control-D 102to exit 103the Bourne shell 104.Pf ( Xr sh 1 ) , 105and 106.Em exit , 107.Em logout 108or 109.Em control-D 110(if 111.Em ignoreeof 112is not set) for the 113C-shell, 114.Xr csh 1 ) . 115.Pp 116Certain interactive commands, such as 117.Xr vi 1 , 118create garbage in the typescript file. 119The 120.Nm 121utility works best with commands that do not manipulate the screen. 122The results are meant to emulate a hardcopy terminal, not an addressable one. 123.Sh ENVIRONMENT 124The following environment variables are utilized by 125.Nm : 126.Bl -tag -width SHELL 127.It Ev SCRIPT 128The 129.Ev SCRIPT 130environment variable is added to the sub-shell. 131If 132.Ev SCRIPT 133already existed in the users environment, 134its value is overwritten within the sub-shell. 135The value of 136.Ev SCRIPT 137is the name of the 138.Ar typescript 139file. 140.It Ev SHELL 141If the variable 142.Ev SHELL 143exists, the shell forked by 144.Nm 145will be that shell. 146If 147.Ev SHELL 148is not set, the Bourne shell 149is assumed. 150.Pq Most shells set this variable automatically . 151.El 152.Sh SEE ALSO 153.Xr csh 1 154.Po 155for the 156.Em history 157mechanism 158.Pc . 159.Sh HISTORY 160The 161.Nm 162command appeared in 163.Bx 3.0 . 164.Pp 165The 166.Fl d , 167.Fl p 168and 169.Fl r 170options first appeared in 171.Nx 2.0 172and were ported to 173.Fx 10 . 174.Sh BUGS 175The 176.Nm 177utility places 178.Sy everything 179in the log file, including linefeeds and backspaces. 180This is not what the naive user expects. 181.Pp 182It is not possible to specify a command without also naming the script file 183because of argument parsing compatibility issues. 184.Pp 185When running in 186.Fl k 187mode, echo cancelling is far from ideal. 188The slave terminal mode is checked 189for ECHO mode to check when to avoid manual echo logging. 190This does not 191work when the terminal is in a raw mode where 192the program being run is doing manual echo. 193.Pp 194If 195.Nm 196reads zero bytes from the terminal, it switches to a mode when it 197only attempts to read 198once a second until there is data to read. 199This prevents 200.Nm 201from spinning on zero-byte reads, but might cause a 1-second delay in 202processing of user input. 203