rzerres/dsnap-sync
1
0
Fork 0
Code Issues Pull Requests Releases 1 Activity

README.md:

Browse Source 
o wording
o update to comply with tag 0.5.5
This commit is contained in:
Ralf Zerres
2018-06-26 19:16:31 +02:00
parent c23124e7f5
commit 7793023c9d
1 changed files with 31 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@@ -1,5 +1,5 @@
<!-- dsnap-sync README.md --> <!-- dsnap-sync README.md -->
<!-- version: 0.5.2 --> <!-- version: 0.5.5 -->
# dsnap-sync # dsnap-sync
@@ -48,7 +48,6 @@ A scheduled run will take all needed parameters from config options.
`dsnap-sync` does support systemd.timer units. Please refer to related paragraph [documenting systemd](https://github.com/rzerres/dsnap-sync#systemd). `dsnap-sync` does support systemd.timer units. Please refer to related paragraph [documenting systemd](https://github.com/rzerres/dsnap-sync#systemd).
## Requirements ## Requirements
g
beside the shell itself, `dsnap-sync`relies on external tools to achieve its goal. beside the shell itself, `dsnap-sync`relies on external tools to achieve its goal.
At run-time their availability is checked. Following tools are are used: At run-time their availability is checked. Following tools are are used:
@@ -79,30 +78,42 @@ The local snapper configuration will be extended to make use
of a new template 'dsnap-sync'. of a new template 'dsnap-sync'.
The package is also available in the The package is also available in the
[AUR](https://aur.archlinux.org/packages/dsnap-sync/). <!-- [AUR](https://aur.archlinux.org/packages/dsnap-sync/). -->
## Options ## Options
Usage: dsnap-sync [options] Usage: dsnap-sync [options]
Options: Options:
-d, --description <desc> Change the snapper description. Default: "latest incremental backup" -b, --backupdir <prefix> backupdir is a relative path that will be appended to target backup-root
-c, --config <config> Specify the snapper configuration to use. Otherwise will perform for each snapper -d, --description <desc> Change the snapper description. Default: "latest incremental backup"
configuration. Can list multiple configurations within quotes, space-separated --label-finished <desc> snapper description tagging successful jobs. Default: "dsnap-sync backup"
(e.g. -c "root home"). --label-running <desc> snapper description tagging active jobs. Default: "dsnap-sync in progress"
-n, --noconfirm Do not ask for confirmation for each configuration. Will still prompt for backup --label-synced <desc> snapper description tagging last synced jobs.
directory name on first backup Default: "dsnap-sync last incremental"
-u, --uuid <UUID> Specify the UUID of the mounted BTRFS subvolume to back up to. Otherwise will prompt. --color Enable colored output messages
--UUID <UUID> If multiple mount points are found with the same UUID, will prompt user. -c, --config <config> Specify the snapper configuration to use. Otherwise will perform for each snapper
-s, --subvolid <subvlid> Specify the subvolume id of the mounted BTRFS subvolume to back up to. Defaults to 5. configuration. Can list multiple configurations within quotes, space-separated
--SUBVOLID (e.g. -c "root home").
-t, --target <target> Specify the mountpoint of the BTRFS subvolume to back up to. --config-postfix <name> Specify a postfix that will be appended to the destination snapper config name.
--TARGET <target> -n, --noconfirm Do not ask for confirmation for each configuration. Will still prompt for backup
--remote <address> Send the snapshot backup to a remote machine. The snapshot will be sent via ssh. You --batch directory name on first backup"
should specify the remote machine's hostname or ip address. The 'root' user must be --nonotify Disable graphical notification (via dbus)
permitted to login on the remote machine. --nopv Disable graphical progress output (disable pv)
--dry-run perform a trial run with no changes made. -r, --remote <address> Send the snapshot backup to a remote machine. The snapshot will be sent via ssh.
-v, --verbose Be more verbose on what's going on. You should specify the remote machine's hostname or ip address. The 'root' user
must be permitted to login on the remote machine.
-p, --port <port> The remote port.
-s, --subvolid <subvlid> Specify the subvolume id of the mounted BTRFS subvolume to back up to. Defaults to 5.
-u, --uuid <UUID> Specify the UUID of the mounted BTRFS subvolume to back up to. Otherwise will prompt."
If multiple mount points are found with the same UUID, will prompt user."
-t, --target <target> Specify the mountpoint of the BTRFS subvolume to back up to.
--remote <address> Send the snapshot backup to a remote machine. The snapshot will be sent via ssh. You
should specify the remote machine's hostname or ip address. The 'root' user must be
permitted to login on the remote machine.
--dry-run perform a trial run where no changes are made.
-v, --verbose Be more verbose on what's going on (use multiple times to be more verbose).
--version show program version
## First run ## First run
@@ -129,7 +140,6 @@ You have to confirm any further operation, or use defaults (option: noconfirm).
# dsnap-sync -c root -s 265 --noconfirm --dry-run # dsnap-sync -c root -s 265 --noconfirm --dry-run
### dsnap-sync to remote host ### dsnap-sync to remote host
`dsnap-sync` will rely on ssh access to the target host. For batch usage make sure, that your `dsnap-sync` will rely on ssh access to the target host. For batch usage make sure, that your