zb-snap, readme

3 files changed, 17 insertions, 0 deletions

diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
--- a/README
+++ /dev/null
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7a833c8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+
+# ZFS-Backup
+
+The zfs backing-up tool. ha-ha.
+
+## Tools:
+
+- `zb-snap <volume>` creates a snapshot
+- `zb-cleanup <volume> <density>` destroys unnecessary snapshots
+- `zb-pull <volume> <remote_volume> <ssh_options>` pulls most recent snapshot of `remote_volume` to `volume`, using ssh called with `ssh_options`
+- `zb-cron` reads configuration from `/etc/zfs-backup.conf` and executes above 3 commands with config-specified parameters
diff --git a/zb-snap b/zb-snap
index 13f4793..3b32460 100755
--- a/zb-snap
+++ b/zb-snap
@@ -1,2 +1,8 @@
 #!/bin/sh
 
+if [ -z "$1" ] ; then
+	echo "usage: $0 <zfs_volume>" >&2
+	exit 1
+fi
+
+exec zfs snapshot "${1}@zb-`date '+%F %T %z' |tr + p`"