From f5476a583d6d12cdc7a0737b104ce1586fec9748 Mon Sep 17 00:00:00 2001 From: Kristjan Eimre Date: Thu, 7 Dec 2023 17:19:10 +0200 Subject: [PATCH] fix docs --- docs/index.rst | 2 +- docs/pages/backup.md | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index abee521..c1b825d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -64,7 +64,7 @@ and does not require a server running. ---------------------------------------------- -:fa:`bookmark,mr-1` **Making a backup** + :fa:`bookmark,mr-1` **Making backups** Information on how to back up a container. diff --git a/docs/pages/backup.md b/docs/pages/backup.md index 7577ff3..fd2cfed 100644 --- a/docs/pages/backup.md +++ b/docs/pages/backup.md @@ -1,4 +1,4 @@ -# Backing up the container +# Making backups ## User instructions @@ -44,6 +44,20 @@ Options: ``` +Example usage: + +```console +$ dostore backup /path/to/backup +INFO:Last backup is '/path/to/backup/backup_20231207142602_ymqf', using it for rsync --link-dest. +INFO:Transferred /path/to/dostore/loose to /path/to/backup/live-backup +INFO:Dumped the SQLite database to /tmp/tmpgewwse3f/packs.idx +INFO:Transferred SQLite database to /path/to/backup/live-backup +INFO:Transferred /path/to/dostore/packs to /path/to/backup/live-backup +INFO:Backup moved from '/path/to/backup/live-backup' to '/path/to/backup/backup_20231207142913_pz7m'. +INFO:Added symlink 'last-backup' to 'backup_20231207142913_pz7m'. +INFO:Deleted old backup: /path/to/backup/backup_20231207131741_zar7 +``` + For more detailed information about how the backup is made, see the next section. ## Detailed info/design