X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=518d62ac9a3d3536e44a6964eef0804d388f72bd;hb=c2f10963fcaa6728bac8089c66d13f0961dcbf14;hp=ad320dffa125f1b3be55d3e850fd844cb2bd84df;hpb=1ac1aa05017832ee731461aa382d89d0847c582c;p=bup.git diff --git a/README.md b/README.md index ad320df..518d62a 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,9 @@ Reasons you might want to avoid bup Notable changes introduced by a release ======================================= + - Changes in 0.30 as compared to 0.29.3 + - Changes in 0.29.3 as compared to 0.29.2 + - 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 @@ -93,6 +96,14 @@ Notable changes introduced by a release - Changes in 0.27.1 as compared to 0.27 +Test status +=========== + +| branch | Debian | FreeBSD | macOS | +|--------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| master | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=master&task=macos)](https://cirrus-ci.com/github/bup/bup) | +| 0.29.x | [![Debian test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=debian)](https://cirrus-ci.com/github/bup/bup) | [![FreeBSD test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=freebsd)](https://cirrus-ci.com/github/bup/bup) | [![macOS test status](https://api.cirrus-ci.com/github/bup/bup.svg?branch=0.29.x&task=macos)](https://cirrus-ci.com/github/bup/bup) | + Getting started =============== @@ -103,6 +114,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 +164,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 @@ -152,7 +176,7 @@ 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. @@ -200,7 +224,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 @@ -246,9 +272,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 @@ -277,7 +313,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"): @@ -288,11 +324,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 - @@ -337,7 +374,7 @@ Notes on NetBSD/pkgsrc traversal code ("fts") in NetBSD's libc will interpret this as a cycle and error out, so "ls -R" and "find" will not work. - - There is no support for ACLs. If/when some entrprising person + - There is no support for ACLs. If/when some enterprising person fixes this, adjust t/compare-trees. @@ -430,16 +467,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, @@ -507,7 +534,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