3 files changed, 438 insertions, 0 deletions

diff --git a/usr.bin/script/Makefile b/usr.bin/script/Makefile
new file mode 100644
index 000000000000..78dbe68c514a
--- /dev/null
+++ b/usr.bin/script/Makefile
@@ -0,0 +1,7 @@
+#	@(#)Makefile	8.1 (Berkeley) 6/6/93
+
+PROG=	script
+LDADD=	-lutil
+DPADD=	${LIBUTIL}
+
+.include <bsd.prog.mk>
diff --git a/usr.bin/script/script.1 b/usr.bin/script/script.1
new file mode 100644
index 000000000000..506da270a193
--- /dev/null
+++ b/usr.bin/script/script.1
@@ -0,0 +1,154 @@
+.\" 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
+.\" $FreeBSD$
+.\"
+.Dd June 6, 1993
+.Dt SCRIPT 1
+.Os
+.Sh NAME
+.Nm script
+.Nd make typescript of terminal session
+.Sh SYNOPSIS
+.Nm
+.Op Fl a
+.Op Fl k
+.Op Fl q
+.Op Fl t Ar time
+.Op Ar file Op command ...
+.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
+If the argument
+.Ar command ...
+is given,
+.Nm
+will run the specified command with an optional argument vector
+instead of an interactive shell.
+.Pp
+Options:
+.Bl -tag -width xxxxxxx
+.It Fl a
+Append the output to
+.Ar file
+or
+.Pa typescript ,
+retaining the prior contents.
+.It Fl k
+Log keys sent to program as well as output.
+.It Fl q
+Run in quiet mode, omit the start and stop status messages.
+.It Fl t Ar time
+Specify time interval between flushing script output file.  A value of 0
+causes
+.Nm
+to flush for every character I/O event.  The default interval is
+30 seconds.
+.El
+.Pp
+The script ends when the forked shell (or command) 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, not an addressable one.
+.Sh ENVIRONMENT
+The following environment variable is utilized by
+.Nm :
+.Bl -tag -width SHELL
+.It Ev SHELL
+If the variable
+.Ev SHELL
+exists, the shell forked by
+.Nm
+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
+.Nm
+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.
+.Pp
+It is not possible to specify a command without also naming the script file
+because of argument parsing compatibility issues.
+.Pp
+When running in
+.Fl k
+mode, echo cancelling is far from ideal.  The slave terminal mode is checked
+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.
diff --git a/usr.bin/script/script.c b/usr.bin/script/script.c
new file mode 100644
index 000000000000..e4663f9b4c29
--- /dev/null
+++ b/usr.bin/script/script.c
@@ -0,0 +1,277 @@
+/*
+ * Copyright (c) 1980, 1992, 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.
+ */
+
+#ifndef lint
+static const char copyright[] =
+"@(#) Copyright (c) 1980, 1992, 1993\n\
+	The Regents of the University of California.  All rights reserved.\n";
+#endif /* not lint */
+
+#ifndef lint
+#if 0
+static char sccsid[] = "@(#)script.c	8.1 (Berkeley) 6/6/93";
+#endif
+static const char rcsid[] =
+  "$FreeBSD$";
+#endif /* not lint */
+
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/stat.h>
+#include <sys/ioctl.h>
+#include <sys/time.h>
+
+#include <err.h>
+#include <errno.h>
+#include <fcntl.h>
+#include <libutil.h>
+#include <paths.h>
+#include <signal.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <termios.h>
+#include <unistd.h>
+
+FILE	*fscript;
+int	master, slave;
+int	child;
+char	*fname;
+int	qflg;
+
+struct	termios tt;
+
+void	done __P((int)) __dead2;
+void	dooutput __P((void));
+void	doshell __P((char **));
+void	fail __P((void));
+void	finish __P((void));
+static void usage __P((void));
+
+int
+main(argc, argv)
+	int argc;
+	char *argv[];
+{
+	register int cc;
+	struct termios rtt, stt;
+	struct winsize win;
+	int aflg, kflg, ch, n;
+	struct timeval tv, *tvp;
+	time_t tvec, start;
+	char obuf[BUFSIZ];
+	char ibuf[BUFSIZ];
+	fd_set rfd;
+	int flushtime = 30;
+	int lastc = 1000;
+
+	aflg = kflg = 0;
+	while ((ch = getopt(argc, argv, "aqkt:")) != -1)
+		switch(ch) {
+		case 'a':
+			aflg = 1;
+			break;
+		case 'q':
+			qflg = 1;
+			break;
+		case 'k':
+			kflg = 1;
+			break;
+		case 't':
+			flushtime = atoi(optarg);
+			if (flushtime < 0)
+				err(1, "invalid flush time %d", flushtime);
+			break;
+		case '?':
+		default:
+			usage();
+		}
+	argc -= optind;
+	argv += optind;
+
+	if (argc > 0) {
+		fname = argv[0];
+		argv++;
+		argc--;
+	} else
+		fname = "typescript";
+
+	if ((fscript = fopen(fname, aflg ? "a" : "w")) == NULL)
+		err(1, "%s", fname);
+
+	(void)tcgetattr(STDIN_FILENO, &tt);
+	(void)ioctl(STDIN_FILENO, TIOCGWINSZ, &win);
+	if (openpty(&master, &slave, NULL, &tt, &win) == -1)
+		err(1, "openpty");
+
+	if (!qflg) {
+		tvec = time(NULL);
+		(void)printf("Script started, output file is %s\n", fname);
+		(void)fprintf(fscript, "Script started on %s", ctime(&tvec));
+		fflush(fscript);
+	}
+	rtt = tt;
+	cfmakeraw(&rtt);
+	rtt.c_lflag &= ~ECHO;
+	(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &rtt);
+
+	child = fork();
+	if (child < 0) {
+		warn("fork");
+		done(1);
+	}
+	if (child == 0)
+		doshell(argv);
+
+	if (flushtime > 0)
+		tvp = &tv;
+	else
+		tvp = NULL;
+
+	start = time(0);
+	FD_ZERO(&rfd);
+	for (;;) {
+		FD_SET(master, &rfd);
+		FD_SET(STDIN_FILENO, &rfd);
+		if (flushtime > 0) {
+			tv.tv_sec = flushtime;
+			tv.tv_usec = 0;
+		}
+		n = select(master + 1, &rfd, 0, 0, tvp);
+		if (n < 0 && errno != EINTR)
+			break;
+		if (n > 0 && FD_ISSET(STDIN_FILENO, &rfd)) {
+			cc = read(STDIN_FILENO, ibuf, BUFSIZ);
+			if (cc <= 0)
+				break;
+			if (cc > 0) {
+				(void)write(master, ibuf, cc);
+				if (kflg && tcgetattr(master, &stt) >= 0 &&
+				    ((stt.c_lflag & ECHO) == 0)) {
+					(void)fwrite(ibuf, 1, cc, fscript);
+				}
+			}
+		}
+		if (n > 0 && FD_ISSET(master, &rfd)) {
+			cc = read(master, obuf, sizeof (obuf));
+			if (cc <= 0)
+				break;
+			(void)write(1, obuf, cc);
+			(void)fwrite(obuf, 1, cc, fscript);
+		}
+		tvec = time(0);
+		if (tvec - start >= flushtime) {
+			fflush(fscript);
+			start = tvec;
+		}
+	}
+	finish();
+	done(0);
+}
+
+static void
+usage()
+{
+	(void)fprintf(stderr,
+	    "usage: script [-a] [-q] [-k] [-t time] [file] [command]\n");
+	exit(1);
+}
+
+void
+finish()
+{
+	int die, e, pid;
+	union wait status;
+
+	die = e = 0;
+	while ((pid = wait3((int *)&status, WNOHANG, 0)) > 0)
+	        if (pid == child) {
+			die = 1;
+			if (WIFEXITED(status))
+				e = WEXITSTATUS(status);
+			else if (WIFSIGNALED(status))
+				e = WTERMSIG(status);
+			else /* can't happen */
+				e = 1;
+		}
+
+	if (die)
+		done(e);
+}
+
+void
+doshell(av)
+	char **av;
+{
+	char *shell;
+
+	shell = getenv("SHELL");
+	if (shell == NULL)
+		shell = _PATH_BSHELL;
+
+	(void)close(master);
+	(void)fclose(fscript);
+	login_tty(slave);
+	if (av[0]) {
+		execvp(av[0], av);
+		warn("%s", av[0]);
+	} else {
+		execl(shell, shell, "-i", NULL);
+		warn("%s", shell);
+	}
+	fail();
+}
+
+void
+fail()
+{
+	(void)kill(0, SIGTERM);
+	done(1);
+}
+
+void
+done(eno)
+	int eno;
+{
+	time_t tvec;
+
+	(void)tcsetattr(STDIN_FILENO, TCSAFLUSH, &tt);
+	tvec = time(NULL);
+	if (!qflg) {
+		(void)fprintf(fscript,"\nScript done on %s", ctime(&tvec));
+		(void)printf("\nScript done, output file is %s\n", fname);
+	}
+	(void)fclose(fscript);
+	(void)close(master);
+	exit(eno);
+}