Add readme, license and authors files

This commit is contained in:
Tor Arne Vestbø
2012-10-01 23:27:11 +02:00
parent 1be8425136
commit 34cb663656
3 changed files with 91 additions and 0 deletions

1
AUTHORS Normal file
View File

@@ -0,0 +1 @@
Tor Arne Vestbø <torarnv@gmail.com>

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
Copyright (c) 2012, Tor Arne Vestbø. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

69
README.md Normal file
View File

@@ -0,0 +1,69 @@
sparsebundlefs
================
FUSE filesystem for reading Mac OS sparse-bundle disk images.
Mac OS X v10.5 (Leopard) introduced the concept of sparse-bundle disk images, where the data is
stored as a set of small fixed-size *band* files instead of as a single monolithic file. This
allows for more effective backups of the disk image, as only the changed bands need to be
stored.
One common client of sparse-bundles is Mac OS's backup utility, *Time Machine*, which stores
the backup data within a sparse-bundle image on the chosen backup volume.
This software package implements a FUSE virtual filesystem for read-only access to the sparse-
bundle, as if it was a single monolithic image.
Installation
------------
Clone the project from GitHub:
git clone git://github.com/torarnv/sparsebundlefs.git
Or download the latest tar-ball:
curl -L https://github.com/torarnv/sparsebundlefs/tarball/master | tar xvz
Install dependencies:
- [OSXFUSE][osxfuse] on *Mac OS X*
- `apt get install libfuse-dev libfuse2 fuse-utils` on Debian-based *GNU/Linux* distros
- Or install the latest FUSE manually from [source][fuse]
Compile:
make
**Note:** If your FUSE installation is in a non-default location you may have to
export `PKG_CONFIG_PATH` before compiling.
Usage
-----
To mount a `.sparsebundle` disk image, execute the following command:
sparsebundlefs [-o options] sparsebundle mountpoint
For example:
sparsebundlefs ~/MyDiskImage.sparsebundle /tmp/my-disk-image
This will give you a directory at the mount point with a single `sparsebundle.dmg` file.
You may then proceed to mount the `.dmg` file using regular means, *eg.*:
mount -o loop -t hfsplus /tmp/my-disk-image/sparsebundle.dmg /mnt/my-disk
This will give you read-only access to the content of the sparse-bundle disk image.
License
-------
This software is licensed under the [BSD two-clause "simplified" license][bsd].
[osxfuse]: http://osxfuse.github.com/ "Fuse for OSX"
[fuse]: http://fuse.sourceforge.net/ "FUSE"
[bsd]: http://opensource.org/licenses/BSD-2-Clause "BSD two-clause license"