2006-12-06 17:25:32 -06:00
|
|
|
.\" Copyright (c) 1980, 1990 Regents of the University of California.
|
|
|
|
.\" All rights reserved.
|
|
|
|
.\"
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
.\" are met:
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
|
|
.\" must display the following acknowledgement:
|
|
|
|
.\" This product includes software developed by the University of
|
|
|
|
.\" California, Berkeley and its contributors.
|
|
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
|
|
.\" may be used to endorse or promote products derived from this software
|
|
|
|
.\" without specific prior written permission.
|
|
|
|
.\"
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
.\"
|
|
|
|
.\" @(#)script.1 6.5 (Berkeley) 7/27/91
|
|
|
|
.\"
|
2011-08-23 15:10:49 -05:00
|
|
|
.Dd February 2011 " "
|
|
|
|
.Dt SCRIPT(1) "" "User Commands"
|
2011-08-18 15:18:34 -05:00
|
|
|
.Os util-linux
|
2006-12-06 17:25:32 -06:00
|
|
|
.Sh NAME
|
|
|
|
.Nm script
|
|
|
|
.Nd make typescript of terminal session
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
.Nm script
|
|
|
|
.Op Fl a
|
2011-08-10 15:37:31 -05:00
|
|
|
.Op Fl c Ar command
|
2010-04-27 05:11:31 -05:00
|
|
|
.Op Fl e
|
2006-12-06 17:25:44 -06:00
|
|
|
.Op Fl f
|
|
|
|
.Op Fl q
|
2011-08-10 15:37:31 -05:00
|
|
|
.Op Fl t Ns Op Ns = Ns Ar file
|
2011-02-20 06:21:16 -06:00
|
|
|
.Op Fl V
|
|
|
|
.Op Fl h
|
2006-12-06 17:25:32 -06:00
|
|
|
.Op Ar file
|
|
|
|
.Sh DESCRIPTION
|
2011-08-10 15:37:31 -05:00
|
|
|
.Nm script
|
2006-12-06 17:25:32 -06:00
|
|
|
makes a typescript of everything printed on your terminal.
|
|
|
|
It is useful for students who need a hardcopy record of an interactive
|
|
|
|
session as proof of an assignment, as the typescript file
|
|
|
|
can be printed out later with
|
|
|
|
.Xr lpr 1 .
|
|
|
|
.Pp
|
|
|
|
If the argument
|
|
|
|
.Ar file
|
|
|
|
is given,
|
|
|
|
.Nm
|
|
|
|
saves all dialogue in
|
|
|
|
.Ar file .
|
|
|
|
If no file name is given, the typescript is saved in the file
|
|
|
|
.Pa typescript .
|
|
|
|
.Pp
|
2006-12-06 17:25:44 -06:00
|
|
|
Options:
|
2006-12-06 17:25:32 -06:00
|
|
|
.Bl -tag -width Ds
|
2011-02-20 06:21:16 -06:00
|
|
|
.It Fl a, Fl Fl append
|
2006-12-06 17:25:32 -06:00
|
|
|
Append the output to
|
|
|
|
.Ar file
|
|
|
|
or
|
|
|
|
.Pa typescript ,
|
|
|
|
retaining the prior contents.
|
2011-08-10 15:37:31 -05:00
|
|
|
.It Fl c, Fl Fl command Ar command
|
|
|
|
Run the
|
|
|
|
.Ar command
|
|
|
|
rather than an interactive shell.
|
2006-12-06 17:26:12 -06:00
|
|
|
This makes it easy for a script to capture the output of a program that
|
|
|
|
behaves differently when its stdout is not a tty.
|
2011-02-20 06:21:16 -06:00
|
|
|
.It Fl e, Fl Fl return
|
2011-08-10 15:37:31 -05:00
|
|
|
Return the exit code of the child process. Uses the same format as bash
|
2010-04-27 05:11:31 -05:00
|
|
|
termination on signal termination exit code is 128+n.
|
2011-02-20 06:21:16 -06:00
|
|
|
.It Fl f, Fl Fl flush
|
2011-08-10 15:37:31 -05:00
|
|
|
Flush output after each write. This is nice for telecooperation:
|
|
|
|
one person does `mkfifo foo; script -f foo', and another can
|
2006-12-06 17:25:44 -06:00
|
|
|
supervise real-time what is being done using `cat foo'.
|
2011-06-28 05:43:23 -05:00
|
|
|
.It Fl Fl force
|
2011-08-10 15:37:31 -05:00
|
|
|
Allow the default output destination, i.e. the typescript file, to be a
|
|
|
|
hard or symbolic link. The command will follow a symbolic link.
|
2011-02-20 06:21:16 -06:00
|
|
|
.It Fl q, Fl Fl quiet
|
2006-12-06 17:25:44 -06:00
|
|
|
Be quiet.
|
2011-08-10 15:37:31 -05:00
|
|
|
.It Fl t, Fl Fl timing Ns Op Ns = Ns Ar file
|
|
|
|
Output timing data to standard error, or to \fIfile\fR when given.
|
|
|
|
This data contains two fields, separated by a space.
|
|
|
|
The first field indicates how much time elapsed since the previous output.
|
|
|
|
The second field indicates how many characters were output this time.
|
|
|
|
This information can be used to replay typescripts with
|
2006-12-06 17:25:49 -06:00
|
|
|
realistic typing and output delays.
|
2011-02-20 06:21:16 -06:00
|
|
|
.It Fl V, Fl Fl version
|
|
|
|
Output version information and exit.
|
|
|
|
.It Fl h, Fl Fl help
|
|
|
|
Output help and exit.
|
2006-12-06 17:25:32 -06:00
|
|
|
.El
|
|
|
|
.Pp
|
|
|
|
The script ends when the forked shell exits (a
|
|
|
|
.Em control-D
|
|
|
|
to exit
|
|
|
|
the Bourne shell
|
|
|
|
.Pf ( Xr sh 1 ) ,
|
|
|
|
and
|
|
|
|
.Em exit ,
|
|
|
|
.Em logout
|
|
|
|
or
|
|
|
|
.Em control-d
|
|
|
|
(if
|
|
|
|
.Em ignoreeof
|
|
|
|
is not set) for the
|
|
|
|
C-shell,
|
|
|
|
.Xr csh 1 ) .
|
|
|
|
.Pp
|
|
|
|
Certain interactive commands, such as
|
|
|
|
.Xr vi 1 ,
|
|
|
|
create garbage in the typescript file.
|
|
|
|
.Nm Script
|
|
|
|
works best with commands that do not manipulate the
|
|
|
|
screen, the results are meant to emulate a hardcopy
|
|
|
|
terminal.
|
|
|
|
.Sh ENVIRONMENT
|
|
|
|
The following environment variable is utilized by
|
|
|
|
.Nm script :
|
|
|
|
.Bl -tag -width SHELL
|
|
|
|
.It Ev SHELL
|
|
|
|
If the variable
|
|
|
|
.Ev SHELL
|
|
|
|
exists, the shell forked by
|
|
|
|
.Nm script
|
|
|
|
will be that shell. If
|
|
|
|
.Ev SHELL
|
|
|
|
is not set, the Bourne shell
|
|
|
|
is assumed. (Most shells set this variable automatically).
|
|
|
|
.El
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr csh 1
|
|
|
|
(for the
|
|
|
|
.Em history
|
2006-12-06 17:25:53 -06:00
|
|
|
mechanism),
|
2006-12-06 17:26:16 -06:00
|
|
|
.Xr scriptreplay 1 .
|
2006-12-06 17:25:32 -06:00
|
|
|
.Sh HISTORY
|
|
|
|
The
|
|
|
|
.Nm script
|
|
|
|
command appeared in
|
|
|
|
.Bx 3.0 .
|
|
|
|
.Sh BUGS
|
|
|
|
.Nm Script
|
|
|
|
places
|
|
|
|
.Sy everything
|
|
|
|
in the log file, including linefeeds and backspaces.
|
|
|
|
This is not what the naive user expects.
|
2007-07-02 18:17:04 -05:00
|
|
|
.Sh AVAILABILITY
|
2010-11-30 04:41:59 -06:00
|
|
|
The script command is part of the util-linux package and is available from
|
|
|
|
ftp://ftp.kernel.org/pub/linux/utils/util-linux/.
|