README for rsync-backup-rotator
===============================

Overview
--------
rsync-backup-rotator is a shell script that leverages rsync to create and manage rotating backups. It facilitates daily backups based on the weekday and monthly snapshots on the first day of each month. This tool is designed for flexibility, ease of use, and is configurable via command-line options.

Version: 1.0.0
License: GNU General Public License v3.0

Concept
-------
The script is designed to work with a specific directory structure. It expects the presence of a 'current' folder within the provided parent directory. This 'current' folder should contain the latest backup data. rsync-backup-rotator will use this 'current' folder as the source to create rotating backups into weekly and monthly snapshots.

- Weekly backups are stored in subfolders named after each weekday within a 'week' folder.
- Monthly backups are stored in subfolders named after each month within a 'month' folder.

The script ensures that your backup data is systematically organized for easy retrieval and management.

Requirements
------------
- GNU/Linux/Unix environment
- rsync installed

Installation
------------
1. Download the script from https://source.willem.com/rsync-backup-rotator/
2. Make the script executable: `chmod +x rsync-backup-rotator.sh`

Usage
-----
To use rsync-backup-rotator, run the script with the required arguments:

    ./rsync-backup-rotator.sh <parent_directory> [options]

Options:
- -w: Enable backups for each weekday.
- -m: Enable backups for the first day of each month.
- --delete: Include the --delete option in rsync to remove files in the destination that are no longer in the source.
- --help: Display help information.

Examples:
- Perform a weekday backup: `./rsync-backup-rotator.sh /path/to/parent -w`
- Perform both weekday and monthly backups with deletion of removed files: `./rsync-backup-rotator.sh /path/to/parent -wm --delete`

Contributing
------------
Contributions to rsync-backup-rotator are welcome. Send me your ideas, suggestions or contributions via https://willem.com.

Contact Information
-------------------
For more information or to report issues, please visit https://source.willem.com/rsync-backup-rotator/ or contact Willem L. Middelkoop through https://willem.com.

Changelog
---------
The changelog can be found at https://source.willem.com/rsync-backup-rotator/CHANGELOG.txt.