.\" Automatically generated by Pandoc 2.9.2.1
.\"
.TH "BORGMATIC" "1" "August, 2019" "backups manager for borgbackup manual" ""
.hy
.SH NAME
.PP
borgmatic - backups manager for borgbackup
.SH SYNOPSIS
.PP
borgmatic [\f[I]options\f[R]]
.SH DESCRIPTION
.PP
A simple wrapper script for the Borg backup software that creates and
prunes backups.
If none of the action options are given, then borgmatic defaults to:
prune, create, and check archives.
.SH OPTIONS
.SS optional arguments
.TP
-h, --help
Show this help message and exit
.SS global arguments
.TP
-c \f[I][CONFIG_PATHS [CONFIG_PATHS \&...]]\f[R], --config \f[I][CONFIG_PATHS [CONFIG_PATHS \&...]]\f[R]
Configuration filenames or directories, defaults to:
/etc/borgmatic/config.yaml /etc/borgmatic.d
/root/.config/borgmatic/config.yaml
.TP
--excludes \f[I]EXCLUDES_FILENAME\f[R]
Deprecated in favor of exclude_patterns within configuration
.TP
-n, --dry-run
Go through the motions, but do not actually write to any repositories
.TP
-nc, --no-color
Disable colored output
.TP
-v \f[I]{0,1,2}\f[R], --verbosity \f[I]{0,1,2}\f[R]
Display verbose progress to the console (from none to lots: 0, 1, or 2)
.TP
--syslog-verbosity \f[I]{0,1,2}\f[R]
Display verbose progress to syslog (from none to lots: 0, 1, or 2).
Ignored when console is interactive
.TP
--version
Display installed version number of borgmatic and exit
.SS actions
.PP
Specify zero or more actions.
Defaults to prune, create, and check.
Use \[en]help with action for details:
.TP
init (\f[I]--init, -I\f[R])
Initialize an empty Borg repository
.TP
prune (\f[I]--prune, -p\f[R])
Prune archives according to the retention policy
.TP
create (\f[I]--create, -C\f[R])
Create archives (actually perform backups)
.TP
check (\f[I]--check, -k\f[R])
Check archives for consistency
.TP
extract (\f[I]--extract, -x\f[R])
Extract a named archive to the current directory
.TP
list (\f[I]--list, -l\f[R])
List archives
.TP
info (\f[I]--info, -i\f[R])
Display summary information on archives
.SH SEE ALSO
.PP
The borgmatic source code and all documentation may be downloaded from
<https://github.com/witten/borgmatic>
.SH AUTHORS
Dan Helfman <witten@torsion.org>.