BORGMATIC(1)

💖 BORGMATIC(1) 💖

okay bestie, welcome to the borgmatic(1) manual page — yes, section 1, we're in the user commands, we're thriving, we're backing things up 💅

---

✨ NAME ✨

borgmatic — backups manager for borgbackup 🫶

---

✨ SYNOPSIS ✨

borgmatic [options]

---

✨ DESCRIPTION ✨

so basically, borgmatic is a simple wrapper script for the Borg backup software 🌸 it creates backups and it prunes backups, that's the whole vibe. lowkey iconic.

and here's the part where you pay attention, bestie: if none of the action options are given, then borgmatic defaults to: prune, create, and check archives. like, it just does all three on its own. main character energy, no notes. 👑

---

✨ OPTIONS ✨

optional arguments

• -h, --help — shows you this help message and then dips. exit stage left. 🎀

global arguments

• -c [CONFIG_PATHS [CONFIG_PATHS ...]], --config [CONFIG_PATHS [CONFIG_PATHS ...]] — configuration filenames or directories 🗂️ defaults to:

/etc/borgmatic/config.yaml /etc/borgmatic.d
/root/.config/borgmatic/config.yaml

like, it already knows where to look, she's self-sufficient fr fr.

• --excludes EXCLUDES_FILENAME — ⚠️ deprecated in favor of exclude_patterns within configuration. so like, still here, but it's giving "old money, no longer fashionable." use the config version, bestie 🙈
• -n, --dry-run — go through the motions, but do not actually write to any repositories 💀 it's a rehearsal, not the performance. nothing gets touched. zero. zip. nada.
• -nc, --no-color — disable colored output 😭 (if you must, if your terminal is being a hater)
• -v {0,1,2}, --verbosity {0,1,2} — display verbose progress to the console, from none to lots: 0, 1, or 2 ✨
• --syslog-verbosity {0,1,2} — display verbose progress to syslog, from none to lots: 0, 1, or 2 🌈 ignored when console is interactive — so like, if you're sitting there typing at it, this setting is just not invited to the party.
• --version — displays the installed version number of borgmatic and exits 👑 quick lil flex, then gone.

actions

specify zero or more actions. defaults to prune, create, and check. use –help with action for details:

• init (--init, -I) — initialize an empty Borg repository 🎀 baby's first repo.
• prune (--prune, -p) — prune archives according to the retention policy ✂️ cutting the old growth, it's giving self-care.
• create (--create, -C) — create archives (actually perform backups) 💖 the real one. the actual backup. no cap.
• check (--check, -k) — check archives for consistency 🔍 vibe check on your archives, essentially.
• extract (--extract, -x) — extract a named archive to the current directory 🦋
• list (--list, -l) — list archives 📋
• info (--info, -i) — display summary information on archives 🧚 the tea, basically.

---

✨ SEE ALSO ✨

the borgmatic source code and all documentation may be downloaded from https://github.com/witten/borgmatic — go, go read, she's an open book (literally) 💜

---

✨ AUTHORS ✨

Dan Helfman witten@torsion.org 🌟

---

okay that's the whole page, you ate that 🍓 and for the cute sign-off: this beauty is a backups manager for borgbackup, dated August, 2019, and it lives at the bottom of the page as BORGMATIC(1) like the queen she is. mwah 💅✨