From: Ethan Halsall <ethanhalsall11@augustana.edu>
Date: Sat, 24 Dec 2022 23:43:09 +0000 (-0600)
Subject: feat: add compress threads to man page
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=e405cfc0735d5e68393869bbaa8aa39381758890;p=thirdparty%2Frsync.git

feat: add compress threads to man page
---

diff --git a/rsync.1.md b/rsync.1.md
index 7e40e361..2b4b7508 100644
--- a/rsync.1.md
+++ b/rsync.1.md
@@ -513,6 +513,7 @@ has its own detailed description later in this manpage.
 --compress, -z           compress file data during the transfer
 --compress-choice=STR    choose the compression algorithm (aka --zc)
 --compress-level=NUM     explicitly set compression level (aka --zl)
+--compress-threads=NUM   explicitly set compression threads (aka --zt)
 --skip-compress=LIST     skip compressing files with suffix in LIST
 --cvs-exclude, -C        auto-ignore files in the same way CVS does
 --filter=RULE, -f        add a file-filtering RULE
@@ -2817,6 +2818,22 @@ expand it.
     report something like "`Client compress: zstd (level 3)`" (along with the
     checksum choice in effect).
 
+0.  `--compress-threads=NUM`, `--zt=NUM`
+
+    Set the number of threads to spawn when compressing data. Setting this 
+    option to 1 or more will instruct the compression library to spawn 1 or 
+    more threads for compression. Ideally, increasing the number of threads 
+    will increase transfer speed if the transfer is CPU bound on the sender.
+    
+    This option does not affect decompression. 
+
+    Compression algorithms that allow threading:
+
+    - `zstd` (only when libzstd is compiled with threading support)
+
+    This option is ignored if one of the above alogithms is not selected as the
+     `--compression-choice` or if compression not enabled.
+
 0.  `--skip-compress=LIST`
 
     **NOTE:** no compression method currently supports per-file compression
diff --git a/support/rrsync b/support/rrsync
index e8b0cc0d..61f1d888 100755
--- a/support/rrsync
+++ b/support/rrsync
@@ -46,6 +46,7 @@ long_opts = {
   'compare-dest': 2,
   'compress-choice': 1,
   'compress-level': 1,
+  'compress-threads': 1,
   'copy-dest': 2,
   'copy-devices': -1,
   'copy-unsafe-links': 0,