File	Date	Author	Commit
bin	2010-02-05	Jan Rüegg	[fbe844] still modif script.rb... types... tests
lib	2010-02-17	Jan Rüegg	[6888e2] tests working again
test	2010-09-22	Jan Rüegg	[133d50] + Adapted tests
.autotest	2009-12-16	Jan Rüegg	[4ce135] Working GEM
History.txt	2010-01-28	Jan Rüegg	[68d06f] added date to history
Manifest.txt	2009-12-21	Jan Rüegg	[17b95f] Even better gem (final?)
README.txt	2010-01-30	Jan Rüegg	[dc7b78] Started rewrite of script.rb, testing
Rakefile	2010-02-16	Jan Rüegg	[6af14c] Added 'mocha' tests

Read Me

= smarbs

* http://smarbs.sourceforge.net

== DESCRIPTION:

Smarbs is a backup script written in ruby.
It is capable of doing intelligent and automated backups using rsync.

== FEATURES/PROBLEMS:

Smarbs was designed to be

* fast
* incremental
* able to take full snapshots
* space managing
* able to handle several sources
* automated 

== SYNOPSIS:

Run smarbs --help to see what options you have. The configfiles are stored
in the directory /etc/smarbs or ~/.smarbs, if not executed as root.

= Syslog

Smarbs can log to syslog instead of directly to file. Note, you
should only enable this feature if you know what you are doing, and
have root access. 

Example configuration for syslog-ng, this will log everything "smarbs"
into separate file.

 destination smarbs      { file("/var/log/smarbs.log"
                            template("$FULLDATE [$LEVEL] $MSG\n")
                            template_escape(no) );
                          };
  filter f_smarbs         { program(smarbs); };
log { source(src); filter(f_smarbs);      destination(smarbs); };

To filter out some less important information, try:

  filter f_smarbs         { program(smarbs) and level(notice..err); };

Also, if you put $ISODATE there instead of $FULLDATE, you will get
date in ISO-standard format.

== REQUIREMENTS:

* Ruby 1.9.1
* rsync
* standard unix tools (du, df, ...)
* optional: ruby-gtk2: For status icon while backupping
* optional: syslog-ng: For syslog functionality


== INSTALL:

* sudo gem install smarbs

or

* gem install smarbs

== DEVELOPERS:

After checking out the source, run:

  $ rake newb

This task will install any missing dependencies, run the tests/specs,
and generate the RDoc.

== LICENSE:

(GPL)

Copyright (c) 2009 Jan Rüegg <rggjan@gmail.com>

Smarbs is free software; you can redistribute it and/or modify it 
under the terms of the GNU General Public License as published by 
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of 
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
General Public License for more details.

You can find a copy of the GNU General Public License under 
http://www.gnu.org/licenses/