From 9913e2785a4c97abb9d176c2facda81b6d56e0a0 Mon Sep 17 00:00:00 2001 From: Axel Burri Date: Thu, 18 Aug 2016 15:25:40 +0200 Subject: [PATCH] documentation: add stream_compress documentation, update Changelog --- ChangeLog | 7 +++++++ btrbk.conf.example | 5 +++++ doc/btrbk.conf.5 | 23 +++++++++++++++++++++++ 3 files changed, 35 insertions(+) diff --git a/ChangeLog b/ChangeLog index a6234c5..5260ae3 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,12 @@ btrbk-current + * KNOWN BUG: for raw targets, the send stream is not decompressed if + stream_compress is set and raw_target_compress is not set. + * MIGRATION + - update ssh_filter_btrbk.sh on remote hosts if "stream_compress" + is enabled. Also add "--compress" option to ssh_filter_btrbk.sh + invocation if "stream_compress" is enabled. + * Add "stream_compress" configuration option. * Bugfix: Replace "realpath" with "readlink" in ssh_filter_btrbk.sh btrbk-0.23.3 diff --git a/btrbk.conf.example b/btrbk.conf.example index 1977f92..9cb8231 100644 --- a/btrbk.conf.example +++ b/btrbk.conf.example @@ -56,6 +56,11 @@ snapshot_dir _btrbk_snap #ssh_compression no #ssh_cipher_spec default +# Enable compression for remote btrfs send/receive operations: +#stream_compress no +#stream_compress_level default +#stream_compress_threads default + # Enable lock file support: Ensures that only one instance of btrbk # can be run at a time. #lockfile /var/lock/btrbk.lock diff --git a/doc/btrbk.conf.5 b/doc/btrbk.conf.5 index 68feabc..d0693de 100644 --- a/doc/btrbk.conf.5 +++ b/doc/btrbk.conf.5 @@ -225,6 +225,29 @@ cipher_spec" option in ssh(1) for more information. Defaults to \[lq]default\[rq] (the ciphers specified in \fIssh_config\fR). .RE .PP +\fBstream_compress\fR |no +.RS 4 +Compress the btrfs send stream before transferring it from/to remote +locations. Defaults to \[lq]no\[rq]. If enabled, make sure that + is available on the source and target +hosts. Supported \fI\fR: gzip, pigz, bzip2, pbzip2, +xz, lzo, lz4. +.RE +.PP +\fBstream_compress_level\fR default| +.RS 4 +Compression level for the specified . Refer to the +related man-page for details (usually [1..9], where 1 means fastest +compression). Defaults to \[lq]default\[rq] (the default compression +level of ). +.RE +.PP +\fBstream_compress_threads\fR default| +.RS 4 +Number of threads to use for . Only supported for +"pigz", "pbzip2" and recent versions of "xz". +.RE +.PP \fBrate_limit\fR |no .RS 4 Limit the transfer to a maximum of \fI\fR bytes per second. A