From dc14611911d0d929e3ef06546fc6d82997b611a5 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Sun, 28 Jul 2019 15:04:30 +0200 Subject: [PATCH] documentation: adapt rate_limit and --progress text --- doc/btrbk.1.asciidoc | 3 ++- doc/btrbk.conf.5.asciidoc | 6 +++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/btrbk.1.asciidoc b/doc/btrbk.1.asciidoc index cae7a58..b4df40a 100644 --- a/doc/btrbk.1.asciidoc +++ b/doc/btrbk.1.asciidoc @@ -132,7 +132,8 @@ OPTIONS command line option to switch between different output formats. --progress:: - Show progress bar on send-receive operation. + Show progress bar on send-receive operation. Requires "mbuffer" + command (version >= 20180505) installed on the host running btrbk. --lockfile :: Create lockfile on startup; checks lockfile before running diff --git a/doc/btrbk.conf.5.asciidoc b/doc/btrbk.conf.5.asciidoc index ef32b1c..30cec14 100644 --- a/doc/btrbk.conf.5.asciidoc +++ b/doc/btrbk.conf.5.asciidoc @@ -305,9 +305,9 @@ backup process, leave this option disabled. *rate_limit* |no:: Limit the transfer to a maximum of '' bytes per second. A suffix of "k", "m", "g", or "t" can be added to denote kilobytes - (*1024), megabytes, and so on. Defaults to ``no''. If enabled for - remote sources, make sure that the "pv" command is available on - the source host. + (*1024), megabytes, and so on. Defaults to ``no''. Note that the + current implementation uses the "mbuffer" command for both + 'rate_limit' and 'stream_buffer' (see implications above). === System Options