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 September 28, 2011 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 akq 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 k 76Log keys sent to the program as well as output. 77.It Fl q 78Run in quiet mode, omit the start and stop status messages. 79.It Fl t Ar time 80Specify the interval at which the script output file will be flushed 81to disk, in seconds. 82A value of 0 83causes 84.Nm 85to flush after every character I/O event. 86The default interval is 8730 seconds. 88.El 89.Pp 90The script ends when the forked shell (or command) exits (a 91.Em control-D 92to exit 93the Bourne shell 94.Pf ( Xr sh 1 ) , 95and 96.Em exit , 97.Em logout 98or 99.Em control-D 100(if 101.Em ignoreeof 102is not set) for the 103C-shell, 104.Xr csh 1 ) . 105.Pp 106Certain interactive commands, such as 107.Xr vi 1 , 108create garbage in the typescript file. 109The 110.Nm 111utility works best with commands that do not manipulate the screen. 112The results are meant to emulate a hardcopy terminal, not an addressable one. 113.Sh ENVIRONMENT 114The following environment variables are utilized by 115.Nm : 116.Bl -tag -width SHELL 117.It Ev SCRIPT 118The 119.Ev SCRIPT 120environment variable is added to the sub-shell. 121If 122.Ev SCRIPT 123already existed in the users environment, 124its value is overwritten within the sub-shell. 125The value of 126.Ev SCRIPT 127is the name of the 128.Ar typescript 129file. 130.It Ev SHELL 131If the variable 132.Ev SHELL 133exists, the shell forked by 134.Nm 135will be that shell. 136If 137.Ev SHELL 138is not set, the Bourne shell 139is assumed. 140.Pq Most shells set this variable automatically . 141.El 142.Sh SEE ALSO 143.Xr csh 1 144.Po 145for the 146.Em history 147mechanism 148.Pc . 149.Sh HISTORY 150The 151.Nm 152command appeared in 153.Bx 3.0 . 154.Sh BUGS 155The 156.Nm 157utility places 158.Sy everything 159in the log file, including linefeeds and backspaces. 160This is not what the naive user expects. 161.Pp 162It is not possible to specify a command without also naming the script file 163because of argument parsing compatibility issues. 164.Pp 165When running in 166.Fl k 167mode, echo cancelling is far from ideal. 168The slave terminal mode is checked 169for ECHO mode to check when to avoid manual echo logging. 170This does not 171work when the terminal is in a raw mode where 172the program being run is doing manual echo. 173.Pp 174If 175.Nm 176reads zero bytes from the terminal, it switches to a mode when it 177only attempts to read 178once a second until there is data to read. 179This prevents 180.Nm 181from spinning on zero-byte reads, but might cause a 1-second delay in 182processing of user input. 183