X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=47ec27a91819dc27d1d52b6355126ed3deb3e16d;hb=dc62385b6c1db1f36f3b58fa9a44ffed31d5cb3e;hp=f1c1e6ba66abaf294b5695375a70e01573818995;hpb=05cbdc409dd5e4ef1c1d32dcaf15c6baa77e865d;p=backup-script.git

diff --git a/README.md b/README.md
index f1c1e6b..47ec27a 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,25 @@
 # Backup Script
 
-A script for cloning systems using rsync.  
+A script for backing up data using `ssh`(1), `rsync`(1), and `scp`(1).
+Can handle backup generations on *btrfs* and *ZFS*.
+
 Copyright (c)2008-2016 Alexander Barton (<alex@barton.de>)  
 Homepage: https://github.com/alexbarton/backup-script
 
 
+## Installation
+
+Call the scripts located in `./bin` directly from the source folder, or run
+`make install` to install them to `/usr/local/sbin`.
+
+You can set `PREFIX` to use an other path prefix than `/usr/local` like this:
+`make PREFIX=/opt/backup-script install`.
+
 ## Usage
 
 ### backup-script
 
-Backup all or individual systems.
+Run all or individual backup jobs.
 
 Usage: `backup-script [<options>] [<job> [<job> [...]]]`
 
@@ -240,14 +250,15 @@ The following job configurations variables used by the outdated backup-pull(1)
 script in job definition files are automatically mapped to the new backup-script
 variables:
 
-* host -> system
-* source -> source_root
-* pre_exec -> job_pre_exec
-* post_exec -> job_post_exec
+* `host` -> `system`
+* `source` -> `source_root`
+* `pre_exec` -> `job_pre_exec`
+* `post_exec` -> `job_post_exec`
 
 
 ## Exit codes
 
+- 0: No error, success.
 - 1: Unspecific Error!
 - 2: Usage information has been shown.
 - 3: Can't read job definition