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 January 22, 2004 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 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 time interval between flushing script output file. 81A value of 0 82causes 83.Nm 84to flush for every character I/O event. 85The default interval is 8630 seconds. 87.El 88.Pp 89The script ends when the forked shell (or command) exits (a 90.Em control-D 91to exit 92the Bourne shell 93.Pf ( Xr sh 1 ) , 94and 95.Em exit , 96.Em logout 97or 98.Em control-D 99(if 100.Em ignoreeof 101is not set) for the 102C-shell, 103.Xr csh 1 ) . 104.Pp 105Certain interactive commands, such as 106.Xr vi 1 , 107create garbage in the typescript file. 108The 109.Nm 110utility works best with commands that do not manipulate the screen. 111The results are meant to emulate a hardcopy terminal, not an addressable one. 112.Sh ENVIRONMENT 113The following environment variables are utilized by 114.Nm : 115.Bl -tag -width SHELL 116.It Ev SCRIPT 117The 118.Ev SCRIPT 119environment variable is added to the sub-shell. 120If 121.Ev SCRIPT 122already existed in the users environment, 123its value is overwritten within the sub-shell. 124The value of 125.Ev SCRIPT 126is the name of the 127.Ar typescript 128file. 129.It Ev SHELL 130If the variable 131.Ev SHELL 132exists, the shell forked by 133.Nm 134will be that shell. 135If 136.Ev SHELL 137is not set, the Bourne shell 138is assumed. 139(Most shells set this variable automatically). 140.El 141.Sh SEE ALSO 142.Xr csh 1 143(for the 144.Em history 145mechanism). 146.Sh HISTORY 147The 148.Nm 149command appeared in 150.Bx 3.0 . 151.Sh BUGS 152The 153.Nm 154utility places 155.Sy everything 156in the log file, including linefeeds and backspaces. 157This is not what the naive user expects. 158.Pp 159It is not possible to specify a command without also naming the script file 160because of argument parsing compatibility issues. 161.Pp 162When running in 163.Fl k 164mode, echo cancelling is far from ideal. 165The slave terminal mode is checked 166for ECHO mode to check when to avoid manual echo logging. 167This does not 168work when in a raw mode where the program being run is doing manual echo. 169