Merge pull request #6790 from ThomasWaldmann/update-docs-borg2

borg2: update docs

docs/changes.rst

@@ -1,228 +1,127 @@
 .. _important_notes:
 
-Important notes
-===============
+Important notes 2.x
+===================
 
 This section provides information about security and corruption issues.
 
-.. _hashindex_set_bug:
+(nothing to see here yet)
 
-Pre-1.1.11 potential index corruption / data loss issue
--------------------------------------------------------
-
-A bug was discovered in our hashtable code, see issue #4829.
-The code is used for the client-side chunks cache and the server-side repo index.
-
-Although borg uses the hashtables very heavily, the index corruption did not
-happen too frequently, because it needed specific conditions to happen.
-
-Data loss required even more specific conditions, so it should be rare (and
-also detectable via borg check).
-
-You might be affected if borg crashed with / complained about:
-
-- AssertionError: Corrupted segment reference count - corrupted index or hints
-- ObjectNotFound: Object with key ... not found in repository ...
-- Index mismatch for key b'...'. (..., ...) != (-1, -1)
-- ValueError: stats_against: key contained in self but not in master_index.
-
-Advised procedure to fix any related issue in your indexes/caches:
-
-- install fixed borg code (on client AND server)
-- for all of your clients and repos remove the cache by:
-
-  borg delete --cache-only YOURREPO
-
-  (later, the cache will be re-built automatically)
-- for all your repos, rebuild the repo index by:
-
-  borg check --repair YOURREPO
-
-  This will also check all archives and detect if there is any data-loss issue.
-
-Affected branches / releases:
-
-- fd06497 introduced the bug into 1.1-maint branch - it affects all borg 1.1.x since 1.1.0b4.
-- fd06497 introduced the bug into master branch - it affects all borg 1.2.0 alpha releases.
-- c5cd882 introduced the bug into 1.0-maint branch - it affects all borg 1.0.x since 1.0.11rc1.
-
-The bug was fixed by:
-
-- 701159a fixes the bug in 1.1-maint branch - will be released with borg 1.1.11.
-- fa63150 fixes the bug in master branch - will be released with borg 1.2.0a8.
-- 7bb90b6 fixes the bug in 1.0-maint branch. Branch is EOL, no new release is planned as of now.
-
-.. _broken_validator:
-
-Pre-1.1.4 potential data corruption issue
------------------------------------------
-
-A data corruption bug was discovered in borg check --repair, see issue #3444.
-
-This is a 1.1.x regression, releases < 1.1 (e.g. 1.0.x) are not affected.
-
-To avoid data loss, you must not run borg check --repair using an unfixed version
-of borg 1.1.x. The first official release that has the fix is 1.1.4.
-
-Package maintainers may have applied the fix to updated packages of 1.1.x (x<4)
-though, see the package maintainer's package changelog to make sure.
-
-If you never had missing item metadata chunks, the bug has not affected you
-even if you did run borg check --repair with an unfixed version.
-
-When borg check --repair tried to repair corrupt archives that miss item metadata
-chunks, the resync to valid metadata in still present item metadata chunks
-malfunctioned. This was due to a broken validator that considered all (even valid)
-item metadata as invalid. As they were considered invalid, borg discarded them.
-Practically, that means the affected files, directories or other fs objects were
-discarded from the archive.
-
-Due to the malfunction, the process was extremely slow, but if you let it
-complete, borg would have created a "repaired" archive that has lost a lot of items.
-If you interrupted borg check --repair because it was so strangely slow (killing
-borg somehow, e.g. Ctrl-C) the transaction was rolled back and no corruption occurred.
-
-The log message indicating the precondition for the bug triggering looks like:
-
-    item metadata chunk missing [chunk: 001056_bdee87d...a3e50d]
-
-If you never had that in your borg check --repair runs, you're not affected.
-
-But if you're unsure or you actually have seen that, better check your archives.
-By just using "borg list repo::archive" you can see if all expected filesystem
-items are listed.
-
-.. _tam_vuln:
-
-Pre-1.0.9 manifest spoofing vulnerability (CVE-2016-10099)
-----------------------------------------------------------
-
-A flaw in the cryptographic authentication scheme in Borg allowed an attacker
-to spoof the manifest. The attack requires an attacker to be able to
-
-1. insert files (with no additional headers) into backups
-2. gain write access to the repository
-
-This vulnerability does not disclose plaintext to the attacker, nor does it
-affect the authenticity of existing archives.
-
-The vulnerability allows an attacker to create a spoofed manifest (the list of archives).
-Creating plausible fake archives may be feasible for small archives, but is unlikely
-for large archives.
-
-The fix adds a separate authentication tag to the manifest. For compatibility
-with prior versions this authentication tag is *not* required by default
-for existing repositories. Repositories created with 1.0.9 and later require it.
-
-Steps you should take:
-
-1. Upgrade all clients to 1.0.9 or later.
-2. Run ``borg upgrade --tam <repository>`` *on every client* for *each* repository.
-3. This will list all archives, including archive IDs, for easy comparison with your logs.
-4. Done.
-
-Prior versions can access and modify repositories with this measure enabled, however,
-to 1.0.9 or later their modifications are indiscernible from an attack and will
-raise an error until the below procedure is followed. We are aware that this can
-be annoying in some circumstances, but don't see a way to fix the vulnerability
-otherwise.
-
-In case a version prior to 1.0.9 is used to modify a repository where above procedure
-was completed, and now you get an error message from other clients:
-
-1. ``borg upgrade --tam --force <repository>`` once with *any* client suffices.
-
-This attack is mitigated by:
-
-- Noting/logging ``borg list``, ``borg info``, or ``borg create --stats``, which
-  contain the archive IDs.
+.. _changelog:
 
-We are not aware of others having discovered, disclosed or exploited this vulnerability.
+Change Log 2.x
+==============
 
-Vulnerability time line:
+Version 2.0.0a2 (not released yet)
+----------------------------------
 
-* 2016-11-14: Vulnerability and fix discovered during review of cryptography by Marian Beermann (@enkore)
-* 2016-11-20: First patch
-* 2016-12-20: Released fixed version 1.0.9
-* 2017-01-02: CVE was assigned
-* 2017-01-15: Released fixed version 1.1.0b3 (fix was previously only available from source)
+Please note:
 
-.. _attic013_check_corruption:
+This is an alpha release, only for testing - do not use for production repos.
 
-Pre-1.0.9 potential data loss
------------------------------
+Compatibility notes:
 
-If you have archives in your repository that were made with attic <= 0.13
-(and later migrated to borg), running borg check would report errors in these
-archives. See issue #1837.
+- this is a major "breaking" release that is not compatible with existing repos.
 
-The reason for this is a invalid (and useless) metadata key that was
-always added due to a bug in these old attic versions.
+  We tried to put all the necessary "breaking" changes into this release, so we
+  hopefully do not need another breaking release in the near future. The changes
+  were necessary for improved security, improved speed, unblocking future
+  improvements, getting rid of legacy crap / design limitations, having less and
+  simpler code to maintain.
 
-If you run borg check --repair, things escalate quickly: all archive items
-with invalid metadata will be killed. Due to that attic bug, that means all
-items in all archives made with these old attic versions.
+  You can use "borg transfer" to transfer archives from borg 1.1/1.2 repos to
+  a new borg 2.0 repo, but it will need some time and space.
 
+- command line syntax was changed, scripts and wrappers will need changes:
 
-Pre-1.0.4 potential repo corruption
------------------------------------
+  - you will usually either export BORG_REPO=<MYREPO> into your environment or
+    call borg like: borg -r <MYREPO> command (-r ... usually omitted 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:
 
-Some external errors (like network or disk I/O errors) could lead to
-corruption of the backup repository due to issue #1138.
+    - borg create myarchive2 /some/path
+    - borg diff myarchive1 myarchive2
+  - or, if the command makes sense for an arbitrary amount of archives, archives
+    can be selected using a glob pattern, like:
 
-A sign that this happened is if "E" status was reported for a file that can
-not be explained by problems with the source file. If you still have logs from
-"borg create -v --list", you can check for "E" status.
+    - borg delete -a 'myarchive*'
+    - borg recreate -a 'myarchive*'
+  - some borg 1.x commands that supported working on a repo AND on an archive
+    were split into 2 commands, some others were renamed:
 
-Here is what could cause corruption and what you can do now:
+    - borg 2 repo commands:
 
-1) I/O errors (e.g. repo disk errors) while writing data to repo.
+      - borg rcreate  # "repo create", was: borg init
+      - borg rlist  # "repo list"
+      - borg rinfo  # "repo info"
+      - borg rdelete  # "repo delete"
 
-This could lead to corrupted segment files.
+    - borg 2 archive commands:
 
-Fix::
+      - borg create ARCHIVE ...
+      - borg list ARCHIVE
+      - borg info -a ARCH_GLOB
+      - borg delete -a ARCH_GLOB
+      - borg diff ARCH1 ARCH2
+      - borg extract ARCHIVE ...
+      - borg recreate -a ARCH_GLOB ...
+      - borg rename OLDNAME NEWNAME
+      - borg mount -a ARCH_GLOB mountpoint ...
 
-    # check for corrupt chunks / segments:
-    borg check -v --repository-only REPO
+    For more details, please consult the docs or --help option output.
 
-    # repair the repo:
-    borg check -v --repository-only --repair REPO
+Changes:
 
-    # make sure everything is fixed:
-    borg check -v --repository-only REPO
+- split repo and archive name into separate args, #948
 
-2) Unreliable network / unreliable connection to the repo.
+  - 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`
 
-This could lead to archive metadata corruption.
+- remove support for scp-style repo specification, use ssh://...
+- simplify stats output: repo ops -> repo stats, archive ops -> archive stats
 
-Fix::
+- 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
 
-    # check for corrupt archives:
-    borg check -v --archives-only REPO
+- 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)
 
-    # delete the corrupt archives:
-    borg delete --force REPO::CORRUPT_ARCHIVE
+- replace problematic/ugly hardlink_master approach of borg 1.x by:
 
-    # make sure everything is fixed:
-    borg check -v --archives-only REPO
+  - symmetric hlid (all hardlinks pointing to same inode have same hlid)
+  - all archived hardlinked regular files have a chunks list
 
-3) In case you want to do more intensive checking.
+- borg init --other-repo=OTHER_REPO: reuse key material from OTHER_REPO, #6554
+- borg transfer:
 
-The best check that everything is ok is to run a dry-run extraction::
+  - efficiently copy archives from borg 1.1/1.2 repo to new repo. uses
+    deduplication and does not decompress/recompress file content data.
+  - does some cleanups / fixes / conversions:
 
-    borg extract -v --dry-run REPO::ARCHIVE
+    - disallow None value for .user/group/chunks/chunks_healthy
+    - cleanup msgpack related str/bytes mess, use new msgpack spec, #968
+    - obfuscation: fix byte order for size, #6701
+    - compression: use the 2 bytes for type and level, #6698
+    - use version 2 for new archives
+    - convert timestamps int/bigint -> msgpack.Timestamp, see #2323
+    - all hardlinks have chunks, maybe chunks_healty, hlid
+    - remove the zlib type bytes hack
+    - make sure items with chunks have precomputed size
+    - clean item of attic 0.13 'acl' bug remnants
 
-.. _changelog:
+- crypto: see 1.3.0a1 log entry
 
-Change Log
-==========
 
 Version 1.3.0a1 (2022-04-15)
 ----------------------------
 
-Please note:
-
-This is an alpha release, only for testing - do not use this with production repos.
+Although this was released as 1.3.0a1, it can be also seen as 2.0.0a1 as it was
+later decided to do breaking changes and thus the major release number had to
+be increased (thus, there will not be a 1.3.0 release, but 2.0.0).
 
 New features:
 
@@ -261,4906 +160,3 @@ Other changes:
 - OpenBSD: build borg with OpenSSL (not: LibreSSL), #6474
 - remove support for LibreSSL, #6474
 - remove support for OpenSSL < 1.1.1
-
-
-Version 1.2.0 (2022-02-22 22:02:22 :-)
---------------------------------------
-
-Please note:
-
-This is the first borg 1.2 release, so be careful and read the notes below.
-
-Upgrade notes:
-
-Strictly taken, nothing special is required for upgrading to 1.2, but some
-things can be recommended:
-
-- do you already want to upgrade? 1.1.x also will get fixes for a while.
-- be careful, first upgrade your less critical / smaller repos.
-- first upgrade to a recent 1.1.x release - especially if you run some older
-  1.1.* or even 1.0.* borg release.
-- using that, run at least one `borg create` (your normal backup), `prune`
-  and especially a `check` to see everything is in a good state.
-- check the output of `borg check` - if there is anything special, consider
-  a `borg check --repair` followed by another `borg check`.
-- if everything is fine so far (borg check reports no issues), you can consider
-  upgrading to 1.2.0. if not, please first fix any already existing issue.
-- if you want to play safer, first **create a backup of your borg repository**.
-- upgrade to latest borg 1.2.x release (you could use the fat binary from
-  github releases page)
-- run `borg compact --cleanup-commits` to clean up a ton of 17 bytes long files
-  in your repo caused by a borg 1.1 bug
-- run `borg check` again (now with borg 1.2.x) and check if there is anything
-  special.
-- run `borg info` (with borg 1.2.x) to build the local pre12-meta cache (can
-  take significant time, but after that it will be fast) - for more details
-  see below.
-- check the compatibility notes (see below) and adapt your scripts, if needed.
-- if you run into any issues, please check the github issue tracker before
-  posting new issues there or elsewhere.
-
-If you follow this procedure, you can help avoiding that we get a lot of
-"borg 1.2" issue reports that are not really 1.2 issues, but existed before
-and maybe just were not noticed.
-
-Compatibility notes:
-
-- matching of path patterns has been aligned with borg storing relative paths.
-  Borg archives file paths without leading slashes. Previously, include/exclude
-  patterns could contain leading slashes. You should check your patterns and
-  remove leading slashes.
-- dropped support / testing for older Pythons, minimum requirement is 3.8.
-  In case your OS does not provide Python >= 3.8, consider using our binary,
-  which does not need an external Python interpreter. Or continue using
-  borg 1.1.x, which is still supported.
-- freeing repository space only happens when "borg compact" is invoked.
-- mount: the default for --numeric-ids is False now (same as borg extract)
-- borg create --noatime is deprecated. Not storing atime is the default behaviour
-  now (use --atime if you want to store the atime).
-- list: corrected mix-up of "isomtime" and "mtime" formats.
-  Previously, "isomtime" was the default but produced a verbose human format,
-  while "mtime" produced a ISO-8601-like format.
-  The behaviours have been swapped (so "mtime" is human, "isomtime" is ISO-like),
-  and the default is now "mtime".
-  "isomtime" is now a real ISO-8601 format ("T" between date and time, not a space).
-- create/recreate --list: file status for all files used to get announced *AFTER*
-  the file (with borg < 1.2). Now, file status is announced *BEFORE* the file
-  contents are processed. If the file status changes later (e.g. due to an error
-  or a content change), the updated/final file status will be printed again.
-- removed deprecated-since-long stuff (deprecated since):
-
-  - command "borg change-passphrase" (2017-02), use "borg key ..."
-  - option "--keep-tag-files" (2017-01), use "--keep-exclude-tags"
-  - option "--list-format" (2017-10), use "--format"
-  - option "--ignore-inode" (2017-09), use "--files-cache" w/o "inode"
-  - option "--no-files-cache" (2017-09), use "--files-cache=disabled"
-- removed BORG_HOSTNAME_IS_UNIQUE env var.
-  to use borg you must implement one of these 2 scenarios:
-
-  - 1) the combination of FQDN and result of uuid.getnode() must be unique
-       and stable (this should be the case for almost everybody, except when
-       having duplicate FQDN *and* MAC address or all-zero MAC address)
-  - 2) if you are aware that 1) is not the case for you, you must set
-       BORG_HOST_ID env var to something unique.
-- exit with 128 + signal number, #5161.
-  if you have scripts expecting rc == 2 for a signal exit, you need to update
-  them to check for >= 128.
-
-Fixes:
-
-- diff: reduce memory consumption, fix is_hardlink_master, #6295
-- compact: fix / improve freeable / freed space log output
-
-  - derive really freed space from quota use before/after, #5679
-  - do not say "freeable", but "maybe freeable" (based on hint, unsure)
-- fix race conditions in internal SaveFile function, #6306 #6028
-- implement internal safe_unlink (was: truncate_and_unlink) function more safely:
-  usually it does not truncate any more, only under "disk full" circumstances
-  and only if there is only one hardlink.
-  see: https://github.com/borgbackup/borg/discussions/6286
-
-Other changes:
-
-- info: use a pre12-meta cache to accelerate stats for borg < 1.2 archives.
-  the first time borg info is invoked on a borg 1.1 repo, it can take a
-  rather long time computing and caching some stats values for 1.1 archives,
-  which borg 1.2 archives have in their archive metadata structure.
-  be patient, esp. if you have lots of old archives.
-  following invocations are much faster due to the cache.
-  related change: add archive name to calc_stats progress display.
-- docs:
-
-  - add borg 1.2 upgrade notes, #6217
-  - link to borg placeholders and borg patterns help
-  - init: explain the encryption modes better
-  - clarify usage of patternfile roots
-  - put import-tar docs into same file as export-tar docs
-  - explain the difference between a path that ends with or without a slash,
-    #6297
-
-
-Version 1.2.0rc1 (2022-02-05)
------------------------------
-
-Fixes:
-
-- repo::archive location placeholder expansion fixes, #5826, #5998
-- repository: fix intermediate commits, shall be at end of current segment
-- delete: don't commit if nothing was deleted, avoid cache sync, #6060
-- argument parsing: accept some options only once, #6026
-- disallow overwriting of existing keyfiles on init, #6036
-- if ensure_dir() fails, give more informative error message, #5952
-
-New features:
-
-- delete --force: do not ask when deleting a repo, #5941
-
-Other changes:
-
-- requirements: exclude broken or incompatible-with-pyinstaller setuptools
-- add a requirements.d/development.lock.txt and use it for vagrant
-- tests:
-
-  - added nonce-related tests
-  - refactor: remove assert_true
-  - vagrant: macos box tuning, netbsd box fixes, #5370, #5922
-- docs:
-
-  - update install docs / requirements docs, #6180
-  - borg mount / FUSE "versions" view is not experimental any more
-  - --pattern* is not experimental any more, #6134
-  - impact of deleting path/to/repo/nonce, #5858
-  - key export: add examples, #6204
-  - ~/.config/borg/keys is not used for repokey keys, #6107
-  - excluded parent dir's metadata can't restore
-
-
-Version 1.2.0b4 (2022-01-23)
-----------------------------
-
-Fixes:
-
-- create: fix passing device nodes and symlinks to --paths-from-stdin, #6009
-- create --dry-run: fix display of kept tagfile, #5834
-- check --repair: fix missing parameter in "did not consistently fail" msg, #5822
-- fix hardlinkable file type check, #6037
-- list: remove placeholders for shake_* hashes, #6082
-- prune: handle case of calling prune_split when there are no archives, #6015
-- benchmark crud: make sure cleanup of borg-test-data files/dir happens, #5630
-- do not show archive name in repository-related error msgs, #6014
-- prettier error msg (no stacktrace) if exclude file is missing, #5734
-- do not require BORG_CONFIG_DIR if BORG_{SECURITY,KEYS}_DIR are set, #5979
-- fix pyinstaller detection for dir-mode, #5897
-- atomically create the CACHE_TAG file, #6028
-- deal with the SaveFile/SyncFile race, docs, see #6056 708a5853
-- avoid expanding path into LHS of formatting operation + tests, #6064 #6063
-- repository: quota / compactable computation fixes
-- info: emit repo info even if repo has 0 archives + test, #6120
-
-New features:
-
-- check --repair: significantly speed up search for next valid object in segment, #6022
-- check: add progress indicator for archive check, #5809
-- create: add retry_erofs workaround for O_NOATIME issue on volume shadow copies in WSL1, #6024
-- create: allow --files-cache=size (this is potentially dangerous, use on your own risk), #5686
-- import-tar: implement import-tar to complement export-tar, #2233
-- implement BORG_SELFTEST env variable (can be carefully used to speedup borg hosting), #5871
-- key export: print key if path is '-' or not given, #6092
-- list --format: Add command_line to format keys
-
-Other changes:
-
-- pypi metadata: alpha -> beta
-- require python 3.8+, #5975
-- use pyinstaller 4.7
-- allow msgpack 1.0.3
-- upgrade to bundled xxhash to 0.8.1
-- import-tar / export-tar: tar file related changes:
-
-  - check for short tarfile extensions
-  - add .lz4 and .zstd
-  - fix docs about extensions and decompression commands
-- add github codeql analysis, #6148
-- vagrant:
-
-  - box updates / add new boxes / remove outdated and broken boxes
-  - use Python 3.9.10 (incl. binary builds) and 3.10.0
-  - fix pyenv initialisation, #5798
-  - fix vagrant scp on macOS, #5921
-  - use macfuse instead of osxfuse
-- shell completions:
-
-  - update shell completions to 1.1.17, #5923
-  - remove BORG_LIBC completion, since 9914968 borg no longer uses find_library().
-- docs:
-
-  - fixed readme.rst irc webchat link (we use libera chat now, not freenode)
-  - fix exceptions thrown by `setup.py build_man`
-  - check --repair: recommend checking hw before check --repair, #5855
-  - check --verify-data: clarify and document conflict with --repository-only, #5808
-  - serve: improve ssh forced commands docs, #6083
-  - list: improve docs for `borg list` --format, #6061
-  - list: remove --list-format from borg list
-  - FAQ: fix manifest-timestamp path (inside security dir)
-  - fix the broken link to .nix file
-  - document behavior for filesystems with inconsistent inodes, #5770
-  - clarify user_id vs uid for fuse, #5723
-  - clarify pattern usage with commands, #5176
-  - clarify pp vs. pf pattern type, #5300
-  - update referenced freebsd/macOS versions used for binary build, #5942
-  - pull mode: add some warnings, #5827
-  - clarify "you will need key and passphrase" borg init warning, #4622
-  - add missing leading slashes in help patterns, #5857
-  - add info on renaming repositories, #5240
-  - check: add notice about defective hardware, #5753
-  - mention tar --compare (compare archive to fs files), #5880
-  - add note about grandfather-father-son backup retention policy / rotation scheme, #6006
-  - permissions note rewritten to make it less confusing
-  - create github security policy
-  - remove leftovers of BORG_HOSTNAME_IS_UNIQUE
-  - excluded parent dir's metadata can't restore. (#6062)
-  - if parent dir is not extracted, we do not have its metadata
-  - clarify who starts the remote agent
-
-
-Version 1.2.0b3 (2021-05-12)
-----------------------------
-
-Fixes:
-
-- create: fix --progress --log-json, #4360#issuecomment-774580052
-- do not load files cache for commands not using it, #5673
-- fix repeated cache tag file writing bug
-
-New features:
-
-- create/recreate: print preliminary file status early, #5417
-- create/extract: add --noxattrs and --noacls options, #3955
-- create: verbose files cache logging via --debug-topic=files_cache, #5659
-- mount: implement --numeric-ids (default: False!), #2377
-- diff: add --json-lines option
-- info / create --stats: add --iec option to print sizes in powers of 1024.
-
-Other changes:
-
-- create: add --upload-(ratelimit|buffer), deprecate --remote-* options, #5611
-- create/extract/mount: add --numeric-ids, deprecate --numeric-owner option, #5724
-- config: accept non-int value for max_segment_size / storage_quota
-- use PyInstaller v4.3, #5671
-- vagrant: use Python 3.9.5 to build binaries
-- tox.ini: modernize and enable execution without preinstalling deps
-- cleanup code style checks
-- get rid of distutils, use setuptools+packaging
-- github CI: test on Python 3.10-dev
-- check: missing / healed chunks: always tell chunk ID, #5704
-- docs:
-
-  - remove bad /var/cache exclusion in example commands, #5625
-  - misc. fixes and improvements, esp. for macOS
-  - add unsafe workaround to use an old repo copy, #5722
-
-
-Version 1.2.0b2 (2021-02-06)
-----------------------------
-
-Fixes:
-
-- create: do not recurse into duplicate roots, #5603
-- create: only print stats if not ctrl-c'ed, fixes traceback, #5668
-- extract:
-  improve exception handling when setting xattrs, #5092.
-  emit a warning message giving the path, xattr key and error message.
-  continue trying to restore other xattrs and bsdflags of the same file
-  after an exception with xattr-setting happened.
-- export-tar:
-  fix memory leak with ssh: remote repository, #5568.
-  fix potential memory leak with ssh: remote repository with partial extraction.
-- remove empty shadowed_segments lists, #5275
-- fix bad default: manifest.archives.list(consider_checkpoints=False),
-  fixes tracebacks / KeyErros for missing objects in ChunkIndex, #5668
-
-New features:
-
-- create: improve sparse file support
-
-  - create --sparse (detect sparse file holes) and file map support,
-    only for the "fixed" chunker, #14
-  - detect all-zero chunks in read data in "buzhash" and "fixed" chunkers
-  - cached_hash: use a small LRU cache to accelerate all-zero chunks hashing
-  - use cached_hash also to generate all-zero replacement chunks
-- create --remote-buffer, add a upload buffer for remote repos, #5574
-- prune: keep oldest archive when retention target not met
-
-Other changes:
-
-- use blake2 from python 3.6+ hashlib
-  (this removes the requirement for libb2 and the bundled blake2 code)
-- also accept msgpack up to 1.0.2.
-  exclude 1.0.1 though, which had some issues (not sure they affect borg).
-- create: add repository location to --stats output, #5491
-- check: debug log the segment filename
-- delete: add a --list switch to borg delete, #5116
-- borg debug dump-hints - implemented to e.g. to look at shadow_index
-- Tab completion support for additional archives for 'borg delete'
-- refactor: have one borg.constants.zero all-zero bytes object
-- refactor shadow_index updating repo.put/delete, #5661, #5636.
-- docs:
-
-  - add another case of attempted hardlink usage
-  - fix description of borg upgrade hardlink usage, #5518
-  - use HTTPS everywhere
-  - add examples for --paths-from-stdin, --paths-from-command, --paths-separator, #5644
-  - fix typos/grammar
-  - update docs for dev environment installation instructions
-  - recommend running tests only on installed versions for setup
-  - add badge with current status of package
-- vagrant:
-
-  - use brew install --cask ..., #5557
-  - use Python 3.9.1 and PyInstaller 4.1 to build the borg binary
-
-
-Version 1.2.0b1 (2020-12-06)
-----------------------------
-
-Fixes:
-
-- BORG_CACHE_DIR crashing borg if empty, atomic handling of
-  recursive directory creation, #5216
-- fix --dry-run and --stats coexistence, #5415
-- allow EIO with warning when trying to hardlink, #4336
-- export-tar: set tar format to GNU_FORMAT explicitly, #5274
-- use --timestamp for {utcnow} and {now} if given, #5189
-- make timestamp helper timezone-aware
-
-New features:
-
-- create: implement --paths-from-stdin and --paths-from-command, see #5492.
-  These switches read paths to archive from stdin. Delimiter can specified
-  by --paths-delimiter=DELIM. Paths read will be added honoring every
-  option but exclusion options and --one-file-system. borg won't recurse
-  into directories.
-- 'obfuscate' pseudo compressor obfuscates compressed chunk size in repo
-- add pyfuse3 (successor of llfuse) as an alternative lowlevel fuse
-  implementation to llfuse (deprecated), #5407.
-  FUSE implementation can be switched via env var BORG_FUSE_IMPL.
-- allow appending to the files cache filename with BORG_FILES_CACHE_SUFFIX
-- create: implement --stdin-mode, --stdin-user and --stdin-group, #5333
-
-Other changes:
-
-- split recursive directory walking/processing into directory walking and
-  item processing.
-- fix warning by importing setuptools before distutils.
-- debug info: include infos about FUSE implementation, #5546
-- testing:
-
-  - add a test for the hashindex corruption bug, #5531 #4829
-  - move away from travis-ci, use github actions, #5528 #5467
-  - test both on fuse2 and fuse3
-  - upload coverage reports to codecov
-  - fix spurious failure in test_cache_files, #5438
-  - add tests for Location.with_timestamp
-  - tox: add a non-fuse env to the envlist
-- vagrant:
-
-  - use python 3.7.latest and pyinstaller 4.0 for binary creation
-  - pyinstaller: compute basepath from spec file location
-  - vagrant: updates/fixes for archlinux box, #5543
-- docs:
-
-  - "filename with spaces" example added to exclude file, #5236
-  - add a hint about sleeping computer, #5301
-  - how to adjust macOS >= Catalina security settings, #5303
-  - process/policy for adding new compression algorithms
-  - updated docs about hacked backup client, #5480
-  - improve ansible deployment docs, make it more generic
-  - how to approach borg speed issues, give speed example, #5371
-  - fix mathematical inaccuracy about chunk size, #5336
-  - add example for excluding content using --pattern cli option
-  - clarify borg create's '--one-file-system' option, #4009
-  - improve docs/FAQ about append-only remote repos, #5497
-  - fix reST markup issues, labels
-  - add infos about contributor retirement status
-
-
-Version 1.2.0a9 (2020-10-05)
-----------------------------
-
-Fixes:
-
-- fix memory leak related to preloading, #5202
-- check --repair: fix potential data loss, #5325
-- persist shadow_index in between borg runs, #4830
-- fix hardlinked CACHEDIR.TAG processing, #4911
-- --read-special: .part files also should be regular files, #5217
-- allow server side enforcing of umask, --umask is for the local borg
-  process only (see docs), #4947
-- exit with 128 + signal number, #5161
-- borg config --list does not show last_segment_checked, #5159
-- locking:
-
-  - fix ExclusiveLock race condition bug, #4923
-  - fix race condition in lock migration, #4953
-  - fix locking on openindiana, #5271
-
-New features:
-
-- --content-from-command: create archive using stdout of given command, #5174
-- allow key-import + BORG_KEY_FILE to create key files
-- build directory-based binary for macOS to avoid Gatekeeper delays
-
-Other changes:
-
-- upgrade bundled zstd to 1.4.5
-- upgrade bundled xxhash to 0.8.0, #5362
-- if self test fails, also point to OS and hardware, #5334
-- misc. shell completions fixes/updates, rewrite zsh completion
-- prettier error message when archive gets too big, #5307
-- stop relying on `false` exiting with status code 1
-- rephrase some warnings, #5164
-- parseformat: unnecessary calls removed, #5169
-- testing:
-
-  - enable Python3.9 env for test suite and VMs, #5373
-  - drop python 3.5, #5344
-  - misc. vagrant fixes/updates
-  - misc. testing fixes, #5196
-- docs:
-
-  - add ssh-agent pull backup method to doc, #5288
-  - mention double --force in prune docs
-  - update Homebrew install instructions, #5185
-  - better description of how cache and rebuilds of it work
-    and how the workaround applies to that
-  - point to borg create --list item flags in recreate usage, #5165
-  - add a note to create from stdin regarding files cache, #5180
-  - add security faq explaining AES-CTR crypto issues, #5254
-  - clarify --exclude-if-present in recreate, #5193
-  - add socat pull mode, #5150, #900
-  - move content of resources doc page to community project, #2088
-  - explain hash collision, #4884
-  - clarify --recompress option, #5154
-
-
-Version 1.2.0a8 (2020-04-22)
-----------------------------
-
-Fixes:
-
-- fixed potential index corruption / data loss issue due to bug in hashindex_set, #4829.
-  Please read and follow the more detailed notes close to the top of this document.
-- fix crash when upgrading erroneous hints file, #4922
-- commit-time free space calc: ignore bad compact map entries, #4796
-- info: if the archive doesn't exist, print a pretty message, #4793
-- --prefix / -P: fix processing, avoid argparse issue, #4769
-- ignore EACCES (errno 13) when hardlinking, #4730
-- add a try catch when formatting the info string, #4818
-- check: do not stumble over invalid item key, #4845
-- update prevalence of env vars to set config and cache paths
-- mount: fix FUSE low linear read speed on large files, #5032
-- extract: fix confusing output of borg extract --list --strip-components, #4934
-- recreate: support --timestamp option, #4745
-- fix ProgressIndicator msgids (JSON output), #4935
-- fuse: set f_namemax in statfs result, #2684
-- accept absolute paths on windows
-- pyinstaller: work around issue with setuptools > 44
-
-New features:
-
-- chunker speedup (plus regression test)
-- added --consider-checkpoints and related test, #4788
-- added --noflags option, deprecate --nobsdflags option, #4489
-- compact: add --threshold option, #4674
-- mount: add birthtime to FUSE entries
-- support platforms with no os.link, #4901 - if we don't have os.link,
-  we just extract another copy instead of making a hardlink.
-- move sync_file_range to its own extension for better platform compatibility.
-- new --bypass-lock option to bypass locking, e.g. for read-only repos
-- accept absolute paths by removing leading slashes in patterns of all
-  sorts but re: style, #4029
-- delete: new --keep-security-info option
-
-Other changes:
-
-- support msgpack 0.6.2 and 1.0.0, #5065
-- upgrade bundled zstd to 1.4.4
-- upgrade bundled lz4 to 1.9.2
-- upgrade xxhash to 0.7.3
-- require recent enough llfuse for birthtime support, #5064
-- only store compressed data if the result actually is smaller, #4516
-- check: improve error output for matching index size, see #4829
-- ignore --stats when given with --dry-run, but continue, #4373
-- replaced usage of os.statvfs with shutil.disk_usage (better cross-platform support).
-- fuse: remove unneeded version check and compat code, micro opts
-- docs:
-
-  - improve description of path variables
-  - document how to completely delete data, #2929
-  - add FAQ about Borg config dir, #4941
-  - add docs about errors not printed as JSON, #4073
-  - update usage_general.rst.inc
-  - added "Will move with BORG_CONFIG_DIR variable unless specified." to BORG_SECURITY_DIR info.
-  - put BORG_SECURITY_DIR immediately below BORG_CONFIG_DIR (and moved BORG_CACHE_DIR up before them).
-  - add paragraph regarding cache security assumptions, #4900
-  - tell about borg cache security precautions
-  - add FAQ describing difference between a local repo vs. repo on a server.
-  - document how to test exclusion patterns without performing an actual backup
-  - create: tell that "Calculating size" time and space needs are caused by --progress
-  - fix/improve documentation for @api decorator, #4674
-  - add a pull backup / push restore how-to, #1552
-  - fix man pages creation, #4752
-  - more general FAQ for backup and retain original paths, #4532
-  - explain difference between --exclude and --pattern, #4118
-  - add FAQ for preventing SSH timeout in extract, #3866
-  - improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap), #4591
-  - add note about patterns and stored paths, #4160
-  - add upgrade of tools to pip installation how-to, #5090
-  - document one cause of orphaned chunks in check command, #2295
-  - clean up the whole check usage paragraph
-  - FAQ: linked recommended restrictions to ssh public keys on borg servers, #4946
-  - fixed "doc downplays severity of Nonce reuse issue", #4883
-  - borg repo restore instructions needed, #3428
-  - new FAQ: A repo is corrupt and must be replaced with an older repo.
-  - clarify borg init's encryption modes
-- native windows port:
-
-  - update README_WINDOWS.rst
-  - updated pyinstaller spec file to support windows builds
-- testing / CI:
-
-  - improved travis config / install script, improved macOS builds
-  - allow osx builds to fail, #4955
-  - Windows 10 build on Appveyor CI
-- vagrant:
-
-  - upgrade pyinstaller to v3.5 + patch
-  - use py369 for binary build, add py380 for tests
-  - fix issue in stretch VM hanging at grub installation
-  - add a debian buster and a ubuntu focal VM
-  - update darwin box to 10.12
-  - upgrade FreeBSD box to 12.1
-  - fix debianoid virtualenv packages
-  - use pyenv in freebsd64 VM
-  - remove the flake8 test
-  - darwin: avoid error if pkg is already installed
-  - debianoid: don't interactively ask questions
-
-
-Version 1.2.0a7 (2019-09-07)
-----------------------------
-
-Fixes:
-
-- slave hardlinks extraction issue, see #4350
-- extract: fix KeyError for "partial" extraction, #4607
-- preload chunks for hardlink slaves w/o preloaded master, #4350
-- fix preloading for old remote servers, #4652
-- fix partial extract for hardlinked contentless file types, #4725
-- Repository.open: use stat() to check for repo dir, #4695
-- Repository.check_can_create_repository: use stat() to check, ~ #4695.
-- SecurityManager.known(): check all files, #4614
-- after double-force delete, warn about necessary repair, #4704
-- cope with ANY error when importing pytest into borg.testsuite, #4652
-- fix invalid archive error message
-- setup.py: fix detection of missing Cython
-- filter out selinux xattrs, #4574
-- location arg - should it be optional? #4541
-- enable placeholder usage in --comment, #4559
-- use whitelist approach for borg serve, #4097
-
-New features:
-
-- minimal native Windows support, see windows readme (work in progress)
-- create: first ctrl-c (SIGINT) triggers checkpoint and abort, #4606
-- new BORG_WORKAROUNDS mechanism, basesyncfile, #4710
-- remove WSL autodetection. if WSL still has this problem, you need to
-  set BORG_WORKAROUNDS=basesyncfile in the borg process environment to
-  work around it.
-- support xxh64 checksum in addition to the hashlib hashes in borg list
-- enable placeholder usage in all extra archive arguments
-- enable placeholder usage in --comment, #4559
-- enable placeholder usage in --glob-archives, #4495
-- ability to use a system-provided version of "xxhash"
-- create:
-
-  - changed the default behaviour to not store the atime of fs items. atime is
-    often rather not interesting and fragile - it easily changes even if nothing
-    else has changed and, if stored into the archive, spoils deduplication of
-    the archive metadata stream.
-  - if you give the --noatime option, borg will output a deprecation warning
-    because it is currently ignored / does nothing.
-    Please remove the --noatime option when using borg 1.2.
-  - added a --atime option for storing files' atime into an archive
-
-Other changes:
-
-- argparser: always use REPOSITORY in metavar
-- do not check python/libc for borg serve, #4483
-- small borg compact improvements, #4522
-- compact: log freed space at INFO level
-- tests:
-
-  - tox / travis: add testing on py38-dev
-  - fix broken test that relied on improper zlib assumptions
-  - pure-py msgpack warning shall not make a lot of tests fail, #4558
-  - rename test_mount_hardlinks to test_fuse_mount_hardlinks (master)
-  - vagrant: add up-to-date openindiana box (py35, openssl10)
-  - get rid of confusing coverage warning, #2069
-- docs:
-
-  - reiterate that 'file cache names are absolute' in FAQ,
-    mention bind mount solution, #4738
-  - add restore docs, #4670
-  - updated docs to cover use of temp directory on remote, #4545
-  - add a push-style example to borg-create(1), #4613
-  - timestamps in the files cache are now usually ctime, #4583
-  - benchmark crud: clarify that space is used until compact
-  - update documentation of borg create,
-    corrects a mention of borg 1.1 as a future version.
-  - fix osxfuse github link in installation docs
-  - how to supply a passphrase, use crypto devices, #4549
-  - extract: document limitation "needs empty destination",  #4598
-  - update macOS Brew link
-  - add note about software for automating backup
-  - compact: improve docs,
-  - README: new URL for funding options
-
-
-Version 1.2.0a6 (2019-04-22)
-----------------------------
-
-Fixes:
-
-- delete / prune: consider part files correctly for stats, #4507
-- fix "all archives" stats considering part files, #4329
-- create: only run stat_simple_attrs() once
-- create: --stats does not work with --dry-run, exit with error msg, #4373
-- give "invalid repo" error msg if repo config not found, #4411
-
-New features:
-
-- display msgpack version as part of sysinfo (e.g. in tracebacks)
-
-Other changes:
-
-- docs:
-
-  - sdd "SSH Configuration" section, #4493, #3988, #636, #4485
-  - better document borg check --max-duration, #4473
-  - sorted commands help in multiple steps, #4471
-- testing:
-
-  - travis: use py 3.5.3 and 3.6.7 on macOS to get a pyenv-based python
-    build with openssl 1.1
-  - vagrant: use py 3.5.3 and 3.6.8 on darwin64 VM to build python and
-    borg with openssl 1.1
-  - pytest: -v and default XDISTN to 1, #4481
-
-
-Version 1.2.0a5 (2019-03-21)
-----------------------------
-
-Fixes:
-
-- warn if a file has changed while being backed up, #1750
-- lrucache: regularly remove old FDs, #4427
-- borg command shall terminate with rc 2 for ImportErrors, #4424
-- make freebsd xattr platform code api compatible with linux, #3952
-
-Other changes:
-
-- major setup code refactoring (especially how libraries like openssl, liblz4,
-  libzstd, libb2 are discovered and how it falls back to code bundled with
-  borg), new: uses pkg-config now (and needs python "pkgconfig" package
-  installed), #1925
-
-  if you are a borg package maintainer, please try packaging this
-  (see comments in setup.py).
-- Vagrantfile: add zstd, reorder, build env vars, #4444
-- travis: install script improvements
-- update shell completions
-- docs:
-
-  - add a sample logging.conf in docs/misc, #4380
-  - fix spelling errors
-  - update requirements / install docs, #4374
-
-
-Version 1.2.0a4 (2019-03-11)
-----------------------------
-
-Fixes:
-
-- do not use O_NONBLOCK for special files, like FIFOs, block and char devices
-  when using --read-special. fixes backing up FIFOs. fixes to test. #4394
-- more LibreSSL build fixes: LibreSSL has HMAC_CTX_free and HMAC_CTX_new
-
-New features:
-
-- check: incremental repo check (only checks crc32 for segment entries), #1657
-  borg check --repository-only --max-duration SECONDS ...
-- delete: timestamp for borg delete --info added, #4359
-
-Other changes:
-
-- redo stale lock handling, #3986
-  drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed).
-  borg now always assumes it has a unique host id - either automatically
-  from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
-- docs:
-
-  - added Alpine Linux to distribution list
-  - elaborate on append-only mode docs
-- vagrant:
-
-  - darwin: new 10.12 box
-  - freebsd: new 12.0 box
-  - openbsd: new 6.4 box
-  - misc. updates / fixes
-
-
-Version 1.2.0a3 (2019-02-26)
-----------------------------
-
-Fixes:
-
-- LibreSSL build fixes, #4403
-- dummy ACL/xattr code fixes (used by OpenBSD and others), #4403
-- create: fix openat/statat issues for root directory, #4405
-
-
-Version 1.2.0a2 and earlier (2019-02-24)
-----------------------------------------
-
-New features:
-
-- compact: "borg compact" needs to be used to free repository space by
-  compacting the segments (reading sparse segments, rewriting still needed
-  data to new segments, deleting the sparse segments).
-  Borg < 1.2 invoked compaction automatically at the end of each repository
-  writing command.
-  Borg >= 1.2 does not do that any more to give better speed, more control,
-  more segment file stability (== less stuff moving to newer segments) and
-  more robustness.
-  See the docs about "borg compact" for more details.
-- "borg compact --cleanup-commits" is to cleanup the tons of 17byte long
-  commit-only segment files caused by borg 1.1.x issue #2850.
-  Invoke this once after upgrading (the server side) borg to 1.2.
-  Compaction now automatically removes unneeded commit-only segment files.
-- prune: Show which rule was applied to keep archive, #2886
-- add fixed blocksize chunker (see --chunker-params docs), #1086
-
-Fixes:
-
-- avoid stale filehandle issues, #3265
-- use more FDs, avoid race conditions on active fs, #906, #908, #1038
-- add O_NOFOLLOW to base flags, #908
-- compact:
-
-  - require >10% freeable space in a segment, #2985
-  - repository compaction now automatically removes unneeded 17byte
-    commit-only segments, #2850
-- make swidth available on all posix platforms, #2667
-
-Other changes:
-
-- repository: better speed and less stuff moving around by using separate
-  segment files for manifest DELETEs and PUTs, #3947
-- use pyinstaller v3.3.1 to build binaries
-- update bundled zstd code to 1.3.8, #4210
-- update bundled lz4 code to 1.8.3, #4209
-- msgpack:
-
-  - switch to recent "msgpack" pypi pkg name, #3890
-  - wrap msgpack to avoid future compat complications, #3632, #2738
-  - support msgpack 0.6.0 and 0.6.1, #4220, #4308
-
-- llfuse: modernize / simplify llfuse version requirements
-- code refactorings / internal improvements:
-
-  - include size/csize/nfiles[_parts] stats into archive, #3241
-  - calc_stats: use archive stats metadata, if available
-  - crypto: refactored crypto to use an AEAD style API
-  - crypto: new AES-OCB, CHACHA20-POLY1305
-  - create: use less syscalls by not using a python file obj, #906, #3962
-  - diff: refactor the diff functionality to new ItemDiff class, #2475
-  - archive: create FilesystemObjectProcessors class
-  - helpers: make a package, split into smaller modules
-  - xattrs: move to platform package, use cython instead ctypes, #2495
-  - xattrs/acls/bsdflags: misc. code/api optimizations
-  - FUSE: separate creation of filesystem from implementation of llfuse funcs, #3042
-  - FUSE: use unpacker.tell() instead of deprecated write_bytes, #3899
-  - setup.py: move build_man / build_usage code to setup_docs.py
-  - setup.py: update to use a newer Cython/setuptools API for compiling .pyx -> .c, #3788
-  - use python 3.5's os.scandir / os.set_blocking
-  - multithreading preparations (not used yet):
-
-    - item.to_optr(), Item.from_optr()
-    - fix chunker holding the GIL during blocking I/O
-  - C code portability / basic MSC compatibility, #4147, #2677
-- testing:
-
-  - vagrant: new VMs for linux/bsd/darwin, most with OpenSSL 1.1 and py36
-
-
-Version 1.1.18 (2022-06-05)
----------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
-  If WSL still has a problem with sync_file_range, you need to set
-  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
-  work around the WSL issue.
-- 1.1.14 changes return codes due to a bug fix:
-  In case you have scripts expecting rc == 2 for a signal exit, you need to
-  update them to check for >= 128 (as documented since long).
-- 1.1.15 drops python 3.4 support, minimum requirement is 3.5 now.
-- 1.1.17 install_requires the "packaging" pypi package now.
-
-New features:
-
-- check --repair: significantly speed up search for next valid object in segment, #6022
-- create: add retry_erofs workaround for O_NOATIME issue on volume shadow copies in WSL1, #6024
-- key export: display key if path is '-' or not given, #6092
-- list --format: add command_line to format keys, #6108
-
-Fixes:
-
-- check: improve error handling for corrupt archive metadata block,
-  make robust_iterator more robust, #4777
-- diff: support presence change for blkdev, chrdev and fifo items, #6483
-- diff: reduce memory consumption, fix is_hardlink_master
-- init: disallow overwriting of existing keyfiles
-- info: fix authenticated mode repo to show "Encrypted: No", #6462
-- info: emit repo info even if repo has 0 archives, #6120
-- list: remove placeholders for shake_* hashes, #6082
-- mount -o versions: give clear error msg instead of crashing
-- show_progress: add finished=true/false to archive_progress json, #6570
-- fix hardlinkable file type check, #6037
-- do not show archive name in error msgs referring to the repository, #6023
-- prettier error msg (no stacktrace) if exclude file is missing, #5734
-- do not require BORG_CONFIG_DIR if BORG_{SECURITY,KEYS}_DIR are set, #5979
-- atomically create the CACHE_TAG file, #6028
-- deal with the SaveFile/SyncFile race, docs, see #6176 5c5b59bc9
-- avoid expanding path into LHS of formatting operation + tests, #6064 #6063
-- repository: quota / compactable computation fixes, #6119.
-  This is mainly to keep the repo code in sync with borg 1.2. As borg 1.1
-  compacts immediately, there was not really an issue with this in 1.1.
-- fix transaction rollback: use files cache filename as found in txn.active, #6353
-- do not load files cache for commands not using it, fixes #5673
-- fix scp repo url parsing for ip v6 addrs, #6526
-- repo::archive location placeholder expansion fixes, #5826, #5998
-
-  - use expanded location for log output
-  - support placeholder expansion for BORG_REPO env var
-- respect umask for created directory and file modes, #6400
-- safer truncate_and_unlink implementation
-
-Other changes:
-
-- upgrade bundled xxhash code to 0.8.1
-- fix xxh64 related build (setup.py and post-0.8.1 patch for static_assert).
-  The patch was required to build the bundled xxhash code on FreeBSD, see
-  https://github.com/Cyan4973/xxHash/pull/670
-- msgpack build: remove endianness macro, #6105
-- update and fix shell completions
-- fuse: remove unneeded version check and compat code
-- delete --force: do not ask when deleting a repo, #5941
-- delete: don't commit if nothing was deleted, avoid cache sync, #6060
-- delete: add repository id and location to prompt
-- compact segments: improve freeable / freed space log output, #5679
-- if ensure_dir() fails, give more informative error message, #5952
-- load_key: no key is same as empty key, #6441
-- better error msg for defect or unsupported repo configs, #6566
-- use hmac.compare_digest instead of ==, #6470
-- implement more standard hashindex.setdefault behaviour
-- remove stray punctuation from secure-erase message
-- add development.lock.txt, use a real python 3.5 to generate frozen reqs
-- setuptools 60.7.0 breaks pyinstaller, #6246
-- setup.py clean2 was added to work around some setuptools customizability limitation.
-- allow extra compiler flags for every extension build
-- C code: make switch fallthrough explicit
-- Cython code: fix "useless trailing comma" cython warnings
-- requirements.lock.txt: use the latest cython 0.29.30
-- fix compilation warnings: ‘PyUnicode_AsUnicode’ is deprecated
-- docs:
-
-  - ~/.config/borg/keys is not used for repokey keys, #6107
-  - excluded parent dir's metadata can't restore, #6062
-  - permissions note rewritten to make it less confusing, #5490
-  - add note about grandfather-father-son backup retention policy / rotation scheme
-  - clarify who starts the remote agent (borg serve)
-  - test/improve pull backup docs, #5903
-  - document the socat pull mode described in #900 #515ß
-  - borg serve: improve ssh forced commands docs, #6083
-  - improve docs for borg list --format, #6080
-  - fix the broken link to .nix file
-  - clarify pattern usage with commands, #5176
-  - clarify user_id vs uid for fuse, #5723
-  - fix binary build freebsd/macOS version, #5942
-  - FAQ: fix manifest-timestamp path, #6016
-  - remove duplicate faq entries, #5926
-  - fix sphinx warnings, #5919
-  - virtualisation speed tips
-  - fix values of TAG bytes, #6515
-  - recommend umask for passphrase file perms
-  - update link to ubuntu packages, #6485
-  - clarify on-disk order and size of log entry fields, #6357
-  - do not transform --/--- to unicode dashes
-  - improve linking inside docs, link to borg_placeholders, link to borg_patterns
-  - use same phrasing in misc. help texts
-  - borg init: explain the encryption modes better
-  - explain the difference between a path that ends with or without a slash, #6297
-  - clarify usage of patternfile roots, #6242
-  - borg key export: add examples
-  - updates about features not experimental any more: FUSE "versions" view, --pattern*, #6134
-  - fix/update cygwin package requirements
-  - impact of deleting path/to/repo/nonce, #5858
-  - warn about tampered server nonce
-  - mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, #5602
-  - add a troubleshooting note about "is not a valid repository" to the FAQ
-- vagrant / CI / testing:
-
-  - misc. fixes and updates, new python versions
-  - macOS on github: re-enable fuse2 testing by downgrading to older macOS, #6099
-  - fix OpenBSD symlink mode test failure, #2055
-  - use the generic/openbsd6 box
-  - strengthen the test: we can read data w/o nonces
-  - add tests for path/to/repo/nonce deletion
-  - darwin64: backport some tunings from master
-  - darwin64: remove fakeroot, #6314
-  - darwin64: fix vagrant scp, #5921
-  - darwin64: use macfuse instead of osxfuse
-  - add ubuntu "jammy" 22.04 LTS VM
-  - adapt memory for openindiana64 and darwin64
-
-
-Version 1.1.17 (2021-07-12)
----------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
-  If WSL still has a problem with sync_file_range, you need to set
-  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
-  work around the WSL issue.
-- 1.1.14 changes return codes due to a bug fix:
-  In case you have scripts expecting rc == 2 for a signal exit, you need to
-  update them to check for >= 128 (as documented since long).
-- 1.1.15 drops python 3.4 support, minimum requirement is 3.5 now.
-- 1.1.17 install_requires the "packaging" pypi package now.
-
-Fixes:
-
-- pyinstaller dir-mode: fix pyi detection / LIBPATH treatment, #5897
-- handle crash due to kill stale lock race, #5828
-- fix BORG_CACHE_DIR crashing borg if empty, #5216
-- create --dry-run: fix display of kept tagfile, #5834
-- fix missing parameter in "did not consistently fail" msg, #5822
-- missing / healed chunks: always tell chunk ID, #5704
-- benchmark: make sure cleanup happens even on exceptions, #5630
-
-New features:
-
-- implement BORG_SELFTEST env variable, #5871.
-  this can be used to accelerate borg startup a bit. not recommended for
-  normal usage, but borg mass hosters with a lot of borg invocations can
-  save some resources with this. on my laptop, this saved ~100ms cpu time
-  (sys+user) per borg command invocation.
-- implement BORG_LIBC env variable to give the libc filename, #5870.
-  you can use this if a borg does not find your libc.
-- check: add progress indicator for archive check.
-- allow --files-cache=size (not recommended, make sure you know what you do)
-
-Other changes:
-
-- Python 3.10 now officially supported!
-  we test on py310-dev on github CI since a while and now also on the vagrant
-  machines, so it should work ok.
-- github CI: test on py310 (again)
-- get rid of distutils, use packaging and setuptools.
-  distutils is deprecated and gives warnings on py 3.10.
-- setup.py: rename "clean" to "clean2" to avoid shadowing the "clean" command.
-- remove libc filename fallback for the BSDs (there is no "usual" name)
-- cleanup flake8 checks, fix some pep8 violations.
-- docs building: replace deprecated function ".add_stylesheet()" for Sphinx 4 compatibility
-- docs:
-
-  - add a hint on sleeping computer and ssh connections, #5301
-  - update the documentation on hacked backup client, #5480
-  - improve docs/FAQ about append-only remote repos, #5497
-  - complement the documentation for pattern files and exclude files, #5520
-  - "filename with spaces" example added to exclude file, #5236
-    note: no whitespace escaping needed, processed by borg.
-  - add info on renaming repositories, #5240
-  - clarify borg check --verify-data, #5808
-  - add notice about defective hardware to check documentation, #5753
-  - add paragraph added in #5855 to utility documentation source
-  - add missing leading slashes in help patterns, #5857
-  - clarify "you will need key and passphrase" borg init warning, #4622
-  - pull mode: add some warnings, #5827
-  - mention tar --compare (compare archive to fs files), #5880
-  - fix typos, backport of #5597
-- vagrant:
-
-  - add py3.7.11 for binary build, also add 3.10-dev.
-  - use latest Cython 0.29.23 for py310 compat fixes.
-  - more RAM for openindiana upgrade plan resolver, it just hangs (swaps?) if
-    there is too little RAM.
-  - fix install_pyenv to adapt to recent changes in pyenv (same as in master now).
-  - use generic/netbsd9 box, copied from master branch.
-
-
-Version 1.1.16 (2021-03-23)
----------------------------
-
-Fixes:
-
-- setup.py: add special openssl prefix for Apple M1 compatibility
-- do not recurse into duplicate roots, #5603
-- remove empty shadowed_segments lists, #5275, #5614
-- fix libpython load error when borg fat binary / dir-based binary is invoked
-  via a symlink by upgrading pyinstaller to v4.2, #5688
-- config: accept non-int value (like 500M or 100G) for max_segment_size or
-  storage_quota, #5639.
-  please note: when setting a non-int value for this in a repo config,
-  using the repo will require borg >= 1.1.16.
-
-New features:
-
-- bundled msgpack: drop support for old buffer protocol to support Python 3.10
-- verbose files cache logging via --debug-topic=files_cache, #5659.
-  Use this if you suspect that borg does not detect unmodified files as expected.
-- create/extract: add --noxattrs and --noacls option, #3955.
-  when given with borg create, borg will not get xattrs / ACLs from input files
-  (and thus, it will not archive xattrs / ACLs). when given with borg extract,
-  borg will not read xattrs / ACLs from archive and will not set xattrs / ACLs
-  on extracted files.
-- diff: add --json-lines option, #3765
-- check: debug log segment filename
-- borg debug dump-hints
-
-Other changes:
-
-- Tab completion support for additional archives for 'borg delete'
-- repository: deduplicate code of put and delete, no functional change
-- tests: fix result order issue (sporadic test failure on openindiana)
-- vagrant:
-
-  - upgrade pyinstaller to v4.2, #5671
-  - avoid grub-install asking interactively for device
-  - remove the xenial box
-  - update freebsd box to 12.1
-- docs:
-
-  - update macOS install instructions, #5677
-  - use macFUSE (not osxfuse) for Apple M1 compatibility
-  - update docs for dev environment installation instructions, #5643
-  - fix grammar in faq
-  - recommend running tests only on installed versions for setup
-  - add link back to git-installation
-  - remove /var/cache exclusion in example commands, #5625.
-    This is generally a poor idea and shouldn't be promoted through examples.
-  - add repology.org badge with current packaging status
-  - explain hash collision
-  - add unsafe workaround to use an old repo copy, #5722
-
-
-Version 1.1.15 (2020-12-25)
----------------------------
-
-Fixes:
-
-- extract:
-
-  - improve exception handling when setting xattrs, #5092.
-  - emit a warning message giving the path, xattr key and error message.
-  - continue trying to restore other xattrs and bsdflags of the same file
-    after an exception with xattr-setting happened.
-- export-tar:
-
-  - set tar format to GNU_FORMAT explicitly, #5274
-  - fix memory leak with ssh: remote repository, #5568
-  - fix potential memory leak with ssh: remote repository with partial extraction
-- create: fix --dry-run and --stats coexistence, #5415
-- use --timestamp for {utcnow} and {now} if given, #5189
-
-New features:
-
-- create: implement --stdin-mode, --stdin-user and --stdin-group, #5333
-- allow appending the files cache filename with BORG_FILES_CACHE_SUFFIX env var
-
-Other changes:
-
-- drop python 3.4 support, minimum requirement is 3.5 now.
-- enable using libxxhash instead of bundled xxh64 code
-- update llfuse requirements (1.3.8)
-- set cython language_level in some files to fix warnings
-- allow EIO with warning when trying to hardlink
-- PropDict: fail early if internal_dict is not a dict
-- update shell completions
-- tests / CI
-
-  - add a test for the hashindex corruption bug, #5531 #4829
-  - fix spurious failure in test_cache_files, #5438
-  - added a github ci workflow
-  - reduce testing on travis, no macOS, no py3x-dev, #5467
-  - travis: use newer dists, native py on dist
-- vagrant:
-
-  - remove jessie and trusty boxes, #5348 #5383
-  - pyinstaller 4.0, build on py379
-  - binary build on stretch64, #5348
-  - remove easy_install based pip installation
-- docs:
-
-  - clarify '--one-file-system' for btrfs, #5391
-  - add example for excluding content using the --pattern cmd line arg
-  - complement the documentation for pattern files and exclude files, #5524
-  - made ansible playbook more generic, use package instead of pacman. also
-    change state from "latest" to "present".
-  - complete documentation on append-only remote repos, #5497
-  - internals: rather talk about target size than statistics, #5336
-  - new compression algorithm policy, #1633 #5505
-  - faq: add a hint on sleeping computer, #5301
-  - note requirements for full disk access on macOS Catalina, #5303
-  - fix/improve description of borg upgrade hardlink usage, #5518
-- modernize 1.1 code:
-
-  - drop code/workarounds only needed to support Python 3.4
-  - remove workaround for pre-release py37 argparse bug
-  - removed some outdated comments/docstrings
-  - requirements: remove some restrictions, lock on current versions
-
-
-Version 1.1.14 (2020-10-07)
----------------------------
-
-Fixes:
-
-- check --repair: fix potential data loss when interrupting it, #5325
-- exit with 128 + signal number (as documented) when borg is killed by a signal, #5161
-- fix hardlinked CACHEDIR.TAG processing, #4911
-- create --read-special: .part files also should be regular files, #5217
-- llfuse dependency: choose least broken 1.3.6/1.3.7.
-  1.3.6 is broken on python 3.9, 1.3.7 is broken on FreeBSD.
-
-Other changes:
-
-- upgrade bundled xxhash to 0.7.4
-- self test: if it fails, also point to OS and hardware, #5334
-- pyinstaller: compute basepath from spec file location
-- prettier error message when archive gets too big, #5307
-- check/recreate are not "experimental" any more (but still potentially dangerous):
-
-  - recreate: remove extra confirmation
-  - rephrase some warnings, update docs, #5164
-- shell completions:
-
-  - misc. updates / fixes
-  - support repositories in fish tab completion, #5256
-  - complete $BORG_RECREATE_I_KNOW_WHAT_I_AM_DOING
-  - rewrite zsh completion:
-
-    - completion for almost all optional and positional arguments
-    - completion for Borg environment variables (parameters)
-- use "allow/deny list" instead of "white/black list" wording
-- declare "allow_cache_wipe" marker in setup.cfg to avoid pytest warning
-- vagrant / tests:
-
-  - misc. fixes / updates
-  - use python 3.5.10 for binary build
-  - build directory-based binaries additionally to the single file binaries
-  - add libffi-dev, required to build python
-  - use cryptography<3.0, more recent versions break the jessie box
-  - test on python 3.9
-  - do brew update with /dev/null redirect to avoid "too much log output" on travis-ci
-- docs:
-
-  - add ssh-agent pull backup method docs, #5288
-  - how to approach borg speed issues, #5371
-  - mention double --force in prune docs
-  - update Homebrew install instructions, #5185
-  - better description of how cache and rebuilds of it work
-  - point to borg create --list item flags in recreate usage, #5165
-  - add security faq explaining AES-CTR crypto issues, #5254
-  - add a note to create from stdin regarding files cache, #5180
-  - fix borg.1 manpage generation regression, #5211
-  - clarify how exclude options work in recreate, #5193
-  - add section for retired contributors
-  - hint about not misusing private email addresses of contributors for borg support
-
-
-Version 1.1.13 (2020-06-06)
----------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
-  If WSL still has a problem with sync_file_range, you need to set
-  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
-  work around the WSL issue.
-
-Fixes:
-
-- rebuilt using a current Cython version, compatible with python 3.8, #5214
-
-
-Version 1.1.12 (2020-06-06)
----------------------------
-
-Fixes:
-
-- fix preload-related memory leak, #5202.
-- mount / borgfs (FUSE filesystem):
-
-  - fix FUSE low linear read speed on large files, #5067
-  - fix crash on old llfuse without birthtime attrs, #5064 - accidentally
-    we required llfuse >= 1.3. Now also old llfuse works again.
-  - set f_namemax in statfs result, #2684
-- update precedence of env vars to set config and cache paths, #4894
-- correctly calculate compression ratio, taking header size into account, too
-
-New features:
-
-- --bypass-lock option to bypass locking with read-only repositories
-
-Other changes:
-
-- upgrade bundled zstd to 1.4.5
-- travis: adding comments and explanations to Travis config / install script,
-  improve macOS builds.
-- tests: test_delete_force: avoid sporadic test setup issues, #5196
-- misc. vagrant fixes
-- the binary for macOS is now built on macOS 10.12
-- the binaries for Linux are now built on Debian 8 "Jessie", #3761
-- docs:
-
-  - PlaceholderError not printed as JSON, #4073
-  - "How important is Borg config?", #4941
-  - make Sphinx warnings break docs build, #4587
-  - some markup / warning fixes
-  - add "updating borgbackup.org/releases" to release checklist, #4999
-  - add "rendering docs" to release checklist, #5000
-  - clarify borg init's encryption modes
-  - add note about patterns and stored paths, #4160
-  - add upgrade of tools to pip installation how-to
-  - document one cause of orphaned chunks in check command, #2295
-  - linked recommended restrictions to ssh public keys on borg servers in faq, #4946
-
-
-Version 1.1.11 (2020-03-08)
----------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
-  If WSL still has a problem with sync_file_range, you need to set
-  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
-  work around the WSL issue.
-
-Fixes:
-
-- fixed potential index corruption / data loss issue due to bug in hashindex_set, #4829.
-  Please read and follow the more detailed notes close to the top of this document.
-- upgrade bundled xxhash to 0.7.3, #4891.
-  0.7.2 is the minimum requirement for correct operations on ARMv6 in non-fixup
-  mode, where unaligned memory accesses cause bus errors.
-  0.7.3 adds some speedups and libxxhash 0.7.3 even has a pkg-config file now.
-- upgrade bundled lz4 to 1.9.2
-- upgrade bundled zstd to 1.4.4
-- fix crash when upgrading erroneous hints file, #4922
-- extract:
-
-  - fix KeyError for "partial" extraction, #4607
-  - fix "partial" extract for hardlinked contentless file types, #4725
-  - fix preloading for old (0.xx) remote servers, #4652
-  - fix confusing output of borg extract --list --strip-components, #4934
-- delete: after double-force delete, warn about necessary repair, #4704
-- create: give invalid repo error msg if repo config not found, #4411
-- mount: fix FUSE mount missing st_birthtime, #4763 #4767
-- check: do not stumble over invalid item key, #4845
-- info: if the archive doesn't exist, print a pretty message, #4793
-- SecurityManager.known(): check all files, #4614
-- Repository.open: use stat() to check for repo dir, #4695
-- Repository.check_can_create_repository: use stat() to check, #4695
-- fix invalid archive error message
-- fix optional/non-optional location arg, #4541
-- commit-time free space calc: ignore bad compact map entries, #4796
-- ignore EACCES (errno 13) when hardlinking the old config, #4730
-- --prefix / -P: fix processing, avoid argparse issue, #4769
-
-New features:
-
-- enable placeholder usage in all extra archive arguments
-- new BORG_WORKAROUNDS mechanism, basesyncfile, #4710
-- recreate: support --timestamp option, #4745
-- support platforms without os.link (e.g. Android with Termux), #4901.
-  if we don't have os.link, we just extract another copy instead of making a hardlink.
-- support linux platforms without sync_file_range (e.g. Android 7 with Termux), #4905
-
-Other:
-
-- ignore --stats when given with --dry-run, but continue, #4373
-- add some ProgressIndicator msgids to code / fix docs, #4935
-- elaborate on "Calculating size" message
-- argparser: always use REPOSITORY in metavar, also use more consistent help phrasing.
-- check: improve error output for matching index size, see #4829
-- docs:
-
-  - changelog: add advisory about hashindex_set bug #4829
-  - better describe BORG_SECURITY_DIR, BORG_CACHE_DIR, #4919
-  - infos about cache security assumptions, #4900
-  - add FAQ describing difference between a local repo vs. repo on a server.
-  - document how to test exclusion patterns without performing an actual backup
-  - timestamps in the files cache are now usually ctime, #4583
-  - fix bad reference to borg compact (does not exist in 1.1), #4660
-  - create: borg 1.1 is not future any more
-  - extract: document limitation "needs empty destination", #4598
-  - how to supply a passphrase, use crypto devices, #4549
-  - fix osxfuse github link in installation docs
-  - add example of exclude-norecurse rule in help patterns
-  - update macOS Brew link
-  - add note about software for automating backups, #4581
-  - AUTHORS: mention copyright+license for bundled msgpack
-  - fix various code blocks in the docs, #4708
-  - updated docs to cover use of temp directory on remote, #4545
-  - add restore docs, #4670
-  - add a pull backup / push restore how-to, #1552
-  - add FAQ how to retain original paths, #4532
-  - explain difference between --exclude and --pattern, #4118
-  - add FAQs for SSH connection issues, #3866
-  - improve password FAQ, #4591
-  - reiterate that 'file cache names are absolute' in FAQ
-- tests:
-
-  - cope with ANY error when importing pytest into borg.testsuite, #4652
-  - fix broken test that relied on improper zlib assumptions
-  - test_fuse: filter out selinux xattrs, #4574
-- travis / vagrant:
-
-  - misc python versions removed / changed (due to openssl 1.1 compatibility)
-    or added (3.7 and 3.8, for better borg compatibility testing)
-  - binary building is on python 3.5.9 now
-- vagrant:
-
-  - add new boxes: ubuntu 18.04 and 20.04, debian 10
-  - update boxes: openindiana, darwin, netbsd
-  - remove old boxes: centos 6
-  - darwin: updated osxfuse to 3.10.4
-  - use debian/ubuntu pip/virtualenv packages
-  - rather use python 3.6.2 than 3.6.0, fixes coverage/sqlite3 issue
-  - use requirements.d/development.lock.txt to avoid compat issues
-- travis:
-
-  - darwin: backport some install code / order from master
-  - remove deprecated keyword "sudo" from travis config
-  - allow osx builds to fail, #4955
-    this is due to travis-ci frequently being so slow that the OS X builds
-    just fail because they exceed 50 minutes and get killed by travis.
-
-
-Version 1.1.10 (2019-05-16)
----------------------------
-
-Fixes:
-
-- extract: hang on partial extraction with ssh: repo, when hardlink master
-  is not matched/extracted and borg hangs on related slave hardlink, #4350
-- lrucache: regularly remove old FDs, #4427
-- avoid stale filehandle issues, #3265
-- freebsd: make xattr platform code api compatible with linux, #3952
-- use whitelist approach for borg serve, #4097
-- borg command shall terminate with rc 2 for ImportErrors, #4424
-- create: only run stat_simple_attrs() once, this increases
-  backup with lots of unchanged files performance by ~ 5%.
-- prune: fix incorrect borg prune --stats output with --dry-run, #4373
-- key export: emit user-friendly error if repo key is exported to a directory,
-  #4348
-
-New features:
-
-- bundle latest supported msgpack-python release (0.5.6), remove msgpack-python
-  from setup.py install_requires - by default we use the bundled code now.
-  optionally, we still support using an external msgpack (see hints in
-  setup.py), but this requires solid requirements management within
-  distributions and is not recommended.
-  borgbackup will break if you upgrade msgpack to an unsupported version.
-- display msgpack version as part of sysinfo (e.g. in tracebacks)
-- timestamp for borg delete --info added, #4359
-- enable placeholder usage in --comment and --glob-archives, #4559, #4495
-
-Other:
-
-- serve: do not check python/libc for borg serve, #4483
-- shell completions: borg diff second archive
-- release scripts: signing binaries with Qubes OS support
-- testing:
-
-  - vagrant: upgrade openbsd box to 6.4
-  - travis-ci: lock test env to py 3.4 compatible versions, #4343
-  - get rid of confusing coverage warning, #2069
-  - rename test_mount_hardlinks to test_fuse_mount_hardlinks,
-    so both can be excluded by "not test_fuse".
-  - pure-py msgpack warning shall not make a lot of tests fail, #4558
-- docs:
-
-  - add "SSH Configuration" section to "borg serve", #3988, #636, #4485
-  - README: new URL for funding options
-  - add a sample logging.conf in docs/misc, #4380
-  - elaborate on append-only mode docs, #3504
-  - installation: added Alpine Linux to distribution list, #4415
-  - usage.html: only modify window.location when redirecting, #4133
-  - add msgpack license to docs/3rd_party/msgpack
-- vagrant / binary builds:
-
-  - use python 3.5.7 for builds
-  - use osxfuse 3.8.3
-
-
-Version 1.1.9 (2019-02-10)
---------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-
-Fixes:
-
-- security fix: configure FUSE with "default_permissions", #3903
-  "default_permissions" is now enforced by borg by default to let the
-  kernel check uid/gid/mode based permissions.
-  "ignore_permissions" can be given to not enforce "default_permissions".
-- make "hostname" short, even on misconfigured systems, #4262
-- fix free space calculation on macOS (and others?), #4289
-- config: quit with error message when no key is provided, #4223
-- recover_segment: handle too small segment files correctly, #4272
-- correctly release memoryview, #4243
-- avoid diaper pattern in configparser by opening files, #4263
-- add "# cython: language_level=3" directive to .pyx files, #4214
-- info: consider part files for "This archive" stats, #3522
-- work around Microsoft WSL issue #645 (sync_file_range), #1961
-
-New features:
-
-- add --rsh command line option to complement BORG_RSH env var, #1701
-- init: --make-parent-dirs parent1/parent2/repo_dir, #4235
-
-Other:
-
-- add archive name to check --repair output, #3447
-- check for unsupported msgpack versions
-- shell completions:
-
-  - new shell completions for borg 1.1.9
-  - more complete shell completions for borg mount -o
-  - added shell completions for borg help
-  - option arguments for zsh tab completion
-- docs:
-
-  - add FAQ regarding free disk space check, #3905
-  - update BORG_PASSCOMMAND example and clarify variable expansion, #4249
-  - FAQ regarding change of compression settings, #4222
-  - add note about BSD flags to changelog, #4246
-  - improve logging in example automation script
-  - add note about files changing during backup, #4081
-  - work around the backslash issue, #4280
-  - update release workflow using twine (docs, scripts), #4213
-  - add warnings on repository copies to avoid future problems, #4272
-- tests:
-
-  - fix the homebrew 1.9 issues on travis-ci, #4254
-  - fix duplicate test method name, #4311
-
-
-Version 1.1.8 (2018-12-09)
---------------------------
-
-Fixes:
-
-- enforce storage quota if set by serve-command, #4093
-- invalid locations: give err msg containing parsed location, #4179
-- list repo: add placeholders for hostname and username, #4130
-- on linux, symlinks can't have ACLs, so don't try to set any, #4044
-
-New features:
-
-- create: added PATH::archive output on INFO log level
-- read a passphrase from a file descriptor specified in the
-  BORG_PASSPHRASE_FD environment variable.
-
-Other:
-
-- docs:
-
-  - option --format is required for some expensive-to-compute values for json
-
-    borg list by default does not compute expensive values except when
-    they are needed. whether they are needed is determined by the format,
-    in standard mode as well as in --json mode.
-  - tell that our binaries are x86/x64 amd/intel, bauerj has ARM
-  - fixed wrong archive name pattern in CRUD benchmark help
-  - fixed link to cachedir spec in docs, #4140
-- tests:
-
-  - stop using fakeroot on travis, avoids sporadic EISDIR errors, #2482
-  - xattr key names must start with "user." on linux
-  - fix code so flake8 3.6 does not complain
-  - explicitly convert environment variable to str, #4136
-  - fix DeprecationWarning: Flags not at the start of the expression, #4137
-  - support pytest4, #4172
-- vagrant:
-
-  - use python 3.5.6 for builds
-
-
-Version 1.1.7 (2018-08-11)
---------------------------
-
-Compatibility notes:
-
-- added support for Python 3.7
-
-Fixes:
-
-- cache lock: use lock_wait everywhere to fix infinite wait, see #3968
-- don't archive tagged dir when recursing an excluded dir, #3991
-- py37 argparse: work around bad default in py 3.7.0a/b/rc, #3996
-- py37 remove loggerDict.clear() from tearDown method, #3805
-- some fixes for bugs which likely did not result in problems in practice:
-
-  - fixed logic bug in platform module API version check
-  - fixed xattr/acl function prototypes, added missing ones
-
-New features:
-
-- init: add warning to store both key and passphrase at safe place(s)
-- BORG_HOST_ID env var to work around all-zero MAC address issue, #3985
-- borg debug dump-repo-objs --ghost (dump everything from segment files,
-  including deleted or superseded objects or commit tags)
-- borg debug search-repo-objs (search in repo objects for hex bytes or strings)
-
-Other changes:
-
-- add Python 3.7 support
-- updated shell completions
-- call socket.gethostname only once
-- locking: better logging, add some asserts
-- borg debug dump-repo-objs:
-
-  - filename layout improvements
-  - use repository.scan() to get on-disk order
-- docs:
-
-  - update installation instructions for macOS
-  - added instructions to install fuse via homebrew
-  - improve diff docs
-  - added note that checkpoints inside files requires 1.1+
-  - add link to tempfile module
-  - remove row/column-spanning from docs source, #4000 #3990
-- tests:
-
-  - fetch less data via os.urandom
-  - add py37 env for tox
-  - travis: add 3.7, remove 3.6-dev (we test with -dev in master)
-- vagrant / binary builds:
-
-  - use osxfuse 3.8.2
-  - use own (uptodate) openindiana box
-
-
-Version 1.1.6 (2018-06-11)
---------------------------
-
-Compatibility notes:
-
-- 1.1.6 changes:
-
-  - also allow msgpack-python 0.5.6.
-
-Fixes:
-
-- fix borg exception handling on ENOSPC error with xattrs, #3808
-- prune: fix/improve overall progress display
-- borg config repo ... does not need cache/manifest/key, #3802
-- debug dump-repo-objs should not depend on a manifest obj
-- pypi package:
-
-  - include .coveragerc, needed by tox.ini
-  - fix package long description, #3854
-
-New features:
-
-- mount: add uid, gid, umask mount options
-- delete:
-
-  - only commit once, #3823
-  - implement --dry-run, #3822
-- check:
-
-  - show progress while rebuilding missing manifest, #3787
-  - more --repair output
-- borg config --list <repo>, #3612
-
-Other changes:
-
-- update msgpack requirement, #3753
-- update bundled zstd to 1.3.4, #3745
-- update bundled lz4 code to 1.8.2, #3870
-- docs:
-
-  - describe what BORG_LIBZSTD_PREFIX does
-  - fix and deduplicate encryption quickstart docs, #3776
-- vagrant:
-
-  - FUSE for macOS: upgrade 3.7.1 to 3.8.0
-  - exclude macOS High Sierra upgrade on the darwin64 machine
-  - remove borgbackup.egg-info dir in fs_init (after rsync)
-  - use pyenv-based build/test on jessie32/62
-  - use local 32 and 64bit debian jessie boxes
-  - use "vagrant" as username for new xenial box
-- travis OS X: use xcode 8.3 (not broken)
-
-
-Version 1.1.5 (2018-04-01)
---------------------------
-
-Compatibility notes:
-
-- 1.1.5 changes:
-
-  - require msgpack-python >= 0.4.6 and < 0.5.0.
-    0.5.0+ dropped python 3.4 testing and also caused some other issues because
-    the python package was renamed to msgpack and emitted some FutureWarning.
-
-Fixes:
-
-- create --list: fix that it was never showing M status, #3492
-- create: fix timing for first checkpoint (read files cache early, init
-  checkpoint timer after that), see #3394
-- extract: set rc=1 when extracting damaged files with all-zero replacement
-  chunks or with size inconsistencies, #3448
-- diff: consider an empty file as different to a non-existing file, #3688
-- files cache: improve exception handling, #3553
-- ignore exceptions in scandir_inorder() caused by an implicit stat(),
-  also remove unneeded sort, #3545
-- fixed tab completion problem where a space is always added after path even
-  when it shouldn't
-- build: do .h file content checks in binary mode, fixes build issue for
-  non-ascii header files on pure-ascii locale platforms, #3544 #3639
-- borgfs: fix patterns/paths processing, #3551
-- config: add some validation, #3566
-- repository config: add validation for max_segment_size, #3592
-- set cache previous_location on load instead of save
-- remove platform.uname() call which caused library mismatch issues, #3732
-- add exception handler around deprecated platform.linux_distribution() call
-- use same datetime object for {now} and {utcnow}, #3548
-
-New features:
-
-- create: implement --stdin-name, #3533
-- add chunker_params to borg archive info (--json)
-- BORG_SHOW_SYSINFO=no to hide system information from exceptions
-
-Other changes:
-
-- updated zsh completions for borg 1.1.4
-- files cache related code cleanups
-- be more helpful when parsing invalid --pattern values, #3575
-- be more clear in secure-erase warning message, #3591
-- improve getpass user experience, #3689
-- docs build: unicode problem fixed when using a py27-based sphinx
-- docs:
-
-  - security: explicitly note what happens OUTSIDE the attack model
-  - security: add note about combining compression and encryption
-  - security: describe chunk size / proximity issue, #3687
-  - quickstart: add note about permissions, borg@localhost, #3452
-  - quickstart: add introduction to repositories & archives, #3620
-  - recreate --recompress: add missing metavar, clarify description, #3617
-  - improve logging docs, #3549
-  - add an example for --pattern usage, #3661
-  - clarify path semantics when matching, #3598
-  - link to offline documentation from README, #3502
-  - add docs on how to verify a signed release with GPG, #3634
-  - chunk seed is generated per repository (not: archive)
-  - better formatting of CPU usage documentation, #3554
-  - extend append-only repo rollback docs, #3579
-- tests:
-
-  - fix erroneously skipped zstd compressor tests, #3606
-  - skip a test if argparse is broken, #3705
-- vagrant:
-
-  - xenial64 box now uses username 'vagrant', #3707
-  - move cleanup steps to fs_init, #3706
-  - the boxcutter wheezy boxes are 404, use local ones
-  - update to Python 3.5.5 (for binary builds)
-
-
-Version 1.1.4 (2017-12-31)
---------------------------
-
-Compatibility notes:
-
-- When upgrading from borg 1.0.x to 1.1.x, please note:
-
-  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
-  - borg upgrade: you do not need to and you also should not run it.
-  - borg might ask some security-related questions once after upgrading.
-    You can answer them either manually or via environment variable.
-    One known case is if you use unencrypted repositories, then it will ask
-    about a unknown unencrypted repository one time.
-  - your first backup with 1.1.x might be significantly slower (it might
-    completely read, chunk, hash a lot files) - this is due to the
-    --files-cache mode change (and happens every time you change mode).
-    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
-    mode (but that is less safe for detecting changed files than the default).
-    See the --files-cache docs for details.
-- borg 1.1.4 changes:
-
-  - zstd compression is new in borg 1.1.4, older borg can't handle it.
-  - new minimum requirements for the compression libraries - if the required
-    versions (header and lib) can't be found at build time, bundled code will
-    be used:
-
-    - added requirement: libzstd >= 1.3.0 (bundled: 1.3.2)
-    - updated requirement: liblz4 >= 1.7.0 / r129 (bundled: 1.8.0)
-
-Fixes:
-
-- check: data corruption fix: fix for borg check --repair malfunction, #3444.
-  See the more detailed notes close to the top of this document.
-- delete: also delete security dir when deleting a repo, #3427
-- prune: fix building the "borg prune" man page, #3398
-- init: use given --storage-quota for local repo, #3470
-- init: properly quote repo path in output
-- fix startup delay with dns-only own fqdn resolving, #3471
-
-New features:
-
-- added zstd compression. try it!
-- added placeholder {reverse-fqdn} for fqdn in reverse notation
-- added BORG_BASE_DIR environment variable, #3338
-
-Other changes:
-
-- list help topics when invalid topic is requested
-- fix lz4 deprecation warning, requires lz4 >= 1.7.0 (r129)
-- add parens for C preprocessor macro argument usages (did not cause malfunction)
-- exclude broken pytest 3.3.0 release
-- updated fish/bash completions
-- init: more clear exception messages for borg create, #3465
-- docs:
-
-  - add auto-generated docs for borg config
-  - don't generate HTML docs page for borgfs, #3404
-  - docs update for lz4 b2 zstd changes
-  - add zstd to compression help, readme, docs
-  - update requirements and install docs about bundled lz4 and zstd
-- refactored build of the compress and crypto.low_level extensions, #3415:
-
-  - move some lib/build related code to setup_{zstd,lz4,b2}.py
-  - bundle lz4 1.8.0 (requirement: >= 1.7.0 / r129)
-  - bundle zstd 1.3.2 (requirement: >= 1.3.0)
-  - blake2 was already bundled
-  - rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX for better consistency:
-    we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX now.
-  - add prefer_system_lib* = True settings to setup.py - by default the build
-    will prefer a shared library over the bundled code, if library and headers
-    can be found and meet the minimum requirements.
-
-
-Version 1.1.3 (2017-11-27)
---------------------------
-
-Fixes:
-
-- Security Fix for CVE-2017-15914: Incorrect implementation of access controls
-  allows remote users to override repository restrictions in Borg servers.
-  A user able to access a remote Borg SSH server is able to circumvent access
-  controls post-authentication.
-  Affected releases: 1.1.0, 1.1.1, 1.1.2. Releases 1.0.x are NOT affected.
-- crc32: deal with unaligned buffer, add tests - this broke borg on older ARM
-  CPUs that can not deal with unaligned 32bit memory accesses and raise a bus
-  error in such cases. the fix might also improve performance on some CPUs as
-  all 32bit memory accesses by the crc32 code are properly aligned now. #3317
-- mount: fixed support of --consider-part-files and do not show .borg_part_N
-  files by default in the mounted FUSE filesystem. #3347
-- fixed cache/repo timestamp inconsistency message, highlight that information
-  is obtained from security dir (deleting the cache will not bypass this error
-  in case the user knows this is a legitimate repo).
-- borgfs: don't show sub-command in borgfs help, #3287
-- create: show an error when --dry-run and --stats are used together, #3298
-
-New features:
-
-- mount: added exclusion group options and paths, #2138
-
-  Reused some code to support similar options/paths as borg extract offers -
-  making good use of these to only mount a smaller subset of dirs/files can
-  speed up mounting a lot and also will consume way less memory.
-
-  borg mount [options] repo_or_archive mountpoint path [paths...]
-
-  paths: you can just give some "root paths" (like for borg extract) to
-  only partially populate the FUSE filesystem.
-
-  new options: --exclude[-from], --pattern[s-from], --strip-components
-- create/extract: support st_birthtime on platforms supporting it, #3272
-- add "borg config" command for querying/setting/deleting config values, #3304
-
-Other changes:
-
-- clean up and simplify packaging (only package committed files, do not install
-  .c/.h/.pyx files)
-- docs:
-
-  - point out tuning options for borg create, #3239
-  - add instructions for using ntfsclone, zerofree, #81
-  - move image backup-related FAQ entries to a new page
-  - clarify key aliases for borg list --format, #3111
-  - mention break-lock in checkpointing FAQ entry, #3328
-  - document sshfs rename workaround, #3315
-  - add FAQ about removing files from existing archives
-  - add FAQ about different prune policies
-  - usage and man page for borgfs, #3216
-  - clarify create --stats duration vs. wall time, #3301
-  - clarify encrypted key format for borg key export, #3296
-  - update release checklist about security fixes
-  - document good and problematic option placements, fix examples, #3356
-  - add note about using --nobsdflags to avoid speed penalty related to
-    bsdflags, #3239
-  - move most of support section to www.borgbackup.org
-
-
-Version 1.1.2 (2017-11-05)
---------------------------
-
-Fixes:
-
-- fix KeyError crash when talking to borg server < 1.0.7, #3244
-- extract: set bsdflags last (include immutable flag), #3263
-- create: don't do stat() call on excluded-norecurse directory, fix exception
-  handling for stat() call, #3209
-- create --stats: do not count data volume twice when checkpointing, #3224
-- recreate: move chunks_healthy when excluding hardlink master, #3228
-- recreate: get rid of chunks_healthy when rechunking (does not match), #3218
-- check: get rid of already existing not matching chunks_healthy metadata, #3218
-- list: fix stdout broken pipe handling, #3245
-- list/diff: remove tag-file options (not used), #3226
-
-New features:
-
-- bash, zsh and fish shell auto-completions, see scripts/shell_completions/
-- added BORG_CONFIG_DIR env var, #3083
-
-Other changes:
-
-- docs:
-
-  - clarify using a blank passphrase in keyfile mode
-  - mention "!" (exclude-norecurse) type in "patterns" help
-  - document to first heal before running borg recreate to re-chunk stuff,
-    because that will have to get rid of chunks_healthy metadata.
-  - more than 23 is not supported for CHUNK_MAX_EXP, #3115
-  - borg does not respect nodump flag by default any more
-  - clarify same-filesystem requirement for borg upgrade, #2083
-  - update / rephrase cygwin / WSL status, #3174
-  - improve docs about --stats, #3260
-- vagrant: openindiana new clang package
-
-Already contained in 1.1.1 (last minute fix):
-
-- arg parsing: fix fallback function, refactor, #3205. This is a fixup
-  for #3155, which was broken on at least python <= 3.4.2.
-
-
-Version 1.1.1 (2017-10-22)
---------------------------
-
-Compatibility notes:
-
-- The deprecated --no-files-cache is not a global/common option any more,
-  but only available for borg create (it is not needed for anything else).
-  Use --files-cache=disabled instead of --no-files-cache.
-- The nodump flag ("do not backup this file") is not honoured any more by
-  default because this functionality (esp. if it happened by error or
-  unexpected) was rather confusing and unexplainable at first to users.
-  If you want that "do not backup NODUMP-flagged files" behaviour, use:
-  borg create --exclude-nodump ...
-- If you are on Linux and do not need bsdflags archived, consider using
-  ``--nobsdflags`` with ``borg create`` to avoid additional syscalls and
-  speed up backup creation.
-
-Fixes:
-
-- borg recreate: correctly compute part file sizes. fixes cosmetic, but
-  annoying issue as borg check complains about size inconsistencies of part
-  files in affected archives. you can solve that by running borg recreate on
-  these archives, see also #3157.
-- bsdflags support: do not open BLK/CHR/LNK files, avoid crashes and
-  slowness, #3130
-- recreate: don't crash on attic archives w/o time_end, #3109
-- don't crash on repository filesystems w/o hardlink support, #3107
-- don't crash in first part of truncate_and_unlink, #3117
-- fix server-side IndexError crash with clients < 1.0.7, #3192
-- don't show traceback if only a global option is given, show help, #3142
-- cache: use SaveFile for more safety, #3158
-- init: fix wrong encryption choices in command line parser, fix missing
-  "authenticated-blake2", #3103
-- move --no-files-cache from common to borg create options, #3146
-- fix detection of non-local path (failed on ..filename), #3108
-- logging with fileConfig: set json attr on "borg" logger, #3114
-- fix crash with relative BORG_KEY_FILE, #3197
-- show excluded dir with "x" for tagged dirs / caches, #3189
-
-New features:
-
-- create: --nobsdflags and --exclude-nodump options, #3160
-- extract: --nobsdflags option, #3160
-
-Other changes:
-
-- remove annoying hardlinked symlinks warning, #3175
-- vagrant: use self-made FreeBSD 10.3 box, #3022
-- travis: don't brew update, hopefully fixes #2532
-- docs:
-
-  - readme: -e option is required in borg 1.1
-  - add example showing --show-version --show-rc
-  - use --format rather than --list-format (deprecated) in example
-  - update docs about hardlinked symlinks limitation
-
-
-Version 1.1.0 (2017-10-07)
---------------------------
-
-Compatibility notes:
-
-- borg command line: do not put options in between positional arguments
-
-  This sometimes works (e.g. it worked in borg 1.0.x), but can easily stop
-  working if we make positional arguments optional (like it happened for
-  borg create's "paths" argument in 1.1). There are also places in borg 1.0
-  where we do that, so it doesn't work there in general either. #3356
-
-  Good: borg create -v --stats repo::archive path
-  Good: borg create repo::archive path -v --stats
-  Bad:  borg create repo::archive -v --stats path
-
-Fixes:
-
-- fix LD_LIBRARY_PATH restoration for subprocesses, #3077
-- "auto" compression: make sure expensive compression is actually better,
-  otherwise store lz4 compressed data we already computed.
-
-Other changes:
-
-- docs:
-
-  - FAQ: we do not implement futile attempts of ETA / progress displays
-  - manpage: fix typos, update homepage
-  - implement simple "issue" role for manpage generation, #3075
-
-
-Version 1.1.0rc4 (2017-10-01)
------------------------------
-
-Compatibility notes:
-
-- A borg server >= 1.1.0rc4 does not support borg clients 1.1.0b3-b5. #3033
-- The files cache is now controlled differently and has a new default mode:
-
-  - the files cache now uses ctime by default for improved file change
-    detection safety. You can still use mtime for more speed and less safety.
-  - --ignore-inode is deprecated (use --files-cache=... without "inode")
-  - --no-files-cache is deprecated (use --files-cache=disabled)
-
-New features:
-
-- --files-cache - implement files cache mode control, #911
-  You can now control the files cache mode using this option:
-  --files-cache={ctime,mtime,size,inode,rechunk,disabled}
-  (only some combinations are supported). See the docs for details.
-
-Fixes:
-
-- remote progress/logging: deal with partial lines, #2637
-- remote progress: flush json mode output
-- fix subprocess environments, #3050 (and more)
-
-Other changes:
-
-- remove client_supports_log_v3 flag, #3033
-- exclude broken Cython 0.27(.0) in requirements, #3066
-- vagrant:
-
-  - upgrade to FUSE for macOS 3.7.1
-  - use Python 3.5.4 to build the binaries
-- docs:
-
-  - security: change-passphrase only changes the passphrase, #2990
-  - fixed/improved borg create --compression examples, #3034
-  - add note about metadata dedup and --no[ac]time, #2518
-  - twitter account @borgbackup now, better visible, #2948
-  - simplified rate limiting wrapper in FAQ
-
-
-Version 1.1.0rc3 (2017-09-10)
------------------------------
-
-New features:
-
-- delete: support naming multiple archives, #2958
-
-Fixes:
-
-- repo cleanup/write: invalidate cached FDs, #2982
-- fix datetime.isoformat() microseconds issues, #2994
-- recover_segment: use mmap(), lower memory needs, #2987
-
-Other changes:
-
-- with-lock: close segment file before invoking subprocess
-- keymanager: don't depend on optional readline module, #2976
-- docs:
-
-  - fix macOS keychain integration command
-  - show/link new screencasts in README, #2936
-  - document utf-8 locale requirement for json mode, #2273
-- vagrant: clean up shell profile init, user name, #2977
-- test_detect_attic_repo: don't test mount, #2975
-- add debug logging for repository cleanup
-
-
-Version 1.1.0rc2 (2017-08-28)
------------------------------
-
-Compatibility notes:
-
-- list: corrected mix-up of "isomtime" and "mtime" formats. Previously,
-  "isomtime" was the default but produced a verbose human format,
-  while "mtime" produced a ISO-8601-like format.
-  The behaviours have been swapped (so "mtime" is human, "isomtime" is ISO-like),
-  and the default is now "mtime".
-  "isomtime" is now a real ISO-8601 format ("T" between date and time, not a space).
-
-New features:
-
-- None.
-
-Fixes:
-
-- list: fix weird mixup of mtime/isomtime
-- create --timestamp: set start time, #2957
-- ignore corrupt files cache, #2939
-- migrate locks to child PID when daemonize is used
-- fix exitcode of borg serve, #2910
-- only compare contents when chunker params match, #2899
-- umount: try fusermount, then try umount, #2863
-
-Other changes:
-
-- JSON: use a more standard ISO 8601 datetime format, #2376
-- cache: write_archive_index: truncate_and_unlink on error, #2628
-- detect non-upgraded Attic repositories, #1933
-- delete various nogil and threading related lines
-- coala / pylint related improvements
-- docs:
-
-  - renew asciinema/screencasts, #669
-  - create: document exclusion through nodump, #2949
-  - minor formatting fixes
-  - tar: tarpipe example
-  - improve "with-lock" and "info" docs, #2869
-  - detail how to use macOS/GNOME/KDE keyrings for repo passwords, #392
-- travis: only short-circuit docs-only changes for pull requests
-- vagrant:
-
-  - netbsd: bash is already installed
-  - fix netbsd version in PKG_PATH
-  - add exe location to PATH when we build an exe
-
-
-Version 1.1.0rc1 (2017-07-24)
------------------------------
-
-Compatibility notes:
-
-- delete: removed short option for --cache-only
-
-New features:
-
-- support borg list repo --format {comment} {bcomment} {end}, #2081
-- key import: allow reading from stdin, #2760
-
-Fixes:
-
-- with-lock: avoid creating segment files that might be overwritten later, #1867
-- prune: fix checkpoints processing with --glob-archives
-- FUSE: versions view: keep original file extension at end, #2769
-- fix --last, --first: do not accept values <= 0,
-  fix reversed archive ordering with --last
-- include testsuite data (attic.tar.gz) when installing the package
-- use limited unpacker for outer key, for manifest (both security precautions),
-  #2174 #2175
-- fix bashism in shell scripts, #2820, #2816
-- cleanup endianness detection, create _endian.h,
-  fixes build on alpine linux, #2809
-- fix crash with --no-cache-sync (give known chunk size to chunk_incref), #2853
-
-Other changes:
-
-- FUSE: versions view: linear numbering by archive time
-- split up interval parsing from filtering for --keep-within, #2610
-- add a basic .editorconfig, #2734
-- use archive creation time as mtime for FUSE mount, #2834
-- upgrade FUSE for macOS (osxfuse) from 3.5.8 to 3.6.3, #2706
-- hashindex: speed up by replacing modulo with "if" to check for wraparound
-- coala checker / pylint: fixed requirements and .coafile, more ignores
-- borg upgrade: name backup directories as 'before-upgrade', #2811
-- add .mailmap
-- some minor changes suggested by lgtm.com
-- docs:
-
-  - better explanation of the --ignore-inode option relevance, #2800
-  - fix openSUSE command and add openSUSE section
-  - simplify ssh authorized_keys file using "restrict", add legacy note, #2121
-  - mount: show usage of archive filters
-  - mount: add repository example, #2462
-  - info: update and add examples, #2765
-  - prune: include example
-  - improved style / formatting
-  - improved/fixed segments_per_dir docs
-  - recreate: fix wrong "remove unwanted files" example
-  - reference list of status chars in borg recreate --filter description
-  - update source-install docs about doc build dependencies, #2795
-  - cleanup installation docs
-  - file system requirements, update segs per dir
-  - fix checkpoints/parts reference in FAQ, #2859
-- code:
-
-  - hashindex: don't pass side effect into macro
-  - crypto low_level: don't mutate local bytes()
-  - use dash_open function to open file or "-" for stdin/stdout
-  - archiver: argparse cleanup / refactoring
-  - shellpattern: add match_end arg
-- tests: added some additional unit tests, some fixes, #2700 #2710
-- vagrant: fix setup of cygwin, add Debian 9 "stretch"
-- travis: don't perform full travis build on docs-only changes, #2531
-
-
-Version 1.1.0b6 (2017-06-18)
-----------------------------
-
-Compatibility notes:
-
-- Running "borg init" via a "borg serve --append-only" server will *not* create
-  an append-only repository anymore. Use "borg init --append-only" to initialize
-  an append-only repository.
-
-- Repositories in the "repokey" and "repokey-blake2" modes with an empty passphrase
-  are now treated as unencrypted repositories for security checks (e.g.
-  BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK).
-
-  Previously there would be no prompts nor messages if an unknown repository
-  in one of these modes with an empty passphrase was encountered. This would
-  allow an attacker to swap a repository, if one assumed that the lack of
-  password prompts was due to a set BORG_PASSPHRASE.
-
-  Since the "trick" does not work if BORG_PASSPHRASE is set, this does generally
-  not affect scripts.
-
-- Repositories in the "authenticated" mode are now treated as the unencrypted
-  repositories they are.
-
-- The client-side temporary repository cache now holds unencrypted data for better speed.
-
-- borg init: removed the short form of --append-only (-a).
-
-- borg upgrade: removed the short form of --inplace (-i).
-
-New features:
-
-- reimplemented the RepositoryCache, size-limited caching of decrypted repo
-  contents, integrity checked via xxh64. #2515
-- reduced space usage of chunks.archive.d. Existing caches are migrated during
-  a cache sync. #235 #2638
-- integrity checking using xxh64 for important files used by borg, #1101:
-
-  - repository: index and hints files
-  - cache: chunks and files caches, chunks.archive.d
-- improve cache sync speed, #1729
-- create: new --no-cache-sync option
-- add repository mandatory feature flags infrastructure, #1806
-- Verify most operations against SecurityManager. Location, manifest timestamp
-  and key types are now checked for almost all non-debug commands. #2487
-- implement storage quotas, #2517
-- serve: add --restrict-to-repository, #2589
-- BORG_PASSCOMMAND: use external tool providing the key passphrase, #2573
-- borg export-tar, #2519
-- list: --json-lines instead of --json for archive contents, #2439
-- add --debug-profile option (and also "borg debug convert-profile"), #2473
-- implement --glob-archives/-a, #2448
-- normalize authenticated key modes for better naming consistency:
-
-  - rename "authenticated" to "authenticated-blake2" (uses blake2b)
-  - implement "authenticated" mode (uses hmac-sha256)
-
-Fixes:
-
-- hashindex: read/write indices >2 GiB on 32bit systems, better error
-  reporting, #2496
-- repository URLs: implement IPv6 address support and also more informative
-  error message when parsing fails.
-- mount: check whether llfuse is installed before asking for passphrase, #2540
-- mount: do pre-mount checks before opening repository, #2541
-- FUSE:
-
-  - fix crash if empty (None) xattr is read, #2534
-  - fix read(2) caching data in metadata cache
-  - fix negative uid/gid crash (fix crash when mounting archives
-    of external drives made on cygwin), #2674
-  - redo ItemCache, on top of object cache
-  - use decrypted cache
-  - remove unnecessary normpaths
-- serve: ignore --append-only when initializing a repository (borg init), #2501
-- serve: fix incorrect type of exception_short for Errors, #2513
-- fix --exclude and --exclude-from recursing into directories, #2469
-- init: don't allow creating nested repositories, #2563
-- --json: fix encryption[mode] not being the cmdline name
-- remote: propagate Error.traceback correctly
-- fix remote logging and progress, #2241
-
-  - implement --debug-topic for remote servers
-  - remote: restore "Remote:" prefix (as used in 1.0.x)
-  - rpc negotiate: enable v3 log protocol only for supported clients
-  - fix --progress and logging in general for remote
-- fix parse_version, add tests, #2556
-- repository: truncate segments (and also some other files) before unlinking, #2557
-- recreate: keep timestamps as in original archive, #2384
-- recreate: if single archive is not processed, exit 2
-- patterns: don't recurse with ! / --exclude for pf:, #2509
-- cache sync: fix n^2 behaviour in lookup_name
-- extract: don't write to disk with --stdout (affected non-regular-file items), #2645
-- hashindex: implement KeyError, more tests
-
-Other changes:
-
-- remote: show path in PathNotAllowed
-- consider repokey w/o passphrase == unencrypted, #2169
-- consider authenticated mode == unencrypted, #2503
-- restrict key file names, #2560
-- document follow_symlinks requirements, check libc, use stat and chown
-  with follow_symlinks=False, #2507
-- support common options on the main command, #2508
-- support common options on mid-level commands (e.g. borg *key* export)
-- make --progress a common option
-- increase DEFAULT_SEGMENTS_PER_DIR to 1000
-- chunker: fix invalid use of types (function only used by tests)
-- chunker: don't do uint32_t >> 32
-- FUSE:
-
-  - add instrumentation (--debug and SIGUSR1/SIGINFO)
-  - reduced memory usage for repository mounts by lazily instantiating archives
-  - improved archive load times
-- info: use CacheSynchronizer & HashIndex.stats_against (better performance)
-- docs:
-
-  - init: document --encryption as required
-  - security: OpenSSL usage
-  - security: used implementations; note python libraries
-  - security: security track record of OpenSSL and msgpack
-  - patterns: document denial of service (regex, wildcards)
-  - init: note possible denial of service with "none" mode
-  - init: document SHA extension is supported in OpenSSL and thus SHA is
-    faster on AMD Ryzen than blake2b.
-  - book: use A4 format, new builder option format.
-  - book: create appendices
-  - data structures: explain repository compaction
-  - data structures: add chunk layout diagram
-  - data structures: integrity checking
-  - data structures: demingle cache and repo index
-  - Attic FAQ: separate section for attic stuff
-  - FAQ: I get an IntegrityError or similar - what now?
-  - FAQ: Can I use Borg on SMR hard drives?, #2252
-  - FAQ: specify "using inline shell scripts"
-  - add systemd warning regarding placeholders, #2543
-  - xattr: document API
-  - add docs/misc/borg-data-flow data flow chart
-  - debugging facilities
-  - README: how to help the project, #2550
-  - README: add bountysource badge, #2558
-  - fresh new theme + tweaking
-  - logo: vectorized (PDF and SVG) versions
-  - frontends: use headlines - you can link to them
-  - mark --pattern, --patterns-from as experimental
-  - highlight experimental features in online docs
-  - remove regex based pattern examples, #2458
-  - nanorst for "borg help TOPIC" and --help
-  - split deployment
-  - deployment: hosting repositories
-  - deployment: automated backups to a local hard drive
-  - development: vagrant, windows10 requirements
-  - development: update docs remarks
-  - split usage docs, #2627
-  - usage: avoid bash highlight, [options] instead of <options>
-  - usage: add benchmark page
-  - helpers: truncate_and_unlink doc
-  - don't suggest to leak BORG_PASSPHRASE
-  - internals: columnize rather long ToC [webkit fixup]
-    internals: manifest & feature flags
-  - internals: more HashIndex details
-  - internals: fix ASCII art equations
-  - internals: edited obj graph related sections a bit
-  - internals: layers image + description
-  - fix way too small figures in pdf
-  - index: disable syntax highlight (bash)
-  - improve options formatting, fix accidental block quotes
-
-- testing / checking:
-
-  - add support for using coala, #1366
-  - testsuite: add ArchiverCorruptionTestCase
-  - do not test logger name, #2504
-  - call setup_logging after destroying logging config
-  - testsuite.archiver: normalise pytest.raises vs. assert_raises
-  - add test for preserved intermediate folder permissions, #2477
-  - key: add round-trip test
-  - remove attic dependency of the tests, #2505
-  - enable remote tests on cygwin
-  - tests: suppress tar's future timestamp warning
-  - cache sync: add more refcount tests
-  - repository: add tests, including corruption tests
-
-- vagrant:
-
-  - control VM cpus and pytest workers via env vars VMCPUS and XDISTN
-  - update cleaning workdir
-  - fix openbsd shell
-  - add OpenIndiana
-
-- packaging:
-
-  - binaries: don't bundle libssl
-  - setup.py clean to remove compiled files
-  - fail in borg package if version metadata is very broken (setuptools_scm)
-
-- repo / code structure:
-
-  - create borg.algorithms and borg.crypto packages
-  - algorithms: rename crc32 to checksums
-  - move patterns to module, #2469
-  - gitignore: complete paths for src/ excludes
-  - cache: extract CacheConfig class
-  - implement IntegrityCheckedFile + Detached variant, #2502 #1688
-  - introduce popen_with_error_handling to handle common user errors
-
-
-Version 1.1.0b5 (2017-04-30)
-----------------------------
-
-Compatibility notes:
-
-- BORG_HOSTNAME_IS_UNIQUE is now on by default.
-- removed --compression-from feature
-- recreate: add --recompress flag, unify --always-recompress and
-  --recompress
-
-Fixes:
-
-- catch exception for os.link when hardlinks are not supported, #2405
-- borg rename / recreate: expand placeholders, #2386
-- generic support for hardlinks (files, devices, FIFOs), #2324
-- extract: also create parent dir for device files, if needed, #2358
-- extract: if a hardlink master is not in the to-be-extracted subset,
-  the "x" status was not displayed for it, #2351
-- embrace y2038 issue to support 32bit platforms: clamp timestamps to int32,
-  #2347
-- verify_data: fix IntegrityError handling for defect chunks, #2442
-- allow excluding parent and including child, #2314
-
-Other changes:
-
-- refactor compression decision stuff
-- change global compression default to lz4 as well, to be consistent
-  with --compression defaults.
-- placeholders: deny access to internals and other unspecified stuff
-- clearer error message for unrecognized placeholder
-- more clear exception if borg check does not help, #2427
-- vagrant: upgrade FUSE for macOS to 3.5.8, #2346
-- linux binary builds: get rid of glibc 2.13 dependency, #2430
-- docs:
-
-  - placeholders: document escaping
-  - serve: env vars in original commands are ignored
-  - tell what kind of hardlinks we support
-  - more docs about compression
-  - LICENSE: use canonical formulation
-    ("copyright holders and contributors" instead of "author")
-  - document borg init behaviour via append-only borg serve, #2440
-  - be clear about what buzhash is used for, #2390
-  - add hint about chunker params, #2421
-  - clarify borg upgrade docs, #2436
-  - FAQ to explain warning when running borg check --repair, #2341
-  - repository file system requirements, #2080
-  - pre-install considerations
-  - misc. formatting / crossref fixes
-- tests:
-
-  - enhance travis setuptools_scm situation
-  - add extra test for the hashindex
-  - fix invalid param issue in benchmarks
-
-These belong to 1.1.0b4 release, but did not make it into changelog by then:
-
-- vagrant: increase memory for parallel testing
-- lz4 compress: lower max. buffer size, exception handling
-- add docstring to do_benchmark_crud
-- patterns help: mention path full-match in intro
-
-
-Version 1.1.0b4 (2017-03-27)
-----------------------------
-
-Compatibility notes:
-
-- init: the --encryption argument is mandatory now (there are several choices)
-- moved "borg migrate-to-repokey" to "borg key migrate-to-repokey".
-- "borg change-passphrase" is deprecated, use "borg key change-passphrase"
-  instead.
-- the --exclude-if-present option now supports tagging a folder with any
-  filesystem object type (file, folder, etc), instead of expecting only files
-  as tags, #1999
-- the --keep-tag-files option has been deprecated in favor of the new
-  --keep-exclude-tags, to account for the change mentioned above.
-- use lz4 compression by default, #2179
-
-New features:
-
-- JSON API to make developing frontends and automation easier
-  (see :ref:`json_output`)
-
-  - add JSON output to commands: `borg create/list/info --json ...`.
-  - add --log-json option for structured logging output.
-  - add JSON progress information, JSON support for confirmations (yes()).
-- add two new options --pattern and --patterns-from as discussed in #1406
-- new path full match pattern style (pf:) for very fast matching, #2334
-- add 'debug dump-manifest' and 'debug dump-archive' commands
-- add 'borg benchmark crud' command, #1788
-- new 'borg delete --force --force' to delete severely corrupted archives, #1975
-- info: show utilization of maximum archive size, #1452
-- list: add dsize and dcsize keys, #2164
-- paperkey.html: Add interactive html template for printing key backups.
-- key export: add qr html export mode
-- securely erase config file (which might have old encryption key), #2257
-- archived file items: add size to metadata, 'borg extract' and 'borg check' do
-  check the file size for consistency, FUSE uses precomputed size from Item.
-
-Fixes:
-
-- fix remote speed regression introduced in 1.1.0b3, #2185
-- fix regression handling timestamps beyond 2262 (revert bigint removal),
-  introduced in 1.1.0b3, #2321
-- clamp (nano)second values to unproblematic range, #2304
-- hashindex: rebuild hashtable if we have too little empty buckets
-  (performance fix), #2246
-- Location regex: fix bad parsing of wrong syntax
-- ignore posix_fadvise errors in repository.py, #2095
-- borg rpc: use limited msgpack.Unpacker (security precaution), #2139
-- Manifest: Make sure manifest timestamp is strictly monotonically increasing.
-- create: handle BackupOSError on a per-path level in one spot
-- create: clarify -x option / meaning of "same filesystem"
-- create: don't create hard link refs to failed files
-- archive check: detect and fix missing all-zero replacement chunks, #2180
-- files cache: update inode number when --ignore-inode is used, #2226
-- fix decompression exceptions crashing ``check --verify-data`` and others
-  instead of reporting integrity error, #2224 #2221
-- extract: warning for unextracted big extended attributes, #2258, #2161
-- mount: umount on SIGINT/^C when in foreground
-- mount: handle invalid hard link refs
-- mount: fix huge RAM consumption when mounting a repository (saves number of
-  archives * 8 MiB), #2308
-- hashindex: detect mingw byte order #2073
-- hashindex: fix wrong skip_hint on hashindex_set when encountering tombstones,
-  the regression was introduced in #1748
-- fix ChunkIndex.__contains__ assertion  for big-endian archs
-- fix borg key/debug/benchmark crashing without subcommand, #2240
-- Location: accept //servername/share/path
-- correct/refactor calculation of unique/non-unique chunks
-- extract: fix missing call to ProgressIndicator.finish
-- prune: fix error msg, it is --keep-within, not --within
-- fix "auto" compression mode bug (not compressing), #2331
-- fix symlink item fs size computation, #2344
-
-Other changes:
-
-- remote repository: improved async exception processing, #2255 #2225
-- with --compression auto,C, only use C if lz4 achieves at least 3% compression
-- PatternMatcher: only normalize path once, #2338
-- hashindex: separate endian-dependent defs from endian detection
-- migrate-to-repokey: ask using canonical_path() as we do everywhere else.
-- SyncFile: fix use of fd object after close
-- make LoggedIO.close_segment reentrant
-- creating a new segment: use "xb" mode, #2099
-- redo key_creator, key_factory, centralise key knowledge, #2272
-- add return code functions, #2199
-- list: only load cache if needed
-- list: files->items, clarifications
-- list: add "name" key for consistency with info cmd
-- ArchiveFormatter: add "start" key for compatibility with "info"
-- RemoteRepository: account rx/tx bytes
-- setup.py build_usage/build_man/build_api fixes
-- Manifest.in: simplify, exclude .so, .dll and .orig, #2066
-- FUSE: get rid of chunk accounting, st_blocks = ceil(size / blocksize).
-- tests:
-
-  - help python development by testing 3.6-dev
-  - test for borg delete --force
-- vagrant:
-
-  - freebsd: some fixes, #2067
-  - darwin64: use osxfuse 3.5.4 for tests / to build binaries
-  - darwin64: improve VM settings
-  - use python 3.5.3 to build binaries, #2078
-  - upgrade pyinstaller from 3.1.1+ to 3.2.1
-  - pyinstaller: use fixed AND freshly compiled bootloader, #2002
-  - pyinstaller: automatically builds bootloader if missing
-- docs:
-
-  - create really nice man pages
-  - faq: mention --remote-ratelimit in bandwidth limit question
-  - fix caskroom link, #2299
-  - docs/security: reiterate that RPC in Borg does no networking
-  - docs/security: counter tracking, #2266
-  - docs/development: update merge remarks
-  - address SSH batch mode in docs, #2202 #2270
-  - add warning about running build_usage on Python >3.4, #2123
-  - one link per distro in the installation page
-  - improve --exclude-if-present and --keep-exclude-tags, #2268
-  - improve automated backup script in doc, #2214
-  - improve remote-path description
-  - update docs for create -C default change (lz4)
-  - document relative path usage, #1868
-  - document snapshot usage, #2178
-  - corrected some stuff in internals+security
-  - internals: move toctree to after the introduction text
-  - clarify metadata kind, manifest ops
-  - key enc: correct / clarify some stuff, link to internals/security
-  - datas: enc: 1.1.x mas different MACs
-  - datas: enc: correct factual error -- no nonce involved there.
-  - make internals.rst an index page and edit it a bit
-  - add "Cryptography in Borg" and "Remote RPC protocol security" sections
-  - document BORG_HOSTNAME_IS_UNIQUE, #2087
-  - FAQ by categories as proposed by @anarcat in #1802
-  - FAQ: update Which file types, attributes, etc. are *not* preserved?
-  - development: new branching model for git repository
-  - development: define "ours" merge strategy for auto-generated files
-  - create: move --exclude note to main doc
-  - create: move item flags to main doc
-  - fix examples using borg init without -e/--encryption
-  - list: don't print key listings in fat (html + man)
-  - remove Python API docs (were very incomplete, build problems on RTFD)
-  - added FAQ section about backing up root partition
-
-
-Version 1.1.0b3 (2017-01-15)
-----------------------------
-
-Compatibility notes:
-
-- borg init: removed the default of "--encryption/-e", #1979
-  This was done so users do a informed decision about -e mode.
-
-Bug fixes:
-
-- borg recreate: don't rechunkify unless explicitly told so
-- borg info: fixed bug when called without arguments, #1914
-- borg init: fix free space check crashing if disk is full, #1821
-- borg debug delete/get obj: fix wrong reference to exception
-- fix processing of remote ~/ and ~user/ paths (regressed since 1.1.0b1), #1759
-- posix platform module: only build / import on non-win32 platforms, #2041
-
-New features:
-
-- new CRC32 implementations that are much faster than the zlib one used previously, #1970
-- add blake2b key modes (use blake2b as MAC). This links against system libb2,
-  if possible, otherwise uses bundled code
-- automatically remove stale locks - set BORG_HOSTNAME_IS_UNIQUE env var
-  to enable stale lock killing. If set, stale locks in both cache and
-  repository are deleted. #562 #1253
-- borg info <repo>: print general repo information, #1680
-- borg check --first / --last / --sort / --prefix, #1663
-- borg mount --first / --last / --sort / --prefix, #1542
-- implement "health" item formatter key, #1749
-- BORG_SECURITY_DIR to remember security related infos outside the cache.
-  Key type, location and manifest timestamp checks now survive cache
-  deletion. This also means that you can now delete your cache and avoid
-  previous warnings, since Borg can still tell it's safe.
-- implement BORG_NEW_PASSPHRASE, #1768
-
-Other changes:
-
-- borg recreate:
-
-  - remove special-cased --dry-run
-  - update --help
-  - remove bloat: interruption blah, autocommit blah, resuming blah
-  - re-use existing checkpoint functionality
-  - archiver tests: add check_cache tool - lints refcounts
-
-- fixed cache sync performance regression from 1.1.0b1 onwards, #1940
-- syncing the cache without chunks.archive.d (see :ref:`disable_archive_chunks`)
-  now avoids any merges and is thus faster, #1940
-- borg check --verify-data: faster due to linear on-disk-order scan
-- borg debug-xxx commands removed, we use "debug xxx" subcommands now, #1627
-- improve metadata handling speed
-- shortcut hashindex_set by having hashindex_lookup hint about address
-- improve / add progress displays, #1721
-- check for index vs. segment files object count mismatch
-- make RPC protocol more extensible: use named parameters.
-- RemoteRepository: misc. code cleanups / refactors
-- clarify cache/repository README file
-
-- docs:
-
-  - quickstart: add a comment about other (remote) filesystems
-  - quickstart: only give one possible ssh url syntax, all others are
-    documented in usage chapter.
-  - mention file://
-  - document repo URLs / archive location
-  - clarify borg diff help, #980
-  - deployment: synthesize alternative --restrict-to-path example
-  - improve cache / index docs, esp. files cache docs, #1825
-  - document using "git merge 1.0-maint -s recursive -X rename-threshold=20%"
-    for avoiding troubles when merging the 1.0-maint branch into master.
-
-- tests:
-
-  - FUSE tests: catch ENOTSUP on freebsd
-  - FUSE tests: test troublesome xattrs last
-  - fix byte range error in test, #1740
-  - use monkeypatch to set env vars, but only on pytest based tests.
-  - point XDG_*_HOME to temp dirs for tests, #1714
-  - remove all BORG_* env vars from the outer environment
-
-
-Version 1.1.0b2 (2016-10-01)
-----------------------------
-
-Bug fixes:
-
-- fix incorrect preservation of delete tags, leading to "object count mismatch"
-  on borg check, #1598. This only occurred with 1.1.0b1 (not with 1.0.x) and is
-  normally fixed by running another borg create/delete/prune.
-- fix broken --progress for double-cell paths (e.g. CJK), #1624
-- borg recreate: also catch SIGHUP
-- FUSE:
-
-  - fix hardlinks in versions view, #1599
-  - add parameter check to ItemCache.get to make potential failures more clear
-
-New features:
-
-- Archiver, RemoteRepository: add --remote-ratelimit (send data)
-- borg help compression, #1582
-- borg check: delete chunks with integrity errors, #1575, so they can be
-  "repaired" immediately and maybe healed later.
-- archives filters concept (refactoring/unifying older code)
-
-  - covers --first/--last/--prefix/--sort-by options
-  - currently used for borg list/info/delete
-
-Other changes:
-
-- borg check --verify-data slightly tuned (use get_many())
-- change {utcnow} and {now} to ISO-8601 format ("T" date/time separator)
-- repo check: log transaction IDs, improve object count mismatch diagnostic
-- Vagrantfile: use TW's fresh-bootloader pyinstaller branch
-- fix module names in api.rst
-- hashindex: bump api_version
-
-
-Version 1.1.0b1 (2016-08-28)
-----------------------------
-
-New features:
-
-- new commands:
-
-  - borg recreate: re-create existing archives, #787 #686 #630 #70, also see
-    #757, #770.
-
-    - selectively remove files/dirs from old archives
-    - re-compress data
-    - re-chunkify data, e.g. to have upgraded Attic / Borg 0.xx archives
-      deduplicate with Borg 1.x archives or to experiment with chunker-params.
-  - borg diff: show differences between archives
-  - borg with-lock: execute a command with the repository locked, #990
-- borg create:
-
-  - Flexible compression with pattern matching on path/filename,
-    and LZ4 heuristic for deciding compressibility, #810, #1007
-  - visit files in inode order (better speed, esp. for large directories and rotating disks)
-  - in-file checkpoints, #1217
-  - increased default checkpoint interval to 30 minutes (was 5 minutes), #896
-  - added uuid archive format tag, #1151
-  - save mountpoint directories with --one-file-system, makes system restore easier, #1033
-  - Linux: added support for some BSD flags, #1050
-  - add 'x' status for excluded paths, #814
-
-    - also means files excluded via UF_NODUMP, #1080
-- borg check:
-
-  - will not produce the "Checking segments" output unless new --progress option is passed, #824.
-  - --verify-data to verify data cryptographically on the client, #975
-- borg list, #751, #1179
-
-  - removed {formatkeys}, see "borg list --help"
-  - --list-format is deprecated, use --format instead
-  - --format now also applies to listing archives, not only archive contents, #1179
-  - now supports the usual [PATH [PATHS…]] syntax and excludes
-  - new keys: csize, num_chunks, unique_chunks, NUL
-  - supports guaranteed_available hashlib hashes
-    (to avoid varying functionality depending on environment),
-    which includes the SHA1 and SHA2 family as well as MD5
-- borg prune:
-
-  - to better visualize the "thinning out", we now list all archives in
-    reverse time order. rephrase and reorder help text.
-  - implement --keep-last N via --keep-secondly N, also --keep-minutely.
-    assuming that there is not more than 1 backup archive made in 1s,
-    --keep-last N and --keep-secondly N are equivalent, #537
-  - cleanup checkpoints except the latest, #1008
-- borg extract:
-
-  - added --progress, #1449
-  - Linux: limited support for BSD flags, #1050
-- borg info:
-
-  - output is now more similar to borg create --stats, #977
-- borg mount:
-
-  - provide "borgfs" wrapper for borg mount, enables usage via fstab, #743
-  - "versions" mount option - when used with a repository mount, this gives
-    a merged, versioned view of the files in all archives, #729
-- repository:
-
-  - added progress information to commit/compaction phase (often takes some time when deleting/pruning), #1519
-  - automatic recovery for some forms of repository inconsistency, #858
-  - check free space before going forward with a commit, #1336
-  - improved write performance (esp. for rotating media), #985
-
-    - new IO code for Linux
-    - raised default segment size to approx 512 MiB
-  - improved compaction performance, #1041
-  - reduced client CPU load and improved performance for remote repositories, #940
-
-- options that imply output (--show-rc, --show-version, --list, --stats,
-  --progress) don't need -v/--info to have that output displayed, #865
-- add archive comments (via borg (re)create --comment), #842
-- borg list/prune/delete: also output archive id, #731
-- --show-version: shows/logs the borg version, #725
-- added --debug-topic for granular debug logging, #1447
-- use atomic file writing/updating for configuration and key files, #1377
-- BORG_KEY_FILE environment variable, #1001
-- self-testing module, #970
-
-
-Bug fixes:
-
-- list: fixed default output being produced if --format is given with empty parameter, #1489
-- create: fixed overflowing progress line with CJK and similar characters, #1051
-- prune: fixed crash if --prefix resulted in no matches, #1029
-- init: clean up partial repo if passphrase input is aborted, #850
-- info: quote cmdline arguments that have spaces in them
-- fix hardlinks failing in some cases for extracting subtrees, #761
-
-Other changes:
-
-- replace stdlib hmac with OpenSSL, zero-copy decrypt (10-15% increase in
-  performance of hash-lists and extract).
-- improved chunker performance, #1021
-- open repository segment files in exclusive mode (fail-safe), #1134
-- improved error logging, #1440
-- Source:
-
-  - pass meta-data around, #765
-  - move some constants to new constants module
-  - better readability and fewer errors with namedtuples, #823
-  - moved source tree into src/ subdirectory, #1016
-  - made borg.platform a package, #1113
-  - removed dead crypto code, #1032
-  - improved and ported parts of the test suite to py.test, #912
-  - created data classes instead of passing dictionaries around, #981, #1158, #1161
-  - cleaned up imports, #1112
-- Docs:
-
-  - better help texts and sphinx reproduction of usage help:
-
-    - Group options
-    - Nicer list of options in Sphinx
-    - Deduplicate 'Common options' (including --help)
-  - chunker: added some insights by "Voltara", #903
-  - clarify what "deduplicated size" means
-  - fix / update / add package list entries
-  - added a SaltStack usage example, #956
-  - expanded FAQ
-  - new contributors in AUTHORS!
-- Tests:
-
-  - vagrant: add ubuntu/xenial 64bit - this box has still some issues
-  - ChunkBuffer: add test for leaving partial chunk in buffer, fixes #945
-
-
-Version 1.0.13 (2019-02-15)
----------------------------
-
-Please note: this is very likely the last 1.0.x release, please upgrade to 1.1.x.
-
-Bug fixes:
-
-- security fix: configure FUSE with "default_permissions", #3903.
-  "default_permissions" is now enforced by borg by default to let the
-  kernel check uid/gid/mode based permissions.
-  "ignore_permissions" can be given to not enforce "default_permissions".
-- xattrs: fix borg exception handling on ENOSPC error, #3808.
-
-New features:
-
-- Read a passphrase from a file descriptor specified in the
-  BORG_PASSPHRASE_FD environment variable.
-
-Other changes:
-
-- acl platform code: fix acl set return type
-- xattr:
-
-  - add linux {list,get,set}xattr ctypes prototypes
-  - fix darwin flistxattr ctypes prototype
-- testing / travis-ci:
-
-  - fix the homebrew 1.9 issues on travis-ci, #4254
-  - travis OS X: use xcode 8.3 (not broken)
-  - tox.ini: lock requirements
-  - unbreak 1.0-maint on travis, fixes #4123
-- vagrant:
-
-  - misc. fixes
-  - FUSE for macOS: upgrade 3.7.1 to 3.8.3
-  - Python: upgrade 3.5.5 to 3.5.6
-- docs:
-
-  - Update installation instructions for macOS
-  - update release workflow using twine (docs, scripts), #4213
-
-Version 1.0.12 (2018-04-08)
----------------------------
-
-Bug fixes:
-
-- repository: cleanup/write: invalidate cached FDs, tests
-- serve: fix exitcode, #2910
-- extract: set bsdflags last (include immutable flag), #3263
-- create --timestamp: set start time, #2957
-- create: show excluded dir with "x" for tagged dirs / caches, #3189
-- migrate locks to child PID when daemonize is used
-- Buffer: fix wrong thread-local storage use, #2951
-- fix detection of non-local path, #3108
-- fix LDLP restoration for subprocesses, #3077
-- fix subprocess environments (xattr module's fakeroot version check,
-  borg umount, BORG_PASSCOMMAND), #3050
-- remote: deal with partial lines, #2637
-- get rid of datetime.isoformat, use safe parse_timestamp to parse
-  timestamps, #2994
-- build: do .h file content checks in binary mode, fixes build issue for
-  non-ascii header files on pure-ascii locale platforms, #3544 #3639
-- remove platform.uname() call which caused library mismatch issues, #3732
-- add exception handler around deprecated platform.linux_distribution() call
-
-Other changes:
-
-- require msgpack-python >= 0.4.6 and < 0.5.0, see #3753
-- add parens for C preprocessor macro argument usages (did not cause
-  malfunction)
-- ignore corrupt files cache, #2939
-- replace "modulo" with "if" to check for wraparound in hashmap
-- keymanager: don't depend on optional readline module, #2980
-- exclude broken pytest 3.3.0 release
-- exclude broken Cython 0.27(.0) release, #3066
-- flake8: add some ignores
-- docs:
-
-  - create: document exclusion through nodump
-  - document good and problematic option placements, fix examples, #3356
-  - update docs about hardlinked symlinks limitation
-  - faq: we do not implement futile attempts of ETA / progress displays
-  - simplified rate limiting wrapper in FAQ
-  - twitter account @borgbackup, #2948
-  - add note about metadata dedup and --no[ac]time, #2518
-  - change-passphrase only changes the passphrase, #2990
-  - clarify encrypted key format for borg key export, #3296
-  - document sshfs rename workaround, #3315
-  - update release checklist about security fixes
-  - docs about how to verify a signed release, #3634
-  - chunk seed is generated per /repository/
-- vagrant:
-
-  - use FUSE for macOS 3.7.1 to build the macOS binary
-  - use python 3.5.5 to build the binaries
-  - add exe location to PATH when we build an exe
-  - use https pypi url for wheezy
-  - netbsd: bash is already installed
-  - netbsd: fix netbsd version in PKG_PATH
-  - use self-made FreeBSD 10.3 box, #3022
-  - backport fs_init (including related updates) from 1.1
-  - the boxcutter wheezy boxes are 404, use local ones
-- travis:
-
-  - don't perform full Travis build on docs-only changes, #2531
-  - only short-circuit docs-only changes for pull requests
-
-
-Version 1.0.11 (2017-07-21)
----------------------------
-
-Bug fixes:
-
-- use limited unpacker for outer key (security precaution), #2174
-- fix paperkey import bug
-
-Other changes:
-
-- change --checkpoint-interval default from 600s to 1800s, #2841.
-  this improves efficiency for big repositories a lot.
-- docs: fix OpenSUSE command and add OpenSUSE section
-- tests: add tests for split_lstring and paperkey
-- vagrant:
-
-  - fix openbsd shell
-  - backport cpu/ram setup from master
-  - add stretch64 VM
-
-Version 1.0.11rc1 (2017-06-27)
-------------------------------
-
-Bug fixes:
-
-- performance: rebuild hashtable if we have too few empty buckets, #2246.
-  this fixes some sporadic, but severe performance breakdowns.
-- Archive: allocate zeros when needed, #2308
-  fixes huge memory usage of mount (8 MiB × number of archives)
-- IPv6 address support
-  also: Location: more informative exception when parsing fails
-- borg single-file binary: use pyinstaller v3.2.1, #2396
-  this fixes that the prelink cronjob on some distros kills the
-  borg binary by stripping away parts of it.
-- extract:
-
-  - warning for unextracted big extended attributes, #2258
-  - also create parent dir for device files, if needed.
-  - don't write to disk with --stdout, #2645
-- archive check: detect and fix missing all-zero replacement chunks, #2180
-- fix (de)compression exceptions, #2224 #2221
-- files cache: update inode number, #2226
-- borg rpc: use limited msgpack.Unpacker (security precaution), #2139
-- Manifest: use limited msgpack.Unpacker (security precaution), #2175
-- Location: accept //servername/share/path
-- fix ChunkIndex.__contains__ assertion  for big-endian archs (harmless)
-- create: handle BackupOSError on a per-path level in one spot
-- fix error msg, there is no --keep-last in borg 1.0.x, #2282
-- clamp (nano)second values to unproblematic range, #2304
-- fuse / borg mount:
-
-  - fix st_blocks to be an integer (not float) value
-  - fix negative uid/gid crash (they could come into archives e.g. when
-    backing up external drives under cygwin), #2674
-  - fix crash if empty (None) xattr is read
-  - do pre-mount checks before opening repository
-  - check llfuse is installed before asking for passphrase
-- borg rename: expand placeholders, #2386
-- borg serve: fix forced command lines containing BORG_* env vars
-- fix error msg, it is --keep-within, not --within
-- fix borg key/debug/benchmark crashing without subcommand, #2240
-- chunker: fix invalid use of types, don't do uint32_t >> 32
-- document follow_symlinks requirements, check libc, #2507
-
-New features:
-
-- added BORG_PASSCOMMAND environment variable, #2573
-- add minimal version of in repository mandatory feature flags, #2134
-
-  This should allow us to make sure older borg versions can be cleanly
-  prevented from doing operations that are no longer safe because of
-  repository format evolution. This allows more fine grained control than
-  just incrementing the manifest version. So for example a change that
-  still allows new archives to be created but would corrupt the repository
-  when an old version tries to delete an archive or check the repository
-  would add the new feature to the check and delete set but leave it out
-  of the write set.
-- borg delete --force --force to delete severely corrupted archives, #1975
-
-Other changes:
-
-- embrace y2038 issue to support 32bit platforms
-- be more clear that this is a "beyond repair" case, #2427
-- key file names: limit to 100 characters and remove colons from host name
-- upgrade FUSE for macOS to 3.5.8, #2346
-- split up parsing and filtering for --keep-within, better error message, #2610
-- docs:
-
-  - fix caskroom link, #2299
-  - address SSH batch mode, #2202 #2270
-  - improve remote-path description
-  - document snapshot usage, #2178
-  - document relative path usage, #1868
-  - one link per distro in the installation page
-  - development: new branching model in git repository
-  - kill api page
-  - added FAQ section about backing up root partition
-  - add bountysource badge, #2558
-  - create empty docs.txt reequirements, #2694
-  - README: how to help the project
-  - note -v/--verbose requirement on affected options, #2542
-  - document borg init behaviour via append-only borg serve, #2440
-  - be clear about what buzhash is used for (chunking) and want it is not
-    used for (deduplication)- also say already in the readme that we use a
-    cryptohash for dedupe, so people don't worry, #2390
-  - add hint about chunker params to borg upgrade docs, #2421
-  - clarify borg upgrade docs, #2436
-  - quickstart: delete problematic BORG_PASSPHRASE use, #2623
-  - faq: specify "using inline shell scripts"
-  - document pattern denial of service, #2624
-- tests:
-
-  - remove attic dependency of the tests, #2505
-  - travis:
-
-    - enhance travis setuptools_scm situation
-    - install fakeroot for Linux
-  - add test for borg delete --force
-  - enable remote tests on cygwin (the cygwin issue that caused these tests
-    to break was fixed in cygwin at least since cygwin 2.8, maybe even since
-    2.7.0).
-  - remove skipping the noatime tests on GNU/Hurd, #2710
-  - fix borg import issue, add comment, #2718
-  - include attic.tar.gz when installing the package
-    also: add include_package_data=True
-
-Version 1.0.10 (2017-02-13)
----------------------------
-
-Bug fixes:
-
-- Manifest timestamps are now monotonically increasing,
-  this fixes issues when the system clock jumps backwards
-  or is set inconsistently across computers accessing the same repository, #2115
-- Fixed testing regression in 1.0.10rc1 that lead to a hard dependency on
-  py.test >= 3.0, #2112
-
-New features:
-
-- "key export" can now generate a printable HTML page with both a QR code and
-  a human-readable "paperkey" representation (and custom text) through the
-  ``--qr-html`` option.
-
-  The same functionality is also available through `paperkey.html <paperkey.html>`_,
-  which is the same HTML page generated by ``--qr-html``. It works with existing
-  "key export" files and key files.
-
-Other changes:
-
-- docs:
-
-  - language clarification - "borg create --one-file-system" option does not respect
-    mount points, but considers different file systems instead, #2141
-- setup.py: build_api: sort file list for determinism
-
-
-Version 1.0.10rc1 (2017-01-29)
-------------------------------
-
-Bug fixes:
-
-- borg serve: fix transmission data loss of pipe writes, #1268
-  This affects only the cygwin platform (not Linux, BSD, OS X).
-- Avoid triggering an ObjectiveFS bug in xattr retrieval, #1992
-- When running out of buffer memory when reading xattrs, only skip the
-  current file, #1993
-- Fixed "borg upgrade --tam" crashing with unencrypted repositories. Since
-  :ref:`the issue <tam_vuln>` is not relevant for unencrypted repositories,
-  it now does nothing and prints an error, #1981.
-- Fixed change-passphrase crashing with unencrypted repositories, #1978
-- Fixed "borg check repo::archive" indicating success if "archive" does not exist, #1997
-- borg check: print non-exit-code warning if --last or --prefix aren't fulfilled
-- fix bad parsing of wrong repo location syntax
-- create: don't create hard link refs to failed files,
-  mount: handle invalid hard link refs, #2092
-- detect mingw byte order, #2073
-- creating a new segment: use "xb" mode, #2099
-- mount: umount on SIGINT/^C when in foreground, #2082
-
-Other changes:
-
-- binary: use fixed AND freshly compiled pyinstaller bootloader, #2002
-- xattr: ignore empty names returned by llistxattr(2) et al
-- Enable the fault handler: install handlers for the SIGSEGV, SIGFPE, SIGABRT,
-  SIGBUS and SIGILL signals to dump the Python traceback.
-- Also print a traceback on SIGUSR2.
-- borg change-passphrase: print key location (simplify making a backup of it)
-- officially support Python 3.6 (setup.py: add Python 3.6 qualifier)
-- tests:
-
-  - vagrant / travis / tox: add Python 3.6 based testing
-  - vagrant: fix openbsd repo, #2042
-  - vagrant: fix the freebsd64 machine, #2037 #2067
-  - vagrant: use python 3.5.3 to build binaries, #2078
-  - vagrant: use osxfuse 3.5.4 for tests / to build binaries
-    vagrant: improve darwin64 VM settings
-  - travis: fix osxfuse install (fixes OS X testing on Travis CI)
-  - travis: require succeeding OS X tests, #2028
-  - travis: use latest pythons for OS X based testing
-  - use pytest-xdist to parallelize testing
-  - fix xattr test race condition, #2047
-  - setup.cfg: fix pytest deprecation warning, #2050
-- docs:
-
-  - language clarification - VM backup FAQ
-  - borg create: document how to backup stdin, #2013
-  - borg upgrade: fix incorrect title levels
-  - add CVE numbers for issues fixed in 1.0.9, #2106
-- fix typos (taken from Debian package patch)
-- remote: include data hexdump in "unexpected RPC data" error message
-- remote: log SSH command line at debug level
-- API_VERSION: use numberspaces, #2023
-- remove .github from pypi package, #2051
-- add pip and setuptools to requirements file, #2030
-- SyncFile: fix use of fd object after close (cosmetic)
-- Manifest.in: simplify, exclude \*.{so,dll,orig}, #2066
-- ignore posix_fadvise errors in repository.py, #2095
-  (works around issues with docker on ARM)
-- make LoggedIO.close_segment reentrant, avoid reentrance
-
-
-Version 1.0.9 (2016-12-20)
---------------------------
-
-Security fixes:
-
-- A flaw in the cryptographic authentication scheme in Borg allowed an attacker
-  to spoof the manifest. See :ref:`tam_vuln` above for the steps you should
-  take.
-
-  CVE-2016-10099 was assigned to this vulnerability.
-- borg check: When rebuilding the manifest (which should only be needed very rarely)
-  duplicate archive names would be handled on a "first come first serve" basis, allowing
-  an attacker to apparently replace archives.
-
-  CVE-2016-10100 was assigned to this vulnerability.
-
-Bug fixes:
-
-- borg check:
-
-  - rebuild manifest if it's corrupted
-  - skip corrupted chunks during manifest rebuild
-- fix TypeError in integrity error handler, #1903, #1894
-- fix location parser for archives with @ char (regression introduced in 1.0.8), #1930
-- fix wrong duration/timestamps if system clock jumped during a create
-- fix progress display not updating if system clock jumps backwards
-- fix checkpoint interval being incorrect if system clock jumps
-
-Other changes:
-
-- docs:
-
-  - add python3-devel as a dependency for cygwin-based installation
-  - clarify extract is relative to current directory
-  - FAQ: fix link to changelog
-  - markup fixes
-- tests:
-
-  - test_get\_(cache|keys)_dir: clean env state, #1897
-  - get back pytest's pretty assertion failures, #1938
-- setup.py build_usage:
-
-  - fixed build_usage not processing all commands
-  - fixed build_usage not generating includes for debug commands
-
-
-Version 1.0.9rc1 (2016-11-27)
------------------------------
-
-Bug fixes:
-
-- files cache: fix determination of newest mtime in backup set (which is
-  used in cache cleanup and led to wrong "A" [added] status for unchanged
-  files in next backup), #1860.
-
-- borg check:
-
-  - fix incorrectly reporting attic 0.13 and earlier archives as corrupt
-  - handle repo w/o objects gracefully and also bail out early if repo is
-    *completely* empty, #1815.
-- fix tox/pybuild in 1.0-maint
-- at xattr module import time, loggers are not initialized yet
-
-New features:
-
-- borg umount <mountpoint>
-  exposed already existing umount code via the CLI api, so users can use it,
-  which is more consistent than using borg to mount and fusermount -u (or
-  umount) to un-mount, #1855.
-- implement borg create --noatime --noctime, fixes #1853
-
-Other changes:
-
-- docs:
-
-  - display README correctly on PyPI
-  - improve cache / index docs, esp. files cache docs, fixes #1825
-  - different pattern matching for --exclude, #1779
-  - datetime formatting examples for {now} placeholder, #1822
-  - clarify passphrase mode attic repo upgrade, #1854
-  - clarify --umask usage, #1859
-  - clarify how to choose PR target branch
-  - clarify prune behavior for different archive contents, #1824
-  - fix PDF issues, add logo, fix authors, headings, TOC
-  - move security verification to support section
-  - fix links in standalone README (:ref: tags)
-  - add link to security contact in README
-  - add FAQ about security
-  - move fork differences to FAQ
-  - add more details about resource usage
-- tests: skip remote tests on cygwin, #1268
-- travis:
-
-  - allow OS X failures until the brew cask osxfuse issue is fixed
-  - caskroom osxfuse-beta gone, it's osxfuse now (3.5.3)
-- vagrant:
-
-  - upgrade OSXfuse / FUSE for macOS to 3.5.3
-  - remove llfuse from tox.ini at a central place
-  - do not try to install llfuse on centos6
-  - fix FUSE test for darwin, #1546
-  - add windows virtual machine with cygwin
-  - Vagrantfile cleanup / code deduplication
-
-
-Version 1.0.8 (2016-10-29)
---------------------------
-
-Bug fixes:
-
-- RemoteRepository: Fix busy wait in call_many, #940
-
-New features:
-
-- implement borgmajor/borgminor/borgpatch placeholders, #1694
-  {borgversion} was already there (full version string). With the new
-  placeholders you can now also get e.g. 1 or 1.0 or 1.0.8.
-
-Other changes:
-
-- avoid previous_location mismatch, #1741
-
-  due to the changed canonicalization for relative paths in PR #1711 / #1655
-  (implement /./ relpath hack), there would be a changed repo location warning
-  and the user would be asked if this is ok. this would break automation and
-  require manual intervention, which is unwanted.
-
-  thus, we automatically fix the previous_location config entry, if it only
-  changed in the expected way, but still means the same location.
-
-- docs:
-
-  - deployment.rst: do not use bare variables in ansible snippet
-  - add clarification about append-only mode, #1689
-  - setup.py: add comment about requiring llfuse, #1726
-  - update usage.rst / api.rst
-  - repo url / archive location docs + typo fix
-  - quickstart: add a comment about other (remote) filesystems
-
-- vagrant / tests:
-
-  - no chown when rsyncing (fixes boxes w/o vagrant group)
-  - fix FUSE permission issues on linux/freebsd, #1544
-  - skip FUSE test for borg binary + fakeroot
-  - ignore security.selinux xattrs, fixes tests on centos, #1735
-
-
-Version 1.0.8rc1 (2016-10-17)
------------------------------
-
-Bug fixes:
-
-- fix signal handling (SIGINT, SIGTERM, SIGHUP), #1620 #1593
-  Fixes e.g. leftover lock files for quickly repeated signals (e.g. Ctrl-C
-  Ctrl-C) or lost connections or systemd sending SIGHUP.
-- progress display: adapt formatting to narrow screens, do not crash, #1628
-- borg create --read-special - fix crash on broken symlink, #1584.
-  also correctly processes broken symlinks. before this regressed to a crash
-  (5b45385) a broken symlink would've been skipped.
-- process_symlink: fix missing backup_io()
-  Fixes a chmod/chown/chgrp/unlink/rename/... crash race between getting
-  dirents and dispatching to process_symlink.
-- yes(): abort on wrong answers, saying so, #1622
-- fixed exception borg serve raised when connection was closed before repository
-  was opened. Add an error message for this.
-- fix read-from-closed-FD issue, #1551
-  (this seems not to get triggered in 1.0.x, but was discovered in master)
-- hashindex: fix iterators (always raise StopIteration when exhausted)
-  (this seems not to get triggered in 1.0.x, but was discovered in master)
-- enable relative paths in ssh:// repo URLs, via /./relpath hack, #1655
-- allow repo paths with colons, #1705
-- update changed repo location immediately after acceptance, #1524
-- fix debug get-obj / delete-obj crash if object not found and remote repo,
-  #1684
-- pyinstaller: use a spec file to build borg.exe binary, exclude osxfuse dylib
-  on Mac OS X (avoids mismatch lib <-> driver), #1619
-
-New features:
-
-- add "borg key export" / "borg key import" commands, #1555, so users are able
-  to backup / restore their encryption keys more easily.
-
-  Supported formats are the keyfile format used by borg internally and a
-  special "paper" format with by line checksums for printed backups. For the
-  paper format, the import is an interactive process which checks each line as
-  soon as it is input.
-- add "borg debug-refcount-obj" to determine a repo objects' referrer counts,
-  #1352
-
-Other changes:
-
-- add "borg debug ..." subcommands
-  (borg debug-* still works, but will be removed in borg 1.1)
-- setup.py: Add subcommand support to build_usage.
-- remote: change exception message for unexpected RPC data format to indicate
-  dataflow direction.
-- improved messages / error reporting:
-
-  - IntegrityError: add placeholder for message, so that the message we give
-    appears not only in the traceback, but also in the (short) error message,
-    #1572
-  - borg.key: include chunk id in exception msgs, #1571
-  - better messages for cache newer than repo, #1700
-- vagrant (testing/build VMs):
-
-  - upgrade OSXfuse / FUSE for macOS to 3.5.2
-  - update Debian Wheezy boxes, #1686
-  - openbsd / netbsd: use own boxes, fixes misc rsync installation and
-    FUSE/llfuse related testing issues, #1695 #1696 #1670 #1671 #1728
-- docs:
-
-  - add docs for "key export" and "key import" commands, #1641
-  - fix inconsistency in FAQ (pv-wrapper).
-  - fix second block in "Easy to use" section not showing on GitHub, #1576
-  - add bestpractices badge
-  - link reference docs and faq about BORG_FILES_CACHE_TTL, #1561
-  - improve borg info --help, explain size infos, #1532
-  - add release signing key / security contact to README, #1560
-  - add contribution guidelines for developers
-  - development.rst: add sphinx_rtd_theme to the sphinx install command
-  - adjust border color in borg.css
-  - add debug-info usage help file
-  - internals.rst: fix typos
-  - setup.py: fix build_usage to always process all commands
-  - added docs explaining multiple --restrict-to-path flags, #1602
-  - add more specific warning about write-access debug commands, #1587
-  - clarify FAQ regarding backup of virtual machines, #1672
-- tests:
-
-  - work around FUSE xattr test issue with recent fakeroot
-  - simplify repo/hashindex tests
-  - travis: test FUSE-enabled borg, use trusty to have a recent FUSE
-  - re-enable FUSE tests for RemoteArchiver (no deadlocks any more)
-  - clean env for pytest based tests, #1714
-  - fuse_mount contextmanager: accept any options
-
-
-Version 1.0.7 (2016-08-19)
---------------------------
-
-Security fixes:
-
-- borg serve: fix security issue with remote repository access, #1428
-  If you used e.g. --restrict-to-path /path/client1/ (with or without trailing
-  slash does not make a difference), it acted like a path prefix match using
-  /path/client1 (note the missing trailing slash) - the code then also allowed
-  working in e.g. /path/client13 or /path/client1000.
-
-  As this could accidentally lead to major security/privacy issues depending on
-  the paths you use, the behaviour was changed to be a strict directory match.
-  That means --restrict-to-path /path/client1 (with or without trailing slash
-  does not make a difference) now uses /path/client1/ internally (note the
-  trailing slash here!) for matching and allows precisely that path AND any
-  path below it. So, /path/client1 is allowed, /path/client1/repo1 is allowed,
-  but not /path/client13 or /path/client1000.
-
-  If you willingly used the undocumented (dangerous) previous behaviour, you
-  may need to rearrange your --restrict-to-path paths now. We are sorry if
-  that causes work for you, but we did not want a potentially dangerous
-  behaviour in the software (not even using a for-backwards-compat option).
-
-Bug fixes:
-
-- fixed repeated LockTimeout exceptions when borg serve tried to write into
-  a already write-locked repo (e.g. by a borg mount), #502 part b)
-  This was solved by the fix for #1220 in 1.0.7rc1 already.
-- fix cosmetics + file leftover for "not a valid borg repository", #1490
-- Cache: release lock if cache is invalid, #1501
-- borg extract --strip-components: fix leak of preloaded chunk contents
-- Repository, when a InvalidRepository exception happens:
-
-  - fix spurious, empty lock.roster
-  - fix repo not closed cleanly
-
-New features:
-
-- implement borg debug-info, fixes #1122
-  (just calls already existing code via cli, same output as below tracebacks)
-
-Other changes:
-
-- skip the O_NOATIME test on GNU Hurd, fixes #1315
-  (this is a very minor issue and the GNU Hurd project knows the bug)
-- document using a clean repo to test / build the release
-
-
-Version 1.0.7rc2 (2016-08-13)
------------------------------
-
-Bug fixes:
-
-- do not write objects to repository that are bigger than the allowed size,
-  borg will reject reading them, #1451.
-
-  Important: if you created archives with many millions of files or
-  directories, please verify if you can open them successfully,
-  e.g. try a "borg list REPO::ARCHIVE".
-- lz4 compression: dynamically enlarge the (de)compression buffer, the static
-  buffer was not big enough for archives with extremely many items, #1453
-- larger item metadata stream chunks, raise archive item limit by 8x, #1452
-- fix untracked segments made by moved DELETEs, #1442
-
-  Impact: Previously (metadata) segments could become untracked when deleting data,
-  these would never be cleaned up.
-- extended attributes (xattrs) related fixes:
-
-  - fixed a race condition in xattrs querying that led to the entire file not
-    being backed up (while logging the error, exit code = 1), #1469
-  - fixed a race condition in xattrs querying that led to a crash, #1462
-  - raise OSError including the error message derived from errno, deal with
-    path being a integer FD
-
-Other changes:
-
-- print active env var override by default, #1467
-- xattr module: refactor code, deduplicate, clean up
-- repository: split object size check into too small and too big
-- add a transaction_id assertion, so borg init on a broken (inconsistent)
-  filesystem does not look like a coding error in borg, but points to the
-  real problem.
-- explain confusing TypeError caused by compat support for old servers, #1456
-- add forgotten usage help file from build_usage
-- refactor/unify buffer code into helpers.Buffer class, add tests
-- docs:
-
-  - document archive limitation, #1452
-  - improve prune examples
-
-
-Version 1.0.7rc1 (2016-08-05)
------------------------------
-
-Bug fixes:
-
-- fix repo lock deadlocks (related to lock upgrade), #1220
-- catch unpacker exceptions, resync, #1351
-- fix borg break-lock ignoring BORG_REPO env var, #1324
-- files cache performance fixes (fixes unnecessary re-reading/chunking/
-  hashing of unmodified files for some use cases):
-
-  - fix unintended file cache eviction, #1430
-  - implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10
-    to 20, #1338
-- FUSE:
-
-  - cache partially read data chunks (performance), #965, #966
-  - always create a root dir, #1125
-- use an OrderedDict for helptext, making the build reproducible, #1346
-- RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
-- ignore stdout/stderr broken pipe errors (cosmetic), #1116
-
-New features:
-
-- better borg versions management support (useful esp. for borg servers
-  wanting to offer multiple borg versions and for clients wanting to choose
-  a specific server borg version), #1392:
-
-  - add BORG_VERSION environment variable before executing "borg serve" via ssh
-  - add new placeholder {borgversion}
-  - substitute placeholders in --remote-path
-
-- borg init --append-only option (makes using the more secure append-only mode
-  more convenient. when used remotely, this requires 1.0.7+ also on the borg
-  server), #1291.
-
-Other changes:
-
-- Vagrantfile:
-
-  - darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
-  - xenial64: use user "ubuntu", not "vagrant" (as usual), #1331
-- tests:
-
-  - fix FUSE tests on OS X, #1433
-- docs:
-
-  - FAQ: add backup using stable filesystem names recommendation
-  - FAQ about glibc compatibility added, #491, glibc-check improved
-  - FAQ: 'A' unchanged file; remove ambiguous entry age sentence.
-  - OS X: install pkg-config to build with FUSE support, fixes #1400
-  - add notes about shell/sudo pitfalls with env. vars, #1380
-  - added platform feature matrix
-- implement borg debug-dump-repo-objs
-
-
-Version 1.0.6 (2016-07-12)
---------------------------
-
-Bug fixes:
-
-- Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
-- Fix crash with unclear message if the libc is not found, #1314, #1111
-
-Other changes:
-
-- tests:
-
-  - Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
-  - Fixed sparse file tests for (file) systems not supporting it, #1310
-- docs:
-
-  - Fixed syntax highlighting, #1313
-  - misc docs: added data processing overview picture
-
-
-Version 1.0.6rc1 (2016-07-10)
------------------------------
-
-New features:
-
-- borg check --repair: heal damaged files if missing chunks re-appear (e.g. if
-  the previously missing chunk was added again in a later backup archive),
-  #148. (*) Also improved logging.
-
-Bug fixes:
-
-- sync_dir: silence fsync() failing with EINVAL, #1287
-  Some network filesystems (like smbfs) don't support this and we use this in
-  repository code.
-- borg mount (FUSE):
-
-  - fix directories being shadowed when contained paths were also specified,
-    #1295
-  - raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is
-    used), #1302. (*)
-- borg extract: warn if a damaged file is extracted, #1299. (*)
-- Added some missing return code checks (ChunkIndex._add, hashindex_resize).
-- borg check: fix/optimize initial hash table size, avoids resize of the table.
-
-Other changes:
-
-- tests:
-
-  - add more FUSE tests, #1284
-  - deduplicate FUSE (u)mount code
-  - fix borg binary test issues, #862
-- docs:
-
-  - changelog: added release dates to older borg releases
-  - fix some sphinx (docs generator) warnings, #881
-
-Notes:
-
-(*) Some features depend on information (chunks_healthy list) added to item
-metadata when a file with missing chunks was "repaired" using all-zero
-replacement chunks. The chunks_healthy list is generated since borg 1.0.4,
-thus borg can't recognize such "repaired" (but content-damaged) files if the
-repair was done with an older borg version.
-
-
-Version 1.0.5 (2016-07-07)
---------------------------
-
-Bug fixes:
-
-- borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282
-
-Other changes:
-
-- backport some FAQ entries from master branch
-- add release helper scripts
-- Vagrantfile:
-
-  - centos6: no FUSE, don't build binary
-  - add xz for redhat-like dists
-
-
-Version 1.0.4 (2016-07-07)
---------------------------
-
-New features:
-
-- borg serve --append-only, #1168
-  This was included because it was a simple change (append-only functionality
-  was already present via repository config file) and makes better security now
-  practically usable.
-- BORG_REMOTE_PATH environment variable, #1258
-  This was included because it was a simple change (--remote-path cli option
-  was already present) and makes borg much easier to use if you need it.
-- Repository: cleanup incomplete transaction on "no space left" condition.
-  In many cases, this can avoid a 100% full repo filesystem (which is very
-  problematic as borg always needs free space - even to delete archives).
-
-Bug fixes:
-
-- Fix wrong handling and reporting of OSErrors in borg create, #1138.
-  This was a serious issue: in the context of "borg create", errors like
-  repository I/O errors (e.g. disk I/O errors, ssh repo connection errors)
-  were handled badly and did not lead to a crash (which would be good for this
-  case, because the repo transaction would be incomplete and trigger a
-  transaction rollback to clean up).
-  Now, error handling for source files is cleanly separated from every other
-  error handling, so only problematic input files are logged and skipped.
-- Implement fail-safe error handling for borg extract.
-  Note that this isn't nearly as critical as the borg create error handling
-  bug, since nothing is written to the repo. So this was "merely" misleading
-  error reporting.
-- Add missing error handler in directory attr restore loop.
-- repo: make sure write data hits disk before the commit tag (#1236) and also
-  sync the containing directory.
-- FUSE: getxattr fail must use errno.ENOATTR, #1126
-  (fixes Mac OS X Finder malfunction: "zero bytes" file length, access denied)
-- borg check --repair: do not lose information about the good/original chunks.
-  If we do not lose the original chunk IDs list when "repairing" a file
-  (replacing missing chunks with all-zero chunks), we have a chance to "heal"
-  the file back into its original state later, in case the chunks re-appear
-  (e.g. in a fresh backup). Healing is not implemented yet, see #148.
-- fixes for --read-special mode:
-
-  - ignore known files cache, #1241
-  - fake regular file mode, #1214
-  - improve symlinks handling, #1215
-- remove passphrase from subprocess environment, #1105
-- Ignore empty index file (will trigger index rebuild), #1195
-- add missing placeholder support for --prefix, #1027
-- improve exception handling for placeholder replacement
-- catch and format exceptions in arg parsing
-- helpers: fix "undefined name 'e'" in exception handler
-- better error handling for missing repo manifest, #1043
-- borg delete:
-
-  - make it possible to delete a repo without manifest
-  - borg delete --forced allows one to delete corrupted archives, #1139
-- borg check:
-
-  - make borg check work for empty repo
-  - fix resync and msgpacked item qualifier, #1135
-  - rebuild_manifest: fix crash if 'name' or 'time' key were missing.
-  - better validation of item metadata dicts, #1130
-  - better validation of archive metadata dicts
-- close the repo on exit - even if rollback did not work, #1197.
-  This is rather cosmetic, it avoids repo closing in the destructor.
-
-- tests:
-
-  - fix sparse file test, #1170
-  - flake8: ignore new F405, #1185
-  - catch "invalid argument" on cygwin, #257
-  - fix sparseness assertion in test prep, #1264
-
-Other changes:
-
-- make borg build/work on OpenSSL 1.0 and 1.1, #1187
-- docs / help:
-
-  - fix / clarify prune help, #1143
-  - fix "patterns" help formatting
-  - add missing docs / help about placeholders
-  - resources: rename atticmatic to borgmatic
-  - document sshd settings, #545
-  - more details about checkpoints, add split trick, #1171
-  - support docs: add freenode web chat link, #1175
-  - add prune visualization / example, #723
-  - add note that Fnmatch is default, #1247
-  - make clear that lzma levels > 6 are a waste of cpu cycles
-  - add a "do not edit" note to auto-generated files, #1250
-  - update cygwin installation docs
-- repository interoperability with borg master (1.1dev) branch:
-
-  - borg check: read item metadata keys from manifest, #1147
-  - read v2 hints files, #1235
-  - fix hints file "unknown version" error handling bug
-- tests: add tests for format_line
-- llfuse: update version requirement for freebsd
-- Vagrantfile:
-
-  - use openbsd 5.9, #716
-  - do not install llfuse on netbsd (broken)
-  - update OSXfuse to version 3.3.3
-  - use Python 3.5.2 to build the binaries
-- glibc compatibility checker: scripts/glibc_check.py
-- add .eggs to .gitignore
-
-
-Version 1.0.3 (2016-05-20)
---------------------------
-
-Bug fixes:
-
-- prune: avoid that checkpoints are kept and completed archives are deleted in
-  a prune run), #997
-- prune: fix commandline argument validation - some valid command lines were
-  considered invalid (annoying, but harmless), #942
-- fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
-- repository: fix commit tags being seen in data
-- when probing key files, do binary reads. avoids crash when non-borg binary
-  files are located in borg's key files directory.
-- handle SIGTERM and make a clean exit - avoids orphan lock files.
-- repository cache: don't cache large objects (avoid using lots of temp. disk
-  space), #1063
-
-Other changes:
-
-- Vagrantfile: OS X: update osxfuse / install lzma package, #933
-- setup.py: add check for platform_darwin.c
-- setup.py: on freebsd, use a llfuse release that builds ok
-- docs / help:
-
-  - update readthedocs URLs, #991
-  - add missing docs for "borg break-lock", #992
-  - borg create help: add some words to about the archive name
-  - borg create help: document format tags, #894
-
-
-Version 1.0.2 (2016-04-16)
---------------------------
-
-Bug fixes:
-
-- fix malfunction and potential corruption on (nowadays rather rare) big-endian
-  architectures or bi-endian archs in (rare) BE mode. #886, #889
-
-  cache resync / index merge was malfunctioning due to this, potentially
-  leading to data loss. borg info had cosmetic issues (displayed wrong values).
-
-  note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs
-  in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.
-- add overflow and range checks for 1st (special) uint32 of the hashindex
-  values, switch from int32 to uint32.
-- fix so that refcount will never overflow, but just stick to max. value after
-  a overflow would have occurred.
-- borg delete: fix --cache-only for broken caches, #874
-
-  Makes --cache-only idempotent: it won't fail if the cache is already deleted.
-- fixed borg create --one-file-system erroneously traversing into other
-  filesystems (if starting fs device number was 0), #873
-- workaround a bug in Linux fadvise FADV_DONTNEED, #907
-
-Other changes:
-
-- better test coverage for hashindex, incl. overflow testing, checking correct
-  computations so endianness issues would be discovered.
-- reproducible doc for ProgressIndicator*,  make the build reproducible.
-- use latest llfuse for vagrant machines
-- docs:
-
-  - use /path/to/repo in examples, fixes #901
-  - fix confusing usage of "repo" as archive name (use "arch")
-
-
-Version 1.0.1 (2016-04-08)
---------------------------
-
-New features:
-
-Usually there are no new features in a bugfix release, but these were added
-due to their high impact on security/safety/speed or because they are fixes
-also:
-
-- append-only mode for repositories, #809, #36 (see docs)
-- borg create: add --ignore-inode option to make borg detect unmodified files
-  even if your filesystem does not have stable inode numbers (like sshfs and
-  possibly CIFS).
-- add options --warning, --error, --critical for missing log levels, #826.
-  it's not recommended to suppress warnings or errors, but the user may decide
-  this on his own.
-  note: --warning is not given to borg serve so a <= 1.0.0 borg will still
-  work as server (it is not needed as it is the default).
-  do not use --error or --critical when using a <= 1.0.0 borg server.
-
-Bug fixes:
-
-- fix silently skipping EIO, #748
-- add context manager for Repository (avoid orphan repository locks), #285
-- do not sleep for >60s while waiting for lock, #773
-- unpack file stats before passing to FUSE
-- fix build on illumos
-- don't try to backup doors or event ports (Solaris and derivatives)
-- remove useless/misleading libc version display, #738
-- test suite: reset exit code of persistent archiver, #844
-- RemoteRepository: clean up pipe if remote open() fails
-- Remote: don't print tracebacks for Error exceptions handled downstream, #792
-- if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
-  instead, #791
-- ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
-- fix capitalization, add ellipses, change log level to debug for 2 messages,
-  #798
-
-Other changes:
-
-- update llfuse requirement, llfuse 1.0 works
-- update OS / dist packages on build machines, #717
-- prefer showing --info over -v in usage help, #859
-- docs:
-
-  - fix cygwin requirements (gcc-g++)
-  - document how to debug / file filesystem issues, #664
-  - fix reproducible build of api docs
-  - RTD theme: CSS !important overwrite, #727
-  - Document logo font. Recreate logo png. Remove GIMP logo file.
-
-
-Version 1.0.0 (2016-03-05)
---------------------------
-
-The major release number change (0.x -> 1.x) indicates bigger incompatible
-changes, please read the compatibility notes, adapt / test your scripts and
-check your backup logs.
-
-Compatibility notes:
-
-- drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490
-  note: we provide binaries that include python 3.5.1 and everything else
-  needed. they are an option in case you are stuck with < 3.4 otherwise.
-- change encryption to be on by default (using "repokey" mode)
-- moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys,
-  you can either move them manually or run "borg upgrade <REPO>"
-- remove support for --encryption=passphrase,
-  use borg migrate-to-repokey to switch to repokey mode, #97
-- remove deprecated --compression <number>,
-  use --compression zlib,<number> instead
-  in case of 0, you could also use --compression none
-- remove deprecated --hourly/daily/weekly/monthly/yearly
-  use --keep-hourly/daily/weekly/monthly/yearly instead
-- remove deprecated --do-not-cross-mountpoints,
-  use --one-file-system instead
-- disambiguate -p option, #563:
-
-  - -p now is same as --progress
-  - -P now is same as --prefix
-- remove deprecated "borg verify",
-  use "borg extract --dry-run" instead
-- cleanup environment variable semantics, #355
-  the environment variables used to be "yes sayers" when set, this was
-  conceptually generalized to "automatic answerers" and they just give their
-  value as answer (as if you typed in that value when being asked).
-  See the "usage" / "Environment Variables" section of the docs for details.
-- change the builtin default for --chunker-params, create 2MiB chunks, #343
-  --chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095
-
-  one of the biggest issues with borg < 1.0 (and also attic) was that it had a
-  default target chunk size of 64kiB, thus it created a lot of chunks and thus
-  also a huge chunk management overhead (high RAM and disk usage).
-
-  please note that the new default won't change the chunks that you already
-  have in your repository. the new big chunks do not deduplicate with the old
-  small chunks, so expect your repo to grow at least by the size of every
-  changed file and in the worst case (e.g. if your files cache was lost / is
-  not used) by the size of every file (minus any compression you might use).
-
-  in case you want to immediately see a much lower resource usage (RAM / disk)
-  for chunks management, it might be better to start with a new repo than
-  continuing in the existing repo (with an existing repo, you'ld have to wait
-  until all archives with small chunks got pruned to see a lower resource
-  usage).
-
-  if you used the old --chunker-params default value (or if you did not use
-  --chunker-params option at all) and you'ld like to continue using small
-  chunks (and you accept the huge resource usage that comes with that), just
-  explicitly use borg create --chunker-params=10,23,16,4095.
-- archive timestamps: the 'time' timestamp now refers to archive creation
-  start time (was: end time), the new 'time_end' timestamp refers to archive
-  creation end time. This might affect prune if your backups take rather long.
-  if you give a timestamp via cli this is stored into 'time', therefore it now
-  needs to mean archive creation start time.
-
-New features:
-
-- implement password roundtrip, #695
-
-Bug fixes:
-
-- remote end does not need cache nor keys directories, do not create them, #701
-- added retry counter for passwords, #703
-
-Other changes:
-
-- fix compiler warnings, #697
-- docs:
-
-  - update README.rst to new changelog location in docs/changes.rst
-  - add Teemu to AUTHORS
-  - changes.rst: fix old chunker params, #698
-  - FAQ: how to limit bandwidth
-
-
-Version 1.0.0rc2 (2016-02-28)
------------------------------
-
-New features:
-
-- format options for location: user, pid, fqdn, hostname, now, utcnow, user
-- borg list --list-format
-- borg prune -v --list enables the keep/prune list output, #658
-
-Bug fixes:
-
-- fix _open_rb noatime handling, #657
-- add a simple archivename validator, #680
-- borg create --stats: show timestamps in localtime, use same labels/formatting
-  as borg info, #651
-- llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)
-
-Other changes:
-
-- it is now possible to use "pip install borgbackup[fuse]" to automatically
-  install the llfuse dependency using the correct version requirement
-  for it. you still need to care about having installed the FUSE / build
-  related OS package first, though, so that building llfuse can succeed.
-- Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
-- Vagrant: use pyinstaller v3.1.1 to build binaries
-- docs:
-
-  - borg upgrade: add to docs that only LOCAL repos are supported
-  - borg upgrade also handles borg 0.xx -> 1.0
-  - use pip extras or requirements file to install llfuse
-  - fix order in release process
-  - updated usage docs and other minor / cosmetic fixes
-  - verified borg examples in docs, #644
-  - freebsd dependency installation and FUSE configuration, #649
-  - add example how to restore a raw device, #671
-  - add a hint about the dev headers needed when installing from source
-  - add examples for delete (and handle delete after list, before prune), #656
-  - update example for borg create -v --stats (use iso datetime format), #663
-  - added example to BORG_RSH docs
-  - "connection closed by remote": add FAQ entry and point to issue #636
-
-
-Version 1.0.0rc1 (2016-02-07)
------------------------------
-
-New features:
-
-- borg migrate-to-repokey ("passphrase" -> "repokey" encryption key mode)
-- implement --short for borg list REPO, #611
-- implement --list for borg extract (consistency with borg create)
-- borg serve: overwrite client's --restrict-to-path with ssh forced command's
-  option value (but keep everything else from the client commandline), #544
-- use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
-- "borg upgrade" moves the keyfile keys to the new location
-- display both archive creation start and end time in "borg info", #627
-
-
-Bug fixes:
-
-- normalize trailing slashes for the repository path, #606
-- Cache: fix exception handling in __init__, release lock, #610
-
-Other changes:
-
-- suppress unneeded exception context (PEP 409), simpler tracebacks
-- removed special code needed to deal with imperfections / incompatibilities /
-  missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
-- removed some version requirements that were kept on old versions because
-  newer did not support py 3.2 any more
-- use some py 3.4+ stdlib code instead of own/openssl/pypi code:
-
-  - use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
-  - use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
-  - use hmac.compare_digest instead of == operator (constant time comparison)
-  - use stat.filemode instead of homegrown code
-  - use "mock" library from stdlib, #145
-  - remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
-- Vagrant: copy CHANGES.rst as symlink, #592
-- cosmetic code cleanups, add flake8 to tox/travis, #4
-- docs / help:
-
-  - make "borg -h" output prettier, #591
-  - slightly rephrase prune help
-  - add missing example for --list option of borg create
-  - quote exclude line that includes an asterisk to prevent shell expansion
-  - fix dead link to license
-  - delete Ubuntu Vivid, it is not supported anymore (EOL)
-  - OS X binary does not work for older OS X releases, #629
-  - borg serve's special support for forced/original ssh commands, #544
-  - misc. updates and fixes
-
-
-Version 0.30.0 (2016-01-23)
----------------------------
-
-Compatibility notes:
-
-- you may need to use -v (or --info) more often to actually see output emitted
-  at INFO log level (because it is suppressed at the default WARNING log level).
-  See the "general" section in the usage docs.
-- for borg create, you need --list (additionally to -v) to see the long file
-  list (was needed so you can have e.g. --stats alone without the long list)
-- see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was:
-  BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)
-
-Bug fixes:
-
-- fix crash when using borg create --dry-run --keep-tag-files, #570
-- make sure teardown with cleanup happens for Cache and RepositoryCache,
-  avoiding leftover locks and TEMP dir contents, #285 (partially), #548
-- fix locking KeyError, partial fix for #502
-- log stats consistently, #526
-- add abbreviated weekday to timestamp format, fixes #496
-- strip whitespace when loading exclusions from file
-- unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library
-  version warning when using the borg binary, #514
-- add some error handling/fallback for C library loading, #494
-- added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in "borg delete", #503
-- remove unused "repair" rpc method name
-
-New features:
-
-- borg create: implement exclusions using regular expression patterns.
-- borg create: implement inclusions using patterns.
-- borg extract: support patterns, #361
-- support different styles for patterns:
-
-  - fnmatch (`fm:` prefix, default when omitted), like borg <= 0.29.
-  - shell (`sh:` prefix) with `*` not matching directory separators and
-    `**/` matching 0..n directories
-  - path prefix (`pp:` prefix, for unifying borg create pp1 pp2 into the
-    patterns system), semantics like in borg <= 0.29
-  - regular expression (`re:`), new!
-- --progress option for borg upgrade (#291) and borg delete <archive>
-- update progress indication more often (e.g. for borg create within big
-  files or for borg check repo), #500
-- finer chunker granularity for items metadata stream, #547, #487
-- borg create --list now used (additionally to -v) to enable the verbose
-  file list output
-- display borg version below tracebacks, #532
-
-Other changes:
-
-- hashtable size (and thus: RAM and disk consumption) follows a growth policy:
-  grows fast while small, grows slower when getting bigger, #527
-- Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix,
-  fixes #569
-- no separate binaries for centos6 any more because the generic linux binaries
-  also work on centos6 (or in general: on systems with a slightly older glibc
-  than debian7
-- dev environment: require virtualenv<14.0 so we get a py32 compatible pip
-- docs:
-
-  - add space-saving chunks.archive.d trick to FAQ
-  - important: clarify -v and log levels in usage -> general, please read!
-  - sphinx configuration: create a simple man page from usage docs
-  - add a repo server setup example
-  - disable unneeded SSH features in authorized_keys examples for security.
-  - borg prune only knows "--keep-within" and not "--within"
-  - add gource video to resources docs, #507
-  - add netbsd install instructions
-  - authors: make it more clear what refers to borg and what to attic
-  - document standalone binary requirements, #499
-  - rephrase the mailing list section
-  - development docs: run build_api and build_usage before tagging release
-  - internals docs: hash table max. load factor is 0.75 now
-  - markup, typo, grammar, phrasing, clarifications and other fixes.
-  - add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583
-
-
-Version 0.29.0 (2015-12-13)
----------------------------
-
-Compatibility notes:
-
-- when upgrading to 0.29.0 you need to upgrade client as well as server
-  installations due to the locking and commandline interface changes otherwise
-  you'll get an error msg about a RPC protocol mismatch or a wrong commandline
-  option.
-  if you run a server that needs to support both old and new clients, it is
-  suggested that you have a "borg-0.28.2" and a "borg-0.29.0" command.
-  clients then can choose via e.g. "borg --remote-path=borg-0.29.0 ...".
-- the default waiting time for a lock changed from infinity to 1 second for a
-  better interactive user experience. if the repo you want to access is
-  currently locked, borg will now terminate after 1s with an error message.
-  if you have scripts that shall wait for the lock for a longer time, use
-  --lock-wait N (with N being the maximum wait time in seconds).
-
-Bug fixes:
-
-- hash table tuning (better chosen hashtable load factor 0.75 and prime initial
-  size of 1031 gave ~1000x speedup in some scenarios)
-- avoid creation of an orphan lock for one case, #285
-- --keep-tag-files: fix file mode and multiple tag files in one directory, #432
-- fixes for "borg upgrade" (attic repo converter), #466
-- remove --progress isatty magic (and also --no-progress option) again, #476
-- borg init: display proper repo URL
-- fix format of umask in help pages, #463
-
-New features:
-
-- implement --lock-wait, support timeout for UpgradableLock, #210
-- implement borg break-lock command, #157
-- include system info below traceback, #324
-- sane remote logging, remote stderr, #461:
-
-  - remote log output: intercept it and log it via local logging system,
-    with "Remote: " prefixed to message. log remote tracebacks.
-  - remote stderr: output it to local stderr with "Remote: " prefixed.
-- add --debug and --info (same as --verbose) to set the log level of the
-  builtin logging configuration (which otherwise defaults to warning), #426
-  note: there are few messages emitted at DEBUG level currently.
-- optionally configure logging via env var BORG_LOGGING_CONF
-- add --filter option for status characters: e.g. to show only the added
-  or modified files (and also errors), use "borg create -v --filter=AME ...".
-- more progress indicators, #394
-- use ISO-8601 date and time format, #375
-- "borg check --prefix" to restrict archive checking to that name prefix, #206
-
-Other changes:
-
-- hashindex_add C implementation (speed up cache re-sync for new archives)
-- increase FUSE read_size to 1024 (speed up metadata operations)
-- check/delete/prune --save-space: free unused segments quickly, #239
-- increase rpc protocol version to 2 (see also Compatibility notes), #458
-- silence borg by default (via default log level WARNING)
-- get rid of C compiler warnings, #391
-- upgrade OS X FUSE to 3.0.9 on the OS X binary build system
-- use python 3.5.1 to build binaries
-- docs:
-
-  - new mailing list borgbackup@python.org, #468
-  - readthedocs: color and logo improvements
-  - load coverage icons over SSL (avoids mixed content)
-  - more precise binary installation steps
-  - update release procedure docs about OS X FUSE
-  - FAQ entry about unexpected 'A' status for unchanged file(s), #403
-  - add docs about 'E' file status
-  - add "borg upgrade" docs, #464
-  - add developer docs about output and logging
-  - clarify encryption, add note about client-side encryption
-  - add resources section, with videos, talks, presentations, #149
-  - Borg moved to Arch Linux [community]
-  - fix wrong installation instructions for archlinux
-
-
-Version 0.28.2 (2015-11-15)
----------------------------
-
-New features:
-
-- borg create --exclude-if-present TAGFILE - exclude directories that have the
-  given file from the backup. You can additionally give --keep-tag-files to
-  preserve just the directory roots and the tag-files (but not backup other
-  directory contents), #395, attic #128, attic #142
-
-Other changes:
-
-- do not create docs sources at build time (just have them in the repo),
-  completely remove have_cython() hack, do not use the "mock" library at build
-  time, #384
-- avoid hidden import, make it easier for PyInstaller, easier fix for #218
-- docs:
-
-  - add description of item flags / status output, fixes #402
-  - explain how to regenerate usage and API files (build_api or
-    build_usage) and when to commit usage files directly into git, #384
-  - minor install docs improvements
-
-
-Version 0.28.1 (2015-11-08)
----------------------------
-
-Bug fixes:
-
-- do not try to build api / usage docs for production install,
-  fixes unexpected "mock" build dependency, #384
-
-Other changes:
-
-- avoid using msgpack.packb at import time
-- fix formatting issue in changes.rst
-- fix build on readthedocs
-
-
-Version 0.28.0 (2015-11-08)
----------------------------
-
-Compatibility notes:
-
-- changed return codes (exit codes), see docs. in short:
-  old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error
-
-New features:
-
-- refactor return codes (exit codes), fixes #61
-- add --show-rc option enable "terminating with X status, rc N" output, fixes 58, #351
-- borg create backups atime and ctime additionally to mtime, fixes #317
-  - extract: support atime additionally to mtime
-  - FUSE: support ctime and atime additionally to mtime
-- support borg --version
-- emit a warning if we have a slow msgpack installed
-- borg list --prefix=thishostname- REPO, fixes #205
-- Debug commands (do not use except if you know what you do: debug-get-obj,
-  debug-put-obj, debug-delete-obj, debug-dump-archive-items.
-
-Bug fixes:
-
-- setup.py: fix bug related to BORG_LZ4_PREFIX processing
-- fix "check" for repos that have incomplete chunks, fixes #364
-- borg mount: fix unlocking of repository at umount time, fixes #331
-- fix reading files without touching their atime, #334
-- non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
-- fix acl_use_local_uid_gid() and add a test for it, attic #359
-- borg upgrade: do not upgrade repositories in place by default, #299
-- fix cascading failure with the index conversion code, #269
-- borg check: implement 'cmdline' archive metadata value decoding, #311
-- fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys
-  were missing, but also bsdflags). add check for unknown metadata keys.
-- create from stdin: also save atime, ctime (cosmetic)
-- use default_notty=False for confirmations, fixes #345
-- vagrant: fix msgpack installation on centos, fixes #342
-- deal with unicode errors for symlinks in same way as for regular files and
-  have a helpful warning message about how to fix wrong locale setup, fixes #382
-- add ACL keys the RobustUnpacker must know about
-
-Other changes:
-
-- improve file size displays, more flexible size formatters
-- explicitly commit to the units standard, #289
-- archiver: add E status (means that an error occurred when processing this
-  (single) item
-- do binary releases via "github releases", closes #214
-- create: use -x and --one-file-system (was: --do-not-cross-mountpoints), #296
-- a lot of changes related to using "logging" module and screen output, #233
-- show progress display if on a tty, output more progress information, #303
-- factor out status output so it is consistent, fix surrogates removal,
-  maybe fixes #309
-- move away from RawConfigParser to ConfigParser
-- archive checker: better error logging, give chunk_id and sequence numbers
-  (can be used together with borg debug-dump-archive-items).
-- do not mention the deprecated passphrase mode
-- emit a deprecation warning for --compression N (giving a just a number)
-- misc .coverragerc fixes (and coverage measurement improvements), fixes #319
-- refactor confirmation code, reduce code duplication, add tests
-- prettier error messages, fixes #307, #57
-- tests:
-
-  - add a test to find disk-full issues, #327
-  - travis: also run tests on Python 3.5
-  - travis: use tox -r so it rebuilds the tox environments
-  - test the generated pyinstaller-based binary by archiver unit tests, #215
-  - vagrant: tests: announce whether fakeroot is used or not
-  - vagrant: add vagrant user to fuse group for debianoid systems also
-  - vagrant: llfuse install on darwin needs pkgconfig installed
-  - vagrant: use pyinstaller from develop branch, fixes #336
-  - benchmarks: test create, extract, list, delete, info, check, help, fixes #146
-  - benchmarks: test with both the binary and the python code
-  - archiver tests: test with both the binary and the python code, fixes #215
-  - make basic test more robust
-- docs:
-
-  - moved docs to borgbackup.readthedocs.org, #155
-  - a lot of fixes and improvements, use mobile-friendly RTD standard theme
-  - use zlib,6 compression in some examples, fixes #275
-  - add missing rename usage to docs, closes #279
-  - include the help offered by borg help <topic> in the usage docs, fixes #293
-  - include a list of major changes compared to attic into README, fixes #224
-  - add OS X install instructions, #197
-  - more details about the release process, #260
-  - fix linux glibc requirement (binaries built on debian7 now)
-  - build: move usage and API generation to setup.py
-  - update docs about return codes, #61
-  - remove api docs (too much breakage on rtd)
-  - borgbackup install + basics presentation (asciinema)
-  - describe the current style guide in documentation
-  - add section about debug commands
-  - warn about not running out of space
-  - add example for rename
-  - improve chunker params docs, fixes #362
-  - minor development docs update
-
-
-Version 0.27.0 (2015-10-07)
----------------------------
-
-New features:
-
-- "borg upgrade" command - attic -> borg one time converter / migration, #21
-- temporary hack to avoid using lots of disk space for chunks.archive.d, #235:
-  To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
-- respect XDG_CACHE_HOME, attic #181
-- add support for arbitrary SSH commands, attic #99
-- borg delete --cache-only REPO (only delete cache, not REPO), attic #123
-
-
-Bug fixes:
-
-- use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow
-  down observed when running the Centos6-built binary on Ubuntu, #222
-- do not crash on empty lock.roster, fixes #232
-- fix multiple issues with the cache config version check, #234
-- fix segment entry header size check, attic #352
-  plus other error handling improvements / code deduplication there.
-- always give segment and offset in repo IntegrityErrors
-
-
-Other changes:
-
-- stop producing binary wheels, remove docs about it, #147
-- docs:
-  - add warning about prune
-  - generate usage include files only as needed
-  - development docs: add Vagrant section
-  - update / improve / reformat FAQ
-  - hint to single-file pyinstaller binaries from README
-
-
-Version 0.26.1 (2015-09-28)
----------------------------
-
-This is a minor update, just docs and new pyinstaller binaries.
-
-- docs update about python and binary requirements
-- better docs for --read-special, fix #220
-- re-built the binaries, fix #218 and #213 (glibc version issue)
-- update web site about single-file pyinstaller binaries
-
-Note: if you did a python-based installation, there is no need to upgrade.
-
-
-Version 0.26.0 (2015-09-19)
----------------------------
-
-New features:
-
-- Faster cache sync (do all in one pass, remove tar/compression stuff), #163
-- BORG_REPO env var to specify the default repo, #168
-- read special files as if they were regular files, #79
-- implement borg create --dry-run, attic issue #267
-- Normalize paths before pattern matching on OS X, #143
-- support OpenBSD and NetBSD (except xattrs/ACLs)
-- support / run tests on Python 3.5
-
-Bug fixes:
-
-- borg mount repo: use absolute path, attic #200, attic #137
-- chunker: use off_t to get 64bit on 32bit platform, #178
-- initialize chunker fd to -1, so it's not equal to STDIN_FILENO (0)
-- fix reaction to "no" answer at delete repo prompt, #182
-- setup.py: detect lz4.h header file location
-- to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
-- fix for obtaining ``char *`` from temporary Python value (old code causes
-  a compile error on Mint 17.2)
-- llfuse 0.41 install troubles on some platforms, require < 0.41
-  (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
-- cython code: add some int types to get rid of unspecific python add /
-  subtract operations (avoid ``undefined symbol FPE_``... error on some platforms)
-- fix verbose mode display of stdin backup
-- extract: warn if a include pattern never matched, fixes #209,
-  implement counters for Include/ExcludePatterns
-- archive names with slashes are invalid, attic issue #180
-- chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined -
-  fixes building on OpenBSD.
-
-Other changes:
-
-- detect inconsistency / corruption / hash collision, #170
-- replace versioneer with setuptools_scm, #106
-- docs:
-
-  - pkg-config is needed for llfuse installation
-  - be more clear about pruning, attic issue #132
-- unit tests:
-
-  - xattr: ignore security.selinux attribute showing up
-  - ext3 seems to need a bit more space for a sparse file
-  - do not test lzma level 9 compression (avoid MemoryError)
-  - work around strange mtime granularity issue on netbsd, fixes #204
-  - ignore st_rdev if file is not a block/char device, fixes #203
-  - stay away from the setgid and sticky mode bits
-- use Vagrant to do easy cross-platform testing (#196), currently:
-
-  - Debian 7 "wheezy" 32bit, Debian 8 "jessie" 64bit
-  - Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
-  - Centos 7 64bit
-  - FreeBSD 10.2 64bit
-  - OpenBSD 5.7 64bit
-  - NetBSD 6.1.5 64bit
-  - Darwin (OS X Yosemite)
-
-
-Version 0.25.0 (2015-08-29)
----------------------------
-
-Compatibility notes:
-
-- lz4 compression library (liblz4) is a new requirement (#156)
-- the new compression code is very compatible: as long as you stay with zlib
-  compression, older borg releases will still be able to read data from a
-  repo/archive made with the new code (note: this is not the case for the
-  default "none" compression, use "zlib,0" if you want a "no compression" mode
-  that can be read by older borg). Also the new code is able to read repos and
-  archives made with older borg versions (for all zlib levels  0..9).
-
-Deprecations:
-
-- --compression N (with N being a number, as in 0.24) is deprecated.
-  We keep the --compression 0..9 for now to not break scripts, but it is
-  deprecated and will be removed later, so better fix your scripts now:
-  --compression 0 (as in 0.24) is the same as --compression zlib,0 (now).
-  BUT: if you do not want compression, you rather want --compression none
-  (which is the default).
-  --compression 1 (in 0.24) is the same as --compression zlib,1 (now)
-  --compression 9 (in 0.24) is the same as --compression zlib,9 (now)
-
-New features:
-
-- create --compression none (default, means: do not compress, just pass through
-  data "as is". this is more efficient than zlib level 0 as used in borg 0.24)
-- create --compression lz4 (super-fast, but not very high compression)
-- create --compression zlib,N (slower, higher compression, default for N is 6)
-- create --compression lzma,N (slowest, highest compression, default N is 6)
-- honor the nodump flag (UF_NODUMP) and do not backup such items
-- list --short just outputs a simple list of the files/directories in an archive
-
-Bug fixes:
-
-- fixed --chunker-params parameter order confusion / malfunction, fixes #154
-- close fds of segments we delete (during compaction)
-- close files which fell out the lrucache
-- fadvise DONTNEED now is only called for the byte range actually read, not for
-  the whole file, fixes #158.
-- fix issue with negative "all archives" size, fixes #165
-- restore_xattrs: ignore if setxattr fails with EACCES, fixes #162
-
-Other changes:
-
-- remove fakeroot requirement for tests, tests run faster without fakeroot
-  (test setup does not fail any more without fakeroot, so you can run with or
-  without fakeroot), fixes #151 and #91.
-- more tests for archiver
-- recover_segment(): don't assume we have an fd for segment
-- lrucache refactoring / cleanup, add dispose function, py.test tests
-- generalize hashindex code for any key length (less hardcoding)
-- lock roster: catch file not found in remove() method and ignore it
-- travis CI: use requirements file
-- improved docs:
-
-  - replace hack for llfuse with proper solution (install libfuse-dev)
-  - update docs about compression
-  - update development docs about fakeroot
-  - internals: add some words about lock files / locking system
-  - support: mention BountySource and for what it can be used
-  - theme: use a lighter green
-  - add pypi, wheel, dist package based install docs
-  - split install docs into system-specific preparations and generic instructions
-
-
-Version 0.24.0 (2015-08-09)
----------------------------
-
-Incompatible changes (compared to 0.23):
-
-- borg now always issues --umask NNN option when invoking another borg via ssh
-  on the repository server. By that, it's making sure it uses the same umask
-  for remote repos as for local ones. Because of this, you must upgrade both
-  server and client(s) to 0.24.
-- the default umask is 077 now (if you do not specify via --umask) which might
-  be a different one as you used previously. The default umask avoids that
-  you accidentally give access permissions for group and/or others to files
-  created by borg (e.g. the repository).
-
-Deprecations:
-
-- "--encryption passphrase" mode is deprecated, see #85 and #97.
-  See the new "--encryption repokey" mode for a replacement.
-
-New features:
-
-- borg create --chunker-params ... to configure the chunker, fixes #16
-  (attic #302, attic #300, and somehow also #41).
-  This can be used to reduce memory usage caused by chunk management overhead,
-  so borg does not create a huge chunks index/repo index and eats all your RAM
-  if you back up lots of data in huge files (like VM disk images).
-  See docs/misc/create_chunker-params.txt for more information.
-- borg info now reports chunk counts in the chunk index.
-- borg create --compression 0..9 to select zlib compression level, fixes #66
-  (attic #295).
-- borg init --encryption repokey (to store the encryption key into the repo),
-  fixes #85
-- improve at-end error logging, always log exceptions and set exit_code=1
-- LoggedIO: better error checks / exceptions / exception handling
-- implement --remote-path to allow non-default-path borg locations, #125
-- implement --umask M and use 077 as default umask for better security, #117
-- borg check: give a named single archive to it, fixes #139
-- cache sync: show progress indication
-- cache sync: reimplement the chunk index merging in C
-
-Bug fixes:
-
-- fix segfault that happened for unreadable files (chunker: n needs to be a
-  signed size_t), #116
-- fix the repair mode, #144
-- repo delete: add destroy to allowed rpc methods, fixes issue #114
-- more compatible repository locking code (based on mkdir), maybe fixes #92
-  (attic #317, attic #201).
-- better Exception msg if no Borg is installed on the remote repo server, #56
-- create a RepositoryCache implementation that can cope with >2GiB,
-  fixes attic #326.
-- fix Traceback when running check --repair, attic #232
-- clarify help text, fixes #73.
-- add help string for --no-files-cache, fixes #140
-
-Other changes:
-
-- improved docs:
-
-  - added docs/misc directory for misc. writeups that won't be included
-    "as is" into the html docs.
-  - document environment variables and return codes (attic #324, attic #52)
-  - web site: add related projects, fix web site url, IRC #borgbackup
-  - Fedora/Fedora-based install instructions added to docs
-  - Cygwin-based install instructions added to docs
-  - updated AUTHORS
-  - add FAQ entries about redundancy / integrity
-  - clarify that borg extract uses the cwd as extraction target
-  - update internals doc about chunker params, memory usage and compression
-  - added docs about development
-  - add some words about resource usage in general
-  - document how to backup a raw disk
-  - add note about how to run borg from virtual env
-  - add solutions for (ll)fuse installation problems
-  - document what borg check does, fixes #138
-  - reorganize borgbackup.github.io sidebar, prev/next at top
-  - deduplicate and refactor the docs / README.rst
-
-- use borg-tmp as prefix for temporary files / directories
-- short prune options without "keep-" are deprecated, do not suggest them
-- improved tox configuration
-- remove usage of unittest.mock, always use mock from pypi
-- use entrypoints instead of scripts, for better use of the wheel format and
-  modern installs
-- add requirements.d/development.txt and modify tox.ini
-- use travis-ci for testing based on Linux and (new) OS X
-- use coverage.py, pytest-cov and codecov.io for test coverage support
-
-I forgot to list some stuff already implemented in 0.23.0, here they are:
-
-New features:
-
-- efficient archive list from manifest, meaning a big speedup for slow
-  repo connections and "list <repo>", "delete <repo>", "prune" (attic #242,
-  attic #167)
-- big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
-- hashindex: improve error messages
-
-Other changes:
-
-- explicitly specify binary mode to open binary files
-- some easy micro optimizations
-
-
-Version 0.23.0 (2015-06-11)
----------------------------
-
-Incompatible changes (compared to attic, fork related):
-
-- changed sw name and cli command to "borg", updated docs
-- package name (and name in urls) uses "borgbackup" to have fewer collisions
-- changed repo / cache internal magic strings from ATTIC* to BORG*,
-  changed cache location to .cache/borg/ - this means that it currently won't
-  accept attic repos (see issue #21 about improving that)
-
-Bug fixes:
-
-- avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
-- fix traceback when trying to do unsupported passphrase change, fixes attic #189
-- datetime does not like the year 10.000, fixes attic #139
-- fix "info" all archives stats, fixes attic #183
-- fix parsing with missing microseconds, fixes attic #282
-- fix misleading hint the fuse ImportError handler gave, fixes attic #237
-- check unpacked data from RPC for tuple type and correct length, fixes attic #127
-- fix Repository._active_txn state when lock upgrade fails
-- give specific path to xattr.is_enabled(), disable symlink setattr call that
-  always fails
-- fix test setup for 32bit platforms, partial fix for attic #196
-- upgraded versioneer, PEP440 compliance, fixes attic #257
-
-New features:
-
-- less memory usage: add global option --no-cache-files
-- check --last N (only check the last N archives)
-- check: sort archives in reverse time order
-- rename repo::oldname newname (rename repository)
-- create -v output more informative
-- create --progress (backup progress indicator)
-- create --timestamp (utc string or reference file/dir)
-- create: if "-" is given as path, read binary from stdin
-- extract: if --stdout is given, write all extracted binary data to stdout
-- extract --sparse (simple sparse file support)
-- extra debug information for 'fread failed'
-- delete <repo> (deletes whole repo + local cache)
-- FUSE: reflect deduplication in allocated blocks
-- only allow whitelisted RPC calls in server mode
-- normalize source/exclude paths before matching
-- use posix_fadvise to not spoil the OS cache, fixes attic #252
-- toplevel error handler: show tracebacks for better error analysis
-- sigusr1 / sigint handler to print current file infos - attic PR #286
-- RPCError: include the exception args we get from remote
-
-Other changes:
-
-- source: misc. cleanups, pep8, style
-- docs and faq improvements, fixes, updates
-- cleanup crypto.pyx, make it easier to adapt to other AES modes
-- do os.fsync like recommended in the python docs
-- source: Let chunker optionally work with os-level file descriptor.
-- source: Linux: remove duplicate os.fsencode calls
-- source: refactor _open_rb code a bit, so it is more consistent / regular
-- source: refactor indicator (status) and item processing
-- source: use py.test for better testing, flake8 for code style checks
-- source: fix tox >=2.0 compatibility (test runner)
-- pypi package: add python version classifiers, add FreeBSD to platforms
-
-
-Attic Changelog
----------------
-
-Here you can see the full list of changes between each Attic release until Borg
-forked from Attic:
-
-Version 0.17
-~~~~~~~~~~~~
-
-(bugfix release, released on X)
-
-- Fix hashindex ARM memory alignment issue (#309)
-- Improve hashindex error messages (#298)
-
-Version 0.16
-~~~~~~~~~~~~
-
-(bugfix release, released on May 16, 2015)
-
-- Fix typo preventing the security confirmation prompt from working (#303)
-- Improve handling of systems with improperly configured file system encoding (#289)
-- Fix "All archives" output for attic info. (#183)
-- More user friendly error message when repository key file is not found (#236)
-- Fix parsing of iso 8601 timestamps with zero microseconds (#282)
-
-Version 0.15
-~~~~~~~~~~~~
-
-(bugfix release, released on Apr 15, 2015)
-
-- xattr: Be less strict about unknown/unsupported platforms (#239)
-- Reduce repository listing memory usage (#163).
-- Fix BrokenPipeError for remote repositories (#233)
-- Fix incorrect behavior with two character directory names (#265, #268)
-- Require approval before accessing relocated/moved repository (#271)
-- Require approval before accessing previously unknown unencrypted repositories (#271)
-- Fix issue with hash index files larger than 2GB.
-- Fix Python 3.2 compatibility issue with noatime open() (#164)
-- Include missing pyx files in dist files (#168)
-
-Version 0.14
-~~~~~~~~~~~~
-
-(feature release, released on Dec 17, 2014)
-
-- Added support for stripping leading path segments (#95)
-  "attic extract --strip-segments X"
-- Add workaround for old Linux systems without acl_extended_file_no_follow (#96)
-- Add MacPorts' path to the default openssl search path (#101)
-- HashIndex improvements, eliminates unnecessary IO on low memory systems.
-- Fix "Number of files" output for attic info. (#124)
-- limit create file permissions so files aren't read while restoring
-- Fix issue with empty xattr values (#106)
-
-Version 0.13
-~~~~~~~~~~~~
-
-(feature release, released on Jun 29, 2014)
-
-- Fix sporadic "Resource temporarily unavailable" when using remote repositories
-- Reduce file cache memory usage (#90)
-- Faster AES encryption (utilizing AES-NI when available)
-- Experimental Linux, OS X and FreeBSD ACL support (#66)
-- Added support for backup and restore of BSDFlags (OSX, FreeBSD) (#56)
-- Fix bug where xattrs on symlinks were not correctly restored
-- Added cachedir support. CACHEDIR.TAG compatible cache directories
-  can now be excluded using ``--exclude-caches`` (#74)
-- Fix crash on extreme mtime timestamps (year 2400+) (#81)
-- Fix Python 3.2 specific lockf issue (EDEADLK)
-
-Version 0.12
-~~~~~~~~~~~~
-
-(feature release, released on April 7, 2014)
-
-- Python 3.4 support (#62)
-- Various documentation improvements a new style
-- ``attic mount`` now supports mounting an entire repository not only
-  individual archives (#59)
-- Added option to restrict remote repository access to specific path(s):
-  ``attic serve --restrict-to-path X`` (#51)
-- Include "all archives" size information in "--stats" output. (#54)
-- Added ``--stats`` option to ``attic delete`` and ``attic prune``
-- Fixed bug where ``attic prune`` used UTC instead of the local time zone
-  when determining which archives to keep.
-- Switch to SI units (Power of 1000 instead 1024) when printing file sizes
-
-Version 0.11
-~~~~~~~~~~~~
-
-(feature release, released on March 7, 2014)
-
-- New "check" command for repository consistency checking (#24)
-- Documentation improvements
-- Fix exception during "attic create" with repeated files (#39)
-- New "--exclude-from" option for attic create/extract/verify.
-- Improved archive metadata deduplication.
-- "attic verify" has been deprecated. Use "attic extract --dry-run" instead.
-- "attic prune --hourly|daily|..." has been deprecated.
-  Use "attic prune --keep-hourly|daily|..." instead.
-- Ignore xattr errors during "extract" if not supported by the filesystem. (#46)
-
-Version 0.10
-~~~~~~~~~~~~
-
-(bugfix release, released on Jan 30, 2014)
-
-- Fix deadlock when extracting 0 sized files from remote repositories
-- "--exclude" wildcard patterns are now properly applied to the full path
-  not just the file name part (#5).
-- Make source code endianness agnostic (#1)
-
-Version 0.9
-~~~~~~~~~~~
-
-(feature release, released on Jan 23, 2014)
-
-- Remote repository speed and reliability improvements.
-- Fix sorting of segment names to ignore NFS left over files. (#17)
-- Fix incorrect display of time (#13)
-- Improved error handling / reporting. (#12)
-- Use fcntl() instead of flock() when locking repository/cache. (#15)
-- Let ssh figure out port/user if not specified so we don't override .ssh/config (#9)
-- Improved libcrypto path detection (#23).
-
-Version 0.8.1
-~~~~~~~~~~~~~
-
-(bugfix release, released on Oct 4, 2013)
-
-- Fix segmentation fault issue.
-
-Version 0.8
-~~~~~~~~~~~
-
-(feature release, released on Oct 3, 2013)
-
-- Fix xattr issue when backing up sshfs filesystems (#4)
-- Fix issue with excessive index file size (#6)
-- Support access of read only repositories.
-- New syntax to enable repository encryption:
-    attic init --encryption="none|passphrase|keyfile".
-- Detect and abort if repository is older than the cache.
-
-
-Version 0.7
-~~~~~~~~~~~
-
-(feature release, released on Aug 5, 2013)
-
-- Ported to FreeBSD
-- Improved documentation
-- Experimental: Archives mountable as FUSE filesystems.
-- The "user." prefix is no longer stripped from xattrs on Linux
-
-
-Version 0.6.1
-~~~~~~~~~~~~~
-
-(bugfix release, released on July 19, 2013)
-
-- Fixed an issue where mtime was not always correctly restored.
-
-
-Version 0.6
-~~~~~~~~~~~
-
-First public release on July 9, 2013

docs/changes_0.x.rst

@@ -0,0 +1,807 @@
+.. _changelog_0x:
+
+Change Log 0.x
+==============
+
+Version 0.30.0 (2016-01-23)
+---------------------------
+
+Compatibility notes:
+
+- you may need to use -v (or --info) more often to actually see output emitted
+  at INFO log level (because it is suppressed at the default WARNING log level).
+  See the "general" section in the usage docs.
+- for borg create, you need --list (additionally to -v) to see the long file
+  list (was needed so you can have e.g. --stats alone without the long list)
+- see below about BORG_DELETE_I_KNOW_WHAT_I_AM_DOING (was:
+  BORG_CHECK_I_KNOW_WHAT_I_AM_DOING)
+
+Bug fixes:
+
+- fix crash when using borg create --dry-run --keep-tag-files, #570
+- make sure teardown with cleanup happens for Cache and RepositoryCache,
+  avoiding leftover locks and TEMP dir contents, #285 (partially), #548
+- fix locking KeyError, partial fix for #502
+- log stats consistently, #526
+- add abbreviated weekday to timestamp format, fixes #496
+- strip whitespace when loading exclusions from file
+- unset LD_LIBRARY_PATH before invoking ssh, fixes strange OpenSSL library
+  version warning when using the borg binary, #514
+- add some error handling/fallback for C library loading, #494
+- added BORG_DELETE_I_KNOW_WHAT_I_AM_DOING for check in "borg delete", #503
+- remove unused "repair" rpc method name
+
+New features:
+
+- borg create: implement exclusions using regular expression patterns.
+- borg create: implement inclusions using patterns.
+- borg extract: support patterns, #361
+- support different styles for patterns:
+
+  - fnmatch (`fm:` prefix, default when omitted), like borg <= 0.29.
+  - shell (`sh:` prefix) with `*` not matching directory separators and
+    `**/` matching 0..n directories
+  - path prefix (`pp:` prefix, for unifying borg create pp1 pp2 into the
+    patterns system), semantics like in borg <= 0.29
+  - regular expression (`re:`), new!
+- --progress option for borg upgrade (#291) and borg delete <archive>
+- update progress indication more often (e.g. for borg create within big
+  files or for borg check repo), #500
+- finer chunker granularity for items metadata stream, #547, #487
+- borg create --list now used (additionally to -v) to enable the verbose
+  file list output
+- display borg version below tracebacks, #532
+
+Other changes:
+
+- hashtable size (and thus: RAM and disk consumption) follows a growth policy:
+  grows fast while small, grows slower when getting bigger, #527
+- Vagrantfile: use pyinstaller 3.1 to build binaries, freebsd sqlite3 fix,
+  fixes #569
+- no separate binaries for centos6 any more because the generic linux binaries
+  also work on centos6 (or in general: on systems with a slightly older glibc
+  than debian7
+- dev environment: require virtualenv<14.0 so we get a py32 compatible pip
+- docs:
+
+  - add space-saving chunks.archive.d trick to FAQ
+  - important: clarify -v and log levels in usage -> general, please read!
+  - sphinx configuration: create a simple man page from usage docs
+  - add a repo server setup example
+  - disable unneeded SSH features in authorized_keys examples for security.
+  - borg prune only knows "--keep-within" and not "--within"
+  - add gource video to resources docs, #507
+  - add netbsd install instructions
+  - authors: make it more clear what refers to borg and what to attic
+  - document standalone binary requirements, #499
+  - rephrase the mailing list section
+  - development docs: run build_api and build_usage before tagging release
+  - internals docs: hash table max. load factor is 0.75 now
+  - markup, typo, grammar, phrasing, clarifications and other fixes.
+  - add gcc gcc-c++ to redhat/fedora/corora install docs, fixes #583
+
+
+Version 0.29.0 (2015-12-13)
+---------------------------
+
+Compatibility notes:
+
+- when upgrading to 0.29.0 you need to upgrade client as well as server
+  installations due to the locking and commandline interface changes otherwise
+  you'll get an error msg about a RPC protocol mismatch or a wrong commandline
+  option.
+  if you run a server that needs to support both old and new clients, it is
+  suggested that you have a "borg-0.28.2" and a "borg-0.29.0" command.
+  clients then can choose via e.g. "borg --remote-path=borg-0.29.0 ...".
+- the default waiting time for a lock changed from infinity to 1 second for a
+  better interactive user experience. if the repo you want to access is
+  currently locked, borg will now terminate after 1s with an error message.
+  if you have scripts that shall wait for the lock for a longer time, use
+  --lock-wait N (with N being the maximum wait time in seconds).
+
+Bug fixes:
+
+- hash table tuning (better chosen hashtable load factor 0.75 and prime initial
+  size of 1031 gave ~1000x speedup in some scenarios)
+- avoid creation of an orphan lock for one case, #285
+- --keep-tag-files: fix file mode and multiple tag files in one directory, #432
+- fixes for "borg upgrade" (attic repo converter), #466
+- remove --progress isatty magic (and also --no-progress option) again, #476
+- borg init: display proper repo URL
+- fix format of umask in help pages, #463
+
+New features:
+
+- implement --lock-wait, support timeout for UpgradableLock, #210
+- implement borg break-lock command, #157
+- include system info below traceback, #324
+- sane remote logging, remote stderr, #461:
+
+  - remote log output: intercept it and log it via local logging system,
+    with "Remote: " prefixed to message. log remote tracebacks.
+  - remote stderr: output it to local stderr with "Remote: " prefixed.
+- add --debug and --info (same as --verbose) to set the log level of the
+  builtin logging configuration (which otherwise defaults to warning), #426
+  note: there are few messages emitted at DEBUG level currently.
+- optionally configure logging via env var BORG_LOGGING_CONF
+- add --filter option for status characters: e.g. to show only the added
+  or modified files (and also errors), use "borg create -v --filter=AME ...".
+- more progress indicators, #394
+- use ISO-8601 date and time format, #375
+- "borg check --prefix" to restrict archive checking to that name prefix, #206
+
+Other changes:
+
+- hashindex_add C implementation (speed up cache re-sync for new archives)
+- increase FUSE read_size to 1024 (speed up metadata operations)
+- check/delete/prune --save-space: free unused segments quickly, #239
+- increase rpc protocol version to 2 (see also Compatibility notes), #458
+- silence borg by default (via default log level WARNING)
+- get rid of C compiler warnings, #391
+- upgrade OS X FUSE to 3.0.9 on the OS X binary build system
+- use python 3.5.1 to build binaries
+- docs:
+
+  - new mailing list borgbackup@python.org, #468
+  - readthedocs: color and logo improvements
+  - load coverage icons over SSL (avoids mixed content)
+  - more precise binary installation steps
+  - update release procedure docs about OS X FUSE
+  - FAQ entry about unexpected 'A' status for unchanged file(s), #403
+  - add docs about 'E' file status
+  - add "borg upgrade" docs, #464
+  - add developer docs about output and logging
+  - clarify encryption, add note about client-side encryption
+  - add resources section, with videos, talks, presentations, #149
+  - Borg moved to Arch Linux [community]
+  - fix wrong installation instructions for archlinux
+
+
+Version 0.28.2 (2015-11-15)
+---------------------------
+
+New features:
+
+- borg create --exclude-if-present TAGFILE - exclude directories that have the
+  given file from the backup. You can additionally give --keep-tag-files to
+  preserve just the directory roots and the tag-files (but not backup other
+  directory contents), #395, attic #128, attic #142
+
+Other changes:
+
+- do not create docs sources at build time (just have them in the repo),
+  completely remove have_cython() hack, do not use the "mock" library at build
+  time, #384
+- avoid hidden import, make it easier for PyInstaller, easier fix for #218
+- docs:
+
+  - add description of item flags / status output, fixes #402
+  - explain how to regenerate usage and API files (build_api or
+    build_usage) and when to commit usage files directly into git, #384
+  - minor install docs improvements
+
+
+Version 0.28.1 (2015-11-08)
+---------------------------
+
+Bug fixes:
+
+- do not try to build api / usage docs for production install,
+  fixes unexpected "mock" build dependency, #384
+
+Other changes:
+
+- avoid using msgpack.packb at import time
+- fix formatting issue in changes.rst
+- fix build on readthedocs
+
+
+Version 0.28.0 (2015-11-08)
+---------------------------
+
+Compatibility notes:
+
+- changed return codes (exit codes), see docs. in short:
+  old: 0 = ok, 1 = error. now: 0 = ok, 1 = warning, 2 = error
+
+New features:
+
+- refactor return codes (exit codes), fixes #61
+- add --show-rc option enable "terminating with X status, rc N" output, fixes 58, #351
+- borg create backups atime and ctime additionally to mtime, fixes #317
+  - extract: support atime additionally to mtime
+  - FUSE: support ctime and atime additionally to mtime
+- support borg --version
+- emit a warning if we have a slow msgpack installed
+- borg list --prefix=thishostname- REPO, fixes #205
+- Debug commands (do not use except if you know what you do: debug-get-obj,
+  debug-put-obj, debug-delete-obj, debug-dump-archive-items.
+
+Bug fixes:
+
+- setup.py: fix bug related to BORG_LZ4_PREFIX processing
+- fix "check" for repos that have incomplete chunks, fixes #364
+- borg mount: fix unlocking of repository at umount time, fixes #331
+- fix reading files without touching their atime, #334
+- non-ascii ACL fixes for Linux, FreeBSD and OS X, #277
+- fix acl_use_local_uid_gid() and add a test for it, attic #359
+- borg upgrade: do not upgrade repositories in place by default, #299
+- fix cascading failure with the index conversion code, #269
+- borg check: implement 'cmdline' archive metadata value decoding, #311
+- fix RobustUnpacker, it missed some metadata keys (new atime and ctime keys
+  were missing, but also bsdflags). add check for unknown metadata keys.
+- create from stdin: also save atime, ctime (cosmetic)
+- use default_notty=False for confirmations, fixes #345
+- vagrant: fix msgpack installation on centos, fixes #342
+- deal with unicode errors for symlinks in same way as for regular files and
+  have a helpful warning message about how to fix wrong locale setup, fixes #382
+- add ACL keys the RobustUnpacker must know about
+
+Other changes:
+
+- improve file size displays, more flexible size formatters
+- explicitly commit to the units standard, #289
+- archiver: add E status (means that an error occurred when processing this
+  (single) item
+- do binary releases via "github releases", closes #214
+- create: use -x and --one-file-system (was: --do-not-cross-mountpoints), #296
+- a lot of changes related to using "logging" module and screen output, #233
+- show progress display if on a tty, output more progress information, #303
+- factor out status output so it is consistent, fix surrogates removal,
+  maybe fixes #309
+- move away from RawConfigParser to ConfigParser
+- archive checker: better error logging, give chunk_id and sequence numbers
+  (can be used together with borg debug-dump-archive-items).
+- do not mention the deprecated passphrase mode
+- emit a deprecation warning for --compression N (giving a just a number)
+- misc .coverragerc fixes (and coverage measurement improvements), fixes #319
+- refactor confirmation code, reduce code duplication, add tests
+- prettier error messages, fixes #307, #57
+- tests:
+
+  - add a test to find disk-full issues, #327
+  - travis: also run tests on Python 3.5
+  - travis: use tox -r so it rebuilds the tox environments
+  - test the generated pyinstaller-based binary by archiver unit tests, #215
+  - vagrant: tests: announce whether fakeroot is used or not
+  - vagrant: add vagrant user to fuse group for debianoid systems also
+  - vagrant: llfuse install on darwin needs pkgconfig installed
+  - vagrant: use pyinstaller from develop branch, fixes #336
+  - benchmarks: test create, extract, list, delete, info, check, help, fixes #146
+  - benchmarks: test with both the binary and the python code
+  - archiver tests: test with both the binary and the python code, fixes #215
+  - make basic test more robust
+- docs:
+
+  - moved docs to borgbackup.readthedocs.org, #155
+  - a lot of fixes and improvements, use mobile-friendly RTD standard theme
+  - use zlib,6 compression in some examples, fixes #275
+  - add missing rename usage to docs, closes #279
+  - include the help offered by borg help <topic> in the usage docs, fixes #293
+  - include a list of major changes compared to attic into README, fixes #224
+  - add OS X install instructions, #197
+  - more details about the release process, #260
+  - fix linux glibc requirement (binaries built on debian7 now)
+  - build: move usage and API generation to setup.py
+  - update docs about return codes, #61
+  - remove api docs (too much breakage on rtd)
+  - borgbackup install + basics presentation (asciinema)
+  - describe the current style guide in documentation
+  - add section about debug commands
+  - warn about not running out of space
+  - add example for rename
+  - improve chunker params docs, fixes #362
+  - minor development docs update
+
+
+Version 0.27.0 (2015-10-07)
+---------------------------
+
+New features:
+
+- "borg upgrade" command - attic -> borg one time converter / migration, #21
+- temporary hack to avoid using lots of disk space for chunks.archive.d, #235:
+  To use it: rm -rf chunks.archive.d ; touch chunks.archive.d
+- respect XDG_CACHE_HOME, attic #181
+- add support for arbitrary SSH commands, attic #99
+- borg delete --cache-only REPO (only delete cache, not REPO), attic #123
+
+
+Bug fixes:
+
+- use Debian 7 (wheezy) to build pyinstaller borgbackup binaries, fixes slow
+  down observed when running the Centos6-built binary on Ubuntu, #222
+- do not crash on empty lock.roster, fixes #232
+- fix multiple issues with the cache config version check, #234
+- fix segment entry header size check, attic #352
+  plus other error handling improvements / code deduplication there.
+- always give segment and offset in repo IntegrityErrors
+
+
+Other changes:
+
+- stop producing binary wheels, remove docs about it, #147
+- docs:
+  - add warning about prune
+  - generate usage include files only as needed
+  - development docs: add Vagrant section
+  - update / improve / reformat FAQ
+  - hint to single-file pyinstaller binaries from README
+
+
+Version 0.26.1 (2015-09-28)
+---------------------------
+
+This is a minor update, just docs and new pyinstaller binaries.
+
+- docs update about python and binary requirements
+- better docs for --read-special, fix #220
+- re-built the binaries, fix #218 and #213 (glibc version issue)
+- update web site about single-file pyinstaller binaries
+
+Note: if you did a python-based installation, there is no need to upgrade.
+
+
+Version 0.26.0 (2015-09-19)
+---------------------------
+
+New features:
+
+- Faster cache sync (do all in one pass, remove tar/compression stuff), #163
+- BORG_REPO env var to specify the default repo, #168
+- read special files as if they were regular files, #79
+- implement borg create --dry-run, attic issue #267
+- Normalize paths before pattern matching on OS X, #143
+- support OpenBSD and NetBSD (except xattrs/ACLs)
+- support / run tests on Python 3.5
+
+Bug fixes:
+
+- borg mount repo: use absolute path, attic #200, attic #137
+- chunker: use off_t to get 64bit on 32bit platform, #178
+- initialize chunker fd to -1, so it's not equal to STDIN_FILENO (0)
+- fix reaction to "no" answer at delete repo prompt, #182
+- setup.py: detect lz4.h header file location
+- to support python < 3.2.4, add less buggy argparse lib from 3.2.6 (#194)
+- fix for obtaining ``char *`` from temporary Python value (old code causes
+  a compile error on Mint 17.2)
+- llfuse 0.41 install troubles on some platforms, require < 0.41
+  (UnicodeDecodeError exception due to non-ascii llfuse setup.py)
+- cython code: add some int types to get rid of unspecific python add /
+  subtract operations (avoid ``undefined symbol FPE_``... error on some platforms)
+- fix verbose mode display of stdin backup
+- extract: warn if a include pattern never matched, fixes #209,
+  implement counters for Include/ExcludePatterns
+- archive names with slashes are invalid, attic issue #180
+- chunker: add a check whether the POSIX_FADV_DONTNEED constant is defined -
+  fixes building on OpenBSD.
+
+Other changes:
+
+- detect inconsistency / corruption / hash collision, #170
+- replace versioneer with setuptools_scm, #106
+- docs:
+
+  - pkg-config is needed for llfuse installation
+  - be more clear about pruning, attic issue #132
+- unit tests:
+
+  - xattr: ignore security.selinux attribute showing up
+  - ext3 seems to need a bit more space for a sparse file
+  - do not test lzma level 9 compression (avoid MemoryError)
+  - work around strange mtime granularity issue on netbsd, fixes #204
+  - ignore st_rdev if file is not a block/char device, fixes #203
+  - stay away from the setgid and sticky mode bits
+- use Vagrant to do easy cross-platform testing (#196), currently:
+
+  - Debian 7 "wheezy" 32bit, Debian 8 "jessie" 64bit
+  - Ubuntu 12.04 32bit, Ubuntu 14.04 64bit
+  - Centos 7 64bit
+  - FreeBSD 10.2 64bit
+  - OpenBSD 5.7 64bit
+  - NetBSD 6.1.5 64bit
+  - Darwin (OS X Yosemite)
+
+
+Version 0.25.0 (2015-08-29)
+---------------------------
+
+Compatibility notes:
+
+- lz4 compression library (liblz4) is a new requirement (#156)
+- the new compression code is very compatible: as long as you stay with zlib
+  compression, older borg releases will still be able to read data from a
+  repo/archive made with the new code (note: this is not the case for the
+  default "none" compression, use "zlib,0" if you want a "no compression" mode
+  that can be read by older borg). Also the new code is able to read repos and
+  archives made with older borg versions (for all zlib levels  0..9).
+
+Deprecations:
+
+- --compression N (with N being a number, as in 0.24) is deprecated.
+  We keep the --compression 0..9 for now to not break scripts, but it is
+  deprecated and will be removed later, so better fix your scripts now:
+  --compression 0 (as in 0.24) is the same as --compression zlib,0 (now).
+  BUT: if you do not want compression, you rather want --compression none
+  (which is the default).
+  --compression 1 (in 0.24) is the same as --compression zlib,1 (now)
+  --compression 9 (in 0.24) is the same as --compression zlib,9 (now)
+
+New features:
+
+- create --compression none (default, means: do not compress, just pass through
+  data "as is". this is more efficient than zlib level 0 as used in borg 0.24)
+- create --compression lz4 (super-fast, but not very high compression)
+- create --compression zlib,N (slower, higher compression, default for N is 6)
+- create --compression lzma,N (slowest, highest compression, default N is 6)
+- honor the nodump flag (UF_NODUMP) and do not backup such items
+- list --short just outputs a simple list of the files/directories in an archive
+
+Bug fixes:
+
+- fixed --chunker-params parameter order confusion / malfunction, fixes #154
+- close fds of segments we delete (during compaction)
+- close files which fell out the lrucache
+- fadvise DONTNEED now is only called for the byte range actually read, not for
+  the whole file, fixes #158.
+- fix issue with negative "all archives" size, fixes #165
+- restore_xattrs: ignore if setxattr fails with EACCES, fixes #162
+
+Other changes:
+
+- remove fakeroot requirement for tests, tests run faster without fakeroot
+  (test setup does not fail any more without fakeroot, so you can run with or
+  without fakeroot), fixes #151 and #91.
+- more tests for archiver
+- recover_segment(): don't assume we have an fd for segment
+- lrucache refactoring / cleanup, add dispose function, py.test tests
+- generalize hashindex code for any key length (less hardcoding)
+- lock roster: catch file not found in remove() method and ignore it
+- travis CI: use requirements file
+- improved docs:
+
+  - replace hack for llfuse with proper solution (install libfuse-dev)
+  - update docs about compression
+  - update development docs about fakeroot
+  - internals: add some words about lock files / locking system
+  - support: mention BountySource and for what it can be used
+  - theme: use a lighter green
+  - add pypi, wheel, dist package based install docs
+  - split install docs into system-specific preparations and generic instructions
+
+
+Version 0.24.0 (2015-08-09)
+---------------------------
+
+Incompatible changes (compared to 0.23):
+
+- borg now always issues --umask NNN option when invoking another borg via ssh
+  on the repository server. By that, it's making sure it uses the same umask
+  for remote repos as for local ones. Because of this, you must upgrade both
+  server and client(s) to 0.24.
+- the default umask is 077 now (if you do not specify via --umask) which might
+  be a different one as you used previously. The default umask avoids that
+  you accidentally give access permissions for group and/or others to files
+  created by borg (e.g. the repository).
+
+Deprecations:
+
+- "--encryption passphrase" mode is deprecated, see #85 and #97.
+  See the new "--encryption repokey" mode for a replacement.
+
+New features:
+
+- borg create --chunker-params ... to configure the chunker, fixes #16
+  (attic #302, attic #300, and somehow also #41).
+  This can be used to reduce memory usage caused by chunk management overhead,
+  so borg does not create a huge chunks index/repo index and eats all your RAM
+  if you back up lots of data in huge files (like VM disk images).
+  See docs/misc/create_chunker-params.txt for more information.
+- borg info now reports chunk counts in the chunk index.
+- borg create --compression 0..9 to select zlib compression level, fixes #66
+  (attic #295).
+- borg init --encryption repokey (to store the encryption key into the repo),
+  fixes #85
+- improve at-end error logging, always log exceptions and set exit_code=1
+- LoggedIO: better error checks / exceptions / exception handling
+- implement --remote-path to allow non-default-path borg locations, #125
+- implement --umask M and use 077 as default umask for better security, #117
+- borg check: give a named single archive to it, fixes #139
+- cache sync: show progress indication
+- cache sync: reimplement the chunk index merging in C
+
+Bug fixes:
+
+- fix segfault that happened for unreadable files (chunker: n needs to be a
+  signed size_t), #116
+- fix the repair mode, #144
+- repo delete: add destroy to allowed rpc methods, fixes issue #114
+- more compatible repository locking code (based on mkdir), maybe fixes #92
+  (attic #317, attic #201).
+- better Exception msg if no Borg is installed on the remote repo server, #56
+- create a RepositoryCache implementation that can cope with >2GiB,
+  fixes attic #326.
+- fix Traceback when running check --repair, attic #232
+- clarify help text, fixes #73.
+- add help string for --no-files-cache, fixes #140
+
+Other changes:
+
+- improved docs:
+
+  - added docs/misc directory for misc. writeups that won't be included
+    "as is" into the html docs.
+  - document environment variables and return codes (attic #324, attic #52)
+  - web site: add related projects, fix web site url, IRC #borgbackup
+  - Fedora/Fedora-based install instructions added to docs
+  - Cygwin-based install instructions added to docs
+  - updated AUTHORS
+  - add FAQ entries about redundancy / integrity
+  - clarify that borg extract uses the cwd as extraction target
+  - update internals doc about chunker params, memory usage and compression
+  - added docs about development
+  - add some words about resource usage in general
+  - document how to backup a raw disk
+  - add note about how to run borg from virtual env
+  - add solutions for (ll)fuse installation problems
+  - document what borg check does, fixes #138
+  - reorganize borgbackup.github.io sidebar, prev/next at top
+  - deduplicate and refactor the docs / README.rst
+
+- use borg-tmp as prefix for temporary files / directories
+- short prune options without "keep-" are deprecated, do not suggest them
+- improved tox configuration
+- remove usage of unittest.mock, always use mock from pypi
+- use entrypoints instead of scripts, for better use of the wheel format and
+  modern installs
+- add requirements.d/development.txt and modify tox.ini
+- use travis-ci for testing based on Linux and (new) OS X
+- use coverage.py, pytest-cov and codecov.io for test coverage support
+
+I forgot to list some stuff already implemented in 0.23.0, here they are:
+
+New features:
+
+- efficient archive list from manifest, meaning a big speedup for slow
+  repo connections and "list <repo>", "delete <repo>", "prune" (attic #242,
+  attic #167)
+- big speedup for chunks cache sync (esp. for slow repo connections), fixes #18
+- hashindex: improve error messages
+
+Other changes:
+
+- explicitly specify binary mode to open binary files
+- some easy micro optimizations
+
+
+Version 0.23.0 (2015-06-11)
+---------------------------
+
+Incompatible changes (compared to attic, fork related):
+
+- changed sw name and cli command to "borg", updated docs
+- package name (and name in urls) uses "borgbackup" to have fewer collisions
+- changed repo / cache internal magic strings from ATTIC* to BORG*,
+  changed cache location to .cache/borg/ - this means that it currently won't
+  accept attic repos (see issue #21 about improving that)
+
+Bug fixes:
+
+- avoid defect python-msgpack releases, fixes attic #171, fixes attic #185
+- fix traceback when trying to do unsupported passphrase change, fixes attic #189
+- datetime does not like the year 10.000, fixes attic #139
+- fix "info" all archives stats, fixes attic #183
+- fix parsing with missing microseconds, fixes attic #282
+- fix misleading hint the fuse ImportError handler gave, fixes attic #237
+- check unpacked data from RPC for tuple type and correct length, fixes attic #127
+- fix Repository._active_txn state when lock upgrade fails
+- give specific path to xattr.is_enabled(), disable symlink setattr call that
+  always fails
+- fix test setup for 32bit platforms, partial fix for attic #196
+- upgraded versioneer, PEP440 compliance, fixes attic #257
+
+New features:
+
+- less memory usage: add global option --no-cache-files
+- check --last N (only check the last N archives)
+- check: sort archives in reverse time order
+- rename repo::oldname newname (rename repository)
+- create -v output more informative
+- create --progress (backup progress indicator)
+- create --timestamp (utc string or reference file/dir)
+- create: if "-" is given as path, read binary from stdin
+- extract: if --stdout is given, write all extracted binary data to stdout
+- extract --sparse (simple sparse file support)
+- extra debug information for 'fread failed'
+- delete <repo> (deletes whole repo + local cache)
+- FUSE: reflect deduplication in allocated blocks
+- only allow whitelisted RPC calls in server mode
+- normalize source/exclude paths before matching
+- use posix_fadvise to not spoil the OS cache, fixes attic #252
+- toplevel error handler: show tracebacks for better error analysis
+- sigusr1 / sigint handler to print current file infos - attic PR #286
+- RPCError: include the exception args we get from remote
+
+Other changes:
+
+- source: misc. cleanups, pep8, style
+- docs and faq improvements, fixes, updates
+- cleanup crypto.pyx, make it easier to adapt to other AES modes
+- do os.fsync like recommended in the python docs
+- source: Let chunker optionally work with os-level file descriptor.
+- source: Linux: remove duplicate os.fsencode calls
+- source: refactor _open_rb code a bit, so it is more consistent / regular
+- source: refactor indicator (status) and item processing
+- source: use py.test for better testing, flake8 for code style checks
+- source: fix tox >=2.0 compatibility (test runner)
+- pypi package: add python version classifiers, add FreeBSD to platforms
+
+
+Attic Changelog
+---------------
+
+Here you can see the full list of changes between each Attic release until Borg
+forked from Attic:
+
+Version 0.17
+~~~~~~~~~~~~
+
+(bugfix release, released on X)
+
+- Fix hashindex ARM memory alignment issue (#309)
+- Improve hashindex error messages (#298)
+
+Version 0.16
+~~~~~~~~~~~~
+
+(bugfix release, released on May 16, 2015)
+
+- Fix typo preventing the security confirmation prompt from working (#303)
+- Improve handling of systems with improperly configured file system encoding (#289)
+- Fix "All archives" output for attic info. (#183)
+- More user friendly error message when repository key file is not found (#236)
+- Fix parsing of iso 8601 timestamps with zero microseconds (#282)
+
+Version 0.15
+~~~~~~~~~~~~
+
+(bugfix release, released on Apr 15, 2015)
+
+- xattr: Be less strict about unknown/unsupported platforms (#239)
+- Reduce repository listing memory usage (#163).
+- Fix BrokenPipeError for remote repositories (#233)
+- Fix incorrect behavior with two character directory names (#265, #268)
+- Require approval before accessing relocated/moved repository (#271)
+- Require approval before accessing previously unknown unencrypted repositories (#271)
+- Fix issue with hash index files larger than 2GB.
+- Fix Python 3.2 compatibility issue with noatime open() (#164)
+- Include missing pyx files in dist files (#168)
+
+Version 0.14
+~~~~~~~~~~~~
+
+(feature release, released on Dec 17, 2014)
+
+- Added support for stripping leading path segments (#95)
+  "attic extract --strip-segments X"
+- Add workaround for old Linux systems without acl_extended_file_no_follow (#96)
+- Add MacPorts' path to the default openssl search path (#101)
+- HashIndex improvements, eliminates unnecessary IO on low memory systems.
+- Fix "Number of files" output for attic info. (#124)
+- limit create file permissions so files aren't read while restoring
+- Fix issue with empty xattr values (#106)
+
+Version 0.13
+~~~~~~~~~~~~
+
+(feature release, released on Jun 29, 2014)
+
+- Fix sporadic "Resource temporarily unavailable" when using remote repositories
+- Reduce file cache memory usage (#90)
+- Faster AES encryption (utilizing AES-NI when available)
+- Experimental Linux, OS X and FreeBSD ACL support (#66)
+- Added support for backup and restore of BSDFlags (OSX, FreeBSD) (#56)
+- Fix bug where xattrs on symlinks were not correctly restored
+- Added cachedir support. CACHEDIR.TAG compatible cache directories
+  can now be excluded using ``--exclude-caches`` (#74)
+- Fix crash on extreme mtime timestamps (year 2400+) (#81)
+- Fix Python 3.2 specific lockf issue (EDEADLK)
+
+Version 0.12
+~~~~~~~~~~~~
+
+(feature release, released on April 7, 2014)
+
+- Python 3.4 support (#62)
+- Various documentation improvements a new style
+- ``attic mount`` now supports mounting an entire repository not only
+  individual archives (#59)
+- Added option to restrict remote repository access to specific path(s):
+  ``attic serve --restrict-to-path X`` (#51)
+- Include "all archives" size information in "--stats" output. (#54)
+- Added ``--stats`` option to ``attic delete`` and ``attic prune``
+- Fixed bug where ``attic prune`` used UTC instead of the local time zone
+  when determining which archives to keep.
+- Switch to SI units (Power of 1000 instead 1024) when printing file sizes
+
+Version 0.11
+~~~~~~~~~~~~
+
+(feature release, released on March 7, 2014)
+
+- New "check" command for repository consistency checking (#24)
+- Documentation improvements
+- Fix exception during "attic create" with repeated files (#39)
+- New "--exclude-from" option for attic create/extract/verify.
+- Improved archive metadata deduplication.
+- "attic verify" has been deprecated. Use "attic extract --dry-run" instead.
+- "attic prune --hourly|daily|..." has been deprecated.
+  Use "attic prune --keep-hourly|daily|..." instead.
+- Ignore xattr errors during "extract" if not supported by the filesystem. (#46)
+
+Version 0.10
+~~~~~~~~~~~~
+
+(bugfix release, released on Jan 30, 2014)
+
+- Fix deadlock when extracting 0 sized files from remote repositories
+- "--exclude" wildcard patterns are now properly applied to the full path
+  not just the file name part (#5).
+- Make source code endianness agnostic (#1)
+
+Version 0.9
+~~~~~~~~~~~
+
+(feature release, released on Jan 23, 2014)
+
+- Remote repository speed and reliability improvements.
+- Fix sorting of segment names to ignore NFS left over files. (#17)
+- Fix incorrect display of time (#13)
+- Improved error handling / reporting. (#12)
+- Use fcntl() instead of flock() when locking repository/cache. (#15)
+- Let ssh figure out port/user if not specified so we don't override .ssh/config (#9)
+- Improved libcrypto path detection (#23).
+
+Version 0.8.1
+~~~~~~~~~~~~~
+
+(bugfix release, released on Oct 4, 2013)
+
+- Fix segmentation fault issue.
+
+Version 0.8
+~~~~~~~~~~~
+
+(feature release, released on Oct 3, 2013)
+
+- Fix xattr issue when backing up sshfs filesystems (#4)
+- Fix issue with excessive index file size (#6)
+- Support access of read only repositories.
+- New syntax to enable repository encryption:
+    attic init --encryption="none|passphrase|keyfile".
+- Detect and abort if repository is older than the cache.
+
+
+Version 0.7
+~~~~~~~~~~~
+
+(feature release, released on Aug 5, 2013)
+
+- Ported to FreeBSD
+- Improved documentation
+- Experimental: Archives mountable as FUSE filesystems.
+- The "user." prefix is no longer stripped from xattrs on Linux
+
+
+Version 0.6.1
+~~~~~~~~~~~~~
+
+(bugfix release, released on July 19, 2013)
+
+- Fixed an issue where mtime was not always correctly restored.
+
+
+Version 0.6
+~~~~~~~~~~~
+
+First public release on July 9, 2013

docs/changes_1.x.rst

@@ -0,0 +1,4362 @@
+.. _important_notes_1x:
+
+Important notes 1.x
+===================
+
+This section provides information about security and corruption issues.
+
+.. _hashindex_set_bug:
+
+Pre-1.1.11 potential index corruption / data loss issue
+-------------------------------------------------------
+
+A bug was discovered in our hashtable code, see issue #4829.
+The code is used for the client-side chunks cache and the server-side repo index.
+
+Although borg uses the hashtables very heavily, the index corruption did not
+happen too frequently, because it needed specific conditions to happen.
+
+Data loss required even more specific conditions, so it should be rare (and
+also detectable via borg check).
+
+You might be affected if borg crashed with / complained about:
+
+- AssertionError: Corrupted segment reference count - corrupted index or hints
+- ObjectNotFound: Object with key ... not found in repository ...
+- Index mismatch for key b'...'. (..., ...) != (-1, -1)
+- ValueError: stats_against: key contained in self but not in master_index.
+
+Advised procedure to fix any related issue in your indexes/caches:
+
+- install fixed borg code (on client AND server)
+- for all of your clients and repos remove the cache by:
+
+  borg delete --cache-only YOURREPO
+
+  (later, the cache will be re-built automatically)
+- for all your repos, rebuild the repo index by:
+
+  borg check --repair YOURREPO
+
+  This will also check all archives and detect if there is any data-loss issue.
+
+Affected branches / releases:
+
+- fd06497 introduced the bug into 1.1-maint branch - it affects all borg 1.1.x since 1.1.0b4.
+- fd06497 introduced the bug into master branch - it affects all borg 1.2.0 alpha releases.
+- c5cd882 introduced the bug into 1.0-maint branch - it affects all borg 1.0.x since 1.0.11rc1.
+
+The bug was fixed by:
+
+- 701159a fixes the bug in 1.1-maint branch - will be released with borg 1.1.11.
+- fa63150 fixes the bug in master branch - will be released with borg 1.2.0a8.
+- 7bb90b6 fixes the bug in 1.0-maint branch. Branch is EOL, no new release is planned as of now.
+
+.. _broken_validator:
+
+Pre-1.1.4 potential data corruption issue
+-----------------------------------------
+
+A data corruption bug was discovered in borg check --repair, see issue #3444.
+
+This is a 1.1.x regression, releases < 1.1 (e.g. 1.0.x) are not affected.
+
+To avoid data loss, you must not run borg check --repair using an unfixed version
+of borg 1.1.x. The first official release that has the fix is 1.1.4.
+
+Package maintainers may have applied the fix to updated packages of 1.1.x (x<4)
+though, see the package maintainer's package changelog to make sure.
+
+If you never had missing item metadata chunks, the bug has not affected you
+even if you did run borg check --repair with an unfixed version.
+
+When borg check --repair tried to repair corrupt archives that miss item metadata
+chunks, the resync to valid metadata in still present item metadata chunks
+malfunctioned. This was due to a broken validator that considered all (even valid)
+item metadata as invalid. As they were considered invalid, borg discarded them.
+Practically, that means the affected files, directories or other fs objects were
+discarded from the archive.
+
+Due to the malfunction, the process was extremely slow, but if you let it
+complete, borg would have created a "repaired" archive that has lost a lot of items.
+If you interrupted borg check --repair because it was so strangely slow (killing
+borg somehow, e.g. Ctrl-C) the transaction was rolled back and no corruption occurred.
+
+The log message indicating the precondition for the bug triggering looks like:
+
+    item metadata chunk missing [chunk: 001056_bdee87d...a3e50d]
+
+If you never had that in your borg check --repair runs, you're not affected.
+
+But if you're unsure or you actually have seen that, better check your archives.
+By just using "borg list repo::archive" you can see if all expected filesystem
+items are listed.
+
+.. _tam_vuln:
+
+Pre-1.0.9 manifest spoofing vulnerability (CVE-2016-10099)
+----------------------------------------------------------
+
+A flaw in the cryptographic authentication scheme in Borg allowed an attacker
+to spoof the manifest. The attack requires an attacker to be able to
+
+1. insert files (with no additional headers) into backups
+2. gain write access to the repository
+
+This vulnerability does not disclose plaintext to the attacker, nor does it
+affect the authenticity of existing archives.
+
+The vulnerability allows an attacker to create a spoofed manifest (the list of archives).
+Creating plausible fake archives may be feasible for small archives, but is unlikely
+for large archives.
+
+The fix adds a separate authentication tag to the manifest. For compatibility
+with prior versions this authentication tag is *not* required by default
+for existing repositories. Repositories created with 1.0.9 and later require it.
+
+Steps you should take:
+
+1. Upgrade all clients to 1.0.9 or later.
+2. Run ``borg upgrade --tam <repository>`` *on every client* for *each* repository.
+3. This will list all archives, including archive IDs, for easy comparison with your logs.
+4. Done.
+
+Prior versions can access and modify repositories with this measure enabled, however,
+to 1.0.9 or later their modifications are indiscernible from an attack and will
+raise an error until the below procedure is followed. We are aware that this can
+be annoying in some circumstances, but don't see a way to fix the vulnerability
+otherwise.
+
+In case a version prior to 1.0.9 is used to modify a repository where above procedure
+was completed, and now you get an error message from other clients:
+
+1. ``borg upgrade --tam --force <repository>`` once with *any* client suffices.
+
+This attack is mitigated by:
+
+- Noting/logging ``borg list``, ``borg info``, or ``borg create --stats``, which
+  contain the archive IDs.
+
+We are not aware of others having discovered, disclosed or exploited this vulnerability.
+
+Vulnerability time line:
+
+* 2016-11-14: Vulnerability and fix discovered during review of cryptography by Marian Beermann (@enkore)
+* 2016-11-20: First patch
+* 2016-12-20: Released fixed version 1.0.9
+* 2017-01-02: CVE was assigned
+* 2017-01-15: Released fixed version 1.1.0b3 (fix was previously only available from source)
+
+.. _attic013_check_corruption:
+
+Pre-1.0.9 potential data loss
+-----------------------------
+
+If you have archives in your repository that were made with attic <= 0.13
+(and later migrated to borg), running borg check would report errors in these
+archives. See issue #1837.
+
+The reason for this is a invalid (and useless) metadata key that was
+always added due to a bug in these old attic versions.
+
+If you run borg check --repair, things escalate quickly: all archive items
+with invalid metadata will be killed. Due to that attic bug, that means all
+items in all archives made with these old attic versions.
+
+
+Pre-1.0.4 potential repo corruption
+-----------------------------------
+
+Some external errors (like network or disk I/O errors) could lead to
+corruption of the backup repository due to issue #1138.
+
+A sign that this happened is if "E" status was reported for a file that can
+not be explained by problems with the source file. If you still have logs from
+"borg create -v --list", you can check for "E" status.
+
+Here is what could cause corruption and what you can do now:
+
+1) I/O errors (e.g. repo disk errors) while writing data to repo.
+
+This could lead to corrupted segment files.
+
+Fix::
+
+    # check for corrupt chunks / segments:
+    borg check -v --repository-only REPO
+
+    # repair the repo:
+    borg check -v --repository-only --repair REPO
+
+    # make sure everything is fixed:
+    borg check -v --repository-only REPO
+
+2) Unreliable network / unreliable connection to the repo.
+
+This could lead to archive metadata corruption.
+
+Fix::
+
+    # check for corrupt archives:
+    borg check -v --archives-only REPO
+
+    # delete the corrupt archives:
+    borg delete --force REPO::CORRUPT_ARCHIVE
+
+    # make sure everything is fixed:
+    borg check -v --archives-only REPO
+
+3) In case you want to do more intensive checking.
+
+The best check that everything is ok is to run a dry-run extraction::
+
+    borg extract -v --dry-run REPO::ARCHIVE
+
+.. _changelog_1x:
+
+Change Log 1.x
+==============
+
+Version 1.3.0a1 (2022-04-15)
+----------------------------
+
+Please note:
+
+This is an alpha release, only for testing - do not use this with production repos.
+
+New features:
+
+- init: new --encryption=(repokey|keyfile)-[blake2-](aes-ocb|chacha20-poly1305)
+
+  - New, better, faster crypto (see encryption-aead diagram in the docs), #6463.
+  - New AEAD cipher suites: AES-OCB and CHACHA20-POLY1305.
+  - Session keys are derived via HKDF from random session id and master key.
+  - Nonces/MessageIVs are counters starting from 0 for each session.
+  - AAD: chunk id, key type, messageIV, sessionID are now authenticated also.
+  - Solves the potential AES-CTR mode counter management issues of the legacy crypto.
+- init: --key-algorithm=argon2 (new default KDF, older pbkdf2 also still available)
+
+  borg key change-passphrase / change-location keeps the key algorithm unchanged.
+- key change-algorithm: to upgrade existing keys to argon2 or downgrade to pbkdf2.
+
+  We recommend you to upgrade unless you have to keep the key compatible with older versions of borg.
+- key change-location: usable for repokey <-> keyfile location change
+- benchmark cpu: display benchmarks of cpu bound stuff
+- export-tar: new --tar-format=PAX (default: GNU)
+- import-tar/export-tar: can use PAX format for ctime and atime support
+- import-tar/export-tar: --tar-format=BORG: roundtrip ALL item metadata, #5830
+- repository: create and use version 2 repos only for now
+- repository: implement PUT2: header crc32, overall xxh64, #1704
+
+Other changes:
+
+- require python >= 3.9, #6315
+- simplify libs setup, #6482
+- unbundle most bundled 3rd party code, use libs, #6316
+- use libdeflate.crc32 (Linux and all others) or zlib.crc32 (macOS)
+- repository: code cleanups / simplifications
+- internal crypto api: speedups / cleanups / refactorings / modernisation
+- remove "borg upgrade" support for "attic backup" repos
+- remove PassphraseKey code and borg key migrate-to-repokey command
+- OpenBSD: build borg with OpenSSL (not: LibreSSL), #6474
+- remove support for LibreSSL, #6474
+- remove support for OpenSSL < 1.1.1
+
+
+Version 1.2.0 (2022-02-22 22:02:22 :-)
+--------------------------------------
+
+Please note:
+
+This is the first borg 1.2 release, so be careful and read the notes below.
+
+Upgrade notes:
+
+Strictly taken, nothing special is required for upgrading to 1.2, but some
+things can be recommended:
+
+- do you already want to upgrade? 1.1.x also will get fixes for a while.
+- be careful, first upgrade your less critical / smaller repos.
+- first upgrade to a recent 1.1.x release - especially if you run some older
+  1.1.* or even 1.0.* borg release.
+- using that, run at least one `borg create` (your normal backup), `prune`
+  and especially a `check` to see everything is in a good state.
+- check the output of `borg check` - if there is anything special, consider
+  a `borg check --repair` followed by another `borg check`.
+- if everything is fine so far (borg check reports no issues), you can consider
+  upgrading to 1.2.0. if not, please first fix any already existing issue.
+- if you want to play safer, first **create a backup of your borg repository**.
+- upgrade to latest borg 1.2.x release (you could use the fat binary from
+  github releases page)
+- run `borg compact --cleanup-commits` to clean up a ton of 17 bytes long files
+  in your repo caused by a borg 1.1 bug
+- run `borg check` again (now with borg 1.2.x) and check if there is anything
+  special.
+- run `borg info` (with borg 1.2.x) to build the local pre12-meta cache (can
+  take significant time, but after that it will be fast) - for more details
+  see below.
+- check the compatibility notes (see below) and adapt your scripts, if needed.
+- if you run into any issues, please check the github issue tracker before
+  posting new issues there or elsewhere.
+
+If you follow this procedure, you can help avoiding that we get a lot of
+"borg 1.2" issue reports that are not really 1.2 issues, but existed before
+and maybe just were not noticed.
+
+Compatibility notes:
+
+- matching of path patterns has been aligned with borg storing relative paths.
+  Borg archives file paths without leading slashes. Previously, include/exclude
+  patterns could contain leading slashes. You should check your patterns and
+  remove leading slashes.
+- dropped support / testing for older Pythons, minimum requirement is 3.8.
+  In case your OS does not provide Python >= 3.8, consider using our binary,
+  which does not need an external Python interpreter. Or continue using
+  borg 1.1.x, which is still supported.
+- freeing repository space only happens when "borg compact" is invoked.
+- mount: the default for --numeric-ids is False now (same as borg extract)
+- borg create --noatime is deprecated. Not storing atime is the default behaviour
+  now (use --atime if you want to store the atime).
+- list: corrected mix-up of "isomtime" and "mtime" formats.
+  Previously, "isomtime" was the default but produced a verbose human format,
+  while "mtime" produced a ISO-8601-like format.
+  The behaviours have been swapped (so "mtime" is human, "isomtime" is ISO-like),
+  and the default is now "mtime".
+  "isomtime" is now a real ISO-8601 format ("T" between date and time, not a space).
+- create/recreate --list: file status for all files used to get announced *AFTER*
+  the file (with borg < 1.2). Now, file status is announced *BEFORE* the file
+  contents are processed. If the file status changes later (e.g. due to an error
+  or a content change), the updated/final file status will be printed again.
+- removed deprecated-since-long stuff (deprecated since):
+
+  - command "borg change-passphrase" (2017-02), use "borg key ..."
+  - option "--keep-tag-files" (2017-01), use "--keep-exclude-tags"
+  - option "--list-format" (2017-10), use "--format"
+  - option "--ignore-inode" (2017-09), use "--files-cache" w/o "inode"
+  - option "--no-files-cache" (2017-09), use "--files-cache=disabled"
+- removed BORG_HOSTNAME_IS_UNIQUE env var.
+  to use borg you must implement one of these 2 scenarios:
+
+  - 1) the combination of FQDN and result of uuid.getnode() must be unique
+       and stable (this should be the case for almost everybody, except when
+       having duplicate FQDN *and* MAC address or all-zero MAC address)
+  - 2) if you are aware that 1) is not the case for you, you must set
+       BORG_HOST_ID env var to something unique.
+- exit with 128 + signal number, #5161.
+  if you have scripts expecting rc == 2 for a signal exit, you need to update
+  them to check for >= 128.
+
+Fixes:
+
+- diff: reduce memory consumption, fix is_hardlink_master, #6295
+- compact: fix / improve freeable / freed space log output
+
+  - derive really freed space from quota use before/after, #5679
+  - do not say "freeable", but "maybe freeable" (based on hint, unsure)
+- fix race conditions in internal SaveFile function, #6306 #6028
+- implement internal safe_unlink (was: truncate_and_unlink) function more safely:
+  usually it does not truncate any more, only under "disk full" circumstances
+  and only if there is only one hardlink.
+  see: https://github.com/borgbackup/borg/discussions/6286
+
+Other changes:
+
+- info: use a pre12-meta cache to accelerate stats for borg < 1.2 archives.
+  the first time borg info is invoked on a borg 1.1 repo, it can take a
+  rather long time computing and caching some stats values for 1.1 archives,
+  which borg 1.2 archives have in their archive metadata structure.
+  be patient, esp. if you have lots of old archives.
+  following invocations are much faster due to the cache.
+  related change: add archive name to calc_stats progress display.
+- docs:
+
+  - add borg 1.2 upgrade notes, #6217
+  - link to borg placeholders and borg patterns help
+  - init: explain the encryption modes better
+  - clarify usage of patternfile roots
+  - put import-tar docs into same file as export-tar docs
+  - explain the difference between a path that ends with or without a slash,
+    #6297
+
+
+Version 1.2.0rc1 (2022-02-05)
+-----------------------------
+
+Fixes:
+
+- repo::archive location placeholder expansion fixes, #5826, #5998
+- repository: fix intermediate commits, shall be at end of current segment
+- delete: don't commit if nothing was deleted, avoid cache sync, #6060
+- argument parsing: accept some options only once, #6026
+- disallow overwriting of existing keyfiles on init, #6036
+- if ensure_dir() fails, give more informative error message, #5952
+
+New features:
+
+- delete --force: do not ask when deleting a repo, #5941
+
+Other changes:
+
+- requirements: exclude broken or incompatible-with-pyinstaller setuptools
+- add a requirements.d/development.lock.txt and use it for vagrant
+- tests:
+
+  - added nonce-related tests
+  - refactor: remove assert_true
+  - vagrant: macos box tuning, netbsd box fixes, #5370, #5922
+- docs:
+
+  - update install docs / requirements docs, #6180
+  - borg mount / FUSE "versions" view is not experimental any more
+  - --pattern* is not experimental any more, #6134
+  - impact of deleting path/to/repo/nonce, #5858
+  - key export: add examples, #6204
+  - ~/.config/borg/keys is not used for repokey keys, #6107
+  - excluded parent dir's metadata can't restore
+
+
+Version 1.2.0b4 (2022-01-23)
+----------------------------
+
+Fixes:
+
+- create: fix passing device nodes and symlinks to --paths-from-stdin, #6009
+- create --dry-run: fix display of kept tagfile, #5834
+- check --repair: fix missing parameter in "did not consistently fail" msg, #5822
+- fix hardlinkable file type check, #6037
+- list: remove placeholders for shake_* hashes, #6082
+- prune: handle case of calling prune_split when there are no archives, #6015
+- benchmark crud: make sure cleanup of borg-test-data files/dir happens, #5630
+- do not show archive name in repository-related error msgs, #6014
+- prettier error msg (no stacktrace) if exclude file is missing, #5734
+- do not require BORG_CONFIG_DIR if BORG_{SECURITY,KEYS}_DIR are set, #5979
+- fix pyinstaller detection for dir-mode, #5897
+- atomically create the CACHE_TAG file, #6028
+- deal with the SaveFile/SyncFile race, docs, see #6056 708a5853
+- avoid expanding path into LHS of formatting operation + tests, #6064 #6063
+- repository: quota / compactable computation fixes
+- info: emit repo info even if repo has 0 archives + test, #6120
+
+New features:
+
+- check --repair: significantly speed up search for next valid object in segment, #6022
+- check: add progress indicator for archive check, #5809
+- create: add retry_erofs workaround for O_NOATIME issue on volume shadow copies in WSL1, #6024
+- create: allow --files-cache=size (this is potentially dangerous, use on your own risk), #5686
+- import-tar: implement import-tar to complement export-tar, #2233
+- implement BORG_SELFTEST env variable (can be carefully used to speedup borg hosting), #5871
+- key export: print key if path is '-' or not given, #6092
+- list --format: Add command_line to format keys
+
+Other changes:
+
+- pypi metadata: alpha -> beta
+- require python 3.8+, #5975
+- use pyinstaller 4.7
+- allow msgpack 1.0.3
+- upgrade to bundled xxhash to 0.8.1
+- import-tar / export-tar: tar file related changes:
+
+  - check for short tarfile extensions
+  - add .lz4 and .zstd
+  - fix docs about extensions and decompression commands
+- add github codeql analysis, #6148
+- vagrant:
+
+  - box updates / add new boxes / remove outdated and broken boxes
+  - use Python 3.9.10 (incl. binary builds) and 3.10.0
+  - fix pyenv initialisation, #5798
+  - fix vagrant scp on macOS, #5921
+  - use macfuse instead of osxfuse
+- shell completions:
+
+  - update shell completions to 1.1.17, #5923
+  - remove BORG_LIBC completion, since 9914968 borg no longer uses find_library().
+- docs:
+
+  - fixed readme.rst irc webchat link (we use libera chat now, not freenode)
+  - fix exceptions thrown by `setup.py build_man`
+  - check --repair: recommend checking hw before check --repair, #5855
+  - check --verify-data: clarify and document conflict with --repository-only, #5808
+  - serve: improve ssh forced commands docs, #6083
+  - list: improve docs for `borg list` --format, #6061
+  - list: remove --list-format from borg list
+  - FAQ: fix manifest-timestamp path (inside security dir)
+  - fix the broken link to .nix file
+  - document behavior for filesystems with inconsistent inodes, #5770
+  - clarify user_id vs uid for fuse, #5723
+  - clarify pattern usage with commands, #5176
+  - clarify pp vs. pf pattern type, #5300
+  - update referenced freebsd/macOS versions used for binary build, #5942
+  - pull mode: add some warnings, #5827
+  - clarify "you will need key and passphrase" borg init warning, #4622
+  - add missing leading slashes in help patterns, #5857
+  - add info on renaming repositories, #5240
+  - check: add notice about defective hardware, #5753
+  - mention tar --compare (compare archive to fs files), #5880
+  - add note about grandfather-father-son backup retention policy / rotation scheme, #6006
+  - permissions note rewritten to make it less confusing
+  - create github security policy
+  - remove leftovers of BORG_HOSTNAME_IS_UNIQUE
+  - excluded parent dir's metadata can't restore. (#6062)
+  - if parent dir is not extracted, we do not have its metadata
+  - clarify who starts the remote agent
+
+
+Version 1.2.0b3 (2021-05-12)
+----------------------------
+
+Fixes:
+
+- create: fix --progress --log-json, #4360#issuecomment-774580052
+- do not load files cache for commands not using it, #5673
+- fix repeated cache tag file writing bug
+
+New features:
+
+- create/recreate: print preliminary file status early, #5417
+- create/extract: add --noxattrs and --noacls options, #3955
+- create: verbose files cache logging via --debug-topic=files_cache, #5659
+- mount: implement --numeric-ids (default: False!), #2377
+- diff: add --json-lines option
+- info / create --stats: add --iec option to print sizes in powers of 1024.
+
+Other changes:
+
+- create: add --upload-(ratelimit|buffer), deprecate --remote-* options, #5611
+- create/extract/mount: add --numeric-ids, deprecate --numeric-owner option, #5724
+- config: accept non-int value for max_segment_size / storage_quota
+- use PyInstaller v4.3, #5671
+- vagrant: use Python 3.9.5 to build binaries
+- tox.ini: modernize and enable execution without preinstalling deps
+- cleanup code style checks
+- get rid of distutils, use setuptools+packaging
+- github CI: test on Python 3.10-dev
+- check: missing / healed chunks: always tell chunk ID, #5704
+- docs:
+
+  - remove bad /var/cache exclusion in example commands, #5625
+  - misc. fixes and improvements, esp. for macOS
+  - add unsafe workaround to use an old repo copy, #5722
+
+
+Version 1.2.0b2 (2021-02-06)
+----------------------------
+
+Fixes:
+
+- create: do not recurse into duplicate roots, #5603
+- create: only print stats if not ctrl-c'ed, fixes traceback, #5668
+- extract:
+  improve exception handling when setting xattrs, #5092.
+  emit a warning message giving the path, xattr key and error message.
+  continue trying to restore other xattrs and bsdflags of the same file
+  after an exception with xattr-setting happened.
+- export-tar:
+  fix memory leak with ssh: remote repository, #5568.
+  fix potential memory leak with ssh: remote repository with partial extraction.
+- remove empty shadowed_segments lists, #5275
+- fix bad default: manifest.archives.list(consider_checkpoints=False),
+  fixes tracebacks / KeyErros for missing objects in ChunkIndex, #5668
+
+New features:
+
+- create: improve sparse file support
+
+  - create --sparse (detect sparse file holes) and file map support,
+    only for the "fixed" chunker, #14
+  - detect all-zero chunks in read data in "buzhash" and "fixed" chunkers
+  - cached_hash: use a small LRU cache to accelerate all-zero chunks hashing
+  - use cached_hash also to generate all-zero replacement chunks
+- create --remote-buffer, add a upload buffer for remote repos, #5574
+- prune: keep oldest archive when retention target not met
+
+Other changes:
+
+- use blake2 from python 3.6+ hashlib
+  (this removes the requirement for libb2 and the bundled blake2 code)
+- also accept msgpack up to 1.0.2.
+  exclude 1.0.1 though, which had some issues (not sure they affect borg).
+- create: add repository location to --stats output, #5491
+- check: debug log the segment filename
+- delete: add a --list switch to borg delete, #5116
+- borg debug dump-hints - implemented to e.g. to look at shadow_index
+- Tab completion support for additional archives for 'borg delete'
+- refactor: have one borg.constants.zero all-zero bytes object
+- refactor shadow_index updating repo.put/delete, #5661, #5636.
+- docs:
+
+  - add another case of attempted hardlink usage
+  - fix description of borg upgrade hardlink usage, #5518
+  - use HTTPS everywhere
+  - add examples for --paths-from-stdin, --paths-from-command, --paths-separator, #5644
+  - fix typos/grammar
+  - update docs for dev environment installation instructions
+  - recommend running tests only on installed versions for setup
+  - add badge with current status of package
+- vagrant:
+
+  - use brew install --cask ..., #5557
+  - use Python 3.9.1 and PyInstaller 4.1 to build the borg binary
+
+
+Version 1.2.0b1 (2020-12-06)
+----------------------------
+
+Fixes:
+
+- BORG_CACHE_DIR crashing borg if empty, atomic handling of
+  recursive directory creation, #5216
+- fix --dry-run and --stats coexistence, #5415
+- allow EIO with warning when trying to hardlink, #4336
+- export-tar: set tar format to GNU_FORMAT explicitly, #5274
+- use --timestamp for {utcnow} and {now} if given, #5189
+- make timestamp helper timezone-aware
+
+New features:
+
+- create: implement --paths-from-stdin and --paths-from-command, see #5492.
+  These switches read paths to archive from stdin. Delimiter can specified
+  by --paths-delimiter=DELIM. Paths read will be added honoring every
+  option but exclusion options and --one-file-system. borg won't recurse
+  into directories.
+- 'obfuscate' pseudo compressor obfuscates compressed chunk size in repo
+- add pyfuse3 (successor of llfuse) as an alternative lowlevel fuse
+  implementation to llfuse (deprecated), #5407.
+  FUSE implementation can be switched via env var BORG_FUSE_IMPL.
+- allow appending to the files cache filename with BORG_FILES_CACHE_SUFFIX
+- create: implement --stdin-mode, --stdin-user and --stdin-group, #5333
+
+Other changes:
+
+- split recursive directory walking/processing into directory walking and
+  item processing.
+- fix warning by importing setuptools before distutils.
+- debug info: include infos about FUSE implementation, #5546
+- testing:
+
+  - add a test for the hashindex corruption bug, #5531 #4829
+  - move away from travis-ci, use github actions, #5528 #5467
+  - test both on fuse2 and fuse3
+  - upload coverage reports to codecov
+  - fix spurious failure in test_cache_files, #5438
+  - add tests for Location.with_timestamp
+  - tox: add a non-fuse env to the envlist
+- vagrant:
+
+  - use python 3.7.latest and pyinstaller 4.0 for binary creation
+  - pyinstaller: compute basepath from spec file location
+  - vagrant: updates/fixes for archlinux box, #5543
+- docs:
+
+  - "filename with spaces" example added to exclude file, #5236
+  - add a hint about sleeping computer, #5301
+  - how to adjust macOS >= Catalina security settings, #5303
+  - process/policy for adding new compression algorithms
+  - updated docs about hacked backup client, #5480
+  - improve ansible deployment docs, make it more generic
+  - how to approach borg speed issues, give speed example, #5371
+  - fix mathematical inaccuracy about chunk size, #5336
+  - add example for excluding content using --pattern cli option
+  - clarify borg create's '--one-file-system' option, #4009
+  - improve docs/FAQ about append-only remote repos, #5497
+  - fix reST markup issues, labels
+  - add infos about contributor retirement status
+
+
+Version 1.2.0a9 (2020-10-05)
+----------------------------
+
+Fixes:
+
+- fix memory leak related to preloading, #5202
+- check --repair: fix potential data loss, #5325
+- persist shadow_index in between borg runs, #4830
+- fix hardlinked CACHEDIR.TAG processing, #4911
+- --read-special: .part files also should be regular files, #5217
+- allow server side enforcing of umask, --umask is for the local borg
+  process only (see docs), #4947
+- exit with 128 + signal number, #5161
+- borg config --list does not show last_segment_checked, #5159
+- locking:
+
+  - fix ExclusiveLock race condition bug, #4923
+  - fix race condition in lock migration, #4953
+  - fix locking on openindiana, #5271
+
+New features:
+
+- --content-from-command: create archive using stdout of given command, #5174
+- allow key-import + BORG_KEY_FILE to create key files
+- build directory-based binary for macOS to avoid Gatekeeper delays
+
+Other changes:
+
+- upgrade bundled zstd to 1.4.5
+- upgrade bundled xxhash to 0.8.0, #5362
+- if self test fails, also point to OS and hardware, #5334
+- misc. shell completions fixes/updates, rewrite zsh completion
+- prettier error message when archive gets too big, #5307
+- stop relying on `false` exiting with status code 1
+- rephrase some warnings, #5164
+- parseformat: unnecessary calls removed, #5169
+- testing:
+
+  - enable Python3.9 env for test suite and VMs, #5373
+  - drop python 3.5, #5344
+  - misc. vagrant fixes/updates
+  - misc. testing fixes, #5196
+- docs:
+
+  - add ssh-agent pull backup method to doc, #5288
+  - mention double --force in prune docs
+  - update Homebrew install instructions, #5185
+  - better description of how cache and rebuilds of it work
+    and how the workaround applies to that
+  - point to borg create --list item flags in recreate usage, #5165
+  - add a note to create from stdin regarding files cache, #5180
+  - add security faq explaining AES-CTR crypto issues, #5254
+  - clarify --exclude-if-present in recreate, #5193
+  - add socat pull mode, #5150, #900
+  - move content of resources doc page to community project, #2088
+  - explain hash collision, #4884
+  - clarify --recompress option, #5154
+
+
+Version 1.2.0a8 (2020-04-22)
+----------------------------
+
+Fixes:
+
+- fixed potential index corruption / data loss issue due to bug in hashindex_set, #4829.
+  Please read and follow the more detailed notes close to the top of this document.
+- fix crash when upgrading erroneous hints file, #4922
+- commit-time free space calc: ignore bad compact map entries, #4796
+- info: if the archive doesn't exist, print a pretty message, #4793
+- --prefix / -P: fix processing, avoid argparse issue, #4769
+- ignore EACCES (errno 13) when hardlinking, #4730
+- add a try catch when formatting the info string, #4818
+- check: do not stumble over invalid item key, #4845
+- update prevalence of env vars to set config and cache paths
+- mount: fix FUSE low linear read speed on large files, #5032
+- extract: fix confusing output of borg extract --list --strip-components, #4934
+- recreate: support --timestamp option, #4745
+- fix ProgressIndicator msgids (JSON output), #4935
+- fuse: set f_namemax in statfs result, #2684
+- accept absolute paths on windows
+- pyinstaller: work around issue with setuptools > 44
+
+New features:
+
+- chunker speedup (plus regression test)
+- added --consider-checkpoints and related test, #4788
+- added --noflags option, deprecate --nobsdflags option, #4489
+- compact: add --threshold option, #4674
+- mount: add birthtime to FUSE entries
+- support platforms with no os.link, #4901 - if we don't have os.link,
+  we just extract another copy instead of making a hardlink.
+- move sync_file_range to its own extension for better platform compatibility.
+- new --bypass-lock option to bypass locking, e.g. for read-only repos
+- accept absolute paths by removing leading slashes in patterns of all
+  sorts but re: style, #4029
+- delete: new --keep-security-info option
+
+Other changes:
+
+- support msgpack 0.6.2 and 1.0.0, #5065
+- upgrade bundled zstd to 1.4.4
+- upgrade bundled lz4 to 1.9.2
+- upgrade xxhash to 0.7.3
+- require recent enough llfuse for birthtime support, #5064
+- only store compressed data if the result actually is smaller, #4516
+- check: improve error output for matching index size, see #4829
+- ignore --stats when given with --dry-run, but continue, #4373
+- replaced usage of os.statvfs with shutil.disk_usage (better cross-platform support).
+- fuse: remove unneeded version check and compat code, micro opts
+- docs:
+
+  - improve description of path variables
+  - document how to completely delete data, #2929
+  - add FAQ about Borg config dir, #4941
+  - add docs about errors not printed as JSON, #4073
+  - update usage_general.rst.inc
+  - added "Will move with BORG_CONFIG_DIR variable unless specified." to BORG_SECURITY_DIR info.
+  - put BORG_SECURITY_DIR immediately below BORG_CONFIG_DIR (and moved BORG_CACHE_DIR up before them).
+  - add paragraph regarding cache security assumptions, #4900
+  - tell about borg cache security precautions
+  - add FAQ describing difference between a local repo vs. repo on a server.
+  - document how to test exclusion patterns without performing an actual backup
+  - create: tell that "Calculating size" time and space needs are caused by --progress
+  - fix/improve documentation for @api decorator, #4674
+  - add a pull backup / push restore how-to, #1552
+  - fix man pages creation, #4752
+  - more general FAQ for backup and retain original paths, #4532
+  - explain difference between --exclude and --pattern, #4118
+  - add FAQ for preventing SSH timeout in extract, #3866
+  - improve password FAQ (decrease pw length, add -w 0 option to base64 to prevent line wrap), #4591
+  - add note about patterns and stored paths, #4160
+  - add upgrade of tools to pip installation how-to, #5090
+  - document one cause of orphaned chunks in check command, #2295
+  - clean up the whole check usage paragraph
+  - FAQ: linked recommended restrictions to ssh public keys on borg servers, #4946
+  - fixed "doc downplays severity of Nonce reuse issue", #4883
+  - borg repo restore instructions needed, #3428
+  - new FAQ: A repo is corrupt and must be replaced with an older repo.
+  - clarify borg init's encryption modes
+- native windows port:
+
+  - update README_WINDOWS.rst
+  - updated pyinstaller spec file to support windows builds
+- testing / CI:
+
+  - improved travis config / install script, improved macOS builds
+  - allow osx builds to fail, #4955
+  - Windows 10 build on Appveyor CI
+- vagrant:
+
+  - upgrade pyinstaller to v3.5 + patch
+  - use py369 for binary build, add py380 for tests
+  - fix issue in stretch VM hanging at grub installation
+  - add a debian buster and a ubuntu focal VM
+  - update darwin box to 10.12
+  - upgrade FreeBSD box to 12.1
+  - fix debianoid virtualenv packages
+  - use pyenv in freebsd64 VM
+  - remove the flake8 test
+  - darwin: avoid error if pkg is already installed
+  - debianoid: don't interactively ask questions
+
+
+Version 1.2.0a7 (2019-09-07)
+----------------------------
+
+Fixes:
+
+- slave hardlinks extraction issue, see #4350
+- extract: fix KeyError for "partial" extraction, #4607
+- preload chunks for hardlink slaves w/o preloaded master, #4350
+- fix preloading for old remote servers, #4652
+- fix partial extract for hardlinked contentless file types, #4725
+- Repository.open: use stat() to check for repo dir, #4695
+- Repository.check_can_create_repository: use stat() to check, ~ #4695.
+- SecurityManager.known(): check all files, #4614
+- after double-force delete, warn about necessary repair, #4704
+- cope with ANY error when importing pytest into borg.testsuite, #4652
+- fix invalid archive error message
+- setup.py: fix detection of missing Cython
+- filter out selinux xattrs, #4574
+- location arg - should it be optional? #4541
+- enable placeholder usage in --comment, #4559
+- use whitelist approach for borg serve, #4097
+
+New features:
+
+- minimal native Windows support, see windows readme (work in progress)
+- create: first ctrl-c (SIGINT) triggers checkpoint and abort, #4606
+- new BORG_WORKAROUNDS mechanism, basesyncfile, #4710
+- remove WSL autodetection. if WSL still has this problem, you need to
+  set BORG_WORKAROUNDS=basesyncfile in the borg process environment to
+  work around it.
+- support xxh64 checksum in addition to the hashlib hashes in borg list
+- enable placeholder usage in all extra archive arguments
+- enable placeholder usage in --comment, #4559
+- enable placeholder usage in --glob-archives, #4495
+- ability to use a system-provided version of "xxhash"
+- create:
+
+  - changed the default behaviour to not store the atime of fs items. atime is
+    often rather not interesting and fragile - it easily changes even if nothing
+    else has changed and, if stored into the archive, spoils deduplication of
+    the archive metadata stream.
+  - if you give the --noatime option, borg will output a deprecation warning
+    because it is currently ignored / does nothing.
+    Please remove the --noatime option when using borg 1.2.
+  - added a --atime option for storing files' atime into an archive
+
+Other changes:
+
+- argparser: always use REPOSITORY in metavar
+- do not check python/libc for borg serve, #4483
+- small borg compact improvements, #4522
+- compact: log freed space at INFO level
+- tests:
+
+  - tox / travis: add testing on py38-dev
+  - fix broken test that relied on improper zlib assumptions
+  - pure-py msgpack warning shall not make a lot of tests fail, #4558
+  - rename test_mount_hardlinks to test_fuse_mount_hardlinks (master)
+  - vagrant: add up-to-date openindiana box (py35, openssl10)
+  - get rid of confusing coverage warning, #2069
+- docs:
+
+  - reiterate that 'file cache names are absolute' in FAQ,
+    mention bind mount solution, #4738
+  - add restore docs, #4670
+  - updated docs to cover use of temp directory on remote, #4545
+  - add a push-style example to borg-create(1), #4613
+  - timestamps in the files cache are now usually ctime, #4583
+  - benchmark crud: clarify that space is used until compact
+  - update documentation of borg create,
+    corrects a mention of borg 1.1 as a future version.
+  - fix osxfuse github link in installation docs
+  - how to supply a passphrase, use crypto devices, #4549
+  - extract: document limitation "needs empty destination",  #4598
+  - update macOS Brew link
+  - add note about software for automating backup
+  - compact: improve docs,
+  - README: new URL for funding options
+
+
+Version 1.2.0a6 (2019-04-22)
+----------------------------
+
+Fixes:
+
+- delete / prune: consider part files correctly for stats, #4507
+- fix "all archives" stats considering part files, #4329
+- create: only run stat_simple_attrs() once
+- create: --stats does not work with --dry-run, exit with error msg, #4373
+- give "invalid repo" error msg if repo config not found, #4411
+
+New features:
+
+- display msgpack version as part of sysinfo (e.g. in tracebacks)
+
+Other changes:
+
+- docs:
+
+  - sdd "SSH Configuration" section, #4493, #3988, #636, #4485
+  - better document borg check --max-duration, #4473
+  - sorted commands help in multiple steps, #4471
+- testing:
+
+  - travis: use py 3.5.3 and 3.6.7 on macOS to get a pyenv-based python
+    build with openssl 1.1
+  - vagrant: use py 3.5.3 and 3.6.8 on darwin64 VM to build python and
+    borg with openssl 1.1
+  - pytest: -v and default XDISTN to 1, #4481
+
+
+Version 1.2.0a5 (2019-03-21)
+----------------------------
+
+Fixes:
+
+- warn if a file has changed while being backed up, #1750
+- lrucache: regularly remove old FDs, #4427
+- borg command shall terminate with rc 2 for ImportErrors, #4424
+- make freebsd xattr platform code api compatible with linux, #3952
+
+Other changes:
+
+- major setup code refactoring (especially how libraries like openssl, liblz4,
+  libzstd, libb2 are discovered and how it falls back to code bundled with
+  borg), new: uses pkg-config now (and needs python "pkgconfig" package
+  installed), #1925
+
+  if you are a borg package maintainer, please try packaging this
+  (see comments in setup.py).
+- Vagrantfile: add zstd, reorder, build env vars, #4444
+- travis: install script improvements
+- update shell completions
+- docs:
+
+  - add a sample logging.conf in docs/misc, #4380
+  - fix spelling errors
+  - update requirements / install docs, #4374
+
+
+Version 1.2.0a4 (2019-03-11)
+----------------------------
+
+Fixes:
+
+- do not use O_NONBLOCK for special files, like FIFOs, block and char devices
+  when using --read-special. fixes backing up FIFOs. fixes to test. #4394
+- more LibreSSL build fixes: LibreSSL has HMAC_CTX_free and HMAC_CTX_new
+
+New features:
+
+- check: incremental repo check (only checks crc32 for segment entries), #1657
+  borg check --repository-only --max-duration SECONDS ...
+- delete: timestamp for borg delete --info added, #4359
+
+Other changes:
+
+- redo stale lock handling, #3986
+  drop BORG_HOSTNAME_IS_UNIQUE (please use BORG_HOST_ID if needed).
+  borg now always assumes it has a unique host id - either automatically
+  from fqdn plus uuid.getnode() or overridden via BORG_HOST_ID.
+- docs:
+
+  - added Alpine Linux to distribution list
+  - elaborate on append-only mode docs
+- vagrant:
+
+  - darwin: new 10.12 box
+  - freebsd: new 12.0 box
+  - openbsd: new 6.4 box
+  - misc. updates / fixes
+
+
+Version 1.2.0a3 (2019-02-26)
+----------------------------
+
+Fixes:
+
+- LibreSSL build fixes, #4403
+- dummy ACL/xattr code fixes (used by OpenBSD and others), #4403
+- create: fix openat/statat issues for root directory, #4405
+
+
+Version 1.2.0a2 and earlier (2019-02-24)
+----------------------------------------
+
+New features:
+
+- compact: "borg compact" needs to be used to free repository space by
+  compacting the segments (reading sparse segments, rewriting still needed
+  data to new segments, deleting the sparse segments).
+  Borg < 1.2 invoked compaction automatically at the end of each repository
+  writing command.
+  Borg >= 1.2 does not do that any more to give better speed, more control,
+  more segment file stability (== less stuff moving to newer segments) and
+  more robustness.
+  See the docs about "borg compact" for more details.
+- "borg compact --cleanup-commits" is to cleanup the tons of 17byte long
+  commit-only segment files caused by borg 1.1.x issue #2850.
+  Invoke this once after upgrading (the server side) borg to 1.2.
+  Compaction now automatically removes unneeded commit-only segment files.
+- prune: Show which rule was applied to keep archive, #2886
+- add fixed blocksize chunker (see --chunker-params docs), #1086
+
+Fixes:
+
+- avoid stale filehandle issues, #3265
+- use more FDs, avoid race conditions on active fs, #906, #908, #1038
+- add O_NOFOLLOW to base flags, #908
+- compact:
+
+  - require >10% freeable space in a segment, #2985
+  - repository compaction now automatically removes unneeded 17byte
+    commit-only segments, #2850
+- make swidth available on all posix platforms, #2667
+
+Other changes:
+
+- repository: better speed and less stuff moving around by using separate
+  segment files for manifest DELETEs and PUTs, #3947
+- use pyinstaller v3.3.1 to build binaries
+- update bundled zstd code to 1.3.8, #4210
+- update bundled lz4 code to 1.8.3, #4209
+- msgpack:
+
+  - switch to recent "msgpack" pypi pkg name, #3890
+  - wrap msgpack to avoid future compat complications, #3632, #2738
+  - support msgpack 0.6.0 and 0.6.1, #4220, #4308
+
+- llfuse: modernize / simplify llfuse version requirements
+- code refactorings / internal improvements:
+
+  - include size/csize/nfiles[_parts] stats into archive, #3241
+  - calc_stats: use archive stats metadata, if available
+  - crypto: refactored crypto to use an AEAD style API
+  - crypto: new AES-OCB, CHACHA20-POLY1305
+  - create: use less syscalls by not using a python file obj, #906, #3962
+  - diff: refactor the diff functionality to new ItemDiff class, #2475
+  - archive: create FilesystemObjectProcessors class
+  - helpers: make a package, split into smaller modules
+  - xattrs: move to platform package, use cython instead ctypes, #2495
+  - xattrs/acls/bsdflags: misc. code/api optimizations
+  - FUSE: separate creation of filesystem from implementation of llfuse funcs, #3042
+  - FUSE: use unpacker.tell() instead of deprecated write_bytes, #3899
+  - setup.py: move build_man / build_usage code to setup_docs.py
+  - setup.py: update to use a newer Cython/setuptools API for compiling .pyx -> .c, #3788
+  - use python 3.5's os.scandir / os.set_blocking
+  - multithreading preparations (not used yet):
+
+    - item.to_optr(), Item.from_optr()
+    - fix chunker holding the GIL during blocking I/O
+  - C code portability / basic MSC compatibility, #4147, #2677
+- testing:
+
+  - vagrant: new VMs for linux/bsd/darwin, most with OpenSSL 1.1 and py36
+
+
+Version 1.1.18 (2022-06-05)
+---------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
+  If WSL still has a problem with sync_file_range, you need to set
+  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
+  work around the WSL issue.
+- 1.1.14 changes return codes due to a bug fix:
+  In case you have scripts expecting rc == 2 for a signal exit, you need to
+  update them to check for >= 128 (as documented since long).
+- 1.1.15 drops python 3.4 support, minimum requirement is 3.5 now.
+- 1.1.17 install_requires the "packaging" pypi package now.
+
+New features:
+
+- check --repair: significantly speed up search for next valid object in segment, #6022
+- create: add retry_erofs workaround for O_NOATIME issue on volume shadow copies in WSL1, #6024
+- key export: display key if path is '-' or not given, #6092
+- list --format: add command_line to format keys, #6108
+
+Fixes:
+
+- check: improve error handling for corrupt archive metadata block,
+  make robust_iterator more robust, #4777
+- diff: support presence change for blkdev, chrdev and fifo items, #6483
+- diff: reduce memory consumption, fix is_hardlink_master
+- init: disallow overwriting of existing keyfiles
+- info: fix authenticated mode repo to show "Encrypted: No", #6462
+- info: emit repo info even if repo has 0 archives, #6120
+- list: remove placeholders for shake_* hashes, #6082
+- mount -o versions: give clear error msg instead of crashing
+- show_progress: add finished=true/false to archive_progress json, #6570
+- fix hardlinkable file type check, #6037
+- do not show archive name in error msgs referring to the repository, #6023
+- prettier error msg (no stacktrace) if exclude file is missing, #5734
+- do not require BORG_CONFIG_DIR if BORG_{SECURITY,KEYS}_DIR are set, #5979
+- atomically create the CACHE_TAG file, #6028
+- deal with the SaveFile/SyncFile race, docs, see #6176 5c5b59bc9
+- avoid expanding path into LHS of formatting operation + tests, #6064 #6063
+- repository: quota / compactable computation fixes, #6119.
+  This is mainly to keep the repo code in sync with borg 1.2. As borg 1.1
+  compacts immediately, there was not really an issue with this in 1.1.
+- fix transaction rollback: use files cache filename as found in txn.active, #6353
+- do not load files cache for commands not using it, fixes #5673
+- fix scp repo url parsing for ip v6 addrs, #6526
+- repo::archive location placeholder expansion fixes, #5826, #5998
+
+  - use expanded location for log output
+  - support placeholder expansion for BORG_REPO env var
+- respect umask for created directory and file modes, #6400
+- safer truncate_and_unlink implementation
+
+Other changes:
+
+- upgrade bundled xxhash code to 0.8.1
+- fix xxh64 related build (setup.py and post-0.8.1 patch for static_assert).
+  The patch was required to build the bundled xxhash code on FreeBSD, see
+  https://github.com/Cyan4973/xxHash/pull/670
+- msgpack build: remove endianness macro, #6105
+- update and fix shell completions
+- fuse: remove unneeded version check and compat code
+- delete --force: do not ask when deleting a repo, #5941
+- delete: don't commit if nothing was deleted, avoid cache sync, #6060
+- delete: add repository id and location to prompt
+- compact segments: improve freeable / freed space log output, #5679
+- if ensure_dir() fails, give more informative error message, #5952
+- load_key: no key is same as empty key, #6441
+- better error msg for defect or unsupported repo configs, #6566
+- use hmac.compare_digest instead of ==, #6470
+- implement more standard hashindex.setdefault behaviour
+- remove stray punctuation from secure-erase message
+- add development.lock.txt, use a real python 3.5 to generate frozen reqs
+- setuptools 60.7.0 breaks pyinstaller, #6246
+- setup.py clean2 was added to work around some setuptools customizability limitation.
+- allow extra compiler flags for every extension build
+- C code: make switch fallthrough explicit
+- Cython code: fix "useless trailing comma" cython warnings
+- requirements.lock.txt: use the latest cython 0.29.30
+- fix compilation warnings: ‘PyUnicode_AsUnicode’ is deprecated
+- docs:
+
+  - ~/.config/borg/keys is not used for repokey keys, #6107
+  - excluded parent dir's metadata can't restore, #6062
+  - permissions note rewritten to make it less confusing, #5490
+  - add note about grandfather-father-son backup retention policy / rotation scheme
+  - clarify who starts the remote agent (borg serve)
+  - test/improve pull backup docs, #5903
+  - document the socat pull mode described in #900 #515ß
+  - borg serve: improve ssh forced commands docs, #6083
+  - improve docs for borg list --format, #6080
+  - fix the broken link to .nix file
+  - clarify pattern usage with commands, #5176
+  - clarify user_id vs uid for fuse, #5723
+  - fix binary build freebsd/macOS version, #5942
+  - FAQ: fix manifest-timestamp path, #6016
+  - remove duplicate faq entries, #5926
+  - fix sphinx warnings, #5919
+  - virtualisation speed tips
+  - fix values of TAG bytes, #6515
+  - recommend umask for passphrase file perms
+  - update link to ubuntu packages, #6485
+  - clarify on-disk order and size of log entry fields, #6357
+  - do not transform --/--- to unicode dashes
+  - improve linking inside docs, link to borg_placeholders, link to borg_patterns
+  - use same phrasing in misc. help texts
+  - borg init: explain the encryption modes better
+  - explain the difference between a path that ends with or without a slash, #6297
+  - clarify usage of patternfile roots, #6242
+  - borg key export: add examples
+  - updates about features not experimental any more: FUSE "versions" view, --pattern*, #6134
+  - fix/update cygwin package requirements
+  - impact of deleting path/to/repo/nonce, #5858
+  - warn about tampered server nonce
+  - mention BORG_FILES_CACHE_SUFFIX as alternative to BORG_FILES_CACHE_TTL, #5602
+  - add a troubleshooting note about "is not a valid repository" to the FAQ
+- vagrant / CI / testing:
+
+  - misc. fixes and updates, new python versions
+  - macOS on github: re-enable fuse2 testing by downgrading to older macOS, #6099
+  - fix OpenBSD symlink mode test failure, #2055
+  - use the generic/openbsd6 box
+  - strengthen the test: we can read data w/o nonces
+  - add tests for path/to/repo/nonce deletion
+  - darwin64: backport some tunings from master
+  - darwin64: remove fakeroot, #6314
+  - darwin64: fix vagrant scp, #5921
+  - darwin64: use macfuse instead of osxfuse
+  - add ubuntu "jammy" 22.04 LTS VM
+  - adapt memory for openindiana64 and darwin64
+
+
+Version 1.1.17 (2021-07-12)
+---------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
+  If WSL still has a problem with sync_file_range, you need to set
+  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
+  work around the WSL issue.
+- 1.1.14 changes return codes due to a bug fix:
+  In case you have scripts expecting rc == 2 for a signal exit, you need to
+  update them to check for >= 128 (as documented since long).
+- 1.1.15 drops python 3.4 support, minimum requirement is 3.5 now.
+- 1.1.17 install_requires the "packaging" pypi package now.
+
+Fixes:
+
+- pyinstaller dir-mode: fix pyi detection / LIBPATH treatment, #5897
+- handle crash due to kill stale lock race, #5828
+- fix BORG_CACHE_DIR crashing borg if empty, #5216
+- create --dry-run: fix display of kept tagfile, #5834
+- fix missing parameter in "did not consistently fail" msg, #5822
+- missing / healed chunks: always tell chunk ID, #5704
+- benchmark: make sure cleanup happens even on exceptions, #5630
+
+New features:
+
+- implement BORG_SELFTEST env variable, #5871.
+  this can be used to accelerate borg startup a bit. not recommended for
+  normal usage, but borg mass hosters with a lot of borg invocations can
+  save some resources with this. on my laptop, this saved ~100ms cpu time
+  (sys+user) per borg command invocation.
+- implement BORG_LIBC env variable to give the libc filename, #5870.
+  you can use this if a borg does not find your libc.
+- check: add progress indicator for archive check.
+- allow --files-cache=size (not recommended, make sure you know what you do)
+
+Other changes:
+
+- Python 3.10 now officially supported!
+  we test on py310-dev on github CI since a while and now also on the vagrant
+  machines, so it should work ok.
+- github CI: test on py310 (again)
+- get rid of distutils, use packaging and setuptools.
+  distutils is deprecated and gives warnings on py 3.10.
+- setup.py: rename "clean" to "clean2" to avoid shadowing the "clean" command.
+- remove libc filename fallback for the BSDs (there is no "usual" name)
+- cleanup flake8 checks, fix some pep8 violations.
+- docs building: replace deprecated function ".add_stylesheet()" for Sphinx 4 compatibility
+- docs:
+
+  - add a hint on sleeping computer and ssh connections, #5301
+  - update the documentation on hacked backup client, #5480
+  - improve docs/FAQ about append-only remote repos, #5497
+  - complement the documentation for pattern files and exclude files, #5520
+  - "filename with spaces" example added to exclude file, #5236
+    note: no whitespace escaping needed, processed by borg.
+  - add info on renaming repositories, #5240
+  - clarify borg check --verify-data, #5808
+  - add notice about defective hardware to check documentation, #5753
+  - add paragraph added in #5855 to utility documentation source
+  - add missing leading slashes in help patterns, #5857
+  - clarify "you will need key and passphrase" borg init warning, #4622
+  - pull mode: add some warnings, #5827
+  - mention tar --compare (compare archive to fs files), #5880
+  - fix typos, backport of #5597
+- vagrant:
+
+  - add py3.7.11 for binary build, also add 3.10-dev.
+  - use latest Cython 0.29.23 for py310 compat fixes.
+  - more RAM for openindiana upgrade plan resolver, it just hangs (swaps?) if
+    there is too little RAM.
+  - fix install_pyenv to adapt to recent changes in pyenv (same as in master now).
+  - use generic/netbsd9 box, copied from master branch.
+
+
+Version 1.1.16 (2021-03-23)
+---------------------------
+
+Fixes:
+
+- setup.py: add special openssl prefix for Apple M1 compatibility
+- do not recurse into duplicate roots, #5603
+- remove empty shadowed_segments lists, #5275, #5614
+- fix libpython load error when borg fat binary / dir-based binary is invoked
+  via a symlink by upgrading pyinstaller to v4.2, #5688
+- config: accept non-int value (like 500M or 100G) for max_segment_size or
+  storage_quota, #5639.
+  please note: when setting a non-int value for this in a repo config,
+  using the repo will require borg >= 1.1.16.
+
+New features:
+
+- bundled msgpack: drop support for old buffer protocol to support Python 3.10
+- verbose files cache logging via --debug-topic=files_cache, #5659.
+  Use this if you suspect that borg does not detect unmodified files as expected.
+- create/extract: add --noxattrs and --noacls option, #3955.
+  when given with borg create, borg will not get xattrs / ACLs from input files
+  (and thus, it will not archive xattrs / ACLs). when given with borg extract,
+  borg will not read xattrs / ACLs from archive and will not set xattrs / ACLs
+  on extracted files.
+- diff: add --json-lines option, #3765
+- check: debug log segment filename
+- borg debug dump-hints
+
+Other changes:
+
+- Tab completion support for additional archives for 'borg delete'
+- repository: deduplicate code of put and delete, no functional change
+- tests: fix result order issue (sporadic test failure on openindiana)
+- vagrant:
+
+  - upgrade pyinstaller to v4.2, #5671
+  - avoid grub-install asking interactively for device
+  - remove the xenial box
+  - update freebsd box to 12.1
+- docs:
+
+  - update macOS install instructions, #5677
+  - use macFUSE (not osxfuse) for Apple M1 compatibility
+  - update docs for dev environment installation instructions, #5643
+  - fix grammar in faq
+  - recommend running tests only on installed versions for setup
+  - add link back to git-installation
+  - remove /var/cache exclusion in example commands, #5625.
+    This is generally a poor idea and shouldn't be promoted through examples.
+  - add repology.org badge with current packaging status
+  - explain hash collision
+  - add unsafe workaround to use an old repo copy, #5722
+
+
+Version 1.1.15 (2020-12-25)
+---------------------------
+
+Fixes:
+
+- extract:
+
+  - improve exception handling when setting xattrs, #5092.
+  - emit a warning message giving the path, xattr key and error message.
+  - continue trying to restore other xattrs and bsdflags of the same file
+    after an exception with xattr-setting happened.
+- export-tar:
+
+  - set tar format to GNU_FORMAT explicitly, #5274
+  - fix memory leak with ssh: remote repository, #5568
+  - fix potential memory leak with ssh: remote repository with partial extraction
+- create: fix --dry-run and --stats coexistence, #5415
+- use --timestamp for {utcnow} and {now} if given, #5189
+
+New features:
+
+- create: implement --stdin-mode, --stdin-user and --stdin-group, #5333
+- allow appending the files cache filename with BORG_FILES_CACHE_SUFFIX env var
+
+Other changes:
+
+- drop python 3.4 support, minimum requirement is 3.5 now.
+- enable using libxxhash instead of bundled xxh64 code
+- update llfuse requirements (1.3.8)
+- set cython language_level in some files to fix warnings
+- allow EIO with warning when trying to hardlink
+- PropDict: fail early if internal_dict is not a dict
+- update shell completions
+- tests / CI
+
+  - add a test for the hashindex corruption bug, #5531 #4829
+  - fix spurious failure in test_cache_files, #5438
+  - added a github ci workflow
+  - reduce testing on travis, no macOS, no py3x-dev, #5467
+  - travis: use newer dists, native py on dist
+- vagrant:
+
+  - remove jessie and trusty boxes, #5348 #5383
+  - pyinstaller 4.0, build on py379
+  - binary build on stretch64, #5348
+  - remove easy_install based pip installation
+- docs:
+
+  - clarify '--one-file-system' for btrfs, #5391
+  - add example for excluding content using the --pattern cmd line arg
+  - complement the documentation for pattern files and exclude files, #5524
+  - made ansible playbook more generic, use package instead of pacman. also
+    change state from "latest" to "present".
+  - complete documentation on append-only remote repos, #5497
+  - internals: rather talk about target size than statistics, #5336
+  - new compression algorithm policy, #1633 #5505
+  - faq: add a hint on sleeping computer, #5301
+  - note requirements for full disk access on macOS Catalina, #5303
+  - fix/improve description of borg upgrade hardlink usage, #5518
+- modernize 1.1 code:
+
+  - drop code/workarounds only needed to support Python 3.4
+  - remove workaround for pre-release py37 argparse bug
+  - removed some outdated comments/docstrings
+  - requirements: remove some restrictions, lock on current versions
+
+
+Version 1.1.14 (2020-10-07)
+---------------------------
+
+Fixes:
+
+- check --repair: fix potential data loss when interrupting it, #5325
+- exit with 128 + signal number (as documented) when borg is killed by a signal, #5161
+- fix hardlinked CACHEDIR.TAG processing, #4911
+- create --read-special: .part files also should be regular files, #5217
+- llfuse dependency: choose least broken 1.3.6/1.3.7.
+  1.3.6 is broken on python 3.9, 1.3.7 is broken on FreeBSD.
+
+Other changes:
+
+- upgrade bundled xxhash to 0.7.4
+- self test: if it fails, also point to OS and hardware, #5334
+- pyinstaller: compute basepath from spec file location
+- prettier error message when archive gets too big, #5307
+- check/recreate are not "experimental" any more (but still potentially dangerous):
+
+  - recreate: remove extra confirmation
+  - rephrase some warnings, update docs, #5164
+- shell completions:
+
+  - misc. updates / fixes
+  - support repositories in fish tab completion, #5256
+  - complete $BORG_RECREATE_I_KNOW_WHAT_I_AM_DOING
+  - rewrite zsh completion:
+
+    - completion for almost all optional and positional arguments
+    - completion for Borg environment variables (parameters)
+- use "allow/deny list" instead of "white/black list" wording
+- declare "allow_cache_wipe" marker in setup.cfg to avoid pytest warning
+- vagrant / tests:
+
+  - misc. fixes / updates
+  - use python 3.5.10 for binary build
+  - build directory-based binaries additionally to the single file binaries
+  - add libffi-dev, required to build python
+  - use cryptography<3.0, more recent versions break the jessie box
+  - test on python 3.9
+  - do brew update with /dev/null redirect to avoid "too much log output" on travis-ci
+- docs:
+
+  - add ssh-agent pull backup method docs, #5288
+  - how to approach borg speed issues, #5371
+  - mention double --force in prune docs
+  - update Homebrew install instructions, #5185
+  - better description of how cache and rebuilds of it work
+  - point to borg create --list item flags in recreate usage, #5165
+  - add security faq explaining AES-CTR crypto issues, #5254
+  - add a note to create from stdin regarding files cache, #5180
+  - fix borg.1 manpage generation regression, #5211
+  - clarify how exclude options work in recreate, #5193
+  - add section for retired contributors
+  - hint about not misusing private email addresses of contributors for borg support
+
+
+Version 1.1.13 (2020-06-06)
+---------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
+  If WSL still has a problem with sync_file_range, you need to set
+  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
+  work around the WSL issue.
+
+Fixes:
+
+- rebuilt using a current Cython version, compatible with python 3.8, #5214
+
+
+Version 1.1.12 (2020-06-06)
+---------------------------
+
+Fixes:
+
+- fix preload-related memory leak, #5202.
+- mount / borgfs (FUSE filesystem):
+
+  - fix FUSE low linear read speed on large files, #5067
+  - fix crash on old llfuse without birthtime attrs, #5064 - accidentally
+    we required llfuse >= 1.3. Now also old llfuse works again.
+  - set f_namemax in statfs result, #2684
+- update precedence of env vars to set config and cache paths, #4894
+- correctly calculate compression ratio, taking header size into account, too
+
+New features:
+
+- --bypass-lock option to bypass locking with read-only repositories
+
+Other changes:
+
+- upgrade bundled zstd to 1.4.5
+- travis: adding comments and explanations to Travis config / install script,
+  improve macOS builds.
+- tests: test_delete_force: avoid sporadic test setup issues, #5196
+- misc. vagrant fixes
+- the binary for macOS is now built on macOS 10.12
+- the binaries for Linux are now built on Debian 8 "Jessie", #3761
+- docs:
+
+  - PlaceholderError not printed as JSON, #4073
+  - "How important is Borg config?", #4941
+  - make Sphinx warnings break docs build, #4587
+  - some markup / warning fixes
+  - add "updating borgbackup.org/releases" to release checklist, #4999
+  - add "rendering docs" to release checklist, #5000
+  - clarify borg init's encryption modes
+  - add note about patterns and stored paths, #4160
+  - add upgrade of tools to pip installation how-to
+  - document one cause of orphaned chunks in check command, #2295
+  - linked recommended restrictions to ssh public keys on borg servers in faq, #4946
+
+
+Version 1.1.11 (2020-03-08)
+---------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+- 1.1.11 removes WSL autodetection (Windows 10 Subsystem for Linux).
+  If WSL still has a problem with sync_file_range, you need to set
+  BORG_WORKAROUNDS=basesyncfile in the borg process environment to
+  work around the WSL issue.
+
+Fixes:
+
+- fixed potential index corruption / data loss issue due to bug in hashindex_set, #4829.
+  Please read and follow the more detailed notes close to the top of this document.
+- upgrade bundled xxhash to 0.7.3, #4891.
+  0.7.2 is the minimum requirement for correct operations on ARMv6 in non-fixup
+  mode, where unaligned memory accesses cause bus errors.
+  0.7.3 adds some speedups and libxxhash 0.7.3 even has a pkg-config file now.
+- upgrade bundled lz4 to 1.9.2
+- upgrade bundled zstd to 1.4.4
+- fix crash when upgrading erroneous hints file, #4922
+- extract:
+
+  - fix KeyError for "partial" extraction, #4607
+  - fix "partial" extract for hardlinked contentless file types, #4725
+  - fix preloading for old (0.xx) remote servers, #4652
+  - fix confusing output of borg extract --list --strip-components, #4934
+- delete: after double-force delete, warn about necessary repair, #4704
+- create: give invalid repo error msg if repo config not found, #4411
+- mount: fix FUSE mount missing st_birthtime, #4763 #4767
+- check: do not stumble over invalid item key, #4845
+- info: if the archive doesn't exist, print a pretty message, #4793
+- SecurityManager.known(): check all files, #4614
+- Repository.open: use stat() to check for repo dir, #4695
+- Repository.check_can_create_repository: use stat() to check, #4695
+- fix invalid archive error message
+- fix optional/non-optional location arg, #4541
+- commit-time free space calc: ignore bad compact map entries, #4796
+- ignore EACCES (errno 13) when hardlinking the old config, #4730
+- --prefix / -P: fix processing, avoid argparse issue, #4769
+
+New features:
+
+- enable placeholder usage in all extra archive arguments
+- new BORG_WORKAROUNDS mechanism, basesyncfile, #4710
+- recreate: support --timestamp option, #4745
+- support platforms without os.link (e.g. Android with Termux), #4901.
+  if we don't have os.link, we just extract another copy instead of making a hardlink.
+- support linux platforms without sync_file_range (e.g. Android 7 with Termux), #4905
+
+Other:
+
+- ignore --stats when given with --dry-run, but continue, #4373
+- add some ProgressIndicator msgids to code / fix docs, #4935
+- elaborate on "Calculating size" message
+- argparser: always use REPOSITORY in metavar, also use more consistent help phrasing.
+- check: improve error output for matching index size, see #4829
+- docs:
+
+  - changelog: add advisory about hashindex_set bug #4829
+  - better describe BORG_SECURITY_DIR, BORG_CACHE_DIR, #4919
+  - infos about cache security assumptions, #4900
+  - add FAQ describing difference between a local repo vs. repo on a server.
+  - document how to test exclusion patterns without performing an actual backup
+  - timestamps in the files cache are now usually ctime, #4583
+  - fix bad reference to borg compact (does not exist in 1.1), #4660
+  - create: borg 1.1 is not future any more
+  - extract: document limitation "needs empty destination", #4598
+  - how to supply a passphrase, use crypto devices, #4549
+  - fix osxfuse github link in installation docs
+  - add example of exclude-norecurse rule in help patterns
+  - update macOS Brew link
+  - add note about software for automating backups, #4581
+  - AUTHORS: mention copyright+license for bundled msgpack
+  - fix various code blocks in the docs, #4708
+  - updated docs to cover use of temp directory on remote, #4545
+  - add restore docs, #4670
+  - add a pull backup / push restore how-to, #1552
+  - add FAQ how to retain original paths, #4532
+  - explain difference between --exclude and --pattern, #4118
+  - add FAQs for SSH connection issues, #3866
+  - improve password FAQ, #4591
+  - reiterate that 'file cache names are absolute' in FAQ
+- tests:
+
+  - cope with ANY error when importing pytest into borg.testsuite, #4652
+  - fix broken test that relied on improper zlib assumptions
+  - test_fuse: filter out selinux xattrs, #4574
+- travis / vagrant:
+
+  - misc python versions removed / changed (due to openssl 1.1 compatibility)
+    or added (3.7 and 3.8, for better borg compatibility testing)
+  - binary building is on python 3.5.9 now
+- vagrant:
+
+  - add new boxes: ubuntu 18.04 and 20.04, debian 10
+  - update boxes: openindiana, darwin, netbsd
+  - remove old boxes: centos 6
+  - darwin: updated osxfuse to 3.10.4
+  - use debian/ubuntu pip/virtualenv packages
+  - rather use python 3.6.2 than 3.6.0, fixes coverage/sqlite3 issue
+  - use requirements.d/development.lock.txt to avoid compat issues
+- travis:
+
+  - darwin: backport some install code / order from master
+  - remove deprecated keyword "sudo" from travis config
+  - allow osx builds to fail, #4955
+    this is due to travis-ci frequently being so slow that the OS X builds
+    just fail because they exceed 50 minutes and get killed by travis.
+
+
+Version 1.1.10 (2019-05-16)
+---------------------------
+
+Fixes:
+
+- extract: hang on partial extraction with ssh: repo, when hardlink master
+  is not matched/extracted and borg hangs on related slave hardlink, #4350
+- lrucache: regularly remove old FDs, #4427
+- avoid stale filehandle issues, #3265
+- freebsd: make xattr platform code api compatible with linux, #3952
+- use whitelist approach for borg serve, #4097
+- borg command shall terminate with rc 2 for ImportErrors, #4424
+- create: only run stat_simple_attrs() once, this increases
+  backup with lots of unchanged files performance by ~ 5%.
+- prune: fix incorrect borg prune --stats output with --dry-run, #4373
+- key export: emit user-friendly error if repo key is exported to a directory,
+  #4348
+
+New features:
+
+- bundle latest supported msgpack-python release (0.5.6), remove msgpack-python
+  from setup.py install_requires - by default we use the bundled code now.
+  optionally, we still support using an external msgpack (see hints in
+  setup.py), but this requires solid requirements management within
+  distributions and is not recommended.
+  borgbackup will break if you upgrade msgpack to an unsupported version.
+- display msgpack version as part of sysinfo (e.g. in tracebacks)
+- timestamp for borg delete --info added, #4359
+- enable placeholder usage in --comment and --glob-archives, #4559, #4495
+
+Other:
+
+- serve: do not check python/libc for borg serve, #4483
+- shell completions: borg diff second archive
+- release scripts: signing binaries with Qubes OS support
+- testing:
+
+  - vagrant: upgrade openbsd box to 6.4
+  - travis-ci: lock test env to py 3.4 compatible versions, #4343
+  - get rid of confusing coverage warning, #2069
+  - rename test_mount_hardlinks to test_fuse_mount_hardlinks,
+    so both can be excluded by "not test_fuse".
+  - pure-py msgpack warning shall not make a lot of tests fail, #4558
+- docs:
+
+  - add "SSH Configuration" section to "borg serve", #3988, #636, #4485
+  - README: new URL for funding options
+  - add a sample logging.conf in docs/misc, #4380
+  - elaborate on append-only mode docs, #3504
+  - installation: added Alpine Linux to distribution list, #4415
+  - usage.html: only modify window.location when redirecting, #4133
+  - add msgpack license to docs/3rd_party/msgpack
+- vagrant / binary builds:
+
+  - use python 3.5.7 for builds
+  - use osxfuse 3.8.3
+
+
+Version 1.1.9 (2019-02-10)
+--------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+
+Fixes:
+
+- security fix: configure FUSE with "default_permissions", #3903
+  "default_permissions" is now enforced by borg by default to let the
+  kernel check uid/gid/mode based permissions.
+  "ignore_permissions" can be given to not enforce "default_permissions".
+- make "hostname" short, even on misconfigured systems, #4262
+- fix free space calculation on macOS (and others?), #4289
+- config: quit with error message when no key is provided, #4223
+- recover_segment: handle too small segment files correctly, #4272
+- correctly release memoryview, #4243
+- avoid diaper pattern in configparser by opening files, #4263
+- add "# cython: language_level=3" directive to .pyx files, #4214
+- info: consider part files for "This archive" stats, #3522
+- work around Microsoft WSL issue #645 (sync_file_range), #1961
+
+New features:
+
+- add --rsh command line option to complement BORG_RSH env var, #1701
+- init: --make-parent-dirs parent1/parent2/repo_dir, #4235
+
+Other:
+
+- add archive name to check --repair output, #3447
+- check for unsupported msgpack versions
+- shell completions:
+
+  - new shell completions for borg 1.1.9
+  - more complete shell completions for borg mount -o
+  - added shell completions for borg help
+  - option arguments for zsh tab completion
+- docs:
+
+  - add FAQ regarding free disk space check, #3905
+  - update BORG_PASSCOMMAND example and clarify variable expansion, #4249
+  - FAQ regarding change of compression settings, #4222
+  - add note about BSD flags to changelog, #4246
+  - improve logging in example automation script
+  - add note about files changing during backup, #4081
+  - work around the backslash issue, #4280
+  - update release workflow using twine (docs, scripts), #4213
+  - add warnings on repository copies to avoid future problems, #4272
+- tests:
+
+  - fix the homebrew 1.9 issues on travis-ci, #4254
+  - fix duplicate test method name, #4311
+
+
+Version 1.1.8 (2018-12-09)
+--------------------------
+
+Fixes:
+
+- enforce storage quota if set by serve-command, #4093
+- invalid locations: give err msg containing parsed location, #4179
+- list repo: add placeholders for hostname and username, #4130
+- on linux, symlinks can't have ACLs, so don't try to set any, #4044
+
+New features:
+
+- create: added PATH::archive output on INFO log level
+- read a passphrase from a file descriptor specified in the
+  BORG_PASSPHRASE_FD environment variable.
+
+Other:
+
+- docs:
+
+  - option --format is required for some expensive-to-compute values for json
+
+    borg list by default does not compute expensive values except when
+    they are needed. whether they are needed is determined by the format,
+    in standard mode as well as in --json mode.
+  - tell that our binaries are x86/x64 amd/intel, bauerj has ARM
+  - fixed wrong archive name pattern in CRUD benchmark help
+  - fixed link to cachedir spec in docs, #4140
+- tests:
+
+  - stop using fakeroot on travis, avoids sporadic EISDIR errors, #2482
+  - xattr key names must start with "user." on linux
+  - fix code so flake8 3.6 does not complain
+  - explicitly convert environment variable to str, #4136
+  - fix DeprecationWarning: Flags not at the start of the expression, #4137
+  - support pytest4, #4172
+- vagrant:
+
+  - use python 3.5.6 for builds
+
+
+Version 1.1.7 (2018-08-11)
+--------------------------
+
+Compatibility notes:
+
+- added support for Python 3.7
+
+Fixes:
+
+- cache lock: use lock_wait everywhere to fix infinite wait, see #3968
+- don't archive tagged dir when recursing an excluded dir, #3991
+- py37 argparse: work around bad default in py 3.7.0a/b/rc, #3996
+- py37 remove loggerDict.clear() from tearDown method, #3805
+- some fixes for bugs which likely did not result in problems in practice:
+
+  - fixed logic bug in platform module API version check
+  - fixed xattr/acl function prototypes, added missing ones
+
+New features:
+
+- init: add warning to store both key and passphrase at safe place(s)
+- BORG_HOST_ID env var to work around all-zero MAC address issue, #3985
+- borg debug dump-repo-objs --ghost (dump everything from segment files,
+  including deleted or superseded objects or commit tags)
+- borg debug search-repo-objs (search in repo objects for hex bytes or strings)
+
+Other changes:
+
+- add Python 3.7 support
+- updated shell completions
+- call socket.gethostname only once
+- locking: better logging, add some asserts
+- borg debug dump-repo-objs:
+
+  - filename layout improvements
+  - use repository.scan() to get on-disk order
+- docs:
+
+  - update installation instructions for macOS
+  - added instructions to install fuse via homebrew
+  - improve diff docs
+  - added note that checkpoints inside files requires 1.1+
+  - add link to tempfile module
+  - remove row/column-spanning from docs source, #4000 #3990
+- tests:
+
+  - fetch less data via os.urandom
+  - add py37 env for tox
+  - travis: add 3.7, remove 3.6-dev (we test with -dev in master)
+- vagrant / binary builds:
+
+  - use osxfuse 3.8.2
+  - use own (uptodate) openindiana box
+
+
+Version 1.1.6 (2018-06-11)
+--------------------------
+
+Compatibility notes:
+
+- 1.1.6 changes:
+
+  - also allow msgpack-python 0.5.6.
+
+Fixes:
+
+- fix borg exception handling on ENOSPC error with xattrs, #3808
+- prune: fix/improve overall progress display
+- borg config repo ... does not need cache/manifest/key, #3802
+- debug dump-repo-objs should not depend on a manifest obj
+- pypi package:
+
+  - include .coveragerc, needed by tox.ini
+  - fix package long description, #3854
+
+New features:
+
+- mount: add uid, gid, umask mount options
+- delete:
+
+  - only commit once, #3823
+  - implement --dry-run, #3822
+- check:
+
+  - show progress while rebuilding missing manifest, #3787
+  - more --repair output
+- borg config --list <repo>, #3612
+
+Other changes:
+
+- update msgpack requirement, #3753
+- update bundled zstd to 1.3.4, #3745
+- update bundled lz4 code to 1.8.2, #3870
+- docs:
+
+  - describe what BORG_LIBZSTD_PREFIX does
+  - fix and deduplicate encryption quickstart docs, #3776
+- vagrant:
+
+  - FUSE for macOS: upgrade 3.7.1 to 3.8.0
+  - exclude macOS High Sierra upgrade on the darwin64 machine
+  - remove borgbackup.egg-info dir in fs_init (after rsync)
+  - use pyenv-based build/test on jessie32/62
+  - use local 32 and 64bit debian jessie boxes
+  - use "vagrant" as username for new xenial box
+- travis OS X: use xcode 8.3 (not broken)
+
+
+Version 1.1.5 (2018-04-01)
+--------------------------
+
+Compatibility notes:
+
+- 1.1.5 changes:
+
+  - require msgpack-python >= 0.4.6 and < 0.5.0.
+    0.5.0+ dropped python 3.4 testing and also caused some other issues because
+    the python package was renamed to msgpack and emitted some FutureWarning.
+
+Fixes:
+
+- create --list: fix that it was never showing M status, #3492
+- create: fix timing for first checkpoint (read files cache early, init
+  checkpoint timer after that), see #3394
+- extract: set rc=1 when extracting damaged files with all-zero replacement
+  chunks or with size inconsistencies, #3448
+- diff: consider an empty file as different to a non-existing file, #3688
+- files cache: improve exception handling, #3553
+- ignore exceptions in scandir_inorder() caused by an implicit stat(),
+  also remove unneeded sort, #3545
+- fixed tab completion problem where a space is always added after path even
+  when it shouldn't
+- build: do .h file content checks in binary mode, fixes build issue for
+  non-ascii header files on pure-ascii locale platforms, #3544 #3639
+- borgfs: fix patterns/paths processing, #3551
+- config: add some validation, #3566
+- repository config: add validation for max_segment_size, #3592
+- set cache previous_location on load instead of save
+- remove platform.uname() call which caused library mismatch issues, #3732
+- add exception handler around deprecated platform.linux_distribution() call
+- use same datetime object for {now} and {utcnow}, #3548
+
+New features:
+
+- create: implement --stdin-name, #3533
+- add chunker_params to borg archive info (--json)
+- BORG_SHOW_SYSINFO=no to hide system information from exceptions
+
+Other changes:
+
+- updated zsh completions for borg 1.1.4
+- files cache related code cleanups
+- be more helpful when parsing invalid --pattern values, #3575
+- be more clear in secure-erase warning message, #3591
+- improve getpass user experience, #3689
+- docs build: unicode problem fixed when using a py27-based sphinx
+- docs:
+
+  - security: explicitly note what happens OUTSIDE the attack model
+  - security: add note about combining compression and encryption
+  - security: describe chunk size / proximity issue, #3687
+  - quickstart: add note about permissions, borg@localhost, #3452
+  - quickstart: add introduction to repositories & archives, #3620
+  - recreate --recompress: add missing metavar, clarify description, #3617
+  - improve logging docs, #3549
+  - add an example for --pattern usage, #3661
+  - clarify path semantics when matching, #3598
+  - link to offline documentation from README, #3502
+  - add docs on how to verify a signed release with GPG, #3634
+  - chunk seed is generated per repository (not: archive)
+  - better formatting of CPU usage documentation, #3554
+  - extend append-only repo rollback docs, #3579
+- tests:
+
+  - fix erroneously skipped zstd compressor tests, #3606
+  - skip a test if argparse is broken, #3705
+- vagrant:
+
+  - xenial64 box now uses username 'vagrant', #3707
+  - move cleanup steps to fs_init, #3706
+  - the boxcutter wheezy boxes are 404, use local ones
+  - update to Python 3.5.5 (for binary builds)
+
+
+Version 1.1.4 (2017-12-31)
+--------------------------
+
+Compatibility notes:
+
+- When upgrading from borg 1.0.x to 1.1.x, please note:
+
+  - read all the compatibility notes for 1.1.0*, starting from 1.1.0b1.
+  - borg upgrade: you do not need to and you also should not run it.
+  - borg might ask some security-related questions once after upgrading.
+    You can answer them either manually or via environment variable.
+    One known case is if you use unencrypted repositories, then it will ask
+    about a unknown unencrypted repository one time.
+  - your first backup with 1.1.x might be significantly slower (it might
+    completely read, chunk, hash a lot files) - this is due to the
+    --files-cache mode change (and happens every time you change mode).
+    You can avoid the one-time slowdown by using the pre-1.1.0rc4-compatible
+    mode (but that is less safe for detecting changed files than the default).
+    See the --files-cache docs for details.
+- borg 1.1.4 changes:
+
+  - zstd compression is new in borg 1.1.4, older borg can't handle it.
+  - new minimum requirements for the compression libraries - if the required
+    versions (header and lib) can't be found at build time, bundled code will
+    be used:
+
+    - added requirement: libzstd >= 1.3.0 (bundled: 1.3.2)
+    - updated requirement: liblz4 >= 1.7.0 / r129 (bundled: 1.8.0)
+
+Fixes:
+
+- check: data corruption fix: fix for borg check --repair malfunction, #3444.
+  See the more detailed notes close to the top of this document.
+- delete: also delete security dir when deleting a repo, #3427
+- prune: fix building the "borg prune" man page, #3398
+- init: use given --storage-quota for local repo, #3470
+- init: properly quote repo path in output
+- fix startup delay with dns-only own fqdn resolving, #3471
+
+New features:
+
+- added zstd compression. try it!
+- added placeholder {reverse-fqdn} for fqdn in reverse notation
+- added BORG_BASE_DIR environment variable, #3338
+
+Other changes:
+
+- list help topics when invalid topic is requested
+- fix lz4 deprecation warning, requires lz4 >= 1.7.0 (r129)
+- add parens for C preprocessor macro argument usages (did not cause malfunction)
+- exclude broken pytest 3.3.0 release
+- updated fish/bash completions
+- init: more clear exception messages for borg create, #3465
+- docs:
+
+  - add auto-generated docs for borg config
+  - don't generate HTML docs page for borgfs, #3404
+  - docs update for lz4 b2 zstd changes
+  - add zstd to compression help, readme, docs
+  - update requirements and install docs about bundled lz4 and zstd
+- refactored build of the compress and crypto.low_level extensions, #3415:
+
+  - move some lib/build related code to setup_{zstd,lz4,b2}.py
+  - bundle lz4 1.8.0 (requirement: >= 1.7.0 / r129)
+  - bundle zstd 1.3.2 (requirement: >= 1.3.0)
+  - blake2 was already bundled
+  - rename BORG_LZ4_PREFIX env var to BORG_LIBLZ4_PREFIX for better consistency:
+    we also have BORG_LIBB2_PREFIX and BORG_LIBZSTD_PREFIX now.
+  - add prefer_system_lib* = True settings to setup.py - by default the build
+    will prefer a shared library over the bundled code, if library and headers
+    can be found and meet the minimum requirements.
+
+
+Version 1.1.3 (2017-11-27)
+--------------------------
+
+Fixes:
+
+- Security Fix for CVE-2017-15914: Incorrect implementation of access controls
+  allows remote users to override repository restrictions in Borg servers.
+  A user able to access a remote Borg SSH server is able to circumvent access
+  controls post-authentication.
+  Affected releases: 1.1.0, 1.1.1, 1.1.2. Releases 1.0.x are NOT affected.
+- crc32: deal with unaligned buffer, add tests - this broke borg on older ARM
+  CPUs that can not deal with unaligned 32bit memory accesses and raise a bus
+  error in such cases. the fix might also improve performance on some CPUs as
+  all 32bit memory accesses by the crc32 code are properly aligned now. #3317
+- mount: fixed support of --consider-part-files and do not show .borg_part_N
+  files by default in the mounted FUSE filesystem. #3347
+- fixed cache/repo timestamp inconsistency message, highlight that information
+  is obtained from security dir (deleting the cache will not bypass this error
+  in case the user knows this is a legitimate repo).
+- borgfs: don't show sub-command in borgfs help, #3287
+- create: show an error when --dry-run and --stats are used together, #3298
+
+New features:
+
+- mount: added exclusion group options and paths, #2138
+
+  Reused some code to support similar options/paths as borg extract offers -
+  making good use of these to only mount a smaller subset of dirs/files can
+  speed up mounting a lot and also will consume way less memory.
+
+  borg mount [options] repo_or_archive mountpoint path [paths...]
+
+  paths: you can just give some "root paths" (like for borg extract) to
+  only partially populate the FUSE filesystem.
+
+  new options: --exclude[-from], --pattern[s-from], --strip-components
+- create/extract: support st_birthtime on platforms supporting it, #3272
+- add "borg config" command for querying/setting/deleting config values, #3304
+
+Other changes:
+
+- clean up and simplify packaging (only package committed files, do not install
+  .c/.h/.pyx files)
+- docs:
+
+  - point out tuning options for borg create, #3239
+  - add instructions for using ntfsclone, zerofree, #81
+  - move image backup-related FAQ entries to a new page
+  - clarify key aliases for borg list --format, #3111
+  - mention break-lock in checkpointing FAQ entry, #3328
+  - document sshfs rename workaround, #3315
+  - add FAQ about removing files from existing archives
+  - add FAQ about different prune policies
+  - usage and man page for borgfs, #3216
+  - clarify create --stats duration vs. wall time, #3301
+  - clarify encrypted key format for borg key export, #3296
+  - update release checklist about security fixes
+  - document good and problematic option placements, fix examples, #3356
+  - add note about using --nobsdflags to avoid speed penalty related to
+    bsdflags, #3239
+  - move most of support section to www.borgbackup.org
+
+
+Version 1.1.2 (2017-11-05)
+--------------------------
+
+Fixes:
+
+- fix KeyError crash when talking to borg server < 1.0.7, #3244
+- extract: set bsdflags last (include immutable flag), #3263
+- create: don't do stat() call on excluded-norecurse directory, fix exception
+  handling for stat() call, #3209
+- create --stats: do not count data volume twice when checkpointing, #3224
+- recreate: move chunks_healthy when excluding hardlink master, #3228
+- recreate: get rid of chunks_healthy when rechunking (does not match), #3218
+- check: get rid of already existing not matching chunks_healthy metadata, #3218
+- list: fix stdout broken pipe handling, #3245
+- list/diff: remove tag-file options (not used), #3226
+
+New features:
+
+- bash, zsh and fish shell auto-completions, see scripts/shell_completions/
+- added BORG_CONFIG_DIR env var, #3083
+
+Other changes:
+
+- docs:
+
+  - clarify using a blank passphrase in keyfile mode
+  - mention "!" (exclude-norecurse) type in "patterns" help
+  - document to first heal before running borg recreate to re-chunk stuff,
+    because that will have to get rid of chunks_healthy metadata.
+  - more than 23 is not supported for CHUNK_MAX_EXP, #3115
+  - borg does not respect nodump flag by default any more
+  - clarify same-filesystem requirement for borg upgrade, #2083
+  - update / rephrase cygwin / WSL status, #3174
+  - improve docs about --stats, #3260
+- vagrant: openindiana new clang package
+
+Already contained in 1.1.1 (last minute fix):
+
+- arg parsing: fix fallback function, refactor, #3205. This is a fixup
+  for #3155, which was broken on at least python <= 3.4.2.
+
+
+Version 1.1.1 (2017-10-22)
+--------------------------
+
+Compatibility notes:
+
+- The deprecated --no-files-cache is not a global/common option any more,
+  but only available for borg create (it is not needed for anything else).
+  Use --files-cache=disabled instead of --no-files-cache.
+- The nodump flag ("do not backup this file") is not honoured any more by
+  default because this functionality (esp. if it happened by error or
+  unexpected) was rather confusing and unexplainable at first to users.
+  If you want that "do not backup NODUMP-flagged files" behaviour, use:
+  borg create --exclude-nodump ...
+- If you are on Linux and do not need bsdflags archived, consider using
+  ``--nobsdflags`` with ``borg create`` to avoid additional syscalls and
+  speed up backup creation.
+
+Fixes:
+
+- borg recreate: correctly compute part file sizes. fixes cosmetic, but
+  annoying issue as borg check complains about size inconsistencies of part
+  files in affected archives. you can solve that by running borg recreate on
+  these archives, see also #3157.
+- bsdflags support: do not open BLK/CHR/LNK files, avoid crashes and
+  slowness, #3130
+- recreate: don't crash on attic archives w/o time_end, #3109
+- don't crash on repository filesystems w/o hardlink support, #3107
+- don't crash in first part of truncate_and_unlink, #3117
+- fix server-side IndexError crash with clients < 1.0.7, #3192
+- don't show traceback if only a global option is given, show help, #3142
+- cache: use SaveFile for more safety, #3158
+- init: fix wrong encryption choices in command line parser, fix missing
+  "authenticated-blake2", #3103
+- move --no-files-cache from common to borg create options, #3146
+- fix detection of non-local path (failed on ..filename), #3108
+- logging with fileConfig: set json attr on "borg" logger, #3114
+- fix crash with relative BORG_KEY_FILE, #3197
+- show excluded dir with "x" for tagged dirs / caches, #3189
+
+New features:
+
+- create: --nobsdflags and --exclude-nodump options, #3160
+- extract: --nobsdflags option, #3160
+
+Other changes:
+
+- remove annoying hardlinked symlinks warning, #3175
+- vagrant: use self-made FreeBSD 10.3 box, #3022
+- travis: don't brew update, hopefully fixes #2532
+- docs:
+
+  - readme: -e option is required in borg 1.1
+  - add example showing --show-version --show-rc
+  - use --format rather than --list-format (deprecated) in example
+  - update docs about hardlinked symlinks limitation
+
+
+Version 1.1.0 (2017-10-07)
+--------------------------
+
+Compatibility notes:
+
+- borg command line: do not put options in between positional arguments
+
+  This sometimes works (e.g. it worked in borg 1.0.x), but can easily stop
+  working if we make positional arguments optional (like it happened for
+  borg create's "paths" argument in 1.1). There are also places in borg 1.0
+  where we do that, so it doesn't work there in general either. #3356
+
+  Good: borg create -v --stats repo::archive path
+  Good: borg create repo::archive path -v --stats
+  Bad:  borg create repo::archive -v --stats path
+
+Fixes:
+
+- fix LD_LIBRARY_PATH restoration for subprocesses, #3077
+- "auto" compression: make sure expensive compression is actually better,
+  otherwise store lz4 compressed data we already computed.
+
+Other changes:
+
+- docs:
+
+  - FAQ: we do not implement futile attempts of ETA / progress displays
+  - manpage: fix typos, update homepage
+  - implement simple "issue" role for manpage generation, #3075
+
+
+Version 1.1.0rc4 (2017-10-01)
+-----------------------------
+
+Compatibility notes:
+
+- A borg server >= 1.1.0rc4 does not support borg clients 1.1.0b3-b5. #3033
+- The files cache is now controlled differently and has a new default mode:
+
+  - the files cache now uses ctime by default for improved file change
+    detection safety. You can still use mtime for more speed and less safety.
+  - --ignore-inode is deprecated (use --files-cache=... without "inode")
+  - --no-files-cache is deprecated (use --files-cache=disabled)
+
+New features:
+
+- --files-cache - implement files cache mode control, #911
+  You can now control the files cache mode using this option:
+  --files-cache={ctime,mtime,size,inode,rechunk,disabled}
+  (only some combinations are supported). See the docs for details.
+
+Fixes:
+
+- remote progress/logging: deal with partial lines, #2637
+- remote progress: flush json mode output
+- fix subprocess environments, #3050 (and more)
+
+Other changes:
+
+- remove client_supports_log_v3 flag, #3033
+- exclude broken Cython 0.27(.0) in requirements, #3066
+- vagrant:
+
+  - upgrade to FUSE for macOS 3.7.1
+  - use Python 3.5.4 to build the binaries
+- docs:
+
+  - security: change-passphrase only changes the passphrase, #2990
+  - fixed/improved borg create --compression examples, #3034
+  - add note about metadata dedup and --no[ac]time, #2518
+  - twitter account @borgbackup now, better visible, #2948
+  - simplified rate limiting wrapper in FAQ
+
+
+Version 1.1.0rc3 (2017-09-10)
+-----------------------------
+
+New features:
+
+- delete: support naming multiple archives, #2958
+
+Fixes:
+
+- repo cleanup/write: invalidate cached FDs, #2982
+- fix datetime.isoformat() microseconds issues, #2994
+- recover_segment: use mmap(), lower memory needs, #2987
+
+Other changes:
+
+- with-lock: close segment file before invoking subprocess
+- keymanager: don't depend on optional readline module, #2976
+- docs:
+
+  - fix macOS keychain integration command
+  - show/link new screencasts in README, #2936
+  - document utf-8 locale requirement for json mode, #2273
+- vagrant: clean up shell profile init, user name, #2977
+- test_detect_attic_repo: don't test mount, #2975
+- add debug logging for repository cleanup
+
+
+Version 1.1.0rc2 (2017-08-28)
+-----------------------------
+
+Compatibility notes:
+
+- list: corrected mix-up of "isomtime" and "mtime" formats. Previously,
+  "isomtime" was the default but produced a verbose human format,
+  while "mtime" produced a ISO-8601-like format.
+  The behaviours have been swapped (so "mtime" is human, "isomtime" is ISO-like),
+  and the default is now "mtime".
+  "isomtime" is now a real ISO-8601 format ("T" between date and time, not a space).
+
+New features:
+
+- None.
+
+Fixes:
+
+- list: fix weird mixup of mtime/isomtime
+- create --timestamp: set start time, #2957
+- ignore corrupt files cache, #2939
+- migrate locks to child PID when daemonize is used
+- fix exitcode of borg serve, #2910
+- only compare contents when chunker params match, #2899
+- umount: try fusermount, then try umount, #2863
+
+Other changes:
+
+- JSON: use a more standard ISO 8601 datetime format, #2376
+- cache: write_archive_index: truncate_and_unlink on error, #2628
+- detect non-upgraded Attic repositories, #1933
+- delete various nogil and threading related lines
+- coala / pylint related improvements
+- docs:
+
+  - renew asciinema/screencasts, #669
+  - create: document exclusion through nodump, #2949
+  - minor formatting fixes
+  - tar: tarpipe example
+  - improve "with-lock" and "info" docs, #2869
+  - detail how to use macOS/GNOME/KDE keyrings for repo passwords, #392
+- travis: only short-circuit docs-only changes for pull requests
+- vagrant:
+
+  - netbsd: bash is already installed
+  - fix netbsd version in PKG_PATH
+  - add exe location to PATH when we build an exe
+
+
+Version 1.1.0rc1 (2017-07-24)
+-----------------------------
+
+Compatibility notes:
+
+- delete: removed short option for --cache-only
+
+New features:
+
+- support borg list repo --format {comment} {bcomment} {end}, #2081
+- key import: allow reading from stdin, #2760
+
+Fixes:
+
+- with-lock: avoid creating segment files that might be overwritten later, #1867
+- prune: fix checkpoints processing with --glob-archives
+- FUSE: versions view: keep original file extension at end, #2769
+- fix --last, --first: do not accept values <= 0,
+  fix reversed archive ordering with --last
+- include testsuite data (attic.tar.gz) when installing the package
+- use limited unpacker for outer key, for manifest (both security precautions),
+  #2174 #2175
+- fix bashism in shell scripts, #2820, #2816
+- cleanup endianness detection, create _endian.h,
+  fixes build on alpine linux, #2809
+- fix crash with --no-cache-sync (give known chunk size to chunk_incref), #2853
+
+Other changes:
+
+- FUSE: versions view: linear numbering by archive time
+- split up interval parsing from filtering for --keep-within, #2610
+- add a basic .editorconfig, #2734
+- use archive creation time as mtime for FUSE mount, #2834
+- upgrade FUSE for macOS (osxfuse) from 3.5.8 to 3.6.3, #2706
+- hashindex: speed up by replacing modulo with "if" to check for wraparound
+- coala checker / pylint: fixed requirements and .coafile, more ignores
+- borg upgrade: name backup directories as 'before-upgrade', #2811
+- add .mailmap
+- some minor changes suggested by lgtm.com
+- docs:
+
+  - better explanation of the --ignore-inode option relevance, #2800
+  - fix openSUSE command and add openSUSE section
+  - simplify ssh authorized_keys file using "restrict", add legacy note, #2121
+  - mount: show usage of archive filters
+  - mount: add repository example, #2462
+  - info: update and add examples, #2765
+  - prune: include example
+  - improved style / formatting
+  - improved/fixed segments_per_dir docs
+  - recreate: fix wrong "remove unwanted files" example
+  - reference list of status chars in borg recreate --filter description
+  - update source-install docs about doc build dependencies, #2795
+  - cleanup installation docs
+  - file system requirements, update segs per dir
+  - fix checkpoints/parts reference in FAQ, #2859
+- code:
+
+  - hashindex: don't pass side effect into macro
+  - crypto low_level: don't mutate local bytes()
+  - use dash_open function to open file or "-" for stdin/stdout
+  - archiver: argparse cleanup / refactoring
+  - shellpattern: add match_end arg
+- tests: added some additional unit tests, some fixes, #2700 #2710
+- vagrant: fix setup of cygwin, add Debian 9 "stretch"
+- travis: don't perform full travis build on docs-only changes, #2531
+
+
+Version 1.1.0b6 (2017-06-18)
+----------------------------
+
+Compatibility notes:
+
+- Running "borg init" via a "borg serve --append-only" server will *not* create
+  an append-only repository anymore. Use "borg init --append-only" to initialize
+  an append-only repository.
+
+- Repositories in the "repokey" and "repokey-blake2" modes with an empty passphrase
+  are now treated as unencrypted repositories for security checks (e.g.
+  BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK).
+
+  Previously there would be no prompts nor messages if an unknown repository
+  in one of these modes with an empty passphrase was encountered. This would
+  allow an attacker to swap a repository, if one assumed that the lack of
+  password prompts was due to a set BORG_PASSPHRASE.
+
+  Since the "trick" does not work if BORG_PASSPHRASE is set, this does generally
+  not affect scripts.
+
+- Repositories in the "authenticated" mode are now treated as the unencrypted
+  repositories they are.
+
+- The client-side temporary repository cache now holds unencrypted data for better speed.
+
+- borg init: removed the short form of --append-only (-a).
+
+- borg upgrade: removed the short form of --inplace (-i).
+
+New features:
+
+- reimplemented the RepositoryCache, size-limited caching of decrypted repo
+  contents, integrity checked via xxh64. #2515
+- reduced space usage of chunks.archive.d. Existing caches are migrated during
+  a cache sync. #235 #2638
+- integrity checking using xxh64 for important files used by borg, #1101:
+
+  - repository: index and hints files
+  - cache: chunks and files caches, chunks.archive.d
+- improve cache sync speed, #1729
+- create: new --no-cache-sync option
+- add repository mandatory feature flags infrastructure, #1806
+- Verify most operations against SecurityManager. Location, manifest timestamp
+  and key types are now checked for almost all non-debug commands. #2487
+- implement storage quotas, #2517
+- serve: add --restrict-to-repository, #2589
+- BORG_PASSCOMMAND: use external tool providing the key passphrase, #2573
+- borg export-tar, #2519
+- list: --json-lines instead of --json for archive contents, #2439
+- add --debug-profile option (and also "borg debug convert-profile"), #2473
+- implement --glob-archives/-a, #2448
+- normalize authenticated key modes for better naming consistency:
+
+  - rename "authenticated" to "authenticated-blake2" (uses blake2b)
+  - implement "authenticated" mode (uses hmac-sha256)
+
+Fixes:
+
+- hashindex: read/write indices >2 GiB on 32bit systems, better error
+  reporting, #2496
+- repository URLs: implement IPv6 address support and also more informative
+  error message when parsing fails.
+- mount: check whether llfuse is installed before asking for passphrase, #2540
+- mount: do pre-mount checks before opening repository, #2541
+- FUSE:
+
+  - fix crash if empty (None) xattr is read, #2534
+  - fix read(2) caching data in metadata cache
+  - fix negative uid/gid crash (fix crash when mounting archives
+    of external drives made on cygwin), #2674
+  - redo ItemCache, on top of object cache
+  - use decrypted cache
+  - remove unnecessary normpaths
+- serve: ignore --append-only when initializing a repository (borg init), #2501
+- serve: fix incorrect type of exception_short for Errors, #2513
+- fix --exclude and --exclude-from recursing into directories, #2469
+- init: don't allow creating nested repositories, #2563
+- --json: fix encryption[mode] not being the cmdline name
+- remote: propagate Error.traceback correctly
+- fix remote logging and progress, #2241
+
+  - implement --debug-topic for remote servers
+  - remote: restore "Remote:" prefix (as used in 1.0.x)
+  - rpc negotiate: enable v3 log protocol only for supported clients
+  - fix --progress and logging in general for remote
+- fix parse_version, add tests, #2556
+- repository: truncate segments (and also some other files) before unlinking, #2557
+- recreate: keep timestamps as in original archive, #2384
+- recreate: if single archive is not processed, exit 2
+- patterns: don't recurse with ! / --exclude for pf:, #2509
+- cache sync: fix n^2 behaviour in lookup_name
+- extract: don't write to disk with --stdout (affected non-regular-file items), #2645
+- hashindex: implement KeyError, more tests
+
+Other changes:
+
+- remote: show path in PathNotAllowed
+- consider repokey w/o passphrase == unencrypted, #2169
+- consider authenticated mode == unencrypted, #2503
+- restrict key file names, #2560
+- document follow_symlinks requirements, check libc, use stat and chown
+  with follow_symlinks=False, #2507
+- support common options on the main command, #2508
+- support common options on mid-level commands (e.g. borg *key* export)
+- make --progress a common option
+- increase DEFAULT_SEGMENTS_PER_DIR to 1000
+- chunker: fix invalid use of types (function only used by tests)
+- chunker: don't do uint32_t >> 32
+- FUSE:
+
+  - add instrumentation (--debug and SIGUSR1/SIGINFO)
+  - reduced memory usage for repository mounts by lazily instantiating archives
+  - improved archive load times
+- info: use CacheSynchronizer & HashIndex.stats_against (better performance)
+- docs:
+
+  - init: document --encryption as required
+  - security: OpenSSL usage
+  - security: used implementations; note python libraries
+  - security: security track record of OpenSSL and msgpack
+  - patterns: document denial of service (regex, wildcards)
+  - init: note possible denial of service with "none" mode
+  - init: document SHA extension is supported in OpenSSL and thus SHA is
+    faster on AMD Ryzen than blake2b.
+  - book: use A4 format, new builder option format.
+  - book: create appendices
+  - data structures: explain repository compaction
+  - data structures: add chunk layout diagram
+  - data structures: integrity checking
+  - data structures: demingle cache and repo index
+  - Attic FAQ: separate section for attic stuff
+  - FAQ: I get an IntegrityError or similar - what now?
+  - FAQ: Can I use Borg on SMR hard drives?, #2252
+  - FAQ: specify "using inline shell scripts"
+  - add systemd warning regarding placeholders, #2543
+  - xattr: document API
+  - add docs/misc/borg-data-flow data flow chart
+  - debugging facilities
+  - README: how to help the project, #2550
+  - README: add bountysource badge, #2558
+  - fresh new theme + tweaking
+  - logo: vectorized (PDF and SVG) versions
+  - frontends: use headlines - you can link to them
+  - mark --pattern, --patterns-from as experimental
+  - highlight experimental features in online docs
+  - remove regex based pattern examples, #2458
+  - nanorst for "borg help TOPIC" and --help
+  - split deployment
+  - deployment: hosting repositories
+  - deployment: automated backups to a local hard drive
+  - development: vagrant, windows10 requirements
+  - development: update docs remarks
+  - split usage docs, #2627
+  - usage: avoid bash highlight, [options] instead of <options>
+  - usage: add benchmark page
+  - helpers: truncate_and_unlink doc
+  - don't suggest to leak BORG_PASSPHRASE
+  - internals: columnize rather long ToC [webkit fixup]
+    internals: manifest & feature flags
+  - internals: more HashIndex details
+  - internals: fix ASCII art equations
+  - internals: edited obj graph related sections a bit
+  - internals: layers image + description
+  - fix way too small figures in pdf
+  - index: disable syntax highlight (bash)
+  - improve options formatting, fix accidental block quotes
+
+- testing / checking:
+
+  - add support for using coala, #1366
+  - testsuite: add ArchiverCorruptionTestCase
+  - do not test logger name, #2504
+  - call setup_logging after destroying logging config
+  - testsuite.archiver: normalise pytest.raises vs. assert_raises
+  - add test for preserved intermediate folder permissions, #2477
+  - key: add round-trip test
+  - remove attic dependency of the tests, #2505
+  - enable remote tests on cygwin
+  - tests: suppress tar's future timestamp warning
+  - cache sync: add more refcount tests
+  - repository: add tests, including corruption tests
+
+- vagrant:
+
+  - control VM cpus and pytest workers via env vars VMCPUS and XDISTN
+  - update cleaning workdir
+  - fix openbsd shell
+  - add OpenIndiana
+
+- packaging:
+
+  - binaries: don't bundle libssl
+  - setup.py clean to remove compiled files
+  - fail in borg package if version metadata is very broken (setuptools_scm)
+
+- repo / code structure:
+
+  - create borg.algorithms and borg.crypto packages
+  - algorithms: rename crc32 to checksums
+  - move patterns to module, #2469
+  - gitignore: complete paths for src/ excludes
+  - cache: extract CacheConfig class
+  - implement IntegrityCheckedFile + Detached variant, #2502 #1688
+  - introduce popen_with_error_handling to handle common user errors
+
+
+Version 1.1.0b5 (2017-04-30)
+----------------------------
+
+Compatibility notes:
+
+- BORG_HOSTNAME_IS_UNIQUE is now on by default.
+- removed --compression-from feature
+- recreate: add --recompress flag, unify --always-recompress and
+  --recompress
+
+Fixes:
+
+- catch exception for os.link when hardlinks are not supported, #2405
+- borg rename / recreate: expand placeholders, #2386
+- generic support for hardlinks (files, devices, FIFOs), #2324
+- extract: also create parent dir for device files, if needed, #2358
+- extract: if a hardlink master is not in the to-be-extracted subset,
+  the "x" status was not displayed for it, #2351
+- embrace y2038 issue to support 32bit platforms: clamp timestamps to int32,
+  #2347
+- verify_data: fix IntegrityError handling for defect chunks, #2442
+- allow excluding parent and including child, #2314
+
+Other changes:
+
+- refactor compression decision stuff
+- change global compression default to lz4 as well, to be consistent
+  with --compression defaults.
+- placeholders: deny access to internals and other unspecified stuff
+- clearer error message for unrecognized placeholder
+- more clear exception if borg check does not help, #2427
+- vagrant: upgrade FUSE for macOS to 3.5.8, #2346
+- linux binary builds: get rid of glibc 2.13 dependency, #2430
+- docs:
+
+  - placeholders: document escaping
+  - serve: env vars in original commands are ignored
+  - tell what kind of hardlinks we support
+  - more docs about compression
+  - LICENSE: use canonical formulation
+    ("copyright holders and contributors" instead of "author")
+  - document borg init behaviour via append-only borg serve, #2440
+  - be clear about what buzhash is used for, #2390
+  - add hint about chunker params, #2421
+  - clarify borg upgrade docs, #2436
+  - FAQ to explain warning when running borg check --repair, #2341
+  - repository file system requirements, #2080
+  - pre-install considerations
+  - misc. formatting / crossref fixes
+- tests:
+
+  - enhance travis setuptools_scm situation
+  - add extra test for the hashindex
+  - fix invalid param issue in benchmarks
+
+These belong to 1.1.0b4 release, but did not make it into changelog by then:
+
+- vagrant: increase memory for parallel testing
+- lz4 compress: lower max. buffer size, exception handling
+- add docstring to do_benchmark_crud
+- patterns help: mention path full-match in intro
+
+
+Version 1.1.0b4 (2017-03-27)
+----------------------------
+
+Compatibility notes:
+
+- init: the --encryption argument is mandatory now (there are several choices)
+- moved "borg migrate-to-repokey" to "borg key migrate-to-repokey".
+- "borg change-passphrase" is deprecated, use "borg key change-passphrase"
+  instead.
+- the --exclude-if-present option now supports tagging a folder with any
+  filesystem object type (file, folder, etc), instead of expecting only files
+  as tags, #1999
+- the --keep-tag-files option has been deprecated in favor of the new
+  --keep-exclude-tags, to account for the change mentioned above.
+- use lz4 compression by default, #2179
+
+New features:
+
+- JSON API to make developing frontends and automation easier
+  (see :ref:`json_output`)
+
+  - add JSON output to commands: `borg create/list/info --json ...`.
+  - add --log-json option for structured logging output.
+  - add JSON progress information, JSON support for confirmations (yes()).
+- add two new options --pattern and --patterns-from as discussed in #1406
+- new path full match pattern style (pf:) for very fast matching, #2334
+- add 'debug dump-manifest' and 'debug dump-archive' commands
+- add 'borg benchmark crud' command, #1788
+- new 'borg delete --force --force' to delete severely corrupted archives, #1975
+- info: show utilization of maximum archive size, #1452
+- list: add dsize and dcsize keys, #2164
+- paperkey.html: Add interactive html template for printing key backups.
+- key export: add qr html export mode
+- securely erase config file (which might have old encryption key), #2257
+- archived file items: add size to metadata, 'borg extract' and 'borg check' do
+  check the file size for consistency, FUSE uses precomputed size from Item.
+
+Fixes:
+
+- fix remote speed regression introduced in 1.1.0b3, #2185
+- fix regression handling timestamps beyond 2262 (revert bigint removal),
+  introduced in 1.1.0b3, #2321
+- clamp (nano)second values to unproblematic range, #2304
+- hashindex: rebuild hashtable if we have too little empty buckets
+  (performance fix), #2246
+- Location regex: fix bad parsing of wrong syntax
+- ignore posix_fadvise errors in repository.py, #2095
+- borg rpc: use limited msgpack.Unpacker (security precaution), #2139
+- Manifest: Make sure manifest timestamp is strictly monotonically increasing.
+- create: handle BackupOSError on a per-path level in one spot
+- create: clarify -x option / meaning of "same filesystem"
+- create: don't create hard link refs to failed files
+- archive check: detect and fix missing all-zero replacement chunks, #2180
+- files cache: update inode number when --ignore-inode is used, #2226
+- fix decompression exceptions crashing ``check --verify-data`` and others
+  instead of reporting integrity error, #2224 #2221
+- extract: warning for unextracted big extended attributes, #2258, #2161
+- mount: umount on SIGINT/^C when in foreground
+- mount: handle invalid hard link refs
+- mount: fix huge RAM consumption when mounting a repository (saves number of
+  archives * 8 MiB), #2308
+- hashindex: detect mingw byte order #2073
+- hashindex: fix wrong skip_hint on hashindex_set when encountering tombstones,
+  the regression was introduced in #1748
+- fix ChunkIndex.__contains__ assertion  for big-endian archs
+- fix borg key/debug/benchmark crashing without subcommand, #2240
+- Location: accept //servername/share/path
+- correct/refactor calculation of unique/non-unique chunks
+- extract: fix missing call to ProgressIndicator.finish
+- prune: fix error msg, it is --keep-within, not --within
+- fix "auto" compression mode bug (not compressing), #2331
+- fix symlink item fs size computation, #2344
+
+Other changes:
+
+- remote repository: improved async exception processing, #2255 #2225
+- with --compression auto,C, only use C if lz4 achieves at least 3% compression
+- PatternMatcher: only normalize path once, #2338
+- hashindex: separate endian-dependent defs from endian detection
+- migrate-to-repokey: ask using canonical_path() as we do everywhere else.
+- SyncFile: fix use of fd object after close
+- make LoggedIO.close_segment reentrant
+- creating a new segment: use "xb" mode, #2099
+- redo key_creator, key_factory, centralise key knowledge, #2272
+- add return code functions, #2199
+- list: only load cache if needed
+- list: files->items, clarifications
+- list: add "name" key for consistency with info cmd
+- ArchiveFormatter: add "start" key for compatibility with "info"
+- RemoteRepository: account rx/tx bytes
+- setup.py build_usage/build_man/build_api fixes
+- Manifest.in: simplify, exclude .so, .dll and .orig, #2066
+- FUSE: get rid of chunk accounting, st_blocks = ceil(size / blocksize).
+- tests:
+
+  - help python development by testing 3.6-dev
+  - test for borg delete --force
+- vagrant:
+
+  - freebsd: some fixes, #2067
+  - darwin64: use osxfuse 3.5.4 for tests / to build binaries
+  - darwin64: improve VM settings
+  - use python 3.5.3 to build binaries, #2078
+  - upgrade pyinstaller from 3.1.1+ to 3.2.1
+  - pyinstaller: use fixed AND freshly compiled bootloader, #2002
+  - pyinstaller: automatically builds bootloader if missing
+- docs:
+
+  - create really nice man pages
+  - faq: mention --remote-ratelimit in bandwidth limit question
+  - fix caskroom link, #2299
+  - docs/security: reiterate that RPC in Borg does no networking
+  - docs/security: counter tracking, #2266
+  - docs/development: update merge remarks
+  - address SSH batch mode in docs, #2202 #2270
+  - add warning about running build_usage on Python >3.4, #2123
+  - one link per distro in the installation page
+  - improve --exclude-if-present and --keep-exclude-tags, #2268
+  - improve automated backup script in doc, #2214
+  - improve remote-path description
+  - update docs for create -C default change (lz4)
+  - document relative path usage, #1868
+  - document snapshot usage, #2178
+  - corrected some stuff in internals+security
+  - internals: move toctree to after the introduction text
+  - clarify metadata kind, manifest ops
+  - key enc: correct / clarify some stuff, link to internals/security
+  - datas: enc: 1.1.x mas different MACs
+  - datas: enc: correct factual error -- no nonce involved there.
+  - make internals.rst an index page and edit it a bit
+  - add "Cryptography in Borg" and "Remote RPC protocol security" sections
+  - document BORG_HOSTNAME_IS_UNIQUE, #2087
+  - FAQ by categories as proposed by @anarcat in #1802
+  - FAQ: update Which file types, attributes, etc. are *not* preserved?
+  - development: new branching model for git repository
+  - development: define "ours" merge strategy for auto-generated files
+  - create: move --exclude note to main doc
+  - create: move item flags to main doc
+  - fix examples using borg init without -e/--encryption
+  - list: don't print key listings in fat (html + man)
+  - remove Python API docs (were very incomplete, build problems on RTFD)
+  - added FAQ section about backing up root partition
+
+
+Version 1.1.0b3 (2017-01-15)
+----------------------------
+
+Compatibility notes:
+
+- borg init: removed the default of "--encryption/-e", #1979
+  This was done so users do a informed decision about -e mode.
+
+Bug fixes:
+
+- borg recreate: don't rechunkify unless explicitly told so
+- borg info: fixed bug when called without arguments, #1914
+- borg init: fix free space check crashing if disk is full, #1821
+- borg debug delete/get obj: fix wrong reference to exception
+- fix processing of remote ~/ and ~user/ paths (regressed since 1.1.0b1), #1759
+- posix platform module: only build / import on non-win32 platforms, #2041
+
+New features:
+
+- new CRC32 implementations that are much faster than the zlib one used previously, #1970
+- add blake2b key modes (use blake2b as MAC). This links against system libb2,
+  if possible, otherwise uses bundled code
+- automatically remove stale locks - set BORG_HOSTNAME_IS_UNIQUE env var
+  to enable stale lock killing. If set, stale locks in both cache and
+  repository are deleted. #562 #1253
+- borg info <repo>: print general repo information, #1680
+- borg check --first / --last / --sort / --prefix, #1663
+- borg mount --first / --last / --sort / --prefix, #1542
+- implement "health" item formatter key, #1749
+- BORG_SECURITY_DIR to remember security related infos outside the cache.
+  Key type, location and manifest timestamp checks now survive cache
+  deletion. This also means that you can now delete your cache and avoid
+  previous warnings, since Borg can still tell it's safe.
+- implement BORG_NEW_PASSPHRASE, #1768
+
+Other changes:
+
+- borg recreate:
+
+  - remove special-cased --dry-run
+  - update --help
+  - remove bloat: interruption blah, autocommit blah, resuming blah
+  - re-use existing checkpoint functionality
+  - archiver tests: add check_cache tool - lints refcounts
+
+- fixed cache sync performance regression from 1.1.0b1 onwards, #1940
+- syncing the cache without chunks.archive.d (see :ref:`disable_archive_chunks`)
+  now avoids any merges and is thus faster, #1940
+- borg check --verify-data: faster due to linear on-disk-order scan
+- borg debug-xxx commands removed, we use "debug xxx" subcommands now, #1627
+- improve metadata handling speed
+- shortcut hashindex_set by having hashindex_lookup hint about address
+- improve / add progress displays, #1721
+- check for index vs. segment files object count mismatch
+- make RPC protocol more extensible: use named parameters.
+- RemoteRepository: misc. code cleanups / refactors
+- clarify cache/repository README file
+
+- docs:
+
+  - quickstart: add a comment about other (remote) filesystems
+  - quickstart: only give one possible ssh url syntax, all others are
+    documented in usage chapter.
+  - mention file://
+  - document repo URLs / archive location
+  - clarify borg diff help, #980
+  - deployment: synthesize alternative --restrict-to-path example
+  - improve cache / index docs, esp. files cache docs, #1825
+  - document using "git merge 1.0-maint -s recursive -X rename-threshold=20%"
+    for avoiding troubles when merging the 1.0-maint branch into master.
+
+- tests:
+
+  - FUSE tests: catch ENOTSUP on freebsd
+  - FUSE tests: test troublesome xattrs last
+  - fix byte range error in test, #1740
+  - use monkeypatch to set env vars, but only on pytest based tests.
+  - point XDG_*_HOME to temp dirs for tests, #1714
+  - remove all BORG_* env vars from the outer environment
+
+
+Version 1.1.0b2 (2016-10-01)
+----------------------------
+
+Bug fixes:
+
+- fix incorrect preservation of delete tags, leading to "object count mismatch"
+  on borg check, #1598. This only occurred with 1.1.0b1 (not with 1.0.x) and is
+  normally fixed by running another borg create/delete/prune.
+- fix broken --progress for double-cell paths (e.g. CJK), #1624
+- borg recreate: also catch SIGHUP
+- FUSE:
+
+  - fix hardlinks in versions view, #1599
+  - add parameter check to ItemCache.get to make potential failures more clear
+
+New features:
+
+- Archiver, RemoteRepository: add --remote-ratelimit (send data)
+- borg help compression, #1582
+- borg check: delete chunks with integrity errors, #1575, so they can be
+  "repaired" immediately and maybe healed later.
+- archives filters concept (refactoring/unifying older code)
+
+  - covers --first/--last/--prefix/--sort-by options
+  - currently used for borg list/info/delete
+
+Other changes:
+
+- borg check --verify-data slightly tuned (use get_many())
+- change {utcnow} and {now} to ISO-8601 format ("T" date/time separator)
+- repo check: log transaction IDs, improve object count mismatch diagnostic
+- Vagrantfile: use TW's fresh-bootloader pyinstaller branch
+- fix module names in api.rst
+- hashindex: bump api_version
+
+
+Version 1.1.0b1 (2016-08-28)
+----------------------------
+
+New features:
+
+- new commands:
+
+  - borg recreate: re-create existing archives, #787 #686 #630 #70, also see
+    #757, #770.
+
+    - selectively remove files/dirs from old archives
+    - re-compress data
+    - re-chunkify data, e.g. to have upgraded Attic / Borg 0.xx archives
+      deduplicate with Borg 1.x archives or to experiment with chunker-params.
+  - borg diff: show differences between archives
+  - borg with-lock: execute a command with the repository locked, #990
+- borg create:
+
+  - Flexible compression with pattern matching on path/filename,
+    and LZ4 heuristic for deciding compressibility, #810, #1007
+  - visit files in inode order (better speed, esp. for large directories and rotating disks)
+  - in-file checkpoints, #1217
+  - increased default checkpoint interval to 30 minutes (was 5 minutes), #896
+  - added uuid archive format tag, #1151
+  - save mountpoint directories with --one-file-system, makes system restore easier, #1033
+  - Linux: added support for some BSD flags, #1050
+  - add 'x' status for excluded paths, #814
+
+    - also means files excluded via UF_NODUMP, #1080
+- borg check:
+
+  - will not produce the "Checking segments" output unless new --progress option is passed, #824.
+  - --verify-data to verify data cryptographically on the client, #975
+- borg list, #751, #1179
+
+  - removed {formatkeys}, see "borg list --help"
+  - --list-format is deprecated, use --format instead
+  - --format now also applies to listing archives, not only archive contents, #1179
+  - now supports the usual [PATH [PATHS…]] syntax and excludes
+  - new keys: csize, num_chunks, unique_chunks, NUL
+  - supports guaranteed_available hashlib hashes
+    (to avoid varying functionality depending on environment),
+    which includes the SHA1 and SHA2 family as well as MD5
+- borg prune:
+
+  - to better visualize the "thinning out", we now list all archives in
+    reverse time order. rephrase and reorder help text.
+  - implement --keep-last N via --keep-secondly N, also --keep-minutely.
+    assuming that there is not more than 1 backup archive made in 1s,
+    --keep-last N and --keep-secondly N are equivalent, #537
+  - cleanup checkpoints except the latest, #1008
+- borg extract:
+
+  - added --progress, #1449
+  - Linux: limited support for BSD flags, #1050
+- borg info:
+
+  - output is now more similar to borg create --stats, #977
+- borg mount:
+
+  - provide "borgfs" wrapper for borg mount, enables usage via fstab, #743
+  - "versions" mount option - when used with a repository mount, this gives
+    a merged, versioned view of the files in all archives, #729
+- repository:
+
+  - added progress information to commit/compaction phase (often takes some time when deleting/pruning), #1519
+  - automatic recovery for some forms of repository inconsistency, #858
+  - check free space before going forward with a commit, #1336
+  - improved write performance (esp. for rotating media), #985
+
+    - new IO code for Linux
+    - raised default segment size to approx 512 MiB
+  - improved compaction performance, #1041
+  - reduced client CPU load and improved performance for remote repositories, #940
+
+- options that imply output (--show-rc, --show-version, --list, --stats,
+  --progress) don't need -v/--info to have that output displayed, #865
+- add archive comments (via borg (re)create --comment), #842
+- borg list/prune/delete: also output archive id, #731
+- --show-version: shows/logs the borg version, #725
+- added --debug-topic for granular debug logging, #1447
+- use atomic file writing/updating for configuration and key files, #1377
+- BORG_KEY_FILE environment variable, #1001
+- self-testing module, #970
+
+
+Bug fixes:
+
+- list: fixed default output being produced if --format is given with empty parameter, #1489
+- create: fixed overflowing progress line with CJK and similar characters, #1051
+- prune: fixed crash if --prefix resulted in no matches, #1029
+- init: clean up partial repo if passphrase input is aborted, #850
+- info: quote cmdline arguments that have spaces in them
+- fix hardlinks failing in some cases for extracting subtrees, #761
+
+Other changes:
+
+- replace stdlib hmac with OpenSSL, zero-copy decrypt (10-15% increase in
+  performance of hash-lists and extract).
+- improved chunker performance, #1021
+- open repository segment files in exclusive mode (fail-safe), #1134
+- improved error logging, #1440
+- Source:
+
+  - pass meta-data around, #765
+  - move some constants to new constants module
+  - better readability and fewer errors with namedtuples, #823
+  - moved source tree into src/ subdirectory, #1016
+  - made borg.platform a package, #1113
+  - removed dead crypto code, #1032
+  - improved and ported parts of the test suite to py.test, #912
+  - created data classes instead of passing dictionaries around, #981, #1158, #1161
+  - cleaned up imports, #1112
+- Docs:
+
+  - better help texts and sphinx reproduction of usage help:
+
+    - Group options
+    - Nicer list of options in Sphinx
+    - Deduplicate 'Common options' (including --help)
+  - chunker: added some insights by "Voltara", #903
+  - clarify what "deduplicated size" means
+  - fix / update / add package list entries
+  - added a SaltStack usage example, #956
+  - expanded FAQ
+  - new contributors in AUTHORS!
+- Tests:
+
+  - vagrant: add ubuntu/xenial 64bit - this box has still some issues
+  - ChunkBuffer: add test for leaving partial chunk in buffer, fixes #945
+
+
+Version 1.0.13 (2019-02-15)
+---------------------------
+
+Please note: this is very likely the last 1.0.x release, please upgrade to 1.1.x.
+
+Bug fixes:
+
+- security fix: configure FUSE with "default_permissions", #3903.
+  "default_permissions" is now enforced by borg by default to let the
+  kernel check uid/gid/mode based permissions.
+  "ignore_permissions" can be given to not enforce "default_permissions".
+- xattrs: fix borg exception handling on ENOSPC error, #3808.
+
+New features:
+
+- Read a passphrase from a file descriptor specified in the
+  BORG_PASSPHRASE_FD environment variable.
+
+Other changes:
+
+- acl platform code: fix acl set return type
+- xattr:
+
+  - add linux {list,get,set}xattr ctypes prototypes
+  - fix darwin flistxattr ctypes prototype
+- testing / travis-ci:
+
+  - fix the homebrew 1.9 issues on travis-ci, #4254
+  - travis OS X: use xcode 8.3 (not broken)
+  - tox.ini: lock requirements
+  - unbreak 1.0-maint on travis, fixes #4123
+- vagrant:
+
+  - misc. fixes
+  - FUSE for macOS: upgrade 3.7.1 to 3.8.3
+  - Python: upgrade 3.5.5 to 3.5.6
+- docs:
+
+  - Update installation instructions for macOS
+  - update release workflow using twine (docs, scripts), #4213
+
+Version 1.0.12 (2018-04-08)
+---------------------------
+
+Bug fixes:
+
+- repository: cleanup/write: invalidate cached FDs, tests
+- serve: fix exitcode, #2910
+- extract: set bsdflags last (include immutable flag), #3263
+- create --timestamp: set start time, #2957
+- create: show excluded dir with "x" for tagged dirs / caches, #3189
+- migrate locks to child PID when daemonize is used
+- Buffer: fix wrong thread-local storage use, #2951
+- fix detection of non-local path, #3108
+- fix LDLP restoration for subprocesses, #3077
+- fix subprocess environments (xattr module's fakeroot version check,
+  borg umount, BORG_PASSCOMMAND), #3050
+- remote: deal with partial lines, #2637
+- get rid of datetime.isoformat, use safe parse_timestamp to parse
+  timestamps, #2994
+- build: do .h file content checks in binary mode, fixes build issue for
+  non-ascii header files on pure-ascii locale platforms, #3544 #3639
+- remove platform.uname() call which caused library mismatch issues, #3732
+- add exception handler around deprecated platform.linux_distribution() call
+
+Other changes:
+
+- require msgpack-python >= 0.4.6 and < 0.5.0, see #3753
+- add parens for C preprocessor macro argument usages (did not cause
+  malfunction)
+- ignore corrupt files cache, #2939
+- replace "modulo" with "if" to check for wraparound in hashmap
+- keymanager: don't depend on optional readline module, #2980
+- exclude broken pytest 3.3.0 release
+- exclude broken Cython 0.27(.0) release, #3066
+- flake8: add some ignores
+- docs:
+
+  - create: document exclusion through nodump
+  - document good and problematic option placements, fix examples, #3356
+  - update docs about hardlinked symlinks limitation
+  - faq: we do not implement futile attempts of ETA / progress displays
+  - simplified rate limiting wrapper in FAQ
+  - twitter account @borgbackup, #2948
+  - add note about metadata dedup and --no[ac]time, #2518
+  - change-passphrase only changes the passphrase, #2990
+  - clarify encrypted key format for borg key export, #3296
+  - document sshfs rename workaround, #3315
+  - update release checklist about security fixes
+  - docs about how to verify a signed release, #3634
+  - chunk seed is generated per /repository/
+- vagrant:
+
+  - use FUSE for macOS 3.7.1 to build the macOS binary
+  - use python 3.5.5 to build the binaries
+  - add exe location to PATH when we build an exe
+  - use https pypi url for wheezy
+  - netbsd: bash is already installed
+  - netbsd: fix netbsd version in PKG_PATH
+  - use self-made FreeBSD 10.3 box, #3022
+  - backport fs_init (including related updates) from 1.1
+  - the boxcutter wheezy boxes are 404, use local ones
+- travis:
+
+  - don't perform full Travis build on docs-only changes, #2531
+  - only short-circuit docs-only changes for pull requests
+
+
+Version 1.0.11 (2017-07-21)
+---------------------------
+
+Bug fixes:
+
+- use limited unpacker for outer key (security precaution), #2174
+- fix paperkey import bug
+
+Other changes:
+
+- change --checkpoint-interval default from 600s to 1800s, #2841.
+  this improves efficiency for big repositories a lot.
+- docs: fix OpenSUSE command and add OpenSUSE section
+- tests: add tests for split_lstring and paperkey
+- vagrant:
+
+  - fix openbsd shell
+  - backport cpu/ram setup from master
+  - add stretch64 VM
+
+Version 1.0.11rc1 (2017-06-27)
+------------------------------
+
+Bug fixes:
+
+- performance: rebuild hashtable if we have too few empty buckets, #2246.
+  this fixes some sporadic, but severe performance breakdowns.
+- Archive: allocate zeros when needed, #2308
+  fixes huge memory usage of mount (8 MiB × number of archives)
+- IPv6 address support
+  also: Location: more informative exception when parsing fails
+- borg single-file binary: use pyinstaller v3.2.1, #2396
+  this fixes that the prelink cronjob on some distros kills the
+  borg binary by stripping away parts of it.
+- extract:
+
+  - warning for unextracted big extended attributes, #2258
+  - also create parent dir for device files, if needed.
+  - don't write to disk with --stdout, #2645
+- archive check: detect and fix missing all-zero replacement chunks, #2180
+- fix (de)compression exceptions, #2224 #2221
+- files cache: update inode number, #2226
+- borg rpc: use limited msgpack.Unpacker (security precaution), #2139
+- Manifest: use limited msgpack.Unpacker (security precaution), #2175
+- Location: accept //servername/share/path
+- fix ChunkIndex.__contains__ assertion  for big-endian archs (harmless)
+- create: handle BackupOSError on a per-path level in one spot
+- fix error msg, there is no --keep-last in borg 1.0.x, #2282
+- clamp (nano)second values to unproblematic range, #2304
+- fuse / borg mount:
+
+  - fix st_blocks to be an integer (not float) value
+  - fix negative uid/gid crash (they could come into archives e.g. when
+    backing up external drives under cygwin), #2674
+  - fix crash if empty (None) xattr is read
+  - do pre-mount checks before opening repository
+  - check llfuse is installed before asking for passphrase
+- borg rename: expand placeholders, #2386
+- borg serve: fix forced command lines containing BORG_* env vars
+- fix error msg, it is --keep-within, not --within
+- fix borg key/debug/benchmark crashing without subcommand, #2240
+- chunker: fix invalid use of types, don't do uint32_t >> 32
+- document follow_symlinks requirements, check libc, #2507
+
+New features:
+
+- added BORG_PASSCOMMAND environment variable, #2573
+- add minimal version of in repository mandatory feature flags, #2134
+
+  This should allow us to make sure older borg versions can be cleanly
+  prevented from doing operations that are no longer safe because of
+  repository format evolution. This allows more fine grained control than
+  just incrementing the manifest version. So for example a change that
+  still allows new archives to be created but would corrupt the repository
+  when an old version tries to delete an archive or check the repository
+  would add the new feature to the check and delete set but leave it out
+  of the write set.
+- borg delete --force --force to delete severely corrupted archives, #1975
+
+Other changes:
+
+- embrace y2038 issue to support 32bit platforms
+- be more clear that this is a "beyond repair" case, #2427
+- key file names: limit to 100 characters and remove colons from host name
+- upgrade FUSE for macOS to 3.5.8, #2346
+- split up parsing and filtering for --keep-within, better error message, #2610
+- docs:
+
+  - fix caskroom link, #2299
+  - address SSH batch mode, #2202 #2270
+  - improve remote-path description
+  - document snapshot usage, #2178
+  - document relative path usage, #1868
+  - one link per distro in the installation page
+  - development: new branching model in git repository
+  - kill api page
+  - added FAQ section about backing up root partition
+  - add bountysource badge, #2558
+  - create empty docs.txt reequirements, #2694
+  - README: how to help the project
+  - note -v/--verbose requirement on affected options, #2542
+  - document borg init behaviour via append-only borg serve, #2440
+  - be clear about what buzhash is used for (chunking) and want it is not
+    used for (deduplication)- also say already in the readme that we use a
+    cryptohash for dedupe, so people don't worry, #2390
+  - add hint about chunker params to borg upgrade docs, #2421
+  - clarify borg upgrade docs, #2436
+  - quickstart: delete problematic BORG_PASSPHRASE use, #2623
+  - faq: specify "using inline shell scripts"
+  - document pattern denial of service, #2624
+- tests:
+
+  - remove attic dependency of the tests, #2505
+  - travis:
+
+    - enhance travis setuptools_scm situation
+    - install fakeroot for Linux
+  - add test for borg delete --force
+  - enable remote tests on cygwin (the cygwin issue that caused these tests
+    to break was fixed in cygwin at least since cygwin 2.8, maybe even since
+    2.7.0).
+  - remove skipping the noatime tests on GNU/Hurd, #2710
+  - fix borg import issue, add comment, #2718
+  - include attic.tar.gz when installing the package
+    also: add include_package_data=True
+
+Version 1.0.10 (2017-02-13)
+---------------------------
+
+Bug fixes:
+
+- Manifest timestamps are now monotonically increasing,
+  this fixes issues when the system clock jumps backwards
+  or is set inconsistently across computers accessing the same repository, #2115
+- Fixed testing regression in 1.0.10rc1 that lead to a hard dependency on
+  py.test >= 3.0, #2112
+
+New features:
+
+- "key export" can now generate a printable HTML page with both a QR code and
+  a human-readable "paperkey" representation (and custom text) through the
+  ``--qr-html`` option.
+
+  The same functionality is also available through `paperkey.html <paperkey.html>`_,
+  which is the same HTML page generated by ``--qr-html``. It works with existing
+  "key export" files and key files.
+
+Other changes:
+
+- docs:
+
+  - language clarification - "borg create --one-file-system" option does not respect
+    mount points, but considers different file systems instead, #2141
+- setup.py: build_api: sort file list for determinism
+
+
+Version 1.0.10rc1 (2017-01-29)
+------------------------------
+
+Bug fixes:
+
+- borg serve: fix transmission data loss of pipe writes, #1268
+  This affects only the cygwin platform (not Linux, BSD, OS X).
+- Avoid triggering an ObjectiveFS bug in xattr retrieval, #1992
+- When running out of buffer memory when reading xattrs, only skip the
+  current file, #1993
+- Fixed "borg upgrade --tam" crashing with unencrypted repositories. Since
+  :ref:`the issue <tam_vuln>` is not relevant for unencrypted repositories,
+  it now does nothing and prints an error, #1981.
+- Fixed change-passphrase crashing with unencrypted repositories, #1978
+- Fixed "borg check repo::archive" indicating success if "archive" does not exist, #1997
+- borg check: print non-exit-code warning if --last or --prefix aren't fulfilled
+- fix bad parsing of wrong repo location syntax
+- create: don't create hard link refs to failed files,
+  mount: handle invalid hard link refs, #2092
+- detect mingw byte order, #2073
+- creating a new segment: use "xb" mode, #2099
+- mount: umount on SIGINT/^C when in foreground, #2082
+
+Other changes:
+
+- binary: use fixed AND freshly compiled pyinstaller bootloader, #2002
+- xattr: ignore empty names returned by llistxattr(2) et al
+- Enable the fault handler: install handlers for the SIGSEGV, SIGFPE, SIGABRT,
+  SIGBUS and SIGILL signals to dump the Python traceback.
+- Also print a traceback on SIGUSR2.
+- borg change-passphrase: print key location (simplify making a backup of it)
+- officially support Python 3.6 (setup.py: add Python 3.6 qualifier)
+- tests:
+
+  - vagrant / travis / tox: add Python 3.6 based testing
+  - vagrant: fix openbsd repo, #2042
+  - vagrant: fix the freebsd64 machine, #2037 #2067
+  - vagrant: use python 3.5.3 to build binaries, #2078
+  - vagrant: use osxfuse 3.5.4 for tests / to build binaries
+    vagrant: improve darwin64 VM settings
+  - travis: fix osxfuse install (fixes OS X testing on Travis CI)
+  - travis: require succeeding OS X tests, #2028
+  - travis: use latest pythons for OS X based testing
+  - use pytest-xdist to parallelize testing
+  - fix xattr test race condition, #2047
+  - setup.cfg: fix pytest deprecation warning, #2050
+- docs:
+
+  - language clarification - VM backup FAQ
+  - borg create: document how to backup stdin, #2013
+  - borg upgrade: fix incorrect title levels
+  - add CVE numbers for issues fixed in 1.0.9, #2106
+- fix typos (taken from Debian package patch)
+- remote: include data hexdump in "unexpected RPC data" error message
+- remote: log SSH command line at debug level
+- API_VERSION: use numberspaces, #2023
+- remove .github from pypi package, #2051
+- add pip and setuptools to requirements file, #2030
+- SyncFile: fix use of fd object after close (cosmetic)
+- Manifest.in: simplify, exclude \*.{so,dll,orig}, #2066
+- ignore posix_fadvise errors in repository.py, #2095
+  (works around issues with docker on ARM)
+- make LoggedIO.close_segment reentrant, avoid reentrance
+
+
+Version 1.0.9 (2016-12-20)
+--------------------------
+
+Security fixes:
+
+- A flaw in the cryptographic authentication scheme in Borg allowed an attacker
+  to spoof the manifest. See :ref:`tam_vuln` above for the steps you should
+  take.
+
+  CVE-2016-10099 was assigned to this vulnerability.
+- borg check: When rebuilding the manifest (which should only be needed very rarely)
+  duplicate archive names would be handled on a "first come first serve" basis, allowing
+  an attacker to apparently replace archives.
+
+  CVE-2016-10100 was assigned to this vulnerability.
+
+Bug fixes:
+
+- borg check:
+
+  - rebuild manifest if it's corrupted
+  - skip corrupted chunks during manifest rebuild
+- fix TypeError in integrity error handler, #1903, #1894
+- fix location parser for archives with @ char (regression introduced in 1.0.8), #1930
+- fix wrong duration/timestamps if system clock jumped during a create
+- fix progress display not updating if system clock jumps backwards
+- fix checkpoint interval being incorrect if system clock jumps
+
+Other changes:
+
+- docs:
+
+  - add python3-devel as a dependency for cygwin-based installation
+  - clarify extract is relative to current directory
+  - FAQ: fix link to changelog
+  - markup fixes
+- tests:
+
+  - test_get\_(cache|keys)_dir: clean env state, #1897
+  - get back pytest's pretty assertion failures, #1938
+- setup.py build_usage:
+
+  - fixed build_usage not processing all commands
+  - fixed build_usage not generating includes for debug commands
+
+
+Version 1.0.9rc1 (2016-11-27)
+-----------------------------
+
+Bug fixes:
+
+- files cache: fix determination of newest mtime in backup set (which is
+  used in cache cleanup and led to wrong "A" [added] status for unchanged
+  files in next backup), #1860.
+
+- borg check:
+
+  - fix incorrectly reporting attic 0.13 and earlier archives as corrupt
+  - handle repo w/o objects gracefully and also bail out early if repo is
+    *completely* empty, #1815.
+- fix tox/pybuild in 1.0-maint
+- at xattr module import time, loggers are not initialized yet
+
+New features:
+
+- borg umount <mountpoint>
+  exposed already existing umount code via the CLI api, so users can use it,
+  which is more consistent than using borg to mount and fusermount -u (or
+  umount) to un-mount, #1855.
+- implement borg create --noatime --noctime, fixes #1853
+
+Other changes:
+
+- docs:
+
+  - display README correctly on PyPI
+  - improve cache / index docs, esp. files cache docs, fixes #1825
+  - different pattern matching for --exclude, #1779
+  - datetime formatting examples for {now} placeholder, #1822
+  - clarify passphrase mode attic repo upgrade, #1854
+  - clarify --umask usage, #1859
+  - clarify how to choose PR target branch
+  - clarify prune behavior for different archive contents, #1824
+  - fix PDF issues, add logo, fix authors, headings, TOC
+  - move security verification to support section
+  - fix links in standalone README (:ref: tags)
+  - add link to security contact in README
+  - add FAQ about security
+  - move fork differences to FAQ
+  - add more details about resource usage
+- tests: skip remote tests on cygwin, #1268
+- travis:
+
+  - allow OS X failures until the brew cask osxfuse issue is fixed
+  - caskroom osxfuse-beta gone, it's osxfuse now (3.5.3)
+- vagrant:
+
+  - upgrade OSXfuse / FUSE for macOS to 3.5.3
+  - remove llfuse from tox.ini at a central place
+  - do not try to install llfuse on centos6
+  - fix FUSE test for darwin, #1546
+  - add windows virtual machine with cygwin
+  - Vagrantfile cleanup / code deduplication
+
+
+Version 1.0.8 (2016-10-29)
+--------------------------
+
+Bug fixes:
+
+- RemoteRepository: Fix busy wait in call_many, #940
+
+New features:
+
+- implement borgmajor/borgminor/borgpatch placeholders, #1694
+  {borgversion} was already there (full version string). With the new
+  placeholders you can now also get e.g. 1 or 1.0 or 1.0.8.
+
+Other changes:
+
+- avoid previous_location mismatch, #1741
+
+  due to the changed canonicalization for relative paths in PR #1711 / #1655
+  (implement /./ relpath hack), there would be a changed repo location warning
+  and the user would be asked if this is ok. this would break automation and
+  require manual intervention, which is unwanted.
+
+  thus, we automatically fix the previous_location config entry, if it only
+  changed in the expected way, but still means the same location.
+
+- docs:
+
+  - deployment.rst: do not use bare variables in ansible snippet
+  - add clarification about append-only mode, #1689
+  - setup.py: add comment about requiring llfuse, #1726
+  - update usage.rst / api.rst
+  - repo url / archive location docs + typo fix
+  - quickstart: add a comment about other (remote) filesystems
+
+- vagrant / tests:
+
+  - no chown when rsyncing (fixes boxes w/o vagrant group)
+  - fix FUSE permission issues on linux/freebsd, #1544
+  - skip FUSE test for borg binary + fakeroot
+  - ignore security.selinux xattrs, fixes tests on centos, #1735
+
+
+Version 1.0.8rc1 (2016-10-17)
+-----------------------------
+
+Bug fixes:
+
+- fix signal handling (SIGINT, SIGTERM, SIGHUP), #1620 #1593
+  Fixes e.g. leftover lock files for quickly repeated signals (e.g. Ctrl-C
+  Ctrl-C) or lost connections or systemd sending SIGHUP.
+- progress display: adapt formatting to narrow screens, do not crash, #1628
+- borg create --read-special - fix crash on broken symlink, #1584.
+  also correctly processes broken symlinks. before this regressed to a crash
+  (5b45385) a broken symlink would've been skipped.
+- process_symlink: fix missing backup_io()
+  Fixes a chmod/chown/chgrp/unlink/rename/... crash race between getting
+  dirents and dispatching to process_symlink.
+- yes(): abort on wrong answers, saying so, #1622
+- fixed exception borg serve raised when connection was closed before repository
+  was opened. Add an error message for this.
+- fix read-from-closed-FD issue, #1551
+  (this seems not to get triggered in 1.0.x, but was discovered in master)
+- hashindex: fix iterators (always raise StopIteration when exhausted)
+  (this seems not to get triggered in 1.0.x, but was discovered in master)
+- enable relative paths in ssh:// repo URLs, via /./relpath hack, #1655
+- allow repo paths with colons, #1705
+- update changed repo location immediately after acceptance, #1524
+- fix debug get-obj / delete-obj crash if object not found and remote repo,
+  #1684
+- pyinstaller: use a spec file to build borg.exe binary, exclude osxfuse dylib
+  on Mac OS X (avoids mismatch lib <-> driver), #1619
+
+New features:
+
+- add "borg key export" / "borg key import" commands, #1555, so users are able
+  to backup / restore their encryption keys more easily.
+
+  Supported formats are the keyfile format used by borg internally and a
+  special "paper" format with by line checksums for printed backups. For the
+  paper format, the import is an interactive process which checks each line as
+  soon as it is input.
+- add "borg debug-refcount-obj" to determine a repo objects' referrer counts,
+  #1352
+
+Other changes:
+
+- add "borg debug ..." subcommands
+  (borg debug-* still works, but will be removed in borg 1.1)
+- setup.py: Add subcommand support to build_usage.
+- remote: change exception message for unexpected RPC data format to indicate
+  dataflow direction.
+- improved messages / error reporting:
+
+  - IntegrityError: add placeholder for message, so that the message we give
+    appears not only in the traceback, but also in the (short) error message,
+    #1572
+  - borg.key: include chunk id in exception msgs, #1571
+  - better messages for cache newer than repo, #1700
+- vagrant (testing/build VMs):
+
+  - upgrade OSXfuse / FUSE for macOS to 3.5.2
+  - update Debian Wheezy boxes, #1686
+  - openbsd / netbsd: use own boxes, fixes misc rsync installation and
+    FUSE/llfuse related testing issues, #1695 #1696 #1670 #1671 #1728
+- docs:
+
+  - add docs for "key export" and "key import" commands, #1641
+  - fix inconsistency in FAQ (pv-wrapper).
+  - fix second block in "Easy to use" section not showing on GitHub, #1576
+  - add bestpractices badge
+  - link reference docs and faq about BORG_FILES_CACHE_TTL, #1561
+  - improve borg info --help, explain size infos, #1532
+  - add release signing key / security contact to README, #1560
+  - add contribution guidelines for developers
+  - development.rst: add sphinx_rtd_theme to the sphinx install command
+  - adjust border color in borg.css
+  - add debug-info usage help file
+  - internals.rst: fix typos
+  - setup.py: fix build_usage to always process all commands
+  - added docs explaining multiple --restrict-to-path flags, #1602
+  - add more specific warning about write-access debug commands, #1587
+  - clarify FAQ regarding backup of virtual machines, #1672
+- tests:
+
+  - work around FUSE xattr test issue with recent fakeroot
+  - simplify repo/hashindex tests
+  - travis: test FUSE-enabled borg, use trusty to have a recent FUSE
+  - re-enable FUSE tests for RemoteArchiver (no deadlocks any more)
+  - clean env for pytest based tests, #1714
+  - fuse_mount contextmanager: accept any options
+
+
+Version 1.0.7 (2016-08-19)
+--------------------------
+
+Security fixes:
+
+- borg serve: fix security issue with remote repository access, #1428
+  If you used e.g. --restrict-to-path /path/client1/ (with or without trailing
+  slash does not make a difference), it acted like a path prefix match using
+  /path/client1 (note the missing trailing slash) - the code then also allowed
+  working in e.g. /path/client13 or /path/client1000.
+
+  As this could accidentally lead to major security/privacy issues depending on
+  the paths you use, the behaviour was changed to be a strict directory match.
+  That means --restrict-to-path /path/client1 (with or without trailing slash
+  does not make a difference) now uses /path/client1/ internally (note the
+  trailing slash here!) for matching and allows precisely that path AND any
+  path below it. So, /path/client1 is allowed, /path/client1/repo1 is allowed,
+  but not /path/client13 or /path/client1000.
+
+  If you willingly used the undocumented (dangerous) previous behaviour, you
+  may need to rearrange your --restrict-to-path paths now. We are sorry if
+  that causes work for you, but we did not want a potentially dangerous
+  behaviour in the software (not even using a for-backwards-compat option).
+
+Bug fixes:
+
+- fixed repeated LockTimeout exceptions when borg serve tried to write into
+  a already write-locked repo (e.g. by a borg mount), #502 part b)
+  This was solved by the fix for #1220 in 1.0.7rc1 already.
+- fix cosmetics + file leftover for "not a valid borg repository", #1490
+- Cache: release lock if cache is invalid, #1501
+- borg extract --strip-components: fix leak of preloaded chunk contents
+- Repository, when a InvalidRepository exception happens:
+
+  - fix spurious, empty lock.roster
+  - fix repo not closed cleanly
+
+New features:
+
+- implement borg debug-info, fixes #1122
+  (just calls already existing code via cli, same output as below tracebacks)
+
+Other changes:
+
+- skip the O_NOATIME test on GNU Hurd, fixes #1315
+  (this is a very minor issue and the GNU Hurd project knows the bug)
+- document using a clean repo to test / build the release
+
+
+Version 1.0.7rc2 (2016-08-13)
+-----------------------------
+
+Bug fixes:
+
+- do not write objects to repository that are bigger than the allowed size,
+  borg will reject reading them, #1451.
+
+  Important: if you created archives with many millions of files or
+  directories, please verify if you can open them successfully,
+  e.g. try a "borg list REPO::ARCHIVE".
+- lz4 compression: dynamically enlarge the (de)compression buffer, the static
+  buffer was not big enough for archives with extremely many items, #1453
+- larger item metadata stream chunks, raise archive item limit by 8x, #1452
+- fix untracked segments made by moved DELETEs, #1442
+
+  Impact: Previously (metadata) segments could become untracked when deleting data,
+  these would never be cleaned up.
+- extended attributes (xattrs) related fixes:
+
+  - fixed a race condition in xattrs querying that led to the entire file not
+    being backed up (while logging the error, exit code = 1), #1469
+  - fixed a race condition in xattrs querying that led to a crash, #1462
+  - raise OSError including the error message derived from errno, deal with
+    path being a integer FD
+
+Other changes:
+
+- print active env var override by default, #1467
+- xattr module: refactor code, deduplicate, clean up
+- repository: split object size check into too small and too big
+- add a transaction_id assertion, so borg init on a broken (inconsistent)
+  filesystem does not look like a coding error in borg, but points to the
+  real problem.
+- explain confusing TypeError caused by compat support for old servers, #1456
+- add forgotten usage help file from build_usage
+- refactor/unify buffer code into helpers.Buffer class, add tests
+- docs:
+
+  - document archive limitation, #1452
+  - improve prune examples
+
+
+Version 1.0.7rc1 (2016-08-05)
+-----------------------------
+
+Bug fixes:
+
+- fix repo lock deadlocks (related to lock upgrade), #1220
+- catch unpacker exceptions, resync, #1351
+- fix borg break-lock ignoring BORG_REPO env var, #1324
+- files cache performance fixes (fixes unnecessary re-reading/chunking/
+  hashing of unmodified files for some use cases):
+
+  - fix unintended file cache eviction, #1430
+  - implement BORG_FILES_CACHE_TTL, update FAQ, raise default TTL from 10
+    to 20, #1338
+- FUSE:
+
+  - cache partially read data chunks (performance), #965, #966
+  - always create a root dir, #1125
+- use an OrderedDict for helptext, making the build reproducible, #1346
+- RemoteRepository init: always call close on exceptions, #1370 (cosmetic)
+- ignore stdout/stderr broken pipe errors (cosmetic), #1116
+
+New features:
+
+- better borg versions management support (useful esp. for borg servers
+  wanting to offer multiple borg versions and for clients wanting to choose
+  a specific server borg version), #1392:
+
+  - add BORG_VERSION environment variable before executing "borg serve" via ssh
+  - add new placeholder {borgversion}
+  - substitute placeholders in --remote-path
+
+- borg init --append-only option (makes using the more secure append-only mode
+  more convenient. when used remotely, this requires 1.0.7+ also on the borg
+  server), #1291.
+
+Other changes:
+
+- Vagrantfile:
+
+  - darwin64: upgrade to FUSE for macOS 3.4.1 (aka osxfuse), #1378
+  - xenial64: use user "ubuntu", not "vagrant" (as usual), #1331
+- tests:
+
+  - fix FUSE tests on OS X, #1433
+- docs:
+
+  - FAQ: add backup using stable filesystem names recommendation
+  - FAQ about glibc compatibility added, #491, glibc-check improved
+  - FAQ: 'A' unchanged file; remove ambiguous entry age sentence.
+  - OS X: install pkg-config to build with FUSE support, fixes #1400
+  - add notes about shell/sudo pitfalls with env. vars, #1380
+  - added platform feature matrix
+- implement borg debug-dump-repo-objs
+
+
+Version 1.0.6 (2016-07-12)
+--------------------------
+
+Bug fixes:
+
+- Linux: handle multiple LD_PRELOAD entries correctly, #1314, #1111
+- Fix crash with unclear message if the libc is not found, #1314, #1111
+
+Other changes:
+
+- tests:
+
+  - Fixed O_NOATIME tests for Solaris and GNU Hurd, #1315
+  - Fixed sparse file tests for (file) systems not supporting it, #1310
+- docs:
+
+  - Fixed syntax highlighting, #1313
+  - misc docs: added data processing overview picture
+
+
+Version 1.0.6rc1 (2016-07-10)
+-----------------------------
+
+New features:
+
+- borg check --repair: heal damaged files if missing chunks re-appear (e.g. if
+  the previously missing chunk was added again in a later backup archive),
+  #148. (*) Also improved logging.
+
+Bug fixes:
+
+- sync_dir: silence fsync() failing with EINVAL, #1287
+  Some network filesystems (like smbfs) don't support this and we use this in
+  repository code.
+- borg mount (FUSE):
+
+  - fix directories being shadowed when contained paths were also specified,
+    #1295
+  - raise I/O Error (EIO) on damaged files (unless -o allow_damaged_files is
+    used), #1302. (*)
+- borg extract: warn if a damaged file is extracted, #1299. (*)
+- Added some missing return code checks (ChunkIndex._add, hashindex_resize).
+- borg check: fix/optimize initial hash table size, avoids resize of the table.
+
+Other changes:
+
+- tests:
+
+  - add more FUSE tests, #1284
+  - deduplicate FUSE (u)mount code
+  - fix borg binary test issues, #862
+- docs:
+
+  - changelog: added release dates to older borg releases
+  - fix some sphinx (docs generator) warnings, #881
+
+Notes:
+
+(*) Some features depend on information (chunks_healthy list) added to item
+metadata when a file with missing chunks was "repaired" using all-zero
+replacement chunks. The chunks_healthy list is generated since borg 1.0.4,
+thus borg can't recognize such "repaired" (but content-damaged) files if the
+repair was done with an older borg version.
+
+
+Version 1.0.5 (2016-07-07)
+--------------------------
+
+Bug fixes:
+
+- borg mount: fix FUSE crash in xattr code on Linux introduced in 1.0.4, #1282
+
+Other changes:
+
+- backport some FAQ entries from master branch
+- add release helper scripts
+- Vagrantfile:
+
+  - centos6: no FUSE, don't build binary
+  - add xz for redhat-like dists
+
+
+Version 1.0.4 (2016-07-07)
+--------------------------
+
+New features:
+
+- borg serve --append-only, #1168
+  This was included because it was a simple change (append-only functionality
+  was already present via repository config file) and makes better security now
+  practically usable.
+- BORG_REMOTE_PATH environment variable, #1258
+  This was included because it was a simple change (--remote-path cli option
+  was already present) and makes borg much easier to use if you need it.
+- Repository: cleanup incomplete transaction on "no space left" condition.
+  In many cases, this can avoid a 100% full repo filesystem (which is very
+  problematic as borg always needs free space - even to delete archives).
+
+Bug fixes:
+
+- Fix wrong handling and reporting of OSErrors in borg create, #1138.
+  This was a serious issue: in the context of "borg create", errors like
+  repository I/O errors (e.g. disk I/O errors, ssh repo connection errors)
+  were handled badly and did not lead to a crash (which would be good for this
+  case, because the repo transaction would be incomplete and trigger a
+  transaction rollback to clean up).
+  Now, error handling for source files is cleanly separated from every other
+  error handling, so only problematic input files are logged and skipped.
+- Implement fail-safe error handling for borg extract.
+  Note that this isn't nearly as critical as the borg create error handling
+  bug, since nothing is written to the repo. So this was "merely" misleading
+  error reporting.
+- Add missing error handler in directory attr restore loop.
+- repo: make sure write data hits disk before the commit tag (#1236) and also
+  sync the containing directory.
+- FUSE: getxattr fail must use errno.ENOATTR, #1126
+  (fixes Mac OS X Finder malfunction: "zero bytes" file length, access denied)
+- borg check --repair: do not lose information about the good/original chunks.
+  If we do not lose the original chunk IDs list when "repairing" a file
+  (replacing missing chunks with all-zero chunks), we have a chance to "heal"
+  the file back into its original state later, in case the chunks re-appear
+  (e.g. in a fresh backup). Healing is not implemented yet, see #148.
+- fixes for --read-special mode:
+
+  - ignore known files cache, #1241
+  - fake regular file mode, #1214
+  - improve symlinks handling, #1215
+- remove passphrase from subprocess environment, #1105
+- Ignore empty index file (will trigger index rebuild), #1195
+- add missing placeholder support for --prefix, #1027
+- improve exception handling for placeholder replacement
+- catch and format exceptions in arg parsing
+- helpers: fix "undefined name 'e'" in exception handler
+- better error handling for missing repo manifest, #1043
+- borg delete:
+
+  - make it possible to delete a repo without manifest
+  - borg delete --forced allows one to delete corrupted archives, #1139
+- borg check:
+
+  - make borg check work for empty repo
+  - fix resync and msgpacked item qualifier, #1135
+  - rebuild_manifest: fix crash if 'name' or 'time' key were missing.
+  - better validation of item metadata dicts, #1130
+  - better validation of archive metadata dicts
+- close the repo on exit - even if rollback did not work, #1197.
+  This is rather cosmetic, it avoids repo closing in the destructor.
+
+- tests:
+
+  - fix sparse file test, #1170
+  - flake8: ignore new F405, #1185
+  - catch "invalid argument" on cygwin, #257
+  - fix sparseness assertion in test prep, #1264
+
+Other changes:
+
+- make borg build/work on OpenSSL 1.0 and 1.1, #1187
+- docs / help:
+
+  - fix / clarify prune help, #1143
+  - fix "patterns" help formatting
+  - add missing docs / help about placeholders
+  - resources: rename atticmatic to borgmatic
+  - document sshd settings, #545
+  - more details about checkpoints, add split trick, #1171
+  - support docs: add freenode web chat link, #1175
+  - add prune visualization / example, #723
+  - add note that Fnmatch is default, #1247
+  - make clear that lzma levels > 6 are a waste of cpu cycles
+  - add a "do not edit" note to auto-generated files, #1250
+  - update cygwin installation docs
+- repository interoperability with borg master (1.1dev) branch:
+
+  - borg check: read item metadata keys from manifest, #1147
+  - read v2 hints files, #1235
+  - fix hints file "unknown version" error handling bug
+- tests: add tests for format_line
+- llfuse: update version requirement for freebsd
+- Vagrantfile:
+
+  - use openbsd 5.9, #716
+  - do not install llfuse on netbsd (broken)
+  - update OSXfuse to version 3.3.3
+  - use Python 3.5.2 to build the binaries
+- glibc compatibility checker: scripts/glibc_check.py
+- add .eggs to .gitignore
+
+
+Version 1.0.3 (2016-05-20)
+--------------------------
+
+Bug fixes:
+
+- prune: avoid that checkpoints are kept and completed archives are deleted in
+  a prune run), #997
+- prune: fix commandline argument validation - some valid command lines were
+  considered invalid (annoying, but harmless), #942
+- fix capabilities extraction on Linux (set xattrs last, after chown()), #1069
+- repository: fix commit tags being seen in data
+- when probing key files, do binary reads. avoids crash when non-borg binary
+  files are located in borg's key files directory.
+- handle SIGTERM and make a clean exit - avoids orphan lock files.
+- repository cache: don't cache large objects (avoid using lots of temp. disk
+  space), #1063
+
+Other changes:
+
+- Vagrantfile: OS X: update osxfuse / install lzma package, #933
+- setup.py: add check for platform_darwin.c
+- setup.py: on freebsd, use a llfuse release that builds ok
+- docs / help:
+
+  - update readthedocs URLs, #991
+  - add missing docs for "borg break-lock", #992
+  - borg create help: add some words to about the archive name
+  - borg create help: document format tags, #894
+
+
+Version 1.0.2 (2016-04-16)
+--------------------------
+
+Bug fixes:
+
+- fix malfunction and potential corruption on (nowadays rather rare) big-endian
+  architectures or bi-endian archs in (rare) BE mode. #886, #889
+
+  cache resync / index merge was malfunctioning due to this, potentially
+  leading to data loss. borg info had cosmetic issues (displayed wrong values).
+
+  note: all (widespread) little-endian archs (like x86/x64) or bi-endian archs
+  in (widespread) LE mode (like ARMEL, MIPSEL, ...) were NOT affected.
+- add overflow and range checks for 1st (special) uint32 of the hashindex
+  values, switch from int32 to uint32.
+- fix so that refcount will never overflow, but just stick to max. value after
+  a overflow would have occurred.
+- borg delete: fix --cache-only for broken caches, #874
+
+  Makes --cache-only idempotent: it won't fail if the cache is already deleted.
+- fixed borg create --one-file-system erroneously traversing into other
+  filesystems (if starting fs device number was 0), #873
+- workaround a bug in Linux fadvise FADV_DONTNEED, #907
+
+Other changes:
+
+- better test coverage for hashindex, incl. overflow testing, checking correct
+  computations so endianness issues would be discovered.
+- reproducible doc for ProgressIndicator*,  make the build reproducible.
+- use latest llfuse for vagrant machines
+- docs:
+
+  - use /path/to/repo in examples, fixes #901
+  - fix confusing usage of "repo" as archive name (use "arch")
+
+
+Version 1.0.1 (2016-04-08)
+--------------------------
+
+New features:
+
+Usually there are no new features in a bugfix release, but these were added
+due to their high impact on security/safety/speed or because they are fixes
+also:
+
+- append-only mode for repositories, #809, #36 (see docs)
+- borg create: add --ignore-inode option to make borg detect unmodified files
+  even if your filesystem does not have stable inode numbers (like sshfs and
+  possibly CIFS).
+- add options --warning, --error, --critical for missing log levels, #826.
+  it's not recommended to suppress warnings or errors, but the user may decide
+  this on his own.
+  note: --warning is not given to borg serve so a <= 1.0.0 borg will still
+  work as server (it is not needed as it is the default).
+  do not use --error or --critical when using a <= 1.0.0 borg server.
+
+Bug fixes:
+
+- fix silently skipping EIO, #748
+- add context manager for Repository (avoid orphan repository locks), #285
+- do not sleep for >60s while waiting for lock, #773
+- unpack file stats before passing to FUSE
+- fix build on illumos
+- don't try to backup doors or event ports (Solaris and derivatives)
+- remove useless/misleading libc version display, #738
+- test suite: reset exit code of persistent archiver, #844
+- RemoteRepository: clean up pipe if remote open() fails
+- Remote: don't print tracebacks for Error exceptions handled downstream, #792
+- if BORG_PASSPHRASE is present but wrong, don't prompt for password, but fail
+  instead, #791
+- ArchiveChecker: move "orphaned objects check skipped" to INFO log level, #826
+- fix capitalization, add ellipses, change log level to debug for 2 messages,
+  #798
+
+Other changes:
+
+- update llfuse requirement, llfuse 1.0 works
+- update OS / dist packages on build machines, #717
+- prefer showing --info over -v in usage help, #859
+- docs:
+
+  - fix cygwin requirements (gcc-g++)
+  - document how to debug / file filesystem issues, #664
+  - fix reproducible build of api docs
+  - RTD theme: CSS !important overwrite, #727
+  - Document logo font. Recreate logo png. Remove GIMP logo file.
+
+
+Version 1.0.0 (2016-03-05)
+--------------------------
+
+The major release number change (0.x -> 1.x) indicates bigger incompatible
+changes, please read the compatibility notes, adapt / test your scripts and
+check your backup logs.
+
+Compatibility notes:
+
+- drop support for python 3.2 and 3.3, require 3.4 or 3.5, #221 #65 #490
+  note: we provide binaries that include python 3.5.1 and everything else
+  needed. they are an option in case you are stuck with < 3.4 otherwise.
+- change encryption to be on by default (using "repokey" mode)
+- moved keyfile keys from ~/.borg/keys to ~/.config/borg/keys,
+  you can either move them manually or run "borg upgrade <REPO>"
+- remove support for --encryption=passphrase,
+  use borg migrate-to-repokey to switch to repokey mode, #97
+- remove deprecated --compression <number>,
+  use --compression zlib,<number> instead
+  in case of 0, you could also use --compression none
+- remove deprecated --hourly/daily/weekly/monthly/yearly
+  use --keep-hourly/daily/weekly/monthly/yearly instead
+- remove deprecated --do-not-cross-mountpoints,
+  use --one-file-system instead
+- disambiguate -p option, #563:
+
+  - -p now is same as --progress
+  - -P now is same as --prefix
+- remove deprecated "borg verify",
+  use "borg extract --dry-run" instead
+- cleanup environment variable semantics, #355
+  the environment variables used to be "yes sayers" when set, this was
+  conceptually generalized to "automatic answerers" and they just give their
+  value as answer (as if you typed in that value when being asked).
+  See the "usage" / "Environment Variables" section of the docs for details.
+- change the builtin default for --chunker-params, create 2MiB chunks, #343
+  --chunker-params new default: 19,23,21,4095 - old default: 10,23,16,4095
+
+  one of the biggest issues with borg < 1.0 (and also attic) was that it had a
+  default target chunk size of 64kiB, thus it created a lot of chunks and thus
+  also a huge chunk management overhead (high RAM and disk usage).
+
+  please note that the new default won't change the chunks that you already
+  have in your repository. the new big chunks do not deduplicate with the old
+  small chunks, so expect your repo to grow at least by the size of every
+  changed file and in the worst case (e.g. if your files cache was lost / is
+  not used) by the size of every file (minus any compression you might use).
+
+  in case you want to immediately see a much lower resource usage (RAM / disk)
+  for chunks management, it might be better to start with a new repo than
+  continuing in the existing repo (with an existing repo, you'ld have to wait
+  until all archives with small chunks got pruned to see a lower resource
+  usage).
+
+  if you used the old --chunker-params default value (or if you did not use
+  --chunker-params option at all) and you'ld like to continue using small
+  chunks (and you accept the huge resource usage that comes with that), just
+  explicitly use borg create --chunker-params=10,23,16,4095.
+- archive timestamps: the 'time' timestamp now refers to archive creation
+  start time (was: end time), the new 'time_end' timestamp refers to archive
+  creation end time. This might affect prune if your backups take rather long.
+  if you give a timestamp via cli this is stored into 'time', therefore it now
+  needs to mean archive creation start time.
+
+New features:
+
+- implement password roundtrip, #695
+
+Bug fixes:
+
+- remote end does not need cache nor keys directories, do not create them, #701
+- added retry counter for passwords, #703
+
+Other changes:
+
+- fix compiler warnings, #697
+- docs:
+
+  - update README.rst to new changelog location in docs/changes.rst
+  - add Teemu to AUTHORS
+  - changes.rst: fix old chunker params, #698
+  - FAQ: how to limit bandwidth
+
+
+Version 1.0.0rc2 (2016-02-28)
+-----------------------------
+
+New features:
+
+- format options for location: user, pid, fqdn, hostname, now, utcnow, user
+- borg list --list-format
+- borg prune -v --list enables the keep/prune list output, #658
+
+Bug fixes:
+
+- fix _open_rb noatime handling, #657
+- add a simple archivename validator, #680
+- borg create --stats: show timestamps in localtime, use same labels/formatting
+  as borg info, #651
+- llfuse compatibility fixes (now compatible with: 0.40, 0.41, 0.42)
+
+Other changes:
+
+- it is now possible to use "pip install borgbackup[fuse]" to automatically
+  install the llfuse dependency using the correct version requirement
+  for it. you still need to care about having installed the FUSE / build
+  related OS package first, though, so that building llfuse can succeed.
+- Vagrant: drop Ubuntu Precise (12.04) - does not have Python >= 3.4
+- Vagrant: use pyinstaller v3.1.1 to build binaries
+- docs:
+
+  - borg upgrade: add to docs that only LOCAL repos are supported
+  - borg upgrade also handles borg 0.xx -> 1.0
+  - use pip extras or requirements file to install llfuse
+  - fix order in release process
+  - updated usage docs and other minor / cosmetic fixes
+  - verified borg examples in docs, #644
+  - freebsd dependency installation and FUSE configuration, #649
+  - add example how to restore a raw device, #671
+  - add a hint about the dev headers needed when installing from source
+  - add examples for delete (and handle delete after list, before prune), #656
+  - update example for borg create -v --stats (use iso datetime format), #663
+  - added example to BORG_RSH docs
+  - "connection closed by remote": add FAQ entry and point to issue #636
+
+
+Version 1.0.0rc1 (2016-02-07)
+-----------------------------
+
+New features:
+
+- borg migrate-to-repokey ("passphrase" -> "repokey" encryption key mode)
+- implement --short for borg list REPO, #611
+- implement --list for borg extract (consistency with borg create)
+- borg serve: overwrite client's --restrict-to-path with ssh forced command's
+  option value (but keep everything else from the client commandline), #544
+- use $XDG_CONFIG_HOME/keys for keyfile keys (~/.config/borg/keys), #515
+- "borg upgrade" moves the keyfile keys to the new location
+- display both archive creation start and end time in "borg info", #627
+
+
+Bug fixes:
+
+- normalize trailing slashes for the repository path, #606
+- Cache: fix exception handling in __init__, release lock, #610
+
+Other changes:
+
+- suppress unneeded exception context (PEP 409), simpler tracebacks
+- removed special code needed to deal with imperfections / incompatibilities /
+  missing stuff in py 3.2/3.3, simplify code that can be done simpler in 3.4
+- removed some version requirements that were kept on old versions because
+  newer did not support py 3.2 any more
+- use some py 3.4+ stdlib code instead of own/openssl/pypi code:
+
+  - use os.urandom instead of own cython openssl RAND_bytes wrapper, #493
+  - use hashlib.pbkdf2_hmac from py stdlib instead of own openssl wrapper
+  - use hmac.compare_digest instead of == operator (constant time comparison)
+  - use stat.filemode instead of homegrown code
+  - use "mock" library from stdlib, #145
+  - remove borg.support (with non-broken argparse copy), it is ok in 3.4+, #358
+- Vagrant: copy CHANGES.rst as symlink, #592
+- cosmetic code cleanups, add flake8 to tox/travis, #4
+- docs / help:
+
+  - make "borg -h" output prettier, #591
+  - slightly rephrase prune help
+  - add missing example for --list option of borg create
+  - quote exclude line that includes an asterisk to prevent shell expansion
+  - fix dead link to license
+  - delete Ubuntu Vivid, it is not supported anymore (EOL)
+  - OS X binary does not work for older OS X releases, #629
+  - borg serve's special support for forced/original ssh commands, #544
+  - misc. updates and fixes

docs/faq.rst

@@ -27,13 +27,7 @@ which is slower.
 Can I backup from multiple servers into a single repository?
 ------------------------------------------------------------
 
-Yes, this is *possible* from the technical standpoint, but it is
-*not recommended* from the security perspective. BorgBackup is
-built upon a defined :ref:`attack_model` that cannot provide its
-guarantees for multiple clients using the same repository. See
-:ref:`borg_security_critique` for a detailed explanation.
-
-Also, in order for the deduplication used by Borg to work, it
+In order for the deduplication used by Borg to work, it
 needs to keep a local cache containing checksums of all file
 chunks already stored in the repository. This cache is stored in
 ``~/.cache/borg/``.  If Borg detects that a repository has been
@@ -49,7 +43,7 @@ Can I back up to multiple, swapped backup targets?
 --------------------------------------------------
 
 It is possible to swap your backup disks if each backup medium is assigned its
-own repository by creating a new one with :ref:`borg_init`.
+own repository by creating a new one with :ref:`borg_rcreate`.
 
 Can I copy or synchronize my repo to another location?
 ------------------------------------------------------
@@ -57,8 +51,8 @@ Can I copy or synchronize my repo to another location?
 If you want to have redundant backup repositories (preferably at separate
 locations), the recommended way to do that is like this:
 
-- ``borg init repo1``
-- ``borg init repo2``
+- ``borg rcreate repo1``
+- ``borg rcreate repo2``
 - client machine ---borg create---> repo1
 - client machine ---borg create---> repo2
 
@@ -94,10 +88,6 @@ Also, you must not run borg against multiple instances of the same repo
   think they are identical and e.g. use the same local cache for them
   (which is an issue if they happen to be not the same).
   See :issue:`4272` for an example.
-- Encryption security issues if you would update repo and copy-of-repo
-  independently, due to AES counter reuse (when using legacy encryption modes).
-
-See also: :ref:`faq_corrupt_repo`
 
 "this is either an attack or unsafe" warning
 --------------------------------------------
@@ -118,9 +108,9 @@ you could delete the manifest-timestamp and the local cache:
 
 ::
 
-  borg config repo id   # shows the REPO_ID
+  borg config id   # shows the REPO_ID
   rm ~/.config/borg/security/REPO_ID/manifest-timestamp
-  borg delete --cache-only REPO
+  borg rdelete --cache-only
 
 This is an unsafe and unsupported way to use borg, you have been warned.
 
@@ -199,11 +189,6 @@ really desperate (e.g. if you have no completed backup of that file and you'ld
 rather get a partial file extracted than nothing). You do **not** want to give
 that option under any normal circumstances.
 
-Note that checkpoints inside files are created only since version 1.1, make
-sure you have an up-to-date version of borgbackup if you want to continue
-instead of retransferring a huge file. In some cases, there is only an outdated
-version shipped with your distribution (e.g. Debian). See :ref:`installation`.
-
 How can I backup huge file(s) over a unstable connection?
 ---------------------------------------------------------
 
@@ -241,32 +226,8 @@ then use ``tar`` to perform the comparison:
 
 ::
 
-    borg export-tar /path/to/repo::archive-name - | tar --compare -f - -C /path/to/compare/to
-
-
-.. _faq_corrupt_repo:
-
-My repository is corrupt, how can I restore from an older copy of it?
----------------------------------------------------------------------
-
-Note: this is only required for repos using legacy encryption modes.
-
-If your repositories are encrypted and have the same ID, the recommended method
-is to delete the corrupted repository, but keep its security info, and then copy
-the working repository to the same location:
-
-::
-
-    borg delete --keep-security-info /path/to/repo
-    rsync -aH /path/to/repo-working/ /path/to/repo  # Note the trailing slash.
+    borg export-tar archive-name - | tar --compare -f - -C /path/to/compare/to
 
-A plain delete command would remove the security info in
-``~/.config/borg/security``, including the nonce value. In BorgBackup
-:ref:`security_encryption` is AES-CTR, where the nonce is a counter. When the
-working repo was used later for creating new archives, Borg would re-use nonce
-values due to starting from a lower counter value given by the older copy of the
-repository. To prevent this, the ``keep-security-info`` option is applied so
-that the client-side nonce counter is kept.
 
 Can Borg add redundancy to the backup data to deal with hardware malfunction?
 -----------------------------------------------------------------------------
@@ -296,7 +257,7 @@ SMR (shingled magnetic recording) hard drives are very different from
 regular hard drives. Applications have to behave in certain ways or
 performance will be heavily degraded.
 
-Borg 1.1 ships with default settings suitable for SMR drives,
+Borg ships with default settings suitable for SMR drives,
 and has been successfully tested on *Seagate Archive v2* drives
 using the ext4 file system.
 
@@ -436,16 +397,16 @@ Say you want to prune ``/var/log`` faster than the rest of
 archive *names* and then implement different prune policies for
 different prefixes. For example, you could have a script that does::
 
-    borg create --exclude var/log $REPOSITORY:main-$(date +%Y-%m-%d) /
-    borg create $REPOSITORY:logs-$(date +%Y-%m-%d) /var/log
+    borg create --exclude var/log main-$(date +%Y-%m-%d) /
+    borg create logs-$(date +%Y-%m-%d) /var/log
 
 Then you would have two different prune calls with different policies::
 
-    borg prune --verbose --list -d 30 --prefix main- "$REPOSITORY"
-    borg prune --verbose --list -d 7  --prefix logs- "$REPOSITORY"
+    borg prune --verbose --list -d 30 --prefix main-
+    borg prune --verbose --list -d 7  --prefix logs-
 
-This will keep 7 days of logs and 30 days of everything else. Borg 1.1
-also supports the ``--glob-archives`` parameter.
+This will keep 7 days of logs and 30 days of everything else.
+Borg also supports the ``--glob-archives`` parameter.
 
 How do I remove files from an existing backup?
 ----------------------------------------------
@@ -476,37 +437,6 @@ to change them.
 Security
 ########
 
-.. _borg_security_critique:
-
-Isn't BorgBackup's legacy AES-CTR-based crypto broken?
-------------------------------------------------------
-
-Note: in borg 1.3 new AEAD cipher based modes with session keys were added,
-solving the issues of the legacy modes.
-
-If a nonce (counter) value is reused, AES-CTR mode crypto is broken.
-
-To exploit the AES counter management issue, an attacker would need to have
-access to the borg repository.
-
-By tampering with the repo, the attacker could bring the repo into a state so
-that it reports a lower "highest used counter value" than the one that actually
-was used. The client would usually notice that, because it rather trusts the
-clientside stored "highest used counter value" than trusting the server.
-
-But there are situations, where this is simply not possible:
-
-- If clients A and B used the repo, the client A can only know its own highest
-  CTR value, but not the one produced by B. That is only known to (B and) the
-  server (the repo) and thus the client A needs to trust the server about the
-  value produced by B in that situation. You can't do much about this except
-  not having multiple clients per repo.
-
-- Even if there is only one client, if client-side information is completely
-  lost (e.g. due to disk defect), the client also needs to trust the value from
-  server side. You can avoid this by not continuing to write to the repository
-  after you have lost clientside borg information.
-
 .. _home_config_borg:
 
 How important is the $HOME/.config/borg directory?
@@ -583,7 +513,7 @@ Using ``BORG_PASSCOMMAND`` with a properly permissioned file
 Using keyfile-based encryption with a blank passphrase
   It is possible to encrypt your repository in ``keyfile`` mode instead of the default
   ``repokey`` mode and use a blank passphrase for the key file (simply press Enter twice
-  when ``borg init`` asks for the password). See :ref:`encrypted_repos`
+  when ``borg rcreate`` asks for the password). See :ref:`encrypted_repos`
   for more details.
 
 Using ``BORG_PASSCOMMAND`` with macOS Keychain
@@ -717,34 +647,6 @@ Send a private email to the :ref:`security contact <security-contact>`
 if you think you have discovered a security issue.
 Please disclose security issues responsibly.
 
-How important are the nonce files?
-------------------------------------
-
-This only applies to repositories using legacy encryption modes.
-
-Borg uses :ref:`AES-CTR encryption <borg_security_critique>`. An
-essential part of AES-CTR is a sequential counter that must **never**
-repeat. If the same value of the counter is used twice in the same repository,
-an attacker can decrypt the data. The counter is stored in the home directory
-of each user ($HOME/.config/borg/security/$REPO_ID/nonce) as well as
-in the repository (/path/to/repo/nonce). When creating a new archive borg uses
-the highest of the two values. The value of the counter in the repository may be
-higher than your local value if another user has created an archive more recently
-than you did.
-
-Since the nonce is not necessary to read the data that is already encrypted,
-``borg info``, ``borg list``, ``borg extract`` and ``borg mount`` should work
-just fine without it.
-
-If the nonce file stored in the repo is lost, but you still have your local copy,
-borg will recreate the repository nonce file the next time you run ``borg create``.
-This should be safe for repositories that are only used from one user account
-on one machine.
-
-For repositories that are used by multiple users and/or from multiple machines
-it is safest to avoid running *any* commands that modify the repository after
-the nonce is deleted or if you suspect it may have been tampered with. See :ref:`attack_model`.
-
 Common issues
 #############
 
@@ -789,9 +691,9 @@ How can I deal with my very unstable SSH connection?
 If you have issues with lost connections during long-running borg commands, you
 could try to work around:
 
-- Make partial extracts like ``borg extract REPO PATTERN`` to do multiple
+- Make partial extracts like ``borg extract PATTERN`` to do multiple
   smaller extraction runs that complete before your connection has issues.
-- Try using ``borg mount REPO MOUNTPOINT`` and ``rsync -avH`` from
+- Try using ``borg mount MOUNTPOINT`` and ``rsync -avH`` from
   ``MOUNTPOINT`` to your desired extraction directory. If the connection breaks
   down, just repeat that over and over again until rsync does not find anything
   to do any more. Due to the way borg mount works, this might be less efficient
@@ -846,7 +748,7 @@ space for chunks.archive.d (see :issue:`235` for details):
 ::
 
     # this assumes you are working with the same user as the backup.
-    cd ~/.cache/borg/$(borg config /path/to/repo id)
+    cd ~/.cache/borg/$(borg config id)
     rm -rf chunks.archive.d ; touch chunks.archive.d
 
 This deletes all the cached archive chunk indexes and replaces the directory
@@ -1151,7 +1053,7 @@ To achieve this, run ``borg create`` within the mountpoint/snapshot directory:
 
     # Example: Some file system mounted in /mnt/rootfs.
     cd /mnt/rootfs
-    borg create /path/to/repo::rootfs_backup .
+    borg create rootfs_backup .
 
 
 I am having troubles with some network/FUSE/special filesystem, why?
@@ -1240,7 +1142,7 @@ This can happen for CIFS- or FUSE shares. If you are sure that your target volum
 will always have enough disk space, you can use the following workaround to disable
 checking for free disk space::
 
-    borg config -- $REPO_LOCATION additional_free_space -2T
+    borg config -- additional_free_space -2T
 
 How do I rename a repository?
 -----------------------------
@@ -1279,112 +1181,3 @@ libraries are actually loaded and used.
 In the borg git repository, there is scripts/glibc_check.py that can determine
 (based on the symbols' versions they want to link to) whether a set of given
 (Linux) binaries works with a given glibc version.
-
-
-Why was Borg forked from Attic?
--------------------------------
-
-Borg was created in May 2015 in response to the difficulty of getting new
-code or larger changes incorporated into Attic and establishing a bigger
-developer community / more open development.
-
-More details can be found in `ticket 217
-<https://github.com/jborg/attic/issues/217>`_ that led to the fork.
-
-Borg intends to be:
-
-* simple:
-
-  * as simple as possible, but no simpler
-  * do the right thing by default, but offer options
-* open:
-
-  * welcome feature requests
-  * accept pull requests of good quality and coding style
-  * give feedback on PRs that can't be accepted "as is"
-  * discuss openly, don't work in the dark
-* changing:
-
-  * Borg is not compatible with Attic
-  * do not break compatibility accidentally, without a good reason
-    or without warning. allow compatibility breaking for other cases.
-  * if major version number changes, it may have incompatible changes
-
-Migrating from Attic
-####################
-
-What are the differences between Attic and Borg?
-------------------------------------------------
-
-Borg is a fork of `Attic`_ and maintained by "`The Borg collective`_".
-
-.. _Attic: https://github.com/jborg/attic
-.. _The Borg collective: https://borgbackup.readthedocs.org/en/latest/authors.html
-
-Here's a (incomplete) list of some major changes:
-
-* lots of attic issues fixed
-  (see `issue #5 <https://github.com/borgbackup/borg/issues/5>`_),
-  including critical data corruption bugs and security issues.
-* more open, faster paced development
-  (see `issue #1 <https://github.com/borgbackup/borg/issues/1>`_)
-* less chunk management overhead (less memory and disk usage for chunks index)
-* faster remote cache resync (useful when backing up multiple machines into same repo)
-* compression: no, lz4, zstd, zlib or lzma compression, adjustable compression levels
-* repokey replaces problematic passphrase mode (you can't change the passphrase
-  nor the pbkdf2 iteration count in "passphrase" mode)
-* simple sparse file support, great for virtual machine disk files
-* can read special files (e.g. block devices) or from stdin, write to stdout
-* rename-based locking is more compatible than attic's posix locking
-* uses fadvise to not spoil / blow up the fs cache
-* better error messages / exception handling
-* better logging, screen output, progress indication
-* tested on misc. Linux systems, 32 and 64bit, FreeBSD, OpenBSD, NetBSD, macOS
-
-Please read the :ref:`changelog` (or ``docs/changes.rst`` in the source distribution) for more
-information.
-
-Borg is not compatible with original Attic (but there is a one-way conversion).
-
-How do I migrate from Attic to Borg?
-------------------------------------
-
-Use :ref:`borg_upgrade`. This is a one-way process that cannot be reversed.
-
-There are some caveats:
-
-- The upgrade can only be performed on local repositories.
-  It cannot be performed on remote repositories.
-
-- If the repository is in "keyfile" encryption mode, the keyfile must
-  exist locally or it must be manually moved after performing the upgrade:
-
-  1. Get the repository ID with ``borg config /path/to/repo id``.
-  2. Locate the attic key file at ``~/.attic/keys/``. The correct key for the
-     repository starts with the line ``ATTIC_KEY <repository id>``.
-  3. Copy the attic key file to ``~/.config/borg/keys/``
-  4. Change the first line from ``ATTIC_KEY ...`` to ``BORG_KEY ...``.
-  5. Verify that the repository is now accessible (e.g. ``borg list <repository>``).
-- Attic and Borg use different :ref:`"chunker params" <chunker-params>`.
-  This means that data added by Borg won't deduplicate with the existing data
-  stored by Attic. The effect is lessened if the files cache is used with Borg.
-- Repositories in "passphrase" mode *must* be migrated to "repokey" mode using
-  "borg key migrate-to-repokey" (only available in borg <= 1.2.x). Borg does not
-  support the "passphrase" mode in any other way.
-
-Why is my backup bigger than with attic?
-----------------------------------------
-
-Attic was rather unflexible when it comes to compression, it always
-compressed using zlib level 6 (no way to switch compression off or
-adjust the level or algorithm).
-
-The default in Borg is lz4, which is fast enough to not use significant CPU time
-in most cases, but can only achieve modest compression. It still compresses
-easily compressed data fairly well.
-
-Borg also offers zstd, zlib and lzma compression, choose wisely.
-
-Which choice is the best option depends on a number of factors, like
-bandwidth to the repository, how well the data compresses, available CPU
-power and so on.

docs/index.rst

@@ -18,6 +18,8 @@ Borg Documentation
    faq
    support
    changes
+   changes_1.x
+   changes_0.x
    internals
    development
    authors

docs/installation.rst

@@ -177,8 +177,8 @@ following dependencies first:
 * optionally, if you wish to mount an archive as a FUSE filesystem, you need
   a FUSE implementation for Python:
 
-  - Either pyfuse3_ (preferably, newer and maintained) or llfuse_ (older,
-    unmaintained now). See also the BORG_FUSE_IMPL env variable.
+  - Either pyfuse3_ (preferably, newer) or llfuse_ (older).
+    See also the BORG_FUSE_IMPL env variable.
   - See setup.py about the version requirements.
 
 If you have troubles finding the right package names, have a look at the

docs/internals/data-structures.rst

@@ -79,7 +79,7 @@ Normally the keys are computed like this::
 
   key = id = id_hash(unencrypted_data)
 
-The id_hash function depends on the :ref:`encryption mode <borg_init>`.
+The id_hash function depends on the :ref:`encryption mode <borg_rcreate>`.
 
 As the id / key is used for deduplication, id_hash must be a cryptographically
 strong hash or MAC.
@@ -736,7 +736,6 @@ The chunks cache is a key -> value mapping and contains:
 
   - reference count
   - size
-  - encrypted/compressed size
 
 The chunks cache is a HashIndex_. Due to some restrictions of HashIndex,
 the reference count of each given chunk is limited to a constant, MAX_VALUE
@@ -754,9 +753,9 @@ Here is the estimated memory usage of Borg - it's complicated::
   chunk_size ~= 2 ^ HASH_MASK_BITS  (for buzhash chunker, BLOCK_SIZE for fixed chunker)
   chunk_count ~= total_file_size / chunk_size
 
-  repo_index_usage = chunk_count * 40
+  repo_index_usage = chunk_count * 48
 
-  chunks_cache_usage = chunk_count * 44
+  chunks_cache_usage = chunk_count * 40
 
   files_cache_usage = total_file_count * 240 + chunk_count * 80
 

docs/internals/frontends.rst

@@ -208,7 +208,7 @@ Passphrase prompts should be handled differently. Use the environment variables
 and *BORG_NEW_PASSPHRASE* (see :ref:`env_vars` for reference) to pass passphrases to Borg, don't
 use the interactive passphrase prompts.
 
-When setting a new passphrase (:ref:`borg_init`, :ref:`borg_key_change-passphrase`) normally
+When setting a new passphrase (:ref:`borg_rcreate`, :ref:`borg_key_change-passphrase`) normally
 Borg prompts whether it should display the passphrase. This can be suppressed by setting
 the environment variable *BORG_DISPLAY_PASSPHRASE* to *no*.
 
@@ -252,7 +252,7 @@ last_modified
 The *encryption* key, if present, contains:
 
 mode
-    Textual encryption mode name (same as :ref:`borg_init` ``--encryption`` names)
+    Textual encryption mode name (same as :ref:`borg_rcreate` ``--encryption`` names)
 keyfile
     Path to the local key file used for access. Depending on *mode* this key may be absent.
 

docs/internals/security.rst

@@ -38,9 +38,6 @@ Under these circumstances Borg guarantees that the attacker cannot
 The attacker can always impose a denial of service per definition (he could
 forbid connections to the repository, or delete it entirely).
 
-When the above attack model is extended to include multiple clients
-independently updating the same repository, then Borg fails to provide
-confidentiality (i.e. guarantees 3) and 4) do not apply any more).
 
 .. _security_structural_auth:
 
@@ -78,7 +75,7 @@ the root node of a DAG through its edges, since the root node has no incoming ed
 
 With the scheme as described so far an attacker could easily replace the manifest,
 therefore Borg includes a tertiary authentication mechanism (TAM) that is applied
-to the manifest since version 1.0.9 (see :ref:`tam_vuln`).
+to the manifest (see :ref:`tam_vuln`).
 
 TAM works by deriving a separate key through HKDF_ from the other encryption and
 authentication keys and calculating the HMAC of the metadata to authenticate [#]_::
@@ -129,12 +126,12 @@ AEAD modes
 
 Modes: --encryption (repokey|keyfile)-[blake2-](aes-ocb|chacha20-poly1305)
 
-Supported: borg 1.3+
+Supported: borg 2.0+
 
 Encryption with these modes is based on AEAD ciphers (authenticated encryption
 with associated data) and session keys.
 
-Depending on the chosen mode (see :ref:`borg_init`) different AEAD ciphers are used:
+Depending on the chosen mode (see :ref:`borg_rcreate`) different AEAD ciphers are used:
 
 - AES-256-OCB - super fast, single-pass algorithm IF you have hw accelerated AES.
 - chacha20-poly1305 - very fast, purely software based AEAD cipher.
@@ -201,106 +198,13 @@ Legacy modes
 
 Modes: --encryption (repokey|keyfile)-[blake2]
 
-Supported: all borg versions, blake2 since 1.1
+Supported: borg < 2.0
 
-DEPRECATED. We strongly suggest you use the safer AEAD modes, see above.
+These were the AES-CTR based modes in previous borg versions.
 
-Encryption with these modes is based on the Encrypt-then-MAC construction,
-which is generally seen as the most robust way to create an authenticated
-encryption scheme from encryption and message authentication primitives.
+borg 2.0 does not support creating new repos using these modes,
+but ``borg transfer`` can still read such existing repos.
 
-Every operation (encryption, MAC / authentication, chunk ID derivation)
-uses independent, random keys generated by `os.urandom`_.
-
-Borg does not support unauthenticated encryption -- only authenticated encryption
-schemes are supported. No unauthenticated encryption schemes will be added
-in the future.
-
-Depending on the chosen mode (see :ref:`borg_init`) different primitives are used:
-
-- Legacy encryption modes use AES-256 in CTR mode. The
-  counter is added in plaintext, since it is needed for decryption,
-  and is also tracked locally on the client to avoid counter reuse.
-
-- The authentication primitive is either HMAC-SHA-256 or BLAKE2b-256
-  in a keyed mode. 
-
-  Both HMAC-SHA-256 and BLAKE2b have undergone extensive cryptanalysis  
-  and have proven secure against known attacks. The known vulnerability
-  of SHA-256 against length extension attacks does not apply to HMAC-SHA-256.
-  
-  The authentication primitive should be chosen based upon SHA hardware support.
-  With SHA hardware support, hmac-sha256 is likely to be much faster. 
-  If no hardware support is provided, Blake2b-256 will outperform hmac-sha256.
-  To find out if you have SHA hardware support, use::
-
-  $ borg benchmark cpu
-
-  The output will include an evaluation of cryptographic hashes/MACs like::
-
-  Cryptographic hashes / MACs ====================================
-  hmac-sha256              1GB        0.436s
-  blake2b-256              1GB        1.579s
-
-  Based upon your output, choose the primitive that is faster (in the above
-  example, hmac-sha256 is much faster, which indicates SHA hardware support).
-
-- The primitive used for authentication is always the same primitive
-  that is used for deriving the chunk ID, but they are always
-  used with independent keys.
-
-Encryption::
-
-    id = AUTHENTICATOR(id_key, data)
-    compressed = compress(data)
-
-    iv = reserve_iv()
-    encrypted = AES-256-CTR(enc_key, 8-null-bytes || iv, compressed)
-    authenticated = type-byte || AUTHENTICATOR(enc_hmac_key, encrypted) || iv || encrypted
-
-
-Decryption::
-
-    # Given: input *authenticated* data, possibly a *chunk-id* to assert
-    type-byte, mac, iv, encrypted = SPLIT(authenticated)
-
-    ASSERT(type-byte is correct)
-    ASSERT( CONSTANT-TIME-COMPARISON( mac, AUTHENTICATOR(enc_hmac_key, encrypted) ) )
-
-    decrypted = AES-256-CTR(enc_key, 8-null-bytes || iv, encrypted)
-    decompressed = decompress(decrypted)
-
-    ASSERT( CONSTANT-TIME-COMPARISON( chunk-id, AUTHENTICATOR(id_key, decompressed) ) )
-
-The client needs to track which counter values have been used, since
-encrypting a chunk requires a starting counter value and no two chunks
-may have overlapping counter ranges (otherwise the bitwise XOR of the
-overlapping plaintexts is revealed).
-
-The client does not directly track the counter value, because it
-changes often (with each encrypted chunk), instead it commits a
-"reservation" to the security database and the repository by taking
-the current counter value and adding 4 GiB / 16 bytes (the block size)
-to the counter. Thus the client only needs to commit a new reservation
-every few gigabytes of encrypted data.
-
-This mechanism also avoids reusing counter values in case the client
-crashes or the connection to the repository is severed, since any
-reservation would have been committed to both the security database
-and the repository before any data is encrypted. Borg uses its
-standard mechanism (SaveFile) to ensure that reservations are durable
-(on most hardware / storage systems), therefore a crash of the
-client's host would not impact tracking of reservations.
-
-However, this design is not infallible, and requires synchronization
-between clients, which is handled through the repository. Therefore in
-a multiple-client scenario a repository can trick a client into
-reusing counter values by ignoring counter reservations and replaying
-the manifest (which will fail if the client has seen a more recent
-manifest or has a more recent nonce reservation). If the repository is
-untrusted, but a trusted synchronization channel exists between
-clients, the security database could be synchronized between them over
-said trusted channel. This is not part of Borg's functionality.
 
 .. _key_encryption:
 
@@ -468,13 +372,12 @@ Compression and Encryption
 
 Combining encryption with compression can be insecure in some contexts (e.g. online protocols).
 
-There was some discussion about this in `github issue #1040`_ and for Borg some developers
+There was some discussion about this in :issue:`1040` and for Borg some developers
 concluded this is no problem at all, some concluded this is hard and extremely slow to exploit
 and thus no problem in practice.
 
 No matter what, there is always the option not to use compression if you are worried about this.
 
-.. _github issue #1040: https://github.com/borgbackup/borg/issues/1040
 
 Fingerprinting
 ==============
@@ -490,7 +393,7 @@ output of the chunker. The sizes of these stored chunks are influenced by the
 compression, encryption and authentication.
 
 buzhash chunker
-+++++++++++++++
+~~~~~~~~~~~~~~~
 
 The buzhash chunker chunks according to the input data, the chunker's
 parameters and the secret chunker seed (which all influence the chunk boundary
@@ -501,7 +404,7 @@ chunk (identical content / size as the original file), bigger files result in
 multiple chunks.
 
 fixed chunker
-+++++++++++++
+~~~~~~~~~~~~~
 
 This chunker yields fixed sized chunks, with optional support of a differently
 sized header chunk. The last chunk is not required to have the full block size

docs/man/borg-benchmark-cpu.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BENCHMARK-CPU 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark-cpu \- Benchmark CPU bound operations.
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-benchmark-cpu \- Benchmark CPU bound operations.
 .SH SYNOPSIS
 .sp
 borg [common options] benchmark cpu [options]
@@ -39,8 +39,12 @@ This command benchmarks misc. CPU bound borg operations.
 .sp
 It creates input data in memory, runs the operation and then displays throughput.
 To reduce outside influence on the timings, please make sure to run this with:
-\- an otherwise as idle as possible machine
-\- enough free memory so there will be no slow down due to paging activity
+.INDENT 0.0
+.IP \(bu 2
+an otherwise as idle as possible machine
+.IP \(bu 2
+enough free memory so there will be no slow down due to paging activity
+.UNINDENT
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.

docs/man/borg-benchmark-crud.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BENCHMARK-CRUD 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-benchmark-crud \- Benchmark Create, Read, Update, Delete for archives.
 .SH SYNOPSIS
 .sp
-borg [common options] benchmark crud [options] REPOSITORY PATH
+borg [common options] benchmark crud [options] PATH
 .SH DESCRIPTION
 .sp
 This command benchmarks borg CRUD (create, read, update, delete) operations.
@@ -88,9 +88,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY
-repository to use for benchmark (must exist)
-.TP
 .B PATH
 path were to create benchmark input data
 .UNINDENT

docs/man/borg-benchmark.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BENCHMARK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-benchmark \- benchmark command
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-benchmark \- benchmark command
 .SH SYNOPSIS
 .nf
 borg [common options] benchmark crud ...

docs/man/borg-break-lock.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-BREAK-LOCK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-break-lock \- Break the repository lock (e.g. in case it was left by a dead borg.
 .SH SYNOPSIS
 .sp
-borg [common options] break\-lock [options] [REPOSITORY]
+borg [common options] break\-lock [options]
 .SH DESCRIPTION
 .sp
 This command breaks the repository and cache locks.
@@ -41,12 +41,6 @@ trying to access the Cache or the Repository.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository for which to break the locks
-.UNINDENT
 .SH SEE ALSO
 .sp
 \fIborg\-common(1)\fP

docs/man/borg-check.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CHECK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-check \- Check repository consistency
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-check \- Check repository consistency
 .SH SYNOPSIS
 .sp
-borg [common options] check [options] [REPOSITORY_OR_ARCHIVE]
+borg [common options] check [options]
 .SH DESCRIPTION
 .sp
 The check command verifies the consistency of a repository and the corresponding archives.
@@ -126,28 +126,25 @@ slow.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to check consistency of
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-repository\-only
+.BI \-\-name \ NAME
+specify the archive name
+.TP
+.B  \-\-repository\-only
 only perform repository checks
 .TP
-.B \-\-archives\-only
+.B  \-\-archives\-only
 only perform archives checks
 .TP
-.B \-\-verify\-data
+.B  \-\-verify\-data
 perform cryptographic archive data integrity verification (conflicts with \fB\-\-repository\-only\fP)
 .TP
-.B \-\-repair
+.B  \-\-repair
 attempt to repair any inconsistencies found
 .TP
-.B \-\-save\-space
+.B  \-\-save\-space
 work slower, but using less space
 .TP
 .BI \-\-max\-duration \ SECONDS

docs/man/borg-common.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-COMMON 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-common \- Common options of Borg commands
 .
 .nr rst2man-indent-level 0
 .
@@ -30,49 +27,52 @@ 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"
+.SH NAME
+borg-common \- Common options of Borg commands
 .SH SYNOPSIS
 .INDENT 0.0
 .TP
-.B \-h\fP,\fB  \-\-help
+.B  \-h\fP,\fB  \-\-help
 show this help message and exit
 .TP
-.B \-\-critical
+.B  \-\-critical
 work on log level CRITICAL
 .TP
-.B \-\-error
+.B  \-\-error
 work on log level ERROR
 .TP
-.B \-\-warning
+.B  \-\-warning
 work on log level WARNING (default)
 .TP
-.B \-\-info\fP,\fB  \-v\fP,\fB  \-\-verbose
+.B  \-\-info\fP,\fB  \-v\fP,\fB  \-\-verbose
 work on log level INFO
 .TP
-.B \-\-debug
+.B  \-\-debug
 enable debug output, work on log level DEBUG
 .TP
 .BI \-\-debug\-topic \ TOPIC
 enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
 .TP
-.B \-p\fP,\fB  \-\-progress
+.B  \-p\fP,\fB  \-\-progress
 show progress information
 .TP
-.B \-\-iec
+.B  \-\-iec
 format using IEC units (1KiB = 1024B)
 .TP
-.B \-\-log\-json
+.B  \-\-log\-json
 Output one JSON object per log line instead of formatted text.
 .TP
 .BI \-\-lock\-wait \ SECONDS
 wait at most SECONDS for acquiring a repository/cache lock (default: 1).
 .TP
-.B \-\-bypass\-lock
+.B  \-\-bypass\-lock
 Bypass locking mechanism
 .TP
-.B \-\-show\-version
+.B  \-\-show\-version
 show/log the borg version
 .TP
-.B \-\-show\-rc
+.B  \-\-show\-rc
 show/log the return code (rc)
 .TP
 .BI \-\-umask \ M
@@ -93,7 +93,7 @@ deprecated, use \fB\-\-upload\-buffer\fP instead
 .BI \-\-upload\-buffer \ UPLOAD_BUFFER
 set network upload buffer size in MiB. (default: 0=no buffer)
 .TP
-.B \-\-consider\-part\-files
+.B  \-\-consider\-part\-files
 treat part files like normal files (e.g. to list/extract them)
 .TP
 .BI \-\-debug\-profile \ FILE
@@ -101,6 +101,9 @@ Write execution profile in Borg format into FILE. For local use a Python\-compat
 .TP
 .BI \-\-rsh \ RSH
 Use this command to connect to the \(aqborg serve\(aq process (default: \(aqssh\(aq)
+.TP
+.BI \-r \ REPO\fR,\fB \ \-\-repo \ REPO
+repository to use
 .UNINDENT
 .SH SEE ALSO
 .sp

docs/man/borg-compact.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-COMPACT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-compact \- compact segment files in the repository
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-compact \- compact segment files in the repository
 .SH SYNOPSIS
 .sp
-borg [common options] compact [options] [REPOSITORY]
+borg [common options] compact [options]
 .SH DESCRIPTION
 .sp
 This command frees repository space by compacting segments.
@@ -60,16 +60,10 @@ See \fIseparate_compaction\fP in Additional Notes for more details.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository to compact
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-cleanup\-commits
+.B  \-\-cleanup\-commits
 cleanup commit\-only 17\-byte segment files
 .TP
 .BI \-\-threshold \ PERCENT
@@ -82,10 +76,7 @@ set minimum threshold for saved space in PERCENT (Default: 10)
 .nf
 .ft C
 # compact segments and free repo disk space
-$ borg compact /path/to/repo
-
-# same as above plus clean up 17byte commit\-only segments
-$ borg compact \-\-cleanup\-commits /path/to/repo
+$ borg compact
 .ft P
 .fi
 .UNINDENT

docs/man/borg-compression.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-COMPRESSION 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-compression \- Details regarding compression
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-compression \- Details regarding compression
 .SH DESCRIPTION
 .sp
 It is no problem to mix different compression methods in one repo,

docs/man/borg-config.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CONFIG 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-config \- get, set, and delete values in a repository or cache config file
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-config \- get, set, and delete values in a repository or cache config file
 .SH SYNOPSIS
 .sp
-borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
+borg [common options] config [options] [NAME] [VALUE]
 .SH DESCRIPTION
 .sp
 This command gets and sets options in a local repository or cache config file.
@@ -53,9 +53,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY
-repository to configure
-.TP
 .B NAME
 name of config key
 .TP
@@ -65,13 +62,13 @@ new value for key
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-c\fP,\fB  \-\-cache
+.B  \-c\fP,\fB  \-\-cache
 get and set values from the repo cache
 .TP
-.B \-d\fP,\fB  \-\-delete
+.B  \-d\fP,\fB  \-\-delete
 delete the key from the config file
 .TP
-.B \-l\fP,\fB  \-\-list
+.B  \-l\fP,\fB  \-\-list
 list the configuration of the repo
 .UNINDENT
 .SH EXAMPLES
@@ -90,13 +87,13 @@ making changes!
 .nf
 .ft C
 # find cache directory
-$ cd ~/.cache/borg/$(borg config /path/to/repo id)
+$ cd ~/.cache/borg/$(borg config id)
 
 # reserve some space
-$ borg config /path/to/repo additional_free_space 2G
+$ borg config additional_free_space 2G
 
 # make a repo append\-only
-$ borg config /path/to/repo append_only 1
+$ borg config append_only 1
 .ft P
 .fi
 .UNINDENT

docs/man/borg-create.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-CREATE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-create \- Create new archive
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-create \- Create new archive
 .SH SYNOPSIS
 .sp
-borg [common options] create [options] ARCHIVE [PATH...]
+borg [common options] create [options] NAME [PATH...]
 .SH DESCRIPTION
 .sp
 This command creates a backup archive containing all files found while recursively
@@ -126,8 +126,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B ARCHIVE
-name of archive to create (must be also a valid directory name)
+.B NAME
+specify the archive name
 .TP
 .B PATH
 paths to archive
@@ -135,22 +135,22 @@ paths to archive
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not create a backup archive
 .TP
-.B \-s\fP,\fB  \-\-stats
+.B  \-s\fP,\fB  \-\-stats
 print statistics for the created archive
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of items (files, dirs, ...)
 .TP
 .BI \-\-filter \ STATUSCHARS
 only display items with the given status characters (see description)
 .TP
-.B \-\-json
+.B  \-\-json
 output stats as JSON. Implies \fB\-\-stats\fP\&.
 .TP
-.B \-\-no\-cache\-sync
+.B  \-\-no\-cache\-sync
 experimental: do not synchronize the cache. Implies not using the files cache.
 .TP
 .BI \-\-stdin\-name \ NAME
@@ -160,18 +160,18 @@ use NAME in archive for stdin data (default: \(aqstdin\(aq)
 set user USER in archive for stdin data (default: \(aqroot\(aq)
 .TP
 .BI \-\-stdin\-group \ GROUP
-set group GROUP in archive for stdin data (default: \(aqroot\(aq)
+set group GROUP in archive for stdin data (default: \(aqwheel\(aq)
 .TP
 .BI \-\-stdin\-mode \ M
 set mode to M in archive for stdin data (default: 0660)
 .TP
-.B \-\-content\-from\-command
+.B  \-\-content\-from\-command
 interpret PATH as command and store its stdout. See also section Reading from stdin below.
 .TP
-.B \-\-paths\-from\-stdin
+.B  \-\-paths\-from\-stdin
 read DELIM\-separated list of paths to backup from stdin. Will not recurse into directories.
 .TP
-.B \-\-paths\-from\-command
+.B  \-\-paths\-from\-command
 interpret PATH as command and treat its output as \fB\-\-paths\-from\-stdin\fP
 .TP
 .BI \-\-paths\-delimiter \ DELIM
@@ -192,61 +192,61 @@ include/exclude paths matching PATTERN
 .BI \-\-patterns\-from \ PATTERNFILE
 read include/exclude patterns from PATTERNFILE, one per line
 .TP
-.B \-\-exclude\-caches
+.B  \-\-exclude\-caches
 exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP)
 .TP
 .BI \-\-exclude\-if\-present \ NAME
 exclude directories that are tagged by containing a filesystem object with the given NAME
 .TP
-.B \-\-keep\-exclude\-tags
+.B  \-\-keep\-exclude\-tags
 if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
 .TP
-.B \-\-exclude\-nodump
+.B  \-\-exclude\-nodump
 exclude files flagged NODUMP
 .UNINDENT
 .SS Filesystem options
 .INDENT 0.0
 .TP
-.B \-x\fP,\fB  \-\-one\-file\-system
+.B  \-x\fP,\fB  \-\-one\-file\-system
 stay in the same file system and do not store mount points of other file systems.  This might behave different from your expectations, see the docs.
 .TP
-.B \-\-numeric\-owner
+.B  \-\-numeric\-owner
 deprecated, use \fB\-\-numeric\-ids\fP instead
 .TP
-.B \-\-numeric\-ids
+.B  \-\-numeric\-ids
 only store numeric user and group identifiers
 .TP
-.B \-\-noatime
+.B  \-\-noatime
 do not store atime into archive
 .TP
-.B \-\-atime
+.B  \-\-atime
 do store atime into archive
 .TP
-.B \-\-noctime
+.B  \-\-noctime
 do not store ctime into archive
 .TP
-.B \-\-nobirthtime
+.B  \-\-nobirthtime
 do not store birthtime (creation date) into archive
 .TP
-.B \-\-nobsdflags
+.B  \-\-nobsdflags
 deprecated, use \fB\-\-noflags\fP instead
 .TP
-.B \-\-noflags
+.B  \-\-noflags
 do not read and store flags (e.g. NODUMP, IMMUTABLE) into archive
 .TP
-.B \-\-noacls
+.B  \-\-noacls
 do not read and store ACLs into archive
 .TP
-.B \-\-noxattrs
+.B  \-\-noxattrs
 do not read and store xattrs into archive
 .TP
-.B \-\-sparse
+.B  \-\-sparse
 detect sparse holes in input (supported only by fixed chunker)
 .TP
 .BI \-\-files\-cache \ MODE
 operate files cache in MODE. default: ctime,size,inode
 .TP
-.B \-\-read\-special
+.B  \-\-read\-special
 open and read block and char device files as well as FIFOs as if they were regular files. Also follows symlinks pointing to these kinds of files.
 .UNINDENT
 .SS Archive options
@@ -274,86 +274,84 @@ select compression algorithm, see the output of the "borg help compression" comm
 .nf
 .ft C
 # Backup ~/Documents into an archive named "my\-documents"
-$ borg create /path/to/repo::my\-documents ~/Documents
+$ borg create my\-documents ~/Documents
 
 # same, but list all files as we process them
-$ borg create \-\-list /path/to/repo::my\-documents ~/Documents
+$ borg create \-\-list my\-documents ~/Documents
 
 # Backup ~/Documents and ~/src but exclude pyc files
-$ borg create /path/to/repo::my\-files \e
+$ borg create my\-files                \e
     ~/Documents                       \e
     ~/src                             \e
     \-\-exclude \(aq*.pyc\(aq
 
 # Backup home directories excluding image thumbnails (i.e. only
 # /home/<one directory>/.thumbnails is excluded, not /home/*/*/.thumbnails etc.)
-$ borg create /path/to/repo::my\-files /home \e
-    \-\-exclude \(aqsh:/home/*/.thumbnails\(aq
+$ borg create my\-files /home \-\-exclude \(aqsh:home/*/.thumbnails\(aq
 
 # Backup the root filesystem into an archive named "root\-YYYY\-MM\-DD"
 # use zlib compression (good, but slow) \- default is lz4 (fast, low compression ratio)
-$ borg create \-C zlib,6 \-\-one\-file\-system /path/to/repo::root\-{now:%Y\-%m\-%d} /
+$ borg create \-C zlib,6 \-\-one\-file\-system root\-{now:%Y\-%m\-%d} /
 
-# Backup onto a remote host ("push" style) via ssh to port 2222,
-# logging in as user "borg" and storing into /path/to/repo
-$ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}\-root\-{now} /
+# Backup into an archive name like FQDN\-root\-TIMESTAMP
+$ borg create \(aq{fqdn}\-root\-{now}\(aq /
 
 # Backup a remote host locally ("pull" style) using sshfs
 $ mkdir sshfs\-mount
 $ sshfs root@example.com:/ sshfs\-mount
 $ cd sshfs\-mount
-$ borg create /path/to/repo::example.com\-root\-{now:%Y\-%m\-%d} .
+$ borg create example.com\-root\-{now:%Y\-%m\-%d} .
 $ cd ..
 $ fusermount \-u sshfs\-mount
 
 # Make a big effort in fine granular deduplication (big chunk management
 # overhead, needs a lot of RAM and disk space, see formula in internals
 # docs \- same parameters as borg < 1.0 or attic):
-$ borg create \-\-chunker\-params buzhash,10,23,16,4095 /path/to/repo::small /smallstuff
+$ borg create \-\-chunker\-params buzhash,10,23,16,4095 small /smallstuff
 
 # Backup a raw device (must not be active/in use/mounted at that time)
-$ borg create \-\-read\-special \-\-chunker\-params fixed,4194304 /path/to/repo::my\-sdx /dev/sdX
+$ borg create \-\-read\-special \-\-chunker\-params fixed,4194304 my\-sdx /dev/sdX
 
 # Backup a sparse disk image (must not be active/in use/mounted at that time)
-$ borg create \-\-sparse \-\-chunker\-params fixed,4194304 /path/to/repo::my\-disk my\-disk.raw
+$ borg create \-\-sparse \-\-chunker\-params fixed,4194304 my\-disk my\-disk.raw
 
 # No compression (none)
-$ borg create \-\-compression none /path/to/repo::arch ~
+$ borg create \-\-compression none arch ~
 
 # Super fast, low compression (lz4, default)
-$ borg create /path/to/repo::arch ~
+$ borg create arch ~
 
 # Less fast, higher compression (zlib, N = 0..9)
-$ borg create \-\-compression zlib,N /path/to/repo::arch ~
+$ borg create \-\-compression zlib,N arch ~
 
 # Even slower, even higher compression (lzma, N = 0..9)
-$ borg create \-\-compression lzma,N /path/to/repo::arch ~
+$ borg create \-\-compression lzma,N arch ~
 
 # Only compress compressible data with lzma,N (N = 0..9)
-$ borg create \-\-compression auto,lzma,N /path/to/repo::arch ~
+$ borg create \-\-compression auto,lzma,N arch ~
 
 # Use short hostname, user name and current time in archive name
-$ borg create /path/to/repo::{hostname}\-{user}\-{now} ~
+$ borg create \(aq{hostname}\-{user}\-{now}\(aq ~
 # Similar, use the same datetime format that is default as of borg 1.1
-$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S} ~
+$ borg create \(aq{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S}\(aq ~
 # As above, but add nanoseconds
-$ borg create /path/to/repo::{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f} ~
+$ borg create \(aq{hostname}\-{user}\-{now:%Y\-%m\-%dT%H:%M:%S.%f}\(aq ~
 
 # Backing up relative paths by moving into the correct directory first
 $ cd /home/user/Documents
 # The root directory of the archive will be "projectA"
-$ borg create /path/to/repo::daily\-projectA\-{now:%Y\-%m\-%d} projectA
+$ borg create \(aqdaily\-projectA\-{now:%Y\-%m\-%d}\(aq projectA
 
 # Use external command to determine files to archive
 # Use \-\-paths\-from\-stdin with find to only backup files less than 1MB in size
-$ find ~ \-size \-1000k | borg create \-\-paths\-from\-stdin /path/to/repo::small\-files\-only
+$ find ~ \-size \-1000k | borg create \-\-paths\-from\-stdin small\-files\-only
 # Use \-\-paths\-from\-command with find to only backup files from a given user
-$ borg create \-\-paths\-from\-command /path/to/repo::joes\-files \-\- find /srv/samba/shared \-user joe
+$ borg create \-\-paths\-from\-command joes\-files \-\- find /srv/samba/shared \-user joe
 # Use \-\-paths\-from\-stdin with \-\-paths\-delimiter (for example, for filenames with newlines in them)
 $ find ~ \-size \-1000k \-print0 | borg create \e
     \-\-paths\-from\-stdin \e
     \-\-paths\-delimiter "\e0" \e
-    /path/to/repo::smallfiles\-handle\-newline
+    smallfiles\-handle\-newline
 .ft P
 .fi
 .UNINDENT

docs/man/borg-delete.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-DELETE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-delete \- Delete an existing repository or archives
 .
 .nr rst2man-indent-level 0
 .
@@ -30,21 +27,19 @@ 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"
+.SH NAME
+borg-delete \- Delete archives
 .SH SYNOPSIS
 .sp
-borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
+borg [common options] delete [options]
 .SH DESCRIPTION
 .sp
-This command deletes an archive from the repository or the complete repository.
+This command deletes archives from the repository.
 .sp
 Important: When deleting archives, repository disk space is \fBnot\fP freed until
 you run \fBborg compact\fP\&.
 .sp
-When you delete a complete repository, the security info and local cache for it
-(if any) are also deleted. Alternatively, you can delete just the local cache
-with the \fB\-\-cache\-only\fP option, or keep the security info with the
-\fB\-\-keep\-security\-info\fP option.
-.sp
 When in doubt, use \fB\-\-dry\-run \-\-list\fP to see what would be deleted.
 .sp
 When using \fB\-\-stats\fP, you will get some statistics about how much data was
@@ -58,43 +53,35 @@ pattern to match multiple archives using the \fB\-\-glob\-archives GLOB\fP optio
 (for more info on these patterns, see \fIborg_patterns\fP). Note that these
 two options are mutually exclusive.
 .sp
-To avoid accidentally deleting archives, especially when using glob patterns,
-it might be helpful to use the \fB\-\-dry\-run\fP to test out the command without
-actually making any changes to the repository.
+Always first use \fB\-\-dry\-run \-\-list\fP to see what would be deleted.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to delete
-.TP
-.B ARCHIVE
-archives to delete
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not change repository
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of archives
 .TP
-.B \-s\fP,\fB  \-\-stats
+.B  \-\-consider\-checkpoints
+consider checkpoint archives for deletion (default: not considered).
+.TP
+.B  \-s\fP,\fB  \-\-stats
 print statistics for the deleted archive
 .TP
-.B \-\-cache\-only
+.B  \-\-cache\-only
 delete only the local cache for the given repository
 .TP
-.B \-\-force
+.B  \-\-force
 force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
 .TP
-.B \-\-keep\-security\-info
+.B  \-\-keep\-security\-info
 keep the local security info when deleting a repository
 .TP
-.B \-\-save\-space
+.B  \-\-save\-space
 work slower, but using less space
 .UNINDENT
 .SS Archive filters
@@ -122,26 +109,18 @@ consider last N archives after other filters were applied
 .nf
 .ft C
 # delete a single backup archive:
-$ borg delete /path/to/repo::Monday
+$ borg delete Monday
 # actually free disk space:
-$ borg compact /path/to/repo
+$ borg compact
 
 # delete all archives whose names begin with the machine\(aqs hostname followed by "\-"
-$ borg delete \-\-prefix \(aq{hostname}\-\(aq /path/to/repo
+$ borg delete \-\-prefix \(aq{hostname}\-\(aq
 
 # delete all archives whose names contain "\-2012\-"
-$ borg delete \-\-glob\-archives \(aq*\-2012\-*\(aq /path/to/repo
+$ borg delete \-a \(aq*\-2012\-*\(aq
 
 # see what would be deleted if delete was run without \-\-dry\-run
-$ borg delete \-\-list \-\-dry\-run \-a \(aq*\-May\-*\(aq /path/to/repo
-
-# delete the whole repository and the related local cache:
-$ borg delete /path/to/repo
-You requested to completely DELETE the repository *including* all archives it contains:
-repo                                 Mon, 2016\-02\-15 19:26:54
-root\-2016\-02\-15                      Mon, 2016\-02\-15 19:36:29
-newname                              Mon, 2016\-02\-15 19:50:19
-Type \(aqYES\(aq if you understand this and want to continue: YES
+$ borg delete \-\-list \-\-dry\-run \-a \(aq*\-May\-*\(aq
 .ft P
 .fi
 .UNINDENT

docs/man/borg-diff.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-DIFF 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-diff \- Diff contents of two archives
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-diff \- Diff contents of two archives
 .SH SYNOPSIS
 .sp
-borg [common options] diff [options] REPO::ARCHIVE1 ARCHIVE2 [PATH...]
+borg [common options] diff [options] ARCHIVE1 ARCHIVE2 [PATH...]
 .SH DESCRIPTION
 .sp
 This command finds differences (file contents, user/group/mode) between archives.
@@ -57,11 +57,11 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPO::ARCHIVE1
-repository location and ARCHIVE1 name
+.B ARCHIVE1
+ARCHIVE1 name
 .TP
 .B ARCHIVE2
-ARCHIVE2 name (no repository location allowed)
+ARCHIVE2 name
 .TP
 .B PATH
 paths of items inside the archives to compare; patterns are supported
@@ -69,19 +69,19 @@ paths of items inside the archives to compare; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-numeric\-owner
+.B  \-\-numeric\-owner
 deprecated, use \fB\-\-numeric\-ids\fP instead
 .TP
-.B \-\-numeric\-ids
+.B  \-\-numeric\-ids
 only consider numeric user and group identifiers
 .TP
-.B \-\-same\-chunker\-params
+.B  \-\-same\-chunker\-params
 Override check of chunker parameters.
 .TP
-.B \-\-sort
+.B  \-\-sort
 Sort the output lines by file path.
 .TP
-.B \-\-json\-lines
+.B  \-\-json\-lines
 Format output as JSON Lines.
 .UNINDENT
 .SS Exclusion options
@@ -105,44 +105,17 @@ read include/exclude patterns from PATTERNFILE, one per line
 .sp
 .nf
 .ft C
-$ borg init \-e=none testrepo
-$ mkdir testdir
-$ cd testdir
-$ echo asdf > file1
-$ dd if=/dev/urandom bs=1M count=4 > file2
-$ touch file3
-$ borg create ../testrepo::archive1 .
-
-$ chmod a+x file1
-$ echo "something" >> file2
-$ borg create ../testrepo::archive2 .
-
-$ echo "testing 123" >> file1
-$ rm file3
-$ touch file4
-$ borg create ../testrepo::archive3 .
-
-$ cd ..
-$ borg diff testrepo::archive1 archive2
-[\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
-   +135 B    \-252 B file2
-
-$ borg diff testrepo::archive2 archive3
-    +17 B      \-5 B file1
-added           0 B file4
-removed         0 B file3
-
-$ borg diff testrepo::archive1 archive3
+$ borg diff archive1 archive2
     +17 B      \-5 B [\-rw\-r\-\-r\-\- \-> \-rwxr\-xr\-x] file1
    +135 B    \-252 B file2
 added           0 B file4
 removed         0 B file3
 
-$ borg diff \-\-json\-lines testrepo::archive1 archive3
+$ borg diff archive1 archive2
 {"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "\-rw\-r\-\-r\-\-", "new_mode": "\-rwxr\-xr\-x"}]}
 {"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]}
 {"path": "file4", "changes": [{"type": "added", "size": 0}]}
-{"path": "file3", "changes": [{"type": "removed", "size": 0}]
+{"path": "file3", "changes": [{"type": "removed", "size": 0}]}
 .ft P
 .fi
 .UNINDENT

docs/man/borg-export-tar.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-EXPORT-TAR 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-export-tar \- Export archive contents as a tarball
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-export-tar \- Export archive contents as a tarball
 .SH SYNOPSIS
 .sp
-borg [common options] export\-tar [options] ARCHIVE FILE [PATH...]
+borg [common options] export\-tar [options] NAME FILE [PATH...]
 .SH DESCRIPTION
 .sp
 This command creates a tarball from an archive.
@@ -115,8 +115,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B ARCHIVE
-archive to export
+.B NAME
+specify the archive name
 .TP
 .B FILE
 output tar file. "\-" to write to stdout instead.
@@ -127,10 +127,10 @@ paths to extract; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-tar\-filter
+.B  \-\-tar\-filter
 filter program to pipe data through
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of items (files, dirs, ...)
 .TP
 .BI \-\-tar\-format \ FMT

docs/man/borg-extract.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-EXTRACT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-extract \- Extract archive contents
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-extract \- Extract archive contents
 .SH SYNOPSIS
 .sp
-borg [common options] extract [options] ARCHIVE [PATH...]
+borg [common options] extract [options] NAME [PATH...]
 .SH DESCRIPTION
 .sp
 This command extracts the contents of an archive. By default the entire
@@ -66,8 +66,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B ARCHIVE
-archive to extract
+.B NAME
+specify the archive name
 .TP
 .B PATH
 paths to extract; patterns are supported
@@ -75,34 +75,34 @@ paths to extract; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of items (files, dirs, ...)
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not actually change any files
 .TP
-.B \-\-numeric\-owner
+.B  \-\-numeric\-owner
 deprecated, use \fB\-\-numeric\-ids\fP instead
 .TP
-.B \-\-numeric\-ids
+.B  \-\-numeric\-ids
 only obey numeric user and group identifiers
 .TP
-.B \-\-nobsdflags
+.B  \-\-nobsdflags
 deprecated, use \fB\-\-noflags\fP instead
 .TP
-.B \-\-noflags
+.B  \-\-noflags
 do not extract/set flags (e.g. NODUMP, IMMUTABLE)
 .TP
-.B \-\-noacls
+.B  \-\-noacls
 do not extract/set ACLs
 .TP
-.B \-\-noxattrs
+.B  \-\-noxattrs
 do not extract/set xattrs
 .TP
-.B \-\-stdout
+.B  \-\-stdout
 write all extracted data to stdout
 .TP
-.B \-\-sparse
+.B  \-\-sparse
 create holes in output sparse file from all\-zero chunks
 .UNINDENT
 .SS Exclusion options
@@ -130,22 +130,22 @@ Remove the specified number of leading path elements. Paths with fewer elements
 .nf
 .ft C
 # Extract entire archive
-$ borg extract /path/to/repo::my\-files
+$ borg extract my\-files
 
 # Extract entire archive and list files while processing
-$ borg extract \-\-list /path/to/repo::my\-files
+$ borg extract \-\-list my\-files
 
 # Verify whether an archive could be successfully extracted, but do not write files to disk
-$ borg extract \-\-dry\-run /path/to/repo::my\-files
+$ borg extract \-\-dry\-run my\-files
 
 # Extract the "src" directory
-$ borg extract /path/to/repo::my\-files home/USERNAME/src
+$ borg extract my\-files home/USERNAME/src
 
 # Extract the "src" directory but exclude object files
-$ borg extract /path/to/repo::my\-files home/USERNAME/src \-\-exclude \(aq*.o\(aq
+$ borg extract my\-files home/USERNAME/src \-\-exclude \(aq*.o\(aq
 
 # Restore a raw device (must not be active/in use/mounted at that time)
-$ borg extract \-\-stdout /path/to/repo::my\-sdx | dd of=/dev/sdx bs=10M
+$ borg extract \-\-stdout my\-sdx | dd of=/dev/sdx bs=10M
 .ft P
 .fi
 .UNINDENT

docs/man/borg-import-tar.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-IMPORT-TAR 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-import-tar \- Create a backup archive from a tarball
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-import-tar \- Create a backup archive from a tarball
 .SH SYNOPSIS
 .sp
-borg [common options] import\-tar [options] ARCHIVE TARFILE
+borg [common options] import\-tar [options] NAME TARFILE
 .SH DESCRIPTION
 .sp
 This command creates a backup archive from a tarball.
@@ -86,8 +86,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B ARCHIVE
-name of archive to create (must be also a valid directory name)
+.B NAME
+specify the archive name
 .TP
 .B TARFILE
 input tar file. "\-" to read from stdin instead.
@@ -95,19 +95,19 @@ input tar file. "\-" to read from stdin instead.
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-tar\-filter
+.B  \-\-tar\-filter
 filter program to pipe data through
 .TP
-.B \-s\fP,\fB  \-\-stats
+.B  \-s\fP,\fB  \-\-stats
 print statistics for the created archive
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of items (files, dirs, ...)
 .TP
 .BI \-\-filter \ STATUSCHARS
 only display items with the given status characters
 .TP
-.B \-\-json
+.B  \-\-json
 output stats as JSON (implies \-\-stats)
 .UNINDENT
 .SS Archive options
@@ -135,25 +135,25 @@ select compression algorithm, see the output of the "borg help compression" comm
 .nf
 .ft C
 # export as uncompressed tar
-$ borg export\-tar /path/to/repo::Monday Monday.tar
+$ borg export\-tar Monday Monday.tar
 
 # import an uncompressed tar
-$ borg import\-tar /path/to/repo::Monday Monday.tar
+$ borg import\-tar Monday Monday.tar
 
 # exclude some file types, compress using gzip
-$ borg export\-tar /path/to/repo::Monday Monday.tar.gz \-\-exclude \(aq*.so\(aq
+$ borg export\-tar Monday Monday.tar.gz \-\-exclude \(aq*.so\(aq
 
 # use higher compression level with gzip
-$ borg export\-tar \-\-tar\-filter="gzip \-9" repo::Monday Monday.tar.gz
+$ borg export\-tar \-\-tar\-filter="gzip \-9" Monday Monday.tar.gz
 
 # copy an archive from repoA to repoB
-$ borg export\-tar \-\-tar\-format=BORG repoA::archive \- | borg import\-tar repoB::archive \-
+$ borg \-r repoA export\-tar \-\-tar\-format=BORG archive \- | borg \-r repoB import\-tar archive \-
 
 # export a tar, but instead of storing it on disk, upload it to remote site using curl
-$ borg export\-tar /path/to/repo::Monday \- | curl \-\-data\-binary @\- https://somewhere/to/POST
+$ borg export\-tar Monday \- | curl \-\-data\-binary @\- https://somewhere/to/POST
 
 # remote extraction via "tarpipe"
-$ borg export\-tar /path/to/repo::Monday \- | ssh somewhere "cd extracted; tar x"
+$ borg export\-tar Monday \- | ssh somewhere "cd extracted; tar x"
 .ft P
 .fi
 .UNINDENT
@@ -166,9 +166,9 @@ Outputs a script that copies all archives from repo1 to repo2:
 .sp
 .nf
 .ft C
-for A T in \(gaborg list \-\-format=\(aq{archive} {time:%Y\-%m\-%dT%H:%M:%S}{LF}\(aq repo1\(ga
+for A T in \(gaborg list \-\-format=\(aq{archive} {time:%Y\-%m\-%dT%H:%M:%S}{LF}\(aq\(ga
 do
-  echo "borg export\-tar \-\-tar\-format=BORG repo1::$A \- | borg import\-tar \-\-timestamp=$T repo2::$A \-"
+  echo "borg \-r repo1 export\-tar \-\-tar\-format=BORG $A \- | borg \-r repo2 import\-tar \-\-timestamp=$T $A \-"
 done
 .ft P
 .fi

docs/man/borg-info.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-INFO 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-info \- Show archive details such as disk space used
 .
 .nr rst2man-indent-level 0
 .
@@ -30,12 +27,15 @@ 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"
+.SH NAME
+borg-info \- Show archive details such as disk space used
 .SH SYNOPSIS
 .sp
-borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]
+borg [common options] info [options]
 .SH DESCRIPTION
 .sp
-This command displays detailed information about the specified archive or repository.
+This command displays detailed information about the specified archive.
 .sp
 Please note that the deduplicated sizes of the individual archives do not add
 up to the deduplicated size of the repository ("all archives"), because the two
@@ -53,16 +53,10 @@ This is shown as \fIutilization of maximum supported archive size\fP\&.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to display information about
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-json
+.B  \-\-json
 format output as JSON
 .UNINDENT
 .SS Archive filters
@@ -89,58 +83,20 @@ consider last N archives after other filters were applied
 .sp
 .nf
 .ft C
-$ borg info /path/to/repo::2017\-06\-29T11:00\-srv
-Archive name: 2017\-06\-29T11:00\-srv
-Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
-Comment:
-Hostname: myhostname
-Username: root
-Time (start): Thu, 2017\-06\-29 11:03:07
-Time (end): Thu, 2017\-06\-29 11:03:13
-Duration: 5.66 seconds
-Number of files: 17037
-Command line: /usr/sbin/borg create /path/to/repo::2017\-06\-29T11:00\-srv /srv
-Utilization of max. archive size: 0%
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-                       Original size      Compressed size    Deduplicated size
-This archive:               12.53 GB             12.49 GB              1.62 kB
-All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                       Unique chunks         Total chunks
-Chunk index:                 1015213            626934122
-
-$ borg info /path/to/repo \-\-last 1
-Archive name: 2017\-06\-29T11:00\-srv
-Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
+$ borg info Tuesday2022\-06\-25T20:51:39
+Archive name: Tuesday2022\-06\-25T20:51:39
+Archive fingerprint: f7dea0788dfc026cc2be1c0f5b94beb4e4084eb3402fc40c38d8719b1bf2d943
 Comment:
-Hostname: myhostname
-Username: root
-Time (start): Thu, 2017\-06\-29 11:03:07
-Time (end): Thu, 2017\-06\-29 11:03:13
-Duration: 5.66 seconds
-Number of files: 17037
-Command line: /usr/sbin/borg create /path/to/repo::2017\-06\-29T11:00\-srv /srv
-Utilization of max. archive size: 0%
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-                       Original size      Compressed size    Deduplicated size
-This archive:               12.53 GB             12.49 GB              1.62 kB
-All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                       Unique chunks         Total chunks
-Chunk index:                 1015213            626934122
-
-$ borg info /path/to/repo
-Repository ID: d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-Location: /path/to/repo
-Encrypted: Yes (repokey)
-Cache: /root/.cache/borg/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-Security dir: /root/.config/borg/security/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-                       Original size      Compressed size    Deduplicated size
-All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                       Unique chunks         Total chunks
-Chunk index:                 1015213            626934122
+Hostname: mba2020
+Username: tw
+Time (start): Sat, 2022\-06\-25 20:51:40
+Time (end): Sat, 2022\-06\-25 20:51:40
+Duration: 0.03 seconds
+Command line: /Users/tw/w/borg\-env/bin/borg \-r path/to/repo create \-\-stats \(aqTuesday{now}\(aq src \-\-progress
+Utilization of maximum supported archive size: 0%
+Number of files: 244
+Original size: 13.80 MB
+Deduplicated size: 531 B
 .ft P
 .fi
 .UNINDENT

docs/man/borg-key-change-algorithm.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-CHANGE-ALGORITHM 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key-change-algorithm \- Change repository key algorithm
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-key-change-algorithm \- Change repository key algorithm
 .SH SYNOPSIS
 .sp
-borg [common options] key change\-algorithm [options] [REPOSITORY] ALGORITHM
+borg [common options] key change\-algorithm [options] ALGORITHM
 .SH DESCRIPTION
 .sp
 Change the algorithm we use to encrypt and authenticate the borg key.
@@ -77,8 +77,6 @@ borg key change\-algorithm /path/to/repo pbkdf2
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
-.sp
-REPOSITORY
 .INDENT 0.0
 .TP
 .B ALGORITHM

docs/man/borg-key-change-location.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-CHANGE-LOCATION 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key-change-location \- Change repository key location
 .
 .nr rst2man-indent-level 0
 .
@@ -30,26 +27,30 @@ 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"
+.SH NAME
+borg-key-change-location \- Change repository key location
 .SH SYNOPSIS
 .sp
-borg [common options] key change\-location [options] [REPOSITORY] KEY_LOCATION
+borg [common options] key change\-location [options] KEY_LOCATION
 .SH DESCRIPTION
 .sp
 Change the location of a borg key. The key can be stored at different locations:
-.sp
+.INDENT 0.0
+.IP \(bu 2
 keyfile: locally, usually in the home directory
+.IP \(bu 2
 repokey: inside the repo (in the repo config)
-.INDENT 0.0
-.TP
-.B Note: this command does NOT change the crypto algorithms, just the key location,
-thus you must ONLY give the key location (keyfile or repokey).
 .UNINDENT
+.sp
+Please note:
+.sp
+This command does NOT change the crypto algorithms, just the key location,
+thus you must ONLY give the key location (keyfile or repokey).
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
-.sp
-REPOSITORY
 .INDENT 0.0
 .TP
 .B KEY_LOCATION
@@ -58,7 +59,7 @@ select key location
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-keep
+.B  \-\-keep
 keep the key also at the current location (default: remove it)
 .UNINDENT
 .SH SEE ALSO

docs/man/borg-key-change-passphrase.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-CHANGE-PASSPHRASE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key-change-passphrase \- Change repository key file passphrase
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-key-change-passphrase \- Change repository key file passphrase
 .SH SYNOPSIS
 .sp
-borg [common options] key change\-passphrase [options] [REPOSITORY]
+borg [common options] key change\-passphrase [options]
 .SH DESCRIPTION
 .sp
 The key files used for repository encryption are optionally passphrase
@@ -45,9 +45,6 @@ does not protect future (nor past) backups to the same repository.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.sp
-REPOSITORY
 .SH EXAMPLES
 .INDENT 0.0
 .INDENT 3.5
@@ -55,7 +52,7 @@ REPOSITORY
 .nf
 .ft C
 # Create a key file protected repository
-$ borg init \-\-encryption=keyfile \-v /path/to/repo
+$ borg rcreate \-\-encryption=keyfile \-v
 Initializing repository at "/path/to/repo"
 Enter new passphrase:
 Enter same passphrase again:
@@ -67,7 +64,7 @@ Archives: 0, w/ cached Idx: 0, w/ outdated Idx: 0, w/o cached Idx: 0.
 Done.
 
 # Change key file passphrase
-$ borg key change\-passphrase \-v /path/to/repo
+$ borg key change\-passphrase \-v
 Enter passphrase for key /root/.config/borg/keys/mnt_backup:
 Enter new passphrase:
 Enter same passphrase again:
@@ -77,7 +74,7 @@ Key updated
 # Import a previously\-exported key into the specified
 # key file (creating or overwriting the output key)
 # (keyfile repositories only)
-$ BORG_KEY_FILE=/path/to/output\-key borg key import /path/to/repo /path/to/exported
+$ BORG_KEY_FILE=/path/to/output\-key borg key import /path/to/exported
 .ft P
 .fi
 .UNINDENT
@@ -89,9 +86,9 @@ Fully automated using environment variables:
 .sp
 .nf
 .ft C
-$ BORG_NEW_PASSPHRASE=old borg init \-e=repokey repo
+$ BORG_NEW_PASSPHRASE=old borg rcreate \-e=repokey
 # now "old" is the current passphrase.
-$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase repo
+$ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change\-passphrase
 # now "new" is the current passphrase.
 .ft P
 .fi

docs/man/borg-key-export.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-EXPORT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key-export \- Export the repository key for backup
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-key-export \- Export the repository key for backup
 .SH SYNOPSIS
 .sp
-borg [common options] key export [options] [REPOSITORY] [PATH]
+borg [common options] key export [options] [PATH]
 .SH DESCRIPTION
 .sp
 If repository encryption is used, the repository is inaccessible
@@ -78,8 +78,6 @@ borg key export \-\-qr\-html /path/to/repo encrypted\-key\-backup.html
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
-.sp
-REPOSITORY
 .INDENT 0.0
 .TP
 .B PATH
@@ -88,10 +86,10 @@ where to store the backup
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-paper
+.B  \-\-paper
 Create an export suitable for printing and later type\-in
 .TP
-.B \-\-qr\-html
+.B  \-\-qr\-html
 Create an html file suitable for printing and later type\-in or qr scan
 .UNINDENT
 .SH SEE ALSO

docs/man/borg-key-import.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY-IMPORT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key-import \- Import the repository key from backup
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-key-import \- Import the repository key from backup
 .SH SYNOPSIS
 .sp
-borg [common options] key import [options] [REPOSITORY] [PATH]
+borg [common options] key import [options] [PATH]
 .SH DESCRIPTION
 .sp
 This command restores a key previously backed up with the export command.
@@ -53,8 +53,6 @@ key import\fP creates a new key file in \fB$BORG_KEYS_DIR\fP\&.
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
-.sp
-REPOSITORY
 .INDENT 0.0
 .TP
 .B PATH
@@ -63,7 +61,7 @@ path to the backup (\(aq\-\(aq to read from stdin)
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-paper
+.B  \-\-paper
 interactively import from a backup done with \fB\-\-paper\fP
 .UNINDENT
 .SH SEE ALSO

docs/man/borg-key.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-KEY 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-key \- Manage a keyfile or repokey of a repository
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-key \- Manage a keyfile or repokey of a repository
 .SH SYNOPSIS
 .nf
 borg [common options] key export ...

docs/man/borg-list.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-LIST 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-list \- List archive or repository contents
 .
 .nr rst2man-indent-level 0
 .
@@ -30,12 +27,15 @@ 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"
+.SH NAME
+borg-list \- List archive contents
 .SH SYNOPSIS
 .sp
-borg [common options] list [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
+borg [common options] list [options] NAME [PATH...]
 .SH DESCRIPTION
 .sp
-This command lists the contents of a repository or an archive.
+This command lists the contents of an archive.
 .sp
 For more help on include/exclude patterns, see the \fIborg_patterns\fP command output.
 .SH OPTIONS
@@ -44,8 +44,8 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to list contents of
+.B NAME
+specify the archive name
 .TP
 .B PATH
 paths to list; patterns are supported
@@ -53,38 +53,14 @@ paths to list; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-consider\-checkpoints
-Show checkpoint archives in the repository contents list (default: hidden).
-.TP
-.B \-\-short
+.B  \-\-short
 only print file/directory names, nothing else
 .TP
 .BI \-\-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}")
-.TP
-.B \-\-json
-Only valid for listing repository contents. Format output as JSON. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available.
-.TP
-.B \-\-json\-lines
-Only valid for listing archive contents. Format output as JSON Lines. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
-.UNINDENT
-.SS Archive filters
-.INDENT 0.0
-.TP
-.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
-only consider archive names starting with this prefix.
-.TP
-.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB
-only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
-.TP
-.BI \-\-sort\-by \ KEYS
-Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-.TP
-.BI \-\-first \ N
-consider first N archives after other filters were applied
+specify format for file listing (default: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}")
 .TP
-.BI \-\-last \ N
-consider last N archives after other filters were applied
+.B  \-\-json\-lines
+Format output as JSON Lines. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
 .UNINDENT
 .SS Exclusion options
 .INDENT 0.0
@@ -107,14 +83,7 @@ read include/exclude patterns from PATTERNFILE, one per line
 .sp
 .nf
 .ft C
-$ borg list /path/to/repo
-Monday                               Mon, 2016\-02\-15 19:15:11
-repo                                 Mon, 2016\-02\-15 19:26:54
-root\-2016\-02\-15                      Mon, 2016\-02\-15 19:36:29
-newname                              Mon, 2016\-02\-15 19:50:19
-\&...
-
-$ borg list /path/to/repo::root\-2016\-02\-15
+$ borg list root\-2016\-02\-15
 drwxr\-xr\-x root   root          0 Mon, 2016\-02\-15 17:44:27 .
 drwxrwxr\-x root   root          0 Mon, 2016\-02\-15 19:04:49 bin
 \-rwxr\-xr\-x root   root    1029624 Thu, 2014\-11\-13 00:08:51 bin/bash
@@ -122,14 +91,14 @@ lrwxrwxrwx root   root          0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdif
 \-rwxr\-xr\-x root   root       2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff
 \&...
 
-$ borg list /path/to/repo::root\-2016\-02\-15 \-\-pattern "\- bin/ba*"
+$ borg list root\-2016\-02\-15 \-\-pattern "\- bin/ba*"
 drwxr\-xr\-x root   root          0 Mon, 2016\-02\-15 17:44:27 .
 drwxrwxr\-x root   root          0 Mon, 2016\-02\-15 19:04:49 bin
 lrwxrwxrwx root   root          0 Fri, 2015\-03\-27 20:24:26 bin/bzcmp \-> bzdiff
 \-rwxr\-xr\-x root   root       2140 Fri, 2015\-03\-27 20:24:22 bin/bzdiff
 \&...
 
-$ borg list /path/to/repo::archiveA \-\-format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}"
+$ borg list archiveA \-\-format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}"
 drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 .
 drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 code
 drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 code/myproject
@@ -137,11 +106,11 @@ drwxrwxr\-x user   user          0 Sun, 2015\-02\-01 11:00:00 code/myproject
 \-rw\-rw\-r\-\- user   user    1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.text
 \&...
 
-$ borg list /path/to/repo/::archiveA \-\-pattern \(aqre:\e.ext$\(aq
+$ borg list archiveA \-\-pattern \(aqre:\e.ext$\(aq
 \-rw\-rw\-r\-\- user   user    1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.ext
 \&...
 
-$ borg list /path/to/repo/::archiveA \-\-pattern \(aqre:.ext$\(aq
+$ borg list archiveA \-\-pattern \(aqre:.ext$\(aq
 \-rw\-rw\-r\-\- user   user    1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.ext
 \-rw\-rw\-r\-\- user   user    1416192 Sun, 2015\-02\-01 11:00:00 code/myproject/file.text
 \&...
@@ -160,23 +129,13 @@ Examples:
 .sp
 .nf
 .ft C
-$ borg list \-\-format \(aq{archive}{NL}\(aq /path/to/repo
-ArchiveFoo
-ArchiveBar
-\&...
-
-# {VAR:NUMBER} \- pad to NUMBER columns.
-# Strings are left\-aligned, numbers are right\-aligned.
-# Note: time columns except \(ga\(gaisomtime\(ga\(ga, \(ga\(gaisoctime\(ga\(ga and \(ga\(gaisoatime\(ga\(ga cannot be padded.
-$ borg list \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq /path/to/repo
-ArchiveFoo                           Thu, 2021\-12\-09 10:22:28 [0b8e9a312bef3f2f6e2d0fc110c196827786c15eba0188738e81697a7fa3b274]
-$ borg list \-\-format \(aq{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(aq /path/to/repo::ArchiveFoo
+$ borg list \-\-format \(aq{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
 \-rw\-rw\-r\-\- user   user       1024 Thu, 2021\-12\-09 10:22:17 file\-foo
 \&...
 
 # {VAR:<NUMBER} \- pad to NUMBER columns left\-aligned.
 # {VAR:>NUMBER} \- pad to NUMBER columns right\-aligned.
-$ borg list \-\-format \(aq{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}\(aq /path/to/repo::ArchiveFoo
+$ borg list \-\-format \(aq{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}\(aq ArchiveFoo
 \-rw\-rw\-r\-\-   user   user 1024     Thu, 2021\-12\-09 10:22:17 file\-foo
 \&...
 .ft P
@@ -185,50 +144,13 @@ $ borg list \-\-format \(aq{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{
 .UNINDENT
 .sp
 The following keys are always available:
-.INDENT 0.0
-.IP \(bu 2
-NEWLINE: OS dependent line separator
-.IP \(bu 2
-NL: alias of NEWLINE
-.IP \(bu 2
-NUL: NUL character for creating print0 / xargs \-0 like output, see barchive and bpath keys below
-.IP \(bu 2
-SPACE
-.IP \(bu 2
-TAB
-.IP \(bu 2
-CR
-.IP \(bu 2
-LF
-.UNINDENT
-.sp
-Keys available only when listing archives in a repository:
-.INDENT 0.0
-.IP \(bu 2
-archive: archive name interpreted as text (might be missing non\-text characters, see barchive)
-.IP \(bu 2
-name: alias of "archive"
-.IP \(bu 2
-barchive: verbatim archive name, can contain any character except NUL
-.IP \(bu 2
-comment: archive comment interpreted as text (might be missing non\-text characters, see bcomment)
-.IP \(bu 2
-bcomment: verbatim archive comment, can contain any character except NUL
-.IP \(bu 2
-id: internal ID of the archive
-.IP \(bu 2
-start: time (start) of creation of the archive
-.IP \(bu 2
-time: alias of "start"
-.IP \(bu 2
-end: time (end) of creation of the archive
-.IP \(bu 2
-command_line: command line which was used to create the archive
-.IP \(bu 2
-hostname: hostname of host on which this archive was created
-.IP \(bu 2
-username: username of user who created this archive
-.UNINDENT
+\- NEWLINE: OS dependent line separator
+\- NL: alias of NEWLINE
+\- NUL: NUL character for creating print0 / xargs \-0 like output, see barchive and bpath keys below
+\- SPACE
+\- TAB
+\- CR
+\- LF
 .sp
 Keys available only when listing files in an archive:
 .INDENT 0.0
@@ -249,20 +171,18 @@ path: path interpreted as text (might be missing non\-text characters, see bpath
 .IP \(bu 2
 bpath: verbatim POSIX path, can contain any character except NUL
 .IP \(bu 2
-source: link target for links (identical to linktarget)
+source: link target for symlinks (identical to linktarget)
 .IP \(bu 2
 linktarget
 .IP \(bu 2
+hlid: hard link identity (same if hardlinking same fs object)
+.IP \(bu 2
 flags
 .IP \(bu 2
 size
 .IP \(bu 2
-csize: compressed size
-.IP \(bu 2
 dsize: deduplicated size
 .IP \(bu 2
-dcsize: deduplicated compressed size
-.IP \(bu 2
 num_chunks: number of chunks in this file
 .IP \(bu 2
 unique_chunks: number of unique chunks in this file

docs/man/borg-mount.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-MOUNT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-mount \- Mount archive or an entire repository as a FUSE filesystem
 .SH SYNOPSIS
 .sp
-borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...]
+borg [common options] mount [options] MOUNTPOINT [PATH...]
 .SH DESCRIPTION
 .sp
 This command mounts an archive as a FUSE filesystem. This can be useful for
@@ -98,9 +98,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to mount
-.TP
 .B MOUNTPOINT
 where to mount filesystem
 .TP
@@ -110,19 +107,19 @@ paths to extract; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-consider\-checkpoints
+.B  \-\-consider\-checkpoints
 Show checkpoint archives in the repository contents list (default: hidden).
 .TP
-.B \-f\fP,\fB  \-\-foreground
+.B  \-f\fP,\fB  \-\-foreground
 stay in foreground, do not daemonize
 .TP
-.B \-o
+.B  \-o
 Extra mount options
 .TP
-.B \-\-numeric\-owner
+.B  \-\-numeric\-owner
 deprecated, use \fB\-\-numeric\-ids\fP instead
 .TP
-.B \-\-numeric\-ids
+.B  \-\-numeric\-ids
 use numeric user and group identifiers from archive(s)
 .UNINDENT
 .SS Archive filters

docs/man/borg-patterns.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PATTERNS 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-patterns \- Details regarding patterns
 .
 .nr rst2man-indent-level 0
 .
@@ -30,45 +27,47 @@ 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"
+.SH NAME
+borg-patterns \- Details regarding patterns
 .SH DESCRIPTION
 .sp
-The path/filenames used as input for the pattern matching start from the
-currently active recursion root. You usually give the recursion root(s)
-when invoking borg and these can be either relative or absolute paths.
-.sp
-So, when you give \fIrelative/\fP as root, the paths going into the matcher
-will look like \fIrelative/.../file.ext\fP\&. When you give \fI/absolute/\fP as
-root, they will look like \fI/absolute/.../file.ext\fP\&.
-.sp
-File paths in Borg archives are always stored normalized and relative.
-This means that e.g. \fBborg create /path/to/repo ../some/path\fP will
-store all files as \fIsome/path/.../file.ext\fP and \fBborg create
-/path/to/repo /home/user\fP will store all files as
-\fIhome/user/.../file.ext\fP\&.
-.sp
-A directory exclusion pattern can end either with or without a slash (\(aq/\(aq).
-If it ends with a slash, such as \fIsome/path/\fP, the directory will be
-included but not its content. If it does not end with a slash, such as
-\fIsome/path\fP, both the directory and content will be excluded.
+When specifying one or more file paths in a Borg command that supports
+patterns for the respective option or argument, you can apply the
+patterns described here to include only desired files and/or exclude
+unwanted ones. Patterns can be used
+.INDENT 0.0
+.IP \(bu 2
+for \fB\-\-exclude\fP option,
+.IP \(bu 2
+in the file given with \fB\-\-exclude\-from\fP option,
+.IP \(bu 2
+for \fB\-\-pattern\fP option,
+.IP \(bu 2
+in the file given with \fB\-\-patterns\-from\fP option and
+.IP \(bu 2
+for \fBPATH\fP arguments that explicitly support them.
+.UNINDENT
 .sp
-File patterns support these styles: fnmatch, shell, regular expressions,
-path prefixes and path full\-matches. By default, fnmatch is used for
-\fB\-\-exclude\fP patterns and shell\-style is used for the \fB\-\-pattern\fP
-option. For commands that support patterns in their \fBPATH\fP argument
-like (\fBborg list\fP), the default pattern is path prefix.
+Borg always stores all file paths normalized and relative to the
+current recursion root. The recursion root is also named \fBPATH\fP in
+Borg commands like \fIborg create\fP that do a file discovery, so do not
+confuse the root with the \fBPATH\fP argument of e.g. \fIborg extract\fP\&.
 .sp
-Starting with Borg 1.2, for all but regular expression pattern matching
-styles, all paths are treated as relative, meaning that a leading path
-separator is removed after normalizing and before matching. This allows
-you to use absolute or relative patterns arbitrarily.
+Starting with Borg 1.2, paths that are matched against patterns always
+appear relative. If you give \fB/absolute/\fP as root, the paths going
+into the matcher will look relative like \fBabsolute/.../file.ext\fP\&.
+If you give \fB\&../some/path\fP as root, the paths will look like
+\fBsome/path/.../file.ext\fP\&.
 .sp
-If followed by a colon (\(aq:\(aq) the first two characters of a pattern are
-used as a style selector. Explicit style selection is necessary when a
-non\-default style is desired or when the desired pattern starts with
-two alphanumeric characters followed by a colon (i.e. \fIaa:something/*\fP).
+File patterns support five different styles. If followed by a colon \(aq:\(aq,
+the first two characters of a pattern are used as a style selector.
+Explicit style selection is necessary if a non\-default style is desired
+or when the desired pattern starts with two alphanumeric characters
+followed by a colon (i.e. \fBaa:something/*\fP).
 .INDENT 0.0
 .TP
-.B \fI\%Fnmatch\fP, selector \fIfm:\fP
+.B \fI\%Fnmatch\fP, selector \fBfm:\fP
 This is the default style for \fB\-\-exclude\fP and \fB\-\-exclude\-from\fP\&.
 These patterns use a variant of shell pattern syntax, with \(aq*\(aq matching
 any number of characters, \(aq?\(aq matching any single character, \(aq[...]\(aq
@@ -76,7 +75,7 @@ matching any single character specified, including ranges, and \(aq[!...]\(aq
 matching any character not specified. For the purpose of these patterns,
 the path separator (backslash for Windows and \(aq/\(aq on other systems) is not
 treated specially. Wrap meta\-characters in brackets for a literal
-match (i.e. \fI[?]\fP to match the literal character \fI?\fP). For a path
+match (i.e. \fB[?]\fP to match the literal character \(aq?\(aq). For a path
 to match a pattern, the full path must match, or it must match
 from the start of the full path to just before a path separator. Except
 for the root path, paths will never end in the path separator when
@@ -84,33 +83,31 @@ matching is attempted.  Thus, if a given pattern ends in a path
 separator, a \(aq*\(aq is appended before matching is attempted. A leading
 path separator is always removed.
 .TP
-.B Shell\-style patterns, selector \fIsh:\fP
+.B Shell\-style patterns, selector \fBsh:\fP
 This is the default style for \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP\&.
 Like fnmatch patterns these are similar to shell patterns. The difference
-is that the pattern may include \fI**/\fP for matching zero or more directory
-levels, \fI*\fP for matching zero or more arbitrary characters with the
+is that the pattern may include \fB**/\fP for matching zero or more directory
+levels, \fB*\fP for matching zero or more arbitrary characters with the
 exception of any path separator. A leading path separator is always removed.
 .TP
-.B Regular expressions, selector \fIre:\fP
-Regular expressions similar to those found in Perl are supported. Unlike
-shell patterns regular expressions are not required to match the full
+.B \fI\%Regular expressions\fP, selector \fBre:\fP
+Unlike shell patterns, regular expressions are not required to match the full
 path and any substring match is sufficient. It is strongly recommended to
 anchor patterns to the start (\(aq^\(aq), to the end (\(aq$\(aq) or both. Path
 separators (backslash for Windows and \(aq/\(aq on other systems) in paths are
-always normalized to a forward slash (\(aq/\(aq) before applying a pattern. The
-regular expression syntax is described in the \fI\%Python documentation for
-the re module\fP\&.
+always normalized to a forward slash \(aq/\(aq before applying a pattern.
 .TP
-.B Path prefix, selector \fIpp:\fP
+.B Path prefix, selector \fBpp:\fP
 This pattern style is useful to match whole sub\-directories. The pattern
-\fIpp:root/somedir\fP matches \fIroot/somedir\fP and everything therein. A leading
-path separator is always removed.
+\fBpp:root/somedir\fP matches \fBroot/somedir\fP and everything therein.
+A leading path separator is always removed.
 .TP
-.B Path full\-match, selector \fIpf:\fP
+.B Path full\-match, selector \fBpf:\fP
 This pattern style is (only) useful to match full paths.
 This is kind of a pseudo pattern as it can not have any variable or
-unspecified parts \- the full path must be given. \fIpf:root/file.ext\fP matches
-\fIroot/file.ext\fP only. A leading path separator is always removed.
+unspecified parts \- the full path must be given. \fBpf:root/file.ext\fP
+matches \fBroot/file.ext\fP only. A leading path separator is always
+removed.
 .sp
 Implementation note: this is implemented via very time\-efficient O(1)
 hashtable lookups (this means you can have huge amounts of such patterns
@@ -125,12 +122,12 @@ Same logic applies for exclude.
 \fBNOTE:\fP
 .INDENT 0.0
 .INDENT 3.5
-\fIre:\fP, \fIsh:\fP and \fIfm:\fP patterns are all implemented on top of the Python SRE
-engine. It is very easy to formulate patterns for each of these types which
-requires an inordinate amount of time to match paths. If untrusted users
-are able to supply patterns, ensure they cannot supply \fIre:\fP patterns.
-Further, ensure that \fIsh:\fP and \fIfm:\fP patterns only contain a handful of
-wildcards at most.
+\fBre:\fP, \fBsh:\fP and \fBfm:\fP patterns are all implemented on top of
+the Python SRE engine. It is very easy to formulate patterns for each
+of these types which requires an inordinate amount of time to match
+paths. If untrusted users are able to supply patterns, ensure they
+cannot supply \fBre:\fP patterns. Further, ensure that \fBsh:\fP and
+\fBfm:\fP patterns only contain a handful of wildcards at most.
 .UNINDENT
 .UNINDENT
 .sp
@@ -139,8 +136,8 @@ from within a shell, the patterns should be quoted to protect them from
 expansion.
 .sp
 The \fB\-\-exclude\-from\fP option permits loading exclusion patterns from a text
-file with one pattern per line. Lines empty or starting with the number sign
-(\(aq#\(aq) after removing whitespace on both ends are ignored. The optional style
+file with one pattern per line. Lines empty or starting with the hash sign
+\(aq#\(aq after removing whitespace on both ends are ignored. The optional style
 selector prefix is also supported for patterns loaded from a file. Due to
 whitespace removal, paths with whitespace at the beginning or end can only be
 excluded using regular expressions.
@@ -155,74 +152,101 @@ Examples:
 .nf
 .ft C
 # Exclude \(aq/home/user/file.o\(aq but not \(aq/home/user/file.odt\(aq:
-$ borg create \-e \(aq*.o\(aq backup /
+$ borg create \-e \(aq*.o\(aq archive /
 
 # Exclude \(aq/home/user/junk\(aq and \(aq/home/user/subdir/junk\(aq but
 # not \(aq/home/user/importantjunk\(aq or \(aq/etc/junk\(aq:
-$ borg create \-e \(aq/home/*/junk\(aq backup /
+$ borg create \-e \(aqhome/*/junk\(aq archive /
 
 # Exclude the contents of \(aq/home/user/cache\(aq but not the directory itself:
-$ borg create \-e home/user/cache/ backup /
+$ borg create \-e home/user/cache/ archive /
 
 # The file \(aq/home/user/cache/important\(aq is *not* backed up:
-$ borg create \-e /home/user/cache/ backup / /home/user/cache/important
+$ borg create \-e home/user/cache/ archive / /home/user/cache/important
 
 # The contents of directories in \(aq/home\(aq are not backed up when their name
 # ends in \(aq.tmp\(aq
-$ borg create \-\-exclude \(aqre:^/home/[^/]+\e.tmp/\(aq backup /
+$ borg create \-\-exclude \(aqre:^home/[^/]+\e.tmp/\(aq archive /
 
 # Load exclusions from file
 $ cat >exclude.txt <<EOF
 # Comment line
-/home/*/junk
+home/*/junk
 *.tmp
 fm:aa:something/*
-re:^/home/[^/]+\e.tmp/
-sh:/home/*/.thumbnails
+re:^home/[^/]+\e.tmp/
+sh:home/*/.thumbnails
 # Example with spaces, no need to escape as it is processed by borg
 some file with spaces.txt
 EOF
-$ borg create \-\-exclude\-from exclude.txt backup /
+$ borg create \-\-exclude\-from exclude.txt archive /
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-A more general and easier to use way to define filename matching patterns exists
-with the \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP options. Using these, you may
-specify the backup roots (starting points) and patterns for inclusion/exclusion.
-A root path starts with the prefix \fIR\fP, followed by a path (a plain path, not a
-file pattern). An include rule starts with the prefix +, an exclude rule starts
-with the prefix \-, an exclude\-norecurse rule starts with !, all followed by a pattern.
+A more general and easier to use way to define filename matching patterns
+exists with the \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP options. Using
+these, you may specify the backup roots, default pattern styles and
+patterns for inclusion and exclusion.
+.INDENT 0.0
+.TP
+.B Root path prefix \fBR\fP
+A recursion root path starts with the prefix \fBR\fP, followed by a path
+(a plain path, not a file pattern). Use this prefix to have the root
+paths in the patterns file rather than as command line arguments.
+.TP
+.B Pattern style prefix \fBP\fP
+To change the default pattern style, use the \fBP\fP prefix, followed by
+the pattern style abbreviation (\fBfm\fP, \fBpf\fP, \fBpp\fP, \fBre\fP, \fBsh\fP).
+All patterns following this line will use this style until another style
+is specified.
+.TP
+.B Exclude pattern prefix \fB\-\fP
+Use the prefix \fB\-\fP, followed by a pattern, to define an exclusion.
+This has the same effect as the \fB\-\-exclude\fP option.
+.TP
+.B Exclude no\-recurse pattern prefix \fB!\fP
+Use the prefix \fB!\fP, followed by a pattern, to define an exclusion
+that does not recurse into subdirectories. This saves time, but
+prevents include patterns to match any files in subdirectories.
+.TP
+.B Include pattern prefix \fB+\fP
+Use the prefix \fB+\fP, followed by a pattern, to define inclusions.
+This is useful to include paths that are covered in an exclude
+pattern and would otherwise not be backed up.
+.UNINDENT
+.sp
+The first matching pattern is used, so if an include pattern matches
+before an exclude pattern, the file is backed up. Note that a no\-recurse
+exclude stops examination of subdirectories so that potential includes
+will not match \- use normal exludes for such use cases.
 .sp
-\fBNOTE:\fP
+\fBTip: You can easily test your patterns with \-\-dry\-run and  \-\-list\fP:
 .INDENT 0.0
 .INDENT 3.5
-Via \fB\-\-pattern\fP or \fB\-\-patterns\-from\fP you can define BOTH inclusion and exclusion
-of files using pattern prefixes \fB+\fP and \fB\-\fP\&. With \fB\-\-exclude\fP and
-\fB\-\-exclude\-from\fP ONLY excludes are defined.
+.sp
+.nf
+.ft C
+$ borg create \-\-dry\-run \-\-list \-\-patterns\-from patterns.txt archive
+.ft P
+.fi
 .UNINDENT
 .UNINDENT
 .sp
-Inclusion patterns are useful to include paths that are contained in an excluded
-path. The first matching pattern is used so if an include pattern matches before
-an exclude pattern, the file is backed up. If an exclude\-norecurse pattern matches
-a directory, it won\(aqt recurse into it and won\(aqt discover any potential matches for
-include rules below that directory.
+This will list the considered files one per line, prefixed with a
+character that indicates the action (e.g. \(aqx\(aq for excluding, see
+\fBItem flags\fP in \fIborg create\fP usage docs).
 .sp
 \fBNOTE:\fP
 .INDENT 0.0
 .INDENT 3.5
-It\(aqs possible that a sub\-directory/file is matched while parent directories are not.
-In that case, parent directories are not backed up thus their user, group, permission,
-etc. can not be restored.
+It\(aqs possible that a sub\-directory/file is matched while parent
+directories are not. In that case, parent directories are not backed
+up and thus their user, group, permission, etc. cannot be restored.
 .UNINDENT
 .UNINDENT
 .sp
-Note that the default pattern style for \fB\-\-pattern\fP and \fB\-\-patterns\-from\fP is
-shell style (\fIsh:\fP), so those patterns behave similar to rsync include/exclude
-patterns. The pattern style can be set via the \fIP\fP prefix.
-.sp
 Patterns (\fB\-\-pattern\fP) and excludes (\fB\-\-exclude\fP) from the command line are
 considered first (in the order of appearance). Then patterns from \fB\-\-patterns\-from\fP
 are added. Exclusion patterns from \fB\-\-exclude\-from\fP files are appended last.
@@ -235,10 +259,16 @@ Examples:
 .ft C
 # backup pics, but not the ones from 2018, except the good ones:
 # note: using = is essential to avoid cmdline argument parsing issues.
-borg create \-\-pattern=+pics/2018/good \-\-pattern=\-pics/2018 repo::arch pics
+borg create \-\-pattern=+pics/2018/good \-\-pattern=\-pics/2018 archive pics
 
-# use a file with patterns:
-borg create \-\-patterns\-from patterns.lst repo::arch
+# backup only JPG/JPEG files (case insensitive) in all home directories:
+borg create \-\-pattern \(aq+ re:\e.jpe?g(?i)$\(aq archive /home
+
+# backup homes, but exclude big downloads (like .ISO files) or hidden files:
+borg create \-\-exclude \(aqre:\e.iso(?i)$\(aq \-\-exclude \(aqsh:home/**/.*\(aq archive /home
+
+# use a file with patterns (recursion root \(aq/\(aq via command line):
+borg create \-\-patterns\-from patterns.lst archive /
 .ft P
 .fi
 .UNINDENT
@@ -250,22 +280,17 @@ The patterns.lst file could look like that:
 .sp
 .nf
 .ft C
-# "sh:" pattern style is the default, so the following line is not needed:
-P sh
-R /
-# can be rebuild
-\- /home/*/.cache
-# they\(aqre downloads for a reason
-\- /home/*/Downloads
-# susan is a nice person
+# "sh:" pattern style is the default
+# exclude caches
+\- home/*/.cache
 # include susans home
-+ /home/susan
++ home/susan
 # also back up this exact file
-+ pf:/home/bobby/specialfile.txt
++ pf:home/bobby/specialfile.txt
 # don\(aqt backup the other home directories
-\- /home/*
-# don\(aqt even look in /proc
-! /proc
+\- home/*
+# don\(aqt even look in /dev, /proc, /run, /sys, /tmp (note: would exclude files like /device, too)
+! re:^(dev|proc|run|sys|tmp)
 .ft P
 .fi
 .UNINDENT
@@ -278,14 +303,14 @@ You can specify recursion roots either on the command line or in a patternfile:
 .nf
 .ft C
 # these two commands do the same thing
-borg create \-\-exclude /home/bobby/junk repo::arch /home/bobby /home/susan
-borg create \-\-patterns\-from patternfile.lst repo::arch
+borg create \-\-exclude home/bobby/junk archive /home/bobby /home/susan
+borg create \-\-patterns\-from patternfile.lst archive
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .sp
-The patternfile:
+patternfile.lst:
 .INDENT 0.0
 .INDENT 3.5
 .sp
@@ -296,8 +321,7 @@ The patternfile:
 P fm
 R /home/bobby
 R /home/susan
-
-\- /home/bobby/junk
+\- home/bobby/junk
 .ft P
 .fi
 .UNINDENT

docs/man/borg-placeholders.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PLACEHOLDERS 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-placeholders \- Details regarding placeholders
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-placeholders \- Details regarding placeholders
 .SH DESCRIPTION
 .sp
-Repository (or Archive) URLs, \fB\-\-prefix\fP, \fB\-\-glob\-archives\fP, \fB\-\-comment\fP
+Repository URLs, \fB\-\-name\fP, \fB\-\-prefix\fP, \fB\-\-glob\-archives\fP, \fB\-\-comment\fP
 and \fB\-\-remote\-path\fP values support these placeholders:
 .INDENT 0.0
 .TP

docs/man/borg-prune.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-PRUNE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-prune \- Prune repository archives according to specified rules
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-prune \- Prune repository archives according to specified rules
 .SH SYNOPSIS
 .sp
-borg [common options] prune [options] [REPOSITORY]
+borg [common options] prune [options]
 .SH DESCRIPTION
 .sp
 The prune command prunes a repository by deleting all archives not matching
@@ -91,52 +91,46 @@ Please note that the "All archives" stats refer to the state after pruning.
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository to prune
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not change repository
 .TP
-.B \-\-force
+.B  \-\-force
 force pruning of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
 .TP
-.B \-s\fP,\fB  \-\-stats
+.B  \-s\fP,\fB  \-\-stats
 print statistics for the deleted archive
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of archives it keeps/prunes
 .TP
 .BI \-\-keep\-within \ INTERVAL
 keep all archives within this time interval
 .TP
-.B \-\-keep\-last\fP,\fB  \-\-keep\-secondly
+.B  \-\-keep\-last\fP,\fB  \-\-keep\-secondly
 number of secondly archives to keep
 .TP
-.B \-\-keep\-minutely
+.B  \-\-keep\-minutely
 number of minutely archives to keep
 .TP
-.B \-H\fP,\fB  \-\-keep\-hourly
+.B  \-H\fP,\fB  \-\-keep\-hourly
 number of hourly archives to keep
 .TP
-.B \-d\fP,\fB  \-\-keep\-daily
+.B  \-d\fP,\fB  \-\-keep\-daily
 number of daily archives to keep
 .TP
-.B \-w\fP,\fB  \-\-keep\-weekly
+.B  \-w\fP,\fB  \-\-keep\-weekly
 number of weekly archives to keep
 .TP
-.B \-m\fP,\fB  \-\-keep\-monthly
+.B  \-m\fP,\fB  \-\-keep\-monthly
 number of monthly archives to keep
 .TP
-.B \-y\fP,\fB  \-\-keep\-yearly
+.B  \-y\fP,\fB  \-\-keep\-yearly
 number of yearly archives to keep
 .TP
-.B \-\-save\-space
+.B  \-\-save\-space
 work slower, but using less space
 .UNINDENT
 .SS Archive filters
@@ -167,21 +161,21 @@ first so you will see what it would do without it actually doing anything.
 .ft C
 # Keep 7 end of day and 4 additional end of week archives.
 # Do a dry\-run without actually deleting anything.
-$ borg prune \-v \-\-list \-\-dry\-run \-\-keep\-daily=7 \-\-keep\-weekly=4 /path/to/repo
+$ borg prune \-v \-\-list \-\-dry\-run \-\-keep\-daily=7 \-\-keep\-weekly=4
 
 # Same as above but only apply to archive names starting with the hostname
 # of the machine followed by a "\-" character:
-$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-prefix=\(aq{hostname}\-\(aq /path/to/repo
+$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-prefix=\(aq{hostname}\-\(aq
 # actually free disk space:
-$ borg compact /path/to/repo
+$ borg compact
 
 # Keep 7 end of day, 4 additional end of week archives,
 # and an end of month archive for every month:
-$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 /path/to/repo
+$ borg prune \-v \-\-list \-\-keep\-daily=7 \-\-keep\-weekly=4 \-\-keep\-monthly=\-1
 
 # Keep all backups in the last 10 days, 4 additional end of week archives,
 # and an end of month archive for every month:
-$ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-monthly=\-1 /path/to/repo
+$ borg prune \-v \-\-list \-\-keep\-within=10d \-\-keep\-weekly=4 \-\-keep\-monthly=\-1
 .ft P
 .fi
 .UNINDENT

docs/man/borg-init.1 → docs/man/borg-rcreate.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-INIT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-init \- Initialize an empty repository
 .
 .nr rst2man-indent-level 0
 .
@@ -30,12 +27,15 @@ 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"
+.SH NAME
+borg-rcreate \- Create a new, empty repository
 .SH SYNOPSIS
 .sp
-borg [common options] init [options] [REPOSITORY]
+borg [common options] rcreate [options]
 .SH DESCRIPTION
 .sp
-This command initializes an empty repository. A repository is a filesystem
+This command creates a new, empty repository. A repository is a filesystem
 directory containing the deduplicated data from zero or more archives.
 .SS Encryption mode TLDR
 .sp
@@ -48,7 +48,7 @@ tips will come below):
 .sp
 .nf
 .ft C
-borg init \-\-encryption repokey /path/to/repo
+borg rcreate \-\-encryption repokey\-aes\-ocb
 .ft P
 .fi
 .UNINDENT
@@ -122,19 +122,19 @@ center;
 |l|l|l|l|l|.
 _
 T{
-\fBmode (* = keyfile or repokey)\fP
+Mode (K = keyfile or repokey)
 T}	T{
-\fBID\-Hash\fP
+ID\-Hash
 T}	T{
-\fBEncryption\fP
+Encryption
 T}	T{
-\fBAuthentication\fP
+Authentication
 T}	T{
-\fBV>=\fP
+V >=
 T}
 _
 T{
-\fB*\-blake2\-chacha20\-poly1305\fP
+K\-blake2\-chacha20\-poly1305
 T}	T{
 BLAKE2b
 T}	T{
@@ -142,11 +142,11 @@ CHACHA20
 T}	T{
 POLY1305
 T}	T{
-1.3
+2.0
 T}
 _
 T{
-\fB*\-chacha20\-poly1305\fP
+K\-chacha20\-poly1305
 T}	T{
 HMAC\-SHA\-256
 T}	T{
@@ -154,11 +154,11 @@ CHACHA20
 T}	T{
 POLY1305
 T}	T{
-1.3
+2.0
 T}
 _
 T{
-\fB*\-blake2\-aes\-ocb\fP
+K\-blake2\-aes\-ocb
 T}	T{
 BLAKE2b
 T}	T{
@@ -166,11 +166,11 @@ AES256\-OCB
 T}	T{
 AES256\-OCB
 T}	T{
-1.3
+2.0
 T}
 _
 T{
-\fB*\-aes\-ocb\fP
+K\-aes\-ocb
 T}	T{
 HMAC\-SHA\-256
 T}	T{
@@ -178,11 +178,11 @@ AES256\-OCB
 T}	T{
 AES256\-OCB
 T}	T{
-1.3
+2.0
 T}
 _
 T{
-\fB*\-blake2\fP
+K\-blake2
 T}	T{
 BLAKE2b
 T}	T{
@@ -194,7 +194,7 @@ T}	T{
 T}
 _
 T{
-\fB*\fP
+K
 T}	T{
 HMAC\-SHA\-256
 T}	T{
@@ -257,8 +257,6 @@ malicious tampering use an \fIauthenticated\fP mode. It\(aqs like \fIrepokey\fP
 \fB\-\-key\-algorithm argon2\fP is the default and is recommended.
 The key encryption key is derived from your passphrase via argon2\-id.
 Argon2 is considered more modern and secure than pbkdf2.
-.IP \(bu 2
-You can use \fB\-\-key\-algorithm pbkdf2\fP if you want to access your repo via old versions of borg.
 .UNINDENT
 .sp
 Our implementation of argon2\-based key algorithm follows the cryptographic best practices:
@@ -275,28 +273,25 @@ to break backwards compatibility anyway we took the opportunity to fix all 3 iss
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-repository to create
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
+.BI \-\-other\-repo \ SRC_REPOSITORY
+reuse the key material from the other repository
+.TP
 .BI \-e \ MODE\fR,\fB \ \-\-encryption \ MODE
 select encryption key mode \fB(required)\fP
 .TP
-.B \-\-append\-only
+.B  \-\-append\-only
 create an append\-only mode repository. Note that this only affects the low level structure of the repository, and running \fIdelete\fP or \fIprune\fP will still be allowed. See \fIappend_only_mode\fP in Additional Notes for more details.
 .TP
 .BI \-\-storage\-quota \ QUOTA
 Set storage quota of the new repository (e.g. 5G, 1.5T). Default: no quota.
 .TP
-.B \-\-make\-parent\-dirs
+.B  \-\-make\-parent\-dirs
 create the parent directories of the repository directory, if they are missing.
 .TP
-.B \-\-key\-algorithm
+.B  \-\-key\-algorithm
 the algorithm we use to derive a key encryption key from your passphrase. Default: argon2
 .UNINDENT
 .SH EXAMPLES
@@ -305,29 +300,30 @@ the algorithm we use to derive a key encryption key from your passphrase. Defaul
 .sp
 .nf
 .ft C
-# Local repository, recommended repokey AEAD crypto modes
-$ borg init \-\-encryption=repokey\-aes\-ocb /path/to/repo
-$ borg init \-\-encryption=repokey\-chacha20\-poly1305 /path/to/repo
-$ borg init \-\-encryption=repokey\-blake2\-aes\-ocb /path/to/repo
-$ borg init \-\-encryption=repokey\-blake2\-chacha20\-poly1305 /path/to/repo
-
-# Local repository (no encryption), not recommended
-$ borg init \-\-encryption=none /path/to/repo
+# Local repository
+$ export BORG_REPO=/path/to/repo
+# recommended repokey AEAD crypto modes
+$ borg rcreate \-\-encryption=repokey\-aes\-ocb
+$ borg rcreate \-\-encryption=repokey\-chacha20\-poly1305
+$ borg rcreate \-\-encryption=repokey\-blake2\-aes\-ocb
+$ borg rcreate \-\-encryption=repokey\-blake2\-chacha20\-poly1305
+# no encryption, not recommended
+$ borg rcreate \-\-encryption=authenticated
+$ borg rcreate \-\-encryption=none
 
 # Remote repository (accesses a remote borg via ssh)
+$ export BORG_REPO=ssh://user@hostname/~/backup
 # repokey: stores the (encrypted) key into <REPO_DIR>/config
-$ borg init \-\-encryption=repokey\-aes\-ocb user@hostname:backup
-
-# Remote repository (accesses a remote borg via ssh)
+$ borg rcreate \-\-encryption=repokey\-aes\-ocb
 # keyfile: stores the (encrypted) key into ~/.config/borg/keys/
-$ borg init \-\-encryption=keyfile\-aes\-ocb user@hostname:backup
+$ borg rcreate \-\-encryption=keyfile\-aes\-ocb
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
 .SH SEE ALSO
 .sp
-\fIborg\-common(1)\fP, \fIborg\-create(1)\fP, \fIborg\-delete(1)\fP, \fIborg\-check(1)\fP, \fIborg\-list(1)\fP, \fIborg\-key\-import(1)\fP, \fIborg\-key\-export(1)\fP, \fIborg\-key\-change\-passphrase(1)\fP
+\fIborg\-common(1)\fP, \fIborg\-rdelete(1)\fP, \fIborg\-rlist(1)\fP, \fIborg\-check(1)\fP, \fIborg\-key\-import(1)\fP, \fIborg\-key\-export(1)\fP, \fIborg\-key\-change\-passphrase(1)\fP
 .SH AUTHOR
 The Borg Collective
 .\" Generated by docutils manpage writer.

docs/man/borg-rdelete.1

@@ -0,0 +1,90 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" 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"
+.SH NAME
+borg-rdelete \- Delete a repository
+.SH SYNOPSIS
+.sp
+borg [common options] rdelete [options]
+.SH DESCRIPTION
+.sp
+This command deletes the complete repository.
+.sp
+When you delete a complete repository, the security info and local cache for it
+(if any) are also deleted. Alternatively, you can delete just the local cache
+with the \fB\-\-cache\-only\fP option, or keep the security info with the
+\fB\-\-keep\-security\-info\fP option.
+.sp
+Always first use \fB\-\-dry\-run \-\-list\fP to see what would be deleted.
+.SH OPTIONS
+.sp
+See \fIborg\-common(1)\fP for common options of Borg commands.
+.SS optional arguments
+.INDENT 0.0
+.TP
+.B  \-n\fP,\fB  \-\-dry\-run
+do not change repository
+.TP
+.B  \-\-list
+output verbose list of archives
+.TP
+.B  \-\-force
+force deletion of corrupted archives, use \fB\-\-force \-\-force\fP in case \fB\-\-force\fP does not work.
+.TP
+.B  \-\-cache\-only
+delete only the local cache for the given repository
+.TP
+.B  \-\-keep\-security\-info
+keep the local security info when deleting a repository
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# delete the whole repository and the related local cache:
+$ borg rdelete
+You requested to completely DELETE the repository *including* all archives it contains:
+repo                                 Mon, 2016\-02\-15 19:26:54
+root\-2016\-02\-15                      Mon, 2016\-02\-15 19:36:29
+newname                              Mon, 2016\-02\-15 19:50:19
+Type \(aqYES\(aq if you understand this and want to continue: YES
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIborg\-common(1)\fP
+.SH AUTHOR
+The Borg Collective
+.\" Generated by docutils manpage writer.
+.

docs/man/borg-recreate.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-RECREATE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-recreate \- Re-create archives
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-recreate \- Re-create archives
 .SH SYNOPSIS
 .sp
-borg [common options] recreate [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
+borg [common options] recreate [options] [PATH...]
 .SH DESCRIPTION
 .sp
 Recreate the contents of existing archives.
@@ -91,25 +91,22 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to recreate
-.TP
 .B PATH
 paths to recreate; patterns are supported
 .UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-\-list
+.B  \-\-list
 output verbose list of items (files, dirs, ...)
 .TP
 .BI \-\-filter \ STATUSCHARS
 only display items with the given status characters (listed in borg create \-\-help)
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not change anything
 .TP
-.B \-s\fP,\fB  \-\-stats
+.B  \-s\fP,\fB  \-\-stats
 print statistics at end
 .UNINDENT
 .SS Exclusion options
@@ -127,18 +124,33 @@ include/exclude paths matching PATTERN
 .BI \-\-patterns\-from \ PATTERNFILE
 read include/exclude patterns from PATTERNFILE, one per line
 .TP
-.B \-\-exclude\-caches
+.B  \-\-exclude\-caches
 exclude directories that contain a CACHEDIR.TAG file (\fI\%http://www.bford.info/cachedir/spec.html\fP)
 .TP
 .BI \-\-exclude\-if\-present \ NAME
 exclude directories that are tagged by containing a filesystem object with the given NAME
 .TP
-.B \-\-keep\-exclude\-tags
+.B  \-\-keep\-exclude\-tags
 if tag objects are specified with \fB\-\-exclude\-if\-present\fP, don\(aqt omit the tag objects themselves from the backup archive
 .UNINDENT
-.SS Archive options
+.SS Archive filters
 .INDENT 0.0
 .TP
+.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
+only consider archive names starting with this prefix.
+.TP
+.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB
+only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+.TP
+.BI \-\-sort\-by \ KEYS
+Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+.TP
+.BI \-\-first \ N
+consider first N archives after other filters were applied
+.TP
+.BI \-\-last \ N
+consider last N archives after other filters were applied
+.TP
 .BI \-\-target \ TARGET
 create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
 .TP
@@ -166,30 +178,25 @@ specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BI
 .sp
 .nf
 .ft C
-# Make old (Attic / Borg 0.xx) archives deduplicate with Borg 1.x archives.
-# Archives created with Borg 1.1+ and the default chunker params are skipped
-# (archive ID stays the same).
-$ borg recreate /mnt/backup \-\-chunker\-params default \-\-progress
-
 # Create a backup with little but fast compression
-$ borg create /mnt/backup::archive /some/files \-\-compression lz4
+$ borg create archive /some/files \-\-compression lz4
 # Then compress it \- this might take longer, but the backup has already completed,
 # so no inconsistencies from a long\-running backup job.
-$ borg recreate /mnt/backup::archive \-\-recompress \-\-compression zlib,9
+$ borg recreate \-a archive \-\-recompress \-\-compression zlib,9
 
 # Remove unwanted files from all archives in a repository.
 # Note the relative path for the \-\-exclude option \- archives only contain relative paths.
-$ borg recreate /mnt/backup \-\-exclude home/icke/Pictures/drunk_photos
+$ borg recreate \-\-exclude home/icke/Pictures/drunk_photos
 
 # Change archive comment
-$ borg create \-\-comment "This is a comment" /mnt/backup::archivename ~
-$ borg info /mnt/backup::archivename
+$ borg create \-\-comment "This is a comment" archivename ~
+$ borg info \-a archivename
 Name: archivename
 Fingerprint: ...
 Comment: This is a comment
 \&...
-$ borg recreate \-\-comment "This is a better comment" /mnt/backup::archivename
-$ borg info /mnt/backup::archivename
+$ borg recreate \-\-comment "This is a better comment" \-a archivename
+$ borg info \-a archivename
 Name: archivename
 Fingerprint: ...
 Comment: This is a better comment

docs/man/borg-rename.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-RENAME 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-rename \- Rename an existing archive
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-rename \- Rename an existing archive
 .SH SYNOPSIS
 .sp
-borg [common options] rename [options] ARCHIVE NEWNAME
+borg [common options] rename [options] OLDNAME NEWNAME
 .SH DESCRIPTION
 .sp
 This command renames an archive in the repository.
@@ -44,11 +44,11 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B ARCHIVE
-archive to rename
+.B OLDNAME
+specify the archive name
 .TP
 .B NEWNAME
-the new archive name to use
+specify the new archive name
 .UNINDENT
 .SH EXAMPLES
 .INDENT 0.0
@@ -56,12 +56,12 @@ the new archive name to use
 .sp
 .nf
 .ft C
-$ borg create /path/to/repo::archivename ~
-$ borg list /path/to/repo
+$ borg create archivename ~
+$ borg rlist
 archivename                          Mon, 2016\-02\-15 19:50:19
 
-$ borg rename /path/to/repo::archivename newname
-$ borg list /path/to/repo
+$ borg rename archivename newname
+$ borg rlist
 newname                              Mon, 2016\-02\-15 19:50:19
 .ft P
 .fi

docs/man/borg-rinfo.1

@@ -0,0 +1,83 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" 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"
+.SH NAME
+borg-rinfo \- Show repository infos
+.SH SYNOPSIS
+.sp
+borg [common options] rinfo [options]
+.SH DESCRIPTION
+.sp
+This command displays detailed information about the repository.
+.sp
+Please note that the deduplicated sizes of the individual archives do not add
+up to the deduplicated size of the repository ("all archives"), because the two
+are meaning different things:
+.sp
+This archive / deduplicated size = amount of data stored ONLY for this archive
+= unique chunks of this archive.
+All archives / deduplicated size = amount of data stored in the repo
+= all chunks in the repository.
+.SH OPTIONS
+.sp
+See \fIborg\-common(1)\fP for common options of Borg commands.
+.SS optional arguments
+.INDENT 0.0
+.TP
+.B  \-\-json
+format output as JSON
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ borg rinfo
+Repository ID: 0e85a7811022326c067acb2a7181d5b526b7d2f61b34470fb8670c440a67f1a9
+Location: /Users/tw/w/borg/path/to/repo
+Encrypted: Yes (repokey AES\-OCB)
+Cache: /Users/tw/.cache/borg/0e85a7811022326c067acb2a7181d5b526b7d2f61b34470fb8670c440a67f1a9
+Security dir: /Users/tw/.config/borg/security/0e85a7811022326c067acb2a7181d5b526b7d2f61b34470fb8670c440a67f1a9
+Original size: 152.14 MB
+Deduplicated size: 30.38 MB
+Unique chunks: 654
+Total chunks: 3302
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIborg\-common(1)\fP
+.SH AUTHOR
+The Borg Collective
+.\" Generated by docutils manpage writer.
+.

docs/man/borg-rlist.1

@@ -0,0 +1,160 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" 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"
+.SH NAME
+borg-rlist \- List the archives contained in a repository
+.SH SYNOPSIS
+.sp
+borg [common options] rlist [options]
+.SH DESCRIPTION
+.sp
+This command lists the archives contained in a repository.
+.SH OPTIONS
+.sp
+See \fIborg\-common(1)\fP for common options of Borg commands.
+.SS optional arguments
+.INDENT 0.0
+.TP
+.B  \-\-consider\-checkpoints
+Show checkpoint archives in the repository contents list (default: hidden).
+.TP
+.B  \-\-short
+only print the archive names, nothing else
+.TP
+.BI \-\-format \ FORMAT
+specify format for archive listing (default: "{archive:<36} {time} [{id}]{NL}")
+.TP
+.B  \-\-json
+Format output as JSON. The form of \fB\-\-format\fP is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available.
+.UNINDENT
+.SS Archive filters
+.INDENT 0.0
+.TP
+.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
+only consider archive names starting with this prefix.
+.TP
+.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB
+only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+.TP
+.BI \-\-sort\-by \ KEYS
+Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+.TP
+.BI \-\-first \ N
+consider first N archives after other filters were applied
+.TP
+.BI \-\-last \ N
+consider last N archives after other filters were applied
+.UNINDENT
+.SH EXAMPLES
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ borg rlist
+Monday                               Mon, 2016\-02\-15 19:15:11
+repo                                 Mon, 2016\-02\-15 19:26:54
+root\-2016\-02\-15                      Mon, 2016\-02\-15 19:36:29
+newname                              Mon, 2016\-02\-15 19:50:19
+\&...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH NOTES
+.SS The FORMAT specifier syntax
+.sp
+The \fB\-\-format\fP option uses python\(aqs \fI\%format string syntax\fP\&.
+.sp
+Examples:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ borg rlist \-\-format \(aq{archive}{NL}\(aq
+ArchiveFoo
+ArchiveBar
+\&...
+
+# {VAR:NUMBER} \- pad to NUMBER columns.
+# Strings are left\-aligned, numbers are right\-aligned.
+# Note: time columns except \(ga\(gaisomtime\(ga\(ga, \(ga\(gaisoctime\(ga\(ga and \(ga\(gaisoatime\(ga\(ga cannot be padded.
+$ borg rlist \-\-format \(aq{archive:36} {time} [{id}]{NL}\(aq /path/to/repo
+ArchiveFoo                           Thu, 2021\-12\-09 10:22:28 [0b8e9a312bef3f2f6e2d0fc110c196827786c15eba0188738e81697a7fa3b274]
+\&...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The following keys are always available:
+\- NEWLINE: OS dependent line separator
+\- NL: alias of NEWLINE
+\- NUL: NUL character for creating print0 / xargs \-0 like output, see barchive and bpath keys below
+\- SPACE
+\- TAB
+\- CR
+\- LF
+.sp
+Keys available only when listing archives in a repository:
+.INDENT 0.0
+.IP \(bu 2
+archive: archive name interpreted as text (might be missing non\-text characters, see barchive)
+.IP \(bu 2
+name: alias of "archive"
+.IP \(bu 2
+barchive: verbatim archive name, can contain any character except NUL
+.IP \(bu 2
+comment: archive comment interpreted as text (might be missing non\-text characters, see bcomment)
+.IP \(bu 2
+bcomment: verbatim archive comment, can contain any character except NUL
+.IP \(bu 2
+id: internal ID of the archive
+.IP \(bu 2
+start: time (start) of creation of the archive
+.IP \(bu 2
+time: alias of "start"
+.IP \(bu 2
+end: time (end) of creation of the archive
+.IP \(bu 2
+command_line: command line which was used to create the archive
+.IP \(bu 2
+hostname: hostname of host on which this archive was created
+.IP \(bu 2
+username: username of user who created this archive
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIborg\-common(1)\fP
+.SH AUTHOR
+The Borg Collective
+.\" Generated by docutils manpage writer.
+.

docs/man/borg-serve.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-SERVE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-serve \- Start in server mode. This command is usually not used manually.
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-serve \- Start in server mode. This command is usually not used manually.
 .SH SYNOPSIS
 .sp
 borg [common options] serve [options]
@@ -48,7 +48,7 @@ restrict repository access to PATH. Can be specified multiple times to allow the
 .BI \-\-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 \fB\-\-restrict\-to\-path\fP 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.
 .TP
-.B \-\-append\-only
+.B  \-\-append\-only
 only allow appending to repository segment files. Note that this only affects the low level structure of the repository, and running \fIdelete\fP or \fIprune\fP will still be allowed. See \fIappend_only_mode\fP in Additional Notes for more details.
 .TP
 .BI \-\-storage\-quota \ QUOTA

docs/man/borg-transfer.1

@@ -0,0 +1,100 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" 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"
+.SH NAME
+borg-transfer \- archives transfer from other repository
+.SH SYNOPSIS
+.sp
+borg [common options] transfer [options]
+.SH DESCRIPTION
+.sp
+This command transfers archives from one repository to another repository.
+.sp
+Suggested use:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# initialize DST_REPO reusing key material from SRC_REPO, so that
+# chunking and chunk id generation will work in the same way as before.
+borg \-\-repo=DST_REPO init \-\-other\-repo=SRC_REPO \-\-encryption=DST_ENC
+
+# transfer archives from SRC_REPO to DST_REPO
+borg \-\-repo=DST_REPO transfer \-\-other\-repo=SRC_REPO \-\-dry\-run  # check what it would do
+borg \-\-repo=DST_REPO transfer \-\-other\-repo=SRC_REPO            # do it!
+borg \-\-repo=DST_REPO transfer \-\-other\-repo=SRC_REPO \-\-dry\-run  # check! anything left?
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The default is to transfer all archives, including checkpoint archives.
+.sp
+You could use the misc. archive filter options to limit which archives it will
+transfer, e.g. using the \-a option. This is recommended for big
+repositories with multiple data sets to keep the runtime per invocation lower.
+.SH OPTIONS
+.sp
+See \fIborg\-common(1)\fP for common options of Borg commands.
+.SS optional arguments
+.INDENT 0.0
+.TP
+.B  \-n\fP,\fB  \-\-dry\-run
+do not change repository, just check
+.TP
+.BI \-\-other\-repo \ SRC_REPOSITORY
+transfer archives from the other repository
+.UNINDENT
+.SS Archive filters
+.INDENT 0.0
+.TP
+.BI \-P \ PREFIX\fR,\fB \ \-\-prefix \ PREFIX
+only consider archive names starting with this prefix.
+.TP
+.BI \-a \ GLOB\fR,\fB \ \-\-glob\-archives \ GLOB
+only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
+.TP
+.BI \-\-sort\-by \ KEYS
+Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+.TP
+.BI \-\-first \ N
+consider first N archives after other filters were applied
+.TP
+.BI \-\-last \ N
+consider last N archives after other filters were applied
+.UNINDENT
+.SH SEE ALSO
+.sp
+\fIborg\-common(1)\fP
+.SH AUTHOR
+The Borg Collective
+.\" Generated by docutils manpage writer.
+.

docs/man/borg-umount.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-UMOUNT 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-umount \- un-mount the FUSE filesystem
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg-umount \- un-mount the FUSE filesystem
 .SH SYNOPSIS
 .sp
 borg [common options] umount [options] MOUNTPOINT
@@ -57,21 +57,14 @@ mountpoint of the filesystem to umount
 # Mounting the repository shows all archives.
 # Archives are loaded lazily, expect some delay when navigating to an archive
 # for the first time.
-$ borg mount /path/to/repo /tmp/mymountpoint
+$ borg mount /tmp/mymountpoint
 $ ls /tmp/mymountpoint
 root\-2016\-02\-14 root\-2016\-02\-15
 $ borg umount /tmp/mymountpoint
 
-# Mounting a specific archive is possible as well.
-$ borg mount /path/to/repo::root\-2016\-02\-15 /tmp/mymountpoint
-$ ls /tmp/mymountpoint
-bin  boot  etc      home  lib  lib64  lost+found  media  mnt  opt
-root  sbin  srv  tmp  usr  var
-$ borg umount /tmp/mymountpoint
-
 # The "versions view" merges all archives in the repository
 # and provides a versioned view on files.
-$ borg mount \-o versions /path/to/repo /tmp/mymountpoint
+$ borg mount \-o versions /tmp/mymountpoint
 $ ls \-l /tmp/mymountpoint/home/user/doc.txt/
 total 24
 \-rw\-rw\-r\-\- 1 user group 12357 Aug 26 21:19 doc.cda00bc9.txt
@@ -81,12 +74,12 @@ $ borg umount /tmp/mymountpoint
 # Archive filters are supported.
 # These are especially handy for the "versions view",
 # which does not support lazy processing of archives.
-$ borg mount \-o versions \-\-glob\-archives \(aq*\-my\-home\(aq \-\-last 10 /path/to/repo /tmp/mymountpoint
+$ borg mount \-o versions \-\-glob\-archives \(aq*\-my\-home\(aq \-\-last 10 /tmp/mymountpoint
 
 # Exclusion options are supported.
 # These can speed up mounting and lower memory needs significantly.
 $ borg mount /path/to/repo /tmp/mymountpoint only/that/path
-$ borg mount \-\-exclude \(aq...\(aq /path/to/repo /tmp/mymountpoint
+$ borg mount \-\-exclude \(aq...\(aq /tmp/mymountpoint
 .ft P
 .fi
 .UNINDENT
@@ -98,13 +91,9 @@ $ borg mount \-\-exclude \(aq...\(aq /path/to/repo /tmp/mymountpoint
 .nf
 .ft C
 $ echo \(aq/mnt/backup /tmp/myrepo fuse.borgfs defaults,noauto 0 0\(aq >> /etc/fstab
-$ echo \(aq/mnt/backup::root\-2016\-02\-15 /tmp/myarchive fuse.borgfs defaults,noauto 0 0\(aq >> /etc/fstab
 $ mount /tmp/myrepo
-$ mount /tmp/myarchive
 $ ls /tmp/myrepo
 root\-2016\-02\-01 root\-2016\-02\-2015
-$ ls /tmp/myarchive
-bin  boot  etc      home  lib  lib64  lost+found  media  mnt  opt  root  sbin  srv  tmp  usr  var
 .ft P
 .fi
 .UNINDENT

docs/man/borg-upgrade.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-UPGRADE 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-upgrade \- upgrade a repository from a previous version
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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 "2022-06-25" "" "borg backup tool"
+.SH NAME
+borg-upgrade \- upgrade a repository from a previous version
 .SH SYNOPSIS
 .sp
-borg [common options] upgrade [options] [REPOSITORY]
+borg [common options] upgrade [options]
 .SH DESCRIPTION
 .sp
 Upgrade an existing, local Borg repository.
@@ -84,28 +84,22 @@ See \fB\-\-chunker\-params\fP option of \fBborg create\fP and \fBborg recreate\f
 .SH OPTIONS
 .sp
 See \fIborg\-common(1)\fP for common options of Borg commands.
-.SS arguments
-.INDENT 0.0
-.TP
-.B REPOSITORY
-path to the repository to be upgraded
-.UNINDENT
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-n\fP,\fB  \-\-dry\-run
+.B  \-n\fP,\fB  \-\-dry\-run
 do not change repository
 .TP
-.B \-\-inplace
+.B  \-\-inplace
 rewrite repository in place, with no chance of going back to older versions of the repository.
 .TP
-.B \-\-force
+.B  \-\-force
 Force upgrade
 .TP
-.B \-\-tam
+.B  \-\-tam
 Enable manifest authentication (in key and cache) (Borg 1.0.9 and later).
 .TP
-.B \-\-disable\-tam
+.B  \-\-disable\-tam
 Disable manifest authentication (in key and cache).
 .UNINDENT
 .SH EXAMPLES

docs/man/borg-with-lock.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG-WITH-LOCK 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg-with-lock \- run a user specified command with the repository lock held
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borg-with-lock \- run a user specified command with the repository lock held
 .SH SYNOPSIS
 .sp
-borg [common options] with\-lock [options] REPOSITORY COMMAND [ARGS...]
+borg [common options] with\-lock [options] COMMAND [ARGS...]
 .SH DESCRIPTION
 .sp
 This command runs a user\-specified command while the repository lock is held.
@@ -57,9 +57,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY
-repository to lock
-.TP
 .B COMMAND
 command to run
 .TP

docs/man/borg.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORG 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borg \- deduplicating and encrypting backup tool
 .
 .nr rst2man-indent-level 0
 .
@@ -30,6 +27,9 @@ 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"
+.SH NAME
+borg \- deduplicating and encrypting backup tool
 .SH SYNOPSIS
 .sp
 borg [common options] <command> [options] [arguments]
@@ -60,7 +60,7 @@ Before a backup can be made a repository has to be initialized:
 .sp
 .nf
 .ft C
-$ borg init \-\-encryption=repokey /path/to/repo
+$ borg \-r /path/to/repo rcreate \-\-encryption=repokey\-aes\-ocb
 .ft P
 .fi
 .UNINDENT
@@ -73,7 +73,7 @@ Backup the \fB~/src\fP and \fB~/Documents\fP directories into an archive called
 .sp
 .nf
 .ft C
-$ borg create /path/to/repo::Monday ~/src ~/Documents
+$ borg \-r /path/to/repo create Monday ~/src ~/Documents
 .ft P
 .fi
 .UNINDENT
@@ -85,7 +85,7 @@ The next day create a new archive called \fITuesday\fP:
 .sp
 .nf
 .ft C
-$ borg create \-\-stats /path/to/repo::Tuesday ~/src ~/Documents
+$ borg \-r /path/to/repo create \-\-stats Tuesday ~/src ~/Documents
 .ft P
 .fi
 .UNINDENT
@@ -93,29 +93,23 @@ $ borg create \-\-stats /path/to/repo::Tuesday ~/src ~/Documents
 .sp
 This backup will be a lot quicker and a lot smaller since only new never
 before seen data is stored. The \fB\-\-stats\fP option causes Borg to
-output statistics about the newly created archive such as the amount of unique
-data (not shared with other archives):
+output statistics about the newly created archive such as the deduplicated
+size (the amount of unique data not shared with other archives):
 .INDENT 3.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+Repository: /path/to/repo
 Archive name: Tuesday
-Archive fingerprint: bd31004d58f51ea06ff735d2e5ac49376901b21d58035f8fb05dbf866566e3c2
-Time (start): Tue, 2016\-02\-16 18:15:11
-Time (end):   Tue, 2016\-02\-16 18:15:11
-
-Duration: 0.19 seconds
-Number of files: 127
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
-                      Original size      Compressed size    Deduplicated size
-This archive:                4.16 MB              4.17 MB             26.78 kB
-All archives:                8.33 MB              8.34 MB              4.19 MB
-
-                      Unique chunks         Total chunks
-Chunk index:                     132                  261
-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+Archive fingerprint: bcd1b53f9b4991b7afc2b339f851b7ffe3c6d030688936fe4552eccc1877718d
+Time (start): Sat, 2022\-06\-25 20:21:43
+Time (end):   Sat, 2022\-06\-25 20:21:43
+Duration: 0.07 seconds
+Utilization of max. archive size: 0%
+Number of files: 699
+Original size: 31.14 MB
+Deduplicated size: 502 B
 .ft P
 .fi
 .UNINDENT
@@ -127,9 +121,9 @@ List all archives in the repository:
 .sp
 .nf
 .ft C
-$ borg list /path/to/repo
-Monday                               Mon, 2016\-02\-15 19:14:44
-Tuesday                              Tue, 2016\-02\-16 19:15:11
+$ borg \-r /path/to/repo rlist
+Monday                               Sat, 2022\-06\-25 20:21:14 [b80e24d2...b179f298]
+Tuesday                              Sat, 2022\-06\-25 20:21:43 [bcd1b53f...1877718d]
 .ft P
 .fi
 .UNINDENT
@@ -141,7 +135,7 @@ List the contents of the \fIMonday\fP archive:
 .sp
 .nf
 .ft C
-$ borg list /path/to/repo::Monday
+$ borg \-r /path/to/repo list Monday
 drwxr\-xr\-x user   group          0 Mon, 2016\-02\-15 18:22:30 home/user/Documents
 \-rw\-r\-\-r\-\- user   group       7961 Mon, 2016\-02\-15 18:22:30 home/user/Documents/Important.doc
 \&...
@@ -156,7 +150,7 @@ Restore the \fIMonday\fP archive by extracting the files relative to the current
 .sp
 .nf
 .ft C
-$ borg extract /path/to/repo::Monday
+$ borg \-r /path/to/repo extract Monday
 .ft P
 .fi
 .UNINDENT
@@ -168,11 +162,16 @@ Delete the \fIMonday\fP archive (please note that this does \fBnot\fP free repo
 .sp
 .nf
 .ft C
-$ borg delete /path/to/repo::Monday
+$ borg \-r /path/to/repo delete \-a Monday
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+Please note the \fB\-a\fP option here (short for \fB\-\-glob\-archives\fP) which enables you
+to give a globbing pattern to delete multiple archives, like \fB\-a \(aqoldcrap\-*\(aq\fP\&.
+You can also combine this with \fB\-\-first\fP, \fB\-\-last\fP and \fB\-\-sort\-by\fP\&.
+Be careful, always first use with \fB\-\-dry\-run\fP and \fB\-\-list\fP!
 .IP 8. 3
 Recover disk space by compacting the segment files in the repo:
 .INDENT 3.0
@@ -180,7 +179,7 @@ Recover disk space by compacting the segment files in the repo:
 .sp
 .nf
 .ft C
-$ borg compact /path/to/repo
+$ borg \-r /path/to/repo compact
 .ft P
 .fi
 .UNINDENT
@@ -208,10 +207,10 @@ in the example), but not in between them:
 .sp
 .nf
 .ft C
-borg create \-s \-\-progress repo::archive path  # good and preferred
-borg create repo::archive path \-s \-\-progress  # also works
-borg create \-s repo::archive path \-\-progress  # works, but ugly
-borg create repo::archive \-s \-\-progress path  # BAD
+borg create \-s \-\-progress archive path  # good and preferred
+borg create archive path \-s \-\-progress  # also works
+borg create \-s archive path \-\-progress  # works, but ugly
+borg create archive \-s \-\-progress path  # BAD
 .ft P
 .fi
 .UNINDENT
@@ -233,22 +232,7 @@ Note: you may also prepend a \fBfile://\fP to a filesystem path to get URL style
 .sp
 \fBRemote repositories\fP accessed via ssh \fI\%user@host\fP:
 .sp
-\fBuser@host:/path/to/repo\fP \- remote repo, absolute path
-.sp
-\fBssh://user@host:port/path/to/repo\fP \- same, alternative syntax, port can be given
-.sp
-\fBRemote repositories with relative paths\fP can be given using this syntax:
-.sp
-\fBuser@host:path/to/repo\fP \- path relative to current directory
-.sp
-\fBuser@host:~/path/to/repo\fP \- path relative to user\(aqs home directory
-.sp
-\fBuser@host:~other/path/to/repo\fP \- path relative to other\(aqs home directory
-.sp
-Note: giving \fBuser@host:/./path/to/repo\fP or \fBuser@host:/~/path/to/repo\fP or
-\fBuser@host:/~other/path/to/repo\fP is also supported, but not required here.
-.sp
-\fBRemote repositories with relative paths, alternative syntax with port\fP:
+\fBssh://user@host:port/path/to/repo\fP \- absolute path\(ga
 .sp
 \fBssh://user@host:port/./path/to/repo\fP \- path relative to current directory
 .sp
@@ -269,23 +253,21 @@ export BORG_REPO=\(aqssh://user@host:port/path/to/repo\(aq
 .UNINDENT
 .UNINDENT
 .sp
-Then just leave away the repo URL if only a repo URL is needed and you want
+Then just leave away the \fB\-\-repo\fP option if you want
 to use the default \- it will be read from BORG_REPO then.
+.SS Repository Locations / Archive names
 .sp
-Use \fB::\fP syntax to give the repo URL when syntax requires giving a positional
-argument for the repo (e.g. \fBborg mount :: /mnt\fP).
-.SS Repository / Archive Locations
+Many commands need to know the repository location, give it via \fB\-r\fP / \fB\-\-repo\fP
+or use the \fBBORG_REPO\fP environment variable.
 .sp
-Many commands want either a repository (just give the repo URL, see above) or
-an archive location, which is a repo URL followed by \fB::archive_name\fP\&.
+Commands needing one or two archive names usually get them as positional argument.
+.sp
+Commands working with an arbitrary amount of archives, usually take \fB\-a ARCH_GLOB\fP\&.
 .sp
 Archive names must not contain the \fB/\fP (slash) character. For simplicity,
 maybe also avoid blanks or other characters that have special meaning on the
 shell or in a filesystem (borg mount will use the archive name as directory
 name).
-.sp
-If you have set BORG_REPO (see above) and an archive location is needed, use
-\fB::archive_name\fP \- the repo URL part is then read from BORG_REPO.
 .SS Logging
 .sp
 Borg writes all log output to stderr by default. But please note that something
@@ -391,9 +373,11 @@ Borg uses some environment variables for automation:
 .INDENT 7.0
 .TP
 .B BORG_REPO
-When set, use the value to give the default repository location. If a command needs an archive
-parameter, you can abbreviate as \fB::archive\fP\&. If a command needs a repository parameter, you
-can either leave it away or abbreviate as \fB::\fP, if a positional parameter is required.
+When set, use the value to give the default repository location.
+Use this so you do not need to type \fB\-\-repo /path/to/my/repo\fP all the time.
+.TP
+.B BORG_OTHER_REPO
+Similar to BORG_REPO, but gives the default for \fB\-\-other\-repo\fP\&.
 .TP
 .B BORG_PASSPHRASE
 When set, use the value to answer the passphrase question for encrypted repositories.
@@ -614,7 +598,8 @@ know a list of affected hardware.
 If you are suspicious whether your Borg repository is still consistent
 and readable after one of the failures mentioned above occurred, run
 \fBborg check \-\-verify\-data\fP to make sure it is consistent.
-Requirements for Borg repository file systems.INDENT 0.0
+Requirements for Borg repository file systems
+.INDENT 0.0
 .IP \(bu 2
 Long file names
 .IP \(bu 2
@@ -772,7 +757,7 @@ special file \fIcontents\fP can be backed up in \fB\-\-read\-special\fP mode.
 By default the metadata to create them with mknod(2), mkfifo(2) etc. is stored.
 .UNINDENT
 .IP \(bu 2
-hardlinked regular files, devices, FIFOs (considering all items in the same archive)
+hardlinked regular files, devices, symlinks, FIFOs (considering all items in the same archive)
 .IP \(bu 2
 timestamps in nanosecond precision: mtime, atime, ctime
 .IP \(bu 2
@@ -907,10 +892,10 @@ The BSDs define additional flags.
 .sp
 \fIborg\-common(1)\fP for common command line options
 .sp
-\fIborg\-init(1)\fP,
+\fIborg\-rcreate(1)\fP, \fIborg\-rdelete(1)\fP, \fIborg\-rlist(1)\fP, \fIborg\-rinfo(1)\fP,
 \fIborg\-create(1)\fP, \fIborg\-mount(1)\fP, \fIborg\-extract(1)\fP,
 \fIborg\-list(1)\fP, \fIborg\-info(1)\fP,
-\fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP,
+\fIborg\-delete(1)\fP, \fIborg\-prune(1)\fP, \fIborg\-compact(1)\fP,
 \fIborg\-recreate(1)\fP
 .sp
 \fIborg\-compression(1)\fP, \fIborg\-patterns(1)\fP, \fIborg\-placeholders(1)\fP

docs/man/borgfs.1

@@ -1,8 +1,5 @@
 .\" Man page generated from reStructuredText.
 .
-.TH BORGFS 1 "2022-04-14" "" "borg backup tool"
-.SH NAME
-borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .
 .nr rst2man-indent-level 0
 .
@@ -30,9 +27,12 @@ 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"
+.SH NAME
+borgfs \- Mount archive or an entire repository as a FUSE filesystem
 .SH SYNOPSIS
 .sp
-borgfs [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...]
+borgfs [options] MOUNTPOINT [PATH...]
 .SH DESCRIPTION
 .sp
 This command mounts an archive as a FUSE filesystem. This can be useful for
@@ -98,9 +98,6 @@ See \fIborg\-common(1)\fP for common options of Borg commands.
 .SS arguments
 .INDENT 0.0
 .TP
-.B REPOSITORY_OR_ARCHIVE
-repository or archive to mount
-.TP
 .B MOUNTPOINT
 where to mount filesystem
 .TP
@@ -110,22 +107,22 @@ paths to extract; patterns are supported
 .SS optional arguments
 .INDENT 0.0
 .TP
-.B \-V\fP,\fB  \-\-version
+.B  \-V\fP,\fB  \-\-version
 show version number and exit
 .TP
-.B \-\-consider\-checkpoints
+.B  \-\-consider\-checkpoints
 Show checkpoint archives in the repository contents list (default: hidden).
 .TP
-.B \-f\fP,\fB  \-\-foreground
+.B  \-f\fP,\fB  \-\-foreground
 stay in foreground, do not daemonize
 .TP
-.B \-o
+.B  \-o
 Extra mount options
 .TP
-.B \-\-numeric\-owner
+.B  \-\-numeric\-owner
 deprecated, use \fB\-\-numeric\-ids\fP instead
 .TP
-.B \-\-numeric\-ids
+.B  \-\-numeric\-ids
 use numeric user and group identifiers from archive(s)
 .UNINDENT
 .SS Archive filters

docs/man_intro.rst

@@ -42,10 +42,10 @@ SEE ALSO
 
 `borg-common(1)` for common command line options
 
-`borg-init(1)`,
+`borg-rcreate(1)`, `borg-rdelete(1)`, `borg-rlist(1)`, `borg-rinfo(1)`,
 `borg-create(1)`, `borg-mount(1)`, `borg-extract(1)`,
 `borg-list(1)`, `borg-info(1)`,
-`borg-delete(1)`, `borg-prune(1)`,
+`borg-delete(1)`, `borg-prune(1)`, `borg-compact(1)`,
 `borg-recreate(1)`
 
 `borg-compression(1)`, `borg-patterns(1)`, `borg-placeholders(1)`

docs/quickstart.rst

@@ -39,7 +39,7 @@ on file systems which do not support this mechanism (e.g. XFS) we recommend to r
 some space in Borg itself just to be safe by adjusting the ``additional_free_space``
 setting (a good starting point is ``2G``)::
 
-    borg config /path/to/repo additional_free_space 2G
+    borg config additional_free_space 2G
 
 If Borg runs out of disk space, it tries to free as much space as it
 can while aborting the current operation safely, which allows the user to free more space
@@ -47,8 +47,7 @@ by deleting/pruning archives. This mechanism is not bullet-proof in some
 circumstances [1]_.
 
 If you *really* run out of disk space, it can be hard or impossible to free space,
-because Borg needs free space to operate - even to delete backup
-archives.
+because Borg needs free space to operate - even to delete backup archives.
 
 You can use some monitoring process or just include the free space information
 in your backup log files (you check them regularly anyway, right?).
@@ -185,7 +184,7 @@ backed up and that the ``prune`` command is keeping and deleting the correct bac
         --exclude 'home/*/.cache/*'     \
         --exclude 'var/tmp/*'           \
                                         \
-        ::'{hostname}-{now}'            \
+        '{hostname}-{now}'              \
         /etc                            \
         /home                           \
         /root                           \
@@ -315,30 +314,29 @@ You can use zstd for a wide range from high speed (and relatively low
 compression) using N=1 to high compression (and lower speed) using N=22.
 
 zstd is a modern compression algorithm and might be preferable over zlib and
-lzma, except if you need compatibility to older borg versions (< 1.1.4) that
-did not yet offer zstd.::
+lzma.::
 
-    $ borg create --compression zstd,N /path/to/repo::arch ~
+    $ borg create --compression zstd,N arch ~
 
 Other options are:
 
 If you have a fast repo storage and you want minimum CPU usage, no compression::
 
-    $ borg create --compression none /path/to/repo::arch ~
+    $ borg create --compression none arch ~
 
 If you have a less fast repo storage and you want a bit more compression (N=0..9,
 0 means no compression, 9 means high compression):
 
 ::
 
-    $ borg create --compression zlib,N /path/to/repo::arch ~
+    $ borg create --compression zlib,N arch ~
 
 If you have a very slow repo storage and you want high compression (N=0..9, 0 means
 low compression, 9 means high compression):
 
 ::
 
-    $ borg create --compression lzma,N /path/to/repo::arch ~
+    $ borg create --compression lzma,N arch ~
 
 You'll need to experiment a bit to find the best compression for your use case.
 Keep an eye on CPU load and throughput.
@@ -350,10 +348,10 @@ Repository encryption
 
 You can choose the repository encryption mode at repository creation time::
 
-    $ borg init --encryption=MODE PATH
+    $ borg rcreate --encryption=MODE
 
 For a list of available encryption MODEs and their descriptions, please refer
-to :ref:`borg_init`.
+to :ref:`borg_rcreate`.
 
 If you use encryption, all data is encrypted on the client before being written
 to the repository.
@@ -387,13 +385,6 @@ For automated backups the passphrase can be specified using the
     A backup inside of the backup that is encrypted with that key/passphrase
     won't help you with that, of course.
 
-    Only applies to repos using legacy encryption modes:
-    In case you lose your repository and the security information, but have an
-    older copy of it to restore from, don't use that later for creating new
-    backups – you would run into security issues (reuse of nonce counter
-    values). It is better to initialize a new Borg repository. See also:
-    :ref:`faq_corrupt_repo`
-
 .. _template: paperkey.html
 
 .. _remote_repos:
@@ -405,7 +396,7 @@ Borg can initialize and access repositories on remote hosts if the
 host is accessible using SSH.  This is fastest and easiest when Borg
 is installed on the remote host, in which case the following syntax is used::
 
-  $ borg init user@hostname:/path/to/repo
+  $ borg -r ssh://user@hostname:port/path/to/repo rcreate ...
 
 Note: please see the usage chapter for a full documentation of repo URLs.
 
@@ -421,7 +412,7 @@ it is still possible to use the remote host to store a repository by
 mounting the remote filesystem, for example, using sshfs::
 
   $ sshfs user@hostname:/path/to /path/to
-  $ borg init /path/to/repo
+  $ borg -r /path/to/repo rcreate ...
   $ fusermount -u /path/to
 
 You can also use other remote filesystems in a similar way. Just be careful,
@@ -517,13 +508,13 @@ Example with **borg mount**:
     # open a new, separate terminal (this terminal will be blocked until umount)
 
     # now we find out the archive names we have in the repo:
-    borg list /mnt/backup/borg_repo
+    borg rlist
 
     # mount one archive from a borg repo:
-    borg mount /mnt/backup/borg_repo::myserver-system-2019-08-11 /mnt/borg
+    borg mount -a myserver-system-2019-08-11 /mnt/borg
 
     # alternatively, mount all archives from a borg repo (slower):
-    borg mount /mnt/backup/borg_repo /mnt/borg
+    borg mount /mnt/borg
 
     # it may take a while until you will see stuff in /mnt/borg.
 
@@ -543,16 +534,16 @@ Example with **borg extract**:
     cd borg_restore
 
     # now we find out the archive names we have in the repo:
-    borg list /mnt/backup/borg_repo
+    borg rlist
 
     # we could find out the archive contents, esp. the path layout:
-    borg list /mnt/backup/borg_repo::myserver-system-2019-08-11
+    borg list myserver-system-2019-08-11
 
     # we extract only some specific path (note: no leading / !):
-    borg extract /mnt/backup/borg_repo::myserver-system-2019-08-11 path/to/extract
+    borg extract myserver-system-2019-08-11 path/to/extract
 
     # alternatively, we could fully extract the archive:
-    borg extract /mnt/backup/borg_repo::myserver-system-2019-08-11
+    borg extract myserver-system-2019-08-11
 
     # now move the files to the correct place...
 
@@ -574,6 +565,6 @@ case if unattended, automated backups were done).
 
 ::
 
-    borg mount ssh://borg@backup.example.org:2222/path/to/repo /mnt/borg
+    borg -r ssh://borg@backup.example.org:2222/path/to/repo mount /mnt/borg
     # or
-    borg extract ssh://borg@backup.example.org:2222/path/to/repo
+    borg -r ssh://borg@backup.example.org:2222/path/to/repo extract archive

docs/quickstart_example.rst.inc

@@ -1,62 +1,61 @@
 1. Before a backup can be made a repository has to be initialized::
 
-    $ borg init --encryption=repokey /path/to/repo
+    $ borg -r /path/to/repo rcreate --encryption=repokey-aes-ocb
 
 2. Backup the ``~/src`` and ``~/Documents`` directories into an archive called
    *Monday*::
 
-    $ borg create /path/to/repo::Monday ~/src ~/Documents
+    $ borg -r /path/to/repo create Monday ~/src ~/Documents
 
 3. The next day create a new archive called *Tuesday*::
 
-    $ borg create --stats /path/to/repo::Tuesday ~/src ~/Documents
+    $ borg -r /path/to/repo create --stats Tuesday ~/src ~/Documents
 
    This backup will be a lot quicker and a lot smaller since only new never
    before seen data is stored. The ``--stats`` option causes Borg to
-   output statistics about the newly created archive such as the amount of unique
-   data (not shared with other archives)::
+   output statistics about the newly created archive such as the deduplicated
+   size (the amount of unique data not shared with other archives)::
 
-    ------------------------------------------------------------------------------
+    Repository: /path/to/repo
     Archive name: Tuesday
-    Archive fingerprint: bd31004d58f51ea06ff735d2e5ac49376901b21d58035f8fb05dbf866566e3c2
-    Time (start): Tue, 2016-02-16 18:15:11
-    Time (end):   Tue, 2016-02-16 18:15:11
-
-    Duration: 0.19 seconds
-    Number of files: 127
-    ------------------------------------------------------------------------------
-                          Original size      Compressed size    Deduplicated size
-    This archive:                4.16 MB              4.17 MB             26.78 kB
-    All archives:                8.33 MB              8.34 MB              4.19 MB
-
-                          Unique chunks         Total chunks
-    Chunk index:                     132                  261
-    ------------------------------------------------------------------------------
+    Archive fingerprint: bcd1b53f9b4991b7afc2b339f851b7ffe3c6d030688936fe4552eccc1877718d
+    Time (start): Sat, 2022-06-25 20:21:43
+    Time (end):   Sat, 2022-06-25 20:21:43
+    Duration: 0.07 seconds
+    Utilization of max. archive size: 0%
+    Number of files: 699
+    Original size: 31.14 MB
+    Deduplicated size: 502 B
 
 4. List all archives in the repository::
 
-    $ borg list /path/to/repo
-    Monday                               Mon, 2016-02-15 19:14:44
-    Tuesday                              Tue, 2016-02-16 19:15:11
+    $ borg -r /path/to/repo rlist
+    Monday                               Sat, 2022-06-25 20:21:14 [b80e24d2...b179f298]
+    Tuesday                              Sat, 2022-06-25 20:21:43 [bcd1b53f...1877718d]
 
 5. List the contents of the *Monday* archive::
 
-    $ borg list /path/to/repo::Monday
+    $ borg -r /path/to/repo list Monday
     drwxr-xr-x user   group          0 Mon, 2016-02-15 18:22:30 home/user/Documents
     -rw-r--r-- user   group       7961 Mon, 2016-02-15 18:22:30 home/user/Documents/Important.doc
     ...
 
 6. Restore the *Monday* archive by extracting the files relative to the current directory::
 
-    $ borg extract /path/to/repo::Monday
+    $ borg -r /path/to/repo extract Monday
 
 7. Delete the *Monday* archive (please note that this does **not** free repo disk space)::
 
-    $ borg delete /path/to/repo::Monday
+    $ borg -r /path/to/repo delete -a Monday
+
+   Please note the ``-a`` option here (short for ``--glob-archives``) which enables you
+   to give a globbing pattern to delete multiple archives, like ``-a 'oldcrap-*'``.
+   You can also combine this with ``--first``, ``--last`` and ``--sort-by``.
+   Be careful, always first use with ``--dry-run`` and ``--list``!
 
 8. Recover disk space by compacting the segment files in the repo::
 
-    $ borg compact /path/to/repo
+    $ borg -r /path/to/repo compact
 
 .. Note::
     Borg is quiet by default (it works on WARNING log level).

docs/usage.rst

@@ -36,7 +36,16 @@ Usage
 .. toctree::
    usage/general
 
-   usage/init
+   usage/rcreate
+   usage/rlist
+   usage/rinfo
+   usage/rdelete
+   usage/serve
+   usage/compact
+   usage/config
+   usage/lock
+   usage/key
+
    usage/create
    usage/extract
    usage/check
@@ -45,16 +54,13 @@ Usage
    usage/diff
    usage/delete
    usage/prune
-   usage/compact
    usage/info
    usage/mount
-   usage/key
-   usage/upgrade
    usage/recreate
    usage/tar
-   usage/serve
-   usage/config
-   usage/lock
+
+   usage/transfer
+   usage/upgrade
    usage/benchmark
 
    usage/help

docs/usage/benchmark_cpu.rst.inc

@@ -40,5 +40,6 @@ This command benchmarks misc. CPU bound borg operations.
 
 It creates input data in memory, runs the operation and then displays throughput.
 To reduce outside influence on the timings, please make sure to run this with:
+
 - an otherwise as idle as possible machine
 - enough free memory so there will be no slow down due to paging activity

docs/usage/benchmark_crud.rst.inc

@@ -6,23 +6,21 @@ borg benchmark crud
 -------------------
 .. code-block:: none
 
-    borg [common options] benchmark crud [options] REPOSITORY PATH
+    borg [common options] benchmark crud [options] PATH
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+----------------------------------------------+
-    | **positional arguments**                                                                                              |
-    +-------------------------------------------------------+----------------+----------------------------------------------+
-    |                                                       | ``REPOSITORY`` | repository to use for benchmark (must exist) |
-    +-------------------------------------------------------+----------------+----------------------------------------------+
-    |                                                       | ``PATH``       | path were to create benchmark input data     |
-    +-------------------------------------------------------+----------------+----------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                        |
-    |                                                                                                                       |
-    | :ref:`common_options`                                                                                                 |
-    +-------------------------------------------------------+----------------+----------------------------------------------+
+    +-------------------------------------------------------+----------+------------------------------------------+
+    | **positional arguments**                                                                                    |
+    +-------------------------------------------------------+----------+------------------------------------------+
+    |                                                       | ``PATH`` | path were to create benchmark input data |
+    +-------------------------------------------------------+----------+------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                              |
+    |                                                                                                             |
+    | :ref:`common_options`                                                                                       |
+    +-------------------------------------------------------+----------+------------------------------------------+
 
     .. raw:: html
 
@@ -34,8 +32,6 @@ borg benchmark crud
 
 .. only:: latex
 
-    REPOSITORY
-        repository to use for benchmark (must exist)
     PATH
         path were to create benchmark input data
 

docs/usage/break-lock.rst.inc

@@ -6,21 +6,17 @@ borg break-lock
 ---------------
 .. code-block:: none
 
-    borg [common options] break-lock [options] [REPOSITORY]
+    borg [common options] break-lock [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+-----------------------------------------+
-    | **positional arguments**                                                                                         |
-    +-------------------------------------------------------+----------------+-----------------------------------------+
-    |                                                       | ``REPOSITORY`` | repository for which to break the locks |
-    +-------------------------------------------------------+----------------+-----------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                   |
-    |                                                                                                                  |
-    | :ref:`common_options`                                                                                            |
-    +-------------------------------------------------------+----------------+-----------------------------------------+
+    +-------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                        |
+    |                                                       |
+    | :ref:`common_options`                                 |
+    +-------------------------------------------------------+
 
     .. raw:: html
 
@@ -32,8 +28,6 @@ borg break-lock
 
 .. only:: latex
 
-    REPOSITORY
-        repository for which to break the locks
 
 
     :ref:`common_options`

docs/usage/check.rst.inc

@@ -6,19 +6,17 @@ borg check
 ----------
 .. code-block:: none
 
-    borg [common options] check [options] [REPOSITORY_OR_ARCHIVE]
+    borg [common options] check [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                     |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to check consistency of                                                                                                          |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--name NAME``                       | specify the archive name                                                                                                                               |
+    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--repository-only``                 | only perform repository checks                                                                                                                         |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--archives-only``                   | only perform archives checks                                                                                                                           |
@@ -58,11 +56,10 @@ borg check
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to check consistency of
 
 
     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/common-options.rst.inc

@@ -1,23 +1,24 @@
--h, --help         show this help message and exit
---critical         work on log level CRITICAL
---error            work on log level ERROR
---warning          work on log level WARNING (default)
+-h, --help               show this help message and exit
+--critical               work on log level CRITICAL
+--error                  work on log level ERROR
+--warning                work on log level WARNING (default)
 --info, -v, --verbose    work on log level INFO
---debug            enable debug output, work on log level DEBUG
---debug-topic TOPIC    enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
--p, --progress     show progress information
---iec              format using IEC units (1KiB = 1024B)
---log-json         Output one JSON object per log line instead of formatted text.
---lock-wait SECONDS    wait at most SECONDS for acquiring a repository/cache lock (default: 1).
---bypass-lock      Bypass locking mechanism
---show-version     show/log the borg version
---show-rc          show/log the return code (rc)
---umask M          set umask to M (local only, default: 0077)
---remote-path PATH    use PATH as borg executable on the remote (default: "borg")
+--debug                  enable debug output, work on log level DEBUG
+--debug-topic TOPIC      enable TOPIC debugging (can be specified multiple times). The logger path is borg.debug.<TOPIC> if TOPIC is not fully qualified.
+-p, --progress           show progress information
+--iec                    format using IEC units (1KiB = 1024B)
+--log-json               Output one JSON object per log line instead of formatted text.
+--lock-wait SECONDS      wait at most SECONDS for acquiring a repository/cache lock (default: 1).
+--bypass-lock            Bypass locking mechanism
+--show-version           show/log the borg version
+--show-rc                show/log the return code (rc)
+--umask M                set umask to M (local only, default: 0077)
+--remote-path PATH       use PATH as borg executable on the remote (default: "borg")
 --remote-ratelimit RATE    deprecated, use ``--upload-ratelimit`` instead
 --upload-ratelimit RATE    set network upload rate limit in kiByte/s (default: 0=unlimited)
 --remote-buffer UPLOAD_BUFFER    deprecated, use ``--upload-buffer`` instead
 --upload-buffer UPLOAD_BUFFER    set network upload buffer size in MiB. (default: 0=no buffer)
 --consider-part-files    treat part files like normal files (e.g. to list/extract them)
---debug-profile FILE    Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof".
---rsh RSH          Use this command to connect to the 'borg serve' process (default: 'ssh')
+--debug-profile FILE     Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof".
+--rsh RSH                Use this command to connect to the 'borg serve' process (default: 'ssh')
+-r REPO, --repo REPO     repository to use

docs/usage/compact.rst

@@ -5,9 +5,4 @@ Examples
 ::
 
     # compact segments and free repo disk space
-    $ borg compact /path/to/repo
-
-    # same as above plus clean up 17byte commit-only segments
-    $ borg compact --cleanup-commits /path/to/repo
-
-
+    $ borg compact

docs/usage/compact.rst.inc

@@ -6,16 +6,12 @@ borg compact
 ------------
 .. code-block:: none
 
-    borg [common options] compact [options] [REPOSITORY]
+    borg [common options] compact [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
-    | **positional arguments**                                                                                                                         |
-    +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
-    |                                                       | ``REPOSITORY``          | repository to compact                                          |
     +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
     | **optional arguments**                                                                                                                           |
     +-------------------------------------------------------+-------------------------+----------------------------------------------------------------+
@@ -38,8 +34,6 @@ borg compact
 
 .. only:: latex
 
-    REPOSITORY
-        repository to compact
 
 
     optional arguments

docs/usage/config.rst

@@ -11,12 +11,12 @@ Examples
 ::
 
     # find cache directory
-    $ cd ~/.cache/borg/$(borg config /path/to/repo id)
+    $ cd ~/.cache/borg/$(borg config id)
 
     # reserve some space
-    $ borg config /path/to/repo additional_free_space 2G
+    $ borg config additional_free_space 2G
 
     # make a repo append-only
-    $ borg config /path/to/repo append_only 1
+    $ borg config append_only 1
 
 

docs/usage/config.rst.inc

@@ -6,7 +6,7 @@ borg config
 -----------
 .. code-block:: none
 
-    borg [common options] config [options] [REPOSITORY] [NAME] [VALUE]
+    borg [common options] config [options] [NAME] [VALUE]
 
 .. only:: html
 
@@ -15,8 +15,6 @@ borg config
     +-------------------------------------------------------+----------------------+----------------------------------------+
     | **positional arguments**                                                                                              |
     +-------------------------------------------------------+----------------------+----------------------------------------+
-    |                                                       | ``REPOSITORY``       | repository to configure                |
-    +-------------------------------------------------------+----------------------+----------------------------------------+
     |                                                       | ``NAME``             | name of config key                     |
     +-------------------------------------------------------+----------------------+----------------------------------------+
     |                                                       | ``VALUE``            | new value for key                      |
@@ -44,8 +42,6 @@ borg config
 
 .. only:: latex
 
-    REPOSITORY
-        repository to configure
     NAME
         name of config key
     VALUE

docs/usage/create.rst

@@ -5,83 +5,81 @@ Examples
 ::
 
     # Backup ~/Documents into an archive named "my-documents"
-    $ borg create /path/to/repo::my-documents ~/Documents
+    $ borg create my-documents ~/Documents
 
     # same, but list all files as we process them
-    $ borg create --list /path/to/repo::my-documents ~/Documents
+    $ borg create --list my-documents ~/Documents
 
     # Backup ~/Documents and ~/src but exclude pyc files
-    $ borg create /path/to/repo::my-files \
+    $ borg create my-files                \
         ~/Documents                       \
         ~/src                             \
         --exclude '*.pyc'
 
     # Backup home directories excluding image thumbnails (i.e. only
     # /home/<one directory>/.thumbnails is excluded, not /home/*/*/.thumbnails etc.)
-    $ borg create /path/to/repo::my-files /home \
-        --exclude 'sh:home/*/.thumbnails'
+    $ borg create my-files /home --exclude 'sh:home/*/.thumbnails'
 
     # Backup the root filesystem into an archive named "root-YYYY-MM-DD"
     # use zlib compression (good, but slow) - default is lz4 (fast, low compression ratio)
-    $ borg create -C zlib,6 --one-file-system /path/to/repo::root-{now:%Y-%m-%d} /
+    $ borg create -C zlib,6 --one-file-system root-{now:%Y-%m-%d} /
 
-    # Backup onto a remote host ("push" style) via ssh to port 2222,
-    # logging in as user "borg" and storing into /path/to/repo
-    $ borg create ssh://borg@backup.example.org:2222/path/to/repo::{fqdn}-root-{now} /
+    # Backup into an archive name like FQDN-root-TIMESTAMP
+    $ borg create '{fqdn}-root-{now}' /
 
     # Backup a remote host locally ("pull" style) using sshfs
     $ mkdir sshfs-mount
     $ sshfs root@example.com:/ sshfs-mount
     $ cd sshfs-mount
-    $ borg create /path/to/repo::example.com-root-{now:%Y-%m-%d} .
+    $ borg create example.com-root-{now:%Y-%m-%d} .
     $ cd ..
     $ fusermount -u sshfs-mount
 
     # Make a big effort in fine granular deduplication (big chunk management
     # overhead, needs a lot of RAM and disk space, see formula in internals
     # docs - same parameters as borg < 1.0 or attic):
-    $ borg create --chunker-params buzhash,10,23,16,4095 /path/to/repo::small /smallstuff
+    $ borg create --chunker-params buzhash,10,23,16,4095 small /smallstuff
 
     # Backup a raw device (must not be active/in use/mounted at that time)
-    $ borg create --read-special --chunker-params fixed,4194304 /path/to/repo::my-sdx /dev/sdX
+    $ borg create --read-special --chunker-params fixed,4194304 my-sdx /dev/sdX
 
     # Backup a sparse disk image (must not be active/in use/mounted at that time)
-    $ borg create --sparse --chunker-params fixed,4194304 /path/to/repo::my-disk my-disk.raw
+    $ borg create --sparse --chunker-params fixed,4194304 my-disk my-disk.raw
 
     # No compression (none)
-    $ borg create --compression none /path/to/repo::arch ~
+    $ borg create --compression none arch ~
 
     # Super fast, low compression (lz4, default)
-    $ borg create /path/to/repo::arch ~
+    $ borg create arch ~
 
     # Less fast, higher compression (zlib, N = 0..9)
-    $ borg create --compression zlib,N /path/to/repo::arch ~
+    $ borg create --compression zlib,N arch ~
 
     # Even slower, even higher compression (lzma, N = 0..9)
-    $ borg create --compression lzma,N /path/to/repo::arch ~
+    $ borg create --compression lzma,N arch ~
 
     # Only compress compressible data with lzma,N (N = 0..9)
-    $ borg create --compression auto,lzma,N /path/to/repo::arch ~
+    $ borg create --compression auto,lzma,N arch ~
 
     # Use short hostname, user name and current time in archive name
-    $ borg create /path/to/repo::{hostname}-{user}-{now} ~
+    $ borg create '{hostname}-{user}-{now}' ~
     # Similar, use the same datetime format that is default as of borg 1.1
-    $ borg create /path/to/repo::{hostname}-{user}-{now:%Y-%m-%dT%H:%M:%S} ~
+    $ borg create '{hostname}-{user}-{now:%Y-%m-%dT%H:%M:%S}' ~
     # As above, but add nanoseconds
-    $ borg create /path/to/repo::{hostname}-{user}-{now:%Y-%m-%dT%H:%M:%S.%f} ~
+    $ borg create '{hostname}-{user}-{now:%Y-%m-%dT%H:%M:%S.%f}' ~
 
     # Backing up relative paths by moving into the correct directory first
     $ cd /home/user/Documents
     # The root directory of the archive will be "projectA"
-    $ borg create /path/to/repo::daily-projectA-{now:%Y-%m-%d} projectA
+    $ borg create 'daily-projectA-{now:%Y-%m-%d}' projectA
 
     # Use external command to determine files to archive
     # Use --paths-from-stdin with find to only backup files less than 1MB in size
-    $ find ~ -size -1000k | borg create --paths-from-stdin /path/to/repo::small-files-only
+    $ find ~ -size -1000k | borg create --paths-from-stdin small-files-only
     # Use --paths-from-command with find to only backup files from a given user
-    $ borg create --paths-from-command /path/to/repo::joes-files -- find /srv/samba/shared -user joe
+    $ borg create --paths-from-command joes-files -- find /srv/samba/shared -user joe
     # Use --paths-from-stdin with --paths-delimiter (for example, for filenames with newlines in them)
     $ find ~ -size -1000k -print0 | borg create \
         --paths-from-stdin \
         --paths-delimiter "\0" \
-        /path/to/repo::smallfiles-handle-newline
+        smallfiles-handle-newline

docs/usage/create.rst.inc

@@ -6,7 +6,7 @@ borg create
 -----------
 .. code-block:: none
 
-    borg [common options] create [options] ARCHIVE [PATH...]
+    borg [common options] create [options] NAME [PATH...]
 
 .. only:: html
 
@@ -15,7 +15,7 @@ borg create
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                         |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``ARCHIVE``                                       | name of archive to create (must be also a valid directory name)                                                                                      |
+    |                                                       | ``NAME``                                          | specify the archive name                                                                                                                             |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``PATH``                                          | paths to archive                                                                                                                                     |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -37,7 +37,7 @@ borg create
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--stdin-user USER``                             | set user USER in archive for stdin data (default: 'root')                                                                                            |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--stdin-group GROUP``                           | set group GROUP in archive for stdin data (default: 'root')                                                                                          |
+    |                                                       | ``--stdin-group GROUP``                           | set group GROUP in archive for stdin data (default: 'wheel')                                                                                         |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``--stdin-mode M``                                | set mode to M in archive for stdin data (default: 0660)                                                                                              |
     +-------------------------------------------------------+---------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -124,8 +124,8 @@ borg create
 
 .. only:: latex
 
-    ARCHIVE
-        name of archive to create (must be also a valid directory name)
+    NAME
+        specify the archive name
     PATH
         paths to archive
 
@@ -139,7 +139,7 @@ borg create
         --no-cache-sync    experimental: do not synchronize the cache. Implies not using the files cache.
         --stdin-name NAME    use NAME in archive for stdin data (default: 'stdin')
         --stdin-user USER    set user USER in archive for stdin data (default: 'root')
-        --stdin-group GROUP    set group GROUP in archive for stdin data (default: 'root')
+        --stdin-group GROUP    set group GROUP in archive for stdin data (default: 'wheel')
         --stdin-mode M    set mode to M in archive for stdin data (default: 0660)
         --content-from-command    interpret PATH as command and store its stdout. See also section Reading from stdin below.
         --paths-from-stdin    read DELIM-separated list of paths to backup from stdin. Will not recurse into directories.

docs/usage/delete.rst

@@ -5,23 +5,15 @@ Examples
 ::
 
     # delete a single backup archive:
-    $ borg delete /path/to/repo::Monday
+    $ borg delete Monday
     # actually free disk space:
-    $ borg compact /path/to/repo
+    $ borg compact
 
     # delete all archives whose names begin with the machine's hostname followed by "-"
-    $ borg delete --prefix '{hostname}-' /path/to/repo
+    $ borg delete --prefix '{hostname}-'
 
     # delete all archives whose names contain "-2012-"
-    $ borg delete --glob-archives '*-2012-*' /path/to/repo
+    $ borg delete -a '*-2012-*'
 
     # see what would be deleted if delete was run without --dry-run
-    $ borg delete --list --dry-run -a '*-May-*' /path/to/repo
-
-    # delete the whole repository and the related local cache:
-    $ borg delete /path/to/repo
-    You requested to completely DELETE the repository *including* all archives it contains:
-    repo                                 Mon, 2016-02-15 19:26:54
-    root-2016-02-15                      Mon, 2016-02-15 19:36:29
-    newname                              Mon, 2016-02-15 19:50:19
-    Type 'YES' if you understand this and want to continue: YES
+    $ borg delete --list --dry-run -a '*-May-*'

docs/usage/delete.rst.inc

@@ -6,18 +6,12 @@ borg delete
 -----------
 .. code-block:: none
 
-    borg [common options] delete [options] [REPOSITORY_OR_ARCHIVE] [ARCHIVE...]
+    borg [common options] delete [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                     |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to delete                                                                                                                        |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``ARCHIVE``                           | archives to delete                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -25,6 +19,8 @@ borg delete
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--list``                            | output verbose list of archives                                                                                                                        |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--consider-checkpoints``            | consider checkpoint archives for deletion (default: not considered).                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``-s``, ``--stats``                   | print statistics for the deleted archive                                                                                                               |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``--cache-only``                      | delete only the local cache for the given repository                                                                                                   |
@@ -62,15 +58,12 @@ borg delete
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to delete
-    ARCHIVE
-        archives to delete
 
 
     optional arguments
         -n, --dry-run    do not change repository
         --list          output verbose list of archives
+        --consider-checkpoints    consider checkpoint archives for deletion (default: not considered).
         -s, --stats     print statistics for the deleted archive
         --cache-only    delete only the local cache for the given repository
         --force         force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
@@ -92,16 +85,11 @@ borg delete
 Description
 ~~~~~~~~~~~
 
-This command deletes an archive from the repository or the complete repository.
+This command deletes archives from the repository.
 
 Important: When deleting archives, repository disk space is **not** freed until
 you run ``borg compact``.
 
-When you delete a complete repository, the security info and local cache for it
-(if any) are also deleted. Alternatively, you can delete just the local cache
-with the ``--cache-only`` option, or keep the security info with the
-``--keep-security-info`` option.
-
 When in doubt, use ``--dry-run --list`` to see what would be deleted.
 
 When using ``--stats``, you will get some statistics about how much data was
@@ -115,6 +103,4 @@ pattern to match multiple archives using the ``--glob-archives GLOB`` option
 (for more info on these patterns, see :ref:`borg_patterns`). Note that these
 two options are mutually exclusive.
 
-To avoid accidentally deleting archives, especially when using glob patterns,
-it might be helpful to use the ``--dry-run`` to test out the command without
-actually making any changes to the repository.
+Always first use ``--dry-run --list`` to see what would be deleted.

docs/usage/diff.rst

@@ -4,41 +4,14 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg init -e=none testrepo
-    $ mkdir testdir
-    $ cd testdir
-    $ echo asdf > file1
-    $ dd if=/dev/urandom bs=1M count=4 > file2
-    $ touch file3
-    $ borg create ../testrepo::archive1 .
-
-    $ chmod a+x file1
-    $ echo "something" >> file2
-    $ borg create ../testrepo::archive2 .
-
-    $ echo "testing 123" >> file1
-    $ rm file3
-    $ touch file4
-    $ borg create ../testrepo::archive3 .
-
-    $ cd ..
-    $ borg diff testrepo::archive1 archive2
-    [-rw-r--r-- -> -rwxr-xr-x] file1
-       +135 B    -252 B file2
-
-    $ borg diff testrepo::archive2 archive3
-        +17 B      -5 B file1
-    added           0 B file4
-    removed         0 B file3
-
-    $ borg diff testrepo::archive1 archive3
+    $ borg diff archive1 archive2
         +17 B      -5 B [-rw-r--r-- -> -rwxr-xr-x] file1
        +135 B    -252 B file2
     added           0 B file4
     removed         0 B file3
 
-    $ borg diff --json-lines testrepo::archive1 archive3
+    $ borg diff archive1 archive2
     {"path": "file1", "changes": [{"type": "modified", "added": 17, "removed": 5}, {"type": "mode", "old_mode": "-rw-r--r--", "new_mode": "-rwxr-xr-x"}]}
     {"path": "file2", "changes": [{"type": "modified", "added": 135, "removed": 252}]}
     {"path": "file4", "changes": [{"type": "added", "size": 0}]}
-    {"path": "file3", "changes": [{"type": "removed", "size": 0}]}
+    {"path": "file3", "changes": [{"type": "removed", "size": 0}]}

docs/usage/diff.rst.inc

@@ -6,7 +6,7 @@ borg diff
 ---------
 .. code-block:: none
 
-    borg [common options] diff [options] REPO::ARCHIVE1 ARCHIVE2 [PATH...]
+    borg [common options] diff [options] ARCHIVE1 ARCHIVE2 [PATH...]
 
 .. only:: html
 
@@ -15,9 +15,9 @@ borg diff
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                              |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
-    |                                                       | ``REPO::ARCHIVE1``                    | repository location and ARCHIVE1 name                                 |
+    |                                                       | ``ARCHIVE1``                          | ARCHIVE1 name                                                         |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
-    |                                                       | ``ARCHIVE2``                          | ARCHIVE2 name (no repository location allowed)                        |
+    |                                                       | ``ARCHIVE2``                          | ARCHIVE2 name                                                         |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
     |                                                       | ``PATH``                              | paths of items inside the archives to compare; patterns are supported |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------+
@@ -58,10 +58,10 @@ borg diff
 
 .. only:: latex
 
-    REPO::ARCHIVE1
-        repository location and ARCHIVE1 name
+    ARCHIVE1
+        ARCHIVE1 name
     ARCHIVE2
-        ARCHIVE2 name (no repository location allowed)
+        ARCHIVE2 name
     PATH
         paths of items inside the archives to compare; patterns are supported
 

docs/usage/export-tar.rst.inc

@@ -6,7 +6,7 @@ borg export-tar
 ---------------
 .. code-block:: none
 
-    borg [common options] export-tar [options] ARCHIVE FILE [PATH...]
+    borg [common options] export-tar [options] NAME FILE [PATH...]
 
 .. only:: html
 
@@ -15,7 +15,7 @@ borg export-tar
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                  |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
-    |                                                       | ``ARCHIVE``                           | archive to export                                                                                         |
+    |                                                       | ``NAME``                              | specify the archive name                                                                                  |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``FILE``                              | output tar file. "-" to write to stdout instead.                                                          |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
@@ -56,8 +56,8 @@ borg export-tar
 
 .. only:: latex
 
-    ARCHIVE
-        archive to export
+    NAME
+        specify the archive name
     FILE
         output tar file. "-" to write to stdout instead.
     PATH

docs/usage/extract.rst

@@ -5,19 +5,19 @@ Examples
 ::
 
     # Extract entire archive
-    $ borg extract /path/to/repo::my-files
+    $ borg extract my-files
 
     # Extract entire archive and list files while processing
-    $ borg extract --list /path/to/repo::my-files
+    $ borg extract --list my-files
 
     # Verify whether an archive could be successfully extracted, but do not write files to disk
-    $ borg extract --dry-run /path/to/repo::my-files
+    $ borg extract --dry-run my-files
 
     # Extract the "src" directory
-    $ borg extract /path/to/repo::my-files home/USERNAME/src
+    $ borg extract my-files home/USERNAME/src
 
     # Extract the "src" directory but exclude object files
-    $ borg extract /path/to/repo::my-files home/USERNAME/src --exclude '*.o'
+    $ borg extract my-files home/USERNAME/src --exclude '*.o'
 
     # Restore a raw device (must not be active/in use/mounted at that time)
-    $ borg extract --stdout /path/to/repo::my-sdx | dd of=/dev/sdx bs=10M
+    $ borg extract --stdout my-sdx | dd of=/dev/sdx bs=10M

docs/usage/extract.rst.inc

@@ -6,7 +6,7 @@ borg extract
 ------------
 .. code-block:: none
 
-    borg [common options] extract [options] ARCHIVE [PATH...]
+    borg [common options] extract [options] NAME [PATH...]
 
 .. only:: html
 
@@ -15,7 +15,7 @@ borg extract
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                  |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
-    |                                                       | ``ARCHIVE``                           | archive to extract                                                                                        |
+    |                                                       | ``NAME``                              | specify the archive name                                                                                  |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
     |                                                       | ``PATH``                              | paths to extract; patterns are supported                                                                  |
     +-------------------------------------------------------+---------------------------------------+-----------------------------------------------------------------------------------------------------------+
@@ -68,8 +68,8 @@ borg extract
 
 .. only:: latex
 
-    ARCHIVE
-        archive to extract
+    NAME
+        specify the archive name
     PATH
         paths to extract; patterns are supported
 

docs/usage/general.rst

@@ -7,7 +7,7 @@ The following sections will describe each command in detail.
 
 Commands, options, parameters, paths and such are ``set in fixed-width``.
 Option values are `underlined`. Borg has few options accepting a fixed set
-of values (e.g. ``--encryption`` of :ref:`borg_init`).
+of values (e.g. ``--encryption`` of :ref:`borg_rcreate`).
 
 .. container:: experimental
 
@@ -54,5 +54,5 @@ Examples
 ::
 
     # Create an archive and log: borg version, files list, return code
-    $ borg create --show-version --list --show-rc /path/to/repo::my-files files
+    $ borg -r /path/to/repo create --show-version --list --show-rc my-files files
 

docs/usage/general/environment.rst.inc

@@ -5,9 +5,10 @@ Borg uses some environment variables for automation:
 
 General:
     BORG_REPO
-        When set, use the value to give the default repository location. If a command needs an archive
-        parameter, you can abbreviate as ``::archive``. If a command needs a repository parameter, you
-        can either leave it away or abbreviate as ``::``, if a positional parameter is required.
+        When set, use the value to give the default repository location.
+        Use this so you do not need to type ``--repo /path/to/my/repo`` all the time.
+    BORG_OTHER_REPO
+        Similar to BORG_REPO, but gives the default for ``--other-repo``.
     BORG_PASSPHRASE
         When set, use the value to answer the passphrase question for encrypted repositories.
         It is used when a passphrase is needed to access an encrypted repo as well as when a new

docs/usage/general/positional-arguments.rst.inc

@@ -7,9 +7,9 @@ in the example), but not in between them:
 
 ::
 
-    borg create -s --progress repo::archive path  # good and preferred
-    borg create repo::archive path -s --progress  # also works
-    borg create -s repo::archive path --progress  # works, but ugly
-    borg create repo::archive -s --progress path  # BAD
+    borg create -s --progress archive path  # good and preferred
+    borg create archive path -s --progress  # also works
+    borg create -s archive path --progress  # works, but ugly
+    borg create archive -s --progress path  # BAD
 
 This is due to a problem in the argparse module: https://bugs.python.org/issue15112

docs/usage/general/repository-locations.rst.inc

@@ -1,13 +1,14 @@
-Repository / Archive Locations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Repository Locations / Archive names
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Many commands want either a repository (just give the repo URL, see above) or
-an archive location, which is a repo URL followed by ``::archive_name``.
+Many commands need to know the repository location, give it via ``-r`` / ``--repo``
+or use the ``BORG_REPO`` environment variable.
+
+Commands needing one or two archive names usually get them as positional argument.
+
+Commands working with an arbitrary amount of archives, usually take ``-a ARCH_GLOB``.
 
 Archive names must not contain the ``/`` (slash) character. For simplicity,
 maybe also avoid blanks or other characters that have special meaning on the
 shell or in a filesystem (borg mount will use the archive name as directory
 name).
-
-If you have set BORG_REPO (see above) and an archive location is needed, use
-``::archive_name`` - the repo URL part is then read from BORG_REPO.

docs/usage/general/repository-urls.rst.inc

@@ -14,24 +14,7 @@ Note: you may also prepend a ``file://`` to a filesystem path to get URL style.
 
 **Remote repositories** accessed via ssh user@host:
 
-``user@host:/path/to/repo`` - remote repo, absolute path
-
-``ssh://user@host:port/path/to/repo`` - same, alternative syntax, port can be given
-
-
-**Remote repositories with relative paths** can be given using this syntax:
-
-``user@host:path/to/repo`` - path relative to current directory
-
-``user@host:~/path/to/repo`` - path relative to user's home directory
-
-``user@host:~other/path/to/repo`` - path relative to other's home directory
-
-Note: giving ``user@host:/./path/to/repo`` or ``user@host:/~/path/to/repo`` or
-``user@host:/~other/path/to/repo`` is also supported, but not required here.
-
-
-**Remote repositories with relative paths, alternative syntax with port**:
+``ssh://user@host:port/path/to/repo`` - absolute path`
 
 ``ssh://user@host:port/./path/to/repo`` - path relative to current directory
 
@@ -47,8 +30,5 @@ If you frequently need the same repo URL, it is a good idea to set the
 
     export BORG_REPO='ssh://user@host:port/path/to/repo'
 
-Then just leave away the repo URL if only a repo URL is needed and you want
+Then just leave away the ``--repo`` option if you want
 to use the default - it will be read from BORG_REPO then.
-
-Use ``::`` syntax to give the repo URL when syntax requires giving a positional
-argument for the repo (e.g. ``borg mount :: /mnt``).

docs/usage/help.rst.inc

@@ -6,42 +6,35 @@ borg help patterns
 ~~~~~~~~~~~~~~~~~~
 
 
-The path/filenames used as input for the pattern matching start from the
-currently active recursion root. You usually give the recursion root(s)
-when invoking borg and these can be either relative or absolute paths.
-
-So, when you give `relative/` as root, the paths going into the matcher
-will look like `relative/.../file.ext`. When you give `/absolute/` as
-root, they will look like `/absolute/.../file.ext`.
-
-File paths in Borg archives are always stored normalized and relative.
-This means that e.g. ``borg create /path/to/repo ../some/path`` will
-store all files as `some/path/.../file.ext` and ``borg create
-/path/to/repo /home/user`` will store all files as
-`home/user/.../file.ext`.
-
-A directory exclusion pattern can end either with or without a slash ('/').
-If it ends with a slash, such as `some/path/`, the directory will be
-included but not its content. If it does not end with a slash, such as
-`some/path`, both the directory and content will be excluded.
-
-File patterns support these styles: fnmatch, shell, regular expressions,
-path prefixes and path full-matches. By default, fnmatch is used for
-``--exclude`` patterns and shell-style is used for the ``--pattern``
-option. For commands that support patterns in their ``PATH`` argument
-like (``borg list``), the default pattern is path prefix.
-
-Starting with Borg 1.2, for all but regular expression pattern matching
-styles, all paths are treated as relative, meaning that a leading path
-separator is removed after normalizing and before matching. This allows
-you to use absolute or relative patterns arbitrarily.
-
-If followed by a colon (':') the first two characters of a pattern are
-used as a style selector. Explicit style selection is necessary when a
-non-default style is desired or when the desired pattern starts with
-two alphanumeric characters followed by a colon (i.e. `aa:something/*`).
-
-`Fnmatch <https://docs.python.org/3/library/fnmatch.html>`_, selector `fm:`
+When specifying one or more file paths in a Borg command that supports
+patterns for the respective option or argument, you can apply the
+patterns described here to include only desired files and/or exclude
+unwanted ones. Patterns can be used
+
+- for ``--exclude`` option,
+- in the file given with ``--exclude-from`` option,
+- for ``--pattern`` option,
+- in the file given with ``--patterns-from`` option and
+- for ``PATH`` arguments that explicitly support them.
+
+Borg always stores all file paths normalized and relative to the
+current recursion root. The recursion root is also named ``PATH`` in
+Borg commands like `borg create` that do a file discovery, so do not
+confuse the root with the ``PATH`` argument of e.g. `borg extract`.
+
+Starting with Borg 1.2, paths that are matched against patterns always
+appear relative. If you give ``/absolute/`` as root, the paths going
+into the matcher will look relative like ``absolute/.../file.ext``.
+If you give ``../some/path`` as root, the paths will look like
+``some/path/.../file.ext``.
+
+File patterns support five different styles. If followed by a colon ':',
+the first two characters of a pattern are used as a style selector.
+Explicit style selection is necessary if a non-default style is desired
+or when the desired pattern starts with two alphanumeric characters
+followed by a colon (i.e. ``aa:something/*``).
+
+`Fnmatch <https://docs.python.org/3/library/fnmatch.html>`_, selector ``fm:``
     This is the default style for ``--exclude`` and ``--exclude-from``.
     These patterns use a variant of shell pattern syntax, with '\*' matching
     any number of characters, '?' matching any single character, '[...]'
@@ -49,7 +42,7 @@ two alphanumeric characters followed by a colon (i.e. `aa:something/*`).
     matching any character not specified. For the purpose of these patterns,
     the path separator (backslash for Windows and '/' on other systems) is not
     treated specially. Wrap meta-characters in brackets for a literal
-    match (i.e. `[?]` to match the literal character `?`). For a path
+    match (i.e. ``[?]`` to match the literal character '?'). For a path
     to match a pattern, the full path must match, or it must match
     from the start of the full path to just before a path separator. Except
     for the root path, paths will never end in the path separator when
@@ -57,33 +50,31 @@ two alphanumeric characters followed by a colon (i.e. `aa:something/*`).
     separator, a '\*' is appended before matching is attempted. A leading
     path separator is always removed.
 
-Shell-style patterns, selector `sh:`
+Shell-style patterns, selector ``sh:``
     This is the default style for ``--pattern`` and ``--patterns-from``.
     Like fnmatch patterns these are similar to shell patterns. The difference
-    is that the pattern may include `**/` for matching zero or more directory
-    levels, `*` for matching zero or more arbitrary characters with the
+    is that the pattern may include ``**/`` for matching zero or more directory
+    levels, ``*`` for matching zero or more arbitrary characters with the
     exception of any path separator. A leading path separator is always removed.
 
-Regular expressions, selector `re:`
-    Regular expressions similar to those found in Perl are supported. Unlike
-    shell patterns regular expressions are not required to match the full
+`Regular expressions <https://docs.python.org/3/library/re.html>`_, selector ``re:``
+    Unlike shell patterns, regular expressions are not required to match the full
     path and any substring match is sufficient. It is strongly recommended to
     anchor patterns to the start ('^'), to the end ('$') or both. Path
     separators (backslash for Windows and '/' on other systems) in paths are
-    always normalized to a forward slash ('/') before applying a pattern. The
-    regular expression syntax is described in the `Python documentation for
-    the re module <https://docs.python.org/3/library/re.html>`_.
+    always normalized to a forward slash '/' before applying a pattern.
 
-Path prefix, selector `pp:`
+Path prefix, selector ``pp:``
     This pattern style is useful to match whole sub-directories. The pattern
-    `pp:root/somedir` matches `root/somedir` and everything therein. A leading
-    path separator is always removed.
+    ``pp:root/somedir`` matches ``root/somedir`` and everything therein.
+    A leading path separator is always removed.
 
-Path full-match, selector `pf:`
+Path full-match, selector ``pf:``
     This pattern style is (only) useful to match full paths.
     This is kind of a pseudo pattern as it can not have any variable or
-    unspecified parts - the full path must be given. `pf:root/file.ext` matches
-    `root/file.ext` only. A leading path separator is always removed.
+    unspecified parts - the full path must be given. ``pf:root/file.ext``
+    matches ``root/file.ext`` only. A leading path separator is always
+    removed.
 
     Implementation note: this is implemented via very time-efficient O(1)
     hashtable lookups (this means you can have huge amounts of such patterns
@@ -96,20 +87,20 @@ Path full-match, selector `pf:`
 
 .. note::
 
-    `re:`, `sh:` and `fm:` patterns are all implemented on top of the Python SRE
-    engine. It is very easy to formulate patterns for each of these types which
-    requires an inordinate amount of time to match paths. If untrusted users
-    are able to supply patterns, ensure they cannot supply `re:` patterns.
-    Further, ensure that `sh:` and `fm:` patterns only contain a handful of
-    wildcards at most.
+    ``re:``, ``sh:`` and ``fm:`` patterns are all implemented on top of
+    the Python SRE engine. It is very easy to formulate patterns for each
+    of these types which requires an inordinate amount of time to match
+    paths. If untrusted users are able to supply patterns, ensure they
+    cannot supply ``re:`` patterns. Further, ensure that ``sh:`` and
+    ``fm:`` patterns only contain a handful of wildcards at most.
 
 Exclusions can be passed via the command line option ``--exclude``. When used
 from within a shell, the patterns should be quoted to protect them from
 expansion.
 
 The ``--exclude-from`` option permits loading exclusion patterns from a text
-file with one pattern per line. Lines empty or starting with the number sign
-('#') after removing whitespace on both ends are ignored. The optional style
+file with one pattern per line. Lines empty or starting with the hash sign
+'#' after removing whitespace on both ends are ignored. The optional style
 selector prefix is also supported for patterns loaded from a file. Due to
 whitespace removal, paths with whitespace at the beginning or end can only be
 excluded using regular expressions.
@@ -120,63 +111,83 @@ run ``borg create --list --dry-run ...``.
 Examples::
 
     # Exclude '/home/user/file.o' but not '/home/user/file.odt':
-    $ borg create -e '*.o' backup /
+    $ borg create -e '*.o' archive /
 
     # Exclude '/home/user/junk' and '/home/user/subdir/junk' but
     # not '/home/user/importantjunk' or '/etc/junk':
-    $ borg create -e '/home/*/junk' backup /
+    $ borg create -e 'home/*/junk' archive /
 
     # Exclude the contents of '/home/user/cache' but not the directory itself:
-    $ borg create -e home/user/cache/ backup /
+    $ borg create -e home/user/cache/ archive /
 
     # The file '/home/user/cache/important' is *not* backed up:
-    $ borg create -e /home/user/cache/ backup / /home/user/cache/important
+    $ borg create -e home/user/cache/ archive / /home/user/cache/important
 
     # The contents of directories in '/home' are not backed up when their name
     # ends in '.tmp'
-    $ borg create --exclude 're:^/home/[^/]+\.tmp/' backup /
+    $ borg create --exclude 're:^home/[^/]+\.tmp/' archive /
 
     # Load exclusions from file
     $ cat >exclude.txt <<EOF
     # Comment line
-    /home/*/junk
+    home/*/junk
     *.tmp
     fm:aa:something/*
-    re:^/home/[^/]+\.tmp/
-    sh:/home/*/.thumbnails
+    re:^home/[^/]+\.tmp/
+    sh:home/*/.thumbnails
     # Example with spaces, no need to escape as it is processed by borg
     some file with spaces.txt
     EOF
-    $ borg create --exclude-from exclude.txt backup /
+    $ borg create --exclude-from exclude.txt archive /
 
-A more general and easier to use way to define filename matching patterns exists
-with the ``--pattern`` and ``--patterns-from`` options. Using these, you may
-specify the backup roots (starting points) and patterns for inclusion/exclusion.
-A root path starts with the prefix `R`, followed by a path (a plain path, not a
-file pattern). An include rule starts with the prefix +, an exclude rule starts
-with the prefix -, an exclude-norecurse rule starts with !, all followed by a pattern.
+A more general and easier to use way to define filename matching patterns
+exists with the ``--pattern`` and ``--patterns-from`` options. Using
+these, you may specify the backup roots, default pattern styles and
+patterns for inclusion and exclusion.
 
-.. note::
+Root path prefix ``R``
+    A recursion root path starts with the prefix ``R``, followed by a path
+    (a plain path, not a file pattern). Use this prefix to have the root
+    paths in the patterns file rather than as command line arguments.
 
-    Via ``--pattern`` or ``--patterns-from`` you can define BOTH inclusion and exclusion
-    of files using pattern prefixes ``+`` and ``-``. With ``--exclude`` and
-    ``--exclude-from`` ONLY excludes are defined.
+Pattern style prefix ``P``
+    To change the default pattern style, use the ``P`` prefix, followed by
+    the pattern style abbreviation (``fm``, ``pf``, ``pp``, ``re``, ``sh``).
+    All patterns following this line will use this style until another style
+    is specified.
 
-Inclusion patterns are useful to include paths that are contained in an excluded
-path. The first matching pattern is used so if an include pattern matches before
-an exclude pattern, the file is backed up. If an exclude-norecurse pattern matches
-a directory, it won't recurse into it and won't discover any potential matches for
-include rules below that directory.
+Exclude pattern prefix ``-``
+    Use the prefix ``-``, followed by a pattern, to define an exclusion.
+    This has the same effect as the ``--exclude`` option.
 
-.. note::
+Exclude no-recurse pattern prefix ``!``
+    Use the prefix ``!``, followed by a pattern, to define an exclusion
+    that does not recurse into subdirectories. This saves time, but
+    prevents include patterns to match any files in subdirectories.
+
+Include pattern prefix ``+``
+    Use the prefix ``+``, followed by a pattern, to define inclusions.
+    This is useful to include paths that are covered in an exclude
+    pattern and would otherwise not be backed up.
+
+The first matching pattern is used, so if an include pattern matches
+before an exclude pattern, the file is backed up. Note that a no-recurse
+exclude stops examination of subdirectories so that potential includes
+will not match - use normal exludes for such use cases.
+
+**Tip: You can easily test your patterns with --dry-run and  --list**::
 
-    It's possible that a sub-directory/file is matched while parent directories are not.
-    In that case, parent directories are not backed up thus their user, group, permission,
-    etc. can not be restored.
+    $ borg create --dry-run --list --patterns-from patterns.txt archive
 
-Note that the default pattern style for ``--pattern`` and ``--patterns-from`` is
-shell style (`sh:`), so those patterns behave similar to rsync include/exclude
-patterns. The pattern style can be set via the `P` prefix.
+This will list the considered files one per line, prefixed with a
+character that indicates the action (e.g. 'x' for excluding, see
+**Item flags** in `borg create` usage docs).
+
+.. note::
+
+    It's possible that a sub-directory/file is matched while parent
+    directories are not. In that case, parent directories are not backed
+    up and thus their user, group, permission, etc. cannot be restored.
 
 Patterns (``--pattern``) and excludes (``--exclude``) from the command line are
 considered first (in the order of appearance). Then patterns from ``--patterns-from``
@@ -186,45 +197,45 @@ Examples::
 
     # backup pics, but not the ones from 2018, except the good ones:
     # note: using = is essential to avoid cmdline argument parsing issues.
-    borg create --pattern=+pics/2018/good --pattern=-pics/2018 repo::arch pics
+    borg create --pattern=+pics/2018/good --pattern=-pics/2018 archive pics
 
-    # use a file with patterns:
-    borg create --patterns-from patterns.lst repo::arch
+    # backup only JPG/JPEG files (case insensitive) in all home directories:
+    borg create --pattern '+ re:\.jpe?g(?i)$' archive /home
+
+    # backup homes, but exclude big downloads (like .ISO files) or hidden files:
+    borg create --exclude 're:\.iso(?i)$' --exclude 'sh:home/**/.*' archive /home
+
+    # use a file with patterns (recursion root '/' via command line):
+    borg create --patterns-from patterns.lst archive /
 
 The patterns.lst file could look like that::
 
-    # "sh:" pattern style is the default, so the following line is not needed:
-    P sh
-    R /
-    # can be rebuild
-    - /home/*/.cache
-    # they're downloads for a reason
-    - /home/*/Downloads
-    # susan is a nice person
+    # "sh:" pattern style is the default
+    # exclude caches
+    - home/*/.cache
     # include susans home
-    + /home/susan
+    + home/susan
     # also back up this exact file
-    + pf:/home/bobby/specialfile.txt
+    + pf:home/bobby/specialfile.txt
     # don't backup the other home directories
-    - /home/*
-    # don't even look in /proc
-    ! /proc
+    - home/*
+    # don't even look in /dev, /proc, /run, /sys, /tmp (note: would exclude files like /device, too)
+    ! re:^(dev|proc|run|sys|tmp)
 
 You can specify recursion roots either on the command line or in a patternfile::
 
     # these two commands do the same thing
-    borg create --exclude /home/bobby/junk repo::arch /home/bobby /home/susan
-    borg create --patterns-from patternfile.lst repo::arch
+    borg create --exclude home/bobby/junk archive /home/bobby /home/susan
+    borg create --patterns-from patternfile.lst archive
 
-The patternfile::
+patternfile.lst::
 
     # note that excludes use fm: by default and patternfiles use sh: by default.
     # therefore, we need to specify fm: to have the same exact behavior.
     P fm
     R /home/bobby
     R /home/susan
-
-    - /home/bobby/junk
+    - home/bobby/junk
 
 This allows you to share the same patterns between multiple repositories
 without needing to specify them on the command line.
@@ -235,7 +246,7 @@ borg help placeholders
 ~~~~~~~~~~~~~~~~~~~~~~
 
 
-Repository (or Archive) URLs, ``--prefix``, ``--glob-archives``, ``--comment``
+Repository URLs, ``--name``, ``--prefix``, ``--glob-archives``, ``--comment``
 and ``--remote-path`` values support these placeholders:
 
 {hostname}

docs/usage/import-tar.rst.inc

@@ -6,7 +6,7 @@ borg import-tar
 ---------------
 .. code-block:: none
 
-    borg [common options] import-tar [options] ARCHIVE TARFILE
+    borg [common options] import-tar [options] NAME TARFILE
 
 .. only:: html
 
@@ -15,7 +15,7 @@ borg import-tar
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                          |
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``ARCHIVE``                                       | name of archive to create (must be also a valid directory name)                                                                       |
+    |                                                       | ``NAME``                                          | specify the archive name                                                                                                              |
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``TARFILE``                                       | input tar file. "-" to read from stdin instead.                                                                                       |
     +-------------------------------------------------------+---------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
@@ -58,8 +58,8 @@ borg import-tar
 
 .. only:: latex
 
-    ARCHIVE
-        name of archive to create (must be also a valid directory name)
+    NAME
+        specify the archive name
     TARFILE
         input tar file. "-" to read from stdin instead.
 

docs/usage/info.rst

@@ -4,55 +4,17 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg info /path/to/repo::2017-06-29T11:00-srv
-    Archive name: 2017-06-29T11:00-srv
-    Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
+    $ borg info Tuesday2022-06-25T20:51:39
+    Archive name: Tuesday2022-06-25T20:51:39
+    Archive fingerprint: f7dea0788dfc026cc2be1c0f5b94beb4e4084eb3402fc40c38d8719b1bf2d943
     Comment:
-    Hostname: myhostname
-    Username: root
-    Time (start): Thu, 2017-06-29 11:03:07
-    Time (end): Thu, 2017-06-29 11:03:13
-    Duration: 5.66 seconds
-    Number of files: 17037
-    Command line: /usr/sbin/borg create /path/to/repo::2017-06-29T11:00-srv /srv
-    Utilization of max. archive size: 0%
-    ------------------------------------------------------------------------------
-                           Original size      Compressed size    Deduplicated size
-    This archive:               12.53 GB             12.49 GB              1.62 kB
-    All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                           Unique chunks         Total chunks
-    Chunk index:                 1015213            626934122
-
-    $ borg info /path/to/repo --last 1
-    Archive name: 2017-06-29T11:00-srv
-    Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
-    Comment:
-    Hostname: myhostname
-    Username: root
-    Time (start): Thu, 2017-06-29 11:03:07
-    Time (end): Thu, 2017-06-29 11:03:13
-    Duration: 5.66 seconds
-    Number of files: 17037
-    Command line: /usr/sbin/borg create /path/to/repo::2017-06-29T11:00-srv /srv
-    Utilization of max. archive size: 0%
-    ------------------------------------------------------------------------------
-                           Original size      Compressed size    Deduplicated size
-    This archive:               12.53 GB             12.49 GB              1.62 kB
-    All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                           Unique chunks         Total chunks
-    Chunk index:                 1015213            626934122
-
-    $ borg info /path/to/repo
-    Repository ID: d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-    Location: /path/to/repo
-    Encrypted: Yes (repokey)
-    Cache: /root/.cache/borg/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-    Security dir: /root/.config/borg/security/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
-    ------------------------------------------------------------------------------
-                           Original size      Compressed size    Deduplicated size
-    All archives:              121.82 TB            112.41 TB            215.42 GB
-
-                           Unique chunks         Total chunks
-    Chunk index:                 1015213            626934122
+    Hostname: mba2020
+    Username: tw
+    Time (start): Sat, 2022-06-25 20:51:40
+    Time (end): Sat, 2022-06-25 20:51:40
+    Duration: 0.03 seconds
+    Command line: /Users/tw/w/borg-env/bin/borg -r path/to/repo create --stats 'Tuesday{now}' src --progress
+    Utilization of maximum supported archive size: 0%
+    Number of files: 244
+    Original size: 13.80 MB
+    Deduplicated size: 531 B

docs/usage/info.rst.inc

@@ -6,16 +6,12 @@ borg info
 ---------
 .. code-block:: none
 
-    borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]
+    borg [common options] info [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                     |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to display information about                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -48,8 +44,6 @@ borg info
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to display information about
 
 
     optional arguments
@@ -70,7 +64,7 @@ borg info
 Description
 ~~~~~~~~~~~
 
-This command displays detailed information about the specified archive or repository.
+This command displays detailed information about the specified archive.
 
 Please note that the deduplicated sizes of the individual archives do not add
 up to the deduplicated size of the repository ("all archives"), because the two

docs/usage/init.rst

@@ -1,22 +0,0 @@
-.. include:: init.rst.inc
-
-Examples
-~~~~~~~~
-::
-
-    # Local repository, recommended repokey AEAD crypto modes
-    $ borg init --encryption=repokey-aes-ocb /path/to/repo
-    $ borg init --encryption=repokey-chacha20-poly1305 /path/to/repo
-    $ borg init --encryption=repokey-blake2-aes-ocb /path/to/repo
-    $ borg init --encryption=repokey-blake2-chacha20-poly1305 /path/to/repo
-
-    # Local repository (no encryption), not recommended
-    $ borg init --encryption=none /path/to/repo
-
-    # Remote repository (accesses a remote borg via ssh)
-    # repokey: stores the (encrypted) key into <REPO_DIR>/config
-    $ borg init --encryption=repokey-aes-ocb user@hostname:backup
-
-    # Remote repository (accesses a remote borg via ssh)
-    # keyfile: stores the (encrypted) key into ~/.config/borg/keys/
-    $ borg init --encryption=keyfile-aes-ocb user@hostname:backup

docs/usage/key.rst

@@ -11,7 +11,7 @@ Examples
 ::
 
     # Create a key file protected repository
-    $ borg init --encryption=keyfile -v /path/to/repo
+    $ borg rcreate --encryption=keyfile -v
     Initializing repository at "/path/to/repo"
     Enter new passphrase:
     Enter same passphrase again:
@@ -23,7 +23,7 @@ Examples
     Done.
 
     # Change key file passphrase
-    $ borg key change-passphrase -v /path/to/repo
+    $ borg key change-passphrase -v
     Enter passphrase for key /root/.config/borg/keys/mnt_backup:
     Enter new passphrase:
     Enter same passphrase again:
@@ -33,15 +33,15 @@ Examples
     # Import a previously-exported key into the specified
     # key file (creating or overwriting the output key)
     # (keyfile repositories only)
-    $ BORG_KEY_FILE=/path/to/output-key borg key import /path/to/repo /path/to/exported
+    $ BORG_KEY_FILE=/path/to/output-key borg key import /path/to/exported
 
 Fully automated using environment variables:
 
 ::
 
-    $ BORG_NEW_PASSPHRASE=old borg init -e=repokey repo
+    $ BORG_NEW_PASSPHRASE=old borg rcreate -e=repokey
     # now "old" is the current passphrase.
-    $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change-passphrase repo
+    $ BORG_PASSPHRASE=old BORG_NEW_PASSPHRASE=new borg key change-passphrase
     # now "new" is the current passphrase.
 
 

docs/usage/key_change-algorithm.rst.inc

@@ -6,23 +6,21 @@ borg key change-algorithm
 -------------------------
 .. code-block:: none
 
-    borg [common options] key change-algorithm [options] [REPOSITORY] ALGORITHM
+    borg [common options] key change-algorithm [options] ALGORITHM
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+----------------------+
-    | **positional arguments**                                                                      |
-    +-------------------------------------------------------+----------------+----------------------+
-    |                                                       | ``REPOSITORY`` |                      |
-    +-------------------------------------------------------+----------------+----------------------+
-    |                                                       | ``ALGORITHM``  | select key algorithm |
-    +-------------------------------------------------------+----------------+----------------------+
-    | .. class:: borg-common-opt-ref                                                                |
-    |                                                                                               |
-    | :ref:`common_options`                                                                         |
-    +-------------------------------------------------------+----------------+----------------------+
+    +-------------------------------------------------------+---------------+----------------------+
+    | **positional arguments**                                                                     |
+    +-------------------------------------------------------+---------------+----------------------+
+    |                                                       | ``ALGORITHM`` | select key algorithm |
+    +-------------------------------------------------------+---------------+----------------------+
+    | .. class:: borg-common-opt-ref                                                               |
+    |                                                                                              |
+    | :ref:`common_options`                                                                        |
+    +-------------------------------------------------------+---------------+----------------------+
 
     .. raw:: html
 
@@ -34,8 +32,6 @@ borg key change-algorithm
 
 .. only:: latex
 
-    REPOSITORY
-
     ALGORITHM
         select key algorithm
 

docs/usage/key_change-location.rst.inc

@@ -6,7 +6,7 @@ borg key change-location
 ------------------------
 .. code-block:: none
 
-    borg [common options] key change-location [options] [REPOSITORY] KEY_LOCATION
+    borg [common options] key change-location [options] KEY_LOCATION
 
 .. only:: html
 
@@ -15,8 +15,6 @@ borg key change-location
     +-------------------------------------------------------+------------------+----------------------------------------------------------------+
     | **positional arguments**                                                                                                                  |
     +-------------------------------------------------------+------------------+----------------------------------------------------------------+
-    |                                                       | ``REPOSITORY``   |                                                                |
-    +-------------------------------------------------------+------------------+----------------------------------------------------------------+
     |                                                       | ``KEY_LOCATION`` | select key location                                            |
     +-------------------------------------------------------+------------------+----------------------------------------------------------------+
     | **optional arguments**                                                                                                                    |
@@ -38,8 +36,6 @@ borg key change-location
 
 .. only:: latex
 
-    REPOSITORY
-
     KEY_LOCATION
         select key location
 
@@ -56,8 +52,10 @@ Description
 
 Change the location of a borg key. The key can be stored at different locations:
 
-keyfile: locally, usually in the home directory
-repokey: inside the repo (in the repo config)
+- keyfile: locally, usually in the home directory
+- repokey: inside the repo (in the repo config)
+
+Please note:
 
-Note: this command does NOT change the crypto algorithms, just the key location,
-      thus you must ONLY give the key location (keyfile or repokey).
+This command does NOT change the crypto algorithms, just the key location,
+thus you must ONLY give the key location (keyfile or repokey).

docs/usage/key_change-passphrase.rst.inc

@@ -6,21 +6,17 @@ borg key change-passphrase
 --------------------------
 .. code-block:: none
 
-    borg [common options] key change-passphrase [options] [REPOSITORY]
+    borg [common options] key change-passphrase [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+--+
-    | **positional arguments**                                                  |
-    +-------------------------------------------------------+----------------+--+
-    |                                                       | ``REPOSITORY`` |  |
-    +-------------------------------------------------------+----------------+--+
-    | .. class:: borg-common-opt-ref                                            |
-    |                                                                           |
-    | :ref:`common_options`                                                     |
-    +-------------------------------------------------------+----------------+--+
+    +-------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                        |
+    |                                                       |
+    | :ref:`common_options`                                 |
+    +-------------------------------------------------------+
 
     .. raw:: html
 
@@ -32,8 +28,6 @@ borg key change-passphrase
 
 .. only:: latex
 
-    REPOSITORY
-
 
 
     :ref:`common_options`

docs/usage/key_export.rst.inc

@@ -6,29 +6,27 @@ borg key export
 ---------------
 .. code-block:: none
 
-    borg [common options] key export [options] [REPOSITORY] [PATH]
+    borg [common options] key export [options] [PATH]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                        |
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
-    |                                                       | ``REPOSITORY`` |                                                                        |
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
-    |                                                       | ``PATH``       | where to store the backup                                              |
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
-    | **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 |
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                                                  |
-    |                                                                                                                                                 |
-    | :ref:`common_options`                                                                                                                           |
-    +-------------------------------------------------------+----------------+------------------------------------------------------------------------+
+    +-------------------------------------------------------+---------------+------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                       |
+    +-------------------------------------------------------+---------------+------------------------------------------------------------------------+
+    |                                                       | ``PATH``      | where to store the backup                                              |
+    +-------------------------------------------------------+---------------+------------------------------------------------------------------------+
+    | **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 |
+    +-------------------------------------------------------+---------------+------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                 |
+    |                                                                                                                                                |
+    | :ref:`common_options`                                                                                                                          |
+    +-------------------------------------------------------+---------------+------------------------------------------------------------------------+
 
     .. raw:: html
 
@@ -40,8 +38,6 @@ borg key export
 
 .. only:: latex
 
-    REPOSITORY
-
     PATH
         where to store the backup
 

docs/usage/key_import.rst.inc

@@ -6,27 +6,25 @@ borg key import
 ---------------
 .. code-block:: none
 
-    borg [common options] key import [options] [REPOSITORY] [PATH]
+    borg [common options] key import [options] [PATH]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    | **positional arguments**                                                                                                          |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    |                                                       | ``REPOSITORY`` |                                                          |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    |                                                       | ``PATH``       | path to the backup ('-' to read from stdin)              |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    | **optional arguments**                                                                                                            |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    |                                                       | ``--paper``    | interactively import from a backup done with ``--paper`` |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                                    |
-    |                                                                                                                                   |
-    | :ref:`common_options`                                                                                                             |
-    +-------------------------------------------------------+----------------+----------------------------------------------------------+
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
+    | **positional arguments**                                                                                                       |
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
+    |                                                       | ``PATH``    | path to the backup ('-' to read from stdin)              |
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
+    | **optional arguments**                                                                                                         |
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
+    |                                                       | ``--paper`` | interactively import from a backup done with ``--paper`` |
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                 |
+    |                                                                                                                                |
+    | :ref:`common_options`                                                                                                          |
+    +-------------------------------------------------------+-------------+----------------------------------------------------------+
 
     .. raw:: html
 
@@ -38,8 +36,6 @@ borg key import
 
 .. only:: latex
 
-    REPOSITORY
-
     PATH
         path to the backup ('-' to read from stdin)
 

docs/usage/list.rst

@@ -4,14 +4,7 @@ Examples
 ~~~~~~~~
 ::
 
-    $ borg list /path/to/repo
-    Monday                               Mon, 2016-02-15 19:15:11
-    repo                                 Mon, 2016-02-15 19:26:54
-    root-2016-02-15                      Mon, 2016-02-15 19:36:29
-    newname                              Mon, 2016-02-15 19:50:19
-    ...
-
-    $ borg list /path/to/repo::root-2016-02-15
+    $ borg list root-2016-02-15
     drwxr-xr-x root   root          0 Mon, 2016-02-15 17:44:27 .
     drwxrwxr-x root   root          0 Mon, 2016-02-15 19:04:49 bin
     -rwxr-xr-x root   root    1029624 Thu, 2014-11-13 00:08:51 bin/bash
@@ -19,14 +12,14 @@ Examples
     -rwxr-xr-x root   root       2140 Fri, 2015-03-27 20:24:22 bin/bzdiff
     ...
 
-    $ borg list /path/to/repo::root-2016-02-15 --pattern "- bin/ba*"
+    $ borg list root-2016-02-15 --pattern "- bin/ba*"
     drwxr-xr-x root   root          0 Mon, 2016-02-15 17:44:27 .
     drwxrwxr-x root   root          0 Mon, 2016-02-15 19:04:49 bin
     lrwxrwxrwx root   root          0 Fri, 2015-03-27 20:24:26 bin/bzcmp -> bzdiff
     -rwxr-xr-x root   root       2140 Fri, 2015-03-27 20:24:22 bin/bzdiff
     ...
 
-    $ borg list /path/to/repo::archiveA --format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}"
+    $ borg list archiveA --format="{mode} {user:6} {group:6} {size:8d} {isomtime} {path}{extra}{NEWLINE}"
     drwxrwxr-x user   user          0 Sun, 2015-02-01 11:00:00 .
     drwxrwxr-x user   user          0 Sun, 2015-02-01 11:00:00 code
     drwxrwxr-x user   user          0 Sun, 2015-02-01 11:00:00 code/myproject
@@ -34,11 +27,11 @@ Examples
     -rw-rw-r-- user   user    1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.text
     ...
 
-    $ borg list /path/to/repo/::archiveA --pattern 're:\.ext$'
+    $ borg list archiveA --pattern 're:\.ext$'
     -rw-rw-r-- user   user    1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext
     ...
 
-    $ borg list /path/to/repo/::archiveA --pattern 're:.ext$'
+    $ borg list archiveA --pattern 're:.ext$'
     -rw-rw-r-- user   user    1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.ext
     -rw-rw-r-- user   user    1416192 Sun, 2015-02-01 11:00:00 code/myproject/file.text
     ...

docs/usage/list.rst.inc

@@ -6,57 +6,41 @@ borg list
 ---------
 .. code-block:: none
 
-    borg [common options] list [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
+    borg [common options] list [options] NAME [PATH...]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                       |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to list contents of                                                                                                                                                                                                                                |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``PATH``                              | paths to list; patterns are supported                                                                                                                                                                                                                                    |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **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}")                                                                                          |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--json``                            | Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available. |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--json-lines``                      | Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available. |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                                 |
-    |                                                                                                                                                                                                                                                                                                                                                                                                |
-    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                                          |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **Archive filters** — Archive filters can be applied to repository targets.                                                                                                                                                                                                                                                                                                                    |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``-P PREFIX``, ``--prefix PREFIX``    | only consider archive names starting with this prefix.                                                                                                                                                                                                                   |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``-a GLOB``, ``--glob-archives GLOB`` | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.                                                                                                                   |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--sort-by KEYS``                    | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                                                                                                                                         |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--first N``                         | consider first N archives after other filters were applied                                                                                                                                                                                                               |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--last N``                          | consider last N archives after other filters were applied                                                                                                                                                                                                                |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                                          |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN                                                                                                                                                                                                                                           |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--exclude-from EXCLUDEFILE``        | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                     |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--pattern PATTERN``                 | include/exclude paths matching PATTERN                                                                                                                                                                                                                                   |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``--patterns-from PATTERNFILE``       | read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                                             |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``NAME``                              | specify the archive name                                                                                                                                                                                                        |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``PATH``                              | paths to list; patterns are supported                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                                                                                                                                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--short``                           | only print file/directory names, nothing else                                                                                                                                                                                   |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--format FORMAT``                   | specify format for file listing (default: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}")                                                                                                                       |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--json-lines``                      | Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available. |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                  |
+    |                                                                                                                                                                                                                                                                                                                                 |
+    | :ref:`common_options`                                                                                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                                                                                                                           |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``-e PATTERN``, ``--exclude PATTERN`` | exclude paths matching PATTERN                                                                                                                                                                                                  |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--exclude-from EXCLUDEFILE``        | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                            |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--pattern PATTERN``                 | include/exclude paths matching PATTERN                                                                                                                                                                                          |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--patterns-from PATTERNFILE``       | read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                    |
+    +-------------------------------------------------------+---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
     .. raw:: html
 
@@ -68,31 +52,21 @@ borg list
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to list contents of
+    NAME
+        specify the archive name
     PATH
         paths to list; patterns are supported
 
 
     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}")
-        --json      Only valid for listing repository contents. Format output as JSON. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "barchive" key is therefore not available.
-        --json-lines    Only valid for listing archive contents. Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
+        --format FORMAT    specify format for file listing (default: "{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}")
+        --json-lines    Format output as JSON Lines. The form of ``--format`` is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. A "bpath" key is therefore not available.
 
 
     :ref:`common_options`
         |
 
-    Archive filters
-        -P PREFIX, --prefix PREFIX        only consider archive names starting with this prefix.
-        -a GLOB, --glob-archives GLOB     only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
-        --sort-by KEYS                    Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
-        --first N                         consider first N archives after other filters were applied
-        --last N                          consider last N archives after other filters were applied
-
-
     Exclusion options
         -e PATTERN, --exclude PATTERN     exclude paths matching PATTERN
         --exclude-from EXCLUDEFILE        read exclude patterns from EXCLUDEFILE, one per line
@@ -103,7 +77,7 @@ borg list
 Description
 ~~~~~~~~~~~
 
-This command lists the contents of a repository or an archive.
+This command lists the contents of an archive.
 
 For more help on include/exclude patterns, see the :ref:`borg_patterns` command output.
 
@@ -118,28 +92,17 @@ The ``--format`` option uses python's `format string syntax
 Examples:
 ::
 
-    $ borg list --format '{archive}{NL}' /path/to/repo
-    ArchiveFoo
-    ArchiveBar
-    ...
-
-    # {VAR:NUMBER} - pad to NUMBER columns.
-    # Strings are left-aligned, numbers are right-aligned.
-    # Note: time columns except ``isomtime``, ``isoctime`` and ``isoatime`` cannot be padded.
-    $ borg list --format '{archive:36} {time} [{id}]{NL}' /path/to/repo
-    ArchiveFoo                           Thu, 2021-12-09 10:22:28 [0b8e9a312bef3f2f6e2d0fc110c196827786c15eba0188738e81697a7fa3b274]
-    $ borg list --format '{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}' /path/to/repo::ArchiveFoo
+    $ borg list --format '{mode} {user:6} {group:6} {size:8} {mtime} {path}{extra}{NL}' ArchiveFoo
     -rw-rw-r-- user   user       1024 Thu, 2021-12-09 10:22:17 file-foo
     ...
 
     # {VAR:<NUMBER} - pad to NUMBER columns left-aligned.
     # {VAR:>NUMBER} - pad to NUMBER columns right-aligned.
-    $ borg list --format '{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}' /path/to/repo::ArchiveFoo
+    $ borg list --format '{mode} {user:>6} {group:>6} {size:<8} {mtime} {path}{extra}{NL}' ArchiveFoo
     -rw-rw-r--   user   user 1024     Thu, 2021-12-09 10:22:17 file-foo
     ...
 
 The following keys are always available:
-
 - NEWLINE: OS dependent line separator
 - NL: alias of NEWLINE
 - NUL: NUL character for creating print0 / xargs -0 like output, see barchive and bpath keys below
@@ -148,24 +111,6 @@ The following keys are always available:
 - CR
 - LF
 
-Keys available only when listing archives in a repository:
-
-- archive: archive name interpreted as text (might be missing non-text characters, see barchive)
-- name: alias of "archive"
-- barchive: verbatim archive name, can contain any character except NUL
-- comment: archive comment interpreted as text (might be missing non-text characters, see bcomment)
-- bcomment: verbatim archive comment, can contain any character except NUL
-- id: internal ID of the archive
-
-- start: time (start) of creation of the archive
-- time: alias of "start"
-- end: time (end) of creation of the archive
-- command_line: command line which was used to create the archive
-
-- hostname: hostname of host on which this archive was created
-- username: username of user who created this archive
-
-
 Keys available only when listing files in an archive:
 
 - type
@@ -176,14 +121,13 @@ Keys available only when listing files in an archive:
 - group
 - path: path interpreted as text (might be missing non-text characters, see bpath)
 - bpath: verbatim POSIX path, can contain any character except NUL
-- source: link target for links (identical to linktarget)
+- source: link target for symlinks (identical to linktarget)
 - linktarget
+- hlid: hard link identity (same if hardlinking same fs object)
 - flags
 
 - size
-- csize: compressed size
 - dsize: deduplicated size
-- dcsize: deduplicated compressed size
 - num_chunks: number of chunks in this file
 - unique_chunks: number of unique chunks in this file
 

docs/usage/mount.rst

@@ -10,21 +10,14 @@ Examples
     # Mounting the repository shows all archives.
     # Archives are loaded lazily, expect some delay when navigating to an archive
     # for the first time.
-    $ borg mount /path/to/repo /tmp/mymountpoint
+    $ borg mount /tmp/mymountpoint
     $ ls /tmp/mymountpoint
     root-2016-02-14 root-2016-02-15
     $ borg umount /tmp/mymountpoint
 
-    # Mounting a specific archive is possible as well.
-    $ borg mount /path/to/repo::root-2016-02-15 /tmp/mymountpoint
-    $ ls /tmp/mymountpoint
-    bin  boot  etc	home  lib  lib64  lost+found  media  mnt  opt
-    root  sbin  srv  tmp  usr  var
-    $ borg umount /tmp/mymountpoint
-
     # The "versions view" merges all archives in the repository
     # and provides a versioned view on files.
-    $ borg mount -o versions /path/to/repo /tmp/mymountpoint
+    $ borg mount -o versions /tmp/mymountpoint
     $ ls -l /tmp/mymountpoint/home/user/doc.txt/
     total 24
     -rw-rw-r-- 1 user group 12357 Aug 26 21:19 doc.cda00bc9.txt
@@ -34,12 +27,12 @@ Examples
     # Archive filters are supported.
     # These are especially handy for the "versions view",
     # which does not support lazy processing of archives.
-    $ borg mount -o versions --glob-archives '*-my-home' --last 10 /path/to/repo /tmp/mymountpoint
+    $ borg mount -o versions --glob-archives '*-my-home' --last 10 /tmp/mymountpoint
 
     # Exclusion options are supported.
     # These can speed up mounting and lower memory needs significantly.
     $ borg mount /path/to/repo /tmp/mymountpoint only/that/path
-    $ borg mount --exclude '...' /path/to/repo /tmp/mymountpoint
+    $ borg mount --exclude '...' /tmp/mymountpoint
 
 
 borgfs
@@ -48,13 +41,9 @@ borgfs
 ::
 
     $ echo '/mnt/backup /tmp/myrepo fuse.borgfs defaults,noauto 0 0' >> /etc/fstab
-    $ echo '/mnt/backup::root-2016-02-15 /tmp/myarchive fuse.borgfs defaults,noauto 0 0' >> /etc/fstab
     $ mount /tmp/myrepo
-    $ mount /tmp/myarchive
     $ ls /tmp/myrepo
     root-2016-02-01 root-2016-02-2015
-    $ ls /tmp/myarchive
-    bin  boot  etc	home  lib  lib64  lost+found  media  mnt  opt  root  sbin  srv  tmp  usr  var
 
 .. Note::
 

docs/usage/mount.rst.inc

@@ -6,7 +6,7 @@ borg mount
 ----------
 .. code-block:: none
 
-    borg [common options] mount [options] REPOSITORY_OR_ARCHIVE MOUNTPOINT [PATH...]
+    borg [common options] mount [options] MOUNTPOINT [PATH...]
 
 .. only:: html
 
@@ -15,8 +15,6 @@ borg mount
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **positional arguments**                                                                                                                                                                                                                                                     |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY_OR_ARCHIVE``             | repository or archive to mount                                                                                                                         |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``MOUNTPOINT``                        | where to mount filesystem                                                                                                                              |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                                             | ``PATH``                              | paths to extract; patterns are supported                                                                                                               |
@@ -72,8 +70,6 @@ borg mount
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to mount
     MOUNTPOINT
         where to mount filesystem
     PATH

docs/usage/notes.rst

@@ -155,18 +155,18 @@ After the backup has completed, you remove the snapshots again.
 
     $ # create snapshots here
     $ lvdisplay > lvdisplay.txt
-    $ borg create --read-special /path/to/repo::arch lvdisplay.txt /dev/vg0/*-snapshot
+    $ borg create --read-special arch lvdisplay.txt /dev/vg0/*-snapshot
     $ # remove snapshots here
 
 Now, let's see how to restore some LVs from such a backup.
 
 ::
 
-    $ borg extract /path/to/repo::arch lvdisplay.txt
+    $ borg extract arch lvdisplay.txt
     $ # create empty LVs with correct sizes here (look into lvdisplay.txt).
     $ # we assume that you created an empty root and home LV and overwrite it now:
-    $ borg extract --stdout /path/to/repo::arch dev/vg0/root-snapshot > /dev/vg0/root
-    $ borg extract --stdout /path/to/repo::arch dev/vg0/home-snapshot > /dev/vg0/home
+    $ borg extract --stdout arch dev/vg0/root-snapshot > /dev/vg0/root
+    $ borg extract --stdout arch dev/vg0/home-snapshot > /dev/vg0/home
 
 
 .. _separate_compaction:
@@ -219,7 +219,7 @@ To activate append-only mode, set ``append_only`` to 1 in the repository config:
 
 ::
 
-    borg config /path/to/repo append_only 1
+    borg config append_only 1
 
 Note that you can go back-and-forth between normal and append-only operation with
 ``borg config``; it's not a "one way trip."
@@ -237,7 +237,7 @@ in ``.ssh/authorized_keys``:
     command="borg serve ..." ssh-rsa <key used for backup management>
 
 Running ``borg init`` via a ``borg serve --append-only`` server will *not* create
-an append-only repository. Running ``borg init --append-only`` creates an append-only
+an append-only repository. Running ``borg rcreate --append-only`` creates an append-only
 repository regardless of server settings.
 
 Example
@@ -282,7 +282,7 @@ than what you actually have in the repository now, after the rollback.
 
 Thus, you need to clear the cache::
 
-    borg delete --cache-only repo
+    borg rdelete --cache-only
 
 The cache will get rebuilt automatically. Depending on repo size and archive
 count, it may take a while.
@@ -307,7 +307,7 @@ mode, this is reversible, but ``borg check`` should be run before a writing/prun
 operation on an append-only repository to catch accidental or malicious corruption::
 
     # run without append-only mode
-    borg check --verify-data repo && borg compact repo
+    borg check --verify-data && borg compact
 
 Aside from checking repository & archive integrity you may want to also manually check
 backups to ensure their content seems correct.

docs/usage/prune.rst

@@ -18,21 +18,21 @@ first so you will see what it would do without it actually doing anything.
 
     # Keep 7 end of day and 4 additional end of week archives.
     # Do a dry-run without actually deleting anything.
-    $ borg prune -v --list --dry-run --keep-daily=7 --keep-weekly=4 /path/to/repo
+    $ borg prune -v --list --dry-run --keep-daily=7 --keep-weekly=4
 
     # Same as above but only apply to archive names starting with the hostname
     # of the machine followed by a "-" character:
-    $ borg prune -v --list --keep-daily=7 --keep-weekly=4 --prefix='{hostname}-' /path/to/repo
+    $ borg prune -v --list --keep-daily=7 --keep-weekly=4 --prefix='{hostname}-'
     # actually free disk space:
-    $ borg compact /path/to/repo
+    $ borg compact
 
     # Keep 7 end of day, 4 additional end of week archives,
     # and an end of month archive for every month:
-    $ borg prune -v --list --keep-daily=7 --keep-weekly=4 --keep-monthly=-1 /path/to/repo
+    $ borg prune -v --list --keep-daily=7 --keep-weekly=4 --keep-monthly=-1
 
     # Keep all backups in the last 10 days, 4 additional end of week archives,
     # and an end of month archive for every month:
-    $ borg prune -v --list --keep-within=10d --keep-weekly=4 --keep-monthly=-1 /path/to/repo
+    $ borg prune -v --list --keep-within=10d --keep-weekly=4 --keep-monthly=-1
 
 There is also a visualized prune example in ``docs/misc/prune-example.txt``:
 

docs/usage/prune.rst.inc

@@ -6,16 +6,12 @@ borg prune
 ----------
 .. code-block:: none
 
-    borg [common options] prune [options] [REPOSITORY]
+    borg [common options] prune [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                     |
-    +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                                             | ``REPOSITORY``                        | repository to prune                                                                                                                                    |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                       |
     +-----------------------------------------------------------------------------+---------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -66,8 +62,6 @@ borg prune
 
 .. only:: latex
 
-    REPOSITORY
-        repository to prune
 
 
     optional arguments

docs/usage/rcreate.rst

@@ -0,0 +1,25 @@
+.. _borg-rcreate:
+
+.. include:: rcreate.rst.inc
+
+Examples
+~~~~~~~~
+::
+
+    # Local repository
+    $ export BORG_REPO=/path/to/repo
+    # recommended repokey AEAD crypto modes
+    $ borg rcreate --encryption=repokey-aes-ocb
+    $ borg rcreate --encryption=repokey-chacha20-poly1305
+    $ borg rcreate --encryption=repokey-blake2-aes-ocb
+    $ borg rcreate --encryption=repokey-blake2-chacha20-poly1305
+    # no encryption, not recommended
+    $ borg rcreate --encryption=authenticated
+    $ borg rcreate --encryption=none
+
+    # Remote repository (accesses a remote borg via ssh)
+    $ export BORG_REPO=ssh://user@hostname/~/backup
+    # repokey: stores the (encrypted) key into <REPO_DIR>/config
+    $ borg rcreate --encryption=repokey-aes-ocb
+    # keyfile: stores the (encrypted) key into ~/.config/borg/keys/
+    $ borg rcreate --encryption=keyfile-aes-ocb

docs/usage/init.rst.inc → docs/usage/rcreate.rst.inc

@@ -1,24 +1,22 @@
 .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
 
-.. _borg_init:
+.. _borg_rcreate:
 
-borg init
----------
+borg rcreate
+------------
 .. code-block:: none
 
-    borg [common options] init [options] [REPOSITORY]
+    borg [common options] rcreate [options]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                                                                            |
-    +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``REPOSITORY``                     | repository to create                                                                                                                                                                                                                   |
     +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     | **optional arguments**                                                                                                                                                                                                                                                                                                              |
     +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                       | ``--other-repo SRC_REPOSITORY``    | reuse the key material from the other repository                                                                                                                                                                                       |
+    +-------------------------------------------------------+------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
     |                                                       | ``-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. |
@@ -44,11 +42,10 @@ borg init
 
 .. only:: latex
 
-    REPOSITORY
-        repository to create
 
 
     optional arguments
+        --other-repo SRC_REPOSITORY    reuse the key material from the other repository
         -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.
@@ -62,7 +59,7 @@ borg init
 Description
 ~~~~~~~~~~~
 
-This command initializes an empty repository. A repository is a filesystem
+This command creates a new, empty repository. A repository is a filesystem
 directory containing the deduplicated data from zero or more archives.
 
 Encryption mode TLDR
@@ -75,7 +72,7 @@ tips will come below):
 
 ::
 
-    borg init --encryption repokey /path/to/repo
+    borg rcreate --encryption repokey-aes-ocb
 
 Borg will:
 
@@ -137,13 +134,13 @@ in the upper part of the table, in the lower part is the old and/or unsafe(r) st
 +-----------------------------------+--------------+----------------+--------------------+---------+
 | Mode (K = keyfile or repokey)     | ID-Hash      | Encryption     | Authentication     | V >=    |
 +-----------------------------------+--------------+----------------+--------------------+---------+
-| K-blake2-chacha20-poly1305        | BLAKE2b      | CHACHA20       | POLY1305           | 1.3     |
+| K-blake2-chacha20-poly1305        | BLAKE2b      | CHACHA20       | POLY1305           | 2.0     |
 +-----------------------------------+--------------+----------------+--------------------+---------+
-| K-chacha20-poly1305               | HMAC-SHA-256 | CHACHA20       | POLY1305           | 1.3     |
+| K-chacha20-poly1305               | HMAC-SHA-256 | CHACHA20       | POLY1305           | 2.0     |
 +-----------------------------------+--------------+----------------+--------------------+---------+
-| K-blake2-aes-ocb                  | BLAKE2b      | AES256-OCB     | AES256-OCB         | 1.3     |
+| K-blake2-aes-ocb                  | BLAKE2b      | AES256-OCB     | AES256-OCB         | 2.0     |
 +-----------------------------------+--------------+----------------+--------------------+---------+
-| K-aes-ocb                         | HMAC-SHA-256 | AES256-OCB     | AES256-OCB         | 1.3     |
+| K-aes-ocb                         | HMAC-SHA-256 | AES256-OCB     | AES256-OCB         | 2.0     |
 +-----------------------------------+--------------+----------------+--------------------+---------+
 | K-blake2                          | BLAKE2b      | AES256-CTR     | BLAKE2b            | 1.1     |
 +-----------------------------------+--------------+----------------+--------------------+---------+
@@ -172,8 +169,6 @@ Key derivation functions
   The key encryption key is derived from your passphrase via argon2-id.
   Argon2 is considered more modern and secure than pbkdf2.
 
-- You can use ``--key-algorithm pbkdf2`` if you want to access your repo via old versions of borg.
-
 Our implementation of argon2-based key algorithm follows the cryptographic best practices:
 
 - It derives two separate keys from your passphrase: one to encrypt your key and another one

docs/usage/rdelete.rst

@@ -0,0 +1,13 @@
+.. include:: rdelete.rst.inc
+
+Examples
+~~~~~~~~
+::
+
+    # delete the whole repository and the related local cache:
+    $ borg rdelete
+    You requested to completely DELETE the repository *including* all archives it contains:
+    repo                                 Mon, 2016-02-15 19:26:54
+    root-2016-02-15                      Mon, 2016-02-15 19:36:29
+    newname                              Mon, 2016-02-15 19:50:19
+    Type 'YES' if you understand this and want to continue: YES

docs/usage/rdelete.rst.inc

@@ -0,0 +1,66 @@
+.. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!
+
+.. _borg_rdelete:
+
+borg rdelete
+------------
+.. code-block:: none
+
+    borg [common options] rdelete [options]
+
+.. only:: html
+
+    .. class:: borg-options-table
+
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    | **optional arguments**                                                                                                                                                              |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    |                                                       | ``-n``, ``--dry-run``    | do not change repository                                                                         |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    |                                                       | ``--list``               | output verbose list of archives                                                                  |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    |                                                       | ``--force``              | force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work. |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    |                                                       | ``--cache-only``         | delete only the local cache for the given repository                                             |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    |                                                       | ``--keep-security-info`` | keep the local security info when deleting a repository                                          |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                      |
+    |                                                                                                                                                                                     |
+    | :ref:`common_options`                                                                                                                                                               |
+    +-------------------------------------------------------+--------------------------+--------------------------------------------------------------------------------------------------+
+
+    .. raw:: html
+
+        <script type='text/javascript'>
+        $(document).ready(function () {
+            $('.borg-options-table colgroup').remove();
+        })
+        </script>
+
+.. only:: latex
+
+
+
+    optional arguments
+        -n, --dry-run     do not change repository
+        --list            output verbose list of archives
+        --force           force deletion of corrupted archives, use ``--force --force`` in case ``--force`` does not work.
+        --cache-only      delete only the local cache for the given repository
+        --keep-security-info    keep the local security info when deleting a repository
+
+
+    :ref:`common_options`
+        |
+
+Description
+~~~~~~~~~~~
+
+This command deletes the complete repository.
+
+When you delete a complete repository, the security info and local cache for it
+(if any) are also deleted. Alternatively, you can delete just the local cache
+with the ``--cache-only`` option, or keep the security info with the
+``--keep-security-info`` option.
+
+Always first use ``--dry-run --list`` to see what would be deleted.

docs/usage/recreate.rst

@@ -4,30 +4,25 @@ Examples
 ~~~~~~~~
 ::
 
-    # Make old (Attic / Borg 0.xx) archives deduplicate with Borg 1.x archives.
-    # Archives created with Borg 1.1+ and the default chunker params are skipped
-    # (archive ID stays the same).
-    $ borg recreate /mnt/backup --chunker-params default --progress
-
     # Create a backup with little but fast compression
-    $ borg create /mnt/backup::archive /some/files --compression lz4
+    $ borg create archive /some/files --compression lz4
     # Then compress it - this might take longer, but the backup has already completed,
     # so no inconsistencies from a long-running backup job.
-    $ borg recreate /mnt/backup::archive --recompress --compression zlib,9
+    $ borg recreate -a archive --recompress --compression zlib,9
 
     # Remove unwanted files from all archives in a repository.
     # Note the relative path for the --exclude option - archives only contain relative paths.
-    $ borg recreate /mnt/backup --exclude home/icke/Pictures/drunk_photos
+    $ borg recreate --exclude home/icke/Pictures/drunk_photos
 
     # Change archive comment
-    $ borg create --comment "This is a comment" /mnt/backup::archivename ~
-    $ borg info /mnt/backup::archivename
+    $ borg create --comment "This is a comment" archivename ~
+    $ borg info -a archivename
     Name: archivename
     Fingerprint: ...
     Comment: This is a comment
     ...
-    $ borg recreate --comment "This is a better comment" /mnt/backup::archivename
-    $ borg info /mnt/backup::archivename
+    $ borg recreate --comment "This is a better comment" -a archivename
+    $ borg info -a archivename
     Name: archivename
     Fingerprint: ...
     Comment: This is a better comment

docs/usage/recreate.rst.inc

@@ -6,65 +6,73 @@ borg recreate
 -------------
 .. code-block:: none
 
-    borg [common options] recreate [options] [REPOSITORY_OR_ARCHIVE] [PATH...]
+    borg [common options] recreate [options] [PATH...]
 
 .. only:: html
 
     .. class:: borg-options-table
 
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``REPOSITORY_OR_ARCHIVE``                         | repository or archive to recreate                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``PATH``                                          | paths to recreate; patterns are supported                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``-s``, ``--stats``                               | print statistics at end                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
-    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
-    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``-e PATTERN``, ``--exclude PATTERN``             | exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--exclude-from EXCLUDEFILE``                    | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--pattern PATTERN``                             | include/exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--patterns-from PATTERNFILE``                   | read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--exclude-caches``                              | exclude directories that contain a CACHEDIR.TAG file (http://www.bford.info/cachedir/spec.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--exclude-if-present NAME``                     | exclude directories that are tagged by containing a filesystem object with the given NAME                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--keep-exclude-tags``                           | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                                                                                                                                                                                                                                                                                                                                                                                                                                   |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    | **Archive options**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--target TARGET``                               | create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--comment COMMENT``                             | add a comment text to the archive                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--timestamp TIMESTAMP``                         | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.                                                                                                                                                                                                                                                                                                                                                                                                                          |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--recompress MODE``                             | recompress data chunks according to `MODE` and ``--compression``. Possible modes are `if-different`: recompress if current compression is with a different compression algorithm (the level is not considered); `always`: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and `never`: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, `if-different` will be used. Not passing --recompress is equivalent to "--recompress never". |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-    |                                                       | ``--chunker-params PARAMS``                       | specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: buzhash,19,23,21,4095                                                                                                                                                                                                                                                                                                                                                                              |
-    +-------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **positional arguments**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``PATH``                                          | paths to recreate; patterns are supported                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-s``, ``--stats``                               | print statistics at end                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | .. class:: borg-common-opt-ref                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+    | :ref:`common_options`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Exclusion options**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-e PATTERN``, ``--exclude PATTERN``             | exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--exclude-from EXCLUDEFILE``                    | read exclude patterns from EXCLUDEFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--pattern PATTERN``                             | include/exclude paths matching PATTERN                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--patterns-from PATTERNFILE``                   | read include/exclude patterns from PATTERNFILE, one per line                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--exclude-caches``                              | exclude directories that contain a CACHEDIR.TAG file (http://www.bford.info/cachedir/spec.html)                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--exclude-if-present NAME``                     | exclude directories that are tagged by containing a filesystem object with the given NAME                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--keep-exclude-tags``                           | if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    | **Archive filters** — Archive filters can be applied to repository targets.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-P PREFIX``, ``--prefix PREFIX``                | only consider archive names starting with this prefix.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-a GLOB``, ``--glob-archives GLOB``             | only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--sort-by KEYS``                                | Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--first N``                                     | consider first N archives after other filters were applied                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--last N``                                      | consider last N archives after other filters were applied                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--target TARGET``                               | create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-c SECONDS``, ``--checkpoint-interval SECONDS`` | write checkpoint every SECONDS seconds (Default: 1800)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--comment COMMENT``                             | add a comment text to the archive                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--timestamp TIMESTAMP``                         | manually specify the archive creation date/time (UTC, yyyy-mm-ddThh:mm:ss format). alternatively, give a reference file/directory.                                                                                                                                                                                                                                                                                                                                                                                                                          |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``-C COMPRESSION``, ``--compression COMPRESSION`` | select compression algorithm, see the output of the "borg help compression" command for details.                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--recompress MODE``                             | recompress data chunks according to `MODE` and ``--compression``. Possible modes are `if-different`: recompress if current compression is with a different compression algorithm (the level is not considered); `always`: recompress even if current compression is with the same compression algorithm (use this to change the compression level); and `never`: do not recompress (use this option to explicitly prevent recompression). If no MODE is given, `if-different` will be used. Not passing --recompress is equivalent to "--recompress never". |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+    |                                                                             | ``--chunker-params PARAMS``                       | specify the chunker parameters (ALGO, CHUNK_MIN_EXP, CHUNK_MAX_EXP, HASH_MASK_BITS, HASH_WINDOW_SIZE) or `default` to use the current defaults. default: buzhash,19,23,21,4095                                                                                                                                                                                                                                                                                                                                                                              |
+    +-----------------------------------------------------------------------------+---------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
     .. raw:: html
 
@@ -76,8 +84,6 @@ borg recreate
 
 .. only:: latex
 
-    REPOSITORY_OR_ARCHIVE
-        repository or archive to recreate
     PATH
         paths to recreate; patterns are supported
 
@@ -102,7 +108,12 @@ borg recreate
         --keep-exclude-tags               if tag objects are specified with ``--exclude-if-present``, don't omit the tag objects themselves from the backup archive
 
 
-    Archive options
+    Archive filters
+        -P PREFIX, --prefix PREFIX                    only consider archive names starting with this prefix.
+        -a GLOB, --glob-archives GLOB                 only consider archive names matching the glob. sh: rules apply, see "borg help patterns". ``--prefix`` and ``--glob-archives`` are mutually exclusive.
+        --sort-by KEYS                                Comma-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
+        --first N                                     consider first N archives after other filters were applied
+        --last N                                      consider last N archives after other filters were applied
         --target TARGET                               create a new archive with the name ARCHIVE, do not replace existing archive (only applies for a single archive)
         -c SECONDS, --checkpoint-interval SECONDS     write checkpoint every SECONDS seconds (Default: 1800)
         --comment COMMENT                             add a comment text to the archive