xref: /freebsd/usr.bin/script/script.1 (revision 33b77e2decd50e53798014b70bf7ca3bdc4c0c7e)
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.\"	$Id$
34.\"
35.Dd June 6, 1993
36.Dt SCRIPT 1
37.Os BSD 4
38.Sh NAME
39.Nm script
40.Nd make typescript of terminal session
41.Sh SYNOPSIS
42.Nm
43.Op Fl a
44.Op Fl q
45.Op Ar file
46.Op Ar command ...
47.Sh DESCRIPTION
48.Nm Script
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
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
71Option:
72.Bl -tag -width Ds
73.It Fl a
74Append the output to
75.Ar file
76or
77.Pa typescript ,
78retaining the prior contents.
79.It Fl q
80Run in quiet mode, omit the start and stop status messages.
81.El
82.Pp
83The script ends when the forked shell (or command) exits (a
84.Em control-D
85to exit
86the Bourne shell
87.Pf ( Xr sh 1 ) ,
88and
89.Em exit ,
90.Em logout
91or
92.Em control-d
93(if
94.Em ignoreeof
95is not set) for the
96C-shell,
97.Xr csh 1 ) .
98.Pp
99Certain interactive commands, such as
100.Xr vi 1 ,
101create garbage in the typescript file.
102.Nm Script
103works best with commands that do not manipulate the
104screen, the results are meant to emulate a hardcopy
105terminal.
106.Sh ENVIRONMENT
107The following environment variable is utilized by
108.Nm script :
109.Bl -tag -width SHELL
110.It Ev SHELL
111If the variable
112.Ev SHELL
113exists, the shell forked by
114.Nm
115will be that shell. If
116.Ev SHELL
117is not set, the Bourne shell
118is assumed. (Most shells set this variable automatically).
119.El
120.Sh SEE ALSO
121.Xr csh 1
122(for the
123.Em history
124mechanism).
125.Sh HISTORY
126The
127.Nm
128command appeared in
129.Bx 3.0 .
130.Sh BUGS
131.Nm Script
132places
133.Sy everything
134in the log file, including linefeeds and backspaces.
135This is not what the naive user expects.
136.Pp
137It is not possible to specify a command without also naming the script file
138because of argument parsing compatability issues.
139