Documentation/bup-fuse.md

   1 % bup-fuse(1) Bup %BUP_VERSION%
   2 % Avery Pennarun <apenwarr@gmail.com>
   3 % %BUP_DATE%
   4
   5 # NAME
   6
   7 bup-fuse - mount a bup repository as a filesystem
   8
   9 # SYNOPSIS
  10
  11 bup fuse [-d] [-f] [-o] \<mountpoint\>
  12
  13 # DESCRIPTION
  14
  15 `bup fuse` opens a bup repository and exports it as a
  16 `fuse`(7) userspace filesystem.
  17
  18 This feature is only available on systems (such as Linux)
  19 which support FUSE.
  20
  21 **WARNING**: bup fuse is still experimental and does not
  22 enforce any file permissions!  All files will be readable
  23 by all users.
  24
  25 When you're done accessing the mounted fuse filesystem, you
  26 should unmount it with `umount`(8).
  27
  28 # OPTIONS
  29
  30 -d, \--debug
  31 :   run in the foreground and print FUSE debug information
  32     for each request.
  33
  34 -f, \--foreground
  35 :   run in the foreground and exit only when the filesystem
  36     is unmounted.
  37
  38 -o, \--allow-other
  39 :   permit other users to access the filesystem. Necessary for
  40     exporting the filesystem via Samba, for example.
  41
  42 \--meta
  43 :   report some of the original metadata (when available) for the
  44     mounted paths (currently the uid, gid, mode, and timestamps).
  45     Without this, only generic values will be presented.  This option
  46     is not yet enabled by default because it may negatively affect
  47     performance, and note that any timestamps before 1970-01-01 UTC
  48     (i.e. before the Unix epoch) will be presented as 1970-01-01 UTC.
  49
  50 -v, \--verbose
  51 :   increase verbosity (can be used more than once).
  52
  53 # EXAMPLES
  54     rm -rf /tmp/buptest
  55     mkdir /tmp/buptest
  56     sudo bup fuse -d /tmp/buptest
  57     ls /tmp/buptest/*/latest
  58     ...
  59     umount /tmp/buptest
  60
  61 # SEE ALSO
  62
  63 `fuse`(7), `fusermount`(1), `bup-ls`(1), `bup-ftp`(1),
  64 `bup-restore`(1), `bup-web`(1)
  65
  66 # BUP
  67
  68 Part of the `bup`(1) suite.