Skip to content

Commit

Permalink
release 0.8.2
Browse files Browse the repository at this point in the history
  • Loading branch information
oetiker committed Jul 29, 2014
1 parent 1585356 commit 9fab5c3
Show file tree
Hide file tree
Showing 8 changed files with 81 additions and 42 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ZnapZend 0.8.1
ZnapZend 0.8.2
==============

[![Build Status](https://travis-ci.org/oetiker/znapzend.svg?branch=master)](https://travis-ci.org/oetiker/znapzend)
Expand All @@ -17,15 +17,15 @@ Zetup
To zetup znapzend follow these zimple inztructionz

```sh
wget https://github.com/oetiker/znapzend/releases/download/v0.8.1/znapzend-0.8.1.tar.gz
tar zxvf znapzend-0.8.1.tar.gz
cd znapzend-0.8.1
./configure --prefix=/opt/znapzend-0.8.1
wget https://github.com/oetiker/znapzend/releases/download/v0.8.2/znapzend-0.8.2.tar.gz
tar zxvf znapzend-0.8.2.tar.gz
cd znapzend-0.8.2
./configure --prefix=/opt/znapzend-0.8.2
```
if configure complains about missing perl modules, run

```sh
./setup/build-thirdparty.sh /opt/znapzend-0.8.1/thirdparty
./setup/build-thirdparty.sh /opt/znapzend-0.8.2/thirdparty
```

to install the missing modules into the specified directry. This will NOT messup your local perl installation!
Expand All @@ -50,19 +50,19 @@ The [znapzend](doc/znapzend.pod) demon is responsible for doing the actual backu
To see if your configuration is any good, run znapzend in noaction mode first.

```sh
/opt/znapzend-0.8.1/bin/znapzend --noaction --debug
/opt/znapzend-0.8.2/bin/znapzend --noaction --debug
```

If you don't want to wait for the scheduler to actually schedule work, you can also force immediate action by calling

```sh
/opt/znapzend-0.8.1/bin/znapzend --noaction --debug --runonce=<src_dataset>
/opt/znapzend-0.8.2/bin/znapzend --noaction --debug --runonce=<src_dataset>
```

then when you are happy with what you got, start it in daemon mode.

```sh
/opt/znapzend-0.8.1/bin/znapzend --daemonize
/opt/znapzend-0.8.2/bin/znapzend --daemonize
```

Best is to integrate znapzend into your system startup sequence, but you can also
Expand All @@ -71,8 +71,8 @@ run it by hand.
For illumos OSes you can import the znapzend service manifest provided in the install directory:

```sh
svccfg validate /opt/znapzend-0.8.1/init/znapzend.xml
svccfg import /opt/znapzend-0.8.1/init/znapzend.xml
svccfg validate /opt/znapzend-0.8.2/init/znapzend.xml
svccfg import /opt/znapzend-0.8.2/init/znapzend.xml
```

and then enable the service
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.8.1
0.8.2
20 changes: 10 additions & 10 deletions configure
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#! /bin/sh
# Guess values for system-dependent variables and create Makefiles.
# Generated by GNU Autoconf 2.68 for znapzend 0.8.1.
# Generated by GNU Autoconf 2.68 for znapzend 0.8.2.
#
# Report bugs to <[email protected]>.
#
Expand Down Expand Up @@ -560,8 +560,8 @@ MAKEFLAGS=
# Identity of this package.
PACKAGE_NAME='znapzend'
PACKAGE_TARNAME='znapzend'
PACKAGE_VERSION='0.8.1'
PACKAGE_STRING='znapzend 0.8.1'
PACKAGE_VERSION='0.8.2'
PACKAGE_STRING='znapzend 0.8.2'
PACKAGE_BUGREPORT='[email protected]'
PACKAGE_URL=''

Expand Down Expand Up @@ -1250,7 +1250,7 @@ if test "$ac_init_help" = "long"; then
# Omit some internal or obsolete options to make the list less imposing.
# This message is too long to be a string in the A/UX 3.1 sh.
cat <<_ACEOF
\`configure' configures znapzend 0.8.1 to adapt to many kinds of systems.
\`configure' configures znapzend 0.8.2 to adapt to many kinds of systems.
Usage: $0 [OPTION]... [VAR=VALUE]...
Expand Down Expand Up @@ -1316,7 +1316,7 @@ fi

if test -n "$ac_init_help"; then
case $ac_init_help in
short | recursive ) echo "Configuration of znapzend 0.8.1:";;
short | recursive ) echo "Configuration of znapzend 0.8.2:";;
esac
cat <<\_ACEOF
Expand Down Expand Up @@ -1409,7 +1409,7 @@ fi
test -n "$ac_init_help" && exit $ac_status
if $ac_init_version; then
cat <<\_ACEOF
znapzend configure 0.8.1
znapzend configure 0.8.2
generated by GNU Autoconf 2.68
Copyright (C) 2010 Free Software Foundation, Inc.
Expand Down Expand Up @@ -1665,7 +1665,7 @@ cat >config.log <<_ACEOF
This file contains any messages produced by compilers while
running configure, to aid debugging if configure makes a mistake.
It was created by znapzend $as_me 0.8.1, which was
It was created by znapzend $as_me 0.8.2, which was
generated by GNU Autoconf 2.68. Invocation command line was
$ $0 $@
Expand Down Expand Up @@ -3738,7 +3738,7 @@ fi
# Define the identity of the package.
PACKAGE='znapzend'
VERSION='0.8.1'
VERSION='0.8.2'
cat >>confdefs.h <<_ACEOF
Expand Down Expand Up @@ -4718,7 +4718,7 @@ cat >>$CONFIG_STATUS <<\_ACEOF || ac_write_fail=1
# report actual input values of CONFIG_FILES etc. instead of their
# values after options handling.
ac_log="
This file was extended by znapzend $as_me 0.8.1, which was
This file was extended by znapzend $as_me 0.8.2, which was
generated by GNU Autoconf 2.68. Invocation command line was
CONFIG_FILES = $CONFIG_FILES
Expand Down Expand Up @@ -4771,7 +4771,7 @@ _ACEOF
cat >>$CONFIG_STATUS <<_ACEOF || ac_write_fail=1
ac_cs_config="`$as_echo "$ac_configure_args" | sed 's/^ //; s/[\\""\`\$]/\\\\&/g'`"
ac_cs_version="\\
znapzend config.status 0.8.1
znapzend config.status 0.8.2
configured by $0, generated by GNU Autoconf 2.68,
with options \\"\$ac_cs_config\\"
Expand Down
4 changes: 2 additions & 2 deletions doc/znapzend.pod
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ do all changes to the filesystem except destroy old snapshots
=item B<--logto>={B<syslog::>I<facility>|I<filepath>}

send logs out to either syslog or a logfile. Default is to send logs to
B<syslog::local6> when runing daemonized. When running in debug mode, the
B<syslog::daemon> when runing daemonized. When running in debug mode, the
logs will go to STDERR by default.

Examples:
Expand Down Expand Up @@ -79,7 +79,7 @@ To test a new config

To run as a daemon

znapzend --deamonize --pidfile=/var/run/znapzend.pid --logto=syslog::daemon
znapzend --daemonize --pidfile=/var/run/znapzend.pid --logto=syslog::daemon

=head1 COPYRIGHT

Expand Down
34 changes: 28 additions & 6 deletions doc/znapzendzetup.pod
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,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 All @@ -59,7 +59,7 @@ to the following table:
hour|h
day|d
week|w
mon|month|m
month|mon|m
year|y

To keep one copy every 30 minutes for one week, specify:
Expand All @@ -82,11 +82,11 @@ The syntax is L<strftime>-like. The string must consist of the mandatory

%Y %m %d %H %M %S

and optional
Optionally,

- _ . :

characters.
characters as well as any alphanumeric character are allowed.

If not specified, B<--tsformat> defaults to C<%Y-%m-%d-%H%M%S>.

Expand Down Expand Up @@ -119,6 +119,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
6 changes: 3 additions & 3 deletions man/znapzend.1
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "ZNAPZEND 1"
.TH ZNAPZEND 1 "2014-07-29" "0.8.1" "znapzend"
.TH ZNAPZEND 1 "2014-07-29" "0.8.2" "znapzend"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
Expand Down Expand Up @@ -167,7 +167,7 @@ do all changes to the filesystem except destroy old snapshots
.IP "\fB\-\-logto\fR={\fBsyslog::\fR\fIfacility\fR|\fIfilepath\fR}" 4
.IX Item "--logto={syslog::facility|filepath}"
send logs out to either syslog or a logfile. Default is to send logs to
\&\fBsyslog::local6\fR when runing daemonized. When running in debug mode, the
\&\fBsyslog::daemon\fR when runing daemonized. When running in debug mode, the
logs will go to \s-1STDERR\s0 by default.
.Sp
Examples:
Expand Down Expand Up @@ -201,7 +201,7 @@ To test a new config
To run as a daemon
.PP
.Vb 1
\& znapzend \-\-deamonize \-\-pidfile=/var/run/znapzend.pid \-\-logto=syslog::daemon
\& znapzend \-\-daemonize \-\-pidfile=/var/run/znapzend.pid \-\-logto=syslog::daemon
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Expand Down
33 changes: 25 additions & 8 deletions man/znapzendzetup.1
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "ZNAPZENDZETUP 1"
.TH ZNAPZENDZETUP 1 "2014-07-29" "0.8.1" "znapzend"
.TH ZNAPZENDZETUP 1 "2014-07-29" "0.8.2" "znapzend"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
Expand Down Expand Up @@ -166,10 +166,10 @@ where 'command' is one of the following:
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Znapzend is a snapshot based zfs backup daemon creating snapshots on a
scheduled basis on the source filesystem and on a destination filesystem
.SS "Create Command"
.IX Subsection "Create Command"
Use znapzendsetup to configure your backup tasks. The cli is modled after
the zfs commandline. Below a few notes on main commands.
.SS "\fBcreate\fP"
.IX Subsection "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
the source and the destination datasets.
Expand All @@ -191,7 +191,7 @@ to the following table:
\& hour|h
\& day|d
\& week|w
\& mon|month|m
\& month|mon|m
\& year|y
.Ve
.PP
Expand All @@ -217,13 +217,13 @@ The syntax is strftime\-like. The string must consist of the mandatory
\& %Y %m %d %H %M %S
.Ve
.Sp
and optional
Optionally,
.Sp
.Vb 1
\& \- _ . :
.Ve
.Sp
characters.
characters as well as any alphanumeric character are allowed.
.Sp
If not specified, \fB\-\-tsformat\fR defaults to \f(CW\*(C`%Y\-%m\-%d\-%H%M%S\*(C'\fR.
.IP "\fB\-\-mbuffer\fR=\fI/usr/bin/mbuffer\fR" 4
Expand Down Expand Up @@ -253,6 +253,23 @@ intended it to be.
.IX Item "--pre-snap-command=/path/bin args, --post-snap-command=/path/bin args"
Run commands/scripts before and after snapshots are taken on source.
e.g. for database locking/flushing (pre) and unlocking (post).
.SS "\fBdelete\fP"
.IX Subsection "delete"
to remove configuration from a dataset just give its name
.PP
.Vb 1
\& znapzendzetup I<dataset>
.Ve
.PP
the \fBdelete\fR function understands the following options
.IP "\fB\-\-dst\fR=\fIkey\fR" 4
.IX Item "--dst=key"
to only remove a destination, specify the key of the destionation. Use the
\&\fBlist\fR function to see the keys.
.SS "\fBedit\fP"
.IX Subsection "edit"
modify the configuration of a dataset. see the descriptions in the \fBcreate\fR
function for details.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
.Vb 7
Expand Down
2 changes: 1 addition & 1 deletion man/znapzendztatz.1
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "ZNAPZENDZTATZ 1"
.TH ZNAPZENDZTATZ 1 "2014-07-29" "0.8.1" "znapzend"
.TH ZNAPZENDZTATZ 1 "2014-07-29" "0.8.2" "znapzend"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
Expand Down

0 comments on commit 9fab5c3

Please sign in to comment.