backupgemsteven 0.1.2

data/CHANGELOG

@@ -0,0 +1,48 @@
+= Backup Changelog
+== Version 0.0.11
+* Removed the tmpdir directive because it was screwing up the meta-code
+* Moved the graffle and keynote files to an "extras" directory because it was breaking windows machines
+
+== Version 0.0.10
+* added a rubyforge rake task. This doesnt affect anyone but me so there is no gem for it.
+
+== Version 0.0.9
+* mercurial support
+* multiple backups per day
+* and a variety of bug fixes from patches submitted from the community. Its a
+  little bit closer to windows ready (thanks Jonathan Stott!) because of
+  increased use of FileUtils over "sh".
+
+== Version 0.0.8
+* The attached patch will add the 'backup' executable to your bin path using
+   the built-in RubyGems method for adding things to bin. Thanks to Anthony
+   Eden (aeden) for this patch.
+
+== Version 0.0.7
+* Fixed the default ssh port. It was wrong in version 0.0.6
+* Added a 'rake test' task
+
+== Version 0.0.6
+* Added a default port
+* Fixed an s3 'require' typo
+
+== Version 0.0.5
+* Added Amazon s3 support. Thanks to Jason Perry for this patch.
+* Added an option for ssh port. Thanks to Frank Oxener for this patch.
+
+== Version 0.0.4
+
+* Fixed a bug in 'scp' in the standard recipe that ignored the user when using
+  scp. Thanks to Colin Slater for catching this.
+
+== Version 0.0.3
+
+* Fixed a critical bug that did not allow re-defining the :delivery or :rotate
+  methods. Thanks to James Healy for pointing this out.
+
+== Version 0.0.2
+
+* First stable code in place.
+* Packaged in an gem format
+
+

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'backup'
+    gemspec.author = "Nate Murray"
+    gemspec.email = "nate@natemurray.com"
+    gemspec.homepage = "http://tech.natemurray.com/backup"
+    gemspec.platform = Gem::Platform::RUBY
+    gemspec.summary = "Beginning-to-end solution for backups and rotation."
+    gemspec.files = FileList["{bin,lib,tests,examples,doc}/**/*"].to_a
+    gemspec.require_path = "lib"
+    gemspec.test_files = FileList["{tests}/**/*test.rb"].to_a
+    gemspec.bindir = "bin" # Use these for applications.
+    gemspec.executables = ['backup']
+    gemspec.default_executable = "backup"
+    gemspec.has_rdoc = true
+    gemspec.extra_rdoc_files = ["README", "CHANGELOG", "TODO", "Rakefile"]
+    gemspec.rubyforge_project = "backupgem"
+    gemspec.add_dependency("rake", ">= 0.7.1")
+    gemspec.add_dependency("runt", ">= 0.3.0")
+    gemspec.add_dependency("net-ssh", ">= 2.0.0")
+    gemspec.add_dependency("madeleine", ">= 0.7.3")
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/TODO

@@ -0,0 +1,7 @@
+== 2007-01-26
+* Write some better tests
+* Create a "rake test" task
+* Create rake tasks for generating documentation
+* Move documentation maker to this project
+* Add documentation for s3
+* Add documentation for ssh port

data/bin/backup

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'backup/cli'
+
+Backup::CLI.execute!

data/bin/commands.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+./bin/backup --recipe examples/mediawiki.rb

data/doc/LICENSE-GPL.txt

@@ -0,0 +1,280 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS

data/doc/index.html

@@ -0,0 +1,716 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<title>BackupGem Manual</title>
+<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
+<meta name="generator" content="Click">
+  <style type="text/css">
+    @import url("styles.css");
+  </style>
+</head>
+<body>
+<div id="container">
+<div id="header"><h1>BackupGem Manual</h1></div>
+
+<div id="wrapper">
+<div id="content">
+
+<div class="rightad">
+  <script type="text/javascript"><!--
+  google_ad_client = "pub-0934913060779093";
+  google_ad_width = 120;
+  google_ad_height = 600;
+  google_ad_format = "120x600_as";
+  google_ad_type = "image";
+  //2006-10-06: backup_skyscraper1
+  google_ad_channel ="7310496335";
+  //--></script>
+  <script type="text/javascript"
+    src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+  </script>
+</div>
+
+
+
+
+
+ <a name="Introduction"></a><h2>Introduction</h2>
+  
+    <a name="Introduction_Welcome"
+    ></a><h3>Welcome</h3>
+    <p><code><span class="constant">Backup</span></code> is the easiest and most flexible backup, archive and rotate tool.  It&#8217;s a beginning-to-end solution for scheduled backups in a clean ruby package that is simple use and powerful when customized.
+Backup allows you to specify each of the following options:</p>
+
+
+	<ul>
+	<li>what is being archived (files, folders, arbitrary scripts)</li>
+		<li>how it&#8217;s being archived (tar gzip, bz2)</li>
+		<li>where the archive is going (multiple backup servers? easy)</li>
+		<li>how the archive is going to get there (scp, ftp, mv)</li>
+		<li>where is will be stored when it gets there</li>
+		<li>how it&#8217;s going to be rotated when it gets there (grandfather-father-son, etc)</li>
+		<li>how often will this process happen (customizable cycles)</li>
+		<li>what happens to the working copy after the process (recreate files, folders etc. restart daemons)</li>
+	</ul>
+
+
+	<p>Backup is a collection of scripts that is complete enough to save you time, but flexible enough to work with any situation.
+This is an early version of <code><span class="constant">Backup</span></code>.  Please feel free to ask questions on how to use <code><span class="constant">Backup</span></code> or post suggestions for this manual in the <a href="http://rubyforge.org/mailman/listinfo/backupgem-users">mailing lists</a></p>
+   
+  
+
+
+ <a name="Housekeeping"></a><h2>Housekeeping</h2>
+  
+    <a name="Housekeeping_Prerequisites"
+    ></a><h3>Prerequisites</h3>
+    <p><code><span class="constant">Backup</span></code> makes the following assumptions about your machines:</p>
+
+
+	<ul>
+	<li>server and client understand <span class="caps">POSIX</span> commmands</li>
+		<li>passwords and paths are the same on each backup server</li>
+	</ul>
+
+
+	<p><code><span class="constant">Backup</span></code> depends on the following libraries:</p>
+
+
+	<ul>
+	<li><a href="http://runt.rubyforge.org/">Runt</a> for describing temporal ranges.</li>
+		<li><a href="http://net-ssh.rubyforge.org/">Net::SSH</a> for <span class="caps">SSH</span> backups</li>
+		<li><a href="http://www.ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/index.html">Net::FTP</a> for <span class="caps">FTP</span> backups</li>
+	</ul>
+
+
+	<p>These are listed as dependencies in the gem file so you should be prompted to install them when you install Backup.</p>
+  
+    <a name="Housekeeping_Using_RubyGems"
+    ></a><h3>Using RubyGems</h3>
+    If you have <a href="http://rubygems.rubyforge.org">RubyGems</a> installed, installing Backup is simple:
+	<blockquote>
+		<p><code><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">backupgem</span></code></p>
+	</blockquote>
+  
+    <a name="Housekeeping_Using_svn"
+    ></a><h3>Using svn</h3>
+    If you prefer, you can checkout backupgem from the <a href="http://rubyforge.org/scm/?group_id=2110">RubyForge Repository</a>. Feel free to browse the releases or trunk <a href="http://rubyforge.org/scm/?group_id=2110">here</a>.
+	<blockquote>
+		<p><code><span class="ident">svn</span> <span class="ident">checkout</span> <span class="ident">svn</span><span class="punct">+</span><span class="ident">ssh</span><span class="punct">:/</span><span class="regex"></span><span class="punct">/</span><span class="ident">rubyforge</span><span class="punct">.</span><span class="ident">org</span><span class="punct">/</span><span class="ident">var</span><span class="punct">/</span><span class="ident">svn</span><span class="punct">/</span><span class="ident">backupgem</span></code></p>
+	</blockquote>
+  
+    <a name="Housekeeping_License_Information"
+    ></a><h3>License Information</h3>
+    <p>Backup is made available under either the <span class="caps">BSD</span> license, or the same license Ruby (which, by extension, also allows the <span class="caps">GPL</span> as a permissable license as well). You can view the full text of any of these licenses in the <code><span class="ident">doc</span></code> subdirectory of the Backup distrubtion. The texts of the <span class="caps">BSD</span> and <span class="caps">GPL</span> licenses are also available online: <a href="http://www.opensource.org/licenses/bsd-license.php"><span class="caps">BSD</span></a> and <a href="http://www.opensource.org/licenses/gpl-license.php"><span class="caps">GPL</span></a>.</p>
+
+
+	<p>If you desire permission to use either Backup in a manner incompatible with these licenses, please contact the copyright holder <a href="mailto:nate+backup@natemurray.com">Nate Murray</a> in order to negotiate a more compatible license.</p>
+  
+    <a name="Housekeeping_Support"
+    ></a><h3>Support</h3>
+    <p>Mailing lists, bug trackers, feature requests, and public forums are all available courtesty of <a href="http://rubyforge.org">RubyForge</a> at the  <a href="http://rubyforge.org/projects/backupgem">BackupGem project page</a>.</p>
+  
+    <a name="Housekeeping_Mailing_Lists"
+    ></a><h3>Mailing Lists</h3>
+    <table>
+		<tr>
+			<th>List Name </th>
+			<th>&nbsp; </th>
+			<th>Desc.  </th>
+		</tr>
+		<tr>
+			<td> <a href="http://rubyforge.org/pipermail/backupgem-users">backupgem-users</a> </td>
+			<td> <a href="http://rubyforge.org/mailman/listinfo/backupgem-users">subscribe / unsubscribe</a> </td>
+			<td> The BackupGem users list is devoted to the discussion of and questions about the usage of Backup. If you can&#8217;t quite figure out how to get a feature of Backup to work, this is the list you would go to in order to ask your questions. </td>
+		</tr>
+		<tr>
+			<td> <a href="http://rubyforge.org/pipermail/backupgem-devel">backupgem-devel</a> </td>
+			<td> <a href="http://rubyforge.org/mailman/listinfo/backupgem-devel">subscribe / unsubscribe</a> </td>
+			<td> The Backup developers list is devoted to the discussion of Backup&#8217;s implementation. If you have created a patch that you would like to discuss, or if you would like to discuss a new feature, this is the list for you. </td>
+		</tr>
+	</table>
+  
+    <a name="Housekeeping_About_the_Author"
+    ></a><h3>About the Author</h3>
+    <p>Backup was written by <a href="mailto:nate@natemurray.com">Nate Murray</a>.</p>
+
+
+	<p>Nate currently works at an internet retailer in Southern California. Feel free to send him compliments, money, praise, or new feature patches. You can also send questions and suggestions. However, for bug reports and general feature requests, please use the trackers on the  <a href="http://rubyforge.org/projects/backupgem">BackupGem project page</a>.</p>
+  
+    <a name="Housekeeping_Special_Thanks"
+    ></a><h3>Special Thanks</h3>
+    <p>Special thanks to:</p>
+
+
+	<ul>
+	<li>Matt Pulver for help with various technical problems and ideas.</li>
+		<li>Jamis Buck for writing <a href="http://weblog.rubyonrails.com/2006/8/30/capistrano-1-1-9-beta">Capistrano</a>. Capistrano provided the inspiration and some code for this work. Additionally, the Net::SSH manual provided partial inspiration for this manual. </li>
+		<li><a href="mailto:info@digitalclash.com">Matthew Lipper</a> for writing the Runt Ruby Temporal Expressions Library</li>
+		<li><a href="http://whytheluckystiff.net/">why the lucky stiff</a> for inspiration and some of the code to generate this manual.</li>
+	</ul>
+   
+  
+
+        <div class="ad">
+
+            <script type="text/javascript"><!--
+            google_ad_client = "pub-0934913060779093";
+            google_ad_width = 728;
+            google_ad_height = 90;
+            google_ad_format = "728x90_as";
+            google_ad_type = "text_image";
+            //2006-10-06: backup_before_recipe_1
+            google_ad_channel ="7683863986";
+            //--></script>
+            <script type="text/javascript"
+              src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+            </script>
+
+        </div> 
+
+ <a name="How_Backup_Works"></a><h2>How Backup Works</h2>
+  
+    <a name="How_Backup_Works_A_Typical_Backup"
+    ></a><h3>A Typical Backup</h3>
+    <p>A typical backup has the following sequence:</p>
+
+
+	<ul>
+	<li>content</li>
+		<li>compress</li>
+		<li>encrypt</li>
+		<li>deliver</li>
+		<li>rotate</li>
+		<li>cleanup</li>
+	</ul>
+
+
+	<p>This order is the default, however, like most things it is customizable. Think of it like a pipline: the input of each step is the output of the last step.
+Each of these things are specified in a <code><span class="ident">recipe</span></code> file which is describe below.</p>
+  
+    <a name="How_Backup_Works_CLI"
+    ></a><h3>CLI</h3>
+    <div class='example'><pre><code>  <span class="constant">Usage</span><span class="punct">:</span> <span class="punct">./</span><span class="regex">backup [options]
+  Recipe Options -----------------------
+      -r, --recipe RECIPE              A recipe file to load.
+
+      -g, --global FILE                Specify the global recipe file to work
+                                       with. Defaults to the file +global.rb+
+                                       in the directory of +recipe+
+      -s, --set NAME=VALUE             Specify a variable and it's value to
+                                       set. This will be set after loading all
+                                       recipe files.</span></code></pre></div>
+
+	<p><code><span class="constant">Backup</span></code> <i>is still in an early version. For now, I run the script directly from its <code><span class="ident">bin</span></code> folder in <code><span class="global">$GEMSROOT</span></code>. This will be moved to something like <code><span class="punct">/</span><span class="regex">usr</span><span class="punct">/</span><span class="ident">local</span><span class="punct">/</span><span class="ident">lib</span></code> in a future version. Patches to do this are welcome.</i></p>
+
+
+	<p>For now, you can run backup like so:</p>
+
+
+<div class='example'><pre><code>  <span class="punct">/</span><span class="regex">usr</span><span class="punct">/</span><span class="ident">local</span><span class="punct">/</span><span class="ident">lib</span><span class="punct">/</span><span class="ident">ruby</span><span class="punct">/</span><span class="ident">gems</span><span class="punct">/</span><span class="number">1.8</span><span class="punct">/</span><span class="ident">gems</span><span class="punct">/</span><span class="ident">backupgem</span><span class="punct">-</span><span class="number">0.0</span><span class="punct">.</span><span class="number">2</span><span class="punct">/</span><span class="ident">bin</span><span class="punct">/</span><span class="ident">backup</span> <span class="punct">--</span><span class="ident">recipe</span> <span class="punct">/</span><span class="ident">path</span><span class="punct">/</span><span class="ident">to</span><span class="punct">/</span><span class="ident">examples</span><span class="punct">/</span><span class="ident">mediawiki</span><span class="punct">.</span><span class="ident">rb</span></code></pre></div>
+
+	<p>Usually, you would set this as a cron job or something similar.</p>
+   
+  
+
+
+ <a name="Backup_Recipe_File_Format"></a><h2>Backup Recipe File Format</h2>
+  
+    <a name="Backup_Recipe_File_Format_Recipes_Explained"
+    ></a><h3>Recipes Explained</h3>
+    <div class="longlist">
+
+	<ul>
+	<li>The Backup Recipe format is pure ruby code. Anything that is valid ruby is valid in the recipe file. There are, however, a number of shortcuts that will make your life easier.</li>
+		<li>Each of the steps are specified as an <code><span class="ident">action</span></code>. (An action is really nothing more than a method that becomes defined in the Actor instance. See the <a href="http://rubyforge.org/docman/?group_id=2110"><span class="caps">API</span> docs</a> if you&#8217;re interestd.)</li>
+		<li>You may create &#8220;hook&#8221; actions for any of the actions. So if you define a method <code><span class="ident">before_content</span></code> it will be called immediately before <code><span class="comment">#content</span></code> is called. A method named <code><span class="ident">after_rotation</span></code> would be called after <code><span class="comment">#rotation</span></code>. This may not always be needed as you can customize the rotation order by setting the <code><span class="ident">action_order</span></code>. See the <code><span class="ident">recipes</span><span class="punct">/</span><span class="ident">standard</span><span class="punct">.</span><span class="ident">rb</span></code> file for examples.</li>
+		<li>In each action, the variable <code><span class="ident">last_result</span></code> is set. This is the return value of the previously called method in the chain. Note that this includes the output of the &#8220;hook&#8221; methods. </li>
+		<li>All configuration variables are available to actions via the hash <code><span class="ident">c</span><span class="punct">[]</span></code>. For example, the backup path is available to your actions as <code><span class="ident">c</span><span class="punct">[</span><span class="symbol">:backup_path</span><span class="punct">]</span></code>.</li>
+	</ul>
+
+
+</div>
+  
+    <a name="Backup_Recipe_File_Format_Variables"
+    ></a><h3>Variables</h3>
+    <p>Setting variables is the bulk of the work you have to do when configuring your <code><span class="constant">Backup</span></code> scripts. These first two variables are required for all configurations.</p>
+
+
+	<p><i>The second variable could be omitted completely if the code was updated to use <code><span class="ident">tmpdir</span></code>. This is currently a <span class="caps">TODO</span>.</i></p>
+
+
+	<table>
+		<tr>
+			<th>Name </th>
+			<th>Desc.  </th>
+			<th>Example </th>
+		</tr>
+		<tr>
+			<td> :backup_path </td>
+			<td> The path to place backup archives. </td>
+			<td> <code><span class="ident">set</span> <span class="symbol">:backup_path</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">/var/local/backups/mediawiki</span><span class="punct">&quot;</span></code> </td>
+		</tr>
+		<tr>
+			<td> :tmp_dir </td>
+			<td> Specify a directory that backup can use as a temporary directory. Default <code><span class="punct">/</span><span class="regex">tmp</span></code>.  </td>
+			<td> <code><span class="ident">set</span> <span class="symbol">:tmp_dir</span><span class="punct">,</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">dirname</span><span class="punct">(</span><span class="constant">__FILE__</span><span class="punct">)</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">/../tmp</span><span class="punct">&quot;</span></code> </td>
+		</tr>
+	</table>
+
+
+
+
+	<p>The user running the script must have write permissions for each of these directories.</p>
+  
+    <a name="Backup_Recipe_File_Format_Content"
+    ></a><h3>Content</h3>
+    <p>The first step in any backup is to locate (or create) the content that is to be backed up. Backup provides a couple of shortcuts for common ways to locate content and allows you to arbitrarily define your own.
+Some typical types of content are:</p>
+
+
+	<ul>
+	<li>a particular file</li>
+		<li>a particular folder</li>
+		<li>the contents of a particular folder</li>
+	</ul>
+
+
+These could be specified like so:
+<div class='example'><pre><code>  <span class="ident">action</span> <span class="symbol">:content</span><span class="punct">,</span> <span class="symbol">:is_file</span>   <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">/path/to/file</span><span class="punct">&quot;</span>               <span class="comment"># content is a single file</span>
+  <span class="ident">action</span> <span class="symbol">:content</span><span class="punct">,</span> <span class="symbol">:is_folder</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">/path/to/folder</span><span class="punct">&quot;</span>             <span class="comment"># content is the folder itself </span>
+  <span class="ident">action</span> <span class="symbol">:content</span><span class="punct">,</span> <span class="symbol">:is_contents_of</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">/path/to/other/folder</span><span class="punct">&quot;</span>  <span class="comment"># content is folder/* , recursive option</span></code></pre></div>
+If you want <code><span class="symbol">:content</span></code> to be a series of shell commands just pass <code><span class="comment">#action</span></code> a block:
+<div class='example'><pre><code>  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:content</span><span class="punct">)</span> <span class="keyword">do</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">echo <span class="escape">\&quot;</span>hello $HOSTNAME<span class="escape">\&quot;</span></span><span class="punct">&quot;</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">mysqldump -uroot database &gt; /path/to/db.sql</span><span class="punct">&quot;</span> 
+    <span class="punct">&quot;</span><span class="string">/path/to/db.sql</span><span class="punct">&quot;</span> <span class="comment"># make sure you return the full path to the folder/file you wish to be the content </span>
+  <span class="keyword">end</span></code></pre></div>
+  
+    <a name="Backup_Recipe_File_Format_Compress"
+    ></a><h3>Compress</h3>
+    Next you may want to compress your content. Again, there are a few one-liners for common cases and you can create your own.
+<div class='example'><pre><code>  <span class="ident">action</span> <span class="symbol">:compress</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:tar_bz2</span>  <span class="comment"># actually calls a method named tar_bz2 with output of &quot;:content&quot; ( or &quot;:after_content&quot; ) </span>
+  <span class="comment"># or</span>
+  <span class="ident">action</span> <span class="symbol">:compress</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:tar_gzip</span></code></pre></div>
+Again, you can create your own.
+<div class='example'><pre><code>  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:compress</span><span class="punct">)</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">my_tar  <span class="expr">#{last_result}</span> <span class="expr">#{last_result}</span>.tar</span><span class="punct">&quot;</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">my_bzip <span class="expr">#{last_result}</span>.tar <span class="expr">#{last_result}</span>.tar.bz2</span><span class="punct">&quot;</span> 
+    <span class="ident">last_result</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">.tar.bz2</span><span class="punct">&quot;</span> 
+  <span class="keyword">end</span></code></pre></div>
+  
+    <a name="Backup_Recipe_File_Format_Encrypt"
+    ></a><h3>Encrypt</h3>
+    Encryption is available to you, if you wish to use it.
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:encrypt</span><span class="punct">,</span> <span class="constant">true</span>                              <span class="comment"># default is +false+</span>
+  <span class="ident">set</span> <span class="symbol">:gpg_encrypt_options</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">--default-recipient</span><span class="punct">&quot;</span> <span class="comment"># default is an empty string</span>
+  <span class="ident">action</span> <span class="symbol">:encrypt</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:gpg</span> <span class="comment"># default, none</span></code></pre></div>
+or your own:
+<div class='example'><pre><code>  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:encrypt</span><span class="punct">)</span>
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">gpg <span class="expr">#{c[:gpg_encrypt_options]}</span> --encrypt <span class="expr">#{last_result}</span></span><span class="punct">&quot;</span> 
+    <span class="ident">last_result</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">.gpg</span><span class="punct">&quot;</span>  
+  <span class="keyword">end</span></code></pre></div>
+
+	<p>I would recommend that you think seriously about how you wish to manage your keys for this backup process. If you are backing up encrypted data then you need to backup your keys or else risk losing access to your data. Secure key management is beyond the scope of this document.</p>
+  
+    <a name="Backup_Recipe_File_Format_Delivery"
+    ></a><h3>Delivery</h3>
+    <h4>Action</h4>
+
+
+	<p>Delivery is supported via <code><span class="ident">scp</span></code>, <code><span class="ident">ftp</span></code>, and <code><span class="ident">mv</span></code></p>
+
+
+	<p><i>Full <span class="caps">FTP</span> support is <a href="#Known_Bugs_and_Limitations_TODO">unfinished</a>. Currently, only <code><span class="ident">scp</span></code> and <code><span class="ident">mv</span></code> fully support rotation</i></p>
+
+
+<div class='example'><pre><code>  <span class="ident">action</span> <span class="symbol">:deliver</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:scp</span>
+  <span class="ident">action</span> <span class="symbol">:deliver</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:ftp</span>
+  <span class="ident">action</span> <span class="symbol">:deliver</span><span class="punct">,</span> <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:mv</span></code></pre></div>
+The <code><span class="symbol">:mv</span></code> action is defined (in <code><span class="ident">backup</span><span class="punct">/</span><span class="ident">recipes</span><span class="punct">/</span><span class="ident">standard</span><span class="punct">.</span><span class="ident">rb</span></code>) like any user-defined action:
+<div class='example'><pre><code>  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:mv</span><span class="punct">)</span> <span class="keyword">do</span>
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">mv <span class="expr">#{last_result}</span> <span class="expr">#{c[:backup_path]}</span>/</span><span class="punct">&quot;</span> 
+    <span class="ident">c</span><span class="punct">[</span><span class="symbol">:backup_path</span><span class="punct">]</span> <span class="attribute">@</span> <span class="punct">&quot;</span><span class="string">/</span><span class="punct">&quot;</span> <span class="attribute">@</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">basename</span><span class="punct">(</span><span class="ident">last_result</span><span class="punct">)</span>
+  <span class="keyword">end</span></code></pre></div>
+
+	<h4>Variables</h4>
+
+
+	<table>
+		<tr>
+			<th>Name </th>
+			<th>Desc.  </th>
+			<th>Example </th>
+		</tr>
+		<tr>
+			<td> <code><span class="symbol">:servers</span></code> </td>
+			<td> An array of host names to deliver the data to. <br /><strong><a href="#Known_Bugs_and_Limitations_TODO"><span class="caps">TODO</span></a> this currently supports one 1 server</strong>.  </td>
+			<td> <code><span class="ident">set</span> <span class="symbol">:servers</span><span class="punct">,</span>           <span class="punct">%w{</span><span class="string"> localhost </span><span class="punct">}</span></code> </td>
+		</tr>
+		<tr>
+			<td> <code><span class="symbol">:ssh_user</span></code> </td>
+			<td> The name of the ssh user on the foreign server. Default <span class="caps">ENV</span>[&#8216;USER&#8217;].  </td>
+			<td> <code><span class="ident">set</span> <span class="symbol">:ssh_user</span><span class="punct">,</span>          <span class="constant">ENV</span><span class="punct">['</span><span class="string">USER</span><span class="punct">']</span></code> </td>
+		</tr>
+		<tr>
+			<td> <code><span class="symbol">:identity_key</span></code> </td>
+			<td> The path to the key to use when ssh&#8217;ing into a foreign server.  </td>
+			<td> <code><span class="ident">set</span> <span class="symbol">:identity_key</span><span class="punct">,</span>      <span class="constant">ENV</span><span class="punct">['</span><span class="string">HOME</span><span class="punct">']</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">/.ssh/id_rsa</span><span class="punct">&quot;</span></code> </td>
+		</tr>
+	</table>
+  
+    <a name="Backup_Recipe_File_Format_Rotate"
+    ></a><h3>Rotate</h3>
+    <p>Rotation of your backups is a way to keep snapshot copies of your backups in time while not keeping every single backup for every single day. Currently the only form of rotation Backup supports is <a href="http://en.wikipedia.org/wiki/Grandfather-father-son">grandfather-father-son</a>. See <a href="http://en.wikipedia.org/wiki/Grandfather-father-son">Wikipedia</a> if you are unfamiliar with how this works.</p>
+
+
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:rotation_method</span><span class="punct">,</span>  <span class="symbol">:gfs</span> <span class="comment"># this is the default. you don't need to set it and there are no other supported options</span></code></pre></div>
+
+	<p>By deafult, a <code><span class="ident">son</span></code> is created daily, unless it is a day to create a <code><span class="ident">father</span></code> or <code><span class="ident">grandfather</span></code>.  It is assumed that every time you run Backup you want to create a backup. Therefore, if you do not want to a <code><span class="ident">son</span></code> (etc), do not run the program.  You can specify when a <code><span class="ident">son</span></code> is promoted to a <code><span class="ident">father</span></code> by the following variable:</p>
+
+
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:son_promoted_on</span><span class="punct">,</span>    <span class="symbol">:fri</span></code></pre></div>
+
+	<p>You specify when fathers are promoted to grandfathers by something like the following</p>
+
+
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:father_promoted_on</span><span class="punct">,</span> <span class="symbol">:last_fri_of_the_month</span></code></pre></div>
+
+	<p>Valid arguments for specifying these promotions are as follows:</p>
+
+
+	<ul>
+	<li><code><span class="symbol">:mon</span></code>-<code><span class="symbol">:sun</span></code> &#8211; A symbol of the abbreviation of any day of the week</li>
+		<li><code><span class="symbol">:last_</span><span class="punct">[</span><span class="ident">mon</span><span class="punct">-</span><span class="ident">sun</span><span class="punct">]</span><span class="ident">_of_the_month</span></code> &#8211; A symbol, replacing <code><span class="punct">[</span><span class="ident">mon</span><span class="punct">-</span><span class="ident">sun</span><span class="punct">]</span></code> with the
+    abbreviation for the day of the weeks. <br />
+    Example: <code><span class="symbol">:last_thu_of_the_month</span></code>.</li>
+		<li>Any valid <code><span class="constant">Runt</span></code> object.</li>
+	</ul>
+
+
+Representing these temporal ranges is done internally by using <code><span class="constant">Runt</span></code>. You are, therefore, allowed to pass in your own arbitrarily complex <code><span class="constant">Runt</span></code> object. For example, say that you wanted to promote to <code><span class="ident">father</span></code> on Monday, Wednesday and Friday. You could do the following:
+<div class='example'><pre><code>  <span class="ident">mon_wed_fri</span> <span class="punct">=</span> <span class="constant">Runt</span><span class="punct">::</span><span class="constant">DIWeek</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="constant">Runt</span><span class="punct">::</span><span class="constant">Mon</span><span class="punct">)</span> <span class="punct">|</span> 
+                <span class="constant">Runt</span><span class="punct">::</span><span class="constant">DIWeek</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="constant">Runt</span><span class="punct">::</span><span class="constant">Wed</span><span class="punct">)</span> <span class="punct">|</span> 
+                <span class="constant">Runt</span><span class="punct">::</span><span class="constant">DIWeek</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(</span><span class="constant">Runt</span><span class="punct">::</span><span class="constant">Fri</span><span class="punct">)</span>
+  <span class="ident">set</span> <span class="symbol">:son_promoted_on</span><span class="punct">,</span> <span class="ident">mon_wed_fri</span></code></pre></div>
+
+	<p>See the <a href="http://runt.rubyforge.org/">Runt documentation</a> for more information on this.</p>
+
+
+	<p>You can set how many of each rank to keep:</p>
+
+
+<div class='example'><pre><code>  <span class="comment"># assuming daily backups...</span>
+  <span class="ident">set</span> <span class="symbol">:sons_to_keep</span><span class="punct">,</span>         <span class="number">14</span>   <span class="comment"># this would be two weeks</span>
+  <span class="ident">set</span> <span class="symbol">:fathers_to_keep</span><span class="punct">,</span>       <span class="number">6</span>
+  <span class="ident">set</span> <span class="symbol">:grandfathers_to_keep</span><span class="punct">,</span>  <span class="number">6</span></code></pre></div>
+   
+  
+
+
+ <a name="Examples"></a><h2>Examples</h2>
+  
+    <a name="Examples_Good_things_come_in_threes"
+    ></a><h3>Good things come in threes</h3>
+    <p>Here we will cover three examples. </p>
+
+
+	<ul>
+	<li>a super-simple backup to a local directory. This will show how easy
+    things can be.</li>
+		<li>a more complex implementation. This will show some of the variables
+    you can set and show how to use a foreign server.</li>
+		<li>an even more complex configuration. This will show how to define
+    your own methods and set more advanced variables.</li>
+	</ul>
+  
+    <a name="Examples_Example_One___Backup_a_Folder_of_Logs"
+    ></a><h3>Example One | Backup a Folder of Logs</h3>
+    <p>Our first example will be backing up a folder of logs. Say we have a folder <code><span class="punct">/</span><span class="regex">var</span><span class="punct">/</span><span class="ident">my_logs</span><span class="punct">/</span></code> and it is full of log files.</p>
+
+
+	<p>What we want to do is:</p>
+
+
+	<ul>
+	<li>move out all the old log files</li>
+		<li>compress them and store them in a local folder</li>
+		<li>store 2 weeks of daily backups (sons)</li>
+		<li>store a weekly backup (father) going back 6 weeks</li>
+		<li>and create a monthly backup on the last friday of every month (grandfather) for 6 months</li>
+	</ul>
+
+
+Thankfully, this is incredibly simple:
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:backup_path</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">/var/local/backups/my_old_logs</span><span class="punct">&quot;</span> 
+  <span class="ident">set</span> <span class="symbol">:tmp_dir</span><span class="punct">,</span>     <span class="punct">&quot;</span><span class="string">/tmp</span><span class="punct">&quot;</span> <span class="comment"># this is the default so you actually dont have to specify it</span>
+  <span class="ident">action</span> <span class="symbol">:content</span><span class="punct">,</span>  <span class="symbol">:is_contents_of</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">/var/my_logs</span><span class="punct">&quot;</span></code></pre></div>
+
+	<p>And thats it!</p>
+
+
+	<p>Notice a couple of things here.</p>
+
+
+	<ol>
+	<li>Each time we <code><span class="ident">set</span></code> a variable that becomes available to the actions as <code><span class="ident">c</span><span class="punct">[</span><span class="symbol">:var</span><span class="punct">]</span></code></li>
+		<li>In this case, make sure that <code><span class="symbol">:backup_path</span></code> and <code><span class="symbol">:tmp_dir</span></code> are writable by the user that is running the backup script.</li>
+	</ol>
+  
+    <a name="Examples_Example_Two___SQL_Backup"
+    ></a><h3>Example Two | SQL Backup</h3>
+    <p>Our second example will be backing up a <a href="http://www.mediawiki.org">MediaWiki</a> installation.  Say we have a MySQL database named <code><span class="ident">mediawiki</span></code>.</p>
+
+
+	<p>This time we want to:</p>
+
+
+	<ul>
+	<li>create a dump of the database every day</li>
+		<li>compress this backup and store it in a local folder</li>
+		<li>store 2 weeks of daily backups (son) [<em>same as last time</em>]</li>
+		<li>store &#8220;father&#8221; backups every Monday, Wednesday and Friday going back 6 weeks</li>
+		<li>and create a monthly backup on the last Friday of every month (grandfather) for 6 months</li>
+	</ul>
+
+
+<div class='example'><pre><code>  <span class="ident">set</span> <span class="symbol">:backup_path</span><span class="punct">,</span> <span class="punct">&quot;</span><span class="string">/var/local/backups/mediawiki</span><span class="punct">&quot;</span> 
+
+  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:content</span><span class="punct">)</span> <span class="keyword">do</span>
+    <span class="ident">dump</span> <span class="punct">=</span> <span class="ident">c</span><span class="punct">[</span><span class="symbol">:tmp_dir</span><span class="punct">]</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">/mediawiki.sql</span><span class="punct">&quot;</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">mysqldump -uroot mediawiki &gt; <span class="expr">#{dump}</span></span><span class="punct">&quot;</span> 
+    <span class="ident">dump</span> <span class="comment"># make sure you return the name of the file</span>
+  <span class="keyword">end</span>
+
+  <span class="ident">action</span> <span class="symbol">:deliver</span><span class="punct">,</span>  <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:scp</span>
+  <span class="ident">action</span> <span class="symbol">:rotate</span><span class="punct">,</span>   <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:via_ssh</span>
+
+  <span class="ident">set</span> <span class="symbol">:servers</span><span class="punct">,</span>           <span class="punct">%w{</span><span class="string"> my.server.com </span><span class="punct">}</span>
+
+  <span class="ident">set</span> <span class="symbol">:son_promoted_on</span><span class="punct">,</span>    <span class="symbol">:sun</span>
+  <span class="ident">set</span> <span class="symbol">:father_promoted_on</span><span class="punct">,</span> <span class="symbol">:last_sun_of_the_month</span>
+
+  <span class="ident">set</span> <span class="symbol">:sons_to_keep</span><span class="punct">,</span>         <span class="number">21</span>  
+  <span class="ident">set</span> <span class="symbol">:fathers_to_keep</span><span class="punct">,</span>      <span class="number">12</span>
+  <span class="ident">set</span> <span class="symbol">:grandfathers_to_keep</span><span class="punct">,</span> <span class="number">12</span></code></pre></div>
+
+	<p>A couple things to note:</p>
+
+
+	<ol>
+	<li>In this example, it is assumed that the current user running the
+   script has <code><span class="ident">ssh</span></code> keys configured for password-less login to
+   <code><span class="ident">my</span><span class="punct">.</span><span class="ident">server</span><span class="punct">.</span><span class="ident">com</span></code>. If you want to change the user to login as set the
+   variable <code><span class="symbol">:ssh_user</span></code>. You can also specify a key with
+   <code><span class="symbol">:identity_key</span></code>.</li>
+		<li>Number 1 is the only thing</li>
+	</ol>
+  
+    <a name="Examples_Example_Three___Something_more_complex"
+    ></a><h3>Example Three | Something more complex</h3>
+    <p>By now it should be easy to see what is going on here:</p>
+
+
+<div class='example'><pre><code>  <span class="ident">action</span> <span class="symbol">:content</span><span class="punct">,</span>  <span class="symbol">:is_file</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">/path/to/file.abc</span><span class="punct">&quot;</span> 
+  <span class="ident">action</span> <span class="symbol">:compress</span><span class="punct">,</span> <span class="symbol">:method</span>  <span class="punct">=&gt;</span> <span class="symbol">:my_tar_gzip</span>
+
+  <span class="ident">action</span><span class="punct">(</span><span class="symbol">:my_tar_gzip</span><span class="punct">)</span> <span class="keyword">do</span>
+    <span class="ident">name</span> <span class="punct">=</span> <span class="ident">c</span><span class="punct">[</span><span class="symbol">:tmp_dir</span><span class="punct">]</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">/</span><span class="punct">&quot;</span> <span class="punct">+</span> <span class="constant">File</span><span class="punct">.</span><span class="ident">basename</span><span class="punct">(</span><span class="ident">last_result</span><span class="punct">)</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">.tar.gzip</span><span class="punct">&quot;</span> 
+    <span class="ident">sh</span> <span class="punct">&quot;</span><span class="string">tar -czv --exclude .DS* --exclude CVS  <span class="expr">#{last_result}</span> &gt; <span class="expr">#{name}</span></span><span class="punct">&quot;</span> 
+    <span class="ident">name</span> <span class="comment"># make sure you return the name of the tar.gzip file</span>
+  <span class="keyword">end</span>
+
+  <span class="ident">set</span> <span class="symbol">:encrypt</span><span class="punct">,</span> <span class="constant">true</span>
+
+  <span class="ident">action</span> <span class="symbol">:deliver</span><span class="punct">,</span>  <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:scp</span>  
+  <span class="ident">action</span> <span class="symbol">:rotate</span><span class="punct">,</span>   <span class="symbol">:method</span> <span class="punct">=&gt;</span> <span class="symbol">:via_ssh</span>
+
+  <span class="ident">set</span> <span class="symbol">:ssh_user</span><span class="punct">,</span>          <span class="punct">&quot;</span><span class="string">backup_user</span><span class="punct">&quot;</span> 
+  <span class="ident">set</span> <span class="symbol">:identity_key</span><span class="punct">,</span>      <span class="constant">ENV</span><span class="punct">['</span><span class="string">HOME</span><span class="punct">']</span> <span class="punct">+</span> <span class="punct">&quot;</span><span class="string">/.ssh/backup_key</span><span class="punct">&quot;</span></code></pre></div>
+   
+  
+
+        <div class="ad">
+
+            <script type="text/javascript"><!--
+            google_ad_client = "pub-0934913060779093";
+            google_ad_width = 728;
+            google_ad_height = 90;
+            google_ad_format = "728x90_as";
+            google_ad_type = "text_image";
+            //2006-10-06: backup_before_recipe_1
+            google_ad_channel ="7683863986";
+            //--></script>
+            <script type="text/javascript"
+              src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
+            </script>
+
+        </div> 
+
+ <a name="Known_Bugs_and_Limitations"></a><h2>Known Bugs and Limitations</h2>
+  
+    <a name="Known_Bugs_and_Limitations_TODO"
+    ></a><h3>TODO</h3>
+    <p>What is left to do:</p>
+
+
+	<ul>
+	<li>Finish <span class="caps">FTP</span> support</li>
+		<li>Add support for multiple backup servers</li>
+		<li>Add in better logging </li>
+		<li>Remove all the <code><span class="ident">tmp_dir</span></code> references. use and test the standard library <code><span class="ident">tmpdir</span></code></li>
+		<li>Continue testing it</li>
+	</ul>
+
+
+	<p>If you find yourself writing the code for <code><span class="constant">Backup</span></code> to fix these things, please consider <a href="http://rubyforge.org/mailman/listinfo/backupgem-devel">submitting your patch</a> for the benefit of the community.</p>
+  
+    <a name="Known_Bugs_and_Limitations_BUGS"
+    ></a><h3>BUGS</h3>
+    <ul>
+	<li>You can&#8217;t <code><span class="keyword">return</span></code> in the user-defined actions for some reason. I think this
+  has to do with the <code><span class="ident">instance_eval</span></code>. But still, I wouldn&#8217;t think it would
+  matter. I&#8217;d be interested in any suggestions on how to fix this.</li>
+		<li>Please submit other bugs via the trackers at the 
+  <a href="http://rubyforge.org/projects/backupgem">BackupGem project page</a>.</li>
+	</ul>
+   
+  
+
+
+</div> <!-- end content -->
+</div> <!-- end wrapper -->
+
+<div id="navigation">
+  <ol>
+
+  <li><a href="#Introduction">Introduction</a>
+    <ol>
+  
+      <li><a href="#Introduction_Welcome"
+          >Welcome</a></li>
+  
+    </ol>
+  </li>
+
+  <li><a href="#Housekeeping">Housekeeping</a>
+    <ol>
+  
+      <li><a href="#Housekeeping_Prerequisites"
+          >Prerequisites</a></li>
+  
+      <li><a href="#Housekeeping_Using_RubyGems"
+          >Using RubyGems</a></li>
+  
+      <li><a href="#Housekeeping_Using_svn"
+          >Using svn</a></li>
+  
+      <li><a href="#Housekeeping_License_Information"
+          >License Information</a></li>
+  
+      <li><a href="#Housekeeping_Support"
+          >Support</a></li>
+  
+      <li><a href="#Housekeeping_Mailing_Lists"
+          >Mailing Lists</a></li>
+  
+      <li><a href="#Housekeeping_About_the_Author"
+          >About the Author</a></li>
+  
+      <li><a href="#Housekeeping_Special_Thanks"
+          >Special Thanks</a></li>
+  
+    </ol>
+  </li>
+
+  <li><a href="#How_Backup_Works">How Backup Works</a>
+    <ol>
+  
+      <li><a href="#How_Backup_Works_A_Typical_Backup"
+          >A Typical Backup</a></li>
+  
+      <li><a href="#How_Backup_Works_CLI"
+          >CLI</a></li>
+  
+    </ol>
+  </li>
+
+  <li><a href="#Backup_Recipe_File_Format">Backup Recipe File Format</a>
+    <ol>
+  
+      <li><a href="#Backup_Recipe_File_Format_Recipes_Explained"
+          >Recipes Explained</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Variables"
+          >Variables</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Content"
+          >Content</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Compress"
+          >Compress</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Encrypt"
+          >Encrypt</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Delivery"
+          >Delivery</a></li>
+  
+      <li><a href="#Backup_Recipe_File_Format_Rotate"
+          >Rotate</a></li>
+  
+    </ol>
+  </li>
+
+  <li><a href="#Examples">Examples</a>
+    <ol>
+  
+      <li><a href="#Examples_Good_things_come_in_threes"
+          >Good things come in threes</a></li>
+  
+      <li><a href="#Examples_Example_One___Backup_a_Folder_of_Logs"
+          >Example One | Backup a Folder of Logs</a></li>
+  
+      <li><a href="#Examples_Example_Two___SQL_Backup"
+          >Example Two | SQL Backup</a></li>
+  
+      <li><a href="#Examples_Example_Three___Something_more_complex"
+          >Example Three | Something more complex</a></li>
+  
+    </ol>
+  </li>
+
+  <li><a href="#Known_Bugs_and_Limitations">Known Bugs and Limitations</a>
+    <ol>
+  
+      <li><a href="#Known_Bugs_and_Limitations_TODO"
+          >TODO</a></li>
+  
+      <li><a href="#Known_Bugs_and_Limitations_BUGS"
+          >BUGS</a></li>
+  
+    </ol>
+  </li>
+
+</ol>
+
+</div>
+
+<div id="extra">
+  <ul>
+  <li><a href="http://tech.natemurray.com">tech.natemurray.com</a></li>
+</ul>
+
+</div>
+
+<div id="footer">
+  <p>
+ &copy; 2006 <a href="mailto:nate+backupgem@natemurray.com">Nate Murray</a>. <span class="last_updated">Last updated Tue Oct 10 09:20:53 PDT 2006</span>
+</p>
+
+</div>
+
+
+</div> <!-- end container -->
+</body>
+</html>