restic/doc/man/restic-find.1

167 lines
3.5 KiB
Groff
Raw Normal View History

2017-08-05 09:42:37 +00:00
.nh
2020-09-19 15:38:26 +00:00
.TH restic backup(1)Jan 2017
generated by \fB\fCrestic generate\fR
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
2018-10-13 11:48:30 +00:00
restic\-find \- Find a file, a directory or restic IDs
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
2018-10-13 11:48:30 +00:00
\fBrestic find [flags] PATTERN...\fP
2017-08-05 09:42:37 +00:00
.SH DESCRIPTION
.PP
The "find" command searches for files or directories in snapshots stored in the
repo.
2018-10-13 11:48:30 +00:00
It can also be used to search for restic blobs or trees for troubleshooting.
2017-08-05 09:42:37 +00:00
.SH OPTIONS
2018-10-13 11:48:30 +00:00
.PP
\fB\-\-blob\fP[=false]
2020-09-19 15:38:26 +00:00
pattern is a blob\-ID
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2020-09-19 15:38:26 +00:00
help for find
2017-08-05 09:42:37 +00:00
.PP
2020-09-19 15:38:26 +00:00
\fB\-H\fP, \fB\-\-host\fP=[]
only consider snapshots for this \fB\fChost\fR, when no snapshot ID is given (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB\-i\fP, \fB\-\-ignore\-case\fP[=false]
2020-09-19 15:38:26 +00:00
ignore case for pattern
2017-08-05 09:42:37 +00:00
.PP
\fB\-l\fP, \fB\-\-long\fP[=false]
2020-09-19 15:38:26 +00:00
use a long listing format showing size and mode
2017-08-05 09:42:37 +00:00
.PP
\fB\-N\fP, \fB\-\-newest\fP=""
2020-09-19 15:38:26 +00:00
newest modification date/time
2017-08-05 09:42:37 +00:00
.PP
\fB\-O\fP, \fB\-\-oldest\fP=""
2020-09-19 15:38:26 +00:00
oldest modification date/time
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
\fB\-\-pack\fP[=false]
2020-09-19 15:38:26 +00:00
pattern is a pack\-ID
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-path\fP=[]
2020-09-19 15:38:26 +00:00
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot\-ID is given
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
\fB\-\-show\-pack\-id\fP[=false]
2020-09-19 15:38:26 +00:00
display the pack\-ID the blobs belong to (with \-\-blob or \-\-tree)
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-s\fP, \fB\-\-snapshot\fP=[]
2020-09-19 15:38:26 +00:00
snapshot \fB\fCid\fR to search in (can be given multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-tag\fP=[]
2020-09-19 15:38:26 +00:00
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot\-ID is given
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
\fB\-\-tree\fP[=false]
2020-09-19 15:38:26 +00:00
pattern is a tree\-ID
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-cacert\fP=[]
2020-09-19 15:38:26 +00:00
\fB\fCfile\fR to load root certificates from (default: use system certificates)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-cache\-dir\fP=""
2020-09-19 15:38:26 +00:00
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
2017-09-24 21:13:04 +00:00
2017-12-27 21:31:03 +00:00
.PP
\fB\-\-cleanup\-cache\fP[=false]
2020-09-19 15:38:26 +00:00
auto remove old cache directories
2017-12-27 21:31:03 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-json\fP[=false]
2020-09-19 15:38:26 +00:00
set output mode to JSON for commands that support it
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
2020-09-19 15:38:26 +00:00
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2019-01-06 20:40:32 +00:00
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-limit\-download\fP=0
2020-09-19 15:38:26 +00:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-limit\-upload\fP=0
2020-09-19 15:38:26 +00:00
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
2020-09-19 15:38:26 +00:00
do not use a local cache
2017-09-24 21:13:04 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
2020-09-19 15:38:26 +00:00
do not lock the repo, this allows some operations on read\-only repos
2017-08-05 09:42:37 +00:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2020-09-19 15:38:26 +00:00
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
2020-09-19 15:38:26 +00:00
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
2019-01-06 20:40:32 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
2020-09-19 15:38:26 +00:00
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
2017-08-05 09:42:37 +00:00
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
2020-09-19 15:38:26 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2020-09-19 15:38:26 +00:00
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
2017-08-05 09:42:37 +00:00
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2020-09-19 15:38:26 +00:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
2018-02-17 19:27:28 +00:00
2018-05-21 13:57:32 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
2020-09-19 15:38:26 +00:00
be verbose (specify \-\-verbose multiple times or level \-\-verbose=\fB\fCn\fR)
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.SH EXAMPLE
.PP
.RS
.nf
restic find config.json
restic find \-\-json "*.yml" "*.json"
restic find \-\-json \-\-blob 420f620f b46ebe8a ddd38656
restic find \-\-show\-pack\-id \-\-blob 420f620f
restic find \-\-tree 577c2bc9 f81f2e22 a62827a9
restic find \-\-pack 025c1d06
2020-09-19 15:38:26 +00:00
EXIT STATUS
===========
Exit status is 0 if the command was successful, and non\-zero if there was any error.
2018-10-13 11:48:30 +00:00
.fi
.RE
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP