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