borg/docs/man/borg-umount.1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

117 lines
3.0 KiB
Groff
Raw Normal View History

2017-02-05 13:22:06 +00:00
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
2024-02-20 16:12:43 +00:00
.TH "BORG-UMOUNT" 1 "2024-02-20" "" "borg backup tool"
2022-06-23 23:19:19 +00:00
.SH NAME
borg-umount \- un-mount the FUSE filesystem
2017-02-05 13:22:06 +00:00
.SH SYNOPSIS
.sp
borg [common options] umount [options] MOUNTPOINT
2017-02-05 13:22:06 +00:00
.SH DESCRIPTION
.sp
This command un\-mounts a FUSE filesystem that was mounted with \fBborg mount\fP\&.
.sp
This is a convenience wrapper that just calls the platform\-specific shell
command \- usually this is either umount or fusermount \-u.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
.SS arguments
.INDENT 0.0
.TP
.B MOUNTPOINT
mountpoint of the filesystem to umount
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
# Mounting the repository shows all archives.
# Archives are loaded lazily, expect some delay when navigating to an archive
# for the first time.
2022-06-23 23:19:19 +00:00
$ borg mount /tmp/mymountpoint
$ ls /tmp/mymountpoint
root\-2016\-02\-14 root\-2016\-02\-15
$ borg umount /tmp/mymountpoint
2022-09-10 14:03:27 +00:00
# The \(dqversions view\(dq merges all archives in the repository
# and provides a versioned view on files.
2022-06-23 23:19:19 +00:00
$ borg mount \-o versions /tmp/mymountpoint
2017-02-05 13:22:06 +00:00
$ ls \-l /tmp/mymountpoint/home/user/doc.txt/
total 24
\-rw\-rw\-r\-\- 1 user group 12357 Aug 26 21:19 doc.cda00bc9.txt
\-rw\-rw\-r\-\- 1 user group 12204 Aug 26 21:04 doc.fa760f28.txt
$ borg umount /tmp/mymountpoint
# Archive filters are supported.
2022-09-10 14:03:27 +00:00
# These are especially handy for the \(dqversions view\(dq,
# which does not support lazy processing of archives.
2023-06-11 21:10:23 +00:00
$ borg mount \-o versions \-\-match\-archives \(aqsh:*\-my\-home\(aq \-\-last 10 /tmp/mymountpoint
2019-02-24 19:40:07 +00:00
# Exclusion options are supported.
# These can speed up mounting and lower memory needs significantly.
$ borg mount /path/to/repo /tmp/mymountpoint only/that/path
2022-06-23 23:19:19 +00:00
$ borg mount \-\-exclude \(aq...\(aq /tmp/mymountpoint
2017-02-05 13:22:06 +00:00
.ft P
.fi
.UNINDENT
.UNINDENT
.SS borgfs
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ echo \(aq/mnt/backup /tmp/myrepo fuse.borgfs defaults,noauto 0 0\(aq >> /etc/fstab
$ mount /tmp/myrepo
$ ls /tmp/myrepo
root\-2016\-02\-01 root\-2016\-02\-2015
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
\fBborgfs\fP will be automatically provided if you used a distribution
2024-02-20 16:12:43 +00:00
package or \fBpip\fP to install Borg. Users of the standalone binary will have
to manually create a symlink (see \fIpyinstaller\-binary\fP).
2017-02-05 13:22:06 +00:00
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
\fIborg\-common(1)\fP, \fIborg\-mount(1)\fP
.SH AUTHOR
The Borg Collective
.\" Generated by docutils manpage writer.
.