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

32
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:
-b, --backupdir <prefix> backupdir is a relative path that will be appended to target backup-root
-d, --description <desc> Change the snapper description. Default: "latest incremental backup" -d, --description <desc> Change the snapper description. Default: "latest incremental backup"
--label-finished <desc> snapper description tagging successful jobs. Default: "dsnap-sync backup"
--label-running <desc> snapper description tagging active jobs. Default: "dsnap-sync in progress"
--label-synced <desc> snapper description tagging last synced jobs.
Default: "dsnap-sync last incremental"
--color Enable colored output messages
-c, --config <config> Specify the snapper configuration to use. Otherwise will perform for each snapper -c, --config <config> Specify the snapper configuration to use. Otherwise will perform for each snapper
configuration. Can list multiple configurations within quotes, space-separated configuration. Can list multiple configurations within quotes, space-separated
(e.g. -c "root home"). (e.g. -c "root home").
--config-postfix <name> Specify a postfix that will be appended to the destination snapper config name.
-n, --noconfirm Do not ask for confirmation for each configuration. Will still prompt for backup -n, --noconfirm Do not ask for confirmation for each configuration. Will still prompt for backup
directory name on first backup --batch directory name on first backup"
-u, --uuid <UUID> Specify the UUID of the mounted BTRFS subvolume to back up to. Otherwise will prompt. --nonotify Disable graphical notification (via dbus)
--UUID <UUID> If multiple mount points are found with the same UUID, will prompt user. --nopv Disable graphical progress output (disable pv)
-r, --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.
-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. -s, --subvolid <subvlid> Specify the subvolume id of the mounted BTRFS subvolume to back up to. Defaults to 5.
--SUBVOLID -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. -t, --target <target> Specify the mountpoint of the BTRFS subvolume to back up to.
--TARGET <target>
--remote <address> Send the snapshot backup to a remote machine. The snapshot will be sent via ssh. You --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 should specify the remote machine's hostname or ip address. The 'root' user must be
permitted to login on the remote machine. permitted to login on the remote machine.
--dry-run perform a trial run with no changes made. --dry-run perform a trial run where no changes are made.
-v, --verbose Be more verbose on what's going on. -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