Home Explore Help
Sign In
mirrors
/
borg
mirror of https://github.com/borgbackup/borg
2
0
Fork 0
Files Issues 0 Wiki
Tree: 292ff42655
Branches Tags
borg
/
docs
/
usage
/
mount.rst.inc

mount.rst.inc 2.3 KB
History Raw

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556 
  1. .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
    2. 

  2. 

  3. .. _borg_mount:
    4. 

  4. 

  5. borg mount
    6. 

  6. ----------
    7. 

  7. ::
    8. 

  8. 

  9.     usage: borg mount [-h] [--critical] [--error] [--warning] [--info] [--debug]
    10. 

  10.                       [--lock-wait N] [--show-rc] [--no-files-cache] [--umask M]
    11. 

  11.                       [--remote-path PATH] [-f] [-o OPTIONS]
    12. 

  12.                       REPOSITORY_OR_ARCHIVE MOUNTPOINT
    13. 

  13.     
    14. 

  14.     Mount archive or an entire repository as a FUSE fileystem
    15. 

  15.     
    16. 

  16.     positional arguments:
    17. 

  17.       REPOSITORY_OR_ARCHIVE
    18. 

  18.                             repository/archive to mount
    19. 

  19.       MOUNTPOINT            where to mount filesystem
    20. 

  20.     
    21. 

  21.     optional arguments:
    22. 

  22.       -h, --help            show this help message and exit
    23. 

  23.       --critical            work on log level CRITICAL
    24. 

  24.       --error               work on log level ERROR
    25. 

  25.       --warning             work on log level WARNING (default)
    26. 

  26.       --info, -v, --verbose
    27. 

  27.                             work on log level INFO
    28. 

  28.       --debug               work on log level DEBUG
    29. 

  29.       --lock-wait N         wait for the lock, but max. N seconds (default: 1).
    30. 

  30.       --show-rc             show/log the return code (rc)
    31. 

  31.       --no-files-cache      do not load/update the file metadata cache used to
    32. 

  32.                             detect unchanged files
    33. 

  33.       --umask M             set umask to M (local and remote, default: 0077)
    34. 

  34.       --remote-path PATH    set remote path to executable (default: "borg")
    35. 

  35.       -f, --foreground      stay in foreground, do not daemonize
    36. 

  36.       -o OPTIONS            Extra mount options
    37. 

  37.     
    38. 

  38. Description
    39. 

  39. ~~~~~~~~~~~
    40. 

  40. 

  41. This command mounts an archive as a FUSE filesystem. This can be useful for
    42. 

  42. browsing an archive or restoring individual files. Unless the ``--foreground``
    43. 

  43. option is given the command will run in the background until the filesystem
    44. 

  44. is ``umounted``.
    45. 

  45. 

  46. The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users
    47. 

  47. to tweak the performance. It sets the number of cached data chunks; additional
    48. 

  48. memory usage can be up to ~8 MiB times this number. The default is the number
    49. 

  49. of CPU cores.
    50. 

  50. 

  51. For mount options, see the fuse(8) manual page. Additional mount options
    52. 

  52. supported by borg:
    53. 

  53. 

  54. - allow_damaged_files: by default damaged files (where missing chunks were
    55. 

  55.   replaced with runs of zeros by borg check --repair) are not readable and
    56. 

  56.   return EIO (I/O error). Set this option to read such files.
    57.