diff options
Diffstat (limited to 'docs/man/borg-compression.1')
-rw-r--r-- | docs/man/borg-compression.1 | 60 |
1 files changed, 20 insertions, 40 deletions
diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 9e176f224..3347a6582 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH BORG-COMPRESSION 1 "2017-05-17" "" "borg backup tool" +.TH BORG-COMPRESSION 1 "2017-06-18" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression . @@ -32,57 +32,48 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH DESCRIPTION .sp +It is no problem to mix different compression methods in one repo, +deduplication is done on the source data chunks (not on the compressed +or encrypted data). +.sp +If some specific chunk was once compressed and stored into the repo, creating +another backup that also uses this chunk will not change the stored chunk. +So if you use different compression specs for the backups, whichever stores a +chunk first determines its compression. See also borg recreate. +.sp Compression is lz4 by default. If you want something else, you have to specify what you want. .sp Valid compression specifiers are: -.sp -none .INDENT 0.0 -.INDENT 3.5 +.TP +.B none Do not compress. -.UNINDENT -.UNINDENT -.sp -lz4 -.INDENT 0.0 -.INDENT 3.5 +.TP +.B lz4 Use lz4 compression. High speed, low compression. (default) -.UNINDENT -.UNINDENT -.sp -zlib[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B zlib[,L] Use zlib ("gz") compression. Medium speed, medium compression. If you do not explicitely give the compression level L (ranging from 0 to 9), it will use level 6. Giving level 0 (means "no compression", but still has zlib protocol overhead) is usually pointless, you better use "none" compression. -.UNINDENT -.UNINDENT -.sp -lzma[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B lzma[,L] Use lzma ("xz") compression. Low speed, high compression. If you do not explicitely give the compression level L (ranging from 0 to 9), it will use level 6. Giving levels above 6 is pointless and counterproductive because it does not compress better due to the buffer size used by borg \- but it wastes lots of CPU cycles and RAM. -.UNINDENT -.UNINDENT -.sp -auto,C[,L] -.INDENT 0.0 -.INDENT 3.5 +.TP +.B auto,C[,L] Use a built\-in heuristic to decide per chunk whether to compress or not. The heuristic tries with lz4 whether the data is compressible. For incompressible data, it will not use compression (uses "none"). For compressible data, it uses the given C[,L] compression \- with C[,L] being any valid compression specifier. .UNINDENT -.UNINDENT .sp Examples: .INDENT 0.0 @@ -99,17 +90,6 @@ borg create \-\-compression auto,lzma ... .fi .UNINDENT .UNINDENT -.sp -General remarks: -.sp -It is no problem to mix different compression methods in one repo, -deduplication is done on the source data chunks (not on the compressed -or encrypted data). -.sp -If some specific chunk was once compressed and stored into the repo, creating -another backup that also uses this chunk will not change the stored chunk. -So if you use different compression specs for the backups, whichever stores a -chunk first determines its compression. See also borg recreate. .SH AUTHOR The Borg Collective .\" Generated by docutils manpage writer. |