X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=aabd4b3c7f36ead095022c79ea1c619097deac69;hb=0c32e7c033fcfa7dbda9e0fee8b5910cdbbe6e7a;hp=dd5455096e5ace64e8919c713af87358d583b012;hpb=e5694a4dd6289d29d40e59ba3ca69bbb0cd2449d;p=bup.git diff --git a/README.md b/README.md index dd54550..aabd4b3 100644 --- a/README.md +++ b/README.md @@ -67,18 +67,18 @@ bup has a few advantages over other backup software: Reasons you might want to avoid bup ----------------------------------- - - This is a very early version. Therefore it will most probably not work - for you, but we don't know why. It is also missing some - probably-critical features. + - It's not remotely as well tested as something like tar, so it's + more likely to eat your data. It's also missing some + probably-critical features, though fewer than it used to be. - 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 + version >= 1.5.6. 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,7 @@ Reasons you might want to avoid bup Notable changes introduced by a release ======================================= + - Changes in 0.29.2 as compared to 0.29.1 - Changes in 0.29.1 as compared to 0.29 - Changes in 0.29 as compared to 0.28.1 - Changes in 0.28.1 as compared to 0.28 @@ -103,6 +104,15 @@ From source 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). @@ -144,7 +154,11 @@ From source - Run the tests: - make test + make long-check + + or if you're in a bit more of a hurry: + + make check 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 @@ -200,7 +214,9 @@ Using bup bup help restore ... - - Initialize the default BUP_DIR (~/.bup): + - Initialize the default BUP_DIR (~/.bup -- you can choose another by + either specifying `bup -d DIR ...` or setting the `BUP_DIR` + environment variable for a command): bup init @@ -251,6 +267,10 @@ Using bup 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 @@ -283,7 +303,7 @@ Using bup - Look at how little extra space your second backup used on top of the first: - du -s ~/.bup + du -s ~/.bup - Restore the first tar backup again (the ~1 is git notation for "one older than the most recent"): @@ -504,7 +524,7 @@ mailing list (see below) if you'd like to help. - bup needs better documentation. - According to a recent article about bup in Linux Weekly News + According to an article about bup in Linux Weekly News (https://lwn.net/Articles/380983/), "it's a bit short on examples and a user guide would be nice." Documentation is the sort of thing that will never be great unless someone from outside contributes it (since