restic/doc/man/restic-stats.1

151 lines
3.9 KiB
Groff
Raw Normal View History

2020-11-05 08:41:35 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2018-08-06 19:28:59 +00:00
.nh
2020-11-05 08:41:35 +00:00
.ad l
2018-08-06 19:28:59 +00:00
.SH NAME
.PP
restic\-stats \- Scan the repository and show basic statistics
.SH SYNOPSIS
.PP
2020-09-19 15:38:26 +00:00
\fBrestic stats [flags] [snapshot ID] [...]\fP
2018-08-06 19:28:59 +00:00
.SH DESCRIPTION
.PP
2020-09-19 15:38:26 +00:00
The "stats" command walks one or multiple snapshots in a repository
and accumulates statistics about the data stored therein. It reports
on the number of unique files and their sizes, according to one of
2018-08-06 19:28:59 +00:00
the counting modes as given by the \-\-mode flag.
.PP
2020-09-19 15:38:26 +00:00
It operates on all snapshots matching the selection criteria or all
snapshots if nothing is specified. The special snapshot ID "latest"
is also supported. Some modes make more sense over
just a single snapshot, while others are useful across all snapshots,
depending on what you are trying to calculate.
2018-08-06 19:28:59 +00:00
.PP
The modes are:
2018-10-13 11:48:30 +00:00
.RS
.IP \(bu 2
2018-08-06 19:28:59 +00:00
restore\-size: (default) Counts the size of the restored files.
2018-10-13 11:48:30 +00:00
.IP \(bu 2
2018-08-06 19:28:59 +00:00
files\-by\-contents: Counts total size of files, where a file is
2018-10-13 11:48:30 +00:00
considered unique if it has unique contents.
.IP \(bu 2
raw\-data: Counts the size of blobs in the repository, regardless of
how many files reference them.
.IP \(bu 2
2018-08-06 19:28:59 +00:00
blobs\-per\-file: A combination of files\-by\-contents and raw\-data.
2019-04-23 11:19:39 +00:00
.RE
.PP
2018-08-06 19:28:59 +00:00
Refer to the online manual for more details about each mode.
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
2018-08-06 19:28:59 +00:00
.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2020-11-05 08:41:35 +00:00
help for stats
2018-08-06 19:28:59 +00:00
.PP
2020-09-19 15:38:26 +00:00
\fB\-H\fP, \fB\-\-host\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots with the given \fB\fChost\fR (can be specified multiple times)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-mode\fP="restore\-size"
2020-11-05 08:41:35 +00:00
counting mode: restore\-size (default), files\-by\-contents, blobs\-per\-file or raw\-data
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-path\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times)
2020-09-19 15:38:26 +00:00
.PP
\fB\-\-tag\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
2018-08-06 19:28:59 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
2020-11-05 08:41:35 +00:00
\fB\fCfile\fR to load root certificates from (default: use system certificates)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-cache\-dir\fP=""
2020-11-05 08:41:35 +00:00
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-cleanup\-cache\fP[=false]
2020-11-05 08:41:35 +00:00
auto remove old cache directories
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-json\fP[=false]
2020-11-05 08:41:35 +00:00
set output mode to JSON for commands that support it
2018-08-06 19:28:59 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2019-01-06 20:40:32 +00:00
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-limit\-download\fP=0
2020-11-05 08:41:35 +00:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-limit\-upload\fP=0
2020-11-05 08:41:35 +00:00
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
2020-11-05 08:41:35 +00:00
do not use a local cache
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
2020-11-05 08:41:35 +00:00
do not lock the repository, this allows some operations on read\-only repositories
2018-08-06 19:28:59 +00:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2020-11-05 08:41:35 +00:00
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2018-08-06 19:28:59 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
2020-11-05 08:41:35 +00:00
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
2019-01-06 20:40:32 +00:00
2018-08-06 19:28:59 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
2018-08-06 19:28:59 +00:00
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
2020-11-05 08:41:35 +00:00
do not output comprehensive progress report
2018-08-06 19:28:59 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2020-11-05 08:41:35 +00:00
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
.PP
\fB\-\-repository\-file\fP=""
\fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE)
2018-08-06 19:28:59 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2020-11-05 08:41:35 +00:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
2018-08-06 19:28:59 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
2020-11-05 08:41:35 +00:00
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
2018-08-06 19:28:59 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP