2
2
mirror of https://github.com/octoleo/restic.git synced 2024-12-27 12:42:49 +00:00
restic/doc/man/restic-find.1
2024-02-04 19:50:51 +01:00

190 lines
4.2 KiB
Groff

.nh
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
.SH NAME
.PP
restic-find - Find a file, a directory or restic IDs
.SH SYNOPSIS
.PP
\fBrestic find [flags] PATTERN...\fP
.SH DESCRIPTION
.PP
The "find" command searches for files or directories in snapshots stored in the
repo.
It can also be used to search for restic blobs or trees for troubleshooting.
.SH OPTIONS
.PP
\fB--blob\fP[=false]
pattern is a blob-ID
.PP
\fB-h\fP, \fB--help\fP[=false]
help for find
.PP
\fB-H\fP, \fB--host\fP=[]
only consider snapshots for this \fBhost\fR (can be specified multiple times)
.PP
\fB--human-readable\fP[=false]
print sizes in human readable format
.PP
\fB-i\fP, \fB--ignore-case\fP[=false]
ignore case for pattern
.PP
\fB-l\fP, \fB--long\fP[=false]
use a long listing format showing size and mode
.PP
\fB-N\fP, \fB--newest\fP=""
newest modification date/time
.PP
\fB-O\fP, \fB--oldest\fP=""
oldest modification date/time
.PP
\fB--pack\fP[=false]
pattern is a pack-ID
.PP
\fB--path\fP=[]
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times)
.PP
\fB--show-pack-id\fP[=false]
display the pack-ID the blobs belong to (with --blob or --tree)
.PP
\fB-s\fP, \fB--snapshot\fP=[]
snapshot \fBid\fR to search in (can be given multiple times)
.PP
\fB--tag\fP=[]
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
.PP
\fB--tree\fP[=false]
pattern is a tree-ID
.SH OPTIONS INHERITED FROM PARENT COMMANDS
.PP
\fB--cacert\fP=[]
\fBfile\fR to load root certificates from (default: use system certificates or $RESTIC_CACERT)
.PP
\fB--cache-dir\fP=""
set the cache \fBdirectory\fR\&. (default: use system default cache directory)
.PP
\fB--cleanup-cache\fP[=false]
auto remove old cache directories
.PP
\fB--compression\fP=auto
compression mode (only available for repository format version 2), one of (auto|off|max) (default: $RESTIC_COMPRESSION)
.PP
\fB--insecure-tls\fP[=false]
skip TLS certificate verification when connecting to the repository (insecure)
.PP
\fB--json\fP[=false]
set output mode to JSON for commands that support it
.PP
\fB--key-hint\fP=""
\fBkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
.PP
\fB--limit-download\fP=0
limits downloads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
.PP
\fB--limit-upload\fP=0
limits uploads to a maximum \fBrate\fR in KiB/s. (default: unlimited)
.PP
\fB--no-cache\fP[=false]
do not use a local cache
.PP
\fB--no-extra-verify\fP[=false]
skip additional verification of data before upload (see documentation)
.PP
\fB--no-lock\fP[=false]
do not lock the repository, this allows some operations on read-only repositories
.PP
\fB-o\fP, \fB--option\fP=[]
set extended option (\fBkey=value\fR, can be specified multiple times)
.PP
\fB--pack-size\fP=0
set target pack \fBsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB--password-command\fP=""
shell \fBcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
.PP
\fB-p\fP, \fB--password-file\fP=""
\fBfile\fR to read the repository password from (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=""
\fBrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
.PP
\fB--repository-file\fP=""
\fBfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
.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)
.PP
\fB--tls-client-cert\fP=""
path to a \fBfile\fR containing PEM encoded TLS client certificate and private key (default: $RESTIC_TLS_CLIENT_CERT)
.PP
\fB-v\fP, \fB--verbose\fP[=0]
be verbose (specify multiple times or a level using --verbose=n``, max level/times is 2)
.SH EXAMPLE
.EX
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
EXIT STATUS
===========
Exit status is 0 if the command was successful, and non-zero if there was any error.
.EE
.SH SEE ALSO
.PP
\fBrestic(1)\fP