diff --git a/doc/btrbk.conf.5.asciidoc b/doc/btrbk.conf.5.asciidoc index 960fa4f..0c2022a 100644 --- a/doc/btrbk.conf.5.asciidoc +++ b/doc/btrbk.conf.5.asciidoc @@ -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|:: {blank} -*raw_target_compress_threads* default|:: {blank} -*raw_target_split* |no:: {blank} -*raw_target_block_size* (defaults to 128K):: {blank} -*raw_target_encrypt* gpg|openssl_enc|no:: {blank} - -Additional options for "raw_target_encrypt gpg": - -*gpg_keyring* :: {blank} -*gpg_recipient* :: {blank} - -Additional options for "raw_target_encrypt openssl_enc" ('very -experimental'): - -*openssl_ciphername* (defaults to ``aes-256-cbc''):: {blank} -*openssl_iv_size* |no (depends on selected cipher):: {blank} -*openssl_keyfile* |no:: {blank} -*kdf_backend* |no:: {blank} -*kdf_keysize* (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* |no:: + Compression algorithm to use for raw backup target. Supported + '': gzip, pigz, bzip2, pbzip2, xz, lzo, lz4. +*raw_target_compress_level* default|:: + Compression level for the specified . +*raw_target_compress_threads* default|:: + Number of threads to use for . +*raw_target_split* |no:: {zwsp} + Split the raw backup file into pieces of size ''. +*raw_target_block_size* :: + 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* :: + Keyring to use for gpg, e.g. "`/etc/btrbk/gpg/pubring.kbx`". +*gpg_recipient* :: + Encrypt for user id '' (email address). + + +Additional options for "raw_target_encrypt openssl_enc" ('very +experimental'): + +*openssl_ciphername*{nbsp}:: + Defaults to ``aes-256-cbc''. +*openssl_iv_size* |no:: + Depends on selected cipher. +*openssl_keyfile* |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* |no:: + KDF backend to be executed, + e.g. "`/usr/share/btrbk/scripts/kdf_pbkdf2.py`". +*kdf_keysize* :: + Defaults to ``32''. +*kdf_keygen* once|each:: + Defaults to ``once''. --