borgbackup 2.0.0b12__tar.gz → 2.0.0b14__tar.gz

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/CHANGES.rst

@@ -39,14 +39,27 @@ Compatibility notes:
     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
-  - ssh:// URLs: removed support for /~otheruser/, #6855.
-    If you used this, just replace it by: ssh://user@host:port/home/otheruser/
+  - ssh:// URLs: removed support for /~otheruser/, /~/ and /./, #6855.
+    New format:
+
+    - ssh://user@host:port/relative/path
+    - ssh://user@host:port//absolute/path
   - -P / --prefix option was removed, please use the similar -a / --match-archives.
   - archive names don't need to be unique anymore. to the contrary:
     it is now strongly recommended to use the identical name for borg create
     within the same series of archives to make borg work more efficiently.
     the name now identifies a series of archive, to identify a single archive
     please use aid:<archive-hash-prefix>, e.g.: borg delete aid:d34db33f
+  - in case you do NOT want to adopt the "series name" way of naming archives
+    (like "myarchive") as we recommend, but keep using always-changing names
+    (like "myserver-myarchive-20241231"), you can do that, but then you must
+    make use of BORG_FILES_CACHE_SUFFIX and either set it to a constant suffix
+    (like "all") or to a unique suffix per archive series (like
+    "myserver-myarchive") so that borg can find the correct files cache.
+    For the "all" variant, you must also set BORG_FILES_CACHE_TTL to a value
+    greater than the count of different archives series you write to that repo.
+    Usually borg uses a different files cache suffix per archive (series) name
+    and defaults to BORG_FILES_CACHE_TTL=2 because that is sufficient for that.
   - the archive id is always given separately from the repository
     (differently than with borg 1.x you must not give repo::archive).
   - the series name or archive id is either given as a positional parameter,
@@ -94,6 +107,8 @@ Compatibility notes:
   - removed --save-space option (does not change behaviour)
 - removed --bypass-lock option
 - removed borg config command (only worked locally anyway)
+- compact command now requires access to the borg key if the repo is encrypted
+  or authenticated
 - using --list together with --progress is now disallowed (except with --log-json), #7219
 - the --glob-archives option was renamed to --match-archives (the short option
   name -a is unchanged) and extended to support different pattern styles:
@@ -129,7 +144,7 @@ Compatibility notes:
 Change Log 2.x
 ==============
 
-Version 2.0.0b12 (2024-10-03)
+Version 2.0.0b14 (2024-11-17)
 -----------------------------
 
 Please note:
@@ -141,6 +156,105 @@ above.
 
 New features:
 
+- delete: now only soft-deletes archives (same for prune)
+- repo-list: --deleted lists deleted archives
+- undelete: undelete soft-deleted archives, #8500
+
+Fixes:
+
+- chunks index cache:
+
+  - enable partial/incremental updates (F_NEW flag).
+  - write chunks index every 10mins, #8503.
+    this makes sure progress is not totally lost when a backup is interrupted.
+  - write to repo/cache/chunks.<HASH> to enable parallel updates.
+- mount: fix check_pending_archive to give correct root dir, #8528
+
+Other changes:
+
+- repo-compress: reduce memory consumption (F_COMPRESS flag)
+- files cache: reduce memory consumption, #5756
+- check: rename --undelete-archives to --find-lost-archives
+- check: rebuild_archives_directory: accelerate by only reading metadata
+- shell completions: adapt zsh for borg 2.0.0b13 - needs more work!
+- chunk index: rename .refcount to .flags, use it for user and system flags.
+- vagrant:
+
+  - add bookworm32 box for 32bit platform testing
+  - fix pythons on freebsd14
+  - simplify openindiana box setup
+- docs:
+
+  - remove --bypass-lock, small changes regarding compression
+  - FAQ: clean up entries regarding SSH settings
+
+
+Version 2.0.0b13 (2024-10-31)
+-----------------------------
+
+New features:
+
+- implement special tags, @PROT tag for protecting archives, #953.
+
+  borg won't delete/prune/recreate protected archives.
+- prune: add quarterly pruning strategy, #8337.
+- import-tar/export-tar: add xattr support for PAX format, #2521.
+
+Fixes:
+
+- simple error msgs for existing / non-existing repo, no tracebacks, #8475.
+- mount: create unique directory names, #8461.
+- diff: suppress modified changes for files which weren't actually modified.
+- diff: do not test for ctime difference on windows.
+- prune: fix exception when NAME is given, #8486
+- repo-create: build and cache an empty ChunkIndex.
+- work around missing size/nfiles archive metadata, #8491
+- lock after checking repo exists, #8485
+
+Other changes:
+
+- new file:, rclone:, ssh:, sftp: URLs, #8372, #8446.
+
+  new way to deal with absolute vs. relative paths.
+- require borgstore ~= 0.1.0, require borghash ~= 0.0.1.
+- new hashtable code based on borghash project:
+
+  - borghash replaces old / hard to maintain _hashindex.c code.
+  - implement ChunkIndex, NSIndex1, FuseVersionsIndex using borghash.HashTableNT.
+  - rewrite NSIndex1 (borg 1.x) on-disk format read/write methods in Cython.
+  - remove NSIndex (early borg2) data structure / serialization code for repo index.
+  - change xxh64 seed for ChunkIndex to invalidate old cache contents.
+  - chunks index: show hashtable stats at debug log level, #506.
+- check (repository part): build and cache a ChunkIndex.
+
+  check (archives part): use cached ChunkIndex from check (repository part).
+- export-tar: switch default to PAX format.
+- docs:
+
+  - update URL docs
+  - mount: document on-demand loading, perf tips, #7173.
+  - borg/borgfs detects internally under which name it was invoked, #8207.
+  - better link modern return codes, #8370.
+  - binary: using the directory build is faster, #8008.
+  - update "Running the tests (using the pypi package)", #6386.
+- github CI:
+
+  - temporarily disabled windows CI, #8474.
+  - msys2: use pyinstaller 6.10.0.
+  - msys2: install rclone.
+- tests:
+
+  - rename test files so that pytest default discovery finds them.
+  - call register_assert_rewrite before importing borg.testsuite.
+  - move conftest.py one directory level higher.
+  - remove hashindex tests from selftests (borghash project has own tests).
+
+
+Version 2.0.0b12 (2024-10-03)
+-----------------------------
+
+New features:
+
 - tag: new command to set, add, remove tags.
 - repo-list: add tags/hostname/username/comment to default format, reorder, adjust.
 

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2015-2023 The Borg Collective (see AUTHORS file)
+Copyright (C) 2015-2024 The Borg Collective (see AUTHORS file)
 Copyright (C) 2010-2014 Jonas Borgström <jonas@borgstrom.se>
 All rights reserved.
 

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: borgbackup
-Version: 2.0.0b12
+Version: 2.0.0b14
 Summary: Deduplicated, encrypted, authenticated and compressed backups
 Author: The Borg Collective (see AUTHORS file)
 Maintainer-email: Thomas Waldmann <tw@waldmann-edv.de>
@@ -32,7 +32,8 @@ Classifier: Topic :: System :: Archiving :: Backup
 Requires-Python: >=3.9
 License-File: LICENSE
 License-File: AUTHORS
-Requires-Dist: borgstore~=0.0.4
+Requires-Dist: borghash~=0.0.1
+Requires-Dist: borgstore~=0.1.0
 Requires-Dist: msgpack<=1.1.0,>=1.0.3
 Requires-Dist: packaging
 Requires-Dist: platformdirs<5.0.0,>=3.0.0; sys_platform == "darwin"

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/binaries/00_README.txt

@@ -25,7 +25,9 @@ borg-macos1012      macOS (built on macOS Sierra 10.12 with latest macFUSE from
 borg-freebsd14      FreeBSD (built on FreeBSD 14)
 
 *.tgz               similar to above, but built as a directory with files,
-                    not as a single self-extracting binary.
+                    not as a single self-extracting binary. using the directory
+                    build is faster and doesn't need as much space in the temp
+                    directory as the one-file build.
 *.asc               GnuPG signatures for *
 
 
@@ -53,6 +55,8 @@ Installing
 ----------
 
 It is suggested that you rename or symlink the binary to just "borg".
+If you need "borgfs", just also symlink it to the same binary, it will
+detect internally under which name it was invoked.
 
 On UNIX-like platforms, /usr/local/bin/ or ~/bin/ is a nice place for it,
 but you can invoke it from every place by giving a full path to it.

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/changes.rst

@@ -39,14 +39,27 @@ Compatibility notes:
     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
-  - ssh:// URLs: removed support for /~otheruser/, #6855.
-    If you used this, just replace it by: ssh://user@host:port/home/otheruser/
+  - ssh:// URLs: removed support for /~otheruser/, /~/ and /./, #6855.
+    New format:
+
+    - ssh://user@host:port/relative/path
+    - ssh://user@host:port//absolute/path
   - -P / --prefix option was removed, please use the similar -a / --match-archives.
   - archive names don't need to be unique anymore. to the contrary:
     it is now strongly recommended to use the identical name for borg create
     within the same series of archives to make borg work more efficiently.
     the name now identifies a series of archive, to identify a single archive
     please use aid:<archive-hash-prefix>, e.g.: borg delete aid:d34db33f
+  - in case you do NOT want to adopt the "series name" way of naming archives
+    (like "myarchive") as we recommend, but keep using always-changing names
+    (like "myserver-myarchive-20241231"), you can do that, but then you must
+    make use of BORG_FILES_CACHE_SUFFIX and either set it to a constant suffix
+    (like "all") or to a unique suffix per archive series (like
+    "myserver-myarchive") so that borg can find the correct files cache.
+    For the "all" variant, you must also set BORG_FILES_CACHE_TTL to a value
+    greater than the count of different archives series you write to that repo.
+    Usually borg uses a different files cache suffix per archive (series) name
+    and defaults to BORG_FILES_CACHE_TTL=2 because that is sufficient for that.
   - the archive id is always given separately from the repository
     (differently than with borg 1.x you must not give repo::archive).
   - the series name or archive id is either given as a positional parameter,
@@ -94,6 +107,8 @@ Compatibility notes:
   - removed --save-space option (does not change behaviour)
 - removed --bypass-lock option
 - removed borg config command (only worked locally anyway)
+- compact command now requires access to the borg key if the repo is encrypted
+  or authenticated
 - using --list together with --progress is now disallowed (except with --log-json), #7219
 - the --glob-archives option was renamed to --match-archives (the short option
   name -a is unchanged) and extended to support different pattern styles:
@@ -129,7 +144,7 @@ Compatibility notes:
 Change Log 2.x
 ==============
 
-Version 2.0.0b12 (2024-10-03)
+Version 2.0.0b14 (2024-11-17)
 -----------------------------
 
 Please note:
@@ -141,6 +156,105 @@ above.
 
 New features:
 
+- delete: now only soft-deletes archives (same for prune)
+- repo-list: --deleted lists deleted archives
+- undelete: undelete soft-deleted archives, #8500
+
+Fixes:
+
+- chunks index cache:
+
+  - enable partial/incremental updates (F_NEW flag).
+  - write chunks index every 10mins, #8503.
+    this makes sure progress is not totally lost when a backup is interrupted.
+  - write to repo/cache/chunks.<HASH> to enable parallel updates.
+- mount: fix check_pending_archive to give correct root dir, #8528
+
+Other changes:
+
+- repo-compress: reduce memory consumption (F_COMPRESS flag)
+- files cache: reduce memory consumption, #5756
+- check: rename --undelete-archives to --find-lost-archives
+- check: rebuild_archives_directory: accelerate by only reading metadata
+- shell completions: adapt zsh for borg 2.0.0b13 - needs more work!
+- chunk index: rename .refcount to .flags, use it for user and system flags.
+- vagrant:
+
+  - add bookworm32 box for 32bit platform testing
+  - fix pythons on freebsd14
+  - simplify openindiana box setup
+- docs:
+
+  - remove --bypass-lock, small changes regarding compression
+  - FAQ: clean up entries regarding SSH settings
+
+
+Version 2.0.0b13 (2024-10-31)
+-----------------------------
+
+New features:
+
+- implement special tags, @PROT tag for protecting archives, #953.
+
+  borg won't delete/prune/recreate protected archives.
+- prune: add quarterly pruning strategy, #8337.
+- import-tar/export-tar: add xattr support for PAX format, #2521.
+
+Fixes:
+
+- simple error msgs for existing / non-existing repo, no tracebacks, #8475.
+- mount: create unique directory names, #8461.
+- diff: suppress modified changes for files which weren't actually modified.
+- diff: do not test for ctime difference on windows.
+- prune: fix exception when NAME is given, #8486
+- repo-create: build and cache an empty ChunkIndex.
+- work around missing size/nfiles archive metadata, #8491
+- lock after checking repo exists, #8485
+
+Other changes:
+
+- new file:, rclone:, ssh:, sftp: URLs, #8372, #8446.
+
+  new way to deal with absolute vs. relative paths.
+- require borgstore ~= 0.1.0, require borghash ~= 0.0.1.
+- new hashtable code based on borghash project:
+
+  - borghash replaces old / hard to maintain _hashindex.c code.
+  - implement ChunkIndex, NSIndex1, FuseVersionsIndex using borghash.HashTableNT.
+  - rewrite NSIndex1 (borg 1.x) on-disk format read/write methods in Cython.
+  - remove NSIndex (early borg2) data structure / serialization code for repo index.
+  - change xxh64 seed for ChunkIndex to invalidate old cache contents.
+  - chunks index: show hashtable stats at debug log level, #506.
+- check (repository part): build and cache a ChunkIndex.
+
+  check (archives part): use cached ChunkIndex from check (repository part).
+- export-tar: switch default to PAX format.
+- docs:
+
+  - update URL docs
+  - mount: document on-demand loading, perf tips, #7173.
+  - borg/borgfs detects internally under which name it was invoked, #8207.
+  - better link modern return codes, #8370.
+  - binary: using the directory build is faster, #8008.
+  - update "Running the tests (using the pypi package)", #6386.
+- github CI:
+
+  - temporarily disabled windows CI, #8474.
+  - msys2: use pyinstaller 6.10.0.
+  - msys2: install rclone.
+- tests:
+
+  - rename test files so that pytest default discovery finds them.
+  - call register_assert_rewrite before importing borg.testsuite.
+  - move conftest.py one directory level higher.
+  - remove hashindex tests from selftests (borghash project has own tests).
+
+
+Version 2.0.0b12 (2024-10-03)
+-----------------------------
+
+New features:
+
 - tag: new command to set, add, remove tags.
 - repo-list: add tags/hostname/username/comment to default format, reorder, adjust.
 

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/conf.py

@@ -42,7 +42,7 @@ master_doc = "index"
 
 # General information about the project.
 project = "Borg - Deduplicating Archiver"
-copyright = "2010-2014 Jonas Borgström, 2015-2022 The Borg Collective (see AUTHORS file)"
+copyright = "2010-2014 Jonas Borgström, 2015-2024 The Borg Collective (see AUTHORS file)"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/development.rst

@@ -323,20 +323,8 @@ github releases page)::
     pip install borgbackup
     pip install pytest pytest-benchmark
 
-    # method A: use a pytest.ini
-
-    cat >pytest.ini <<<EOF
-    [pytest]
-    python_files = testsuite/*.py
-    markers = allow_cache_wipe
-    addopts = -rs --benchmark-skip
-    EOF
-
-    pytest --pyargs borg.testsuite
-
-    # method B: give the options via the cmdline (each time you invoke the tests):
-
-    pytest -rs --benchmark-skip -o 'python_files=testsuite/*.py' -o 'markers=allow_cache_wipe' --pyargs borg.testsuite
+    # run the tests
+    pytest -v -rs --benchmark-skip --pyargs borg.testsuite
 
 
 Adding a compression algorithm

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/faq.rst

@@ -602,31 +602,25 @@ You will also get this error if you try to access a repository with a key that u
 We recommend upgrading to the latest stable version and trying again. We are sorry. We should have thought about forward
 compatibility and implemented a more helpful error message.
 
-Why does Borg extract hang after some time?
--------------------------------------------
-
-When I do a ``borg extract``, after a while all activity stops, no cpu usage,
-no downloads.
-
-This may happen when the SSH connection is stuck on server side. You can
-configure SSH on client side to prevent this by sending keep-alive requests,
-for example in ~/.ssh/config:
+Why am I seeing idle borg serve processes on the repo server?
+-------------------------------------------------------------
 
-::
+Please see the next question.
 
-    Host borg.example.com
-        # Client kills connection after 3*30 seconds without server response:
-        ServerAliveInterval 30
-        ServerAliveCountMax 3
+Why does Borg disconnect or hang when backing up to a remote server?
+--------------------------------------------------------------------
 
-You can also do the opposite and configure SSH on server side in
-/etc/ssh/sshd_config, to make the server send keep-alive requests to the client:
+Communication with the remote server (using an ssh: repo URL) happens via an SSH
+connection. This can lead to some issues that would not occur during a local backup:
 
-::
+- Since Borg does not send data all the time, the connection may get closed, leading
+  to errors like "connection closed by remote".
+- On the other hand, network issues may lead to a dysfunctional connection
+  that is only detected after some time by the server, leading to stale ``borg serve``
+  processes and locked repositories.
 
-    # Server kills connection after 3*30 seconds without client response:
-    ClientAliveInterval 30
-    ClientAliveCountMax 3
+To fix such problems, please apply these :ref:`SSH settings <ssh_configuration>` so that
+keep-alive requests are sent regularly.
 
 How can I deal with my very unstable SSH connection?
 ----------------------------------------------------
@@ -642,33 +636,6 @@ could try to work around:
   to do any more. Due to the way borg mount works, this might be less efficient
   than borg extract for bigger volumes of data.
 
-Why do I get "connection closed by remote" after a while?
----------------------------------------------------------
-
-When doing a backup to a remote server (using a ssh: repo URL), it sometimes
-stops after a while (some minutes, hours, ... - not immediately) with
-"connection closed by remote" error message. Why?
-
-That's a good question and we are trying to find a good answer in :issue:`636`.
-
-Why am I seeing idle borg serve processes on the repo server?
--------------------------------------------------------------
-
-Maybe the ssh connection between client and server broke down and that was not
-yet noticed on the server. Try these settings:
-
-::
-
-    # /etc/ssh/sshd_config on borg repo server - kill connection to client
-    # after ClientAliveCountMax * ClientAliveInterval seconds with no response
-    ClientAliveInterval 20
-    ClientAliveCountMax 3
-
-If you have multiple borg create ... ; borg create ... commands in a already
-serialized way in a single script, you need to give them ``--lock-wait N`` (with N
-being a bit more than the time the server needs to terminate broken down
-connections and release the lock).
-
 Can I back up my root partition (/) with Borg?
 ----------------------------------------------
 

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/docs/man/borg-analyze.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-ANALYZE" 1 "2024-10-03" "" "borg backup tool"
+.TH "BORG-ANALYZE" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-analyze \- Analyze archives
 .SH SYNOPSIS

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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 "2024-10-03" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CPU" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-benchmark-cpu \- Benchmark CPU bound operations.
 .SH SYNOPSIS

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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-10-03" "" "borg backup tool"
+.TH "BORG-BENCHMARK-CRUD" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .SH SYNOPSIS

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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-10-03" "" "borg backup tool"
+.TH "BORG-BENCHMARK" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-benchmark \- benchmark command
 .SH SYNOPSIS

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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-10-03" "" "borg backup tool"
+.TH "BORG-BREAK-LOCK" 1 "2024-11-16" "" "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

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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-10-03" "" "borg backup tool"
+.TH "BORG-CHECK" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-check \- Check repository consistency
 .SH SYNOPSIS
@@ -44,19 +44,21 @@ the file magic headers, and both the metadata and data of all objects in
 the repository. The read data is checked by size and hash. Bit rot and other
 types of accidental damage can be detected this way. Running the repository
 check can be split into multiple partial checks using \fB\-\-max\-duration\fP\&.
-When checking a remote repository, please note that the checks run on the
-server and do not cause significant network traffic.
+When checking a \fI\%ssh://\fP remote repository, please note that the checks run on
+the server and do not cause significant network traffic.
 .IP 2. 3
 Checking consistency and correctness of the archive metadata and optionally
 archive data (requires \fB\-\-verify\-data\fP). This includes ensuring that the
 repository manifest exists, the archive metadata chunk is present, and that
 all chunks referencing files (items) in the archive exist. This requires
-reading archive and file metadata, but not data. To cryptographically verify
-the file (content) data integrity pass \fB\-\-verify\-data\fP, but keep in mind
-that this requires reading all data and is hence very time consuming. When
-checking archives of a remote repository, archive checks run on the client
-machine because they require decrypting data and therefore the encryption
-key.
+reading archive and file metadata, but not data. To scan for archives whose
+entries were lost from the archive directory, pass \fB\-\-find\-lost\-archives\fP\&.
+It requires reading all data and is hence very time consuming.
+To additionally cryptographically verify the file (content) data integrity,
+pass \fB\-\-verify\-data\fP, which is even more time consuming.
+.sp
+When checking archives of a remote repository, archive checks run on the client
+machine because they require decrypting data and therefore the encryption key.
 .UNINDENT
 .sp
 Both steps can also be run independently. Pass \fB\-\-repository\-only\fP to run the
@@ -88,6 +90,15 @@ cryptographic verification and hence very time consuming, but will detect any
 accidental and malicious corruption. Tamper\-resistance is only guaranteed for
 encrypted repositories against attackers without access to the keys. You can
 not use \fB\-\-verify\-data\fP with \fB\-\-repository\-only\fP\&.
+.sp
+The \fB\-\-find\-lost\-archives\fP option will also scan the whole repository, but
+tells Borg to search for lost archive metadata. If Borg encounters any archive
+metadata that doesn\(aqt match with an archive directory entry (including
+soft\-deleted archives), it means that an entry was lost.
+Unless \fBborg compact\fP is called, these archives can be fully restored with
+\fB\-\-repair\fP\&. Please note that \fB\-\-find\-lost\-archives\fP must read a lot of
+data from the repository and is thus very time consuming. You can not use
+\fB\-\-find\-lost\-archives\fP with \fB\-\-repository\-only\fP\&.
 .SS About repair mode
 .sp
 The check command is a readonly task by default. If any corruption is found,
@@ -150,10 +161,8 @@ chunks of a \(dqzero\-patched\(dq file reappear, this effectively \(dqheals\(dq
 Consequently, if lost chunks were repaired earlier, it is advised to run
 \fB\-\-repair\fP a second time after creating some new backups.
 .sp
-If \fB\-\-repair \-\-undelete\-archives\fP is given, Borg will scan the repository
-for archive metadata and if it finds some where no corresponding archives
-directory entry exists, it will create the entries. This is basically undoing
-\fBborg delete archive\fP or \fBborg prune ...\fP commands and only possible before
+If \fB\-\-repair \-\-find\-lost\-archives\fP is given, previously lost entries will
+be recreated in the archive directory. This is only possible before
 \fBborg compact\fP would remove the archives\(aq data completely.
 .SH OPTIONS
 .sp
@@ -173,8 +182,8 @@ perform cryptographic archive data integrity verification (conflicts with \fB\-\
 .B  \-\-repair
 attempt to repair any inconsistencies found
 .TP
-.B  \-\-undelete\-archives
-attempt to undelete archives (use with \-\-repair)
+.B  \-\-find\-lost\-archives
+attempt to find lost archives
 .TP
 .BI \-\-max\-duration \ SECONDS
 do only a partial repo check for max. SECONDS seconds (Default: unlimited)

{borgbackup-2.0.0b12 → borgbackup-2.0.0b14}/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-10-03" "" "borg backup tool"
+.TH "BORG-COMMON" 1 "2024-11-16" "" "borg backup tool"
 .SH NAME
 borg-common \- Common options of Borg commands
 .SH SYNOPSIS