mirror of
https://github.com/octoleo/restic.git
synced 2024-11-16 01:57:10 +00:00
150 lines
3.9 KiB
Groff
150 lines
3.9 KiB
Groff
.nh
|
|
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
restic-ls - List files in a snapshot
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBrestic ls [flags] snapshotID [dir...]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The "ls" command lists files and directories in a snapshot.
|
|
|
|
.PP
|
|
The special snapshot ID "latest" can be used to list files and
|
|
directories of the latest snapshot in the repository. The
|
|
--host flag can be used in conjunction to select the latest
|
|
snapshot originating from a certain host only.
|
|
|
|
.PP
|
|
File listings can optionally be filtered by directories. Any
|
|
positional arguments after the snapshot ID are interpreted as
|
|
absolute directory paths, and only files inside those directories
|
|
will be listed. If the --recursive flag is used, then the filter
|
|
will allow traversing into matching directories' subfolders.
|
|
Any directory paths specified must be absolute (starting with
|
|
a path separator); paths use the forward slash '/' as separator.
|
|
|
|
|
|
.SH EXIT STATUS
|
|
.PP
|
|
Exit status is 0 if the command was successful, and non-zero if there was any error.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for ls
|
|
|
|
.PP
|
|
\fB-H\fP, \fB--host\fP=[]
|
|
only consider snapshots for this \fB\fChost\fR, when snapshot ID "latest" is given (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB-l\fP, \fB--long\fP[=false]
|
|
use a long listing format showing size and mode
|
|
|
|
.PP
|
|
\fB--path\fP=[]
|
|
only consider snapshots including this (absolute) \fB\fCpath\fR, when snapshot ID "latest" is given (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--recursive\fP[=false]
|
|
include files in subfolders of the listed directories
|
|
|
|
.PP
|
|
\fB--tag\fP=[]
|
|
only consider snapshots including \fB\fCtag[,tag,...]\fR, when snapshot ID "latest" is given (can be specified multiple times)
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.PP
|
|
\fB--cacert\fP=[]
|
|
\fB\fCfile\fR to load root certificates from (default: use system certificates)
|
|
|
|
.PP
|
|
\fB--cache-dir\fP=""
|
|
set the cache \fB\fCdirectory\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)
|
|
|
|
.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=""
|
|
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
|
|
|
|
.PP
|
|
\fB--limit-download\fP=0
|
|
limits downloads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--limit-upload\fP=0
|
|
limits uploads to a maximum \fB\fCrate\fR in KiB/s. (default: unlimited)
|
|
|
|
.PP
|
|
\fB--no-cache\fP[=false]
|
|
do not use a local cache
|
|
|
|
.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 (\fB\fCkey=value\fR, can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--pack-size\fP=0
|
|
set target pack \fB\fCsize\fR in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
|
|
|
|
.PP
|
|
\fB--password-command\fP=""
|
|
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC_PASSWORD_COMMAND)
|
|
|
|
.PP
|
|
\fB-p\fP, \fB--password-file\fP=""
|
|
\fB\fCfile\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=""
|
|
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
|
|
|
|
.PP
|
|
\fB--repository-file\fP=""
|
|
\fB\fCfile\fR to read the repository location from (default: $RESTIC_REPOSITORY_FILE)
|
|
|
|
.PP
|
|
\fB--tls-client-cert\fP=""
|
|
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
|
|
|
|
.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 SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|