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