Return to script.1 CVS log

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

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

1.14    ! schwarze    1: .\"    $OpenBSD: script.1,v 1.13 2007/05/31 19:20:15 jmc 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.
1.10      millert    15: .\" 3. Neither the name of the University nor the names of its contributors
1.1       deraadt    16: .\"    may be used to endorse or promote products derived from this software
                     17: .\"    without specific prior written permission.
                     18: .\"
                     19: .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
                     20: .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
                     21: .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
                     22: .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
                     23: .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
                     24: .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
                     25: .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
                     26: .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
                     27: .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
                     28: .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
                     29: .\" SUCH DAMAGE.
                     30: .\"
                     31: .\"    @(#)script.1    8.1 (Berkeley) 6/6/93
                     32: .\"
1.14    ! schwarze   33: .Dd $Mdocdate: May 31 2007 $
1.1       deraadt    34: .Dt SCRIPT 1
1.4       aaron      35: .Os
1.1       deraadt    36: .Sh NAME
                     37: .Nm script
                     38: .Nd make typescript of terminal session
                     39: .Sh SYNOPSIS
                     40: .Nm script
                     41: .Op Fl a
                     42: .Op Ar file
                     43: .Sh DESCRIPTION
1.4       aaron      44: .Nm
1.1       deraadt    45: makes a typescript of everything printed on your terminal.
                     46: It is useful for students who need a hardcopy record of an interactive
1.4       aaron      47: session as proof of an assignment, as the typescript file
1.1       deraadt    48: can be printed out later with
                     49: .Xr lpr 1 .
                     50: .Pp
                     51: If the argument
                     52: .Ar file
                     53: is given,
                     54: .Nm
                     55: saves all dialogue in
                     56: .Ar file .
                     57: If no file name is given, the typescript is saved in the file
1.6       aaron      58: .Pa typescript .
1.1       deraadt    59: .Pp
1.5       aaron      60: The options are as follows:
1.1       deraadt    61: .Bl -tag -width Ds
                     62: .It Fl a
                     63: Append the output to
                     64: .Ar file
                     65: or
                     66: .Pa typescript ,
                     67: retaining the prior contents.
                     68: .El
                     69: .Pp
1.5       aaron      70: The script ends when the forked shell exits (a control-D
                     71: .Pq Ql ^D
1.1       deraadt    72: to exit
                     73: the Bourne shell
                     74: .Pf ( Xr sh 1 ) ,
                     75: and
1.5       aaron      76: .Ic exit ,
                     77: .Ic logout ,
                     78: or control-D
1.1       deraadt    79: (if
1.5       aaron      80: .Va ignoreeof
1.1       deraadt    81: is not set) for the
                     82: C-shell,
                     83: .Xr csh 1 ) .
1.7       ericj      84: .Nm
1.8       aaron      85: will exit with the status of 0 unless any of its child
1.12      jmc        86: processes fail.
                     87: In which case,
1.8       aaron      88: .Nm
1.7       ericj      89: will return 1.
1.1       deraadt    90: .Pp
                     91: Certain interactive commands, such as
                     92: .Xr vi 1 ,
                     93: create garbage in the typescript file.
1.4       aaron      94: .Nm
1.1       deraadt    95: works best with commands that do not manipulate the
1.5       aaron      96: screen; the results are meant to emulate a hardcopy terminal.
1.1       deraadt    97: .Sh ENVIRONMENT
                     98: .Bl -tag -width SHELL
                     99: .It Ev SHELL
1.5       aaron     100: Name of the shell to be forked by
                    101: .Nm script .
                    102: If not set, the Bourne shell is assumed.
                    103: (Most shells set this variable automatically.)
1.1       deraadt   104: .El
                    105: .Sh HISTORY
1.14    ! schwarze  106: A predecessor called
        !           107: .Nm dribble
        !           108: appeared in
        !           109: .Bx 2 .
1.1       deraadt   110: The
1.4       aaron     111: .Nm
1.14    ! schwarze  112: command first appeared in
        !           113: .Bx 3 .
        !           114: .Sh AUTHORS
        !           115: .An Mark Horton .
1.1       deraadt   116: .Sh BUGS
1.4       aaron     117: .Nm
1.1       deraadt   118: places
1.3       aaron     119: .Em everything
1.1       deraadt   120: in the log file, including linefeeds and backspaces.
                    121: This is not what the naive user expects.