summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorx4e-jonas <83283569+x4e-jonas@users.noreply.github.com>2021-12-17 19:16:58 +0100
committerGitHub <noreply@github.com>2021-12-17 18:16:58 +0000
commitff223c9df0599af5b60adbd660a6441321db166a (patch)
treee0b2042a0fe75c2f08c90934a64e4fa09bf82149 /README.md
parent7e3618c5140f24ce3c3842b5e3efcf7012e536e0 (diff)
README: Add `--rsync-append-flags` (#242)
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 18 insertions, 14 deletions
diff --git a/README.md b/README.md
index 059509b..ea5ef1f 100644
--- a/README.md
+++ b/README.md
@@ -15,17 +15,22 @@ On macOS, it has a few disadvantages compared to Time Machine - in particular it
Usage: rsync_tmbackup.sh [OPTION]... <[USER@HOST:]SOURCE> <[USER@HOST:]DESTINATION> [exclude-pattern-file]
Options
- -p, --port SSH port.
- -h, --help Display this help message.
- --rsync-get-flags Display the default rsync flags that are used for backup.
- --rsync-set-flags Set the rsync flags that are going to be used for backup.
- --log-dir Set the log file directory. If this flag is set, generated files will
- not be managed by the script - in particular they will not be
- automatically deleted.
- --strategy Set the expiration strategy. Default: "1:1 30:7 365:30" means after one
- day, keep one backup per day. After 30 days, keep one backup every 7 days.
- After 365 days keep one backup every 30 days.
- --no-auto-expire Set option to disable automatically purging old backups when out of space.
+ -p, --port SSH port.
+ -h, --help Display this help message.
+ -i, --id_rsa Specify the private ssh key to use.
+ --rsync-get-flags Display the default rsync flags that are used for backup. If using remote
+ drive over SSH, --compress will be added.
+ --rsync-set-flags Set the rsync flags that are going to be used for backup.
+ --rsync-append-flags Append the rsync flags that are going to be used for backup.
+ --log-dir Set the log file directory. If this flag is set, generated files will
+ not be managed by the script - in particular they will not be
+ automatically deleted.
+ Default: /home/backuper/.rsync_tmbackup
+ --strategy Set the expiration strategy. Default: "1:1 30:7 365:30" means after one
+ day, keep one backup per day. After 30 days, keep one backup every 7 days.
+ After 365 days keep one backup every 30 days.
+ --no-auto-expire Disable automatically deleting backups when out of space. Instead an error
+ is logged, and the backup is aborted.
## Features
@@ -88,10 +93,9 @@ The script is designed so that only one backup operation can be active for a giv
## Rsync options
-To display the rsync options that are used for backup, run `./rsync_tmbackup.sh --rsync-get-flags`. It is also possible to add or remove options using the `--rsync-set-flags` option. For example, to exclude backing up permissions and groups:
+To display the rsync options that are used for backup, run `./rsync_tmbackup.sh --rsync-get-flags`. It is also possible to add or remove options using the `--rsync-append-flags` or `--rsync-set-flags` option. For example, to exclude backing up permissions and groups:
- rsync_tmbackup --rsync-set-flags "--numeric-ids --links --hard-links \
- --one-file-system --archive --no-perms --no-group --itemize-changes" /src /dest
+ rsync_tmbackup --rsync-append-flags "--no-perms --no-group" /src /dest
## No automatic backup expiration