d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some examples to script.1

Browse Source 
While here:

- Split synopsis into two parts. The first explains how to record
  sessions, while the second one explains how to replay (some of)
  the recorded sessions.
- Fix the -width argument of the environment variables list.

MFC after:	1 week
This commit is contained in:
Mateusz Piotrowski 2021-01-05 16:28:32 +01:00
parent 225afb6cad
commit d41149a8e9
1 changed files with 68 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
usr.bin/script/script.1
View File

@ -36,10 +36,14 @@
.Nd make typescript of terminal session
.Sh SYNOPSIS
.Nm
.Op Fl adefkpqr
.Op Fl aefkqr
.Op Fl F Ar pipe
.Op Fl t Ar time
.Op Ar file Op Ar command ...
.Nm
.Fl p
.Op Fl deq
.Op Ar file
.Sh DESCRIPTION
The
.Nm
@ -143,7 +147,7 @@ The results are meant to emulate a hardcopy terminal, not an addressable one.
.Sh ENVIRONMENT
The following environment variables are utilized by
.Nm :
.Bl -tag -width SHELL
.Bl -tag -width SCRIPT
.It Ev SCRIPT
The
.Ev SCRIPT
@ -169,6 +173,68 @@ is not set, the Bourne shell
is assumed.
.Pq Most shells set this variable automatically .
.El
.Sh EXAMPLES
Record a simple
.Xr csh 1
session with no additional details like input, output, and timestamping:
.Bd -literal -offset indent
$ SHELL=/bin/csh script
Script started, output file is typescript
% date
Tue Jan 5 15:08:10 UTC 2021
% exit
exit
Script done, output file is typescript
.Ed
.Pp
Now, replay the session recorded in the previous example:
.Bd -literal -offset indent
$ cat ./typescript
Script started on Tue Jan 5 15:08:08 2021
% date
Tue Jan 5 15:08:10 UTC 2021
% exit
exit
Script done on Tue Jan 5 15:08:13 2021
.Ed
.Pp
Record a
.Xr csh 1
session, but this time with additional details like timestamping:
.Bd -literal -offset indent
$ SHELL=/bin/csh script -r
Script started, output file is typescript
% date
Tue Jan 5 15:17:11 UTC 2021
% exit
exit
Script done, output file is typescript
.Ed
.Pp
In order to replay a sessions recorded with the
.Fl r
flag, it is necessary to specify
.Fl p
.Po
.Xr cat 1
will not work because of all the aditional information stored in the session file
.Pc .
Also, let us use
.Fl d
to print the whole session at once:
.Bd -literal -offset indent
$ script -dp ./typescript
Script started on Tue Jan 5 15:17:09 2021
% date
Tue Jan 5 15:17:11 UTC 2021
% exit
exit
Script done on Tue Jan 5 15:17:14 2021
.Ed
.Sh SEE ALSO
.Xr csh 1
.Po