X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=beb7560d920a24c2db17b56ce768792b2d26e82f;hb=d926749abdfe849117bf95c721d6f1858fef1d12;hp=80d84e064724b5d638c6813bb9d76a8d1fe9d32f;hpb=396199600a07987e1bcf2746cdd8add21a13b527;p=bup.git
diff --git a/README.md b/README.md
index 80d84e0..beb7560 100644
--- a/README.md
+++ b/README.md
@@ -76,17 +76,24 @@ Reasons you might want to avoid bup
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
- other platforms are welcome.
+ - It currently only works on Linux, FreeBSD, NetBSD, OS X >= 10.4,
+ Solaris, or Windows (with Cygwin). Patches to support other
+ platforms are welcome.
- Any items in "Things that are stupid" below.
-
+
+Notable changes introduced by a release
+=======================================
+
+ - Changes in 0.28.1 as compared to 0.28
+ - Changes in 0.28 as compared to 0.27.1
+ - Changes in 0.27.1 as compared to 0.27
+
+
Getting started
===============
-
From source
-----------
@@ -102,7 +109,7 @@ From source
apt-get build-dep bup
- Otherwise try this (substitute python2.5-dev or python2.6-dev if
+ Otherwise try this (substitute python2.6-dev or python2.5-dev if
you have an older system):
apt-get install python2.7-dev python-fuse
@@ -137,8 +144,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 test" should
+ sidestep the problem:
+
+ cd "$(/bin/pwd)"
- You can install bup via "make install", and override the default
destination with DESTDIR and PREFIX.
@@ -149,6 +161,12 @@ From source
make install DESTDIR=/opt/bup PREFIX=''
+ - The Python executable that bup will use is chosen by ./configure,
+ which will search for a reasonable version unless PYTHON is set in
+ the environment, in which case, bup will use that path. You can
+ see which Python executable was chosen by looking at the
+ configure output, or examining cmd/python-cmd.sh, and you can
+ change the selection by re-running ./configure.
From binary packages
--------------------
@@ -162,6 +180,10 @@ 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
+ - Fedora:
+ https://apps.fedoraproject.org/packages/bup
Using bup
@@ -213,14 +235,14 @@ Using bup
bup restore -C ./dest-2 local-etc/2013-11-23-11195/etc
- - 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):
+ - Make a backup to a remote server which must already have the 'bup' command
+ somewhere in its 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:
- ssh SERVERNAME bup init
+ bup init -r SERVERNAME:path/to/remote-bup-dir
bup index /etc
- bup save -r SERVERNAME: -n local-etc /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
@@ -353,8 +375,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
@@ -461,22 +483,20 @@ mailing list (see below) if you'd like to help.
give the continuous-backup process a really low CPU and I/O priority so
you wouldn't even know it was running.
- - bup currently has no way to prune *old* backups.
-
- Because of the way the packfile system works, backups become "entangled"
- in weird ways and it's not actually possible to delete one pack
- (corresponding approximately to one backup) without risking screwing up
- other backups.
-
- git itself has lots of ways of optimizing this sort of thing, but its
- methods aren't really applicable here; bup packfiles are just too huge.
- We'll have to do it in a totally different way. There are lots of
- options. For now: make sure you've got lots of disk space :)
+ - bup only has experimental support for pruning old backups.
- Until we fix this, one possible workaround is to just start a new
- BUP_DIR occasionally, i.e. bup-2013-10, bup-2013-11...
+ While you should now be able to drop old saves and branches with
+ `bup rm`, and reclaim the space occupied by data that's no longer
+ needed by other backups with `bup gc`, these commands are
+ experimental, and should be handled with great care. See the
+ man pages for more information.
- - bup has never been tested on anything but Linux, MacOS, and Windows+Cygwin.
+ Unless you want to help test the new commands, one possible
+ workaround is to just start a new BUP_DIR occasionally,
+ i.e. bup-2013, bup-2014...
+
+ - bup has never been tested on anything but Linux, FreeBSD, NetBSD,
+ OS X, and Windows+Cygwin.
There's nothing that makes it *inherently* non-portable, though, so
that's mostly a matter of someone putting in some effort. (For a
@@ -499,10 +519,9 @@ mailing list (see below) if you'd like to help.
- bup has no GUI.
- Actually, that's not stupid, but you might consider it a limitation.
- There are a bunch of Linux GUI backup programs; someday I expect someone
- will adapt one of them to use bup.
-
+ Actually, that's not stupid, but you might consider it a
+ limitation. See the ["Related Projects"](https://bup.github.io/)
+ list for some possible options.
More Documentation
==================