2017-11-25 13:38:04 +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
|
|
|
|
|
..
|
2023-06-11 21:10:23 +00:00
|
|
|
.TH "BORGFS" 1 "2023-06-11" "" "borg backup tool"
|
2022-06-23 23:19:19 +00:00
|
|
|
.SH NAME
|
|
|
|
|
borgfs \- Mount archive or an entire repository as a FUSE filesystem
|
2017-11-25 13:38:04 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.sp
|
2022-06-23 23:19:19 +00:00
|
|
|
borgfs [options] MOUNTPOINT [PATH...]
|
2017-11-25 13:38:04 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
2022-07-17 07:23:06 +00:00
|
|
|
For more information, see borg mount \-\-help.
|
2017-11-25 13:38:04 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.sp
|
|
|
|
|
See \fIborg\-common(1)\fP for common options of Borg commands.
|
|
|
|
|
.SS arguments
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B MOUNTPOINT
|
|
|
|
|
where to mount filesystem
|
|
|
|
|
.TP
|
|
|
|
|
.B PATH
|
|
|
|
|
paths to extract; patterns are supported
|
|
|
|
|
.UNINDENT
|
2022-11-26 21:23:46 +00:00
|
|
|
.SS options
|
2017-11-25 13:38:04 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-V\fP,\fB \-\-version
|
2017-11-25 13:38:04 +00:00
|
|
|
show version number and exit
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-consider\-checkpoints
|
2020-04-12 17:55:57 +00:00
|
|
|
Show checkpoint archives in the repository contents list (default: hidden).
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-f\fP,\fB \-\-foreground
|
2017-11-25 13:38:04 +00:00
|
|
|
stay in foreground, do not daemonize
|
|
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-o
|
2017-11-25 13:38:04 +00:00
|
|
|
Extra mount options
|
2021-05-11 20:33:28 +00:00
|
|
|
.TP
|
2022-06-23 23:19:19 +00:00
|
|
|
.B \-\-numeric\-ids
|
2021-05-11 20:33:28 +00:00
|
|
|
use numeric user and group identifiers from archive(s)
|
2017-11-25 13:38:04 +00:00
|
|
|
.UNINDENT
|
|
|
|
|
.SS Archive filters
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2022-10-02 13:51:17 +00:00
|
|
|
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
|
|
|
|
|
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq.
|
2017-11-25 13:38:04 +00:00
|
|
|
.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
|
2023-02-26 20:30:54 +00:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-oldest \ TIMESPAN
|
|
|
|
|
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-newest \ TIMESPAN
|
|
|
|
|
consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g. 7d or 12m.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-older \ TIMESPAN
|
|
|
|
|
consider archives older than (now \- TIMESPAN), e.g. 7d oder 12m.
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-newer \ TIMESPAN
|
|
|
|
|
consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
|
2017-11-25 13:38:04 +00:00
|
|
|
.UNINDENT
|
2023-06-11 21:10:23 +00:00
|
|
|
.SS Include/Exclude options
|
2017-11-25 13:38:04 +00:00
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2020-10-04 18:33:08 +00:00
|
|
|
.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN
|
2017-11-25 13:38:04 +00:00
|
|
|
exclude paths matching PATTERN
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-exclude\-from \ EXCLUDEFILE
|
|
|
|
|
read exclude patterns from EXCLUDEFILE, one per line
|
|
|
|
|
.TP
|
|
|
|
|
.BI \-\-pattern \ PATTERN
|
2022-02-05 16:30:40 +00:00
|
|
|
include/exclude paths matching PATTERN
|
2017-11-25 13:38:04 +00:00
|
|
|
.TP
|
|
|
|
|
.BI \-\-patterns\-from \ PATTERNFILE
|
2022-02-05 16:30:40 +00:00
|
|
|
read include/exclude patterns from PATTERNFILE, one per line
|
2017-11-25 13:38:04 +00:00
|
|
|
.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.
|
|
|
|
|
.
|
