From 73bc3206bce7f8aa293ade37b18a27a0b841dcf8 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Wed, 10 Aug 2011 22:37:31 +0200 Subject: script: normalize formatting of the man page Also improve the description of the --timing option, and discard a then superfluous paragraph. Signed-off-by: Benno Schulenberg --- term-utils/script.1 | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) (limited to 'term-utils/script.1') diff --git a/term-utils/script.1 b/term-utils/script.1 index f618ec3d7..5f96b9c21 100644 --- a/term-utils/script.1 +++ b/term-utils/script.1 @@ -40,16 +40,16 @@ .Sh SYNOPSIS .Nm script .Op Fl a -.Op Fl c Ar COMMAND +.Op Fl c Ar command .Op Fl e .Op Fl f .Op Fl q -.Op Fl t[=FILE] +.Op Fl t Ns Op Ns = Ns Ar file .Op Fl V .Op Fl h .Op Ar file .Sh DESCRIPTION -.Nm Script +.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 @@ -73,32 +73,31 @@ Append the output to or .Pa typescript , retaining the prior contents. -.It Fl c, Fl Fl command Ar COMMAND -Run the COMMAND rather than an interactive shell. +.It Fl c, Fl Fl command Ar command +Run the +.Ar command +rather than an interactive shell. This makes it easy for a script to capture the output of a program that behaves differently when its stdout is not a tty. .It Fl e, Fl Fl return -Return the exit code of the child process. Uses the same format as bash +Return the exit code of the child process. Uses the same format as bash termination on signal termination exit code is 128+n. .It Fl f, Fl Fl flush -Flush output after each write. This is nice for telecooperation: -One person does `mkfifo foo; script -f foo' and another can +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 Fl force -Allow default output destination, e.g. typescript file, to be -hard or symbolic link. The command will follow symbolic link. +Allow the default output destination, i.e. the typescript file, to be a +hard or symbolic link. The command will follow a symbolic link. .It Fl q, Fl Fl quiet Be quiet. -.It Fl t, Fl Fl timing[=FILE] -Output timing 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 +.It Fl t, Fl Fl timing Ns Op Ns = Ns Ar file +Output timing data to standard error, or to \fIfile\fR when given. +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. - -The timing option is able to take file path as an argument. The -file is used as output detination instead of standard error when -it is supplied. .It Fl V, Fl Fl version Output version information and exit. .It Fl h, Fl Fl help -- cgit v1.2.3-55-g7522