mirror of
https://github.com/borgbackup/borg.git
synced 2026-03-29 13:54:47 -04:00
117 lines
3.4 KiB
Groff
117 lines
3.4 KiB
Groff
.\" Man page generated from reStructuredText
|
||
.\" by the Docutils 0.22.4 manpage writer.
|
||
.
|
||
.
|
||
.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
|
||
..
|
||
.TH "borgfs" "1" "2026-03-15" "" "borg backup tool"
|
||
.SH Name
|
||
borgfs \- Mounts an archive or an entire repository as a FUSE filesystem.
|
||
.SH SYNOPSIS
|
||
.sp
|
||
borgfs [options] MOUNTPOINT [PATH...]
|
||
.SH DESCRIPTION
|
||
.sp
|
||
For more information, see borg mount \-\-help.
|
||
.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 the filesystem
|
||
.TP
|
||
.B PATH
|
||
paths to extract; patterns are supported
|
||
.UNINDENT
|
||
.SS options
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-\-config
|
||
Path to a configuration file.
|
||
.UNINDENT
|
||
.IP "System Message: WARNING/2 (docs/borgfs.rst:, line 51)"
|
||
Option list ends without a blank line; unexpected unindent.
|
||
.sp
|
||
\-\-print_config [=flags] Print the configuration after applying all other arguments and exit. The optional flags customizes the output and are one or more keywords separated by comma. The supported flags are: skip_default, skip_null.
|
||
\-V, \-\-version show version number and exit
|
||
\-\-cockpit Start the Borg TUI
|
||
\-f, \-\-foreground stay in foreground, do not daemonize
|
||
\-o extra mount options
|
||
\-\-numeric\-ids use numeric user and group identifiers from archives
|
||
.SS Archive filters
|
||
.INDENT 0.0
|
||
.TP
|
||
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
|
||
only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
|
||
.TP
|
||
.BI \-\-sort\-by \ KEYS
|
||
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
|
||
.TP
|
||
.BI \-\-first \ N
|
||
consider the first N archives after other filters are applied
|
||
.TP
|
||
.BI \-\-last \ N
|
||
consider the last N archives after other filters are applied
|
||
.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 or 12m.
|
||
.TP
|
||
.BI \-\-newer \ TIMESPAN
|
||
consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
|
||
.UNINDENT
|
||
.SS Include/Exclude options
|
||
.INDENT 0.0
|
||
.TP
|
||
.BI \-e \ PATTERN\fR,\fB \ \-\-exclude \ PATTERN
|
||
exclude paths matching PATTERN
|
||
.TP
|
||
.BI \-\-exclude\-from \ EXCLUDEFILE
|
||
read exclude patterns from EXCLUDEFILE, one per line
|
||
.TP
|
||
.BI \-\-pattern \ PATTERN
|
||
include/exclude paths matching PATTERN
|
||
.TP
|
||
.BI \-\-patterns\-from \ PATTERNFILE
|
||
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
|
||
.\" End of generated man page.
|