check-bkp-status: New program writes reports about backups.

[rsync-backup] / check-bkp-status.8

diff --git a/check-bkp-status.8 b/check-bkp-status.8
new file mode 100644 (file)
index 0000000..c76ed9c
--- /dev/null
+++ b/check-bkp-status.8
@@ -0,0 +1,60 @@
+.ie t .ds o \(bu
+.el .ds o o
+.de hP
+.IP
+\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c
+..
+.TH check-bkp-status 8 "16 January 2014" rsync-backup
+.SH NAME
+check-bkp-status \- write backup report
+.SH SYNOPSIS
+.B check-bkp-status
+.RB [ \-v ]
+.RB [ \-c
+.IR config-file ]
+.RB [ \-f
+.IR format ]
+.SH DESCRIPTION
+The
+.B check-bkp-status
+script writes to its standard output a report about the current backup
+status by checking the index database and logfiles written by
+.BR rsync-backup (8).
+.PP
+The following command-line options are recognized.
+.TP
+.B \-h
+Show a brief help message for the program, and exit successfully.
+.TP
+.B \-V
+Show
+.BR check-bkp-status 's
+version number and some choice pieces of build-time configuration, and
+exit successfully.
+.TP
+.BI "\-c " conf
+Read
+.I conf
+instead of the default configuration file (shown as
+.B conf
+in the
+.B \-V
+output).
+.TP
+.BI "\-f " format
+Write output in
+.IR format ,
+which may be
+.B txt
+for plain text output, suitable for email, or
+.B html
+for HTML output, suitable for use as a web page.
+.TP
+.B \-v
+Write information for all backups, rather than just those which failed.
+By default, if all backups are up-to-date, then no output is produced at
+all.
+.SH SEE ALSO
+.BR rsync-backup (8).
+.SH AUTHOR
+Mark Wooding, <mdw@distorted.org.uk>