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 January 22, 2004 36.Dt SCRIPT 1 37.Os 38.Sh NAME 39.Nm script 40.Nd make typescript of terminal session 41.Sh SYNOPSIS 42.Nm 43.Op Fl akq 44.Op Fl t Ar time 45.Op Ar file Op Ar command ... 46.Sh DESCRIPTION 47The 48.Nm 49utility makes a typescript of everything printed on your terminal. 50It is useful for students who need a hardcopy record of an interactive 51session as proof of an assignment, as the typescript file 52can be printed out later with 53.Xr lpr 1 . 54.Pp 55If the argument 56.Ar file 57is given, 58.Nm 59saves all dialogue in 60.Ar file . 61If no file name is given, the typescript is saved in the file 62.Pa typescript . 63.Pp 64If the argument 65.Ar command 66is given, 67.Nm 68will run the specified command with an optional argument vector 69instead of an interactive shell. 70.Pp 71The following options are available: 72.Bl -tag -width indent 73.It Fl a 74Append the output to 75.Ar file 76or 77.Pa typescript , 78retaining the prior contents. 79.It Fl k 80Log keys sent to program as well as output. 81.It Fl q 82Run in quiet mode, omit the start and stop status messages. 83.It Fl t Ar time 84Specify time interval between flushing script output file. 85A value of 0 86causes 87.Nm 88to flush for every character I/O event. 89The 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. 112The 113.Nm 114utility works best with commands that do not manipulate the screen. 115The results are meant to emulate a hardcopy terminal, not an addressable one. 116.Sh ENVIRONMENT 117The following environment variable is utilized by 118.Nm : 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. 126If 127.Ev SHELL 128is not set, the Bourne shell 129is assumed. 130(Most shells set this variable automatically). 131.El 132.Sh SEE ALSO 133.Xr csh 1 134(for the 135.Em history 136mechanism). 137.Sh HISTORY 138The 139.Nm 140command appeared in 141.Bx 3.0 . 142.Sh BUGS 143The 144.Nm 145utility places 146.Sy everything 147in the log file, including linefeeds and backspaces. 148This is not what the naive user expects. 149.Pp 150It is not possible to specify a command without also naming the script file 151because of argument parsing compatibility issues. 152.Pp 153When running in 154.Fl k 155mode, echo cancelling is far from ideal. 156The slave terminal mode is checked 157for ECHO mode to check when to avoid manual echo logging. 158This does not 159work when in a raw mode where the program being run is doing manual echo. 160