borgbackup/docs/man/borg-info.1

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

119 lines
3.2 KiB
Groff
Raw Normal View History

2026-03-15 09:34:31 -04:00
.\" Man page generated from reStructuredText
.\" by the Docutils 0.22.4 manpage writer.
2017-02-05 08:22:06 -05:00
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
2026-06-16 08:17:43 -04:00
.TH "borg-info" "1" "2026-06-16" "" "borg backup tool"
2026-03-15 09:34:31 -04:00
.SH Name
2022-06-23 19:19:19 -04:00
borg-info \- Show archive details such as disk space used
2017-02-05 08:22:06 -05:00
.SH SYNOPSIS
.sp
2024-09-26 01:57:01 -04:00
borg [common options] info [options] [NAME]
2017-02-05 08:22:06 -05:00
.SH DESCRIPTION
.sp
2022-06-23 19:19:19 -04:00
This command displays detailed information about the specified archive.
2017-02-05 08:22:06 -05:00
.sp
Please note that the deduplicated sizes of the individual archives do not add
2022-09-10 10:03:27 -04:00
up to the deduplicated size of the repository (\(dqall archives\(dq), because the two
2025-12-23 12:00:09 -05:00
mean different things:
.sp
This archive / deduplicated size = amount of data stored ONLY for this archive
2017-02-05 08:22:06 -05:00
= unique chunks of this archive.
2025-12-23 12:00:09 -05:00
All archives / deduplicated size = amount of data stored in the repository
2017-02-05 08:22:06 -05:00
= all chunks in the repository.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
2024-09-26 01:57:01 -04:00
.SS arguments
.INDENT 0.0
.TP
.B NAME
specify the archive name
.UNINDENT
2025-04-21 15:07:46 -04:00
.SS options
2017-03-26 19:58:19 -04:00
.INDENT 0.0
.TP
2022-06-23 19:19:19 -04:00
.B \-\-json
2017-03-26 19:58:19 -04:00
format output as JSON
.UNINDENT
.SS Archive filters
2017-02-05 08:22:06 -05:00
.INDENT 0.0
.TP
2022-10-02 09:51:17 -04:00
.BI \-a \ PATTERN\fR,\fB \ \-\-match\-archives \ PATTERN
2025-12-23 12:00:09 -05:00
only consider archives matching all patterns. See \(dqborg help match\-archives\(dq.
2017-02-05 08:22:06 -05:00
.TP
.BI \-\-sort\-by \ KEYS
2024-10-03 06:23:03 -04:00
Comma\-separated list of sorting keys; valid keys are: timestamp, archive, name, id, tags, host, user; default is: timestamp
2017-02-05 08:22:06 -05:00
.TP
.BI \-\-first \ N
2025-12-23 12:00:09 -05:00
consider the first N archives after other filters are applied
2017-02-05 08:22:06 -05:00
.TP
.BI \-\-last \ N
2025-12-23 12:00:09 -05:00
consider the last N archives after other filters are applied
2023-02-26 15:30:54 -05:00
.TP
.BI \-\-oldest \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives between the oldest archive\(aqs timestamp and (oldest + TIMESPAN), e.g., 7d or 12m.
2023-02-26 15:30:54 -05:00
.TP
.BI \-\-newest \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives between the newest archive\(aqs timestamp and (newest \- TIMESPAN), e.g., 7d or 12m.
2023-02-26 15:30:54 -05:00
.TP
.BI \-\-older \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives older than (now \- TIMESPAN), e.g., 7d or 12m.
2023-02-26 15:30:54 -05:00
.TP
.BI \-\-newer \ TIMESPAN
2025-12-23 12:00:09 -05:00
consider archives newer than (now \- TIMESPAN), e.g., 7d or 12m.
2017-02-05 08:22:06 -05:00
.UNINDENT
.SH EXAMPLES
.INDENT 0.0
.INDENT 3.5
.sp
2025-04-21 15:07:46 -04:00
.EX
2024-09-26 01:57:01 -04:00
$ borg info aid:f7dea078
Archive name: source\-backup
2022-06-23 19:19:19 -04:00
Archive fingerprint: f7dea0788dfc026cc2be1c0f5b94beb4e4084eb3402fc40c38d8719b1bf2d943
Comment:
2022-06-23 19:19:19 -04:00
Hostname: mba2020
Username: tw
Time (start): Sat, 2022\-06\-25 20:51:40
Time (end): Sat, 2022\-06\-25 20:51:40
Duration: 0.03 seconds
2024-09-26 01:57:01 -04:00
Command line: /usr/bin/borg \-r path/to/repo create source\-backup src
2022-06-23 19:19:19 -04:00
Utilization of maximum supported archive size: 0%
Number of files: 244
Original size: 13.80 MB
Deduplicated size: 531 B
2025-04-21 15:07:46 -04:00
.EE
2017-02-05 08:22:06 -05:00
.UNINDENT
.UNINDENT
.SH SEE ALSO
.sp
2024-09-08 11:52:10 -04:00
\fIborg\-common(1)\fP, \fIborg\-list(1)\fP, \fIborg\-diff(1)\fP, \fIborg\-repo\-info(1)\fP
2026-03-15 09:34:31 -04:00
.SH Author
2017-02-05 08:22:06 -05:00
The Borg Collective
2026-03-15 09:34:31 -04:00
.\" End of generated man page.