| 1 | .ie t .ds o \(bu |
| 2 | .el .ds o o |
| 3 | .de hP |
| 4 | .IP |
| 5 | \h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c |
| 6 | .. |
| 7 | .TH check-bkp-status 8 "16 January 2014" rsync-backup |
| 8 | .SH NAME |
| 9 | check-bkp-status \- write backup report |
| 10 | .SH SYNOPSIS |
| 11 | .B check-bkp-status |
| 12 | .RB [ \-v ] |
| 13 | .RB [ \-c |
| 14 | .IR config-file ] |
| 15 | .RB [ \-f |
| 16 | .IR format ] |
| 17 | .SH DESCRIPTION |
| 18 | The |
| 19 | .B check-bkp-status |
| 20 | script writes to its standard output a report about the current backup |
| 21 | status by checking the index database and logfiles written by |
| 22 | .BR rsync-backup (8). |
| 23 | .PP |
| 24 | The following command-line options are recognized. |
| 25 | .TP |
| 26 | .B \-h |
| 27 | Show a brief help message for the program, and exit successfully. |
| 28 | .TP |
| 29 | .B \-V |
| 30 | Show |
| 31 | .BR check-bkp-status 's |
| 32 | version number and some choice pieces of build-time configuration, and |
| 33 | exit successfully. |
| 34 | .TP |
| 35 | .BI "\-c " conf |
| 36 | Read |
| 37 | .I conf |
| 38 | instead of the default configuration file (shown as |
| 39 | .B conf |
| 40 | in the |
| 41 | .B \-V |
| 42 | output). |
| 43 | .TP |
| 44 | .BI "\-f " format |
| 45 | Write output in |
| 46 | .IR format , |
| 47 | which may be |
| 48 | .B txt |
| 49 | for plain text output, suitable for email, or |
| 50 | .B html |
| 51 | for HTML output, suitable for use as a web page. |
| 52 | .TP |
| 53 | .B \-v |
| 54 | Write information for all backups, rather than just those which failed. |
| 55 | By default, if all backups are up-to-date, then no output is produced at |
| 56 | all. |
| 57 | .SH SEE ALSO |
| 58 | .BR rsync-backup (8). |
| 59 | .SH AUTHOR |
| 60 | Mark Wooding, <mdw@distorted.org.uk> |