diff --git a/docs/30_Scripts.md b/docs/30_Scripts.md index 52ca90ba37d5b98754070c5add211680d952fe17..1468370ccaf640873febe86d8e0572a8ee9b6203 100644 --- a/docs/30_Scripts.md +++ b/docs/30_Scripts.md @@ -162,9 +162,9 @@ ls -l rest_pruner.cfg ## Syntax ```txt - -========== RESTIC REST PRUNER v0.1 ========== - +------------------------------------------------------------------------------ + --------========###| RESTIC REST PRUNER :: v0.2 |###=======-------- +------------------------------------------------------------------------------ Pruner for restic rest server with append only option. This script prunes all repositories on server side. @@ -172,11 +172,21 @@ This script prunes all repositories on server side. The config file [rest_pruner.cfg] contains <USER>:<RESTIC_PASSWORD> If a directory matches /netshare/restic-backup/<USER> then it will be pruned. +Institute for Medical Education * University of Bern +GNU GPL 3.0 + + SYNTAX: rest_pruner.sh [OPTIONS] [FILTER] + OPTIONS: -h, --help show help and exit. + -a, --all process all repositories, default: rest only + archives + -d, --debug show more infos + -f, --force force pruning; do not wait 7 days + -s, --status show pruning status with last prunes + PARAMETERS: FILTER regex to filter directory list in @@ -185,10 +195,23 @@ PARAMETERS: EXAMPLES: rest_pruner.sh Start pruning of all matching repositories + rest_pruner.sh mail Prune servers that match "mail", eg. my-mailhub.example.com + rest_pruner.sh --force mail + Prune servers that match "mail", + eg. my-mailhub.example.com + + rest_pruner.sh --status + Show statistics with last prunes, if it is archive or + running or on error. + It shows repositories with passwords and archives. + Other repositories are not visible until you + specify --all. + + ``` ## How does it work diff --git a/rest_pruner.sh b/rest_pruner.sh index 095490b488e9fda60d10c832e30306b0b266fa82..3762e9316d7b34966f85f25d510983e586d5592b 100755 --- a/rest_pruner.sh +++ b/rest_pruner.sh @@ -93,7 +93,7 @@ EXAMPLES: running or on error. It shows repositories with passwords and archives. Other repositories are not visible until you - specify -d. + specify --all. EOH }