2
2
mirror of https://github.com/octoleo/restic.git synced 2024-11-14 01:04:05 +00:00
restic/doc/man/restic-ls.1

131 lines
3.2 KiB
Groff
Raw Normal View History

2017-09-26 11:16:08 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2017-08-05 09:42:37 +00:00
.nh
.ad l
.SH NAME
.PP
restic\-ls \- List files in a snapshot
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
2018-10-13 11:48:30 +00:00
\fBrestic ls [flags] [snapshotID] [dir...]\fP
2017-08-05 09:42:37 +00:00
.SH DESCRIPTION
.PP
2018-10-13 11:48:30 +00:00
The "ls" command lists files and directories in a snapshot.
2017-08-05 09:42:37 +00:00
.PP
2018-10-13 11:48:30 +00:00
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.
2017-08-05 09:42:37 +00:00
.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 no snapshot ID is given
.PP
\fB\-l\fP, \fB\-\-long\fP[=false]
use a long listing format showing size and mode
.PP
\fB\-\-path\fP=[]
only consider snapshots which include this (absolute) \fB\fCpath\fR, when no snapshot ID is given
2018-10-13 11:48:30 +00:00
.PP
\fB\-\-recursive\fP[=false]
include files in subfolders of the listed directories
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-tag\fP=[]
only consider snapshots which include this \fB\fCtaglist\fR, when no snapshot ID is given
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-cacert\fP=[]
2018-05-21 13:57:32 +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=""
2018-10-13 11:48:30 +00:00
set the cache directory. (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]
auto remove old cache directories
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-json\fP[=false]
set output mode to JSON for commands that support it
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-key\-hint\fP=""
key ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2017-11-26 18:46:16 +00:00
.PP
\fB\-\-limit\-download\fP=0
limits downloads to a maximum rate in KiB/s. (default: unlimited)
.PP
\fB\-\-limit\-upload\fP=0
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2017-09-24 21:13:04 +00:00
.PP
\fB\-\-no\-cache\fP[=false]
do not use a local cache
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-no\-lock\fP[=false]
do not lock the repo, this allows some operations on read\-only repos
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2019-01-06 20:40:32 +00:00
.PP
\fB\-\-password\-command\fP=""
specify a shell command to obtain a password (default: $RESTIC\_PASSWORD\_COMMAND)
2017-08-05 09:42:37 +00:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
read the repository password from a file (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=""
repository to backup to or restore from (default: $RESTIC\_REPOSITORY)
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
path to a file containing PEM encoded TLS client certificate and private key
2018-05-21 13:57:32 +00:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
be verbose (specify \-\-verbose multiple times or level \fB\fCn\fR)
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP