mirror of
https://github.com/borgbackup/borg.git
synced 2024-12-25 09:19:31 +00:00
150 lines
4.6 KiB
Groff
150 lines
4.6 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH BORGFS 1 "2020-04-12" "" "borg backup tool"
|
|
.SH NAME
|
|
borgfs \- Mount archive or an entire repository as a FUSE filesystem
|
|
.
|
|
.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
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
borgfs [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...]
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This command mounts an archive as a FUSE filesystem. This can be useful for
|
|
browsing an archive or restoring individual files. Unless the \fB\-\-foreground\fP
|
|
option is given the command will run in the background until the filesystem
|
|
is \fBumounted\fP\&.
|
|
.sp
|
|
The command \fBborgfs\fP provides a wrapper for \fBborg mount\fP\&. This can also be
|
|
used in fstab entries:
|
|
\fB/path/to/repo /mnt/point fuse.borgfs defaults,noauto 0 0\fP
|
|
.sp
|
|
To allow a regular user to use fstab entries, add the \fBuser\fP option:
|
|
\fB/path/to/repo /mnt/point fuse.borgfs defaults,noauto,user 0 0\fP
|
|
.sp
|
|
For FUSE configuration and mount options, see the mount.fuse(8) manual page.
|
|
.sp
|
|
Additional mount options supported by borg:
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
versions: when used with a repository mount, this gives a merged, versioned
|
|
view of the files in the archives. EXPERIMENTAL, layout may change in future.
|
|
.IP \(bu 2
|
|
allow_damaged_files: by default damaged files (where missing chunks were
|
|
replaced with runs of zeros by borg check \fB\-\-repair\fP) are not readable and
|
|
return EIO (I/O error). Set this option to read such files.
|
|
.IP \(bu 2
|
|
ignore_permissions: for security reasons the "default_permissions" mount
|
|
option is internally enforced by borg. "ignore_permissions" can be given to
|
|
not enforce "default_permissions".
|
|
.UNINDENT
|
|
.sp
|
|
The BORG_MOUNT_DATA_CACHE_ENTRIES environment variable is meant for advanced users
|
|
to tweak the performance. It sets the number of cached data chunks; additional
|
|
memory usage can be up to ~8 MiB times this number. The default is the number
|
|
of CPU cores.
|
|
.sp
|
|
When the daemonized process receives a signal or crashes, it does not unmount.
|
|
Unmounting in these cases could cause an active rsync or similar process
|
|
to unintentionally delete data.
|
|
.sp
|
|
When running in the foreground ^C/SIGINT unmounts cleanly, but other
|
|
signals or crashes do not.
|
|
.SH OPTIONS
|
|
.sp
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
.SS arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B REPOSITORY_OR_ARCHIVE
|
|
repository or archive to mount
|
|
.TP
|
|
.B MOUNTPOINT
|
|
where to mount filesystem
|
|
.TP
|
|
.B PATH
|
|
paths to extract; patterns are supported
|
|
.UNINDENT
|
|
.SS optional arguments
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-V\fP,\fB \-\-version
|
|
show version number and exit
|
|
.TP
|
|
.B \-\-consider\-checkpoints
|
|
Show checkpoint archives in the repository contents list (default: hidden).
|
|
.TP
|
|
.B \-f\fP,\fB \-\-foreground
|
|
stay in foreground, do not daemonize
|
|
.TP
|
|
.B \-o
|
|
Extra mount options
|
|
.UNINDENT
|
|
.SS Archive filters
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX
|
|
only consider archive names starting with this prefix.
|
|
.TP
|
|
.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB
|
|
only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
|
|
.TP
|
|
.BI \-\-sort\-by \ KEYS
|
|
Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
|
|
.TP
|
|
.BI \-\-first \ N
|
|
consider first N archives after other filters were applied
|
|
.TP
|
|
.BI \-\-last \ N
|
|
consider last N archives after other filters were applied
|
|
.UNINDENT
|
|
.SS Exclusion options
|
|
.INDENT 0.0
|
|
.TP
|
|
.BI \-e \ PATTERN\fP,\fB \ \-\-exclude \ PATTERN
|
|
exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-exclude\-from \ EXCLUDEFILE
|
|
read exclude patterns from EXCLUDEFILE, one per line
|
|
.TP
|
|
.BI \-\-pattern \ PATTERN
|
|
experimental: include/exclude paths matching PATTERN
|
|
.TP
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
|
experimental: read include/exclude patterns from PATTERNFILE, one per line
|
|
.TP
|
|
.BI \-\-strip\-components \ NUMBER
|
|
Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIborg\-common(1)\fP
|
|
.SH AUTHOR
|
|
The Borg Collective
|
|
.\" Generated by docutils manpage writer.
|
|
.
|