Merge pull request #6795 from ThomasWaldmann/rel200a2

release 2.0.0 alpha 2

docs/changes.rst

@@ -12,8 +12,8 @@ This section provides information about security and corruption issues.
 Change Log 2.x
 ==============
 
-Version 2.0.0a2 (not released yet)
-----------------------------------
+Version 2.0.0a2 (2022-06-26)
+----------------------------
 
 Please note:
 
@@ -35,7 +35,8 @@ Compatibility notes:
 - command line syntax was changed, scripts and wrappers will need changes:
 
   - you will usually either export BORG_REPO=<MYREPO> into your environment or
-    call borg like: borg -r <MYREPO> command (-r ... usually omitted for brevity)
+    call borg like: "borg -r <MYREPO> <COMMAND>".
+    in the docs, we usually omit "-r ..." for brevity.
   - the scp-style REPO syntax was removed, please use ssh://..., #6697
   - differently than with borg 1.x you ONLY give the repo there, never a ::archive.
   - the archive name is either given as a positional parameter, like:
@@ -56,7 +57,6 @@ Compatibility notes:
       - borg rlist  # "repo list"
       - borg rinfo  # "repo info"
       - borg rdelete  # "repo delete"
-
     - borg 2 archive commands:
 
       - borg create ARCHIVE ...
@@ -78,28 +78,22 @@ Changes:
   - use -r or --repo or BORG_REPO env var to give the repository
   - use --other-repo or BORG_OTHER_REPO to give another repo (e.g. borg transfer)
   - use positional argument for archive name or `-a ARCH_GLOB`
-
 - remove support for scp-style repo specification, use ssh://...
 - simplify stats output: repo ops -> repo stats, archive ops -> archive stats
-
 - repository index: add payload size (==csize) and flags to NSIndex entries
 - repository index: set/query flags, iteration over flagged items (NSIndex)
 - repository: sync write file in get_fd
-
 - stats: deduplicated size now, was deduplicated compressed size in borg 1.x
 - remove csize support at most places in the code (chunks index, stats, get_size,
   Item.chunks)
-
 - replace problematic/ugly hardlink_master approach of borg 1.x by:
 
   - symmetric hlid (all hardlinks pointing to same inode have same hlid)
   - all archived hardlinked regular files have a chunks list
-
 - borg init --other-repo=OTHER_REPO: reuse key material from OTHER_REPO, #6554.
   This is useful if you want to use borg transfer to transfer archives from an
   existing borg 1.1/1.2 repo. If the chunker secret and the id key and algorithm
   stay the same, the deduplication will also work between past and future backups.
-
 - borg transfer:
 
   - efficiently copy archives from a borg 1.1/1.2 repo to a new repo.
@@ -117,13 +111,12 @@ Changes:
     - make sure items with chunks have precomputed size
     - removes the csize element from the tuples in the Item.chunks list
     - clean item of attic 0.13 'acl' bug remnants
-
 - crypto: see 1.3.0a1 log entry
 - removed "borg upgrade" command (not needed any more)
 - compact: removed --cleanup-commits option
 - docs: fixed quickstart and usage docs with new cli command syntax
-- docs: removed the parts talking about AES-CTR mode issues (we will not
-  use that any more)
+- docs: removed the parts talking about potential AES-CTR mode issues
+  (we will not use that any more).
 
 
 Version 1.3.0a1 (2022-04-15)

docs/man/borg-benchmark-cpu.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-CPU" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CPU" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-benchmark-cpu \- Benchmark CPU bound operations.
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CRUD" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-BENCHMARK" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-benchmark \- benchmark command
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-BREAK-LOCK" 1 "2022-06-26" "" "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

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-CHECK" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .SH SYNOPSIS
@@ -129,9 +129,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS optional arguments
 .INDENT 0.0
 .TP
-.BI \-\-name \ NAME
-specify the archive name
-.TP
 .B  \-\-repository\-only
 only perform repository checks
 .TP

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-COMMON" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-COMPACT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-compact \- compact segment files in the repository
 .SH SYNOPSIS
@@ -51,11 +51,6 @@ A segment is compacted if the amount of saved space is above the percentage valu
 given by the \fB\-\-threshold\fP option. If omitted, a threshold of 10% is used.
 When using \fB\-\-verbose\fP, borg will output an estimate of the freed space.
 .sp
-After upgrading borg (server) to 1.2+, you can use \fBborg compact \-\-cleanup\-commits\fP
-to clean up the numerous 17byte commit\-only segments that borg 1.1 did not clean up
-due to a bug. It is enough to do that once per repository. After cleaning up the
-commits, borg will also do a normal compaction.
-.sp
 See \fIseparate_compaction\fP in Additional Notes for more details.
 .SH OPTIONS
 .sp
@@ -63,9 +58,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B  \-\-cleanup\-commits
-cleanup commit\-only 17\-byte segment files
-.TP
 .BI \-\-threshold \ PERCENT
 set minimum threshold for saved space in PERCENT (Default: 10)
 .UNINDENT

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-COMPRESSION" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-compression \- Details regarding compression
 .SH DESCRIPTION

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-CONFIG" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-config \- get, set, and delete values in a repository or cache config file
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-CREATE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-create \- Create new archive
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-DELETE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-delete \- Delete archives
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-DIFF" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-diff \- Diff contents of two archives
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-EXPORT-TAR" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-export-tar \- Export archive contents as a tarball
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-EXTRACT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-extract \- Extract archive contents
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-IMPORT-TAR" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-import-tar \- Create a backup archive from a tarball
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-INFO" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-info \- Show archive details such as disk space used
 .SH SYNOPSIS

docs/man/borg-key-change-algorithm.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-ALGORITHM" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY-CHANGE-ALGORITHM" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key-change-algorithm \- Change repository key algorithm
 .SH SYNOPSIS

docs/man/borg-key-change-location.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-LOCATION" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY-CHANGE-LOCATION" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key-change-location \- Change repository key location
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY-CHANGE-PASSPHRASE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key-change-passphrase \- Change repository key file passphrase
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY-EXPORT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key-export \- Export the repository key for backup
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY-IMPORT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key-import \- Import the repository key from backup
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-KEY" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-key \- Manage a keyfile or repokey of a repository
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-LIST" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-list \- List archive contents
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-MOUNT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-PATTERNS" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-patterns \- Details regarding patterns
 .SH DESCRIPTION

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-PLACEHOLDERS" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-placeholders \- Details regarding placeholders
 .SH DESCRIPTION

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-PRUNE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-prune \- Prune repository archives according to specified rules
 .SH SYNOPSIS

docs/man/borg-rcreate.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-RCREATE" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RCREATE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-rcreate \- Create a new, empty repository
 .SH SYNOPSIS

docs/man/borg-rdelete.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-RDELETE" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RDELETE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-rdelete \- Delete a repository
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RECREATE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-recreate \- Re-create archives
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RENAME" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-rename \- Rename an existing archive
 .SH SYNOPSIS

docs/man/borg-rinfo.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-RINFO" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RINFO" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-rinfo \- Show repository infos
 .SH SYNOPSIS

docs/man/borg-rlist.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-RLIST" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-RLIST" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-rlist \- List the archives contained in a repository
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-SERVE" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-serve \- Start in server mode. This command is usually not used manually.
 .SH SYNOPSIS

docs/man/borg-transfer.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-TRANSFER" 1 "2022-06-25" "" "borg backup tool"
+.TH "BORG-TRANSFER" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-transfer \- archives transfer from other repository
 .SH SYNOPSIS
@@ -91,6 +91,60 @@ consider first N archives after other filters were applied
 .BI \-\-last \ N
 consider last N archives after other filters were applied
 .UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.TP
+.B ::
+# 0. Have borg 2.0 installed on client AND server, have a b12 repo copy for testing.
+.sp
+# 1. Create a new "related" repository:
+# here, the existing borg 1.2 repo used repokey\-blake2 (and aes\-ctr mode),
+# thus we use repokey\-blake2\-aes\-ocb for the new borg 2.0 repo.
+# staying with the same chunk id algorithm (blake2) and with the same
+# key material (via \-\-other\-repo <oldrepo>) will make deduplication work
+# between old archives (copied with borg transfer) and future ones.
+# the AEAD cipher does not matter (everything must be re\-encrypted and
+# re\-authenticated anyway), you could also choose repokey\-blake2\-chacha20\-poly1305.
+# in case your old borg repo did not use blake2, just remove the "\-blake2".
+$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP rcreate 
+.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 88)"
+Unexpected indentation.
+.INDENT 7.0
+.INDENT 3.5
+\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-e repokey\-blake2\-aes\-ocb
+.UNINDENT
+.UNINDENT
+.sp
+# 2. Check what and how much it would transfer:
+$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
+.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 92)"
+Unexpected indentation.
+.INDENT 7.0
+.INDENT 3.5
+\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
+.UNINDENT
+.UNINDENT
+.sp
+# 3. Transfer (copy) archives from old repo into new repo (takes time and space!):
+$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
+.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 96)"
+Unexpected indentation.
+.INDENT 7.0
+.INDENT 3.5
+\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP
+.UNINDENT
+.UNINDENT
+.sp
+# 4. Check if we have everything (same as 2.):
+$ borg \-\-repo       \fI\%ssh://borg2@borgbackup/./tests/b20\fP transfer 
+.IP "System Message: ERROR/3 (docs/borg-transfer.rst:, line 100)"
+Unexpected indentation.
+.INDENT 7.0
+.INDENT 3.5
+\-\-other\-repo \fI\%ssh://borg2@borgbackup/./tests/b12\fP \-\-dry\-run
+.UNINDENT
+.UNINDENT
+.UNINDENT
 .SH SEE ALSO
 .sp
 \fIborg\-common(1)\fP

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-UMOUNT" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-umount \- un-mount the FUSE filesystem
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG-WITH-LOCK" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg-with-lock \- run a user specified command with the repository lock held
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORG" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borg \- deduplicating and encrypting backup tool
 .SH SYNOPSIS

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 "2022-06-25" "" "borg backup tool"
+.TH "BORGFS" 1 "2022-06-26" "" "borg backup tool"
 .SH NAME
 borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .SH SYNOPSIS

docs/usage/check.rst.inc

@@ -15,8 +15,6 @@ borg check
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--name NAME``                       | specify the archive name                                                                                                                               |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--repository-only``                 | only perform repository checks                                                                                                                         |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--archives-only``                   | only perform archives checks                                                                                                                           |
@@ -59,7 +57,6 @@ borg check
 
 
     optional arguments
-        --name NAME       specify the archive name
         --repository-only    only perform repository checks
         --archives-only    only perform archives checks
         --verify-data     perform cryptographic archive data integrity verification (conflicts with ``--repository-only``)

docs/usage/compact.rst.inc

@@ -15,8 +15,6 @@ borg compact
     +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
     | **optional arguments**                                                                                                                           |
     +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
-    |                                                       | ``--cleanup-commits``   | cleanup commit-only 17-byte segment files                      |
-    +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
     |                                                       | ``--threshold PERCENT`` | set minimum threshold for saved space in PERCENT (Default: 10) |
     +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
     | .. class:: borg-common-opt-ref                                                                                                                   |
@@ -37,7 +35,6 @@ borg compact
 
 
     optional arguments
-        --cleanup-commits       cleanup commit-only 17-byte segment files
         --threshold PERCENT     set minimum threshold for saved space in PERCENT (Default: 10)
 
 
@@ -63,9 +60,4 @@ A segment is compacted if the amount of saved space is above the percentage valu
 given by the ``--threshold`` option. If omitted, a threshold of 10% is used.
 When using ``--verbose``, borg will output an estimate of the freed space.
 
-After upgrading borg (server) to 1.2+, you can use ``borg compact --cleanup-commits``
-to clean up the numerous 17byte commit-only segments that borg 1.1 did not clean up
-due to a bug. It is enough to do that once per repository. After cleaning up the
-commits, borg will also do a normal compaction.
-
 See :ref:`separate_compaction` in Additional Notes for more details.