From 55f64968158ebd80c5541a29486174acaa2ce814 Mon Sep 17 00:00:00 2001 From: Tobias Oetiker Date: Mon, 12 Oct 2015 08:50:53 +0200 Subject: [PATCH] update docs --- COPYRIGHT | 2 +- README.md | 38 +++++++++++--------------------------- doc/znapzendzetup.pod | 11 +++++++---- 3 files changed, 19 insertions(+), 32 deletions(-) diff --git a/COPYRIGHT b/COPYRIGHT index 62862088..c1b3510c 100644 --- a/COPYRIGHT +++ b/COPYRIGHT @@ -3,7 +3,7 @@ znapzend - A ZFS backup system Copyright by Dominik Hassler, Tobias Oetiker and the other people listed in the AUTHORS file. -2014-12-16 +2015-10-12 All rights reserved. diff --git a/README.md b/README.md index 2c4c38ad..8f09b131 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -ZnapZend 0.14.0 +ZnapZend 0.14.1 =============== [![Build Status](https://travis-ci.org/oetiker/znapzend.svg?branch=master)](https://travis-ci.org/oetiker/znapzend) @@ -11,34 +11,18 @@ snapshots as well as remote copies by thining them out as time progresses. The ZnapZend configuration is stored as properties in the ZFS filesystem itself. -Zetup Zimple ------------- - -There are two ways to get going with znapzend. The way of the real sysadmin -(as described below) or you can take the simple way out and download our -prebuilt release. It comes with all the perlmodules required for running -znapzend with a copy of perl as old as 5.10.1: - -```sh -wget https://github.com/oetiker/znapzend/releases/download/v0.14.0/znapzend-prebuilt-0.14.0.tar.gz -tar zxvf znapzend-prebuilt-0.14.0.tar.gz -cp -rp znapzend-prebuilt-0.14.0 /opt/znapzend-0.14.0 -``` - -Read on in the [Configuration](#configuration) Section. - -Zetup for Power Admins ----------------------- +Zetup Inztructionz +------------------ On the other hand if you are the proud owner of a properly setup unix box with all the tools and trimmings for building stuff, follow these zimple inztructionz below to get a custom made copy of znapzend. ```sh -wget https://github.com/oetiker/znapzend/releases/download/v0.14.0/znapzend-0.14.0.tar.gz -tar zxvf znapzend-0.14.0.tar.gz -cd znapzend-0.14.0 -./configure --prefix=/opt/znapzend-0.14.0 +wget https://github.com/oetiker/znapzend/releases/download/v0.14.1/znapzend-0.14.1.tar.gz +tar zxvf znapzend-0.14.1.tar.gz +cd znapzend-0.14.1 +./configure --prefix=/opt/znapzend-0.14.1 ``` If configure finds anything noteworthy, it will tell you about it. If any @@ -64,19 +48,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.14.0/bin/znapzend --noaction --debug +/opt/znapzend-0.14.1/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.14.0/bin/znapzend --noaction --debug --runonce= +/opt/znapzend-0.14.1/bin/znapzend --noaction --debug --runonce= ``` then when you are happy with what you got, start it in daemon mode. ```sh -/opt/znapzend-0.14.0/bin/znapzend --daemonize +/opt/znapzend-0.14.1/bin/znapzend --daemonize ``` Best is to integrate znapzend into your system startup sequence, but you can also @@ -117,4 +101,4 @@ And if you have a contribution, please send a pull request. Enjoy! Dominik Hassler & Tobi Oetiker -2014-12-16 +2015-10-12 diff --git a/doc/znapzendzetup.pod b/doc/znapzendzetup.pod index c694696e..679e26ea 100644 --- a/doc/znapzendzetup.pod +++ b/doc/znapzendzetup.pod @@ -46,7 +46,12 @@ where 'command' is one of the following: =head1 DESCRIPTION Use znapzendsetup to configure your backup tasks. The cli is modled after -the zfs commandline. Below a few notes on main commands. +the zfs commandline. + +After modifying the configuration, send a HUP signal to your znapzend daemon +for it to re-read the configuration. + +Below a few notes on main commands. =head2 B @@ -82,9 +87,7 @@ To keep one copy every two days for 10 years: In a minimal setup, you just specify a plan for the B fileset. This will cause snapshots to be taken and destroyed according to the plan. You can then add one or several destinations (B) both local (preferably on -a different pool) or remote. Please be aware that only lower-case-letters -are allowed for the (B) names (eg. in case you want to name the (B) -like a mixed-case named pool you might have). +a different pool) or remote. When adding multiple B entries, each will get labled for later identification, optionally you can specify your own label.