1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
|
From: Simon McVittie <smcv@debian.org>
Date: Wed, 3 Feb 2021 09:15:31 +0000
Subject: Expand documentation of --psplash-pipe to specify what is reported
Signed-off-by: Simon McVittie <smcv@debian.org>
Forwarded: https://github.com/intel/bmap-tools/pull/80
Applied-upstream: 3.7, commit:a8a8a2adfcd816d253cf203c6079ced8bbbbb4e7
---
docs/man1/bmaptool.1 | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/docs/man1/bmaptool.1 b/docs/man1/bmaptool.1
index 6d4ddc2..e6bbb2f 100644
--- a/docs/man1/bmaptool.1
+++ b/docs/man1/bmaptool.1
@@ -211,7 +211,9 @@ IMAGE matches the checksums.
.PP
\-\-psplash\-pipe PATH
.RS 2
-Write progress to a psplash pipe.
+Write periodic machine-readable progress reports to a fifo in the format
+used by \fBpsplash\fR. Each progress report consists of "PROGRESS" followed
+by a space, an integer percentage and a newline.
.RE
.RE
|