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: src/usr.bin/script/script.1,v 1.12.2.4 2002/06/21 15:29:06 charnier Exp $
  30 .\"
  31 .Dd June 6, 1993
  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 a
  40 .Op Fl k
  41 .Op Fl q
  42 .Op Fl t Ar time
  43 .Op Ar file Op command ...
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility makes a typescript of everything printed on your terminal.
  48 It is useful for students who need a hardcopy record of an interactive
  49 session as proof of an assignment, as the typescript file
  50 can be printed out later with
  51 .Xr lpr 1 .
  52 .Pp
  53 If the argument
  54 .Ar file
  55 is given,
  56 .Nm
  57 saves all dialogue in
  58 .Ar file .
  59 If no file name is given, the typescript is saved in the file
  60 .Pa typescript .
  61 .Pp
  62 If the argument
  63 .Ar command ...
  64 is given,
  65 .Nm
  66 will run the specified command with an optional argument vector
  67 instead of an interactive shell.
  68 .Pp
  69 Options:
  70 .Bl -tag -width xxxxxxx
  71 .It Fl a
  72 Append the output to
  73 .Ar file
  74 or
  75 .Pa typescript ,
  76 retaining the prior contents.
  77 .It Fl k
  78 Log keys sent to program as well as output.
  79 .It Fl q
  80 Run in quiet mode, omit the start and stop status messages.
  81 .It Fl t Ar time
  82 Specify time interval between flushing script output file.  A value of 0
  83 causes
  84 .Nm
  85 to flush for every character I/O event.  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 variable is utilized by
 114 .Nm :
 115 .Bl -tag -width SHELL
 116 .It Ev SHELL
 117 If the variable
 118 .Ev SHELL
 119 exists, the shell forked by
 120 .Nm
 121 will be that shell.
 122 If
 123 .Ev SHELL
 124 is not set, the Bourne shell
 125 is assumed.
 126 (Most shells set this variable automatically).
 127 .El
 128 .Sh SEE ALSO
 129 .Xr csh 1
 130 (for the
 131 .Em history
 132 mechanism).
 133 .Sh HISTORY
 134 The
 135 .Nm
 136 command appeared in
 137 .Bx 3.0 .
 138 .Sh BUGS
 139 The
 140 .Nm
 141 utility places
 142 .Sy everything
 143 in the log file, including linefeeds and backspaces.
 144 This is not what the naive user expects.
 145 .Pp
 146 It is not possible to specify a command without also naming the script file
 147 because of argument parsing compatibility issues.
 148 .Pp
 149 When running in
 150 .Fl k
 151 mode, echo cancelling is far from ideal.  The slave terminal mode is checked
 152 for ECHO mode to check when to avoid manual echo logging.  This does not
 153 work when in a raw mode where the program being run is doing manual echo.