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. 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: head/usr.bin/script/script.1 314436 2017-02-28 23:42:47Z imp $
  30 .\"
  31 .Dd November 25, 2018
  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 adkpqr
  40 .Op Fl F Ar pipe
  41 .Op Fl t Ar time
  42 .Op Ar file Op Ar command ...
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility makes a typescript of everything printed on your terminal.
  47 It is useful for students who need a hardcopy record of an interactive
  48 session as proof of an assignment, as the typescript file
  49 can be printed out later with
  50 .Xr lpr 1 .
  51 .Pp
  52 If the argument
  53 .Ar file
  54 is given,
  55 .Nm
  56 saves all dialogue in
  57 .Ar file .
  58 If no file name is given, the typescript is saved in the file
  59 .Pa typescript .
  60 .Pp
  61 If the argument
  62 .Ar command
  63 is given,
  64 .Nm
  65 will run the specified command with an optional argument vector
  66 instead of an interactive shell.
  67 .Pp
  68 The following options are available:
  69 .Bl -tag -width indent
  70 .It Fl a
  71 Append the output to
  72 .Ar file
  73 or
  74 .Pa typescript ,
  75 retaining the prior contents.
  76 .It Fl d
  77 When playing back a session with the
  78 .Fl p
  79 flag, do not sleep between records when playing back a timestamped session.
  80 .It Fl F Ar pipe
  81 Immediately flush output after each write.
  82 This will allow a user to create a named pipe using
  83 .Xr mkfifo 1
  84 and another user may watch the live session using a utility like
  85 .Xr cat 1 .
  86 .It Fl k
  87 Log keys sent to the program as well as output.
  88 .It Fl p
  89 Play back a session recorded with the
  90 .Fl r
  91 flag in real time.
  92 .It Fl q
  93 Run in quiet mode, omit the start, stop and command status messages.
  94 .It Fl r
  95 Record a session with input, output, and timestamping.
  96 .It Fl t Ar time
  97 Specify the interval at which the script output file will be flushed
  98 to disk, in seconds.
  99 A value of 0
 100 causes
 101 .Nm
 102 to flush after every character I/O event.
 103 The default interval is
 104 30 seconds.
 105 .El
 106 .Pp
 107 The script ends when the forked shell (or command) exits (a
 108 .Em control-D
 109 to exit
 110 the Bourne shell
 111 .Pf ( Xr sh 1 ) ,
 112 and
 113 .Em exit ,
 114 .Em logout
 115 or
 116 .Em control-D
 117 (if
 118 .Em ignoreeof
 119 is not set) for the
 120 C-shell,
 121 .Xr csh 1 ) .
 122 .Pp
 123 Certain interactive commands, such as
 124 .Xr vi 1 ,
 125 create garbage in the typescript file.
 126 The
 127 .Nm
 128 utility works best with commands that do not manipulate the screen.
 129 The results are meant to emulate a hardcopy terminal, not an addressable one.
 130 .Sh ENVIRONMENT
 131 The following environment variables are utilized by
 132 .Nm :
 133 .Bl -tag -width SHELL
 134 .It Ev SCRIPT
 135 The
 136 .Ev SCRIPT
 137 environment variable is added to the sub-shell.
 138 If
 139 .Ev SCRIPT
 140 already existed in the users environment,
 141 its value is overwritten within the sub-shell.
 142 The value of
 143 .Ev SCRIPT
 144 is the name of the
 145 .Ar typescript
 146 file.
 147 .It Ev SHELL
 148 If the variable
 149 .Ev SHELL
 150 exists, the shell forked by
 151 .Nm
 152 will be that shell.
 153 If
 154 .Ev SHELL
 155 is not set, the Bourne shell
 156 is assumed.
 157 .Pq Most shells set this variable automatically .
 158 .El
 159 .Sh SEE ALSO
 160 .Xr csh 1
 161 .Po
 162 for the
 163 .Em history
 164 mechanism
 165 .Pc
 166 .Sh HISTORY
 167 The
 168 .Nm
 169 command appeared in
 170 .Bx 3.0 .
 171 .Pp
 172 The
 173 .Fl d ,
 174 .Fl p
 175 and
 176 .Fl r
 177 options first appeared in
 178 .Nx 2.0
 179 and were ported to
 180 .Fx 9.2 .
 181 .Sh BUGS
 182 The
 183 .Nm
 184 utility places
 185 .Sy everything
 186 in the log file, including linefeeds and backspaces.
 187 This is not what the naive user expects.
 188 .Pp
 189 It is not possible to specify a command without also naming the script file
 190 because of argument parsing compatibility issues.
 191 .Pp
 192 When running in
 193 .Fl k
 194 mode, echo cancelling is far from ideal.
 195 The slave terminal mode is checked
 196 for ECHO mode to check when to avoid manual echo logging.
 197 This does not
 198 work when the terminal is in a raw mode where
 199 the program being run is doing manual echo.
 200 .Pp
 201 If
 202 .Nm
 203 reads zero bytes from the terminal, it switches to a mode when it
 204 only attempts to read
 205 once a second until there is data to read.
 206 This prevents
 207 .Nm
 208 from spinning on zero-byte reads, but might cause a 1-second delay in
 209 processing of user input.