restic/doc/man/restic-stats.1

.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" "" 
.nh
.ad l


.SH NAME
.PP
restic\-stats \- Scan the repository and show basic statistics


.SH SYNOPSIS
.PP
\fBrestic stats [flags] [snapshot\-ID]\fP


.SH DESCRIPTION
.PP
The "stats" command walks one or all 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
the counting modes as given by the \-\-mode flag.

.PP
If no snapshot is specified, all snapshots will be considered. 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.

.PP
The modes are:

.RS
.IP \(bu 2
restore\-size: (default) Counts the size of the restored files.
.IP \(bu 2
files\-by\-contents: Counts total size of files, where a file is
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
blobs\-per\-file: A combination of files\-by\-contents and raw\-data.

.RE

.PP
Refer to the online manual for more details about each mode.


.SH OPTIONS
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
    help for stats

.PP
\fB\-H\fP, \fB\-\-host\fP=""
    filter latest snapshot by this hostname

.PP
\fB\-\-mode\fP="restore\-size"
    counting mode: restore\-size (default), files\-by\-contents, blobs\-per\-file, or raw\-data


.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB\-\-cacert\fP=[]
    \fB\fCfile\fR to load root certificates from (default: use system certificates)

.PP
\fB\-\-cache\-dir\fP=""
    set the cache directory. (default: use system default cache directory)

.PP
\fB\-\-cleanup\-cache\fP[=false]
    auto remove old cache directories

.PP
\fB\-\-json\fP[=false]
    set output mode to JSON for commands that support it

.PP
\fB\-\-key\-hint\fP=""
    key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)

.PP
\fB\-\-limit\-download\fP=0
    limits downloads to a maximum rate in KiB/s. (default: unlimited)

.PP
\fB\-\-limit\-upload\fP=0
    limits uploads to a maximum rate in KiB/s. (default: unlimited)

.PP
\fB\-\-no\-cache\fP[=false]
    do not use a local cache

.PP
\fB\-\-no\-lock\fP[=false]
    do not lock the repo, this allows some operations on read\-only repos

.PP
\fB\-o\fP, \fB\-\-option\fP=[]
    set extended option (\fB\fCkey=value\fR, can be specified multiple times)

.PP
\fB\-\-password\-command\fP=""
    specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND)

.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
    read the repository password from a file (default: $RESTIC\_PASSWORD\_FILE)

.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
    do not output comprehensive progress report

.PP
\fB\-r\fP, \fB\-\-repo\fP=""
    repository to backup to or restore from (default: $RESTIC\_REPOSITORY)

.PP
\fB\-\-tls\-client\-cert\fP=""
    path to a file containing PEM encoded TLS client certificate and private key

.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
    be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR)


.SH SEE ALSO
.PP
\fBrestic(1)\fP