xref: /openbsd-src/usr.bin/script/script.1 (revision ce7e0fc6a9d74d25b78fb6ad846387717f5172b6)
1.\"	$OpenBSD: script.1,v 1.9 2001/05/01 17:58:04 aaron 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. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"	@(#)script.1	8.1 (Berkeley) 6/6/93
36.\"
37.Dd June 6, 1993
38.Dt SCRIPT 1
39.Os
40.Sh NAME
41.Nm script
42.Nd make typescript of terminal session
43.Sh SYNOPSIS
44.Nm script
45.Op Fl a
46.Op Ar file
47.Sh DESCRIPTION
48.Nm
49makes 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
64The options are as follows:
65.Bl -tag -width Ds
66.It Fl a
67Append the output to
68.Ar file
69or
70.Pa typescript ,
71retaining the prior contents.
72.El
73.Pp
74The script ends when the forked shell exits (a control-D
75.Pq Ql ^D
76to exit
77the Bourne shell
78.Pf ( Xr sh 1 ) ,
79and
80.Ic exit ,
81.Ic logout ,
82or control-D
83(if
84.Va ignoreeof
85is not set) for the
86C-shell,
87.Xr csh 1 ) .
88.Nm
89will exit with the status of 0 unless any of its child
90processes fail. In which case,
91.Nm
92will return 1.
93.Pp
94Certain interactive commands, such as
95.Xr vi 1 ,
96create garbage in the typescript file.
97.Nm
98works best with commands that do not manipulate the
99screen; the results are meant to emulate a hardcopy terminal.
100.Sh ENVIRONMENT
101.Bl -tag -width SHELL
102.It Ev SHELL
103Name of the shell to be forked by
104.Nm script .
105If not set, the Bourne shell is assumed.
106(Most shells set this variable automatically.)
107.El
108.Sh SEE ALSO
109.Xr csh 1
110(for the
111.Sy history
112mechanism)
113.Sh HISTORY
114The
115.Nm
116command appeared in
117.Bx 3.0 .
118.Sh BUGS
119.Nm
120places
121.Em everything
122in the log file, including linefeeds and backspaces.
123This is not what the naive user expects.
124