README for Obnam, a backup program
==================================

This is Obnam, a backup system. Please see the obnam.1 manual page ("man
obnam" after installation) for instructions on how to use.

Legal stuff:

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License along
    with this program; if not, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

A copy of the GPL version 2 is included in the file COPYING.


ObnamFS: Backups as a read-only FUSE filesystem
-----------------------------------------------

In order to make browsing and restoring as pleasant as possible, backups
made with Obnam are available as a read-only filesystem, implemented
using FUSE.

To use this, make sure your system supports FUSE. Then run the 
following command:

    obnamfs MOUNTPOINT
    
where MOUNTPOINT is the location (directory) where you want your backups
to be visible. Obnamfs uses the same configuration file as plain obnam.
Those obnam command line options that are relevant for obnamfs work in
the identical way.

The virtual filesystem created this way is accessible only by the user
who ran obnamfs. That is, the root of the virtual filesystem is owned by
the user who ran obnamfs, and has 0700 permissions. All backed up files
have the same numeric owner and group, and the same permissions, as are
stored for them in the backup.

To unmount the filesystem, run the following command:

    fusermount -u MOUNTPOINT
    
where MOUNTPOINT is the same location you gave to obnamfs.

For more information about FUSE, see http://fuse.sourceforge.net/


Legalese
--------

Copyright 2007 Lars Wirzenius

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.