misc-utils/script.1

   1 .\" Copyright (c) 1980, 1990 Regents of the University of California.
   2 .\" 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    6.5 (Berkeley) 7/27/91
  33 .\"
  34 .Dd July 30, 2000
  35 .Dt SCRIPT 1
  36 .Os Linux
  37 .Sh NAME
  38 .Nm script
  39 .Nd make typescript of terminal session
  40 .Sh SYNOPSIS
  41 .Nm script
  42 .Op Fl a
  43 .Op Fl f
  44 .Op Fl q
  45 .Op Ar file
  46 .Sh DESCRIPTION
  47 .Nm Script
  48 makes a typescript of everything printed on your terminal.
  49 It is useful for students who need a hardcopy record of an interactive
  50 session as proof of an assignment, as the typescript file
  51 can be printed out later with
  52 .Xr lpr 1 .
  53 .Pp
  54 If the argument
  55 .Ar file
  56 is given,
  57 .Nm
  58 saves all dialogue in
  59 .Ar file .
  60 If no file name is given, the typescript is saved in the file
  61 .Pa typescript  .
  62 .Pp
  63 Options:
  64 .Bl -tag -width Ds
  65 .It Fl a
  66 Append the output to
  67 .Ar file
  68 or
  69 .Pa typescript ,
  70 retaining the prior contents.
  71 .It Fl f
  72 Flush output after each write. This is nice for telecooperation:
  73 One person does `mkfifo foo; script -f foo' and another can
  74 supervise real-time what is being done using `cat foo'.
  75 .It Fl q
  76 Be quiet.
  77 .El
  78 .Pp
  79 The script ends when the forked shell exits (a
  80 .Em control-D
  81 to exit
  82 the Bourne shell
  83 .Pf ( Xr sh 1 ) ,
  84 and
  85 .Em exit ,
  86 .Em logout
  87 or
  88 .Em control-d
  89 (if
  90 .Em ignoreeof
  91 is not set) for the
  92 C-shell,
  93 .Xr csh 1 ) .
  94 .Pp
  95 Certain interactive commands, such as
  96 .Xr vi 1 ,
  97 create garbage in the typescript file.
  98 .Nm Script
  99 works best with commands that do not manipulate the
 100 screen, the results are meant to emulate a hardcopy
 101 terminal.
 102 .Sh ENVIRONMENT
 103 The following environment variable is utilized by
 104 .Nm script :
 105 .Bl -tag -width SHELL
 106 .It Ev SHELL
 107 If the variable
 108 .Ev SHELL
 109 exists, the shell forked by
 110 .Nm script
 111 will be that shell. If
 112 .Ev SHELL
 113 is not set, the Bourne shell
 114 is assumed. (Most shells set this variable automatically).
 115 .El
 116 .Sh SEE ALSO
 117 .Xr csh 1
 118 (for the
 119 .Em history
 120 mechanism).
 121 .Sh HISTORY
 122 The
 123 .Nm script
 124 command appeared in
 125 .Bx 3.0 .
 126 .Sh BUGS
 127 .Nm Script
 128 places
 129 .Sy everything
 130 in the log file, including linefeeds and backspaces.
 131 This is not what the naive user expects.