summaryrefslogtreecommitdiffstats
path: root/system/yabsm/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/yabsm/README')
-rw-r--r--system/yabsm/README21
1 files changed, 21 insertions, 0 deletions
diff --git a/system/yabsm/README b/system/yabsm/README
new file mode 100644
index 0000000000..54aeaa4432
--- /dev/null
+++ b/system/yabsm/README
@@ -0,0 +1,21 @@
+Yabsm (yet another btrfs snapshot manageer) is a btrfs snapshot
+manager and backup system.
+
+To have the yabsm daemon start and stop with your host, add the
+following to /etc/rc.d/rc.local:
+
+ if [ -x /etc/rc.d/rc.yabsm ]; then
+ /etc/rc.d/rc.yabsm start
+ fi
+
+and add the following to /etc/rc.d/rc.local_shutdown (creating it if
+needed):
+
+ if [ -x /etc/rc.d/rc.yabsm ]; then
+ /etc/rc.d/rc.yabsm stop
+ fi
+
+Yabsm is configured via the /etc/yabsm.conf file. On installation, an
+example configuration will be installed to /etc/yabsm.conf.example.
+This example configuration is well documented and can be used (along
+with the manual) to help you create your own configuration.