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