patrick/zfs_autobackup
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Edwin Eefting
2021-08-18 10:32:41 +02:00
parent 9a902f0f38
commit ce987328d9
1 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -510,27 +510,25 @@ Look in man ssh_config for many more options.
## Usage ## Usage
(NOTE: Quite a lot has changed since the current stable version 3.0. The page your are viewing is for upcoming version 3.1 which is still in beta.)
```console ```console
usage: zfs-autobackup [-h] [--ssh-config CONFIG-FILE] [--ssh-source USER@HOST] usage: zfs-autobackup [-h] [--ssh-config CONFIG-FILE] [--ssh-source USER@HOST]
[--ssh-target USER@HOST] [--keep-source SCHEDULE] [--ssh-target USER@HOST] [--keep-source SCHEDULE]
[--keep-target SCHEDULE] [--pre-snapshot-cmd COMMAND] [--keep-target SCHEDULE] [--pre-snapshot-cmd COMMAND]
[--post-snapshot-cmd COMMAND] [--other-snapshots] [--post-snapshot-cmd COMMAND] [--other-snapshots]
[--no-snapshot] [--no-send] [--no-thinning] [--no-holds] [--no-snapshot] [--no-send] [--no-thinning] [--no-holds]
[--min-change BYTES] [--allow-empty] [--min-change BYTES] [--allow-empty] [--ignore-replicated]
[--ignore-replicated] [--strip-path N] [--strip-path N] [--clear-refreservation]
[--clear-refreservation] [--clear-mountpoint] [--clear-mountpoint] [--filter-properties PROPERTY,...]
[--filter-properties PROPERY,...] [--set-properties PROPERTY=VALUE,...] [--rollback]
[--set-properties PROPERTY=VALUE,...] [--rollback] [--destroy-incompatible] [--destroy-missing SCHEDULE]
[--destroy-incompatible] [--destroy-missing SCHEDULE] [--ignore-transfer-errors] [--decrypt] [--encrypt]
[--ignore-transfer-errors] [--decrypt] [--encrypt] [--zfs-compressed] [--test] [--verbose] [--debug]
[--test] [--verbose] [--debug] [--debug-output] [--debug-output] [--progress] [--send-pipe COMMAND]
[--progress] [--send-pipe COMMAND] [--recv-pipe COMMAND] [--recv-pipe COMMAND] [--compress TYPE] [--rate DATARATE]
[--compress TYPE] [--rate DATARATE] [--buffer SIZE] [--buffer SIZE]
backup-name [target-path] backup-name [target-path]
zfs-autobackup v3.1-beta6 - (c)2021 E.H.Eefting (edwin@datux.nl) zfs-autobackup v3.1 - (c)2021 E.H.Eefting (edwin@datux.nl)
positional arguments: positional arguments:
backup-name Name of the backup (you should set the zfs property backup-name Name of the backup (you should set the zfs property
@ -576,7 +574,6 @@ optional arguments:
--ignore-replicated Ignore datasets that seem to be replicated some other --ignore-replicated Ignore datasets that seem to be replicated some other
way. (No changes since lastest snapshot. Useful for way. (No changes since lastest snapshot. Useful for
proxmox HA replication) proxmox HA replication)
--strip-path N Number of directories to strip from target path (use 1 --strip-path N Number of directories to strip from target path (use 1
when cloning zones between 2 SmartOS machines) when cloning zones between 2 SmartOS machines)
--clear-refreservation --clear-refreservation
@ -585,7 +582,7 @@ optional arguments:
--clear-mountpoint Set property canmount=noauto for new datasets. --clear-mountpoint Set property canmount=noauto for new datasets.
(recommended, prevents mount conflicts. same as --set- (recommended, prevents mount conflicts. same as --set-
properties canmount=noauto) properties canmount=noauto)
--filter-properties PROPERY,... --filter-properties PROPERTY,...
List of properties to "filter" when receiving List of properties to "filter" when receiving
filesystems. (you can still restore them with zfs filesystems. (you can still restore them with zfs
inherit -S) inherit -S)
@ -608,6 +605,8 @@ optional arguments:
filesystem exists. useful for acltype errors) filesystem exists. useful for acltype errors)
--decrypt Decrypt data before sending it over. --decrypt Decrypt data before sending it over.
--encrypt Encrypt data after receiving it. --encrypt Encrypt data after receiving it.
--zfs-compressed Transfer blocks that already have zfs-compression as-
is.
--test dont change anything, just show what would be done --test dont change anything, just show what would be done
(still does all read-only operations) (still does all read-only operations)
--verbose verbose output --verbose verbose output
@ -621,14 +620,15 @@ optional arguments:
--recv-pipe COMMAND pipe zfs recv input through COMMAND (can be used --recv-pipe COMMAND pipe zfs recv input through COMMAND (can be used
multiple times) multiple times)
--compress TYPE Use compression during transfer, zstd-fast --compress TYPE Use compression during transfer, zstd-fast
recommended. (zstd-slow, xz, pigz-fast, lz4, pigz- recommended. (xz, pigz-slow, zstd-slow, zstd-fast,
slow, zstd-fast, gzip, lzo) lzo, gzip, pigz-fast, lz4)
--rate DATARATE Limit data transfer rate (e.g. 128K. requires --rate DATARATE Limit data transfer rate (e.g. 128K. requires
mbuffer.) mbuffer.)
--buffer SIZE Add zfs send and recv buffers to smooth out IO bursts. --buffer SIZE Add zfs send and recv buffers to smooth out IO bursts.
(e.g. 128M. requires mbuffer) (e.g. 128M. requires mbuffer)
Full manual at: https://github.com/psy0rz/zfs_autobackup Full manual at: https://github.com/psy0rz/zfs_autobackup
``` ```
## Troubleshooting ## Troubleshooting