summaryrefslogtreecommitdiff
path: root/kyanite.sh
diff options
context:
space:
mode:
authorDerek Stevens <nilix@nilfm.cc>2020-08-31 18:20:16 -0400
committerDerek Stevens <nilix@nilfm.cc>2020-08-31 18:20:16 -0400
commitcfda9f62fb8d7238169ee860991ecec76a1a443e (patch)
treea2418f7eaf6baef782b3e11b043fe703f0db411a /kyanite.sh
parentb0202a3c4825305350a9b5308026bf6ad65e7bb0 (diff)
clarified usage
Diffstat (limited to 'kyanite.sh')
-rwxr-xr-xkyanite.sh18
1 files changed, 13 insertions, 5 deletions
diff --git a/kyanite.sh b/kyanite.sh
index 672b15d..bdd0644 100755
--- a/kyanite.sh
+++ b/kyanite.sh
@@ -2,13 +2,21 @@
helpme() {
echo "usage:"
- echo " kyanite.sh full|partial|restore SRC DEST [options]"
+ echo " $0 full|partial|restore SRC DEST [options]"
echo " COMMANDS:"
- echo " full: make a full backup of SRC to DEST/HOST/TIMESTAMP_full/"
- echo " this can be a remote path in user@host:path form too"
- echo " partial: make partial backup of SRC to DEST/HOST/TIMESTAMP_part/"
+ echo " full: Make a full backup of SRC to DEST/HOST/TIMESTAMP_full/"
+ echo " partial: Make partial backup of SRC to DEST/HOST/TIMESTAMP_part/"
echo " relative to the latest full backup in that directory"
- echo " restore: restore the backup at DEST/ to SRC/"
+ echo " restore: Restore the backup at DEST/ to SRC/"
+ echo " SRC:"
+ echo " Relative or absolute path for the source to backup or restore from."
+ echo " When backing up, can be a remote path in the form of user@host:path;"
+ echo " The HOST component of the kyanite backup path is gleaned from this if so."
+ echo " When restoring, this is the full path to the timestamped backup folder."
+ echo " DEST:"
+ echo " Relative or absolute path for the destination to backup or restore to."
+ echo " When backing up, this is path to the root of your kyanite backups."
+ echo " When retoring, this is the path to your restore destination."
echo " OPTIONS:"
echo " anything provided after DEST is passed as additional options to rsync,"
echo " e.g. '--exclude .cache'"