summaryrefslogtreecommitdiff
path: root/static/openbsd/man1/script.1
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:54:44 -0400
commita9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch)
tree9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man1/script.1
parent160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff)
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man1/script.1')
-rw-r--r--static/openbsd/man1/script.1123
1 files changed, 123 insertions, 0 deletions
diff --git a/static/openbsd/man1/script.1 b/static/openbsd/man1/script.1
new file mode 100644
index 00000000..aa8bb279
--- /dev/null
+++ b/static/openbsd/man1/script.1
@@ -0,0 +1,123 @@
+.\" $OpenBSD: script.1,v 1.20 2022/01/03 21:49:37 jmc Exp $
+.\" $NetBSD: script.1,v 1.3 1994/12/21 08:55:41 jtc Exp $
+.\"
+.\" 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. 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
+.\"
+.Dd $Mdocdate: January 3 2022 $
+.Dt SCRIPT 1
+.Os
+.Sh NAME
+.Nm script
+.Nd make typescript of terminal session
+.Sh SYNOPSIS
+.Nm script
+.Op Fl a
+.Op Fl c Ar command
+.Op Ar file
+.Sh DESCRIPTION
+.Nm
+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
+The options are as follows:
+.Bl -tag -width Ds
+.It Fl a
+Append the output to
+.Ar file
+or
+.Pa typescript ,
+retaining the prior contents.
+.It Fl c Ar command
+Run
+.Nm sh Fl c Ar command ,
+instead of an interactive shell.
+To run a command with arguments, enclose both in quotes.
+.El
+.Pp
+The script ends when the forked program exits (an
+.Ic exit ,
+.Ic logout ,
+or control-D
+.Pq Ql ^D
+will exit most interactive shells).
+.Nm
+will exit with the status of 0 unless any of its child
+processes fail, in which case,
+.Nm
+will return 1.
+.Pp
+Certain interactive commands, such as
+.Xr vi 1 ,
+create garbage in the typescript file.
+.Nm
+works best with commands that do not manipulate the
+screen; the results are meant to emulate a hardcopy terminal.
+.Sh ENVIRONMENT
+.Bl -tag -width SHELL
+.It Ev SHELL
+Name of the shell to be forked by
+.Nm script .
+If not set, the Bourne shell is assumed.
+(Most shells set this variable automatically.)
+.El
+.Sh EXAMPLES
+Start a virtual machine and log all console output to a file:
+.Bd -literal -offset indent
+$ script -c "vmctl start -c myvm" myvm.typescript
+.Ed
+.Sh HISTORY
+A predecessor called
+.Nm dribble
+appeared in
+.Bx 2 .
+The
+.Nm
+command first appeared in
+.Bx 3 .
+.Sh AUTHORS
+.An Mary Ann Horton .
+.Sh BUGS
+.Nm
+places
+.Em everything
+in the log file, including linefeeds and backspaces.
+This is not what the naive user expects.