Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
restic backup(1)					      restic backup(1)

NAME
       restic-stats - Scan the repository and show basic statistics

SYNOPSIS
       restic stats [flags] [snapshot ID] [...]

DESCRIPTION
       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 the	count-
       ing modes as given by the --mode	flag.

       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.

       The modes are:

        restore-size: (default) Counts	the size of the	restored files.

        files-by-contents: Counts total size of unique	files, where a file is
	 considered unique if it has unique contents.

        raw-data: Counts the size of blobs in the repository,	regardless  of
	 how many files	reference them.

        blobs-per-file: A combination of files-by-contents and	raw-data.

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

EXIT STATUS
       Exit  status  is	 0 if the command was successful.  Exit	status is 1 if
       there was any error.  Exit status is 10 if the repository does not  ex-
       ist.  Exit status is 11 if the repository is already locked.  Exit sta-
       tus is 12 if the	password is incorrect.

OPTIONS
       -h, --help[=false]      help for	stats

       -H, --host=[]	  only consider	snapshots for this host	(can be	speci-
       fied multiple times, use	empty string to	unset default value) (default:
       $RESTIC_HOST)

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

       --path=[]      only consider snapshots including	this  (absolute)  path
       (can  be	specified multiple times, snapshots must include all specified
       paths)

       --tag=[]	     only consider snapshots including tag[,tag,...]  (can  be
       specified multiple times)

OPTIONS	INHERITED FROM PARENT COMMANDS
       --cacert=[]	file to	load root certificates from (default: use sys-
       tem certificates	or $RESTIC_CACERT)

       --cache-dir=""	    set	 the cache directory. (default:	use system de-
       fault cache directory)

       --cleanup-cache[=false]	    auto remove	old cache directories

       --compression=auto      compression mode	(only available	for repository
       format  version	2),  one  of  (auto|off|fastest|better|max)  (default:
       $RESTIC_COMPRESSION)

       --http-user-agent=""	  set  a http user agent for outgoing http re-
       quests

       --insecure-no-password[=false]	    use	 an  empty  password  for  the
       repository, must	be passed to every restic command (insecure)

       --insecure-tls[=false]	   skip	TLS certificate	verification when con-
       necting to the repository (insecure)

       --json[=false]	    set	 output	mode to	JSON for commands that support
       it

       --key-hint=""	  key ID of key	 to  try  decrypting  first  (default:
       $RESTIC_KEY_HINT)

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

       --limit-upload=0	     limits uploads to a maximum rate in  KiB/s.  (de-
       fault: unlimited)

       --no-cache[=false]      do not use a local cache

       --no-extra-verify[=false]      skip additional verification of data be-
       fore upload (see	documentation)

       --no-lock[=false]      do not lock the repository, this allows some op-
       erations	on read-only repositories

       -o,  --option=[]	      set extended option (key=value, can be specified
       multiple	times)

       --pack-size=0	  set target pack size in MiB, created pack files  may
       be larger (default: $RESTIC_PACK_SIZE)

       --password-command=""	  shell	command	to obtain the repository pass-
       word from (default: $RESTIC_PASSWORD_COMMAND)

       -p,  --password-file=""	     file to read the repository password from
       (default: $RESTIC_PASSWORD_FILE)

       -q, --quiet[=false]	do not output comprehensive progress report

       -r, --repo=""	  repository to	backup to or  restore  from  (default:
       $RESTIC_REPOSITORY)

       --repository-file=""	  file	to  read  the repository location from
       (default: $RESTIC_REPOSITORY_FILE)

       --retry-lock=0s	    retry to lock the  repository  if  it  is  already
       locked, takes a value like 5m or	2h (default: no	retries)

       --stuck-request-timeout=5m0s	  duration  after which	to retry stuck
       requests

       --tls-client-cert=""	 path to a file	 containing  PEM  encoded  TLS
       client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)

       -v,  --verbose[=0]	be  verbose (specify multiple times or a level
       using --verbose=n``, max	level/times is 2)

SEE ALSO
       restic(1)

generated by restic generate	   Jan 2017		      restic backup(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=restic-stats&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help