summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon McVittie <smcv@debian.org>2021-02-03 09:15:31 +0000
committerSimon McVittie <smcv@debian.org>2021-10-28 12:49:16 +0100
commit1d74baa0e85170639854eff97cde13b9ed9169bf (patch)
tree70bba502499e6d5015d8862ab300766ddf859f2d
parent01de0f9a24e9082e46f975359753d20dcdaf238d (diff)
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 Gbp-Pq: Name Expand-documentation-of-psplash-pipe-to-specify-what-is-r.patch
-rw-r--r--docs/man1/bmaptool.14
1 files changed, 3 insertions, 1 deletions
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