From: Karel Zak <kzak@redhat.com>
Date: Mon, 9 Dec 2019 15:10:02 +0000 (+0100)
Subject: script: document SIGUSR1
X-Git-Tag: v2.35-rc1~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8e0b90e012d8daa4ab39ef7505b5a47a7ce79786;p=thirdparty%2Futil-linux.git

script: document SIGUSR1

Based on pull request: https://github.com/karelzak/util-linux/pull/815

Signed-off-by: Karel Zak <kzak@redhat.com>
---

diff --git a/term-utils/script.1 b/term-utils/script.1
index 2da845fc71..82a8332982 100644
--- a/term-utils/script.1
+++ b/term-utils/script.1
@@ -103,7 +103,8 @@ the child process is always stored in type script file too.
 \fB\-f\fR, \fB\-\-flush\fR
 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'.
+being done using `cat foo'.  Note that flush has an impact on performance, it's
+possible to use SIGUSR1 to flush logs on demand.
 .TP
 \fB\-\-force\fR
 Allow the default output destination, i.e. the typescript file, to be a hard
@@ -225,6 +226,12 @@ You should also avoid use of script in command pipes, as
 .B script
 can read more input than you would expect.
 .PP
+.SH SIGNALS
+Upon receiving
+.BR SIGUSR1,
+.B script
+immediately flushes the output files.
+.PP
 .SH ENVIRONMENT
 The following environment variable is utilized by
 .BR script :