[thirdparty/util-linux.git] / misc-utils / script.1

.\" 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
.\"
.Dd July 30, 2000
.Dt SCRIPT 1
.Os Linux
.Sh NAME
.Nm script
.Nd make typescript of terminal session
.Sh SYNOPSIS
.Nm script
.Op Fl a
.Op Fl f
.Op Fl q
.Op Fl t
.Op Ar file
.Sh DESCRIPTION
.Nm Script
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
Options:
.Bl -tag -width Ds
.It Fl a
Append the output to
.Ar file
or
.Pa typescript ,
retaining the prior contents.
.It Fl f
Flush output after each write. This is nice for telecooperation:
One person does `mkfifo foo; script -f foo' and another can
supervise real-time what is being done using `cat foo'.
.It Fl q
Be quiet.
.It Fl t
Output timeing data to standard error. 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
realistic typing and output delays.
.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
mechanism),
.Xr replay 1 .
.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.
Commit	Line	Data
6dbe3af9 KZ	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	.\"
66ee8158	34	.Dd July 30, 2000
6dbe3af9	35	.Dt SCRIPT 1
66ee8158	36	.Os Linux
6dbe3af9 KZ	37	.Sh NAME
	38	.Nm script
	39	.Nd make typescript of terminal session
	40	.Sh SYNOPSIS
	41	.Nm script
	42	.Op Fl a
66ee8158 KZ	43	.Op Fl f
66ee8158 KZ	44	.Op Fl q
e8f26419	45	.Op Fl t
6dbe3af9 KZ	46	.Op Ar file
	47	.Sh DESCRIPTION
	48	.Nm Script
	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
66ee8158	64	Options:
6dbe3af9 KZ	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.
66ee8158 KZ	72	.It Fl f
	73	Flush output after each write. This is nice for telecooperation:
	74	One person does `mkfifo foo; script -f foo' and another can
	75	supervise real-time what is being done using `cat foo'.
	76	.It Fl q
	77	Be quiet.
e8f26419 KZ	78	.It Fl t
	79	Output timeing data to standard error. This data contains two fields,
	80	separated by a space. The first field indicates how much time elapsed since
	81	the previous output. The second field indicates how many characters were
	82	output this time. This information can be used to replay typescripts with
	83	realistic typing and output delays.
6dbe3af9 KZ	84	.El
	85	.Pp
	86	The script ends when the forked shell exits (a
	87	.Em control-D
	88	to exit
	89	the Bourne shell
	90	.Pf ( Xr sh 1 ) ,
	91	and
	92	.Em exit ,
	93	.Em logout
	94	or
	95	.Em control-d
	96	(if
	97	.Em ignoreeof
	98	is not set) for the
	99	C-shell,
	100	.Xr csh 1 ) .
	101	.Pp
	102	Certain interactive commands, such as
	103	.Xr vi 1 ,
	104	create garbage in the typescript file.
	105	.Nm Script
	106	works best with commands that do not manipulate the
	107	screen, the results are meant to emulate a hardcopy
	108	terminal.
	109	.Sh ENVIRONMENT
	110	The following environment variable is utilized by
	111	.Nm script :
	112	.Bl -tag -width SHELL
	113	.It Ev SHELL
	114	If the variable
	115	.Ev SHELL
	116	exists, the shell forked by
	117	.Nm script
	118	will be that shell. If
	119	.Ev SHELL
	120	is not set, the Bourne shell
	121	is assumed. (Most shells set this variable automatically).
	122	.El
	123	.Sh SEE ALSO
	124	.Xr csh 1
	125	(for the
	126	.Em history
ffc43748 KZ	127	mechanism),
ffc43748 KZ	128	.Xr replay 1 .
6dbe3af9 KZ	129	.Sh HISTORY
	130	The
	131	.Nm script
	132	command appeared in
	133	.Bx 3.0 .
	134	.Sh BUGS
	135	.Nm Script
	136	places
	137	.Sy everything
	138	in the log file, including linefeeds and backspaces.
	139	This is not what the naive user expects.