diff options
| author | Thomas Waldmann <tw@waldmann-edv.de> | 2015-10-03 14:12:16 +0200 |
|---|---|---|
| committer | Thomas Waldmann <tw@waldmann-edv.de> | 2015-10-03 14:12:16 +0200 |
| commit | bf3cf21ac5d128785dacbc0282370524763099c6 (patch) | |
| tree | 0979406181cff467d3272a57df03c2ad1e28ffee /docs | |
| parent | 2c13027750f274442f33c1756207cdf51f61d8cc (diff) | |
docs: add warning about prune
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/quickstart.rst | 9 | ||||
| -rw-r--r-- | docs/usage.rst | 17 |
2 files changed, 21 insertions, 5 deletions
diff --git a/docs/quickstart.rst b/docs/quickstart.rst index b6c4c42df..32218fc67 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -85,9 +85,12 @@ certain number of old archives:: --exclude /home/Ben/Music/Justin\ Bieber \ --exclude '*.pyc' - # Use the `prune` subcommand to maintain 7 daily, 4 weekly - # and 6 monthly archives. - borg prune -v $REPOSITORY --keep-daily=7 --keep-weekly=4 --keep-monthly=6 + # Use the `prune` subcommand to maintain 7 daily, 4 weekly and 6 monthly + # archives of THIS machine. --prefix `hostname`- is very important to + # limit prune's operation to this machine's archives and not apply to + # other machine's archives also. + borg prune -v $REPOSITORY --prefix `hostname`- \ + --keep-daily=7 --keep-weekly=4 --keep-monthly=6 .. backup_compression: diff --git a/docs/usage.rst b/docs/usage.rst index 3a933d42c..95b95d90d 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -265,10 +265,23 @@ Examples Examples ~~~~~~~~ + +Be careful, prune is potentially dangerous command, it will remove backup +archives. + +The default of prune is to apply to **all archives in the repository** unless +you restrict its operation to a subset of the archives using `--prefix`. +When using --prefix, be careful to choose a good prefix - e.g. do not use a +prefix "foo" if you do not also want to match "foobar". + +It is strongly recommended to always run `prune --dry-run ...` first so you +will see what it would do without it actually doing anything. + :: - # Keep 7 end of day and 4 additional end of week archives: - $ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 + # Keep 7 end of day and 4 additional end of week archives. + # Do a dry-run without actually deleting anything. + $ borg prune /mnt/backup --dry-run --keep-daily=7 --keep-weekly=4 # Same as above but only apply to archive names starting with "foo": $ borg prune /mnt/backup --keep-daily=7 --keep-weekly=4 --prefix=foo |