2017-08-05 09:42:37 +00:00
.nh
2021-08-03 09:45:36 +00:00
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
2017-08-05 09:42:37 +00:00
.SH NAME
.PP
2022-08-25 17:55:00 +00:00
restic-prune - Remove unneeded data from the repository
2017-08-05 09:42:37 +00:00
.SH SYNOPSIS
.PP
\fB restic prune [flags]\fP
.SH DESCRIPTION
.PP
The "prune" command checks the repository and removes data that is not
referenced and therefore not needed any more.
2020-09-19 15:38:26 +00:00
.SH EXIT STATUS
.PP
2022-08-25 17:55:00 +00:00
Exit status is 0 if the command was successful, and non-zero if there was any error.
2020-09-19 15:38:26 +00:00
2017-08-05 09:42:37 +00:00
.SH OPTIONS
2021-02-14 10:44:20 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB -n\fP , \fB --dry-run\fP [=false]
2021-08-03 09:45:36 +00:00
do not modify the repository, just print what would be done
2021-02-14 10:44:20 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB -h\fP , \fB --help\fP [=false]
2021-08-03 09:45:36 +00:00
help for prune
2017-08-05 09:42:37 +00:00
2021-02-14 10:44:20 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --max-repack-size\fP =""
2021-08-03 09:45:36 +00:00
maximum \fB \fC size\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
2021-02-14 10:44:20 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --max-unused\fP ="5%"
2021-08-03 09:45:36 +00:00
tolerate given \fB \fC limit\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')
2021-02-14 10:44:20 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --repack-cacheable-only\fP [=false]
2021-08-03 09:45:36 +00:00
only repack packs which are cacheable
2021-02-14 10:44:20 +00:00
2022-08-25 17:55:00 +00:00
.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 --unsafe-recover-no-free-space\fP =""
UNSAFE, READ THE DOCUMENTATION BEFORE USING! Try to recover a repository stuck with no free space. Do not use without trying out 'prune --max-repack-size 0' first.
2017-08-05 09:42:37 +00:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --cacert\fP =[]
2021-08-03 09:45:36 +00:00
\fB \fC file\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
2022-08-25 17:55:00 +00:00
\fB --cache-dir\fP =""
2021-08-03 09:45:36 +00:00
set the cache \fB \fC directory\fR \& . (default: use system default cache directory)
2017-09-24 21:13:04 +00:00
2017-12-27 21:31:03 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --cleanup-cache\fP [=false]
2021-08-03 09:45:36 +00:00
auto remove old cache directories
2017-12-27 21:31:03 +00:00
2022-03-26 19:09:59 +00:00
.PP
2022-08-25 17:55:00 +00:00
\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)
2022-03-26 19:09:59 +00:00
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --json\fP [=false]
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB --key-hint\fP =""
\fB \fC key\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
2022-08-25 17:55:00 +00:00
\fB --limit-download\fP =0
2021-08-03 09:45:36 +00:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 18:46:16 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --limit-upload\fP =0
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB --no-cache\fP [=false]
2021-08-03 09:45:36 +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
2022-08-25 17:55:00 +00:00
\fB --no-lock\fP [=false]
do not lock the repository, this allows some operations on read-only repositories
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB -o\fP , \fB --option\fP =[]
2021-08-03 09:45:36 +00:00
set extended option (\fB \fC key=value\fR , can be specified multiple times)
2017-08-05 09:42:37 +00:00
2019-01-06 20:40:32 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --pack-size\fP =0
set target pack size in MiB, created pack files may be larger (default: $RESTIC_PACK_SIZE)
.PP
\fB --password-command\fP =""
shell \fB \fC command\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
2022-08-25 17:55:00 +00:00
\fB -p\fP , \fB --password-file\fP =""
\fB \fC file\fR to read the repository password from (default: $RESTIC_PASSWORD_FILE)
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB -q\fP , \fB --quiet\fP [=false]
2021-08-03 09:45:36 +00:00
do not output comprehensive progress report
2017-08-05 09:42:37 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB -r\fP , \fB --repo\fP =""
\fB \fC repository\fR to backup to or restore from (default: $RESTIC_REPOSITORY)
2020-11-05 08:41:35 +00:00
.PP
2022-08-25 17:55:00 +00:00
\fB --repository-file\fP =""
\fB \fC file\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
2022-08-25 17:55:00 +00:00
\fB --tls-client-cert\fP =""
2021-08-03 09:45:36 +00:00
path to a \fB \fC file\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
2022-08-25 17:55:00 +00:00
\fB -v\fP , \fB --verbose\fP [=0]
be verbose (specify multiple times or a level using --verbose=\fB \fC n\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
\fB restic(1)\fP