restic/doc/man/restic-forget.1

168 lines
4.1 KiB
Groff
Raw Normal View History

2020-11-05 08:41:35 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by `restic generate`" ""
2017-08-05 09:42:37 +00:00
.nh
2020-11-05 08:41:35 +00:00
.ad l
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
restic\-forget \- Remove snapshots from the repository
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
\fBrestic forget [flags] [snapshot ID] [...]\fP
.SH DESCRIPTION
.PP
The "forget" command removes snapshots according to a policy. Please note that
this command really only deletes the snapshot object in the repository, which
is a reference to data stored there. In order to remove this (now unreferenced)
data after 'forget' was run successfully, see the 'prune' command.
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
Exit status is 0 if the command was successful, and non\-zero if there was any error.
2017-08-05 09:42:37 +00:00
.SH OPTIONS
.PP
\fB\-l\fP, \fB\-\-keep\-last\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR snapshots
2017-08-05 09:42:37 +00:00
.PP
\fB\-H\fP, \fB\-\-keep\-hourly\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR hourly snapshots
2017-08-05 09:42:37 +00:00
.PP
\fB\-d\fP, \fB\-\-keep\-daily\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR daily snapshots
2017-08-05 09:42:37 +00:00
.PP
\fB\-w\fP, \fB\-\-keep\-weekly\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR weekly snapshots
2017-08-05 09:42:37 +00:00
.PP
\fB\-m\fP, \fB\-\-keep\-monthly\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR monthly snapshots
2017-08-05 09:42:37 +00:00
.PP
\fB\-y\fP, \fB\-\-keep\-yearly\fP=0
2020-11-05 08:41:35 +00:00
keep the last \fB\fCn\fR yearly snapshots
2017-08-05 09:42:37 +00:00
2018-05-21 13:57:32 +00:00
.PP
\fB\-\-keep\-within\fP=
2020-11-05 08:41:35 +00:00
keep snapshots that are newer than \fB\fCduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-keep\-tag\fP=[]
2020-11-05 08:41:35 +00:00
keep snapshots with this \fB\fCtaglist\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
2020-09-19 15:38:26 +00:00
\fB\-\-host\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots with the given \fB\fChost\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-tag\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this \fB\fCtaglist\fR in the format \fB\fCtag[,tag,...]\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-path\fP=[]
2020-11-05 08:41:35 +00:00
only consider snapshots which include this (absolute) \fB\fCpath\fR (can be specified multiple times)
2017-08-05 09:42:37 +00:00
2017-09-22 23:35:58 +00:00
.PP
\fB\-c\fP, \fB\-\-compact\fP[=false]
2020-11-05 08:41:35 +00:00
use compact output format
2017-09-22 23:35:58 +00:00
.PP
\fB\-g\fP, \fB\-\-group\-by\fP="host,paths"
2020-11-05 08:41:35 +00:00
string for grouping snapshots by host,paths,tags
2017-08-05 09:42:37 +00:00
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
2020-11-05 08:41:35 +00:00
do not delete anything, just print what would be done
2017-08-05 09:42:37 +00:00
.PP
\fB\-\-prune\fP[=false]
2020-11-05 08:41:35 +00:00
automatically run the 'prune' command if snapshots have been removed
2017-08-05 09:42:37 +00:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2020-11-05 08:41:35 +00:00
help for forget
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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +00:00
do not lock the repository, this allows some operations on read\-only repositories
2017-08-05 09:42:37 +00:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2020-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +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-11-05 08:41:35 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2020-11-05 08:41:35 +00:00
\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)
2017-08-05 09:42:37 +00:00
2018-02-17 19:27:28 +00:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2020-11-05 08:41:35 +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-11-05 08:41:35 +00:00
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
2018-05-21 13:57:32 +00:00
2017-08-05 09:42:37 +00:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP