File	Date	Author	Commit
debian	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt
.hgignore	2024-02-20	Russell Stuart	[b3bc2d] Release rsync-backup-0.1-1 - see ChangeLog.txt
.hgtags	2024-03-19	Russell Stuart	[ba9528] Added tag rsync-backup-0.2-1 for changeset 9260...
ChangeLog.txt	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt
Makefile	2024-02-20	Russell Stuart	[b3bc2d] Release rsync-backup-0.1-1 - see ChangeLog.txt
Makefile.release	2024-02-20	Russell Stuart	[b3bc2d] Release rsync-backup-0.1-1 - see ChangeLog.txt
README.txt	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt
agpl-3.0.txt	2024-02-20	Russell Stuart	[b3bc2d] Release rsync-backup-0.1-1 - see ChangeLog.txt
rsync-backup.1	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt
rsync-backup.html	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt
rsync-backup.sh	2024-03-19	Russell Stuart	[9260dd] Release rsync-backup-0.2-1 - see ChangeLog.txt

Read Me

rsync-backup
============

  Create backups by copying directories using rsync;


Dependencies
------------

  findfs.  Debian package: util-linux.
      Only needed if backup locations are specified by label or UUID.

  flock.  Debian package: util-linux.
      Required.

  rsync.   Debian package: rsync.
      Required.

  sh.
      Required. /bin/sh must be a POSIX shell.
      
  /usr/lib/sendmail. Debian package: mail-transport-agent
      Only needed if --email is used.

  ssh.  Debian package: openssh-client
      Only needed if used as a backup target.

  sudo.  Debian package: sudo
      Only needed if --sudo, --sudo-local or --sudo-remote is used,
      or a file system must be mounted.

  chrt, ionice, nice.  Debian package: util-linux.
  eatmydata, nocache.  Debian packages: eatmydata, nocache.
      Optional, but if present will be used to reduce the impact of
      rsync-backup on the machine.

Rsync-backup was developed on Debian, but will run on any Linux / BSD
machine with the above dependencies installed.  The target file system
also needs to be Linux or BSD.


Building, Installing and Running
--------------------------------

  There is no building required, and the only installation consists of
  download a copy of rsync-backup.sh and making it executable.
  rsync-backup.1 contains the man page.



License
-------

  Copyright (c) 2024 Russell Stuart.

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

  The copyright holders grant you an additional permission under Section 7
  of the GNU Affero General Public License, version 3, exempting you from
  the requirement in Section 6 of the GNU General Public License, version 3,
  to accompany Corresponding Source with Installation Information for the
  Program or any work based on the Program. You are still required to
  comply with all other Section 6 requirements to provide Corresponding
  Source.

  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 Affero General Public License for more details.


--
Russell Stuart
2024-Feb-20