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