summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFatih Üstündağ <fatih.ustundag@gmail.com>2015-09-26 01:06:18 +0300
committerFatih Üstündağ <fatih.ustundag@gmail.com>2015-09-26 01:06:18 +0300
commitdc2d5c22093df6978f2603caef7dc7f838161907 (patch)
tree89ea9103bddbcef9627a2719d82a2d2a3c5edffb
parentf3a265b07e708ce45cd7ed2d4dd4a86f0ebf39cc (diff)
parent73dce717dff39f9465d5b7275e220a4c086f6f8a (diff)
Tested at Cygwin 2.2.1 at Windows Server 2012 R2 64bit
-rw-r--r--README.md32
1 files changed, 27 insertions, 5 deletions
diff --git a/README.md b/README.md
index ba5ee89..973f8b5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# Rsync time backup
-Time Machine style backup with rsync. Should work on Linux (tested), Mac OS X (tested) and Windows with Cygwin (not tested yet but feedback would be welcome).
+Time Machine style backup with rsync. 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.
+
+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.
# Installation
@@ -22,7 +24,7 @@ Time Machine style backup with rsync. Should work on Linux (tested), Mac OS X (t
## Exclude file
-An optional exclude file can be provided as a third parameter. It should be compabible with the `--exclude-from` parameter of rsync. See [this tutorial] (https://sites.google.com/site/rsync2u/home/rsync-tutorial/the-exclude-from-option) for more information.
+An optional exclude file can be provided as a third parameter. It should be compatible with the `--exclude-from` parameter of rsync. See [this tutorial] (https://sites.google.com/site/rsync2u/home/rsync-tutorial/the-exclude-from-option) for more information.
# Features
@@ -30,7 +32,7 @@ An optional exclude file can be provided as a third parameter. It should be comp
* Files that haven't changed from one backup to the next are hard-linked to the previous backup so take very little extra space.
-* Safety check - the backup will only happen if the destination has explicitely been marked as a backup destination.
+* Safety check - the backup will only happen if the destination has explicitly been marked as a backup destination.
* Resume feature - if a backup has failed or was interrupted, the tool will resume from there on the next backup.
@@ -44,12 +46,32 @@ An optional exclude file can be provided as a third parameter. It should be comp
# TODO
+* Check source and destination file-system. If one of them is FAT, use the --modify-window rsync parameter (see `man rsync`) with a value of 1 or 2.
+
* Minor changes (see TODO comments in the source).
* Backup to remote drive?
# LICENSE
-[MIT](http://opensource.org/licenses/MIT)
+The MIT License (MIT)
+
+Copyright (c) 2013-2015 Laurent Cozic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/laurent22/rsync-time-backup/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.