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.\" 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. 19.\" 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 30.\" SUCH DAMAGE. 31.\" 32.\" @(#)script.1 8.1 (Berkeley) 6/6/93 33.\" $FreeBSD$ 34.\" 35.Dd June 6, 1993 36.Dt SCRIPT 1 37.Os BSD 4 38.Sh NAME 39.Nm script 40.Nd make typescript of terminal session 41.Sh SYNOPSIS 42.Nm 43.Op Fl a 44.Op Fl k 45.Op Fl q 46.Op Fl t Ar time 47.Op Ar file 48.Op Ar command ... 49.Sh DESCRIPTION 50.Nm Script 51makes a typescript of everything printed on your terminal. 52It is useful for students who need a hardcopy record of an interactive 53session as proof of an assignment, as the typescript file 54can be printed out later with 55.Xr lpr 1 . 56.Pp 57If the argument 58.Ar file 59is given, 60.Nm 61saves all dialogue in 62.Ar file . 63If no file name is given, the typescript is saved in the file 64.Pa typescript . 65.Pp 66If the argument 67.Ar command ... 68is given, 69.Nm 70will run the specified command with an optional argument vector 71instead of an interactive shell. 72.Pp 73Options: 74.Bl -tag -width xxxxxxx 75.It Fl a 76Append the output to 77.Ar file 78or 79.Pa typescript , 80retaining the prior contents. 81.It Fl k 82Log keys sent to program as well as output. 83.It Fl q 84Run in quiet mode, omit the start and stop status messages. 85.It Fl t Ar time 86Specify time interval between flushing script output file. A value of 0 87causes 88.Nm 89to flush for every character I/O event. The default interval is 9030 seconds. 91.El 92.Pp 93The script ends when the forked shell (or command) exits (a 94.Em control-D 95to exit 96the Bourne shell 97.Pf ( Xr sh 1 ) , 98and 99.Em exit , 100.Em logout 101or 102.Em control-d 103(if 104.Em ignoreeof 105is not set) for the 106C-shell, 107.Xr csh 1 ) . 108.Pp 109Certain interactive commands, such as 110.Xr vi 1 , 111create garbage in the typescript file. 112.Nm Script 113works best with commands that do not manipulate the 114screen, the results are meant to emulate a hardcopy 115terminal. 116.Sh ENVIRONMENT 117The following environment variable is utilized by 118.Nm script : 119.Bl -tag -width SHELL 120.It Ev SHELL 121If the variable 122.Ev SHELL 123exists, the shell forked by 124.Nm 125will be that shell. If 126.Ev SHELL 127is not set, the Bourne shell 128is assumed. (Most shells set this variable automatically). 129.El 130.Sh SEE ALSO 131.Xr csh 1 132(for the 133.Em history 134mechanism). 135.Sh HISTORY 136The 137.Nm 138command appeared in 139.Bx 3.0 . 140.Sh BUGS 141.Nm Script 142places 143.Sy everything 144in the log file, including linefeeds and backspaces. 145This is not what the naive user expects. 146.Pp 147It is not possible to specify a command without also naming the script file 148because of argument parsing compatibility issues. 149.Pp 150When running in 151.Fl k 152mode, echo cancelling far from ideal. The slave terminal mode is checked 153for ECHO mode to check when to avoid manual echo logging. This does not 154work when in a raw mode where the program being run is doing manual echo. 155