borgbackup/borg
1
1
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-10-03 23:42:59 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #8450 from ThomasWaldmann/rel200b12

Browse Source 
Release 2.0.0b12
This commit is contained in:
TW 2024-10-03 12:47:38 +02:00 committed by GitHub
commit b2bdf5e20e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
53 changed files with 339 additions and 254 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/changes.rst
View File

@ -129,7 +129,7 @@ Compatibility notes:
Change Log 2.x Change Log 2.x
============== ==============
Version 2.0.0b11 (2024-09-26) Version 2.0.0b12 (2024-10-03)
----------------------------- -----------------------------
Please note: Please note:
@ -141,6 +141,42 @@ above.
New features: New features:
- tag: new command to set, add, remove tags.
- repo-list: add tags/hostname/username/comment to default format, reorder, adjust.
Idea: not putting these into the archive name, but keeping them separate.
- repo-list --short: only print archive IDs (unique IDs, used for scripting).
- implement --match-archives user:USERNAME host:HOSTNAME tags:TAG1,TAG2,...
- allow -a / --match-archives multiple times (logical AND).
E.g.: borg delete -a home -a user:kenny -a host:kenny-pc
- analyze: list changed chunks' sizes per directory.
Fixes:
- locking: also refresh the lock in other repo methods. avoid repo lock
getting stale when processing lots of unchanged files, #8442.
- make sure the store gets closed in case of exceptions, #8413.
- msgpack: increase max_buffer_size to ~4GiB, #8440.
- Location.canonical_path: fix protocol and host display, #8446.
Other changes:
- give borgstore.Store a complete levels configuration, #8432.
- add BORG_STORE_DATA_LEVELS=2 env var.
- check: also display archive timestamp.
- vagrant:
- use python 3.12.6 for binary builds.
- new testing box based on bento/ubuntu-24.04.
- install Rust on BSD.
Version 2.0.0b11 (2024-09-26)
-----------------------------
New features:
- Support rclone:// URLs for borg repositories. - Support rclone:// URLs for borg repositories.
This enables 70+ cloud storage products, including Amazon S3, Backblaze B2, This enables 70+ cloud storage products, including Amazon S3, Backblaze B2,

2
docs/man/borg-analyze.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-ANALYZE" 1 "2024-10-02" "" "borg backup tool" .TH "BORG-ANALYZE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-analyze \- Analyze archives borg-analyze \- Analyze archives
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-benchmark-cpu.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-BENCHMARK-CPU" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-BENCHMARK-CPU" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-benchmark-cpu \- Benchmark CPU bound operations. borg-benchmark-cpu \- Benchmark CPU bound operations.
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-benchmark-crud.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-BENCHMARK-CRUD" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-BENCHMARK-CRUD" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-benchmark.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-BENCHMARK" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-BENCHMARK" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-benchmark \- benchmark command borg-benchmark \- benchmark command
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-break-lock.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-BREAK-LOCK" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-BREAK-LOCK" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
.SH SYNOPSIS .SH SYNOPSIS

6
docs/man/borg-check.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-CHECK" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-CHECK" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-check \- Check repository consistency borg-check \- Check repository consistency
.SH SYNOPSIS .SH SYNOPSIS
@ -183,10 +183,10 @@ do only a partial repo check for max. SECONDS seconds (Default: unlimited)
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-common.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-COMMON" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-COMMON" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-common \- Common options of Borg commands borg-common \- Common options of Borg commands
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-compact.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-COMPACT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-COMPACT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-compact \- Collect garbage in repository borg-compact \- Collect garbage in repository
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-compression.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-COMPRESSION" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-COMPRESSION" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-compression \- Details regarding compression borg-compression \- Details regarding compression
.SH DESCRIPTION .SH DESCRIPTION

2
docs/man/borg-create.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-CREATE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-CREATE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-create \- Create new archive borg-create \- Create new archive
.SH SYNOPSIS .SH SYNOPSIS

6
docs/man/borg-delete.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-DELETE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-DELETE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-delete \- Delete archives borg-delete \- Delete archives
.SH SYNOPSIS .SH SYNOPSIS
@ -67,10 +67,10 @@ output verbose list of archives
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-diff.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-DIFF" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-DIFF" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-diff \- Diff contents of two archives borg-diff \- Diff contents of two archives
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-export-tar.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-EXPORT-TAR" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-EXPORT-TAR" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-export-tar \- Export archive contents as a tarball borg-export-tar \- Export archive contents as a tarball
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-extract.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-EXTRACT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-EXTRACT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-extract \- Extract archive contents borg-extract \- Extract archive contents
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-import-tar.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-IMPORT-TAR" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-IMPORT-TAR" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-import-tar \- Create a backup archive from a tarball borg-import-tar \- Create a backup archive from a tarball
.SH SYNOPSIS .SH SYNOPSIS

6
docs/man/borg-info.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-INFO" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-INFO" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-info \- Show archive details such as disk space used borg-info \- Show archive details such as disk space used
.SH SYNOPSIS .SH SYNOPSIS
@ -64,10 +64,10 @@ format output as JSON
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-key-change-location.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-KEY-CHANGE-LOCATION" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-KEY-CHANGE-LOCATION" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-change-location \- Change repository key location borg-key-change-location \- Change repository key location
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-key-change-passphrase.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-change-passphrase \- Change repository key file passphrase borg-key-change-passphrase \- Change repository key file passphrase
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-key-export.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-KEY-EXPORT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-KEY-EXPORT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-export \- Export the repository key for backup borg-key-export \- Export the repository key for backup
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-key-import.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-KEY-IMPORT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-KEY-IMPORT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-key-import \- Import the repository key from backup borg-key-import \- Import the repository key from backup
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-key.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-KEY" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-KEY" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-key \- Manage a keyfile or repokey of a repository borg-key \- Manage a keyfile or repokey of a repository
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-list.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-LIST" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-LIST" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-list \- List archive contents borg-list \- List archive contents
.SH SYNOPSIS .SH SYNOPSIS

39
docs/man/borg-match-archives.1
View File

@ -27,15 +27,30 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-MATCH-ARCHIVES" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-MATCH-ARCHIVES" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-match-archives \- Details regarding match-archives borg-match-archives \- Details regarding match-archives
.SH DESCRIPTION .SH DESCRIPTION
.sp .sp
The \fB\-\-match\-archives\fP option matches a given pattern against the list of all archive The \fB\-\-match\-archives\fP option matches a given pattern against the list of all archives
names in the repository. in the repository. It can be given multiple times.
.sp .sp
It uses pattern styles similar to the ones described by \fBborg help patterns\fP: The patterns can have a prefix of:
.INDENT 0.0
.IP \(bu 2
name: pattern match on the archive name (default)
.IP \(bu 2
aid: prefix match on the archive id (only one result allowed)
.IP \(bu 2
user: exact match on the username who created the archive
.IP \(bu 2
host: exact match on the hostname where the archive was created
.IP \(bu 2
tags: match on the archive tags
.UNINDENT
.sp
In case of a name pattern match,
it uses pattern styles similar to the ones described by \fBborg help patterns\fP:
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B Identical match pattern, selector \fBid:\fP (default) .B Identical match pattern, selector \fBid:\fP (default)
@ -55,16 +70,26 @@ Examples:
.sp .sp
.nf .nf
.ft C .ft C
# id: style # name match, id: style
borg delete \-\-match\-archives \(aqid:archive\-with\-crap\(aq borg delete \-\-match\-archives \(aqid:archive\-with\-crap\(aq
borg delete \-a \(aqid:archive\-with\-crap\(aq # same, using short option borg delete \-a \(aqid:archive\-with\-crap\(aq # same, using short option
borg delete \-a \(aqarchive\-with\-crap\(aq # same, because \(aqid:\(aq is the default borg delete \-a \(aqarchive\-with\-crap\(aq # same, because \(aqid:\(aq is the default
# sh: style # name match, sh: style
borg delete \-a \(aqsh:home\-kenny\-*\(aq borg delete \-a \(aqsh:home\-kenny\-*\(aq
# re: style # name match, re: style
borg delete \-a \(aqre:pc[123]\-home\-(user1|user2)\-2022\-09\-.*\(aq borg delete \-a \(aqre:pc[123]\-home\-(user1|user2)\-2022\-09\-.*\(aq
# archive id prefix match:
borg delete \-a \(aqaid:d34db33f\(aq
# host or user match
borg delete \-a \(aquser:kenny\(aq
borg delete \-a \(aqhost:kenny\-pc\(aq
# tags match
borg delete \-a \(aqtags:TAG1\(aq \-a \(aqtags:TAG2\(aq
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT

6
docs/man/borg-mount.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-MOUNT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-MOUNT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-mount \- Mount archive or an entire repository as a FUSE filesystem borg-mount \- Mount archive or an entire repository as a FUSE filesystem
.SH SYNOPSIS .SH SYNOPSIS
@ -123,10 +123,10 @@ use numeric user and group identifiers from archive(s)
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-patterns.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-PATTERNS" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-PATTERNS" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-patterns \- Details regarding patterns borg-patterns \- Details regarding patterns
.SH DESCRIPTION .SH DESCRIPTION

2
docs/man/borg-placeholders.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-PLACEHOLDERS" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-PLACEHOLDERS" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-placeholders \- Details regarding placeholders borg-placeholders \- Details regarding placeholders
.SH DESCRIPTION .SH DESCRIPTION

4
docs/man/borg-prune.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-PRUNE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-PRUNE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-prune \- Prune repository archives according to specified rules borg-prune \- Prune repository archives according to specified rules
.SH SYNOPSIS .SH SYNOPSIS
@ -142,7 +142,7 @@ number of yearly archives to keep
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-oldest \ TIMESPAN .BI \-\-oldest \ TIMESPAN
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

6
docs/man/borg-recreate.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-RECREATE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-RECREATE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-recreate \- Re-create archives borg-recreate \- Re-create archives
.SH SYNOPSIS .SH SYNOPSIS
@ -131,10 +131,10 @@ if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-rename.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-RENAME" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-RENAME" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-rename \- Rename an existing archive borg-rename \- Rename an existing archive
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-repo-compress.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-COMPRESS" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-COMPRESS" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-compress \- Repository (re-)compression borg-repo-compress \- Repository (re-)compression
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-repo-create.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-CREATE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-CREATE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-create \- Create a new, empty repository borg-repo-create \- Create a new, empty repository
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-repo-delete.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-DELETE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-DELETE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-delete \- Delete a repository borg-repo-delete \- Delete a repository
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-repo-info.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-INFO" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-INFO" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-info \- Show repository infos borg-repo-info \- Show repository infos
.SH SYNOPSIS .SH SYNOPSIS

20
docs/man/borg-repo-list.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-LIST" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-LIST" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-list \- List the archives contained in a repository borg-repo-list \- List the archives contained in a repository
.SH SYNOPSIS .SH SYNOPSIS
@ -43,7 +43,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-\-short .B \-\-short
only print the archive names, nothing else only print the archive IDs, nothing else
.TP .TP
.BI \-\-format \ FORMAT .BI \-\-format \ FORMAT
specify format for archive listing (default: \(dq{archive:<36} {time} [{id}]{NL}\(dq) specify format for archive listing (default: \(dq{archive:<36} {time} [{id}]{NL}\(dq)
@ -55,10 +55,10 @@ Format output as JSON. The form of \fB\-\-format\fP is ignored, but keys used in
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied
@ -85,10 +85,12 @@ consider archives newer than (now \- TIMESPAN), e.g. 7d or 12m.
.nf .nf
.ft C .ft C
$ borg repo\-list $ borg repo\-list
Monday Mon, 2016\-02\-15 19:15:11 151b1a57 Mon, 2024\-09\-23 22:57:11 +0200 docs tw MacBook\-Pro this is a comment
repo Mon, 2016\-02\-15 19:26:54 3387a079 Thu, 2024\-09\-26 09:07:07 +0200 scripts tw MacBook\-Pro
root\-2016\-02\-15 Mon, 2016\-02\-15 19:36:29 ca774425 Thu, 2024\-09\-26 10:05:23 +0200 scripts tw MacBook\-Pro
newname Mon, 2016\-02\-15 19:50:19 ba56c4a5 Thu, 2024\-09\-26 10:12:45 +0200 src tw MacBook\-Pro
7567b79a Thu, 2024\-09\-26 10:15:07 +0200 scripts tw MacBook\-Pro
21ab3600 Thu, 2024\-09\-26 10:15:17 +0200 docs tw MacBook\-Pro
\&... \&...
.ft P .ft P
.fi .fi
@ -150,6 +152,8 @@ comment: archive comment
.IP \(bu 2 .IP \(bu 2
id: internal ID of the archive id: internal ID of the archive
.IP \(bu 2 .IP \(bu 2
tags: archive tags
.IP \(bu 2
start: time (start) of creation of the archive start: time (start) of creation of the archive
.IP \(bu 2 .IP \(bu 2
time: alias of \(dqstart\(dq time: alias of \(dqstart\(dq

2
docs/man/borg-repo-space.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-REPO-SPACE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-REPO-SPACE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-repo-space \- Manage reserved space in repository borg-repo-space \- Manage reserved space in repository
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-serve.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-SERVE" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-SERVE" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-serve \- Start in server mode. This command is usually not used manually. borg-serve \- Start in server mode. This command is usually not used manually.
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-tag.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-TAG" 1 "2024-10-02" "" "borg backup tool" .TH "BORG-TAG" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-tag \- Manage tags borg-tag \- Manage tags
.SH SYNOPSIS .SH SYNOPSIS

6
docs/man/borg-transfer.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-TRANSFER" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-TRANSFER" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-transfer \- archives transfer from other repository, optionally upgrade data format borg-transfer \- archives transfer from other repository, optionally upgrade data format
.SH SYNOPSIS .SH SYNOPSIS
@ -121,10 +121,10 @@ recompress data chunks according to \fIMODE\fP and \fB\-\-compression\fP\&. Poss
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

2
docs/man/borg-umount.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-UMOUNT" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-UMOUNT" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-umount \- un-mount the FUSE filesystem borg-umount \- un-mount the FUSE filesystem
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-version.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-VERSION" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-VERSION" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-version \- Display the borg client / borg server version borg-version \- Display the borg client / borg server version
.SH SYNOPSIS .SH SYNOPSIS

2
docs/man/borg-with-lock.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG-WITH-LOCK" 1 "2024-09-26" "" "borg backup tool" .TH "BORG-WITH-LOCK" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg-with-lock \- run a user specified command with the repository lock held borg-with-lock \- run a user specified command with the repository lock held
.SH SYNOPSIS .SH SYNOPSIS

6
docs/man/borg.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORG" 1 "2024-09-26" "" "borg backup tool" .TH "BORG" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borg \- deduplicating and encrypting backup tool borg \- deduplicating and encrypting backup tool
.SH SYNOPSIS .SH SYNOPSIS
@ -244,7 +244,7 @@ For ssh and sftp URLs, the \fBuser@\fP and \fB:port\fP parts are optional.
.sp .sp
\fBRemote repositories\fP accessed via rclone: \fBRemote repositories\fP accessed via rclone:
.sp .sp
\fBrclone://remote:path\fP \fBrclone://remote:path\fP \- see the rclone docs for more details.
.sp .sp
If you frequently need the same repo URL, it is a good idea to set the If you frequently need the same repo URL, it is a good idea to set the
\fBBORG_REPO\fP environment variable to set a default for the repo URL: \fBBORG_REPO\fP environment variable to set a default for the repo URL:
@ -713,7 +713,7 @@ and re\-write segment files to free space.
.IP \(bu 2 .IP \(bu 2
In future, easier to adapt to other kinds of storage: In future, easier to adapt to other kinds of storage:
borgstore\(aqs backends are quite simple to implement. borgstore\(aqs backends are quite simple to implement.
\fBsftp:\fP and \fBrclone:\fP backends already exists, others might be easy to add. \fBsftp:\fP and \fBrclone:\fP backends already exist, others might be easy to add.
.IP \(bu 2 .IP \(bu 2
Parallel repository access with less locking is easier to implement. Parallel repository access with less locking is easier to implement.
.UNINDENT .UNINDENT

6
docs/man/borgfs.1
View File

@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
.. ..
.TH "BORGFS" 1 "2024-09-26" "" "borg backup tool" .TH "BORGFS" 1 "2024-10-03" "" "borg backup tool"
.SH NAME .SH NAME
borgfs \- Mount archive or an entire repository as a FUSE filesystem borgfs \- Mount archive or an entire repository as a FUSE filesystem
.SH SYNOPSIS .SH SYNOPSIS
@ -67,10 +67,10 @@ use numeric user and group identifiers from archive(s)
.INDENT 0.0 .INDENT 0.0
.TP .TP
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN .BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
only consider archive names matching the pattern. see \(dqborg help match\-archives\(dq. only consider archives matching all patterns. see \(dqborg help match\-archives\(dq.
.TP .TP
.BI \-\-sort\-by \ KEYS .BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
.TP .TP
.BI \-\-first \ N .BI \-\-first \ N
consider first N archives after other filters were applied consider first N archives after other filters were applied

78
docs/usage/check.rst.inc
View File

@ -12,43 +12,43 @@ borg check
.. class:: borg-options-table .. class:: borg-options-table
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** | | **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--repository-only`` | only perform repository checks | | | ``--repository-only`` | only perform repository checks |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--archives-only`` | only perform archives checks | | | ``--archives-only`` | only perform archives checks |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--verify-data`` | perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) | | | ``--verify-data`` | perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--repair`` | attempt to repair any inconsistencies found | | | ``--repair`` | attempt to repair any inconsistencies found |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--undelete-archives`` | attempt to undelete archives (use with --repair) | | | ``--undelete-archives`` | attempt to undelete archives (use with --repair) |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--max-duration SECONDS`` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) | | | ``--max-duration SECONDS`` | do only a partial repo check for max. SECONDS seconds (Default: unlimited) |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref | | .. class:: borg-common-opt-ref |
| | | |
| :ref:`common_options` | | :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--last N`` | consider last N archives after other filters were applied | | | ``--last N`` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. | | | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. | | | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
.. raw:: html .. raw:: html
@ -75,8 +75,8 @@ borg check
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

70
docs/usage/delete.rst.inc
View File

@ -12,39 +12,39 @@ borg delete
.. class:: borg-options-table .. class:: borg-options-table
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** | | **positional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``NAME`` | specify the archive name | | | ``NAME`` | specify the archive name |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** | | **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-n``, ``--dry-run`` | do not change repository | | | ``-n``, ``--dry-run`` | do not change repository |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--list`` | output verbose list of archives | | | ``--list`` | output verbose list of archives |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref | | .. class:: borg-common-opt-ref |
| | | |
| :ref:`common_options` | | :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--last N`` | consider last N archives after other filters were applied | | | ``--last N`` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. | | | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. | | | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
.. raw:: html .. raw:: html
@ -69,8 +69,8 @@ borg delete
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

31
docs/usage/help.rst.inc
View File

@ -264,10 +264,19 @@ borg help match-archives
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The ``--match-archives`` option matches a given pattern against the list of all archive The ``--match-archives`` option matches a given pattern against the list of all archives
names in the repository. in the repository. It can be given multiple times.
It uses pattern styles similar to the ones described by ``borg help patterns``: The patterns can have a prefix of:
- name: pattern match on the archive name (default)
- aid: prefix match on the archive id (only one result allowed)
- user: exact match on the username who created the archive
- host: exact match on the hostname where the archive was created
- tags: match on the archive tags
In case of a name pattern match,
it uses pattern styles similar to the ones described by ``borg help patterns``:
Identical match pattern, selector ``id:`` (default) Identical match pattern, selector ``id:`` (default)
Simple string match, must fully match exactly as given. Simple string match, must fully match exactly as given.
@ -281,17 +290,27 @@ Shell-style patterns, selector ``sh:``
Examples:: Examples::
# id: style # name match, id: style
borg delete --match-archives 'id:archive-with-crap' borg delete --match-archives 'id:archive-with-crap'
borg delete -a 'id:archive-with-crap' # same, using short option borg delete -a 'id:archive-with-crap' # same, using short option
borg delete -a 'archive-with-crap' # same, because 'id:' is the default borg delete -a 'archive-with-crap' # same, because 'id:' is the default
# sh: style # name match, sh: style
borg delete -a 'sh:home-kenny-*' borg delete -a 'sh:home-kenny-*'
# re: style # name match, re: style
borg delete -a 're:pc[123]-home-(user1|user2)-2022-09-.*' borg delete -a 're:pc[123]-home-(user1|user2)-2022-09-.*'
# archive id prefix match:
borg delete -a 'aid:d34db33f'
# host or user match
borg delete -a 'user:kenny'
borg delete -a 'host:kenny-pc'
# tags match
borg delete -a 'tags:TAG1' -a 'tags:TAG2'
.. _borg_placeholders: .. _borg_placeholders:
borg help placeholders borg help placeholders

66
docs/usage/info.rst.inc
View File

@ -12,37 +12,37 @@ borg info
.. class:: borg-options-table .. class:: borg-options-table
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** | | **positional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``NAME`` | specify the archive name | | | ``NAME`` | specify the archive name |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** | | **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--json`` | format output as JSON | | | ``--json`` | format output as JSON |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref | | .. class:: borg-common-opt-ref |
| | | |
| :ref:`common_options` | | :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--last N`` | consider last N archives after other filters were applied | | | ``--last N`` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. | | | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. | | | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
.. raw:: html .. raw:: html
@ -66,8 +66,8 @@ borg info
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

102
docs/usage/mount.rst.inc
View File

@ -12,55 +12,55 @@ borg mount
.. class:: borg-options-table .. class:: borg-options-table
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **positional arguments** | | **positional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``MOUNTPOINT`` | where to mount filesystem | | | ``MOUNTPOINT`` | where to mount filesystem |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``PATH`` | paths to extract; patterns are supported | | | ``PATH`` | paths to extract; patterns are supported |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** | | **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-f``, ``--foreground`` | stay in foreground, do not daemonize | | | ``-f``, ``--foreground`` | stay in foreground, do not daemonize |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-o`` | Extra mount options | | | ``-o`` | Extra mount options |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--numeric-ids`` | use numeric user and group identifiers from archive(s) | | | ``--numeric-ids`` | use numeric user and group identifiers from archive(s) |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| .. class:: borg-common-opt-ref | | .. class:: borg-common-opt-ref |
| | | |
| :ref:`common_options` | | :ref:`common_options` |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--last N`` | consider last N archives after other filters were applied | | | ``--last N`` | consider last N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. | | | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. | | | ``--newest TIMESPAN`` | consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--older TIMESPAN`` | consider archives older than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. | | | ``--newer TIMESPAN`` | consider archives newer than (now - TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| **Include/Exclude options** | | **Include/Exclude options** |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN | | | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--exclude-from EXCLUDEFILE`` | read exclude patterns from EXCLUDEFILE, one per line | | | ``--exclude-from EXCLUDEFILE`` | read exclude patterns from EXCLUDEFILE, one per line |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--pattern PATTERN`` | include/exclude paths matching PATTERN | | | ``--pattern PATTERN`` | include/exclude paths matching PATTERN |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--patterns-from PATTERNFILE`` | read include/exclude patterns from PATTERNFILE, one per line | | | ``--patterns-from PATTERNFILE`` | read include/exclude patterns from PATTERNFILE, one per line |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
| | ``--strip-components NUMBER`` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. | | | ``--strip-components NUMBER`` | Remove the specified number of leading path elements. Paths with fewer elements will be silently skipped. |
+-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+
.. raw:: html .. raw:: html
@ -88,8 +88,8 @@ borg mount
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

4
docs/usage/prune.rst.inc
View File

@ -53,7 +53,7 @@ borg prune
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+
| | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. | | | ``--oldest TIMESPAN`` | consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------+
@ -99,7 +99,7 @@ borg prune
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
--newest TIMESPAN consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m. --newest TIMESPAN consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m.
--older TIMESPAN consider archives older than (now - TIMESPAN), e.g. 7d or 12m. --older TIMESPAN consider archives older than (now - TIMESPAN), e.g. 7d or 12m.

8
docs/usage/recreate.rst.inc
View File

@ -49,9 +49,9 @@ borg recreate
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -111,8 +111,8 @@ borg recreate
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.

13
docs/usage/repo-list.rst.inc
View File

@ -15,7 +15,7 @@ borg repo-list
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **optional arguments** | | **optional arguments** |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--short`` | only print the archive names, nothing else | | | ``--short`` | only print the archive IDs, nothing else |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--format FORMAT`` | specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}") | | | ``--format FORMAT`` | specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}") |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -27,9 +27,9 @@ borg repo-list
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+----------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -57,7 +57,7 @@ borg repo-list
optional arguments optional arguments
--short only print the archive names, nothing else --short only print the archive IDs, nothing else
--format FORMAT specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}") --format FORMAT specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}")
--json Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. --json Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text.
@ -66,8 +66,8 @@ borg repo-list
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
@ -121,6 +121,7 @@ Keys available only when listing archives in a repository:
- name: alias of "archive" - name: alias of "archive"
- comment: archive comment - comment: archive comment
- id: internal ID of the archive - id: internal ID of the archive
- tags: archive tags
- start: time (start) of creation of the archive - start: time (start) of creation of the archive
- time: alias of "start" - time: alias of "start"

8
docs/usage/transfer.rst.inc
View File

@ -33,9 +33,9 @@ borg transfer
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Archive filters** — Archive filters can be applied to repository targets. | | **Archive filters** — Archive filters can be applied to repository targets. |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archive names matching the pattern. see "borg help match-archives". | | | ``-a PATTERN``, ``--match-archives PATTERN`` | only consider archives matching all patterns. see "borg help match-archives". |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp | | | ``--sort-by KEYS`` | Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| | ``--first N`` | consider first N archives after other filters were applied | | | ``--first N`` | consider first N archives after other filters were applied |
+-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@ -75,8 +75,8 @@ borg transfer
| |
Archive filters Archive filters
-a PATTERN, --match-archives PATTERN only consider archive names matching the pattern. see "borg help match-archives". -a PATTERN, --match-archives PATTERN only consider archives matching all patterns. see "borg help match-archives".
--sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp --sort-by KEYS Comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
--first N consider first N archives after other filters were applied --first N consider first N archives after other filters were applied
--last N consider last N archives after other filters were applied --last N consider last N archives after other filters were applied
--oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m. --oldest TIMESPAN consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.