ambiser
/
btrbk
mirror of https://github.com/digint/btrbk
9
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

documentation: btrbk.conf.5.asciidoc: add short descriptions for target raw options

pull/204/head
Axel Burri 2017-10-09 15:05:05 +02:00
parent c4ced9d6e4
commit 43399be0db
1 changed files with 52 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
doc/btrbk.conf.5.asciidoc
View File

@ -373,30 +373,6 @@ Note that the target preserve mechanism is currently disabled for
incremental raw backups (btrbk does not delete any incremental raw
files)!
Additional options for raw targets:
*raw_target_compress* gzip|pigz|bzip2|pbzip2|xz|lzo|lz4|no:: {blank}
*raw_target_compress_level* default|<number>:: {blank}
*raw_target_compress_threads* default|<number>:: {blank}
*raw_target_split* <size>|no:: {blank}
*raw_target_block_size* <number> (defaults to 128K):: {blank}
*raw_target_encrypt* gpg|openssl_enc|no:: {blank}
Additional options for "raw_target_encrypt gpg":
*gpg_keyring* <file>:: {blank}
*gpg_recipient* <name>:: {blank}
Additional options for "raw_target_encrypt openssl_enc" ('very
experimental'):
*openssl_ciphername* <name> (defaults to ``aes-256-cbc''):: {blank}
*openssl_iv_size* <size-in-bytes>|no (depends on selected cipher):: {blank}
*openssl_keyfile* <file>|no:: {blank}
*kdf_backend* <file>|no:: {blank}
*kdf_keysize* <size> (defaults to ``32''):: {blank}
*kdf_keygen* once|each (defaults to ``once''):: {blank}
Raw backups consist of two files: the main data file containing the
btrfs send stream, and a sidecar file ".info" containing metadata:
@ -415,6 +391,58 @@ For 'incremental' backups ("incremental yes"), please note that:
* There is currently no support for rotation of incremental backups:
if 'incremental' is set, a full backup must be triggered manually
from time to time in order to be able to delete old backups.
Additional options for raw targets:
*raw_target_compress* <compress_command>|no::
Compression algorithm to use for raw backup target. Supported
'<compress_command>': gzip, pigz, bzip2, pbzip2, xz, lzo, lz4.
*raw_target_compress_level* default|<number>::
Compression level for the specified <compress_command>.
*raw_target_compress_threads* default|<number>::
Number of threads to use for <compress_command>.
*raw_target_split* <size>|no:: {zwsp}
Split the raw backup file into pieces of size '<size>'.
*raw_target_block_size* <number>::
Block size to use for writing the raw backup file. Defaults to
``128K''.
*raw_target_encrypt* gpg|openssl_enc|no::
If enabled, encrypt the target raw file using gpg or openssl_enc.
Additional options for "raw_target_encrypt gpg":
*gpg_keyring* <file>::
Keyring to use for gpg, e.g. "`/etc/btrbk/gpg/pubring.kbx`".
*gpg_recipient* <name>::
Encrypt for user id '<name>' (email address).
Additional options for "raw_target_encrypt openssl_enc" ('very
experimental'):
*openssl_ciphername*{nbsp}<name>::
Defaults to ``aes-256-cbc''.
*openssl_iv_size* <size-in-bytes>|no::
Depends on selected cipher.
*openssl_keyfile* <file>|no::
Point to a key file in hex (absolute path). Example key file
creation (256bit key):
+
------------
# dd if=/dev/urandom bs=1 count=32 \
| od -x -A n \
| tr -d "[:space:]" > /path/to/keyfile
------------
*kdf_backend* <file>|no::
KDF backend to be executed,
e.g. "`/usr/share/btrbk/scripts/kdf_pbkdf2.py`".
*kdf_keysize* <size-in-bytes>::
Defaults to ``32''.
*kdf_keygen* once|each::
Defaults to ``once''.
--