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