mirror of https://github.com/borgbackup/borg.git
build_usage ; build_man
This commit is contained in:
parent
7794573d5c
commit
a41cc1750f
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-BENCHMARK-CRUD" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-BENCHMARK-CRUD" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-BENCHMARK" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-BENCHMARK" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-benchmark \- benchmark command
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-BREAK-LOCK" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-BREAK-LOCK" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-CHECK" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-CHECK" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-check \- Check repository consistency
|
||||
.SH SYNOPSIS
|
||||
|
@ -161,7 +161,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY_OR_ARCHIVE
|
||||
repository or archive to check consistency of
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-repository\-only
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-COMMON" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-COMMON" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-common \- Common options of Borg commands
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-COMPACT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-COMPACT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-compact \- compact segment files in the repository
|
||||
.SH SYNOPSIS
|
||||
|
@ -66,7 +66,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY
|
||||
repository to compact
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-cleanup\-commits
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-COMPRESSION" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-COMPRESSION" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-compression \- Details regarding compression
|
||||
.SH DESCRIPTION
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-CONFIG" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-CONFIG" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-config \- get, set, and delete values in a repository or cache config file
|
||||
.SH SYNOPSIS
|
||||
|
@ -62,7 +62,7 @@ name of config key
|
|||
.B VALUE
|
||||
new value for key
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-c\fP,\fB \-\-cache
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-CREATE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-CREATE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-create \- Create new archive
|
||||
.SH SYNOPSIS
|
||||
|
@ -40,6 +40,11 @@ traversing all paths specified. Paths are added to the archive as they are given
|
|||
that means if relative paths are desired, the command has to be run from the correct
|
||||
directory.
|
||||
.sp
|
||||
The slashdot hack in paths (recursion roots) is triggered by using \fB/./\fP:
|
||||
\fB/this/gets/stripped/./this/gets/archived\fP means to process that fs object, but
|
||||
strip the prefix on the left side of \fB\&./\fP from the archived items (in this case,
|
||||
\fBthis/gets/archived\fP will be the path in the archived item).
|
||||
.sp
|
||||
When giving \(aq\-\(aq as path, borg will read data from standard input and create a
|
||||
file \(aqstdin\(aq in the created archive from that data. In some cases it\(aqs more
|
||||
appropriate to use \-\-content\-from\-command, however. See section \fIReading from
|
||||
|
@ -132,7 +137,7 @@ name of archive to create (must be also a valid directory name)
|
|||
.B PATH
|
||||
paths to archive
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-n\fP,\fB \-\-dry\-run
|
||||
|
@ -279,6 +284,9 @@ $ borg create /path/to/repo::my\-documents ~/Documents
|
|||
# same, but list all files as we process them
|
||||
$ borg create \-\-list /path/to/repo::my\-documents ~/Documents
|
||||
|
||||
# Backup /mnt/disk/docs, but strip path prefix using the slashdot hack
|
||||
$ borg create /path/to/repo::docs /mnt/disk/./docs
|
||||
|
||||
# Backup ~/Documents and ~/src but exclude pyc files
|
||||
$ borg create /path/to/repo::my\-files \e
|
||||
~/Documents \e
|
||||
|
@ -439,7 +447,7 @@ Other flags used include:
|
|||
.IP \(bu 2
|
||||
\(aq?\(aq = missing status code (if you see this, please file a bug report!)
|
||||
.UNINDENT
|
||||
.SS Reading from stdin
|
||||
.SS Reading backup data from stdin
|
||||
.sp
|
||||
There are two methods to read from stdin. Either specify \fB\-\fP as path and
|
||||
pipe directly to borg:
|
||||
|
@ -486,6 +494,19 @@ creation a bit.
|
|||
.sp
|
||||
By default, the content read from stdin is stored in a file called \(aqstdin\(aq.
|
||||
Use \fB\-\-stdin\-name\fP to change the name.
|
||||
.SS Feeding all file paths from externally
|
||||
.sp
|
||||
Usually, you give a starting path (recursion root) to borg and then borg
|
||||
automatically recurses, finds and backs up all fs objects contained in
|
||||
there (optionally considering include/exclude rules).
|
||||
.sp
|
||||
If you need more control and you want to give every single fs object path
|
||||
to borg (maybe implementing your own recursion or your own rules), you can use
|
||||
\fB\-\-paths\-from\-stdin\fP or \fB\-\-paths\-from\-command\fP (with the latter, borg will
|
||||
fail to create an archive should the command fail).
|
||||
.sp
|
||||
Borg supports paths with the slashdot hack to strip path prefixes here also.
|
||||
So, be careful not to unintentionally trigger that.
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fIborg\-common(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-check(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-DELETE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-DELETE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-delete \- Delete an existing repository or archives
|
||||
.SH SYNOPSIS
|
||||
|
@ -71,7 +71,7 @@ repository or archive to delete
|
|||
.B ARCHIVE
|
||||
archives to delete
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-n\fP,\fB \-\-dry\-run
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-DIFF" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-DIFF" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-diff \- Diff contents of two archives
|
||||
.SH SYNOPSIS
|
||||
|
@ -66,7 +66,7 @@ ARCHIVE2 name (no repository location allowed)
|
|||
.B PATH
|
||||
paths of items inside the archives to compare; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-numeric\-owner
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-EXPORT-TAR" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-EXPORT-TAR" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-export-tar \- Export archive contents as a tarball
|
||||
.SH SYNOPSIS
|
||||
|
@ -91,7 +91,7 @@ output tar file. \(dq\-\(dq to write to stdout instead.
|
|||
.B PATH
|
||||
paths to extract; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-tar\-filter
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-EXTRACT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-EXTRACT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-extract \- Extract archive contents
|
||||
.SH SYNOPSIS
|
||||
|
@ -72,7 +72,7 @@ archive to extract
|
|||
.B PATH
|
||||
paths to extract; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-list
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-IMPORT-TAR" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-IMPORT-TAR" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-import-tar \- Create a backup archive from a tarball
|
||||
.SH SYNOPSIS
|
||||
|
@ -86,7 +86,7 @@ name of archive to create (must be also a valid directory name)
|
|||
.B TARFILE
|
||||
input tar file. \(dq\-\(dq to read from stdin instead.
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-tar\-filter
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-INFO" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-INFO" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-info \- Show archive details such as disk space used
|
||||
.SH SYNOPSIS
|
||||
|
@ -59,7 +59,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY_OR_ARCHIVE
|
||||
repository or archive to display information about
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-json
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-INIT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-INIT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-init \- Initialize an empty repository
|
||||
.SH SYNOPSIS
|
||||
|
@ -225,7 +225,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY
|
||||
repository to create
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-key-change-passphrase \- Change repository key file passphrase
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-KEY-EXPORT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-KEY-EXPORT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-key-export \- Export the repository key for backup
|
||||
.SH SYNOPSIS
|
||||
|
@ -85,7 +85,7 @@ REPOSITORY
|
|||
.B PATH
|
||||
where to store the backup
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-paper
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-KEY-IMPORT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-KEY-IMPORT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-key-import \- Import the repository key from backup
|
||||
.SH SYNOPSIS
|
||||
|
@ -60,7 +60,7 @@ REPOSITORY
|
|||
.B PATH
|
||||
path to the backup (\(aq\-\(aq to read from stdin)
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-paper
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-key-migrate-to-repokey \- Migrate passphrase -> repokey
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-KEY" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-KEY" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-key \- Manage a keyfile or repokey of a repository
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-LIST" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-LIST" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-list \- List archive or repository contents
|
||||
.SH SYNOPSIS
|
||||
|
@ -50,7 +50,7 @@ repository or archive to list contents of
|
|||
.B PATH
|
||||
paths to list; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-consider\-checkpoints
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-MOUNT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-MOUNT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-mount \- Mount archive or an entire repository as a FUSE filesystem
|
||||
.SH SYNOPSIS
|
||||
|
@ -107,7 +107,7 @@ where to mount filesystem
|
|||
.B PATH
|
||||
paths to extract; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-consider\-checkpoints
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-PATTERNS" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-PATTERNS" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-patterns \- Details regarding patterns
|
||||
.SH DESCRIPTION
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-PLACEHOLDERS" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-PLACEHOLDERS" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-placeholders \- Details regarding placeholders
|
||||
.SH DESCRIPTION
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-PRUNE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-PRUNE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-prune \- Prune repository archives according to specified rules
|
||||
.SH SYNOPSIS
|
||||
|
@ -97,7 +97,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY
|
||||
repository to prune
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-n\fP,\fB \-\-dry\-run
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-RECREATE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-RECREATE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-recreate \- Re-create archives
|
||||
.SH SYNOPSIS
|
||||
|
@ -97,7 +97,7 @@ repository or archive to recreate
|
|||
.B PATH
|
||||
paths to recreate; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-list
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-RENAME" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-RENAME" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-rename \- Rename an existing archive
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-SERVE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-SERVE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-serve \- Start in server mode. This command is usually not used manually.
|
||||
.SH SYNOPSIS
|
||||
|
@ -39,7 +39,7 @@ This command starts a repository server process. This command is usually not use
|
|||
.SH OPTIONS
|
||||
.sp
|
||||
See \fIborg\-common(1)\fP for common options of Borg commands.
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.BI \-\-restrict\-to\-path \ PATH
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-UMOUNT" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-UMOUNT" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-umount \- un-mount the FUSE filesystem
|
||||
.SH SYNOPSIS
|
||||
|
@ -114,9 +114,8 @@ bin boot etc home lib lib64 lost+found media mnt opt root sbin s
|
|||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\fBborgfs\fP will be automatically provided if you used a distribution
|
||||
package, \fBpip\fP or \fBsetup.py\fP to install Borg. Users of the
|
||||
standalone binary will have to manually create a symlink (see
|
||||
\fIpyinstaller\-binary\fP).
|
||||
package or \fBpip\fP to install Borg. Users of the standalone binary will have
|
||||
to manually create a symlink (see \fIpyinstaller\-binary\fP).
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH SEE ALSO
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-UPGRADE" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-UPGRADE" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-upgrade \- upgrade a repository from a previous version
|
||||
.SH SYNOPSIS
|
||||
|
@ -148,7 +148,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
|
|||
.B REPOSITORY
|
||||
path to the repository to be upgraded
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-n\fP,\fB \-\-dry\-run
|
||||
|
@ -163,9 +163,15 @@ Force upgrade
|
|||
.B \-\-tam
|
||||
Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).
|
||||
.TP
|
||||
.B \-\-check\-tam
|
||||
check manifest authentication (in key and cache).
|
||||
.TP
|
||||
.B \-\-disable\-tam
|
||||
Disable manifest authentication (in key and cache).
|
||||
.TP
|
||||
.B \-\-check\-archives\-tam
|
||||
check TAM authentication for all archives.
|
||||
.TP
|
||||
.B \-\-archives\-tam
|
||||
add TAM authentication for all archives.
|
||||
.UNINDENT
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-VERSION" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-VERSION" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-version \- Display the borg client / borg server version
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG-WITH-LOCK" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG-WITH-LOCK" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg-with-lock \- run a user specified command with the repository lock held
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORG" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORG" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borg \- deduplicating and encrypting backup tool
|
||||
.SH SYNOPSIS
|
||||
|
|
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "BORGFS" 1 "2024-01-20" "" "borg backup tool"
|
||||
.TH "BORGFS" 1 "2024-03-30" "" "borg backup tool"
|
||||
.SH NAME
|
||||
borgfs \- Mount archive or an entire repository as a FUSE filesystem
|
||||
.SH SYNOPSIS
|
||||
|
@ -107,7 +107,7 @@ where to mount filesystem
|
|||
.B PATH
|
||||
paths to extract; patterns are supported
|
||||
.UNINDENT
|
||||
.SS options
|
||||
.SS optional arguments
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-V\fP,\fB \-\-version
|
||||
|
|
|
@ -17,7 +17,7 @@ borg check
|
|||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to check consistency of |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--repository-only`` | only perform repository checks |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -62,7 +62,7 @@ borg check
|
|||
repository or archive to check consistency of
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--repository-only only perform repository checks
|
||||
--archives-only only perform archives checks
|
||||
--verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)
|
||||
|
|
|
@ -17,7 +17,7 @@ borg compact
|
|||
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | repository to compact |
|
||||
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
||||
| | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files |
|
||||
+-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
|
||||
|
@ -42,7 +42,7 @@ borg compact
|
|||
repository to compact
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--cleanup-commits cleanup commit-only 17-byte segment files
|
||||
--threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10)
|
||||
|
||||
|
|
|
@ -21,7 +21,7 @@ borg config
|
|||
+-------------------------------------------------------+----------------------+----------------------------------------+
|
||||
| | ``VALUE`` | new value for key |
|
||||
+-------------------------------------------------------+----------------------+----------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------------+----------------------------------------+
|
||||
| | ``-c``, ``--cache`` | get and set values from the repo cache |
|
||||
+-------------------------------------------------------+----------------------+----------------------------------------+
|
||||
|
@ -52,7 +52,7 @@ borg config
|
|||
new value for key
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-c, --cache get and set values from the repo cache
|
||||
-d, --delete delete the key from the config file
|
||||
-l, --list list the configuration of the repo
|
||||
|
|
|
@ -19,7 +19,7 @@ borg create
|
|||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to archive |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not create a backup archive |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -130,7 +130,7 @@ borg create
|
|||
paths to archive
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-n, --dry-run do not create a backup archive
|
||||
-s, --stats print statistics for the created archive
|
||||
--list output verbose list of items (files, dirs, ...)
|
||||
|
@ -194,6 +194,11 @@ traversing all paths specified. Paths are added to the archive as they are given
|
|||
that means if relative paths are desired, the command has to be run from the correct
|
||||
directory.
|
||||
|
||||
The slashdot hack in paths (recursion roots) is triggered by using ``/./``:
|
||||
``/this/gets/stripped/./this/gets/archived`` means to process that fs object, but
|
||||
strip the prefix on the left side of ``./`` from the archived items (in this case,
|
||||
``this/gets/archived`` will be the path in the archived item).
|
||||
|
||||
When giving '-' as path, borg will read data from standard input and create a
|
||||
file 'stdin' in the created archive from that data. In some cases it's more
|
||||
appropriate to use --content-from-command, however. See section *Reading from
|
||||
|
@ -333,8 +338,8 @@ Other flags used include:
|
|||
- 'x' = excluded, item was *not* backed up
|
||||
- '?' = missing status code (if you see this, please file a bug report!)
|
||||
|
||||
Reading from stdin
|
||||
++++++++++++++++++
|
||||
Reading backup data from stdin
|
||||
++++++++++++++++++++++++++++++
|
||||
|
||||
There are two methods to read from stdin. Either specify ``-`` as path and
|
||||
pipe directly to borg::
|
||||
|
@ -364,4 +369,19 @@ safe to disable it via ``--files-cache disabled`` and speed up backup
|
|||
creation a bit.
|
||||
|
||||
By default, the content read from stdin is stored in a file called 'stdin'.
|
||||
Use ``--stdin-name`` to change the name.
|
||||
Use ``--stdin-name`` to change the name.
|
||||
|
||||
Feeding all file paths from externally
|
||||
++++++++++++++++++++++++++++++++++++++
|
||||
|
||||
Usually, you give a starting path (recursion root) to borg and then borg
|
||||
automatically recurses, finds and backs up all fs objects contained in
|
||||
there (optionally considering include/exclude rules).
|
||||
|
||||
If you need more control and you want to give every single fs object path
|
||||
to borg (maybe implementing your own recursion or your own rules), you can use
|
||||
``--paths-from-stdin`` or ``--paths-from-command`` (with the latter, borg will
|
||||
fail to create an archive should the command fail).
|
||||
|
||||
Borg supports paths with the slashdot hack to strip path prefixes here also.
|
||||
So, be careful not to unintentionally trigger that.
|
|
@ -19,7 +19,7 @@ borg delete
|
|||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``ARCHIVE`` | archives to delete |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not change repository |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -70,7 +70,7 @@ borg delete
|
|||
archives to delete
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-n, --dry-run do not change repository
|
||||
--list output verbose list of archives
|
||||
-s, --stats print statistics for the deleted archive
|
||||
|
|
|
@ -21,7 +21,7 @@ borg diff
|
|||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths of items inside the archives to compare; patterns are supported |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
|
||||
| | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
|
||||
|
@ -68,7 +68,7 @@ borg diff
|
|||
paths of items inside the archives to compare; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--numeric-owner deprecated, use ``--numeric-ids`` instead
|
||||
--numeric-ids only consider numeric user and group identifiers
|
||||
--same-chunker-params Override check of chunker parameters.
|
||||
|
|
|
@ -21,7 +21,7 @@ borg export-tar
|
|||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to extract; patterns are supported |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| | ``--tar-filter`` | filter program to pipe data through |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
@ -62,7 +62,7 @@ borg export-tar
|
|||
paths to extract; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--tar-filter filter program to pipe data through
|
||||
--list output verbose list of items (files, dirs, ...)
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ borg extract
|
|||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to extract; patterns are supported |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
| | ``--list`` | output verbose list of items (files, dirs, ...) |
|
||||
+-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
|
||||
|
@ -74,7 +74,7 @@ borg extract
|
|||
paths to extract; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--list output verbose list of items (files, dirs, ...)
|
||||
-n, --dry-run do not actually change any files
|
||||
--numeric-owner deprecated, use ``--numeric-ids`` instead
|
||||
|
|
|
@ -19,7 +19,7 @@ borg import-tar
|
|||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``TARFILE`` | input tar file. "-" to read from stdin instead. |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--tar-filter`` | filter program to pipe data through |
|
||||
+-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -66,7 +66,7 @@ borg import-tar
|
|||
input tar file. "-" to read from stdin instead.
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--tar-filter filter program to pipe data through
|
||||
-s, --stats print statistics for the created archive
|
||||
--list output verbose list of items (files, dirs, ...)
|
||||
|
|
|
@ -17,7 +17,7 @@ borg info
|
|||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to display information about |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--json`` | format output as JSON |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -52,7 +52,7 @@ borg info
|
|||
repository or archive to display information about
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--json format output as JSON
|
||||
|
||||
|
||||
|
|
|
@ -17,7 +17,7 @@ borg init
|
|||
+-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | repository to create |
|
||||
+-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-e MODE``, ``--encryption MODE`` | select encryption key mode **(required)** |
|
||||
+-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -46,7 +46,7 @@ borg init
|
|||
repository to create
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-e MODE, --encryption MODE select encryption key mode **(required)**
|
||||
--append-only create an append-only mode repository. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details.
|
||||
--storage-quota QUOTA Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
|
||||
|
|
|
@ -19,7 +19,7 @@ borg key export
|
|||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| | ``PATH`` | where to store the backup |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
| | ``--paper`` | Create an export suitable for printing and later type-in |
|
||||
+-------------------------------------------------------+----------------+------------------------------------------------------------------------+
|
||||
|
@ -46,7 +46,7 @@ borg key export
|
|||
where to store the backup
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--paper Create an export suitable for printing and later type-in
|
||||
--qr-html Create an html file suitable for printing and later type-in or qr scan
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ borg key import
|
|||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| | ``PATH`` | path to the backup ('-' to read from stdin) |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
| | ``--paper`` | interactively import from a backup done with ``--paper`` |
|
||||
+-------------------------------------------------------+----------------+----------------------------------------------------------+
|
||||
|
@ -44,7 +44,7 @@ borg key import
|
|||
path to the backup ('-' to read from stdin)
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--paper interactively import from a backup done with ``--paper``
|
||||
|
||||
|
||||
|
|
|
@ -19,7 +19,7 @@ borg list
|
|||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to list; patterns are supported |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -74,7 +74,7 @@ borg list
|
|||
paths to list; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden).
|
||||
--short only print file/directory names, nothing else
|
||||
--format FORMAT specify format for file or archive listing (default for files: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}"; for archives: "{archive:<36} {time} [{id}]{NL}")
|
||||
|
|
|
@ -21,7 +21,7 @@ borg mount
|
|||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to extract; patterns are supported |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -80,7 +80,7 @@ borg mount
|
|||
paths to extract; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden).
|
||||
-f, --foreground stay in foreground, do not daemonize
|
||||
-o Extra mount options
|
||||
|
|
|
@ -17,7 +17,7 @@ borg prune
|
|||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | repository to prune |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not change repository |
|
||||
+-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -72,7 +72,7 @@ borg prune
|
|||
repository to prune
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-n, --dry-run do not change repository
|
||||
--force force pruning of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
|
||||
-s, --stats print statistics for the deleted archive
|
||||
|
|
|
@ -19,7 +19,7 @@ borg recreate
|
|||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``PATH`` | paths to recreate; patterns are supported |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--list`` | output verbose list of items (files, dirs, ...) |
|
||||
+-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -82,7 +82,7 @@ borg recreate
|
|||
paths to recreate; patterns are supported
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--list output verbose list of items (files, dirs, ...)
|
||||
--filter STATUSCHARS only display items with the given status characters (listed in borg create --help)
|
||||
-n, --dry-run do not change anything
|
||||
|
|
|
@ -13,7 +13,7 @@ borg serve
|
|||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| | ``--restrict-to-path PATH`` | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository. |
|
||||
+-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
|
@ -40,7 +40,7 @@ borg serve
|
|||
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
--restrict-to-path PATH restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository.
|
||||
--restrict-to-repository PATH restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path`` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there.
|
||||
--append-only only allow appending to repository segment files. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details.
|
||||
|
|
|
@ -12,29 +12,33 @@ borg upgrade
|
|||
|
||||
.. class:: borg-options-table
|
||||
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | path to the repository to be upgraded |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| **options** |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not change repository |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--inplace`` | rewrite repository in place, with no chance of going back to older versions of the repository. |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--force`` | Force upgrade |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--tam`` | Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--disable-tam`` | Disable manifest authentication (in key and cache). |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--archives-tam`` | add TAM authentication for all archives. |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| **positional arguments** |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``REPOSITORY`` | path to the repository to be upgraded |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| **optional arguments** |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``-n``, ``--dry-run`` | do not change repository |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--inplace`` | rewrite repository in place, with no chance of going back to older versions of the repository. |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--force`` | Force upgrade |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--tam`` | Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--check-tam`` | check manifest authentication (in key and cache). |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--disable-tam`` | Disable manifest authentication (in key and cache). |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--check-archives-tam`` | check TAM authentication for all archives. |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| | ``--archives-tam`` | add TAM authentication for all archives. |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
| .. class:: borg-common-opt-ref |
|
||||
| |
|
||||
| :ref:`common_options` |
|
||||
+-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
@ -50,12 +54,14 @@ borg upgrade
|
|||
path to the repository to be upgraded
|
||||
|
||||
|
||||
options
|
||||
optional arguments
|
||||
-n, --dry-run do not change repository
|
||||
--inplace rewrite repository in place, with no chance of going back to older versions of the repository.
|
||||
--force Force upgrade
|
||||
--tam Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).
|
||||
--check-tam check manifest authentication (in key and cache).
|
||||
--disable-tam Disable manifest authentication (in key and cache).
|
||||
--check-archives-tam check TAM authentication for all archives.
|
||||
--archives-tam add TAM authentication for all archives.
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue