From 9be12f79b90b5600659646d0987854ae2bd81df8 Mon Sep 17 00:00:00 2001 From: Andrew Davidson Date: Thu, 15 Jul 2021 21:11:57 -0700 Subject: [PATCH] updating readme --- readme.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/readme.md b/readme.md index 1cf38ff..7aa125b 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,4 @@ ```bash -#!/usr/bin/env bash - print_logo () { cat <<'EOF' _ _ _ @@ -9,8 +7,10 @@ cat <<'EOF' | |_) | (_| | (__| <| |_| | |_) |\__ \ | | | |_.__/ \__,_|\___|_|\_\\__,_| .__(_)___/_| |_| |_| + +A wrapper around restic to help control configuration. EOF -# Copyright (c) 2020 Andrew Davidson +# Copyright (c) 2021 Andrew Davidson } print_help () { @@ -19,13 +19,35 @@ print_help () { backup.sh 'command' 'destination' Supported Commands: + init - intiialize a new backup repository backup - initiate a backup of the home folder to the destination - list - list backups on the destination + check - check repository for consistency + snapshots - list backups on the destination prune - prune old backups on the destination + stats - print statistics about the backup repository + help - print this help + + Required Configuration: + \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.repo + - Define the repository path in this file + + \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.pwd + - Define the repository password in this file + + \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.paths + - list of paths to be backed up + + \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.exclude + - list of paths to be excluded + + \$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.keys + - OPTIONAL: bash exports of required keys for s3/b2 backups + + \$XDG_DATA_HOME/backup.sh/\$DESTINATION/\$DESTINATION.log + - empty file for logging + - Supported destinations: - royal - local borg/SFTP backup to Royal - wasabi - remote restic backup to Wasabi + """ } ```