Skip to content

Commit e405cfc

Browse files
eshaztridge
authored andcommitted
feat: add compress threads to man page
1 parent b78a841 commit e405cfc

2 files changed

Lines changed: 18 additions & 0 deletions

File tree

rsync.1.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -513,6 +513,7 @@ has its own detailed description later in this manpage.
513513
--compress, -z compress file data during the transfer
514514
--compress-choice=STR choose the compression algorithm (aka --zc)
515515
--compress-level=NUM explicitly set compression level (aka --zl)
516+
--compress-threads=NUM explicitly set compression threads (aka --zt)
516517
--skip-compress=LIST skip compressing files with suffix in LIST
517518
--cvs-exclude, -C auto-ignore files in the same way CVS does
518519
--filter=RULE, -f add a file-filtering RULE
@@ -2817,6 +2818,22 @@ expand it.
28172818
report something like "`Client compress: zstd (level 3)`" (along with the
28182819
checksum choice in effect).
28192820

2821+
0. `--compress-threads=NUM`, `--zt=NUM`
2822+
2823+
Set the number of threads to spawn when compressing data. Setting this
2824+
option to 1 or more will instruct the compression library to spawn 1 or
2825+
more threads for compression. Ideally, increasing the number of threads
2826+
will increase transfer speed if the transfer is CPU bound on the sender.
2827+
2828+
This option does not affect decompression.
2829+
2830+
Compression algorithms that allow threading:
2831+
2832+
- `zstd` (only when libzstd is compiled with threading support)
2833+
2834+
This option is ignored if one of the above alogithms is not selected as the
2835+
`--compression-choice` or if compression not enabled.
2836+
28202837
0. `--skip-compress=LIST`
28212838

28222839
**NOTE:** no compression method currently supports per-file compression

support/rrsync

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ long_opts = {
4646
'compare-dest': 2,
4747
'compress-choice': 1,
4848
'compress-level': 1,
49+
'compress-threads': 1,
4950
'copy-dest': 2,
5051
'copy-devices': -1,
5152
'copy-unsafe-links': 0,

0 commit comments

Comments
 (0)