d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
27d63c1916
freebsd-nq/usr.bin/script/script.1

154 lines
4.4 KiB
Groff
Raw Normal View History

BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.\" Copyright (c) 1980, 1990, 1993
.\" The 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 8.1 (Berkeley) 6/6/93
$Id$ -> $FreeBSD$
1999-08-28 01:08:13 +00:00
.\" $FreeBSD$
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.\"
.Dd June 6, 1993
.Dt SCRIPT 1
.Os BSD 4
.Sh NAME
.Nm script
.Nd make typescript of terminal session
.Sh SYNOPSIS
Add usage(). Use err(3) instead of local redefinition.
1997-08-08 12:24:49 +00:00
.Nm
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.Op Fl a
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
.Op Fl k
script(1) has annoyed me with it's inflexable command argument parsing since I first saw it. I finally needed to pass arguments through to the spawned command badly enough (and urgently) that I threw this together.
1997-12-29 13:31:46 +00:00
.Op Fl q
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
.Op Fl t Ar time
Adjust man page: if command is specified, file name is mandatory
1999-11-24 15:47:45 +00:00
.Op Ar file Op command ...
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.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
script(1) has annoyed me with it's inflexable command argument parsing since I first saw it. I finally needed to pass arguments through to the spawned command badly enough (and urgently) that I threw this together.
1997-12-29 13:31:46 +00:00
If the argument
.Ar command ...
is given,
.Nm
will run the specified command with an optional argument vector
instead of an interactive shell.
.Pp
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
Options:
.Bl -tag -width xxxxxxx
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.It Fl a
Append the output to
.Ar file
or
.Pa typescript ,
retaining the prior contents.
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
.It Fl k
Log keys sent to program as well as output.
script(1) has annoyed me with it's inflexable command argument parsing since I first saw it. I finally needed to pass arguments through to the spawned command badly enough (and urgently) that I threw this together.
1997-12-29 13:31:46 +00:00
.It Fl q
Run in quiet mode, omit the start and stop status messages.
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
.It Fl t Ar time
Specify time interval between flushing script output file. A value of 0
causes
.Nm
Mention default time between output flushes in manual page. PR: docs/8009 Submitted by: Stefan Eggers <seggers@semyam.dinoco.de>
1998-09-29 01:49:49 +00:00
to flush for every character I/O event. The default interval is
30 seconds.
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.El
.Pp
script(1) has annoyed me with it's inflexable command argument parsing since I first saw it. I finally needed to pass arguments through to the spawned command badly enough (and urgently) that I threw this together.
1997-12-29 13:31:46 +00:00
The script ends when the forked shell (or command) exits (a
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
.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
Add usage(). Use err(3) instead of local redefinition.
1997-08-08 12:24:49 +00:00
.Nm
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
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).
.Sh HISTORY
The
Add usage(). Use err(3) instead of local redefinition.
1997-08-08 12:24:49 +00:00
.Nm
BSD 4.4 Lite Usr.bin Sources
1994-05-27 12:33:43 +00:00
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.
script(1) has annoyed me with it's inflexable command argument parsing since I first saw it. I finally needed to pass arguments through to the spawned command badly enough (and urgently) that I threw this together.
1997-12-29 13:31:46 +00:00
.Pp
It is not possible to specify a command without also naming the script file
Fix a bunch of spelling errors. PR: 6856 Submitted by: Josh Gilliam <josh@quick.net>
1998-06-04 21:06:07 +00:00
because of argument parsing compatibility issues.
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
.Pp
When running in
.Fl k
Fix grammar error. (missing verb)
1999-12-13 23:37:56 +00:00
mode, echo cancelling is far from ideal. The slave terminal mode is checked
Rewrite script as a select loop rather than as a twin reader/write process. This allows simple logging of keys sent to a session (turned on with -k). Also allow specifying the script file flush interval.
1998-03-08 14:19:18 +00:00
for ECHO mode to check when to avoid manual echo logging. This does not
work when in a raw mode where the program being run is doing manual echo.
Reference in New Issue Copy Permalink