mount.rst.inc 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. .. _borg_mount:
  2. borg mount
  3. ----------
  4. ::
  5. usage: borg mount [-h] [-v] [--debug] [--lock-wait N] [--show-rc]
  6. [--no-files-cache] [--umask M] [--remote-path PATH] [-f]
  7. [-o OPTIONS]
  8. REPOSITORY_OR_ARCHIVE MOUNTPOINT
  9. Mount archive or an entire repository as a FUSE fileystem
  10. positional arguments:
  11. REPOSITORY_OR_ARCHIVE
  12. repository/archive to mount
  13. MOUNTPOINT where to mount filesystem
  14. optional arguments:
  15. -h, --help show this help message and exit
  16. -v, --verbose, --info
  17. enable informative (verbose) output, work on log level
  18. INFO
  19. --debug enable debug output, work on log level DEBUG
  20. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  21. --show-rc show/log the return code (rc)
  22. --no-files-cache do not load/update the file metadata cache used to
  23. detect unchanged files
  24. --umask M set umask to M (local and remote, default: 0077)
  25. --remote-path PATH set remote path to executable (default: "borg")
  26. -f, --foreground stay in foreground, do not daemonize
  27. -o OPTIONS Extra mount options
  28. Description
  29. ~~~~~~~~~~~
  30. This command mounts an archive as a FUSE filesystem. This can be useful for
  31. browsing an archive or restoring individual files. Unless the ``--foreground``
  32. option is given the command will run in the background until the filesystem
  33. is ``umounted``.
  34. The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be
  35. used in fstab entries:
  36. ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0``
  37. To allow a regular user to use fstab entries, add the ``user`` option:
  38. ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0``