Replace lftp's call to 'rmdir' by calls to 'rm -rf'.

[brioche.git] / README

diff --git a/README b/README
index 21e198e908c1fd3a4c2698d9ecb26c997c039193..9652a13f3a4777e6311221e4a130956835a70ef8 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,14 @@
 .. HTML version generated with rst2html -t README > README.html
 
 .. HTML version generated with rst2html -t README > README.html
 

-==============
+.. |date| date:: %b %e, %Y
+

 Brioche Backup
 Brioche Backup

-==============
+~~~~~~~~~~~~~~

 
 :Author:    Amand Tihon
 :Contact:   <amand.tihon@alrj.org>
 
 :Author:    Amand Tihon
 :Contact:   <amand.tihon@alrj.org>

-:Version:   1.1
-:Date:      Jan 5th, 2008
+:Version:   1.2
+:Date:      |date|

 :Copyright: GNU GPL, see copyright file.
 
 .. sectnum::
 :Copyright: GNU GPL, see copyright file.
 
 .. sectnum::


@@ -113,8 +114,8 @@ USAGE_WARN
 
 COMPRESS
   This directive allows to specify the compression method to apply to the
 
 COMPRESS
   This directive allows to specify the compression method to apply to the

-  archives. Possible values are "gz", "bz2" and "lzma". **Warning** : lzma may
-  not be available with older versions of GNU tar.
+  archives. Possible values are "none", "gz", "bz2" and "lzma".
+  **Warning** : lzma may not be available with older versions of GNU tar.

 
 TAR_OPTS
   Additionnal options that you may want to pass to tar. A typical value could
 
 TAR_OPTS
   Additionnal options that you may want to pass to tar. A typical value could


@@ -133,6 +134,18 @@ SNAPSHOT_SIZE
   Set the size of the snapshot volume. The same suffix than for lvcreate(8)
   are available.
 
   Set the size of the snapshot volume. The same suffix than for lvcreate(8)
   are available.
 

+USE_GPG
+  When set to "yes", Brioche will encrypt the archives with GnuPG.
+  See the `Encryption with GnuPG`_ section below for a detailed explanation on
+  how to use GnuPG with Brioche.
+
+GPG_KEY
+  The identifier of the public GnuPG key to use when encrypting the archives.
+  This is the key that will be needed in case of restore.
+
+GPG_PASSPHRASE
+  The passphrase for the GnuPG private key used to encrypt the archives.
+

 USE_FTP
   If set to "yes", Brioche will upload the backups on an FTP server.
   See the `Using FTP`_ section for more information about this feature.
 USE_FTP
   If set to "yes", Brioche will upload the backups on an FTP server.
   See the `Using FTP`_ section for more information about this feature.


@@ -211,6 +224,10 @@ previous example would lead to the following structure: ::
 +--------------------------------------------------------------------------+
 
 
 +--------------------------------------------------------------------------+
 
 

+Encryption with GnuPG
+---------------------
+
+

 Using FTP
 ---------
 
 Using FTP
 ---------
 


@@ -272,12 +289,13 @@ If all is fine, it can be added in the system crontab. Here's a suggestion for
 weekly full backup on Sunday, with differential during the weekdays: ::
 
   # Daily incremental backup
 weekly full backup on Sunday, with differential during the weekdays: ::
 
   # Daily incremental backup

-  30  3  *  *  1-6  /usr/local/bin/brioche > /var/log/backup.`date "+%a"`.log 2>&1
+  30  3  *  *  1-6  /usr/local/bin/brioche > /var/log/backup.`dow`.log 2>&1

   # Weekly full backup on Sunday
   # Weekly full backup on Sunday

-  30  3  *  *  0  /usr/local/bin/brioche -f > /var/log/backup.`date "+%a"`.log 2>&1
+  30  3  *  *  0  /usr/local/bin/brioche -f > /var/log/backup.`dow`.log 2>&1

 
 The output of the script will be saved in /var/log/backup.DOW.log with DOW
 being the abbreviated day of the week (see man date(1) for the format).
 
 The output of the script will be saved in /var/log/backup.DOW.log with DOW
 being the abbreviated day of the week (see man date(1) for the format).

+The ``dow`` bash script is provided alongside Brioche.

 
 
 Bug reporting
 
 
 Bug reporting