Commit graph

87 commits

Author SHA1 Message Date
Thomas Waldmann
c4347a9dce
build usage / man 2026-06-16 14:17:43 +02:00
TW
5e2da157be
Merge pull request #9769 from ThomasWaldmann/docs-key-subcommands
docs: add docs for "key add", "key list" and "key remove"
2026-06-13 23:47:58 +02:00
Thomas Waldmann
d5cd72b179 docs: add docs for "key add", "key list" and "key remove"
The multi-key feature (#9743) added the "borg key add", "borg key list"
and "borg key remove" subcommands but never wired up their docs:

- scripts/make.py: map key_add/key_list/key_remove to the "key" usage
  group, so build_man can locate their examples (it previously aborted
  with FileNotFoundError: docs/usage/key_add.rst).
- docs/usage/key.rst: include the three new generated snippets so they
  show up on the HTML key page.
- regenerate the affected docs: new key_{add,list,remove}.rst.inc usage
  snippets, new borg-key-{add,list,remove}.1 man pages, and borg-key.1
  (SYNOPSIS + SEE ALSO now reference the new subcommands).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-13 21:37:21 +02:00
Thomas Waldmann
8f4231d21b key: allow --key-location for authenticated* modes
The authenticated and authenticated-blake3 modes do not encrypt data, but
they still have a real key (id/auth key material) stored as a key blob.
That blob can live as a keyfile or as a repokey just like the encrypted
modes, so make it configurable instead of always forcing repokey storage.

- AuthenticatedKeyBase: set LOCATION_CONFIGURABLE = True so --key-location
  (at repo-create) and "borg key change-location" apply.
- key change-location: only copy sessionid/cipher when present (those are
  AEAD-only; authenticated keys do not have them).
- repo-info: report the key storage location for authenticated keys too,
  and handle the authenticated-blake3 variant (was only "authenticated").
- repo-create help: stop claiming authenticated* has no keyfile/repokey
  storage; only "none" truly has no key.
- add change-location round-trip tests for authenticated mode.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-13 20:57:26 +02:00
Thomas Waldmann
f12f67a76d
build_usage build_man 2026-03-15 14:37:50 +01:00
Thomas Waldmann
fcbf7f3572
build_usage build_man 2025-12-23 18:00:09 +01:00
Thomas Waldmann
15f59233b5
completion: borg can now generate completion scripts for supported shells, fixes #9172
Added `shtab` dependency for shell completion functionality:
- bash completion (works).
- zsh completion (known-broken due to iterative/shtab#183).
2025-11-17 18:47:00 +01:00
Thomas Waldmann
f327af11a6
build_usage build_man 2025-08-02 11:12:20 +02:00
Thomas Waldmann
9b26b1011a
build_usage build_man 2025-06-18 17:35:37 +02:00
Thomas Waldmann
fa01a2d46a
build_usage build_man 2025-05-22 13:21:21 +02:00
Thomas Waldmann
6e548ed1f0
build_man build_usage 2025-05-19 23:20:38 +02:00
Thomas Waldmann
7644b04df2
docs: remove outdated docs/man files about borg change-passphrase
this is borg key change-passphrase now.
2025-05-19 23:18:19 +02:00
Thomas Waldmann
524d927871
build_usage build_man 2025-05-06 01:37:17 +02:00
Thomas Waldmann
477e8f53fb
build_man build_usage 2025-04-28 21:42:30 +02:00
Thomas Waldmann
4550a49b0f
build_usage / build_man 2025-04-21 21:08:42 +02:00
Björn Ketelaars
cf6a324afa borg2 - Support other OpenSSL versions on OpenBSD
`setup.py` hardcoded crypto library paths for OpenBSD, causing build
issue when OpenBSD drops specific OpenSSL version. Solution is to make
paths configurable.

Addresses #8553.
2024-11-23 23:01:44 +01:00
Thomas Waldmann
37077a55e7
build_usage build_man 2024-11-16 20:14:16 +01:00
Thomas Waldmann
66e17ff6c8
build_usage, build_man 2024-10-31 20:50:06 +01:00
Thomas Waldmann
4b7ab4f087
build_usage / build_man 2024-10-03 12:30:58 +02:00
Thomas Waldmann
e274860983
tag: set, add, remove tags 2024-10-02 23:52:39 +02:00
Thomas Waldmann
de439ee839
analyze: sum up changed chunks per parent directory 2024-10-02 16:14:44 +02:00
Thomas Waldmann
fb496bf1b7
build_usage build_man 2024-09-26 07:57:01 +02:00
Thomas Waldmann
bb31b42310
build_usage build_man 2024-09-09 16:58:06 +02:00
Thomas Waldmann
7f1fc0cf63
docs: build_man 2024-09-08 18:11:44 +02:00
Thomas Waldmann
ecb838d5e7
src: fix man page names 2024-09-08 18:11:41 +02:00
Thomas Waldmann
b50ed04ffc
build_usage / build_man 2024-09-08 12:02:17 +02:00
Thomas Waldmann
edfca29b97
build_usage / build_man 2024-07-19 20:40:15 +02:00
Thomas Waldmann
b69c937cb7
build_man 2024-02-20 17:12:43 +01:00
Thomas Waldmann
3f75950226
build_usage / build_man 2023-09-14 15:52:08 +02:00
Thomas Waldmann
4dca508848
build_man 2023-06-11 23:10:23 +02:00
Thomas Waldmann
f06d3cc9c8
build_man 2023-02-26 21:32:44 +01:00
Thomas Waldmann
ac1df899aa
build_man 2023-01-03 00:37:04 +01:00
Paul D
991b53ebea Misc fixes. 2022-12-29 22:26:55 +00:00
Paul D
8ada680c87 'Want' fixes
aka who are you to presume what I want?
2022-12-29 22:26:55 +00:00
Paul D
253d8e8d4e Docs grammar fixes
joined split infinitives, and relocated adverbs appropriately.
2022-12-29 22:26:54 +00:00
Paul D
a85b643866 Docs grammar fixes.
One cannot "to not x", but one can "not to x".
Avoiding split infinitives gives the added bonus that machine
translation yields better results.

setup (n/adj) vs set(v) up. We don't "I setup it" but "I set it up".

Likewise for login(n/adj) and log(v) in, backup(n/adj) and back(v) up.
2022-12-29 00:01:48 +00:00
Thomas Waldmann
af93136ca7
build_man 2022-11-26 22:23:46 +01:00
Thomas Waldmann
3f159ca3bb build_man / build_usage 2022-10-02 15:51:17 +02:00
Thomas Waldmann
18ca2ab3ce build_usage build_man 2022-09-10 18:15:45 +02:00
Thomas Waldmann
f5b7ae5b30 build_usage build_man 2022-08-07 19:20:34 +02:00
Thomas Waldmann
c7c7690b26 build_man build_usage 2022-08-03 22:19:12 +02:00
Thomas Waldmann
357aa5241b build_usage / build_man 2022-07-17 09:23:06 +02:00
Thomas Waldmann
6fa8d11ecc build_usage ; build_man 2022-07-04 14:09:19 +02:00
Thomas Waldmann
0a7baa53c4 docs: fix borg transfer formatting / rendering, fixes #6800 2022-06-26 20:29:10 +02:00
Thomas Waldmann
9680538a70 fix rendering of list/rlist help 2022-06-26 20:08:38 +02:00
Thomas Waldmann
ab25bf8175 build_usage build_man 2022-06-26 13:56:33 +02:00
Thomas Waldmann
51cf85e627 build_usage / build_man / doc updates 2022-06-25 21:58:19 +02:00
Thomas Waldmann
9f86c375b4 python setup.py build_man 2022-04-14 21:25:12 +02:00
Thomas Waldmann
6641a9629d build_man 2022-02-19 18:48:13 +01:00
Thomas Waldmann
ef8aac2e4c build_man 2022-02-05 17:52:25 +01:00