X-Git-Url: https://git.alrj.org/?p=brioche.git;a=blobdiff_plain;f=README.html;fp=README.html;h=30a9f596839bcad7f9cdb30a77ef9ef8b9a71706;hp=160a9829ee4136f226d260c4e27f99b621b5bf6c;hb=234cc50467cfd3c9adfbfd4a9d9ac1a5b10499bd;hpb=5430e18aa198b619dd5e4a812dccc96751aba970

diff --git a/README.html b/README.html
index 160a982..30a9f59 100644
--- a/README.html
+++ b/README.html
@@ -6,7 +6,7 @@
 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
 <title>Brioche Backup</title>
 <meta name="author" content="Amand Tihon" />
-<meta name="date" content="Jan 5th, 2008" />
+<meta name="date" content="Jan  9, 2009" />
 <meta name="copyright" content="GNU GPL, see copyright file." />
 <style type="text/css">
 
@@ -298,9 +298,9 @@ ul.auto-toc {
 <tr><th class="docinfo-name">Contact:</th>
 <td>&lt;<a class="reference external" href="mailto:amand.tihon&#64;alrj.org">amand.tihon&#64;alrj.org</a>&gt;</td></tr>
 <tr><th class="docinfo-name">Version:</th>
-<td>1.1</td></tr>
+<td>1.2</td></tr>
 <tr><th class="docinfo-name">Date:</th>
-<td>Jan 5th, 2008</td></tr>
+<td>Jan  9, 2009</td></tr>
 <tr><th class="docinfo-name">Copyright:</th>
 <td>GNU GPL, see copyright file.</td></tr>
 </tbody>
@@ -317,12 +317,13 @@ ul.auto-toc {
 <li><a class="reference internal" href="#using-brioche" id="id7">6&nbsp;&nbsp;&nbsp;Using Brioche</a><ul class="auto-toc">
 <li><a class="reference internal" href="#configuration" id="id8">6.1&nbsp;&nbsp;&nbsp;Configuration</a></li>
 <li><a class="reference internal" href="#defining-backups" id="id9">6.2&nbsp;&nbsp;&nbsp;Defining backups</a></li>
-<li><a class="reference internal" href="#using-ftp" id="id10">6.3&nbsp;&nbsp;&nbsp;Using FTP</a></li>
-<li><a class="reference internal" href="#running-brioche" id="id11">6.4&nbsp;&nbsp;&nbsp;Running Brioche</a></li>
+<li><a class="reference internal" href="#encryption-with-gnupg" id="id10">6.3&nbsp;&nbsp;&nbsp;Encryption with GnuPG</a></li>
+<li><a class="reference internal" href="#using-ftp" id="id11">6.4&nbsp;&nbsp;&nbsp;Using FTP</a></li>
+<li><a class="reference internal" href="#running-brioche" id="id12">6.5&nbsp;&nbsp;&nbsp;Running Brioche</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#bug-reporting" id="id12">7&nbsp;&nbsp;&nbsp;Bug reporting</a></li>
-<li><a class="reference internal" href="#references" id="id13">8&nbsp;&nbsp;&nbsp;References</a></li>
+<li><a class="reference internal" href="#bug-reporting" id="id13">7&nbsp;&nbsp;&nbsp;Bug reporting</a></li>
+<li><a class="reference internal" href="#references" id="id14">8&nbsp;&nbsp;&nbsp;References</a></li>
 </ul>
 </div>
 <div class="section" id="abstract">
@@ -409,8 +410,8 @@ Make sure there's enough free space on the device where REPODIR is located.</dd>
 beyond the given threshold. The value must be an integer.</dd>
 <dt>COMPRESS</dt>
 <dd>This directive allows to specify the compression method to apply to the
-archives. Possible values are &quot;gz&quot;, &quot;bz2&quot; and &quot;lzma&quot;. <strong>Warning</strong> : lzma may
-not be available with older versions of GNU tar.</dd>
+archives. Possible values are &quot;none&quot;, &quot;gz&quot;, &quot;bz2&quot; and &quot;lzma&quot;.
+<strong>Warning</strong> : lzma may not be available with older versions of GNU tar.</dd>
 <dt>TAR_OPTS</dt>
 <dd>Additionnal options that you may want to pass to tar. A typical value could
 be <tt class="docutils literal"><span class="pre">&quot;--one-file-system</span> <span class="pre">-S&quot;</span></tt>. The first option will skip all other
@@ -424,6 +425,15 @@ sparse files.</dd>
 <dt>SNAPSHOT_SIZE</dt>
 <dd>Set the size of the snapshot volume. The same suffix than for lvcreate(8)
 are available.</dd>
+<dt>USE_GPG</dt>
+<dd>When set to &quot;yes&quot;, Brioche will encrypt the archives with GnuPG.
+See the <a class="reference internal" href="#encryption-with-gnupg">Encryption with GnuPG</a> section below for a detailed explanation on
+how to use GnuPG with Brioche.</dd>
+<dt>GPG_KEY</dt>
+<dd>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.</dd>
+<dt>GPG_PASSPHRASE</dt>
+<dd>The passphrase for the GnuPG private key used to encrypt the archives.</dd>
 <dt>USE_FTP</dt>
 <dd>If set to &quot;yes&quot;, Brioche will upload the backups on an FTP server.
 See the <a class="reference internal" href="#using-ftp">Using FTP</a> section for more information about this feature.</dd>
@@ -498,8 +508,11 @@ in the backup if you've included the device in your <tt class="docutils literal"
 </tbody>
 </table>
 </div>
+<div class="section" id="encryption-with-gnupg">
+<h2>6.3&nbsp;&nbsp;&nbsp;Encryption with GnuPG</h2>
+</div>
 <div class="section" id="using-ftp">
-<h2>6.3&nbsp;&nbsp;&nbsp;Using FTP</h2>
+<h2>6.4&nbsp;&nbsp;&nbsp;Using FTP</h2>
 <p>With the help of lftp, Brioche is able to store an history of backups on an FTP
 server. This is mainly usefull when no other distant repository is available.
 If possible, consider using an CIFS, NFS, sshfs or any other kind of remote
@@ -536,7 +549,7 @@ etc)</li>
 </ul>
 </div>
 <div class="section" id="running-brioche">
-<h2>6.4&nbsp;&nbsp;&nbsp;Running Brioche</h2>
+<h2>6.5&nbsp;&nbsp;&nbsp;Running Brioche</h2>
 <p>Brioche understands the following arguments:</p>
 <table class="docutils option-list" frame="void" rules="none">
 <col class="option" />
@@ -559,12 +572,13 @@ will gracefully fall back and do a full backup if none is available.</p>
 weekly full backup on Sunday, with differential during the weekdays:</p>
 <pre class="literal-block">
 # Daily incremental backup
-30  3  *  *  1-6  /usr/local/bin/brioche &gt; /var/log/backup.`date &quot;+%a&quot;`.log 2&gt;&amp;1
+30  3  *  *  1-6  /usr/local/bin/brioche &gt; /var/log/backup.`dow`.log 2&gt;&amp;1
 # Weekly full backup on Sunday
-30  3  *  *  0  /usr/local/bin/brioche -f &gt; /var/log/backup.`date &quot;+%a&quot;`.log 2&gt;&amp;1
+30  3  *  *  0  /usr/local/bin/brioche -f &gt; /var/log/backup.`dow`.log 2&gt;&amp;1
 </pre>
 <p>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).</p>
+being the abbreviated day of the week (see man date(1) for the format).
+The <tt class="docutils literal"><span class="pre">dow</span></tt> bash script is provided alongside Brioche.</p>
 </div>
 </div>
 <div class="section" id="bug-reporting">
@@ -584,7 +598,7 @@ as possible in your report.</p>
 </div>
 <div class="footer">
 <hr class="footer" />
-Generated on: 2009-01-06 15:56 UTC.
+Generated on: 2009-01-09 14:26 UTC.
 
 </div>
 </body>