amd/backup.sh
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Catching up the readme

Browse source
This commit is contained in:
Andrew Davidson 2021-07-16 06:48:48 -07:00
parent c8f66d3976
commit 3328c83133
Signed by: amd
GPG key ID: 17AF8F2A49CF25C6
1 changed files with 10 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
readme.md
View file

@ -16,16 +16,21 @@ EOF
print_help () {
echo -e """
Usage:
backup.sh 'command' 'destination'
backup.sh 'command' 'destination' 'input'
Supported Commands:
init - intiialize a new backup repository
backup - initiate a backup of the home folder to 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
find - find a file by a string in the repository (requires input)
ex: backup.sh find s3 critical_file.doc
help - print this help
init - intiialize a new backup repository
prune - prune old backups on the destination
restore - restores file from repository (requires input)
ex: backup.sh restore s3 latest --target=/tmp/restore --include=/home/user/Documents
snapshots - list backups on the destination
stats - print statistics about the backup repository
unlock - unlock a locked repository - use for stale locks
Required Configuration:
\$XDG_CONFIG_HOME/backup.sh/\$DESTINATION/\$DESTINATION.repo