Update dependencies

Author: Christian Kauhaus

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "backy-extract"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["Christian Kauhaus <kc@flyingcircus.io>"]
 edition = "2018"
 description = "Rapid restore tool for backy"
@@ -19,15 +19,14 @@ env_logger = "0.7"
 fnv = "1"
 fs2 = "0.4"
 fuse = { version = "0.3", optional = true }
-indicatif = "0.11"
+indicatif = "0.13"
 lazy_static = "1.2"
 libc = "0.2"
 log = "0.4"
 memmap = "0.7"
 minilzo = "0.2"
 num_cpus = "1.9"
-parking_lot = "0.7"
-rand = "0.6"
+rand = "0.7"
 serde_json = "1"
 serde = { version = "1.0", features = ["derive"] }
 serde_yaml = "0.8"

Cargo.toml

@@ -1,3 +1,9 @@
+2019-12-09  Christian Kauhaus <kc@flyingcircus.io>
+
+	* Release backy-extract 0.3.1
+	* Improve documentation
+	* Update dependencies
+
 2019-12-07  Christian Kauhaus <kc@flyingcircus.io>
 
 	* Release backy-extract 0.3.0

ChangeLog

@@ -1,6 +1,3 @@
-# Set if your compiler cannot find liblzo2
-# LIBRARY_PATH = /path/to/liblzo2
-
 DESTDIR := dist
 
 all: release
@@ -9,20 +6,18 @@ release: target/release/backy-extract target/release/backy-fuse
 
 target/release/backy-%: Cargo.toml src/*.rs src/*/*.rs
 	cargo build --release --features fuse_driver
-	strip $@
 
 VERSION := $(shell cargo read-manifest | jq .version -r)
 PV = backy-extract-$(VERSION)
 
 dist: release
 	install -D target/release/backy-extract -t tmp/$(PV)/bin
 	install -D target/release/backy-fuse -t tmp/$(PV)/bin
-	install -D -m 0644 README.md -t tmp/$(PV)/share/doc
-	mkdir -p tmp/$(PV)/share/man/man1
+	install -D -m 0644 README.md ChangeLog -t tmp/$(PV)/share/doc
+	install -d tmp/$(PV)/share/man/man1 dist
 	cd man && for f in *.1.rst; do \
 	  rst2man $$f | sed s"/@version@/$(VERSION)/" > ../tmp/$(PV)/share/man/man1/$${f%%.rst}; \
 	done
-	mkdir -p dist
 	tar czf dist/$(PV).tar.gz -C tmp $(PV)
 	rm -r tmp
 

Makefile

@@ -35,21 +35,54 @@ Compiling
 In general, `cargo build --release` should do the right thing. This application
 depends on [liblzo2](http://www.oberhumer.com/opensource/lzo/) being availabe.
 If you get compiler/linker errors, try compiling again with `export
-LIBRABY_PATH=/path/to/liblzo2`.
+LIBRARY_PATH=/path/to/liblzo2`.
 
 A Makefile is supplied to create a statically linked release which should run on
 virtually every Linux x86_64 system.
 
 
+FUSE driver (backy-fuse)
+========================
+
+`backy-fuse` provides access to individual revisions via FUSE (filesystem in
+userspace). This allows to mount backup images and retrieve single files.
+
+Usage
+-----
+
+1. Start `backy-fuse` to mount a backup via FUSE:
+   `backy-fuse -d /srv/backy/vm /mnt/backy-fuse`
+2. Pick a revision and create loop device:
+   `losetup -f -P --show /mnt/backy-fuse/tAGKE5rrxReggVMtoPSr7`
+3. Create loop mount:
+   `mount -oloop /dev/loop0p1 /mnt/restore`
+
+When finished, the above stops must be reversed:
+
+1. Unmount loop device:
+   `umount /mnt/restore`
+2. Unregister loop device:
+   `losetup -d /dev/loop0`
+3. Finish FUSE:
+   `fusermount -u /mnt/backy-fuse`
+
+Compiling
+---------
+
+`backy-fuse` is not compiled by default due to restricted portability. To
+compile it, run `cargo build --release --features fuse_driver`. Note that both
+liblzo2 and libfuse must be detectable by the linker.
+
+
 Hacking
--------
+=======
 
 Please create issues and submit pull requests at
 https://github.com/ckauhaus/backy-extract/.
 
 
 Author
-------
+======
 
 Contact [Christian Kauhaus](kc@flyingcircus.io) for questions, suggestions, and
 bug fixes.

README.md

@@ -104,34 +104,39 @@ Don't forget to unmount the FUSE filesystem when finished:
 
 Mount backup images::
 
-    $ backy-fuse -d /srv/backy/testvm /mnt/backy
+    $ backy-fuse -d /srv/backy/testvm /mnt/backy-fuse
 
 Select revision to restore from. In this example, we will be restoring from revision
 `tAGKE5rrxReggVMtoPSr7`.
 
 Set up loop device to access partitions inside the image::
 
-    # losetup -f -P --show /mnt/backy/tAGKE5rrxReggVMtoPSr7
-    /dev/loop1
+    # losetup -f -P --show /mnt/backy-fuse/tAGKE5rrxReggVMtoPSr7
+    /dev/loop0
+
+Loop mount the image::
 
-Loop mount the first partition found in the image::
+    # mount -oloop /dev/loop0p1 /mnt/restore
 
-    # mount -oloop /dev/loop1p1 /mnt/restore
+If the image does not contain a partition table, use `/dev/loop0` instead of
+`/dev/loop0p1` for example.
 
 After finishing restore operations, unmount the loop mount first::
 
     # umount /mnt/restore
 
 Then unregister the loop device::
 
-    # losetup -d /dev/loop1
+    # losetup -d /dev/loop0
 
 Finally, unmount the FUSE filesystem::
 
-    $ fusermount -u /mnt/backy
+    $ fusermount -u /mnt/backy-fuse
 
 
 SEE ALSO
 ========
 
 fuse(8), mount(8), fusermount(1)
+
+https://bitbucket.org/flyingcircus/backy

man/backy-fuse.1.rst

@@ -244,7 +244,7 @@ fn main() -> Result<()> {
     info!("Loading revisions");
     let fs = BackyFS::init(&app.basedir)?;
     println!(
-        "Mounting FUSE fileystem...\nUnmount with: fusermount -u '{}'",
+        "Mounting FUSE fileystem... unmount with: fusermount -u '{}'",
         app.mountpoint.display()
     );
     fuse::mount(

src/bin/backy-fuse.rs

@@ -102,7 +102,10 @@ type RevID = SmallString<[u8; 24]>;
 
 /// Aqcuire 'purge' lock which prevents backy from deleting chunks
 pub fn purgelock(basedir: &Path) -> Result<File, io::Error> {
-    let f = OpenOptions::new().write(true).create(false).open(basedir.join(".purge"))?;
+    let f = OpenOptions::new()
+        .write(true)
+        .create(false)
+        .open(basedir.join(".purge"))?;
     f.try_lock_exclusive()?;
     Ok(f)
 }