mount.rst.inc 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
  2. .. _borg_mount:
  3. borg mount
  4. ----------
  5. ::
  6. usage: borg mount [-h] [--critical] [--error] [--warning] [--info] [--debug]
  7. [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
  8. [--remote-path PATH] [-f] [-o OPTIONS]
  9. REPOSITORY_OR_ARCHIVE MOUNTPOINT
  10. Mount archive or an entire repository as a FUSE fileystem
  11. positional arguments:
  12. REPOSITORY_OR_ARCHIVE
  13. repository/archive to mount
  14. MOUNTPOINT where to mount filesystem
  15. optional arguments:
  16. -h, --help show this help message and exit
  17. --critical work on log level CRITICAL
  18. --error work on log level ERROR
  19. --warning work on log level WARNING (default)
  20. --info, -v, --verbose
  21. work on log level INFO
  22. --debug work on log level DEBUG
  23. --lock-wait N wait for the lock, but max. N seconds (default: 1).
  24. --show-rc show/log the return code (rc)
  25. --no-files-cache do not load/update the file metadata cache used to
  26. detect unchanged files
  27. --umask M set umask to M (local and remote, default: 0077)
  28. --remote-path PATH set remote path to executable (default: "borg")
  29. -f, --foreground stay in foreground, do not daemonize
  30. -o OPTIONS Extra mount options
  31. Description
  32. ~~~~~~~~~~~
  33. This command mounts an archive as a FUSE filesystem. This can be useful for
  34. browsing an archive or restoring individual files. Unless the ``--foreground``
  35. option is given the command will run in the background until the filesystem
  36. is ``umounted``.
  37. For mount options, see the fuse(8) manual page. Additional mount options
  38. supported by borg:
  39. - allow_damaged_files: by default damaged files (where missing chunks were
  40. replaced with runs of zeros by borg check --repair) are not readable and
  41. return EIO (I/O error). Set this option to read such files.