diff --git a/Vagrantfile b/Vagrantfile index 002b1c673..90dcfd7f4 100644 --- a/Vagrantfile +++ b/Vagrantfile @@ -273,6 +273,18 @@ Vagrant.configure(2) do |config| v.cpus = $cpus end + config.vm.define "noble64" do |b| + b.vm.box = "ubuntu/noble64" + b.vm.provider :virtualbox do |v| + v.memory = 1024 + $wmem + end + b.vm.provision "fs init", :type => :shell, :inline => fs_init("vagrant") + b.vm.provision "packages debianoid", :type => :shell, :inline => packages_debianoid("vagrant") + b.vm.provision "build env", :type => :shell, :privileged => false, :inline => build_sys_venv("noble64") + b.vm.provision "install borg", :type => :shell, :privileged => false, :inline => install_borg("llfuse") + b.vm.provision "run tests", :type => :shell, :privileged => false, :inline => run_tests("noble64", ".*none.*") + end + config.vm.define "jammy64" do |b| b.vm.box = "ubuntu/jammy64" b.vm.provider :virtualbox do |v| diff --git a/docs/changes.rst b/docs/changes.rst index 3180ecf63..1e88010dd 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -412,8 +412,8 @@ Change Log ========== -Version 1.4.0b2 (not released yet) ----------------------------------- +Version 1.4.0b2 (2024-03-31) +---------------------------- For upgrade and compatibility hints, please also read the section "Upgrade Notes" above. diff --git a/docs/man/borg-benchmark-crud.1 b/docs/man/borg-benchmark-crud.1 index c56ea713b..68426fb89 100644 --- a/docs/man/borg-benchmark-crud.1 +++ b/docs/man/borg-benchmark-crud.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK-CRUD" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-BENCHMARK-CRUD" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives. .SH SYNOPSIS diff --git a/docs/man/borg-benchmark.1 b/docs/man/borg-benchmark.1 index 51c11fdd8..037825254 100644 --- a/docs/man/borg-benchmark.1 +++ b/docs/man/borg-benchmark.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BENCHMARK" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-BENCHMARK" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-benchmark \- benchmark command .SH SYNOPSIS diff --git a/docs/man/borg-break-lock.1 b/docs/man/borg-break-lock.1 index e6b45ec36..516cabe0b 100644 --- a/docs/man/borg-break-lock.1 +++ b/docs/man/borg-break-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-BREAK-LOCK" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-BREAK-LOCK" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg. .SH SYNOPSIS diff --git a/docs/man/borg-check.1 b/docs/man/borg-check.1 index 7e8ede053..e4c76c204 100644 --- a/docs/man/borg-check.1 +++ b/docs/man/borg-check.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CHECK" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-CHECK" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-check \- Check repository consistency .SH SYNOPSIS @@ -161,7 +161,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to check consistency of .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-repository\-only diff --git a/docs/man/borg-common.1 b/docs/man/borg-common.1 index f4510502f..f153dc11f 100644 --- a/docs/man/borg-common.1 +++ b/docs/man/borg-common.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMMON" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-COMMON" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-common \- Common options of Borg commands .SH SYNOPSIS diff --git a/docs/man/borg-compact.1 b/docs/man/borg-compact.1 index d07e00634..7389f1b57 100644 --- a/docs/man/borg-compact.1 +++ b/docs/man/borg-compact.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPACT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-COMPACT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-compact \- compact segment files in the repository .SH SYNOPSIS @@ -66,7 +66,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to compact .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-cleanup\-commits diff --git a/docs/man/borg-compression.1 b/docs/man/borg-compression.1 index 2aa7c4d95..4aa4b775a 100644 --- a/docs/man/borg-compression.1 +++ b/docs/man/borg-compression.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-COMPRESSION" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-COMPRESSION" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-compression \- Details regarding compression .SH DESCRIPTION diff --git a/docs/man/borg-config.1 b/docs/man/borg-config.1 index 381e240e3..8f58c1c22 100644 --- a/docs/man/borg-config.1 +++ b/docs/man/borg-config.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CONFIG" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-CONFIG" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-config \- get, set, and delete values in a repository or cache config file .SH SYNOPSIS @@ -62,7 +62,7 @@ name of config key .B VALUE new value for key .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-c\fP,\fB \-\-cache diff --git a/docs/man/borg-create.1 b/docs/man/borg-create.1 index 53cb8ae7b..6c0202bc3 100644 --- a/docs/man/borg-create.1 +++ b/docs/man/borg-create.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-CREATE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-CREATE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-create \- Create new archive .SH SYNOPSIS @@ -40,6 +40,11 @@ traversing all paths specified. Paths are added to the archive as they are given that means if relative paths are desired, the command has to be run from the correct directory. .sp +The slashdot hack in paths (recursion roots) is triggered by using \fB/./\fP: +\fB/this/gets/stripped/./this/gets/archived\fP means to process that fs object, but +strip the prefix on the left side of \fB\&./\fP from the archived items (in this case, +\fBthis/gets/archived\fP will be the path in the archived item). +.sp When giving \(aq\-\(aq as path, borg will read data from standard input and create a file \(aqstdin\(aq in the created archive from that data. In some cases it\(aqs more appropriate to use \-\-content\-from\-command, however. See section \fIReading from @@ -132,7 +137,7 @@ name of archive to create (must be also a valid directory name) .B PATH paths to archive .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run @@ -279,6 +284,9 @@ $ borg create /path/to/repo::my\-documents ~/Documents # same, but list all files as we process them $ borg create \-\-list /path/to/repo::my\-documents ~/Documents +# Backup /mnt/disk/docs, but strip path prefix using the slashdot hack +$ borg create /path/to/repo::docs /mnt/disk/./docs + # Backup ~/Documents and ~/src but exclude pyc files $ borg create /path/to/repo::my\-files \e ~/Documents \e @@ -439,7 +447,7 @@ Other flags used include: .IP \(bu 2 \(aq?\(aq = missing status code (if you see this, please file a bug report!) .UNINDENT -.SS Reading from stdin +.SS Reading backup data from stdin .sp There are two methods to read from stdin. Either specify \fB\-\fP as path and pipe directly to borg: @@ -486,6 +494,19 @@ creation a bit. .sp By default, the content read from stdin is stored in a file called \(aqstdin\(aq. Use \fB\-\-stdin\-name\fP to change the name. +.SS Feeding all file paths from externally +.sp +Usually, you give a starting path (recursion root) to borg and then borg +automatically recurses, finds and backs up all fs objects contained in +there (optionally considering include/exclude rules). +.sp +If you need more control and you want to give every single fs object path +to borg (maybe implementing your own recursion or your own rules), you can use +\fB\-\-paths\-from\-stdin\fP or \fB\-\-paths\-from\-command\fP (with the latter, borg will +fail to create an archive should the command fail). +.sp +Borg supports paths with the slashdot hack to strip path prefixes here also. +So, be careful not to unintentionally trigger that. .SH SEE ALSO .sp \fIborg\-common(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-check(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP, \fIborg\-compression(1)\fP diff --git a/docs/man/borg-delete.1 b/docs/man/borg-delete.1 index c456fa93d..533f264d0 100644 --- a/docs/man/borg-delete.1 +++ b/docs/man/borg-delete.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DELETE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-DELETE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-delete \- Delete an existing repository or archives .SH SYNOPSIS @@ -71,7 +71,7 @@ repository or archive to delete .B ARCHIVE archives to delete .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-diff.1 b/docs/man/borg-diff.1 index 136497c2a..273f12c5f 100644 --- a/docs/man/borg-diff.1 +++ b/docs/man/borg-diff.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-DIFF" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-DIFF" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-diff \- Diff contents of two archives .SH SYNOPSIS @@ -66,7 +66,7 @@ ARCHIVE2 name (no repository location allowed) .B PATH paths of items inside the archives to compare; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-numeric\-owner diff --git a/docs/man/borg-export-tar.1 b/docs/man/borg-export-tar.1 index 6aa2a119a..e08efcfcb 100644 --- a/docs/man/borg-export-tar.1 +++ b/docs/man/borg-export-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXPORT-TAR" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-EXPORT-TAR" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-export-tar \- Export archive contents as a tarball .SH SYNOPSIS @@ -91,7 +91,7 @@ output tar file. \(dq\-\(dq to write to stdout instead. .B PATH paths to extract; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-tar\-filter diff --git a/docs/man/borg-extract.1 b/docs/man/borg-extract.1 index 71e9f894f..f87468a78 100644 --- a/docs/man/borg-extract.1 +++ b/docs/man/borg-extract.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-EXTRACT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-EXTRACT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-extract \- Extract archive contents .SH SYNOPSIS @@ -72,7 +72,7 @@ archive to extract .B PATH paths to extract; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-list diff --git a/docs/man/borg-import-tar.1 b/docs/man/borg-import-tar.1 index b720b203d..3ce53b0cb 100644 --- a/docs/man/borg-import-tar.1 +++ b/docs/man/borg-import-tar.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-IMPORT-TAR" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-IMPORT-TAR" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-import-tar \- Create a backup archive from a tarball .SH SYNOPSIS @@ -86,7 +86,7 @@ name of archive to create (must be also a valid directory name) .B TARFILE input tar file. \(dq\-\(dq to read from stdin instead. .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-tar\-filter diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1 index 0d40cabc1..fb22c9bc0 100644 --- a/docs/man/borg-info.1 +++ b/docs/man/borg-info.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INFO" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-INFO" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-info \- Show archive details such as disk space used .SH SYNOPSIS @@ -59,7 +59,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY_OR_ARCHIVE repository or archive to display information about .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-json diff --git a/docs/man/borg-init.1 b/docs/man/borg-init.1 index 6c671ace3..a26992b22 100644 --- a/docs/man/borg-init.1 +++ b/docs/man/borg-init.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-INIT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-INIT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-init \- Initialize an empty repository .SH SYNOPSIS @@ -225,7 +225,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to create .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE diff --git a/docs/man/borg-key-change-passphrase.1 b/docs/man/borg-key-change-passphrase.1 index e19f4c1f6..914438c00 100644 --- a/docs/man/borg-key-change-passphrase.1 +++ b/docs/man/borg-key-change-passphrase.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-key-change-passphrase \- Change repository key file passphrase .SH SYNOPSIS diff --git a/docs/man/borg-key-export.1 b/docs/man/borg-key-export.1 index 5c6b7701d..29d7fa3b4 100644 --- a/docs/man/borg-key-export.1 +++ b/docs/man/borg-key-export.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-EXPORT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-KEY-EXPORT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-key-export \- Export the repository key for backup .SH SYNOPSIS @@ -85,7 +85,7 @@ REPOSITORY .B PATH where to store the backup .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-paper diff --git a/docs/man/borg-key-import.1 b/docs/man/borg-key-import.1 index 7a35f58ac..cab596516 100644 --- a/docs/man/borg-key-import.1 +++ b/docs/man/borg-key-import.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-IMPORT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-KEY-IMPORT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-key-import \- Import the repository key from backup .SH SYNOPSIS @@ -60,7 +60,7 @@ REPOSITORY .B PATH path to the backup (\(aq\-\(aq to read from stdin) .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-paper diff --git a/docs/man/borg-key-migrate-to-repokey.1 b/docs/man/borg-key-migrate-to-repokey.1 index 3f1238dc7..674c8facf 100644 --- a/docs/man/borg-key-migrate-to-repokey.1 +++ b/docs/man/borg-key-migrate-to-repokey.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-KEY-MIGRATE-TO-REPOKEY" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-key-migrate-to-repokey \- Migrate passphrase -> repokey .SH SYNOPSIS diff --git a/docs/man/borg-key.1 b/docs/man/borg-key.1 index b47493140..3b3465b97 100644 --- a/docs/man/borg-key.1 +++ b/docs/man/borg-key.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-KEY" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-KEY" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-key \- Manage a keyfile or repokey of a repository .SH SYNOPSIS diff --git a/docs/man/borg-list.1 b/docs/man/borg-list.1 index efc8d4fc3..7a4d86f36 100644 --- a/docs/man/borg-list.1 +++ b/docs/man/borg-list.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-LIST" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-LIST" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-list \- List archive or repository contents .SH SYNOPSIS @@ -50,7 +50,7 @@ repository or archive to list contents of .B PATH paths to list; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-consider\-checkpoints diff --git a/docs/man/borg-mount.1 b/docs/man/borg-mount.1 index b59fb273b..2d57b0c9f 100644 --- a/docs/man/borg-mount.1 +++ b/docs/man/borg-mount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-MOUNT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-MOUNT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-mount \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -107,7 +107,7 @@ where to mount filesystem .B PATH paths to extract; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-consider\-checkpoints diff --git a/docs/man/borg-patterns.1 b/docs/man/borg-patterns.1 index 6ecf48565..875b95980 100644 --- a/docs/man/borg-patterns.1 +++ b/docs/man/borg-patterns.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PATTERNS" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-PATTERNS" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-patterns \- Details regarding patterns .SH DESCRIPTION diff --git a/docs/man/borg-placeholders.1 b/docs/man/borg-placeholders.1 index 5f33e41c6..ba5b6bd67 100644 --- a/docs/man/borg-placeholders.1 +++ b/docs/man/borg-placeholders.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PLACEHOLDERS" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-PLACEHOLDERS" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-placeholders \- Details regarding placeholders .SH DESCRIPTION diff --git a/docs/man/borg-prune.1 b/docs/man/borg-prune.1 index 76874a875..3933ffd0b 100644 --- a/docs/man/borg-prune.1 +++ b/docs/man/borg-prune.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-PRUNE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-PRUNE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-prune \- Prune repository archives according to specified rules .SH SYNOPSIS @@ -97,7 +97,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY repository to prune .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run diff --git a/docs/man/borg-recreate.1 b/docs/man/borg-recreate.1 index 33be2038c..6d9901a3a 100644 --- a/docs/man/borg-recreate.1 +++ b/docs/man/borg-recreate.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RECREATE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-RECREATE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-recreate \- Re-create archives .SH SYNOPSIS @@ -97,7 +97,7 @@ repository or archive to recreate .B PATH paths to recreate; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-\-list diff --git a/docs/man/borg-rename.1 b/docs/man/borg-rename.1 index 47951be89..64c9e1d68 100644 --- a/docs/man/borg-rename.1 +++ b/docs/man/borg-rename.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-RENAME" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-RENAME" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-rename \- Rename an existing archive .SH SYNOPSIS diff --git a/docs/man/borg-serve.1 b/docs/man/borg-serve.1 index 929763571..d6dec9168 100644 --- a/docs/man/borg-serve.1 +++ b/docs/man/borg-serve.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-SERVE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-SERVE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-serve \- Start in server mode. This command is usually not used manually. .SH SYNOPSIS @@ -39,7 +39,7 @@ This command starts a repository server process. This command is usually not use .SH OPTIONS .sp See \fIborg\-common(1)\fP for common options of Borg commands. -.SS options +.SS optional arguments .INDENT 0.0 .TP .BI \-\-restrict\-to\-path \ PATH diff --git a/docs/man/borg-umount.1 b/docs/man/borg-umount.1 index d0a069940..fad612f1a 100644 --- a/docs/man/borg-umount.1 +++ b/docs/man/borg-umount.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UMOUNT" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-UMOUNT" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-umount \- un-mount the FUSE filesystem .SH SYNOPSIS @@ -114,9 +114,8 @@ bin boot etc home lib lib64 lost+found media mnt opt root sbin s .INDENT 0.0 .INDENT 3.5 \fBborgfs\fP will be automatically provided if you used a distribution -package, \fBpip\fP or \fBsetup.py\fP to install Borg. Users of the -standalone binary will have to manually create a symlink (see -\fIpyinstaller\-binary\fP). +package or \fBpip\fP to install Borg. Users of the standalone binary will have +to manually create a symlink (see \fIpyinstaller\-binary\fP). .UNINDENT .UNINDENT .SH SEE ALSO diff --git a/docs/man/borg-upgrade.1 b/docs/man/borg-upgrade.1 index 570e2e7e1..f2f1d9a9c 100644 --- a/docs/man/borg-upgrade.1 +++ b/docs/man/borg-upgrade.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-UPGRADE" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-UPGRADE" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-upgrade \- upgrade a repository from a previous version .SH SYNOPSIS @@ -148,7 +148,7 @@ See \fIborg\-common(1)\fP for common options of Borg commands. .B REPOSITORY path to the repository to be upgraded .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-n\fP,\fB \-\-dry\-run @@ -163,9 +163,15 @@ Force upgrade .B \-\-tam Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). .TP +.B \-\-check\-tam +check manifest authentication (in key and cache). +.TP .B \-\-disable\-tam Disable manifest authentication (in key and cache). .TP +.B \-\-check\-archives\-tam +check TAM authentication for all archives. +.TP .B \-\-archives\-tam add TAM authentication for all archives. .UNINDENT diff --git a/docs/man/borg-version.1 b/docs/man/borg-version.1 index ec096c9b6..63016dd65 100644 --- a/docs/man/borg-version.1 +++ b/docs/man/borg-version.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-VERSION" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-VERSION" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-version \- Display the borg client / borg server version .SH SYNOPSIS diff --git a/docs/man/borg-with-lock.1 b/docs/man/borg-with-lock.1 index e0c074eae..904127771 100644 --- a/docs/man/borg-with-lock.1 +++ b/docs/man/borg-with-lock.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG-WITH-LOCK" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG-WITH-LOCK" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg-with-lock \- run a user specified command with the repository lock held .SH SYNOPSIS diff --git a/docs/man/borg.1 b/docs/man/borg.1 index 0fb420b40..5e7d4d325 100644 --- a/docs/man/borg.1 +++ b/docs/man/borg.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORG" 1 "2024-01-20" "" "borg backup tool" +.TH "BORG" 1 "2024-03-30" "" "borg backup tool" .SH NAME borg \- deduplicating and encrypting backup tool .SH SYNOPSIS diff --git a/docs/man/borgfs.1 b/docs/man/borgfs.1 index 6a60b03f0..3c4623754 100644 --- a/docs/man/borgfs.1 +++ b/docs/man/borgfs.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "BORGFS" 1 "2024-01-20" "" "borg backup tool" +.TH "BORGFS" 1 "2024-03-30" "" "borg backup tool" .SH NAME borgfs \- Mount archive or an entire repository as a FUSE filesystem .SH SYNOPSIS @@ -107,7 +107,7 @@ where to mount filesystem .B PATH paths to extract; patterns are supported .UNINDENT -.SS options +.SS optional arguments .INDENT 0.0 .TP .B \-V\fP,\fB \-\-version diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index cfa72d057..47bf1f7ce 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -17,7 +17,7 @@ borg check +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to check consistency of | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--repository-only`` | only perform repository checks | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ borg check repository or archive to check consistency of - options + optional arguments --repository-only only perform repository checks --archives-only only perform archives checks --verify-data perform cryptographic archive data integrity verification (conflicts with ``--repository-only``) diff --git a/docs/usage/compact.rst.inc b/docs/usage/compact.rst.inc index 514dbf575..8187bbf7f 100644 --- a/docs/usage/compact.rst.inc +++ b/docs/usage/compact.rst.inc @@ -17,7 +17,7 @@ borg compact +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ | | ``REPOSITORY`` | repository to compact | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ | | ``--cleanup-commits`` | cleanup commit-only 17-byte segment files | +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+ @@ -42,7 +42,7 @@ borg compact repository to compact - options + optional arguments --cleanup-commits cleanup commit-only 17-byte segment files --threshold PERCENT set minimum threshold for saved space in PERCENT (Default: 10) diff --git a/docs/usage/config.rst.inc b/docs/usage/config.rst.inc index fdb44bf83..d90c327ee 100644 --- a/docs/usage/config.rst.inc +++ b/docs/usage/config.rst.inc @@ -21,7 +21,7 @@ borg config +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``VALUE`` | new value for key | +-------------------------------------------------------+----------------------+----------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+----------------------+----------------------------------------+ | | ``-c``, ``--cache`` | get and set values from the repo cache | +-------------------------------------------------------+----------------------+----------------------------------------+ @@ -52,7 +52,7 @@ borg config new value for key - options + optional arguments -c, --cache get and set values from the repo cache -d, --delete delete the key from the config file -l, --list list the configuration of the repo diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index 3059d4a8f..d27a2b083 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -19,7 +19,7 @@ borg create +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to archive | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not create a backup archive | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -130,7 +130,7 @@ borg create paths to archive - options + optional arguments -n, --dry-run do not create a backup archive -s, --stats print statistics for the created archive --list output verbose list of items (files, dirs, ...) @@ -194,6 +194,11 @@ traversing all paths specified. Paths are added to the archive as they are given that means if relative paths are desired, the command has to be run from the correct directory. +The slashdot hack in paths (recursion roots) is triggered by using ``/./``: +``/this/gets/stripped/./this/gets/archived`` means to process that fs object, but +strip the prefix on the left side of ``./`` from the archived items (in this case, +``this/gets/archived`` will be the path in the archived item). + When giving '-' as path, borg will read data from standard input and create a file 'stdin' in the created archive from that data. In some cases it's more appropriate to use --content-from-command, however. See section *Reading from @@ -333,8 +338,8 @@ Other flags used include: - 'x' = excluded, item was *not* backed up - '?' = missing status code (if you see this, please file a bug report!) -Reading from stdin -++++++++++++++++++ +Reading backup data from stdin +++++++++++++++++++++++++++++++ There are two methods to read from stdin. Either specify ``-`` as path and pipe directly to borg:: @@ -364,4 +369,19 @@ safe to disable it via ``--files-cache disabled`` and speed up backup creation a bit. By default, the content read from stdin is stored in a file called 'stdin'. -Use ``--stdin-name`` to change the name. \ No newline at end of file +Use ``--stdin-name`` to change the name. + +Feeding all file paths from externally +++++++++++++++++++++++++++++++++++++++ + +Usually, you give a starting path (recursion root) to borg and then borg +automatically recurses, finds and backs up all fs objects contained in +there (optionally considering include/exclude rules). + +If you need more control and you want to give every single fs object path +to borg (maybe implementing your own recursion or your own rules), you can use +``--paths-from-stdin`` or ``--paths-from-command`` (with the latter, borg will +fail to create an archive should the command fail). + +Borg supports paths with the slashdot hack to strip path prefixes here also. +So, be careful not to unintentionally trigger that. \ No newline at end of file diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index 46a21fa6a..77246644f 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -19,7 +19,7 @@ borg delete +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``ARCHIVE`` | archives to delete | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -70,7 +70,7 @@ borg delete archives to delete - options + optional arguments -n, --dry-run do not change repository --list output verbose list of archives -s, --stats print statistics for the deleted archive diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index 4bad260bb..914d46a06 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -21,7 +21,7 @@ borg diff +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``PATH`` | paths of items inside the archives to compare; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ | | ``--numeric-owner`` | deprecated, use ``--numeric-ids`` instead | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+ @@ -68,7 +68,7 @@ borg diff paths of items inside the archives to compare; patterns are supported - options + optional arguments --numeric-owner deprecated, use ``--numeric-ids`` instead --numeric-ids only consider numeric user and group identifiers --same-chunker-params Override check of chunker parameters. diff --git a/docs/usage/export-tar.rst.inc b/docs/usage/export-tar.rst.inc index cabfec740..46334880a 100644 --- a/docs/usage/export-tar.rst.inc +++ b/docs/usage/export-tar.rst.inc @@ -21,7 +21,7 @@ borg export-tar +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -62,7 +62,7 @@ borg export-tar paths to extract; patterns are supported - options + optional arguments --tar-filter filter program to pipe data through --list output verbose list of items (files, dirs, ...) diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index c928209f9..b233a846b 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -19,7 +19,7 @@ borg extract +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+ @@ -74,7 +74,7 @@ borg extract paths to extract; patterns are supported - options + optional arguments --list output verbose list of items (files, dirs, ...) -n, --dry-run do not actually change any files --numeric-owner deprecated, use ``--numeric-ids`` instead diff --git a/docs/usage/import-tar.rst.inc b/docs/usage/import-tar.rst.inc index 0749627cd..033ea1614 100644 --- a/docs/usage/import-tar.rst.inc +++ b/docs/usage/import-tar.rst.inc @@ -19,7 +19,7 @@ borg import-tar +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | | ``TARFILE`` | input tar file. "-" to read from stdin instead. | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ | | ``--tar-filter`` | filter program to pipe data through | +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ @@ -66,7 +66,7 @@ borg import-tar input tar file. "-" to read from stdin instead. - options + optional arguments --tar-filter filter program to pipe data through -s, --stats print statistics for the created archive --list output verbose list of items (files, dirs, ...) diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index d53ecf3cc..d77e485a0 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -17,7 +17,7 @@ borg info +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY_OR_ARCHIVE`` | repository or archive to display information about | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--json`` | format output as JSON | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -52,7 +52,7 @@ borg info repository or archive to display information about - options + optional arguments --json format output as JSON diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index 265a491a2..52102fa0a 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -17,7 +17,7 @@ borg init +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY`` | repository to create | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``-e MODE``, ``--encryption MODE`` | select encryption key mode **(required)** | +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -46,7 +46,7 @@ borg init repository to create - options + optional arguments -e MODE, --encryption MODE select encryption key mode **(required)** --append-only create an append-only mode repository. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. --storage-quota QUOTA Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota. diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 319d8b8d8..0a57bf091 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -19,7 +19,7 @@ borg key export +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ | | ``PATH`` | where to store the backup | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ | | ``--paper`` | Create an export suitable for printing and later type-in | +-------------------------------------------------------+----------------+------------------------------------------------------------------------+ @@ -46,7 +46,7 @@ borg key export where to store the backup - options + optional arguments --paper Create an export suitable for printing and later type-in --qr-html Create an html file suitable for printing and later type-in or qr scan diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index 19afbe537..a0890ff38 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -19,7 +19,7 @@ borg key import +-------------------------------------------------------+----------------+----------------------------------------------------------+ | | ``PATH`` | path to the backup ('-' to read from stdin) | +-------------------------------------------------------+----------------+----------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+----------------+----------------------------------------------------------+ | | ``--paper`` | interactively import from a backup done with ``--paper`` | +-------------------------------------------------------+----------------+----------------------------------------------------------+ @@ -44,7 +44,7 @@ borg key import path to the backup ('-' to read from stdin) - options + optional arguments --paper interactively import from a backup done with ``--paper`` diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index d44d9d550..f48a7f515 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -19,7 +19,7 @@ borg list +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to list; patterns are supported | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -74,7 +74,7 @@ borg list paths to list; patterns are supported - options + optional arguments --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). --short only print file/directory names, nothing else --format FORMAT specify format for file or archive listing (default for files: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}"; for archives: "{archive:<36} {time} [{id}]{NL}") diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index 89767a676..251f56cfe 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -21,7 +21,7 @@ borg mount +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to extract; patterns are supported | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``--consider-checkpoints`` | Show checkpoint archives in the repository contents list (default: hidden). | +-----------------------------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -80,7 +80,7 @@ borg mount paths to extract; patterns are supported - options + optional arguments --consider-checkpoints Show checkpoint archives in the repository contents list (default: hidden). -f, --foreground stay in foreground, do not daemonize -o Extra mount options diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index 6856cde00..c57677bf7 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -17,7 +17,7 @@ borg prune +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``REPOSITORY`` | repository to prune | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ | | ``-n``, ``--dry-run`` | do not change repository | +-----------------------------------------------------------------------------+---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------+ @@ -72,7 +72,7 @@ borg prune repository to prune - options + optional arguments -n, --dry-run do not change repository --force force pruning of corrupted archives, use ``--force --force`` in case ``--force`` does not work. -s, --stats print statistics for the deleted archive diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index 22a6dc908..d9c1302ee 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -19,7 +19,7 @@ borg recreate +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``PATH`` | paths to recreate; patterns are supported | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--list`` | output verbose list of items (files, dirs, ...) | +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -82,7 +82,7 @@ borg recreate paths to recreate; patterns are supported - options + optional arguments --list output verbose list of items (files, dirs, ...) --filter STATUSCHARS only display items with the given status characters (listed in borg create --help) -n, --dry-run do not change anything diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index e40692b5a..1c93098c1 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -13,7 +13,7 @@ borg serve .. class:: borg-options-table +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | **options** | + | **optional arguments** | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | | ``--restrict-to-path PATH`` | restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository. | +-------------------------------------------------------+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -40,7 +40,7 @@ borg serve - options + optional arguments --restrict-to-path PATH restrict repository access to PATH. Can be specified multiple times to allow the client access to several directories. Access to all sub-directories is granted implicitly; PATH doesn't need to directly point to a repository. --restrict-to-repository PATH restrict repository access. Only the repository located at PATH (no sub-directories are considered) is accessible. Can be specified multiple times to allow the client access to several repositories. Unlike ``--restrict-to-path`` sub-directories are not accessible; PATH needs to directly point at a repository location. PATH may be an empty directory or the last element of PATH may not exist, in which case the client may initialize a repository there. --append-only only allow appending to repository segment files. Note that this only affects the low level structure of the repository, and running `delete` or `prune` will still be allowed. See :ref:`append_only_mode` in Additional Notes for more details. diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index de6964385..68499d895 100644 --- a/docs/usage/upgrade.rst.inc +++ b/docs/usage/upgrade.rst.inc @@ -12,29 +12,33 @@ borg upgrade .. class:: borg-options-table - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | **positional arguments** | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``REPOSITORY`` | path to the repository to be upgraded | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | **options** | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``-n``, ``--dry-run`` | do not change repository | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``--inplace`` | rewrite repository in place, with no chance of going back to older versions of the repository. | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``--force`` | Force upgrade | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``--tam`` | Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``--disable-tam`` | Disable manifest authentication (in key and cache). | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | | ``--archives-tam`` | add TAM authentication for all archives. | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ - | .. class:: borg-common-opt-ref | - | | - | :ref:`common_options` | - +-------------------------------------------------------+-----------------------+------------------------------------------------------------------------------------------------+ + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | **positional arguments** | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``REPOSITORY`` | path to the repository to be upgraded | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | **optional arguments** | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``-n``, ``--dry-run`` | do not change repository | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--inplace`` | rewrite repository in place, with no chance of going back to older versions of the repository. | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--force`` | Force upgrade | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--tam`` | Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--check-tam`` | check manifest authentication (in key and cache). | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--disable-tam`` | Disable manifest authentication (in key and cache). | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--check-archives-tam`` | check TAM authentication for all archives. | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | | ``--archives-tam`` | add TAM authentication for all archives. | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ + | .. class:: borg-common-opt-ref | + | | + | :ref:`common_options` | + +-------------------------------------------------------+--------------------------+------------------------------------------------------------------------------------------------+ .. raw:: html @@ -50,12 +54,14 @@ borg upgrade path to the repository to be upgraded - options + optional arguments -n, --dry-run do not change repository --inplace rewrite repository in place, with no chance of going back to older versions of the repository. --force Force upgrade --tam Enable manifest authentication (in key and cache) (Borg 1.0.9 and later). + --check-tam check manifest authentication (in key and cache). --disable-tam Disable manifest authentication (in key and cache). + --check-archives-tam check TAM authentication for all archives. --archives-tam add TAM authentication for all archives. diff --git a/requirements.d/development.lock.txt b/requirements.d/development.lock.txt index 328d6b6db..1272873ce 100644 --- a/requirements.d/development.lock.txt +++ b/requirements.d/development.lock.txt @@ -9,4 +9,4 @@ pytest==7.4.3 pytest-xdist==3.5.0 pytest-cov==4.1.0 pytest-benchmark==4.0.0 -Cython==3.0.8 +Cython==3.0.10