borg-umount.1 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .
  4. .nr rst2man-indent-level 0
  5. .
  6. .de1 rstReportMargin
  7. \\$1 \\n[an-margin]
  8. level \\n[rst2man-indent-level]
  9. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  10. -
  11. \\n[rst2man-indent0]
  12. \\n[rst2man-indent1]
  13. \\n[rst2man-indent2]
  14. ..
  15. .de1 INDENT
  16. .\" .rstReportMargin pre:
  17. . RS \\$1
  18. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  19. . nr rst2man-indent-level +1
  20. .\" .rstReportMargin post:
  21. ..
  22. .de UNINDENT
  23. . RE
  24. .\" indent \\n[an-margin]
  25. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  26. .nr rst2man-indent-level -1
  27. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  29. ..
  30. .TH "BORG-UMOUNT" "1" "2025-04-18" "" "borg backup tool"
  31. .SH NAME
  32. borg-umount \- un-mount the FUSE filesystem
  33. .SH SYNOPSIS
  34. .sp
  35. borg [common options] umount [options] MOUNTPOINT
  36. .SH DESCRIPTION
  37. .sp
  38. This command un\-mounts a FUSE filesystem that was mounted with \fBborg mount\fP\&.
  39. .sp
  40. This is a convenience wrapper that just calls the platform\-specific shell
  41. command \- usually this is either umount or fusermount \-u.
  42. .SH OPTIONS
  43. .sp
  44. See \fIborg\-common(1)\fP for common options of Borg commands.
  45. .SS arguments
  46. .INDENT 0.0
  47. .TP
  48. .B MOUNTPOINT
  49. mountpoint of the filesystem to umount
  50. .UNINDENT
  51. .SH EXAMPLES
  52. .INDENT 0.0
  53. .INDENT 3.5
  54. .sp
  55. .EX
  56. # Mounting the repository shows all archives.
  57. # Archives are loaded lazily, expect some delay when navigating to an archive
  58. # for the first time.
  59. $ borg mount /path/to/repo /tmp/mymountpoint
  60. $ ls /tmp/mymountpoint
  61. root\-2016\-02\-14 root\-2016\-02\-15
  62. $ borg umount /tmp/mymountpoint
  63. # Mounting a specific archive is possible as well.
  64. $ borg mount /path/to/repo::root\-2016\-02\-15 /tmp/mymountpoint
  65. $ ls /tmp/mymountpoint
  66. bin boot etc home lib lib64 lost+found media mnt opt
  67. root sbin srv tmp usr var
  68. $ borg umount /tmp/mymountpoint
  69. # The \(dqversions view\(dq merges all archives in the repository
  70. # and provides a versioned view on files.
  71. $ borg mount \-o versions /path/to/repo /tmp/mymountpoint
  72. $ ls \-l /tmp/mymountpoint/home/user/doc.txt/
  73. total 24
  74. \-rw\-rw\-r\-\- 1 user group 12357 Aug 26 21:19 doc.cda00bc9.txt
  75. \-rw\-rw\-r\-\- 1 user group 12204 Aug 26 21:04 doc.fa760f28.txt
  76. $ borg umount /tmp/mymountpoint
  77. # Archive filters are supported.
  78. # These are especially handy for the \(dqversions view\(dq,
  79. # which does not support lazy processing of archives.
  80. $ borg mount \-o versions \-\-glob\-archives \(aq*\-my\-home\(aq \-\-last 10 /path/to/repo /tmp/mymountpoint
  81. # Exclusion options are supported.
  82. # These can speed up mounting and lower memory needs significantly.
  83. $ borg mount /path/to/repo /tmp/mymountpoint only/that/path
  84. $ borg mount \-\-exclude \(aq...\(aq /path/to/repo /tmp/mymountpoint
  85. # When using BORG_REPO env var, use :: as positional argument:
  86. export BORG_REPO=/path/to/repo
  87. # Mount the whole repo:
  88. borg mount :: /tmp/mymountpoint
  89. # Mount some specific archive:
  90. borg mount ::root\-2016\-02\-15 /tmp/mymountpoint
  91. .EE
  92. .UNINDENT
  93. .UNINDENT
  94. .SS borgfs
  95. .INDENT 0.0
  96. .INDENT 3.5
  97. .sp
  98. .EX
  99. $ echo \(aq/mnt/backup /tmp/myrepo fuse.borgfs defaults,noauto 0 0\(aq >> /etc/fstab
  100. $ echo \(aq/mnt/backup::root\-2016\-02\-15 /tmp/myarchive fuse.borgfs defaults,noauto 0 0\(aq >> /etc/fstab
  101. $ mount /tmp/myrepo
  102. $ mount /tmp/myarchive
  103. $ ls /tmp/myrepo
  104. root\-2016\-02\-01 root\-2016\-02\-2015
  105. $ ls /tmp/myarchive
  106. bin boot etc home lib lib64 lost+found media mnt opt root sbin srv tmp usr var
  107. .EE
  108. .UNINDENT
  109. .UNINDENT
  110. .sp
  111. \fBNOTE:\fP
  112. .INDENT 0.0
  113. .INDENT 3.5
  114. \fBborgfs\fP will be automatically provided if you used a distribution
  115. package or \fBpip\fP to install Borg. Users of the standalone binary will have
  116. to manually create a symlink (see \fIpyinstaller\-binary\fP).
  117. .UNINDENT
  118. .UNINDENT
  119. .SH SEE ALSO
  120. .sp
  121. \fIborg\-common(1)\fP, \fIborg\-mount(1)\fP
  122. .SH AUTHOR
  123. The Borg Collective
  124. .\" Generated by docutils manpage writer.
  125. .