.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH BORGREPORT "1" "November 2024" "borgreport 0.3.0" "User Commands"
.SH NAME
borgreport \- manual page for borgreport 0.3.0
.SH SYNOPSIS
.B borgreport
[\fI\,OPTIONS\/\fR]
.SH DESCRIPTION
Summarize the status of multiple BorgBackup repositories in one report and export metrics
.SH OPTIONS
.HP
\fB\-\-env\-dir\fR <DIR>
.IP
Directory to look for *.env files containing BORG_* env vars for a repository. Each file name represents a repository name in the report.
.HP
\fB\-\-env\-inherit\fR <REPOSITORY>
.IP
Inherit BORG_* env vars for a single <REPOSITORY>. This allows to run `borgreport` after `borg` while reusing the environment.
.HP
\fB\-\-text\-to\fR <FILE>
.IP
Write the text report to <FILE> instead of stdout.
.HP
\fB\-\-html\-to\fR <FILE>
.IP
Write the HTML report to <FILE>.
.HP
\fB\-\-metrics\-to\fR <FILE>
.IP
Write metrics to <FILE>.
.HP
\fB\-\-mail\-to\fR <ADDR>
.IP
Send the report to <ADDR> using a 'sendmail' compatible mail transfer agent.
.HP
\fB\-\-mail\-from\fR <ADDR>
.IP
The mail sender <ADDR>. By default this is the current user@host
.HP
\fB\-\-no\-progress\fR
.IP
Suppress all status updates during processing. By default this is auto\-detected.
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Print help (see a summary with '\-h')
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Print version
.SS "Override repository options:"
.HP
\fB\-\-glob\-archives\fR <GLOB>
.IP
A list of space separated archive globs e.g. "etc\-* srv\-*" for archive names starting with etc\- or srv\-. (Default: "")
.HP
\fB\-\-check[=\fR<true|false>]
.IP
Enables the execution of `borg check`. (Default: false)
.HP
\fB\-\-check\-options\fR <OPTS>
.IP
A list of space separated raw borg options supplied to the `borg check` command
.HP
\fB\-\-borg\-binary\fR <FILE>
.IP
Path to a local 'borg' binary. (Default: borg)
.HP
\fB\-\-max\-age\-hours\fR <HOURS>
.IP
Threshold to warn, when the last backup is older than <HOURS>. (Default: 24)
.SH ENVIRONMENT
Environment variables are overwritten by the respective command line option.
.TP
BORGREPORT_ENV_DIR <DIR>
Directory to look for *.env files containing BORG_* env vars for a repository. Each file name represents a repository name in the report.
.TP
BORGREPORT_ENV_INHERIT <REPOSITORY>
Inherit BORG_* env vars for a single <REPOSITORY>. This allows to run `borgreport` after `borg` while reusing the environment.
.TP
BORGREPORT_MAIL_TO <ADDR>
Send the report to <ADDR> using a 'sendmail' compatible mail transfer agent.
.TP
BORGREPORT_MAIL_FROM <ADDR>
The mail sender <ADDR>. By default this is the current user@host
.TP
BORGREPORT_NO_PROGRESS <ADDR>
Suppress all status updates during processing. By default this is auto\-detected.
.TP
BORGREPORT_TEXT_TO <FILE>
Write the text report to <FILE> instead of stdout.
.TP
BORGREPORT_HTML_TO <FORMAT>
Write the HTML report to <FILE>.
.TP
BORGREPORT_METRICS_TO <FILE>
Write metrics to <FILE>.
.SS "Repository Environment:"
.TP
!
You probably want to configure the following variables at repository level. Setting them globally will alter the default behavior for all repositories.
.TP
BORGREPORT_GLOB_ARCHIVES <GLOB>
A list of space separated archive globs e.g. "etc\-* srv\-*" for archive names starting with etc\- or srv\-. (Default: "")
.TP
BORGREPORT_CHECK <true|false>
Enables the execution of `borg check`. (Default: false)
.TP
BORGREPORT_CHECK_OPTIONS <OPTS>
A list of space separated raw borg options supplied to the `borg check` command
.TP
BORGREPORT_BORG_BINARY <FILE>
Path to a local 'borg' binary. (Default: borg)
.TP
BORGREPORT_MAX_AGE_HOURS <HOURS>
Threshold to warn, when the last backup is older than <HOURS>. (Default: 24)
.SH AUTHOR
Written by Philipp Micheel <bbx0+borgreport@bitdevs.de>
.SH "REPORTING BUGS"
Report bugs to <https://github.com/bbx0/borgreport/issues>.
.SH COPYRIGHT
Copyright \(co 2024 Philipp Micheel
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
.br
This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.