diff options
| author | Laurent Cozic <laurent@cozic.net> | 2017-05-02 20:14:36 +0000 |
|---|---|---|
| committer | Laurent Cozic <laurent@cozic.net> | 2017-05-02 20:14:36 +0000 |
| commit | f9205f6e20adffc595c245fb7e907caa0c13433c (patch) | |
| tree | bc952bb687eeca5d0dc2cfd2756b84fe7487b2f0 /README.md | |
| parent | 041ffb459b2e642dc42e0063cd0b15ea82548239 (diff) | |
Allow setting log file directory
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 12 insertions, 3 deletions
@@ -2,9 +2,9 @@ This script offers Time Machine-style backup using rsync. It creates incremental backups of files and directories to the destination of your choice. The backups are structured in a way that makes it easy to recover any file at any point in time. -It should work on Linux, OS X and Windows with Cygwin. The main advantage over Time Machine is the flexibility as it can backup from/to any filesystem and works on any platform. You can also backup, for example, to a Truecrypt drive without any problem. +It works on Linux, macOS and Windows (via WSL or Cygwin). The main advantage over Time Machine is the flexibility as it can backup from/to any filesystem and works on any platform. You can also backup, for example, to a Truecrypt drive without any problem. -On OS X, it has a few disadvantages compared to Time Machine - in particular it doesn't auto-start when the backup drive is plugged (though it can be achieved using a launch agent), it requires some knowledge of the command line, and no specific GUI is provided to restore files. Instead files can be restored by using any file explorer, including Finder, or the command line. +On macOS, it has a few disadvantages compared to Time Machine - in particular it does not auto-start when the backup drive is plugged (though it can be achieved using a launch agent), it requires some knowledge of the command line, and no specific GUI is provided to restore files. Instead files can be restored by using any file explorer, including Finder, or the command line. # Installation @@ -12,7 +12,16 @@ On OS X, it has a few disadvantages compared to Time Machine - in particular it # Usage - rsync_tmbackup.sh <source> <destination> [excluded-pattern-path] + Usage: rsync_tmbackup.sh [OPTION]... <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. ## Examples |