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