Skip to content

Commit

Permalink
better documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
oetiker committed Jul 29, 2014
1 parent 0d545dd commit 1585356
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions bin/znapzendzetup
Original file line number Diff line number Diff line change
Expand Up @@ -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<create>
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
Expand Down Expand Up @@ -360,6 +360,28 @@ e.g. for database locking/flushing (pre) and unlocking (post).
=back
=head2 B<delete>
to remove configuration from a dataset just give its name
znapzendzetup I<dataset>
the B<delete> function understands the following options
=over
=item B<--dst>=I<key>
to only remove a destination, specify the key of the destionation. Use the
B<list> function to see the keys.
=back
=head2 B<edit>
modify the configuration of a dataset. see the descriptions in the B<create>
function for details.
=head1 EXAMPLE
znapzendzetup create -r --mbuffer=/opt/omni/bin/mbuffer \
Expand Down

0 comments on commit 1585356

Please sign in to comment.