]> arthur.barton.de Git - bup.git/blobdiff - README.md
tclient: invoke bup via absolute path
[bup.git] / README.md
index beb7560d920a24c2db17b56ce768792b2d26e82f..4521e30f9c055c6fd6afdbfdc01014e8ca2ab421 100644 (file)
--- a/README.md
+++ b/README.md
@@ -71,14 +71,14 @@ 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
+ - It requires python >= 2.6, 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, FreeBSD, NetBSD, OS X >= 10.4,
-   Solaris, or Windows (with Cygwin).  Patches to support other
-   platforms are welcome.
+   Solaris, or Windows (with Cygwin, and maybe with WSL).  Patches to
+   support other platforms are welcome.
 
  - Any items in "Things that are stupid" below.
 
@@ -86,6 +86,8 @@ Reasons you might want to avoid bup
 Notable changes introduced by a release
 =======================================
 
+ - <a href="note/0.29.1-from-0.29.md">Changes in 0.29.1 as compared to 0.29</a>
+ - <a href="note/0.29-from-0.28.1.md">Changes in 0.29 as compared to 0.28.1</a>
  - <a href="note/0.28.1-from-0.28.md">Changes in 0.28.1 as compared to 0.28</a>
  - <a href="note/0.28-from-0.27.1.md">Changes in 0.28 as compared to 0.27.1</a>
  - <a href="note/0.27.1-from-0.27.md">Changes in 0.27.1 as compared to 0.27</a>
@@ -99,7 +101,16 @@ From source
 
  - Check out the bup source code using git:
  
-        git clone git://github.com/bup/bup
+        git clone https://github.com/bup/bup
+
+ - This will leave you on the master branch, which is perfect if you
+   would like to help with development, but if you'd just like to use
+   bup, please check out the latest stable release like this:
+
+        git checkout 0.29.1
+
+   You can see the latest stable release here:
+   https://github.com/bup/bup/releases.
 
  - Install the required python libraries (including the development
    libraries).
@@ -109,8 +120,8 @@ From source
 
             apt-get build-dep bup
 
-   Otherwise try this (substitute python2.6-dev or python2.5-dev if
-   you have an older system):
+   Otherwise try this (substitute python2.6-dev if you have an older
+   system):
 
             apt-get install python2.7-dev python-fuse
             apt-get install python-pyxattr python-pylibacl
@@ -150,13 +161,13 @@ From source
     may fail.  Running something like this before "make test" should
     sidestep the problem:
 
-        cd "$(/bin/pwd)"
+        cd "$(pwd -P)"
 
  - You can install bup via "make install", and override the default
    destination with DESTDIR and PREFIX.
 
    Files are normally installed to "$DESTDIR/$PREFIX" where DESTDIR is
-   empty by default, and PREFIX is set to /usr.  So if you wanted to
+   empty by default, and PREFIX is set to /usr/local.  So if you wanted to
    install bup to /opt/bup, you might do something like this:
 
         make install DESTDIR=/opt/bup PREFIX=''
@@ -244,9 +255,19 @@ Using bup
         bup index /etc
         bup save -r SERVERNAME:path/to/remote-bup-dir -n local-etc /etc
 
- - Restore a backup from a remote server.  (FAIL: unfortunately,
-   unlike "bup join", "bup restore" does not yet support remote
-   restores.  See both "bup join" and "Things that are stupid" below.)
+ - Make a remote backup to ~/.bup on SERVER:
+
+        bup index /etc
+        bup save -r SERVER: -n local-etc /etc
+
+ - See what saves are available in ~/.bup on SERVER:
+
+        bup ls -r SERVER:
+
+ - Restore the remote backup to ./dest:
+
+        bup restore -r SERVER: -C ./dest local-etc/latest/etc
+        ls -l dest/etc
 
  - Defend your backups from death rays (OK fine, more likely from the
    occasional bad disk block).  This writes parity information
@@ -286,11 +307,12 @@ Using bup
  
         GIT_DIR=~/.bup git log local-etc
        
- - Make a backup on a remote server:
+ - Save a tar archive to a remote server (without tar -z to facilitate
+   deduplication):
    
         tar -cvf - /etc | bup split -r SERVERNAME: -n local-etc -vv
  
- - Try restoring the remote backup tarball:
+ - Restore the archive:
  
         bup join -r SERVERNAME: local-etc | tar -tf -
        
@@ -428,16 +450,6 @@ Things that are stupid for now but which we'll fix later
 Help with any of these problems, or others, is very welcome.  Join the
 mailing list (see below) if you'd like to help.
 
- - 'bup restore' can't pull directly from a remote server.
-
-    So in one sense "save -r" is a dead-end right now.  Obviously you
-    can use "ssh SERVER bup restore -C ./dest..." to create a tree you
-    can transfer elsewhere via rsync/tar/whatever, but that's *lame*.
-
-    Until we fix it, you may be able to mount the remote BUP_DIR via
-    sshfs and then restore "normally", though that hasn't been
-    officially tested.
-
  - 'bup save' and 'bup restore' have immature metadata support.
  
     On the plus side, they actually do have support now, but it's new,