1.\" $OpenBSD: script.1,v 1.16 2018/07/13 16:59:46 cheloha Exp $ 2.\" $NetBSD: script.1,v 1.3 1994/12/21 08:55:41 jtc Exp $ 3.\" 4.\" Copyright (c) 1980, 1990, 1993 5.\" The Regents of the University of California. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 1. Redistributions of source code must retain the above copyright 11.\" notice, this list of conditions and the following disclaimer. 12.\" 2. Redistributions in binary form must reproduce the above copyright 13.\" notice, this list of conditions and the following disclaimer in the 14.\" documentation and/or other materials provided with the distribution. 15.\" 3. Neither the name of the University nor the names of its contributors 16.\" may be used to endorse or promote products derived from this software 17.\" without specific prior written permission. 18.\" 19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29.\" SUCH DAMAGE. 30.\" 31.\" @(#)script.1 8.1 (Berkeley) 6/6/93 32.\" 33.Dd $Mdocdate: July 13 2018 $ 34.Dt SCRIPT 1 35.Os 36.Sh NAME 37.Nm script 38.Nd make typescript of terminal session 39.Sh SYNOPSIS 40.Nm script 41.Op Fl a 42.Op Fl c Ar command 43.Op Ar file 44.Sh DESCRIPTION 45.Nm 46makes a typescript of everything printed on your terminal. 47It is useful for students who need a hardcopy record of an interactive 48session as proof of an assignment, as the typescript file 49can be printed out later with 50.Xr lpr 1 . 51.Pp 52If the argument 53.Ar file 54is given, 55.Nm 56saves all dialogue in 57.Ar file . 58If no file name is given, the typescript is saved in the file 59.Pa typescript . 60.Pp 61The options are as follows: 62.Bl -tag -width Ds 63.It Fl a 64Append the output to 65.Ar file 66or 67.Pa typescript , 68retaining the prior contents. 69.It Fl c Ar command 70Run 71.Ar command 72instead of an interactive shell. 73To run a command with arguments, enclose both in quotes. 74.El 75.Pp 76The script ends when the forked program exits (a control-D 77.Pq Ql ^D 78to exit 79the Bourne shell 80.Pf ( Xr sh 1 ) , 81and 82.Ic exit , 83.Ic logout , 84or control-D 85(if 86.Va ignoreeof 87is not set) for the 88C-shell, 89.Xr csh 1 ) . 90.Nm 91will exit with the status of 0 unless any of its child 92processes fail. 93In which case, 94.Nm 95will return 1. 96.Pp 97Certain interactive commands, such as 98.Xr vi 1 , 99create garbage in the typescript file. 100.Nm 101works best with commands that do not manipulate the 102screen; the results are meant to emulate a hardcopy terminal. 103.Sh ENVIRONMENT 104.Bl -tag -width SHELL 105.It Ev SHELL 106Name of the shell to be forked by 107.Nm script . 108If not set, the Bourne shell is assumed. 109(Most shells set this variable automatically.) 110.El 111.Sh EXAMPLES 112Start a virtual machine and log all console output to a file: 113.Bd -literal -offset indent 114$ script -c "vmctl start myvm -c" myvm.typescript 115.Ed 116.Sh HISTORY 117A predecessor called 118.Nm dribble 119appeared in 120.Bx 2 . 121The 122.Nm 123command first appeared in 124.Bx 3 . 125.Sh AUTHORS 126.An Mary Ann Horton . 127.Sh BUGS 128.Nm 129places 130.Em everything 131in the log file, including linefeeds and backspaces. 132This is not what the naive user expects. 133