Commit: 337d348bfaebdae8b366163837b05c91a93ecc07 - rsnappush (hg)

rsync wrapper for pushing incremental backups

Commit MetaInfo

• Revision: 337d348bfaebdae8b366163837b05c91a93ecc07 (tree)
• Zeit: 2019-11-13 16:50:55
• Autor: Frank Tobin <ftobin@neve...>
• Commiter: Frank Tobin

Log Message

add README.md

Ändern Zusammenfassung

• add: README.md

Diff

diff -r 8da194cd0eae -r 337d348bfaeb README.md
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Wed Nov 13 02:50:55 2019 -0500
@@ -0,0 +1,52 @@
+rsnappush(1) - rsync-based pushed incremental snapshot
+============================
+
+## SYNOPSIS
+
+**rsnappush** [**-h**] [**-r RSYNC_OPT**] [**-q**] *SOURCE_PATH* [*ACCOUNT:*]*DEST_PATH*
+
+## DESCRIPTION
+
+**rsnappush** is a wrapper around rsync(1) to assist in file-level
+incremental snapshots that are pushed to a destination.
+Unchanged files are hard-linked.  Files are plainly laid
+out in a directory for each snapshot: *DEST_PATH*/*backup-YYYYmmdd-HHMM*/
+for easy access and restoration.
+
+*SOURCE_PATH* is any local path.
+
+*DEST_PATH* is a path, local or remote.  If remote, *ACCOUNT* specifies
+an ssh(1)-compatible account description, such as *USER*@*HOST*.
+
+Additionally, under *DEST_PATH* there is a *permissions*/ directory
+created that has compressed output from getfacl(1).  setfacl(1) can be used
+to restore permissions from this file once it is uncompressed.
+
+## EXAMPLE
+
+    rsnappush --rsync-opt=--partial-dir=/home/user2/rsync-partial \
+              /home/user user2@remotehost:backups/
+
+
+## OPTIONS
+
+**-h**, **--help**
+: display a help message
+
+**-r**, **--rsync-opt=RSYNC_OPT**
+: pass-thru options to rsync(1). Use the '=' syntax to pass through options,
+and include prefixing dashes.  See [EXAMPLE][] for details.
+
+**-q**, **--quiet**
+: emit less output
+
+
+## AUTHORS
+rsnappush is written by Frank Tobin: <[e-mail]>, <https://www.neverending.org/>
+
+rsnappush is released under the Eclipse Public License 2.0 <https://opensource.org/licenses/EPL-2.0>.
+
+## SEE ALSO
+
+rsync(1), ssh(1)
+