summaryrefslogtreecommitdiffstats
path: root/docs/man/borg-info.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man/borg-info.1')
-rw-r--r--docs/man/borg-info.182
1 files changed, 60 insertions, 22 deletions
diff --git a/docs/man/borg-info.1 b/docs/man/borg-info.1
index 338d3ca60..726fed826 100644
--- a/docs/man/borg-info.1
+++ b/docs/man/borg-info.1
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH BORG-INFO 1 "2017-06-18" "" "borg backup tool"
+.TH BORG-INFO 1 "2017-11-25" "" "borg backup tool"
.SH NAME
borg-info \- Show archive details such as disk space used
.
@@ -32,7 +32,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
..
.SH SYNOPSIS
.sp
-borg [common options] info <options> REPOSITORY_OR_ARCHIVE
+borg [common options] info [options] [REPOSITORY_OR_ARCHIVE]
.SH DESCRIPTION
.sp
This command displays detailed information about the specified archive or repository.
@@ -40,14 +40,16 @@ This command displays detailed information about the specified archive or reposi
Please note that the deduplicated sizes of the individual archives do not add
up to the deduplicated size of the repository ("all archives"), because the two
are meaning different things:
-.INDENT 0.0
-.TP
-.B This archive / deduplicated size = amount of data stored ONLY for this archive
+.sp
+This archive / deduplicated size = amount of data stored ONLY for this archive
= unique chunks of this archive.
-.TP
-.B All archives / deduplicated size = amount of data stored in the repo
+All archives / deduplicated size = amount of data stored in the repo
= all chunks in the repository.
-.UNINDENT
+.sp
+Borg archives can only contain a limited amount of file metadata.
+The size of an archive relative to this limit depends on a number of factors,
+mainly the number of files, the lengths of paths and other metadata stored for files.
+This is shown as \fIutilization of maximum supported archive size\fP\&.
.SH OPTIONS
.sp
See \fIborg\-common(1)\fP for common options of Borg commands.
@@ -63,16 +65,16 @@ archive or repository to display information about
.B \-\-json
format output as JSON
.UNINDENT
-.SS filters
+.SS Archive filters
.INDENT 0.0
.TP
-.B \-P\fP,\fB \-\-prefix
+.BI \-P \ PREFIX\fP,\fB \ \-\-prefix \ PREFIX
only consider archive names starting with this prefix.
.TP
-.B \-a\fP,\fB \-\-glob\-archives
+.BI \-a \ GLOB\fP,\fB \ \-\-glob\-archives \ GLOB
only consider archive names matching the glob. sh: rules apply, see "borg help patterns". \fB\-\-prefix\fP and \fB\-\-glob\-archives\fP are mutually exclusive.
.TP
-.B \-\-sort\-by
+.BI \-\-sort\-by \ KEYS
Comma\-separated list of sorting keys; valid keys are: timestamp, name, id; default is: timestamp
.TP
.BI \-\-first \ N
@@ -87,22 +89,58 @@ consider last N archives after other filters were applied
.sp
.nf
.ft C
-$ borg info /path/to/repo::root\-2016\-02\-15
-Name: root\-2016\-02\-15
-Fingerprint: 57c827621f21b000a8d363c1e163cc55983822b3afff3a96df595077a660be50
+$ borg info /path/to/repo::2017\-06\-29T11:00\-srv
+Archive name: 2017\-06\-29T11:00\-srv
+Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
+Comment:
Hostname: myhostname
Username: root
-Time (start): Mon, 2016\-02\-15 19:36:29
-Time (end): Mon, 2016\-02\-15 19:39:26
-Command line: /usr/local/bin/borg create \-\-list \-C zlib,6 /path/to/repo::root\-2016\-02\-15 / \-\-one\-file\-system
-Number of files: 38100
+Time (start): Thu, 2017\-06\-29 11:03:07
+Time (end): Thu, 2017\-06\-29 11:03:13
+Duration: 5.66 seconds
+Number of files: 17037
+Command line: /usr/sbin/borg create /path/to/repo::2017\-06\-29T11:00\-srv /srv
+Utilization of max. archive size: 0%
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+ Original size Compressed size Deduplicated size
+This archive: 12.53 GB 12.49 GB 1.62 kB
+All archives: 121.82 TB 112.41 TB 215.42 GB
+
+ Unique chunks Total chunks
+Chunk index: 1015213 626934122
+
+$ borg info /path/to/repo \-\-last 1
+Archive name: 2017\-06\-29T11:00\-srv
+Archive fingerprint: b2f1beac2bd553b34e06358afa45a3c1689320d39163890c5bbbd49125f00fe5
+Comment:
+Hostname: myhostname
+Username: root
+Time (start): Thu, 2017\-06\-29 11:03:07
+Time (end): Thu, 2017\-06\-29 11:03:13
+Duration: 5.66 seconds
+Number of files: 17037
+Command line: /usr/sbin/borg create /path/to/repo::2017\-06\-29T11:00\-srv /srv
+Utilization of max. archive size: 0%
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
+ Original size Compressed size Deduplicated size
+This archive: 12.53 GB 12.49 GB 1.62 kB
+All archives: 121.82 TB 112.41 TB 215.42 GB
+
+ Unique chunks Total chunks
+Chunk index: 1015213 626934122
+$ borg info /path/to/repo
+Repository ID: d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
+Location: /path/to/repo
+Encrypted: Yes (repokey)
+Cache: /root/.cache/borg/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
+Security dir: /root/.config/borg/security/d857ce5788c51272c61535062e89eac4e8ef5a884ffbe976e0af9d8765dedfa5
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
Original size Compressed size Deduplicated size
-This archive: 1.33 GB 613.25 MB 571.64 MB
-All archives: 1.63 GB 853.66 MB 584.12 MB
+All archives: 121.82 TB 112.41 TB 215.42 GB
Unique chunks Total chunks
-Chunk index: 36858 48844
+Chunk index: 1015213 626934122
.ft P
.fi
.UNINDENT