goebbe
66e92636d2
Clarify excluded and included flags for dry-run in borg the docs
...
Rewording of the "flags" description in the docs of borg 1.4.
https://github.com/borgbackup/borg/issues/8556
2024-11-24 13:44:39 +01:00
Martin Richtarsky
05837fbeb7
docs/FAQ: Clean up entries regarding SSH settings
...
Link to recommended ones
(cherry picked from commit b913d9dd1a
2024-11-15 07:40:21 +00:00
Thomas Waldmann
cf472302dc
docs: better link modern return codes, fixes #8370
2024-10-05 19:14:51 +02:00
Eddie Carswell
4f110f8bde
Update repository URLs in docs to use new syntax
...
Fixes #8361
Signed-off-by: Eddie Carswell <eddiecarswell13@yahoo.com>
2024-09-10 18:08:18 -05:00
William Bonnaventure
f3c1444a41
Update docs for BORG_USE_CHUNKS_ARCHIVE
2024-07-14 07:24:37 +02:00
Thomas Waldmann
7b8acc925f
docs: add examples using :: positional argument, fixes #8255
...
Simply omitting the first positional argument (REPO) does
not work because borg then gets confused.
2024-06-30 17:31:22 +02:00
Thomas Waldmann
a41cc1750f
build_usage ; build_man
2024-03-30 22:19:39 +01:00
Thomas Waldmann
5b96d5acc3
create: add the slashdot hack, fixes #4685
2024-01-30 14:01:40 +01:00
Thomas Waldmann
4a65f9c943
docs: do not refer to setup.py installation method
...
Invoking setup.py is deprecated.
2024-01-29 20:39:02 +01:00
Thomas Waldmann
bdacc84ceb
build_usage build_man
2024-01-20 19:25:08 +01:00
Thomas Waldmann
5eaabea647
build_usage
2024-01-01 21:16:30 +01:00
Thomas Waldmann
62ad0369ef
update "modern" error RCs (docs and code)
2023-12-27 13:45:48 +01:00
Marc Kohaupt
05fa6fcab2
typo: notes.rst
2023-12-23 18:58:47 +01:00
Thomas Waldmann
46c1e01d29
build_usage
2023-12-02 01:01:46 +01:00
Thomas Waldmann
05cec8b3b0
docs: OS X -> macOS
2023-10-27 20:31:26 +02:00
Thomas Waldmann
661e5cccd3
docs: minor fixes/update to notes
2023-10-27 20:27:51 +02:00
Thomas Waldmann
d13b5d5557
docs: remove info about borg 1.0 files per dir
2023-10-27 20:26:27 +02:00
Thomas Waldmann
d05d02f238
implement BORG_WORKAROUNDS=ignore_invalid_archive_tam, see #7791
2023-08-31 00:36:04 +02:00
Thomas Waldmann
509a5fd71c
build_usage / build_man
2023-08-30 03:49:47 +02:00
Thomas Waldmann
276781081b
docs: fix borg init command in environment.rst.inc
...
It mentioned borg rcreate due to a bad backport from master.
Must be borg init in borg 1.2.x.
2023-08-24 11:49:17 +02:00
Thomas Waldmann
b419b6ad03
build_man / build_usage
2023-07-20 18:57:22 +02:00
TW
4721a35863
Merge pull request #7702 from ThomasWaldmann/authenticated-no-key-1.2
...
BORG_WORKAROUNDS=authenticated_no_key, fixes #7700
2023-07-07 01:02:41 +02:00
Tim Düsterhus
b58c6ce3b1
Improve the documentation for --keep-within
...
Move the explanation below the general explanation of the `--keep-*` option
behavior rephrase the last sentence to make it clear that it works like the
other options that were explained in the previous paragraph.
Resolves #7687
(cherry picked from commit a6f452a050
2023-07-04 09:16:39 +02:00
Thomas Waldmann
8ac7178ab9
BORG_WORKAROUNDS=authenticated_no_key to extract from authenticated repos without key, fixes #7700
2023-07-03 15:38:21 +02:00
Thomas Waldmann
893530fdac
list: fix --pattern examples, fixes #7611
...
- pattern needs to start with + - !
- first match wins
- the default is to list everything, thus a 2nd pattern
is needed to exclude everything not matched by 1st pattern.
2023-06-27 21:00:05 +02:00
Thomas Waldmann
0d14f3b36f
build_usage
2023-03-23 22:11:45 +01:00
Thomas Waldmann
e6b8e03e19
BORG_KEY_FILE: clarify docs, fixes #7444
2023-03-22 18:52:58 +01:00
Thomas Waldmann
47e0f9bcb0
remove BORG_LIBB2_PREFIX (not used any more)
...
the code now uses hashlib.blake2b from python stdlib.
2023-01-10 14:09:28 +01:00
Thomas Waldmann
ec49d60d1f
build_usage
2022-12-24 18:09:32 +01:00
Thomas Waldmann
90a937e1ed
remove deprecated --prefix from docs, fixes #7109
...
also:
- rather mention --glob-archives
- rather test --glob-archives
2022-12-24 14:44:05 +01:00
Thomas Waldmann
92ca260fd8
build_usage ; build_man
2022-08-20 15:38:10 +02:00
Thomas Waldmann
a7c1c1cb16
build_usage
2022-06-05 20:13:46 +02:00
Thalian
2694652e37
#6407 - Document Borg 1.2 pattern behavior change
...
Backport from master: Make clear that absolute paths always go into the matcher as if they are relative (without leading slash). Adapt all examples accordingly.
2022-05-27 15:14:01 +02:00
Thomas Waldmann
9a8eec6af1
build_usage
2022-02-19 18:47:47 +01:00
Thomas Waldmann
b430c8d15a
build_usage
2022-02-05 17:52:25 +01:00
Thomas Waldmann
6c517e4c25
docs: FUSE "versions" view is not experimental any more
2022-01-31 21:01:49 +01:00
Thomas Waldmann
c643210741
docs: fix tar-related doc structure
2022-01-23 17:16:20 +01:00
Thomas Waldmann
572e996d9a
build_usage
2022-01-23 15:52:21 +01:00
Thomas Waldmann
78f0f3518e
remove leftovers of BORG_HOSTNAME_IS_UNIQUE from docs
...
thanks to @snsmac for the hint: there is no code implementing this any more. it was replaced by
BORG_HOST_ID (if needed).
2022-01-20 23:38:43 +01:00
Chen Yufei
7e746e10e7
docs: excluded parent dir's metadata can't restore. ( #6062 )
...
docs: if parent dir is not extracted, we do not have its metadata
2022-01-20 02:04:15 +01:00
Reiko Asakura
e38f0b26b0
Workaround for volume shadow copy in WSL1
2021-12-24 15:15:23 -05:00
TW
03ab4dc116
Merge pull request #6085 from hexagonrecursion/fix-build-man
...
Fix exceptions thrown by `setup.py build_man`
2021-12-10 18:15:20 +01:00
Andrey Bienkowski
dbfef31783
borg serve: improve ssh forced commands docs ( #6083 )
...
borg serve: improve ssh forced commands docs
Co-authored-by: Andrey Bienkowski <hexagon-recursion@posteo.net>
2021-12-10 18:11:25 +01:00
Andrey Bienkowski
37e1ae4735
Fix exceptions thrown by setup.py build_man
...
While doing some doc updates I needed a way to test them - to build
the documentation and inspect the output. I ran into an issue:
running python setup.py build_man was throwing exceptions:
1. The import-tar parser had a None description causing:
File "/home/user/borg/setup_docs.py", line 451, in write_heading
write(char * len(header))
TypeError: object of type 'NoneType' has no len()
2. There was no docs/usage/import-tar.rst causing an exception too
2021-12-10 10:51:26 +03:00
remyabel
e25095364b
docs: clarify pattern usage with commands ( #5959 )
...
docs: clarify pattern usage with commands, fixes #5176
2021-08-21 16:02:11 +02:00
Tommy Nguyen
7639465ad4
docs: clarify pp pattern type
...
Fixes : #5300
This incorporates the comments from `patterns.py` into the documentation
to clarify the difference between `pp` and `pf`.
2021-08-07 07:38:04 -04:00
TW
e6811748b1
Merge pull request #5873 from ThomasWaldmann/disable-selftest-1.1
...
implement BORG_SELFTEST env variable, fixes #5871
2021-07-03 12:31:13 +02:00
James Buren
4f9e30e980
resolve clarify borg check --verify-data ( #5808 )
2021-06-18 15:00:14 -05:00
James Buren
8394ae6932
add notice about defective hardware to check documentation ( #5753 )
2021-06-18 01:26:57 -05:00
Thomas Waldmann
a99ae950c9
build_usage
2021-05-11 22:33:55 +02:00
