restic/doc/man/restic-prune.1

120 lines
2.8 KiB
Groff
Raw Normal View History

2017-08-05 11:42:37 +02:00
.nh
2021-08-03 11:45:36 +02:00
.TH "restic backup" "1" "Jan 2017" "generated by \fB\fCrestic generate\fR" ""
2017-08-05 11:42:37 +02:00
.SH NAME
.PP
restic\-prune \- Remove unneeded data from the repository
2017-08-05 11:42:37 +02:00
.SH SYNOPSIS
.PP
\fBrestic 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 17:38:26 +02: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 11:42:37 +02:00
.SH OPTIONS
2021-02-14 11:44:20 +01:00
.PP
\fB\-n\fP, \fB\-\-dry\-run\fP[=false]
2021-08-03 11:45:36 +02:00
do not modify the repository, just print what would be done
2021-02-14 11:44:20 +01:00
2017-08-05 11:42:37 +02:00
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
2021-08-03 11:45:36 +02:00
help for prune
2017-08-05 11:42:37 +02:00
2021-02-14 11:44:20 +01:00
.PP
\fB\-\-max\-repack\-size\fP=""
2021-08-03 11:45:36 +02:00
maximum \fB\fCsize\fR to repack (allowed suffixes: k/K, m/M, g/G, t/T)
2021-02-14 11:44:20 +01:00
.PP
\fB\-\-max\-unused\fP="5%"
2021-08-03 11:45:36 +02:00
tolerate given \fB\fClimit\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 11:44:20 +01:00
.PP
\fB\-\-repack\-cacheable\-only\fP[=false]
2021-08-03 11:45:36 +02:00
only repack packs which are cacheable
2021-02-14 11:44:20 +01:00
2017-08-05 11:42:37 +02:00
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2017-11-26 19:46:16 +01:00
.PP
\fB\-\-cacert\fP=[]
2021-08-03 11:45:36 +02:00
\fB\fCfile\fR to load root certificates from (default: use system certificates)
2017-11-26 19:46:16 +01:00
2017-09-24 23:13:04 +02:00
.PP
\fB\-\-cache\-dir\fP=""
2021-08-03 11:45:36 +02:00
set the cache \fB\fCdirectory\fR\&. (default: use system default cache directory)
2017-09-24 23:13:04 +02:00
2017-12-27 22:31:03 +01:00
.PP
\fB\-\-cleanup\-cache\fP[=false]
2021-08-03 11:45:36 +02:00
auto remove old cache directories
2017-12-27 22:31:03 +01:00
2017-08-05 11:42:37 +02:00
.PP
\fB\-\-json\fP[=false]
2021-08-03 11:45:36 +02:00
set output mode to JSON for commands that support it
2017-08-05 11:42:37 +02:00
2019-01-06 21:40:32 +01:00
.PP
\fB\-\-key\-hint\fP=""
2021-08-03 11:45:36 +02:00
\fB\fCkey\fR ID of key to try decrypting first (default: $RESTIC\_KEY\_HINT)
2019-01-06 21:40:32 +01:00
2017-11-26 19:46:16 +01:00
.PP
\fB\-\-limit\-download\fP=0
2021-08-03 11:45:36 +02:00
limits downloads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 19:46:16 +01:00
.PP
\fB\-\-limit\-upload\fP=0
2021-08-03 11:45:36 +02:00
limits uploads to a maximum rate in KiB/s. (default: unlimited)
2017-11-26 19:46:16 +01:00
2017-09-24 23:13:04 +02:00
.PP
\fB\-\-no\-cache\fP[=false]
2021-08-03 11:45:36 +02:00
do not use a local cache
2017-09-24 23:13:04 +02:00
2017-08-05 11:42:37 +02:00
.PP
\fB\-\-no\-lock\fP[=false]
2021-08-03 11:45:36 +02:00
do not lock the repository, this allows some operations on read\-only repositories
2017-08-05 11:42:37 +02:00
.PP
\fB\-o\fP, \fB\-\-option\fP=[]
2021-08-03 11:45:36 +02:00
set extended option (\fB\fCkey=value\fR, can be specified multiple times)
2017-08-05 11:42:37 +02:00
2019-01-06 21:40:32 +01:00
.PP
\fB\-\-password\-command\fP=""
2021-08-03 11:45:36 +02:00
shell \fB\fCcommand\fR to obtain the repository password from (default: $RESTIC\_PASSWORD\_COMMAND)
2019-01-06 21:40:32 +01:00
2017-08-05 11:42:37 +02:00
.PP
\fB\-p\fP, \fB\-\-password\-file\fP=""
2021-08-03 11:45:36 +02:00
\fB\fCfile\fR to read the repository password from (default: $RESTIC\_PASSWORD\_FILE)
2017-08-05 11:42:37 +02:00
.PP
\fB\-q\fP, \fB\-\-quiet\fP[=false]
2021-08-03 11:45:36 +02:00
do not output comprehensive progress report
2017-08-05 11:42:37 +02:00
.PP
\fB\-r\fP, \fB\-\-repo\fP=""
2021-08-03 11:45:36 +02:00
\fB\fCrepository\fR to backup to or restore from (default: $RESTIC\_REPOSITORY)
2020-11-05 09:41:35 +01:00
.PP
\fB\-\-repository\-file\fP=""
2021-08-03 11:45:36 +02:00
\fB\fCfile\fR to read the repository location from (default: $RESTIC\_REPOSITORY\_FILE)
2017-08-05 11:42:37 +02:00
2018-02-17 20:27:28 +01:00
.PP
\fB\-\-tls\-client\-cert\fP=""
2021-08-03 11:45:36 +02:00
path to a \fB\fCfile\fR containing PEM encoded TLS client certificate and private key
2018-02-17 20:27:28 +01:00
2018-05-21 15:57:32 +02:00
.PP
\fB\-v\fP, \fB\-\-verbose\fP[=0]
2021-08-03 11:45:36 +02:00
be verbose (specify multiple times or a level using \-\-verbose=\fB\fCn\fR, max level/times is 3)
2018-05-21 15:57:32 +02:00
2017-08-05 11:42:37 +02:00
.SH SEE ALSO
.PP
\fBrestic(1)\fP