1restic backup(1) restic backup(1)
2
3
4
6 restic-forget - Remove snapshots from the repository
7
8
9
11 restic forget [flags] [snapshot ID] [...]
12
13
14
16 The "forget" command removes snapshots according to a policy. Please
17 note that this command really only deletes the snapshot object in the
18 repository, which is a reference to data stored there. In order to
19 remove this (now unreferenced) data after 'forget' was run
20 successfully, see the 'prune' command.
21
22
23
25 Exit status is 0 if the command was successful, and non-zero if there
26 was any error.
27
28
29
31 -l, --keep-last=0
32 keep the last n snapshots
33
34
35 -H, --keep-hourly=0
36 keep the last n hourly snapshots
37
38
39 -d, --keep-daily=0
40 keep the last n daily snapshots
41
42
43 -w, --keep-weekly=0
44 keep the last n weekly snapshots
45
46
47 -m, --keep-monthly=0
48 keep the last n monthly snapshots
49
50
51 -y, --keep-yearly=0
52 keep the last n yearly snapshots
53
54
55 --keep-within=
56 keep snapshots that are newer than duration (eg. 1y5m7d2h) relative
57 to the latest snapshot
58
59
60 --keep-tag=[]
61 keep snapshots with this taglist (can be specified multiple times)
62
63
64 --host=[]
65 only consider snapshots with the given host (can be specified
66 multiple times)
67
68
69 --tag=[]
70 only consider snapshots which include this taglist in the format
71 tag[,tag,...] (can be specified multiple times)
72
73
74 --path=[]
75 only consider snapshots which include this (absolute) path (can be
76 specified multiple times)
77
78
79 -c, --compact[=false]
80 use compact output format
81
82
83 -g, --group-by="host,paths"
84 string for grouping snapshots by host,paths,tags
85
86
87 -n, --dry-run[=false]
88 do not delete anything, just print what would be done
89
90
91 --prune[=false]
92 automatically run the 'prune' command if snapshots have been
93 removed
94
95
96 --max-unused="5%"
97 tolerate given limit of unused data (absolute value in bytes with
98 suffixes k/K, m/M, g/G, t/T, a value in % or the word 'unlimited')
99
100
101 --max-repack-size=""
102 maximum size to repack (allowed suffixes: k/K, m/M, g/G, t/T)
103
104
105 --repack-cacheable-only[=false]
106 only repack packs which are cacheable
107
108
109 -h, --help[=false]
110 help for forget
111
112
113
115 --cacert=[]
116 file to load root certificates from (default: use system
117 certificates)
118
119
120 --cache-dir=""
121 set the cache directory. (default: use system default cache
122 directory)
123
124
125 --cleanup-cache[=false]
126 auto remove old cache directories
127
128
129 --json[=false]
130 set output mode to JSON for commands that support it
131
132
133 --key-hint=""
134 key ID of key to try decrypting first (default: $RESTIC_KEY_HINT)
135
136
137 --limit-download=0
138 limits downloads to a maximum rate in KiB/s. (default: unlimited)
139
140
141 --limit-upload=0
142 limits uploads to a maximum rate in KiB/s. (default: unlimited)
143
144
145 --no-cache[=false]
146 do not use a local cache
147
148
149 --no-lock[=false]
150 do not lock the repository, this allows some operations on
151 read-only repositories
152
153
154 -o, --option=[]
155 set extended option (key=value, can be specified multiple times)
156
157
158 --password-command=""
159 shell command to obtain the repository password from (default:
160 $RESTIC_PASSWORD_COMMAND)
161
162
163 -p, --password-file=""
164 file to read the repository password from (default:
165 $RESTIC_PASSWORD_FILE)
166
167
168 -q, --quiet[=false]
169 do not output comprehensive progress report
170
171
172 -r, --repo=""
173 repository to backup to or restore from (default:
174 $RESTIC_REPOSITORY)
175
176
177 --repository-file=""
178 file to read the repository location from (default:
179 $RESTIC_REPOSITORY_FILE)
180
181
182 --tls-client-cert=""
183 path to a file containing PEM encoded TLS client certificate and
184 private key
185
186
187 -v, --verbose[=0]
188 be verbose (specify multiple times or a level using --verbose=n,
189 max level/times is 3)
190
191
192
194 restic(1)
195
196
197
198generated by `restic generate` Jan 2017 restic backup(1)