BORG-RLIST(1)

📦
version 2.0.0b8 · 2 versions
, in ubuntu noble

💖 borg-rlist — bestie edition 💖

ok so this is borg-rlist, one of the many little gems inside the borg backup tool (that's the manual name, btw — we're in section 1, the big girl section 🎀). It does exactly one job and it does it beautifully: it lists the archives chillin' in a repository. That's it. That's the whole vibe. ✨

✨ SYNOPSIS ✨

borg [common options] rlist [options]

🌸 DESCRIPTION 🌸

This command lists the archives contained in a repository. Like, all of them. It's giving inventory energy. You point it at a repo, it tells you what's in there, periodt. 👑

💅 OPTIONS 💅

See borg-common(1) for common options of Borg commands — those are the shared ones that every borg command gets to borrow, iykyk.

🍓 options

  • --consider-checkpoints — show checkpoint archives in the repository contents list. Default is hidden, so if you're wondering where your checkpoints went… they're literally just being shy. 🙈
  • --short — only print the archive names, nothing else. No time, no id, no extra. Just names. Minimalist queen. ✨
  • --format FORMAT — specify format for archive listing. Default is: "{archive:<36} {time} [{id}]{NL}"
  • --json — format output as JSON. The form of --format is ignored, but keys used in it are added to the JSON output. Some keys are always present. Note: JSON can only represent text. (so like, no funky binary vibes in there, bestie 💀)

🦋 Archive filters

  • -a PATTERN, --match-archives PATTERN — only consider archive names matching the pattern. see borg help match-archives.
  • --sort-by KEYS — comma-separated list of sorting keys; valid keys are: timestamp, archive, name, id; default is: timestamp
  • --first N — consider first N archives after other filters were applied
  • --last N — consider last N archives after other filters were applied
  • --oldest TIMESPAN — consider archives between the oldest archive's timestamp and (oldest + TIMESPAN), e.g. 7d or 12m.
  • --newest TIMESPAN — consider archives between the newest archive's timestamp and (newest - TIMESPAN), e.g. 7d or 12m.
  • --older TIMESPAN — consider archives older than (now - TIMESPAN), e.g. 7d or 12m.
  • --newer TIMESPAN — consider archives newer than (now - TIMESPAN), e.g. 7d or 12m.

🌈 EXAMPLES 🌈

Look at her go:

$ borg rlist
Monday                               Mon, 2016-02-15 19:15:11
repo                                 Mon, 2016-02-15 19:26:54
root-2016-02-15                      Mon, 2016-02-15 19:36:29
newname                              Mon, 2016-02-15 19:50:19
...

🧚 NOTES 🧚

💜 The FORMAT specifier syntax

The --format option uses python's format string syntax. So if you already know python f-strings, you're basically home free, bestie. 🫶

Examples:

$ borg rlist --format '{archive}{NL}'
ArchiveFoo
ArchiveBar
...

# {VAR:NUMBER} - pad to NUMBER columns.
# Strings are left-aligned, numbers are right-aligned.
# Note: time columns except ``isomtime``, ``isoctime`` and ``isoatime`` cannot be padded.
$ borg rlist --format '{archive:36} {time} [{id}]{NL}' /path/to/repo
ArchiveFoo                           Thu, 2021-12-09 10:22:28 [0b8e9...3b274]
...

The following keys are always available:

  • NEWLINE: OS dependent line separator
  • NL: alias of NEWLINE
  • NUL: NUL character for creating print0 / xargs -0 like output
  • SPACE: space character
  • TAB: tab character
  • CR: carriage return character
  • LF: line feed character

Keys available only when listing archives in a repository:

  • archive: archive name
  • name: alias of "archive"
  • comment: archive comment
  • id: internal ID of the archive
  • start: time (start) of creation of the archive
  • time: alias of "start"
  • end: time (end) of creation of the archive
  • command_line: command line which was used to create the archive
  • hostname: hostname of host on which this archive was created
  • username: username of user who created this archive
  • size: size of this archive (data plus metadata, not considering compression and deduplication)
  • nfiles: count of files in this archive

👑 SEE ALSO 👑

🎀 AUTHOR 🎀

The Borg Collective

ok that's the whole page, you ate that 🍽️💅 borg-rlist, from the borg backup tool manual, dated 2024-04-01, section 1 — love u bestie, go list some archives 🦋✨💖
📦 where this page comes from