From 1585356262372c60d4fad2fbca95837bdcf220d7 Mon Sep 17 00:00:00 2001 From: Tobias Oetiker Date: Tue, 29 Jul 2014 15:46:37 +0200 Subject: [PATCH] better documentation --- bin/znapzendzetup | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/bin/znapzendzetup b/bin/znapzendzetup index 4c77c6f6..10af2dcc 100755 --- a/bin/znapzendzetup +++ b/bin/znapzendzetup @@ -277,10 +277,10 @@ where 'command' is one of the following: =head1 DESCRIPTION -Znapzend is a snapshot based zfs backup daemon creating snapshots on a -scheduled basis on the source filesystem and on a destination filesystem +Use znapzendsetup to configure your backup tasks. The cli is modled after +the zfs commandline. Below a few notes on main commands. -=head2 Create Command +=head2 B The heart of the znapzend backup is the plan. The plan specifies how often to backup and for how long to keep the backups. A plan is required both for @@ -360,6 +360,28 @@ e.g. for database locking/flushing (pre) and unlocking (post). =back +=head2 B + +to remove configuration from a dataset just give its name + + znapzendzetup I + +the B function understands the following options + +=over + +=item B<--dst>=I + +to only remove a destination, specify the key of the destionation. Use the +B function to see the keys. + +=back + +=head2 B + +modify the configuration of a dataset. see the descriptions in the B +function for details. + =head1 EXAMPLE znapzendzetup create -r --mbuffer=/opt/omni/bin/mbuffer \