2
2
mirror of https://github.com/octoleo/restic.git synced 2024-11-22 21:05:10 +00:00
restic/doc/man/restic-find.1

186 lines
4.1 KiB
Groff
Raw Normal View History

2017-08-05 09:42:37 +00:00
.nh
2023-10-24 18:02:55 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
2022-08-25 17:55:00 +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
2022-08-25 17:55:00 +00:00
\fB--blob\fP[=false]
pattern is a blob-ID
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-h\fP, \fB--help\fP[=false]
2021-08-03 09:45:36 +00:00
help for find
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-H\fP, \fB--host\fP=[]
2023-10-24 18:02:55 +00:00
only consider snapshots for this \fBhost\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2023-07-31 18:23:24 +00:00
.PP
\fB--human-readable\fP[=false]
print sizes in human readable format
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-i\fP, \fB--ignore-case\fP[=false]
2021-08-03 09:45:36 +00:00
ignore case for pattern
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-l\fP, \fB--long\fP[=false]
2021-08-03 09:45:36 +00:00
use a long listing format showing size and mode
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-N\fP, \fB--newest\fP=""
2021-08-03 09:45:36 +00:00
newest modification date/time
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-O\fP, \fB--oldest\fP=""
2021-08-03 09:45:36 +00:00
oldest modification date/time
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--pack\fP[=false]
pattern is a pack-ID
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--path\fP=[]
2023-10-24 18:02:55 +00:00
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--show-pack-id\fP[=false]
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
2022-08-25 17:55:00 +00:00
\fB-s\fP, \fB--snapshot\fP=[]
2023-10-24 18:02:55 +00:00
snapshot \fBid\fR to search in (can be given multiple times)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tag\fP=[]
2023-10-24 18:02:55 +00:00
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2018-10-13 11:48:30 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tree\fP[=false]
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
2022-08-25 17:55:00 +00:00
\fB--cacert\fP=[]
2023-10-24 18:02:55 +00:00
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cache-dir\fP=""
2023-10-24 18:02:55 +00:00
set the cache \fBdirectory\fR\&. (default: use system default cache directory)
2017-09-24 21:13:04 +00:00
2017-12-27 21:31:03 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--cleanup-cache\fP[=false]
2021-08-03 09:45:36 +00:00
auto remove old cache directories
2017-12-27 21:31:03 +00:00
2022-03-26 19:09:59 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--compression\fP=auto
2023-07-31 18:23:24 +00:00
compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
2022-03-26 19:09:59 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB--key-hint\fP=""
2023-10-24 18:02:55 +00:00
\fBkey\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
2022-08-25 17:55:00 +00:00
\fB--limit-download\fP=0
2023-10-24 18:02:55 +00:00
limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--limit-upload\fP=0
2023-10-24 18:02:55 +00:00
limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
2017-09-24 21:13:04 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--no-cache\fP[=false]
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-o\fP, \fB--option\fP=[]
2023-10-24 18:02:55 +00:00
set extended option (\fBkey=value\fR, can be specified multiple times)
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--pack-size\fP=0
2023-10-24 18:02:55 +00:00
set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
2022-08-25 17:55:00 +00:00
.PP
\fB--password-command\fP=""
2023-10-24 18:02:55 +00:00
shell \fBcommand\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
2022-08-25 17:55:00 +00:00
\fB-p\fP, \fB--password-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-q\fP, \fB--quiet\fP[=false]
2021-08-03 09:45:36 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-r\fP, \fB--repo\fP=""
2023-10-24 18:02:55 +00:00
\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
2020-11-05 08:41:35 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--repository-file\fP=""
2023-10-24 18:02:55 +00:00
\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
2017-08-05 09:42:37 +00:00
2023-07-31 18:23:24 +00:00
.PP
\fB--retry-lock\fP=0s
retry to lock the repository if it is already locked, takes a value like 5m or 2h (default: no retries)
2018-02-17 19:27:28 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB--tls-client-cert\fP=""
2023-10-24 18:02:55 +00:00
path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
2018-02-17 19:27:28 +00:00
2018-05-21 13:57:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB-v\fP, \fB--verbose\fP[=0]
2023-04-24 18:28:37 +00:00
be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)
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
2023-10-24 18:02:55 +00:00
.EX
2018-10-13 11:48:30 +00:00
restic find config.json
2022-08-25 17:55:00 +00:00
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
2018-10-13 11:48:30 +00:00
2020-09-19 15:38:26 +00:00
EXIT STATUS
===========
2022-08-25 17:55:00 +00:00
Exit status is 0 if the command was successful, and non-zero if there was any error.
2020-09-19 15:38:26 +00:00
2023-10-24 18:02:55 +00:00
.EE
2018-10-13 11:48:30 +00:00
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP