borgbackup/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2026-10-12 02:11:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix the quickstart example list sample and delete caution

Browse Source 
Step 5's borg list sample predated the timezone offset in the default
timestamp format (regenerated from a real run); the delete step claimed
a NAME "might match multiple archives" - borg aborts unless the name
matches exactly one archive; point at aid: and -a instead.

Co-Authored-By: Claude Fable 5 <[email protected]>
This commit is contained in:
Thomas Waldmann
2026-08-29 15:39:34 +02:00
co-authored by Claude Fable 5
parent 848a93574a
commit 661f613ab2
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/quickstart_example.rst.inc
+5 -4
View File
@@ -47,8 +47,8 @@
5. List the contents of the first archive::
$ borg -r /path/to/repo list aid:3affe017
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
drwxr-xr-x user group 0 Fri, 2026-08-28 12:22:30 +0200 home/user/Documents
-rw-r--r-- user group 7961 Fri, 2026-08-28 12:22:30 +0200 home/user/Documents/Important.doc
...
6. Restore the first archive by extracting the files relative to the current directory::
@@ -59,8 +59,9 @@
$ borg -r /path/to/repo delete aid:3affe017
Be careful if you use an archive NAME (and not an archive ID), as it might match multiple archives.
Always use ``--dry-run`` and ``--list`` first!
If you use an archive NAME (and not an archive ID), Borg will abort if the name matches multiple
archives (as with the two *docs* archives here); use ``aid:<archive-id>`` to delete one specific
archive, or ``-a PATTERN`` to delete multiple archives. Always use ``--dry-run`` and ``--list`` first!
8. Recover disk space by removing objects that are not referenced by any
archive any more::