Skip to content

Commit 1585356

Browse files
committed
better documentation
1 parent 0d545dd commit 1585356

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

bin/znapzendzetup

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,10 +277,10 @@ where 'command' is one of the following:
277277
278278
=head1 DESCRIPTION
279279
280-
Znapzend is a snapshot based zfs backup daemon creating snapshots on a
281-
scheduled basis on the source filesystem and on a destination filesystem
280+
Use znapzendsetup to configure your backup tasks. The cli is modled after
281+
the zfs commandline. Below a few notes on main commands.
282282
283-
=head2 Create Command
283+
=head2 B<create>
284284
285285
The heart of the znapzend backup is the plan. The plan specifies how often
286286
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).
360360
361361
=back
362362
363+
=head2 B<delete>
364+
365+
to remove configuration from a dataset just give its name
366+
367+
znapzendzetup I<dataset>
368+
369+
the B<delete> function understands the following options
370+
371+
=over
372+
373+
=item B<--dst>=I<key>
374+
375+
to only remove a destination, specify the key of the destionation. Use the
376+
B<list> function to see the keys.
377+
378+
=back
379+
380+
=head2 B<edit>
381+
382+
modify the configuration of a dataset. see the descriptions in the B<create>
383+
function for details.
384+
363385
=head1 EXAMPLE
364386
365387
znapzendzetup create -r --mbuffer=/opt/omni/bin/mbuffer \

0 commit comments

Comments
 (0)