Return to script.1 CVS log

Up to [local] / src / usr.bin / script

Annotation of src/usr.bin/script/script.1, Revision 1.3

1.3     ! aaron       1: .\"    $OpenBSD: script.1,v 1.2 1996/06/26 05:39:02 deraadt Exp $
1.1       deraadt     2: .\"    $NetBSD: script.1,v 1.3 1994/12/21 08:55:41 jtc Exp $
                      3: .\"
                      4: .\" Copyright (c) 1980, 1990, 1993
                      5: .\"    The Regents of the University of California.  All rights reserved.
                      6: .\"
                      7: .\" Redistribution and use in source and binary forms, with or without
                      8: .\" modification, are permitted provided that the following conditions
                      9: .\" are met:
                     10: .\" 1. Redistributions of source code must retain the above copyright
                     11: .\"    notice, this list of conditions and the following disclaimer.
                     12: .\" 2. Redistributions in binary form must reproduce the above copyright
                     13: .\"    notice, this list of conditions and the following disclaimer in the
                     14: .\"    documentation and/or other materials provided with the distribution.
                     15: .\" 3. All advertising materials mentioning features or use of this software
                     16: .\"    must display the following acknowledgement:
                     17: .\"    This product includes software developed by the University of
                     18: .\"    California, Berkeley and its contributors.
                     19: .\" 4. Neither the name of the University nor the names of its contributors
                     20: .\"    may be used to endorse or promote products derived from this software
                     21: .\"    without specific prior written permission.
                     22: .\"
                     23: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     24: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     25: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     26: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     27: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     28: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     29: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     30: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     31: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     32: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     33: .\" SUCH DAMAGE.
                     34: .\"
                     35: .\"    @(#)script.1    8.1 (Berkeley) 6/6/93
                     36: .\"
                     37: .Dd June 6, 1993
                     38: .Dt SCRIPT 1
                     39: .Os BSD 4
                     40: .Sh NAME
                     41: .Nm script
                     42: .Nd make typescript of terminal session
                     43: .Sh SYNOPSIS
                     44: .Nm script
                     45: .Op Fl a
                     46: .Op Ar file
                     47: .Sh DESCRIPTION
1.3     ! aaron      48: .Nm script
1.1       deraadt    49: makes a typescript of everything printed on your terminal.
                     50: It is useful for students who need a hardcopy record of an interactive
                     51: session as proof of an assignment, as the typescript file
                     52: can be printed out later with
                     53: .Xr lpr 1 .
                     54: .Pp
                     55: If the argument
                     56: .Ar file
                     57: is given,
                     58: .Nm
                     59: saves all dialogue in
                     60: .Ar file .
                     61: If no file name is given, the typescript is saved in the file
                     62: .Pa typescript  .
                     63: .Pp
                     64: Option:
                     65: .Bl -tag -width Ds
                     66: .It Fl a
                     67: Append the output to
                     68: .Ar file
                     69: or
                     70: .Pa typescript ,
                     71: retaining the prior contents.
                     72: .El
                     73: .Pp
                     74: The script ends when the forked shell exits (a
                     75: .Em control-D
                     76: to exit
                     77: the Bourne shell
                     78: .Pf ( Xr sh 1 ) ,
                     79: and
                     80: .Em exit ,
                     81: .Em logout
                     82: or
                     83: .Em control-d
                     84: (if
                     85: .Em ignoreeof
                     86: is not set) for the
                     87: C-shell,
                     88: .Xr csh 1 ) .
                     89: .Pp
                     90: Certain interactive commands, such as
                     91: .Xr vi 1 ,
                     92: create garbage in the typescript file.
1.3     ! aaron      93: .Nm script
1.1       deraadt    94: works best with commands that do not manipulate the
                     95: screen, the results are meant to emulate a hardcopy
                     96: terminal.
                     97: .Sh ENVIRONMENT
                     98: The following environment variable is utilized by
                     99: .Nm script :
                    100: .Bl -tag -width SHELL
                    101: .It Ev SHELL
                    102: If the variable
                    103: .Ev SHELL
                    104: exists, the shell forked by
                    105: .Nm script
                    106: will be that shell. If
                    107: .Ev SHELL
                    108: is not set, the Bourne shell
1.3     ! aaron     109: is assumed. (Most shells set this variable automatically.)
1.1       deraadt   110: .El
                    111: .Sh SEE ALSO
                    112: .Xr csh 1
                    113: (for the
                    114: .Em history
1.3     ! aaron     115: mechanism)
1.1       deraadt   116: .Sh HISTORY
                    117: The
                    118: .Nm script
                    119: command appeared in
                    120: .Bx 3.0 .
                    121: .Sh BUGS
1.3     ! aaron     122: .Nm script
1.1       deraadt   123: places
1.3     ! aaron     124: .Em everything
1.1       deraadt   125: in the log file, including linefeeds and backspaces.
                    126: This is not what the naive user expects.