forked from TrueCloudLab/restic
251 lines
6.8 KiB
Groff
251 lines
6.8 KiB
Groff
.nh
|
|
.TH "restic backup" "1" "Jan 2017" "generated by \fBrestic generate\fR" ""
|
|
|
|
.SH NAME
|
|
.PP
|
|
restic-forget - Remove snapshots from the repository
|
|
|
|
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\fBrestic forget [flags] [snapshot ID] [...]\fP
|
|
|
|
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The "forget" command removes snapshots according to a policy. All snapshots are
|
|
first divided into groups according to "--group-by", and after that the policy
|
|
specified by the "--keep-\fI" options is applied to each group individually.
|
|
If there are not enough snapshots to keep one for each duration related
|
|
"--keep-{within-,}\fP" option, the oldest snapshot in the group is kept
|
|
additionally.
|
|
|
|
.PP
|
|
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 the
|
|
unreferenced data after "forget" was run successfully, see the "prune" command.
|
|
|
|
.PP
|
|
Please also read the documentation for "forget" to learn about some important
|
|
security considerations.
|
|
|
|
|
|
.SH EXIT STATUS
|
|
.PP
|
|
Exit status is 0 if the command was successful.
|
|
Exit status is 1 if there was any error.
|
|
Exit status is 10 if the repository does not exist.
|
|
Exit status is 11 if the repository is already locked.
|
|
|
|
|
|
.SH OPTIONS
|
|
.PP
|
|
\fB-l\fP, \fB--keep-last\fP=0
|
|
keep the last \fBn\fR snapshots (use 'unlimited' to keep all snapshots)
|
|
|
|
.PP
|
|
\fB-H\fP, \fB--keep-hourly\fP=0
|
|
keep the last \fBn\fR hourly snapshots (use 'unlimited' to keep all hourly snapshots)
|
|
|
|
.PP
|
|
\fB-d\fP, \fB--keep-daily\fP=0
|
|
keep the last \fBn\fR daily snapshots (use 'unlimited' to keep all daily snapshots)
|
|
|
|
.PP
|
|
\fB-w\fP, \fB--keep-weekly\fP=0
|
|
keep the last \fBn\fR weekly snapshots (use 'unlimited' to keep all weekly snapshots)
|
|
|
|
.PP
|
|
\fB-m\fP, \fB--keep-monthly\fP=0
|
|
keep the last \fBn\fR monthly snapshots (use 'unlimited' to keep all monthly snapshots)
|
|
|
|
.PP
|
|
\fB-y\fP, \fB--keep-yearly\fP=0
|
|
keep the last \fBn\fR yearly snapshots (use 'unlimited' to keep all yearly snapshots)
|
|
|
|
.PP
|
|
\fB--keep-within\fP=
|
|
keep snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-within-hourly\fP=
|
|
keep hourly snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-within-daily\fP=
|
|
keep daily snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-within-weekly\fP=
|
|
keep weekly snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-within-monthly\fP=
|
|
keep monthly snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-within-yearly\fP=
|
|
keep yearly snapshots that are newer than \fBduration\fR (eg. 1y5m7d2h) relative to the latest snapshot
|
|
|
|
.PP
|
|
\fB--keep-tag\fP=[]
|
|
keep snapshots with this \fBtaglist\fR (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--unsafe-allow-remove-all\fP[=false]
|
|
allow deleting all snapshots of a snapshot group
|
|
|
|
.PP
|
|
\fB--host\fP=[]
|
|
only consider snapshots for this \fBhost\fR (can be specified multiple times) (default: $RESTIC_HOST)
|
|
|
|
.PP
|
|
\fB--tag\fP=[]
|
|
only consider snapshots including \fBtag[,tag,...]\fR (can be specified multiple times)
|
|
|
|
.PP
|
|
\fB--path\fP=[]
|
|
only consider snapshots including this (absolute) \fBpath\fR (can be specified multiple times, snapshots must include all specified paths)
|
|
|
|
.PP
|
|
\fB-c\fP, \fB--compact\fP[=false]
|
|
use compact output format
|
|
|
|
.PP
|
|
\fB-g\fP, \fB--group-by\fP=host,paths
|
|
\fBgroup\fR snapshots by host, paths and/or tags, separated by comma (disable grouping with '')
|
|
|
|
.PP
|
|
\fB-n\fP, \fB--dry-run\fP[=false]
|
|
do not delete anything, just print what would be done
|
|
|
|
.PP
|
|
\fB--prune\fP[=false]
|
|
automatically run the 'prune' command if snapshots have been removed
|
|
|
|
.PP
|
|
\fB--max-unused\fP="5%"
|
|
tolerate given \fBlimit\fR of unused data (absolute value in bytes with suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
|
|
|
|
.PP
|
|
\fB--max-repack-size\fP=""
|
|
maximum \fBsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
|
|
|
|
.PP
|
|
\fB--repack-cacheable-only\fP[=false]
|
|
only repack packs which are cacheable
|
|
|
|
.PP
|
|
\fB--repack-small\fP[=false]
|
|
repack pack files below 80% of target pack size
|
|
|
|
.PP
|
|
\fB--repack-uncompressed\fP[=false]
|
|
repack all uncompressed data
|
|
|
|
.PP
|
|
\fB-h\fP, \fB--help\fP[=false]
|
|
help for forget
|
|
|
|
|
|
.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--http-user-agent\fP=""
|
|
set a http user agent for outgoing http requests
|
|
|
|
.PP
|
|
\fB--insecure-no-password\fP[=false]
|
|
use an empty password for the repository, must be passed to every restic command (insecure)
|
|
|
|
.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 SEE ALSO
|
|
.PP
|
|
\fBrestic(1)\fP
|