Improved usage message

CHANGELOG

@@ -0,0 +1,25 @@
+    RIBS - Rod's Incremental Backup System
+    Copyright (C) 2025  Rod Wright
+
+    This program 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 2 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 should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+    
+    
+Changelog
+
+1.x - 2024-01-09
+    - Initial releases as a bash script.
+
+2.0 - 2025-03-19
+    - Complete rewrite into python.

INSTALL

@@ -0,0 +1,21 @@
+Installation or upgrade of RIBS is straightforward.
+
+1. Unpack
+Unpack the distribution in a convenient place. A directory will
+created called RIBS-x.x/.
+
+2. Review License
+Change to the RIBS-x.x/ directory and review the LICENSE file.
+
+3. Run the install script
+In the same directory, type sudo ./install.sh at a command prompt to
+install RIBS.
+
+4. Configure
+Type ribs -h for help on the ribs command. Type ribs -c to manage ribs
+configuration.
+
+5. Run RIBS
+Type ribs at a command line to run the config files, or refer to the
+/usr/local/bin/run_ribs_backups script for info on running ribs as a
+scheduled task using cron.

LICENSE

@@ -0,0 +1,341 @@
+		    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
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the \"copyright\" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program 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 2 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 should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a \"copyright disclaimer\" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.
+

README.md

@@ -0,0 +1,95 @@
+# RIBS - Rod's Incremental Backup System
+
+## Description
+
+With RIBS you can run automated incremental backups of one or more Linux systems to local or remote storage.
+
+## Who RIBS is for
+
+RIBS is intended for a system administrator who wants to have easily accessible snapshots of the state
+of a specified part of a system at any point in time.
+
+## Dependencies
+
+Before using RIBS, ensure you have:
+
+* Python3
+* rsync
+
+These can be installed using the package manager of your Linux distribution.
+
+## Instructions for using RIBS
+
+### Install RIBS
+
+1. Download RIBS
+
+    The easiest way is to run `wget https://gitserver.thermionic.net/rod.wright/RIBS/releases/download/2.0/RIBS-2.0.tar.gz`
+
+    or visit https://gitserver.thermionic.net/rod.wright/RIBS/releases to download the specific package version you'd like to use.
+
+2. Extract the package
+
+    `tar -zxvf RIBS-2.0.tar.gz`
+
+3. Change to the extracted package directory
+
+    `cd RIBS-2.0`
+
+4. Run the installer as superuser
+
+    `sudo ./install.sh`
+
+
+### Configure RIBS
+
+RIBS operates through the use of configuration files. The format of the file is documented in the sample file, 
+[/etc/ribs/conf-available/ribs.conf.sample](dist/etc/ribs/conf-available/ribs.conf.sample)
+
+* Superuser configuration files are located in `/etc/ribs/conf-available`. If RIBS is run by a 
+superuser, those files will be used. A sample configuration file is provided.  
+* Standard user configuration files are located in the user's home directory in `.ribs/conf-available`. 
+* To enable automated usage of RIBS, the configuration file must be enabled
+by creating a symbolic link in `/etc/ribs/conf-enabled` or `.ribs/conf-enabled` to the configuration file in `/etc/ribs/conf-available` or `.ribs/conf-available`.
+
+### Run RIBS
+```
+usage: ribs [-h] [-s] [-c | -l | -e CONF_FILE | -d CONF_FILE | conf_file]
+
+Rod's Incremental Backup System, version 2.0
+
+positional arguments:
+  conf_file             Run RIBS using the specified config file. If none
+                        specified, run all enabled config files, looking in
+                        '~/.ribs/conf-enabled' for standard users, or in
+                        '/etc/ribs/conf-enabled' for superusers.
+
+options:
+  -h, --help            show this help message and exit
+  -s, --simulate        simulate operations to be performed
+  -c, --config          interactively create, remove, modify, enable, or 
+                        disable config files
+  -l, --list-configs    list all config files
+  -e CONF_FILE, --enable-config CONF_FILE
+                        enable a config file
+  -d CONF_FILE, --disable-config CONF_FILE
+                        disable a config file
+```
+
+A script called `run_ribs_backups` is located in /usr/local/bin.
+This script is intended to facilitate running ribs backups using cron.
+To run system configs, either create a link to this script in one or
+more of the /etc/cron.* directories or add a line calling this script
+to the /etc/crontab file. That will run all enabled system configs.
+To run user configs, the user should add a line calling this script 
+to their personal crontab. That will run all enabled user configs for
+that user.
+
+## How to report problems
+
+To report an issue with RIBS, email me at software@rodsplace.net.
+
+## Terms of use
+
+RIBS is licensed under the [GNU General Public License v2](LICENSE)
+

VERSION.txt

@@ -0,0 +1 @@
+2.0

dist/etc/ribs/conf-available/ribs.conf.sample

@@ -0,0 +1,124 @@
+# ribs.conf.sample
+# Configuration file for Rod's Incremental Backup System
+#
+# A configuration file should be created in either the system
+# config directory (/etc/ribs/conf-available) or the user's
+# config directory (~/.ribs/conf-available). The filename must
+# have the .conf suffix. Use the ribs command to enable or disable
+# the config file with the -e|--enable or -d|--disable options.
+# Run ribs -h for help.
+
+[General]
+# General Options
+#
+#   At least source_dir, backup_root, day_limit, and storage_type 
+#   are required.
+# 
+# Source directory - The directory where files to be backed up are
+#   located. This must be an absolute, not a relative path. If the 
+#   trailing slash is included, the contents of the directory will be
+#   backed up. If not, the directory itself will be backed up.
+#   NOTE: Special characters must be escaped with backslashes!
+#
+#source_dir=/var/www/
+#
+# Backup root directory - The directory on the backup storage where the
+#   backups are stored. For offline storage, this is the mount point of 
+#   the backup drive filesystem. For remote storage, this is the path on
+#   the remote server. Must be writable to user running RIBS. This must
+#   be an absolute, not a relative path. Directories named as the date
+#   of the backups will be created here containing the backed up files.
+#   NOTE: Special characters must be escaped with backslashes!
+#
+#backup_root=/mnt/incremental_backup_dir
+#
+# Backup subdirectory - A subdirectory of backup_root in which to store 
+#   the backup date directories. If this is not set, the date 
+#   directories will be created directly in backup_root.
+#   NOTE: Special characters must be escaped with backslashes!
+#
+#backup_subdir=/main
+#
+# Exclude list - List of file patterns to exclude, separated by
+#   commas. Anything in the source directory that matches a pattern in
+#   this list will not be backed up. If you don't want to exclude
+#   anything from the backup, comment this option out with a '#'.
+#   NOTE: Special characters must be escaped with backslashes unless
+#   they represent a wildcard in a pattern!
+#
+#exclude_list=DatabaseBackups-*, somehugedir, secretstuff
+#
+# Day limit - The number of days of backups to keep. When the backup is
+#   complete, directories with dates older than this limit will be
+#   deleted.
+#
+#day_limit=90
+#
+# Storage type - Where the backups are to be stored. Only one of the
+#   three options should be specified. Set the option you want, then 
+#   refer to the appropriate section below for that specific
+#   configuration. Possible values are:
+#   local - Back up to a local directory. Can also be anything already
+#       mounted on the local filesystem.
+#   offline - Back up to offline storage that must be mounted. Can be
+#       anything that you can mount and unmount, including a filesystem
+#       on a local block device or a remote NFS or CIFS/SMB share.
+#       NOTE: To use offline storage, you must have superuser privileges
+#       in order to mount and unmount the device. RIBS will abort if you
+#       set storage_type to offline and you are not running as root or
+#       with sudo.
+#   remote - Back up to a remote system directly via rsync. If you use
+#       this, you must define remote_user_host below and setup pubkey 
+#       authentication vi ssh for the remote user and host.
+#
+#storage_type=remote
+#
+
+
+[local]
+# Options for local storage type
+#
+# There are currently no specific settings for the local storage type.
+#
+
+
+[offline]
+# Options for offline storage type
+#
+#
+# Mount parameters - Storage filesystem mount parameters. Should be what
+#   you'd type on the command line between the word "mount" and the 
+#   mountpoint. See the manual page for the mount command (man 8 mount)
+#   for the available options. If this is blank ("") or not defined,
+#   RIBS will attempt to mount backup_root, defined above in the 
+#   [General] section, with no parameters, hoping that it is listed in
+#   /etc/fstab (man 5 fstab). You must run RIBS with superuser
+#   privileges for the offline storage type to work, since it requires
+#   mounting and unmounting filesystems.
+#
+#mount_parameters=-t ext4 -U 433a2e61-25aa-4da5-a7c7-4d730a5793e7
+#mount_parameters="-t nfs nfsserver:/srv/ribs-backups"
+#mount_parameters="/dev/sdc1"
+#
+# Remount read-only - Set this to True if storage should be remounted in
+#   read-only mode when not being used for backups, False if not. If 
+#   blank ("") or not defined, the default is False.
+#
+#remount_ro=True
+#
+
+[remote]
+# Options for remote storage type
+#
+# Options in this section are required if storage_type above is set
+# to remote. Otherwise, they are ignored. 
+#
+# Remote user and host - The user and host to connect to for backup
+#   storage. If you want RIBS to be able to run unattended, for example
+#   as a cron job,  you will need to ensure that the user's ssh public
+#   key is listed in the remote host's authorized_keys file. This is 
+#   usually done with the ssh-copy-id command, which also takes care of
+#   adding the host's key fingerprint to the local known_hosts file.
+#
+#remote_user_host=user@backupserver
+#

dist/usr/local/bin/run_ribs_backups

@@ -0,0 +1,17 @@
+#!/bin/bash
+# run_ribs_backups
+#
+# This script is intended to facilitate running ribs backups using cron.
+# To run system configs, either create a link to this script in one or
+# more of the /etc/cron.* directories or add a line calling this script
+# to the /etc/crontab file. That will run all enabled system configs.
+# To run user configs, the user should add a line calling this script 
+# to their personal crontab. That will run all enabled user configs for
+# that user.
+
+log_path="/var/log/ribs"
+log_fn="ribs_$(date +%Y%m%d%H%M%S).log"
+
+/usr/local/bin/ribs > "$log_path"/"$log_fn" 2>&1
+
+    

etc/ribs/exclude_list

@@ -1,7 +0,0 @@
-/archive/
-/backups/rescuebru-backups/
-/old_VirtualBox_files/
-/RescueBRU/
-/VirtualBox_VMs/
-/VMwareBackups/
-/VMwareDatastore/

etc/ribs/ribs.conf

@@ -1,28 +0,0 @@
-#!/bin/bash
-# Configuration file for ribs.sh
-
-# Dry run option. Set to 0 for normal mode or 1 for testing.
-DRY_RUN=0
-
-# Remount option. Set to 0 to not remount  or 1 to remount read-only.
-REMOUNT=1
-
-# Mount point of backup drive
-BACKUP_ROOT="/mnt/incremental_backup_drive"
-
-# Backup device
-BACKUP_DEV="/dev/sde"
-BACKUP_PART=$BACKUP_DEV"1"
-
-# Backup device serial number (as reported by smartctl -a)
-BACKUP_DEV_SN=W4Z1490W
-
-# File containing patterns to exclude
-EXC_FILE="/etc/ribs/exclude_list"
-
-#Number of days of backups to keep
-DAY_LMT=60
-
-# source directory
-SRC="/mnt/raid/"
-

install.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+# RIBS installer
+
+# test for superuser rights
+if [[ $EUID -ne 0 ]]; then
+   echo "This script must be run with superuser privileges. Try sudo ./install.sh" 
+   exit 1
+fi
+
+echo "Copying new files."
+sleep 2
+rsync -av --chown=root:root dist/ /
+chmod +x /usr/local/bin/ribs
+chmod +x /usr/local/bin/run_ribs_backups
+chmod 777 /var/log/ribs
+echo "Installation complete. RIBS must have a config file to run. Refer to"
+echo "/etc/ribs/conf-available/ribs.conf.sample."
+echo "Type ribs -h or ribs --help for help."

usr/local/bin/ribs.sh

@@ -1,188 +0,0 @@
-#!/bin/bash
-
-# Full path of configuration file
-CONF_FILE="/etc/incremental_backup/incremental_backup.conf"
-
-echo "----------------- RIBS ----------------"
-echo "--- Rod's Incremental Backup System ---"
-echo ""
-
-# Read the configuration file
-echo -n "Reading configuration file... "
-source $CONF_FILE
-if [ $? -ne 0 ]; then
-        echo -e "\e[31mFAILED\e[0m"
-        echo "Aborting."
-        exit 1
-else
-        echo -e "\e[32mOK\e[0m"
-fi
-
-# Today's date
-DAY0=`date -I`
-echo "Today's date: $DAY0"
-
-# Previous backup's date
-DAY1=`ls $BACKUP_ROOT | grep -v lost+found | tail -n1`
-if [ "$DAY1" == "" ]; then
-	DAY1=`date -I -d "yesterday"`
-	echo "No previous backup date. Using yesterday's date."
-elif [ "$DAY1" == "$DAY0" ]; then
-	DAY1=`ls $BACKUP_ROOT | grep -v lost+found | tail -n1 | head -n1`
-	echo "Previous backup date: $DAY1"
-else
-	echo "Previous backup date: $DAY1"
-fi
-
-# target directory
-TRG="$BACKUP_ROOT/$DAY0"
-
-# link destination directory:
-LNK="$BACKUP_ROOT/$DAY1"
-
-# rsync options
-OPT="-ah --delete --link-dest=$LNK --exclude-from=$EXC_FILE"
-if [ "$DRY_RUN" -eq 1 ]; then
-        OPT="$OPT -n"
-fi
-
-
-echo -n "Run started "
-date
-echo ""
-# -------- Start backup -------
-echo "Starting incremental backup."
-if [ "$DRY_RUN" -eq 1 ]; then
-	echo "This will be a dry run. Nothing will actually be backed up."
-	sleep 10
-fi
-# Check to see if the backup drive is connected
-echo -n "Checking if device connected... "
-if [ ! -b "$BACKUP_DEV" ]; then
-	echo -e "\e[31mFAILED\e[0m"
-	echo "The backup device is not present."
-	echo "Check to make sure it's connected and powered on and that the"
-	echo "device name in $CONF_FILE is correct."
-	echo "Aborting."
-	exit 1
-else
-	echo -e "\e[32mOK\e[0m"
-fi
-# Check that the backup drive serial number is correct
-echo -n "Checking device serial number... "
-dev_sn=`smartctl -a $BACKUP_DEV|grep "Serial Number:"|cut -d: -f2| sed 's/[[:space:]]//g'`
-if [ "$dev_sn" != "$BACKUP_DEV_SN" ]; then
-	echo -e "\e[31mFAILED\e[0m"
-	echo "The backup device that is attached does not have the correct"
-	echo "serial number. Make sure the correct device is connected and"
-	echo "check that the serial number in $CONF_FILE"
-	echo "matches the serial number of the device as reported by"
-	echo "smartctl -a $BACKUP_DEV"
-	echo "Aborting."
-	exit 1
-else
-        echo -e "\e[32mOK\e[0m"
-fi
-# Mount the backup drive
-# First, check to see that drive is mounted 
-mount|grep -q $BACKUP_PART
-if [ $? -ne 0 ]; then
-	echo -n "Backup device partition not mounted. Mounting read-only... "
-	mount $BACKUP_PART $BACKUP_ROOT -o ro
-	if [ $? -ne 0 ]; then
-		echo -e "\e[31mFAILED\e[0m"
-		echo "An error was encountered while attempting to mount"
-		echo "$BACKUP_PART on $BACKUP_ROOT"
-		echo "Aborting."
-		exit 1
-	else
-		echo -e "\e[32mOK\e[0m"
-	fi
-fi
-# Next, if it's mounted ro, remount it rw
-mount|grep $BACKUP_PART |grep -q "(rw)"
-if [ $? -ne 0 ]; then
-	echo "Backup device partition mounted read-only."
-	echo -n " Remounting read-write... "
-	mount $BACKUP_PART $BACKUP_ROOT -o remount,rw
-	if [ $? -ne 0 ]; then
-		echo -e "\e[31mFAILED\e[0m"
-		echo "An error was encountered while attempting to mount"
-		echo "$BACKUP_PART on $BACKUP_ROOT in read-write mode."
-		echo "Aborting."
-		exit 1
-	else
-		echo -e "\e[32mOK\e[0m"
-	fi
-else
-	echo "Backup device partition already mounted read-write. Continuing"
-fi
-
-# Execute the backup
-echo -n "running rsync backup... "
-rsync $OPT $SRC $TRG
-if [ $? -ne 0 ]; then
-	echo -e "\e[31mFAILED\e[0m"
-	echo "An error was encountered while attempting to backup. No old"
-	echo "backups will be removed."
-	if [ "$REMOUNT" -eq 1 ]; then
-		mount $BACKUP_PART $BACKUP_ROOT -o remount,ro
-	else
-		umount $BACKUP_ROOT
-	fi
-	exit 1
-else
-        echo -e "\e[32mOK\e[0m"
-fi
-
-
-# Date of $DAY_LMT
-DAY_TO_REMOVE=`date -I -d "$DAY_LMT days ago"`
-
-# Delete the specified backup, if it exists
-if [ "$DRY_RUN" -eq 1 ]; then
-	echo "This is a dry run, so no old backups will be removed."
-else
-	if [ -d $BACKUP_ROOT/$DAY_TO_REMOVE ]; then
-		echo -n "Removing oldest backup... "
-		rm -r $BACKUP_ROOT/$DAY_TO_REMOVE
-		if [ $? -ne 0 ];then
-			echo -e "\e[31mFAILED\e[0m"
-		else
-			echo -e "\e[32mOK\e[0m"
-		fi
-	fi
-fi
-
-# Unmount the backup drive and exit
-echo -n "Syncing disks... "
-sync
-if [ $? -ne 0 ];then
-	echo -e "\e[31mFAILED\e[0m"
-else
-	echo -e "\e[32mOK\e[0m"
-fi
-if [ "$REMOUNT" -eq 1 ]; then
-	echo -n "Remounting backup device read-only... "
-	mount $BACKUP_PART $BACKUP_ROOT -o remount,ro
-	if [ $? -ne 0 ]; then
-        	echo -e "\e[31mFAILED\e[0m"
-	else
-        	echo -e "\e[32mOK\e[0m"
-	fi
-else
-	echo -n "Unmounting backup device... "
-	umount $BACKUP_PART
-	if [ $? -ne 0 ]; then
-        	echo -e "\e[31mFAILED\e[0m"
-	else
-        	echo -e "\e[32mOK\e[0m"
-	fi
-fi
-echo "Backup complete."
-echo ""
-echo -n "Run ended "
-date
-echo ""
-
-exit 0