borg-common(1)

📦
version 1.4.5 · 7 versions
, in alpine 3.24, arch rolling, ubuntu stonking

💖 borg-common — Common options of Borg commands 💖

okay bestie, so this is borg-common(1), a page from the borg backup tool manual, and it's literally the shared ✨starter pack✨ of options — the ones every Borg command has in common. every Borg subcommand lowkey inherits this whole menu, so once you know these, you know like half the CLI. iykyk. 🫶

🌸 NAME 🌸

borg-common — nope, not a command you run, it's the Common options of Borg commands. the group-chat rules everybody follows. 💅

🎀 SYNOPSIS 🎀

no fancy usage line here bestie, it's just the option roster. every single one, in order:

  • -h, --help — pops up this help message and then dips (exit).
  • --critical — work on log level CRITICAL. only the actual emergencies make it through. 💀
  • --error — work on log level ERROR.
  • --warning — work on log level WARNING, and heads up: this one is the default. 👑
  • --info, -v, --verbose — work on log level INFO. yes, three spellings, same energy.
  • --debug — enable debug output and work on log level DEBUG. chaos mode, but make it informative. 🔥
  • --debug-topic TOPIC — enable debugging just for TOPIC. you can pass this multiple times if you're feeling extra (and you are). psst: the logger path is borg.debug.<TOPIC> unless TOPIC is already fully qualified.
  • -p, --progress — show progress information, so you can watch the little numbers go up instead of staring into the void. 👀
  • --iec — format using IEC units, where 1KiB = 1024B. the honest math, fr fr.
  • --log-json — output one JSON object per log line instead of formatted text. for the machine besties. 🤖
  • --lock-wait SECONDS — wait at most SECONDS to acquire a repository/cache lock (default: 1). patience is a virtue but it is finite, periodt.
  • --bypass-lock — Bypass locking mechanism. ⚠️ you're out here raw-dogging the locks, so be careful, bestie.
  • --show-version — show/log the borg version. flex the fit.
  • --show-rc — show/log the return code (rc). receipts, literally.
  • --umask M — set umask to M (local only, default: 0077).
  • --remote-path PATH — use PATH as the borg executable on the remote (default: "borg").
  • --remote-ratelimit RATE — deprecated, use --upload-ratelimit instead. it's giving retired. 🪦
  • --upload-ratelimit RATE — set network upload rate limit in kiByte/s (default: 0=unlimited). the glow-up replacement.
  • --remote-buffer UPLOAD_BUFFER — deprecated, use --upload-buffer instead. also retired, also iconic-in-its-day. 🪦
  • --upload-buffer UPLOAD_BUFFER — set network upload buffer size in MiB. (default: 0=no buffer). the other glow-up.
  • --consider-part-files — treat part files like normal files, e.g. to list/extract them. basically "no crumbs left behind" behavior. 🍓
  • --debug-profile FILE — Write execution profile in Borg format into FILE. For local use a Python-compatible file can be generated by suffixing FILE with ".pyprof". (that's FILE + ".pyprof", exactly like that. 🔍)
  • --rsh RSH — Use this command to connect to the 'borg serve' process (default: 'ssh').

🌈 SEE ALSO 🌈

  • borg-common(1) — yeah bestie, it points at itself. main character energy. 👑

💜 AUTHOR 💜

The Borg Collective. no singular author, it's a whole squad. 🫶

and that's the page, bestie!! this was borg-common(1) from the borg backup tool manual, dated 2026-07-18 — go forth and back things up responsibly, mwah 💖✨🎀🦋🌸💅

📦 where this page comes from