Improve "obnam mount" documentation

2 files changed, 37 insertions, 1 deletions

diff --git a/obnam.1.in b/obnam.1.in
index d03340d9..70170e95 100644
--- a/obnam.1.in
+++ b/obnam.1.in
@@ -603,6 +603,15 @@ To verify that the backup repository is OK:
 .IP
 .nf
 obnam fsck \-\-repository sftp://your.server/~/backups
+.fi
+.PP
+To view the backed up files in the backup repository using FUSE:
+.IP
+.nf
+obnam mount \-\-to my-fuse \-\-viewmode multiple
+ls -lh my-fuse
+fusermount -u my-fuse
+.fi
 .SH "SEE ALSO"
 .TP
 .BR cliapp (5)
diff --git a/obnamlib/plugins/fuse_plugin.py b/obnamlib/plugins/fuse_plugin.py
index cd7868fb..afdf88ea 100644
--- a/obnamlib/plugins/fuse_plugin.py
+++ b/obnamlib/plugins/fuse_plugin.py
@@ -549,7 +549,34 @@ class MountPlugin(obnamlib.ObnamPlugin):
                                       metavar='FUSE', group=mount_group)
 
     def mount(self, args):
-        '''Mount a generation as a FUSE filesystem.'''
+        '''Mount a backup repository as a FUSE filesystem.
+
+        This subcommand allows you to access backups in an Obnam
+        backup repository as normal files and directories. Each
+        backed up file or directory can be viewed directly, using
+        a graphical file manager or command line tools.
+
+        Example: To mount your backup repository:
+
+        mkdir my-fuse
+        obnam mount --viewmode multiple --to my-fuse
+
+        You can then access the backup using commands such as these:
+
+        ls -l my-fuse
+        ls -l my-fuse/latest
+        diff -u my-fuse/latest/home/liw/README ~/README
+        
+        You can also restore files by copying them from the
+        my-fuse directory:
+
+        cp -a my-fuse/12765/Maildir ~/Maildir.restored
+
+        To un-mount:
+
+        fusermount -u my-fuse
+
+        '''
 
         if not hasattr(fuse, 'fuse_python_api'):
             raise obnamlib.Error('Failed to load module "fuse", '