restic-check(1)

1restic backup(1)                                              restic backup(1)
2
3
4

NAME

6       restic-check - Check the repository for errors
7
8
9

SYNOPSIS

11       restic check [flags]
12
13
14

DESCRIPTION

16       The "check" command tests the repository for errors and reports any er‐
17       rors it finds. It can also be used to read all data and therefore simu‐
18       late a restore.
19
20
21       By default, the "check" command will always load all data directly from
22       the repository and not use a local cache.
23
24
25

EXIT STATUS

27       Exit status is 0 if the command was successful, and non-zero  if  there
28       was any error.
29
30
31

OPTIONS

33       -h, --help[=false]      help for check
34
35
36       --read-data[=false]      read all data blobs
37
38
39       --read-data-subset=""       read  a  subset of data packs, specified as
40       'n/t' for specific part, or either 'x%' or 'x.y%' or a  size  in  bytes
41       with suffixes k/K, m/M, g/G, t/T for a random subset
42
43
44       --with-cache[=false]       use  existing cache, only read uncached data
45       from repository
46
47
48

OPTIONS INHERITED FROM PARENT COMMANDS

50       --cacert=[]      file to load root certificates from (default: use sys‐
51       tem certificates or $RESTIC_CACERT)
52
53
54       --cache-dir=""       set  the cache directory. (default: use system de‐
55       fault cache directory)
56
57
58       --cleanup-cache[=false]      auto remove old cache directories
59
60
61       --compression=auto      compression mode (only available for repository
62       format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
63
64
65       --insecure-tls[=false]      skip TLS certificate verification when con‐
66       necting to the repository (insecure)
67
68
69       --json[=false]      set output mode to JSON for commands  that  support
70       it
71
72
73       --key-hint=""       key  ID  of  key  to try decrypting first (default:
74       $RESTIC_KEY_HINT)
75
76
77       --limit-download=0      limits downloads to a maximum  rate  in  KiB/s.
78       (default: unlimited)
79
80
81       --limit-upload=0       limits  uploads to a maximum rate in KiB/s. (de‐
82       fault: unlimited)
83
84
85       --no-cache[=false]      do not use a local cache
86
87
88       --no-lock[=false]      do not lock the repository, this allows some op‐
89       erations on read-only repositories
90
91
92       -o,  --option=[]       set extended option (key=value, can be specified
93       multiple times)
94
95
96       --pack-size=0      set target pack size in MiB, created pack files  may
97       be larger (default: $RESTIC_PACK_SIZE)
98
99
100       --password-command=""      shell command to obtain the repository pass‐
101       word from (default: $RESTIC_PASSWORD_COMMAND)
102
103
104       -p, --password-file=""      file to read the repository  password  from
105       (default: $RESTIC_PASSWORD_FILE)
106
107
108       -q, --quiet[=false]      do not output comprehensive progress report
109
110
111       -r,  --repo=""       repository  to backup to or restore from (default:
112       $RESTIC_REPOSITORY)
113
114
115       --repository-file=""      file to read  the  repository  location  from
116       (default: $RESTIC_REPOSITORY_FILE)
117
118
119       --retry-lock=0s       retry  to  lock  the  repository if it is already
120       locked, takes a value like 5m or 2h (default: no retries)
121
122
123       --tls-client-cert=""      path to a file  containing  PEM  encoded  TLS
124       client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
125
126
127       -v,  --verbose[=0]       be  verbose (specify multiple times or a level
128       using --verbose=n``, max level/times is 2)
129
130
131

NAME

SYNOPSIS

DESCRIPTION

EXIT STATUS

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO