mount.rst.inc 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. .. _borg_mount:
  2. borg mount
  3. ----------
  4. ::
  5. usage: borg mount [-h] [-v] [--debug] [--lock-wait N] [--show-version]
  6. [--show-rc] [--no-files-cache] [--umask M]
  7. [--remote-path PATH] [-f] [-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-version show/log the borg version
  22. --show-rc show/log the return code (rc)
  23. --no-files-cache do not load/update the file metadata cache used to
  24. detect unchanged files
  25. --umask M set umask to M (local and remote, default: 0077)
  26. --remote-path PATH set remote path to executable (default: "borg")
  27. -f, --foreground stay in foreground, do not daemonize
  28. -o OPTIONS Extra mount options
  29. Description
  30. ~~~~~~~~~~~
  31. This command mounts an archive as a FUSE filesystem. This can be useful for
  32. browsing an archive or restoring individual files. Unless the ``--foreground``
  33. option is given the command will run in the background until the filesystem
  34. is ``umounted``.
  35. The command ``borgfs`` provides a wrapper for ``borg mount``. This can also be
  36. used in fstab entries:
  37. ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0``
  38. To allow a regular user to use fstab entries, add the ``user`` option:
  39. ``/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0``