BORG-CONFIG(1)

💖 borg-config — the manual page, but make it make sense 💖

okay so bestie, welcome to borg-config, page 1 of the borg backup tool man pages. this is the little command that lets you get, set, and delete values in a repository or cache config file. it's giving lab notebook energy but for your repo's ✨settings✨. let's get into it 🫶

---

✨ SYNOPSIS ✨

borg [common options] config [options] [NAME] [VALUE]

that's it. that's the whole shape of it. borg, then your common options, then config, then its own options, then optionally a NAME and a VALUE. slay.

---

🎀 DESCRIPTION 🎀

so what does this thing actually do? it gets and sets options in a local repository or cache config file. that's the whole job.

⚠️ for security reasons, this command only works on local repositories. fr fr. no remote shenanigans here, bestie. it's a local-only kinda party.

okay so the moves:

• wanna delete a config value entirely? that's --delete, babe. poof, gone, no notes.
• wanna list the values of the configuration file or the default values? use --list. we love a good inventory moment.
• wanna get an existing key? just pass the key name and nothing else. easy.
• wanna set a key? pass both the key name and the new value. that's the combo.

now, keys 💅 — you can write them as "section.name", or you can be lazy (affectionate) and just write "name". if you drop the section, it defaults to "repository" for the repo config and "cache" for the cache config. the command knows what you meant. iykyk.

and by default? borg config is messing with the repository config file. if you want it to touch the repository cache's config file instead, you reach for --cache. that's the switch. 🌈

---

👑 OPTIONS 👑

see borg-common(1) for common options of Borg commands — those are the shared ones, this page is about the config-specific ones.

arguments 🦋

• NAME — name of config key. that's the key you're getting, setting, or deleting.
• VALUE — new value for key. only needed when you're actually setting something.

optional arguments 💅

• -c, --cache — get and set values from the repo cache. (instead of the repo config, which is the default vibe)
• -d, --delete — delete the key from the config file. bye bestie 👋
• -l, --list — list the configuration of the repo. show me everything, i want the whole picture ✨

---

🌸 EXAMPLES 🌸

NOTE: the repository & cache config files are some of the only directly manipulable parts of a repository that aren't versioned or backed up, so be careful when making changes!

like, genuinely be careful. nothing's backing these up for you. no safety net, no undo button, no vibes-based recovery. 😭

find cache directory — let's go locate that cache dir:

$ cd ~/.cache/borg/$(borg config id)

look at that command substitution doing its little thing. iconic. 💖

reserve some space — setting a value, nice and simple:

$ borg config additional_free_space 2G

boom. reserved. 2G of space held back like a bouncer at the club. 🎀

make a repo append-only — flip that key to on:

$ borg config append_only 1

now your repo is in append-only mode, main character energy: it adds, it doesn't take away. periodt.

---

🧚 SEE ALSO 🧚

• borg-common(1)

that's the one. go read it for the common options, bestie. 🫶

---

💜 AUTHOR 💜

The Borg Collective

they wrote it, i just made it cute. ✨

---

and that's a wrap, babe! this was BORG-CONFIG(1) from the borg backup tool, dated 2024-07-19, and it ends exactly where this little sign-off is — BORG-CONFIG(1) with the version tucked in right on that footer line. go forth and configure responsibly, no cap. 💅🦋🌸