restore: test --sparse with zeros at 64k boundary

[bup.git] / README.md

diff --git a/README.md b/README.md
index 871f779c166772833eb4f41bffae246d86a7f1e3..ea08b6eb80265b4cf83999d9d4ed2f938edaf40f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,8 +71,10 @@ Reasons you might want to avoid bup
    for you, but we don't know why.  It is also missing some
    probably-critical features.
    
- - It requires python >= 2.5, a C compiler, and an installed git version >=
-   1.5.3.1.
+ - It requires python >= 2.5, a C compiler, and an installed git
+   version >= 1.5.3.1.  It also requires par2 if you want fsck to be
+   able to generate the information needed to recover from some types
+   of corruption.
  
  - It currently only works on Linux, MacOS X >= 10.4,
    NetBSD, Solaris, or Windows (with Cygwin).  Patches to support
@@ -100,12 +102,13 @@ From source
 
             apt-get build-dep bup
 
-   Otherwise try this (substitute python2.5-dev if you have an older
-   system):
+   Otherwise try this (substitute python2.5-dev or python2.6-dev if
+   you have an older system):
 
-            apt-get install python2.6-dev python-fuse
+            apt-get install python2.7-dev python-fuse
             apt-get install python-pyxattr python-pylibacl
             apt-get install linux-libc-dev
+            apt-get install acl attr
             apt-get install python-tornado # optional
 
    On CentOS (for CentOS 6, at least), this should be sufficient (run
@@ -134,8 +137,13 @@ From source
  
         make test
        
-    (The tests should pass.  If they don't pass for you, stop here and send
-     an email to bup-list@googlegroups.com.)
+    The tests should pass.  If they don't pass for you, stop here and
+    send an email to bup-list@googlegroups.com.  Though if there are
+    symbolic links along the current working directory path, the tests
+    may fail.  Running something like this before "make check" should
+    sidestep the problem:
+
+        cd "$(/bin/pwd)"
 
  - You can install bup via "make install", and override the default
    destination with DESTDIR and PREFIX.
@@ -159,6 +167,8 @@ Binary packages of bup are known to be built for the following OSes:
  - pkgsrc (NetBSD, Dragonfly, and others)
     http://pkgsrc.se/sysutils/bup
     http://cvsweb.netbsd.org/bsdweb.cgi/pkgsrc/sysutils/bup/
+ - Arch Linux:
+    https://www.archlinux.org/packages/?sort=&q=bup
 
 
 Using bup
@@ -210,7 +220,7 @@ Using bup
 
         bup restore -C ./dest-2 local-etc/2013-11-23-11195/etc
 
- - Make a backup on a remote server (which must already have the 'bup' command
+ - Make a backup to a remote server (which must already have the 'bup' command
    somewhere in the server's PATH (see /etc/profile, etc/environment,
    ~/.profile, or ~/.bashrc), and be accessible via ssh.
    Make sure to replace SERVERNAME with the actual hostname of your server):
@@ -350,8 +360,8 @@ python.
 
 Basically, 'bup split' reads the data on stdin (or from files specified on
 the command line), breaks it into chunks using a rolling checksum (similar to
-rsync), and saves those chunks into a new git packfile.  There is one git
-packfile per backup.
+rsync), and saves those chunks into a new git packfile.  There is at least one
+git packfile per backup.
 
 When deciding whether to write a particular chunk into the new packfile, bup
 first checks all the other packfiles that exist to see if they already have that