summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLaurent Cozic <laurent@pogopixels.com>2013-10-27 12:34:05 +0800
committerLaurent Cozic <laurent@pogopixels.com>2013-10-27 12:34:05 +0800
commita3cdd8640aae3a75fb26a4ca325c1fc2be361286 (patch)
treef8321dc4005a58b8260740a22ee7c99c611cda20 /README.md
parent405bdd9dc2089710ba7e90ef9ad5a93e698485e7 (diff)
Readme tweaks
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 13 insertions, 15 deletions
diff --git a/README.md b/README.md
index 60fc081..b28a9c7 100644
--- a/README.md
+++ b/README.md
@@ -4,27 +4,25 @@ Time Machine style backup with rsync. Should work on Linux, Mac OS X and Windows
# Installation
- git clone https://github.com/laurent22/rsync-time-backup
-
-or download "rsync_tmbackup.sh".
+ git clone https://github.com/laurent22/rsync-time-backup
# Usage
- rsync_tmbackup.sh <source> <destination> [excluded-pattern-path]
+ rsync_tmbackup.sh <source> <destination> [excluded-pattern-path]
## Examples
-
- # Backup the home folder to backup_drive
-
- rsync_tmbackup.sh /home /mnt/backup_drive
-
- # Backup with exclusion list:
-
- $ rsync_tmbackup.sh /home /mnt/backup_drive excluded_patterns.txt
-
+
+ # Backup the home folder to backup_drive
+
+ $ rsync_tmbackup.sh /home /mnt/backup_drive
+
+ # Backup with exclusion list:
+
+ $ rsync_tmbackup.sh /home /mnt/backup_drive excluded_patterns.txt
+
## 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 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.
# Features
@@ -36,7 +34,7 @@ An optional exclude file can be provided as a third parameter. It should be comp
* Resume feature - if a backup has failed or was interrupted, the tool will resume from there on the next backup.
-* Exclude file - support for pattern-based exclusion via rsync --exclude-from parameter.
+* Exclude file - support for pattern-based exclusion via the `--exclude-from` rsync parameter.
* The application is one bash script that can be easily edited.