retention-helper/readme.md

@@ -0,0 +1,28 @@
+# retention-helper.sh
+This script is intended to find files with a certain retention time.
+
+Additionally one can run the script in *set* mode to update the retention. To update the retention the repository has to be mounted separately as mentioned in [Special delete without blocking a share for the public](https://it-confluence.pixsoftware.de/display/Operations/Special+delete+without+blocking+a+share+for+the+public).
+
+Please consult the help for a comprehensive option description.
+
+Some examples:
+
+---
+To fix a wrong set default retention of 30.000 years to 30 years. This needs the special delete mount.
+
+    # retentionHelper.sh --retention 946728000000 --mode set --new-retention 946728000 --directory /mnt/special_delete/my_repo
+---
+To find files with a certain *atime*. This works on any folder as the *atime* of a file is evaluated.
+ 
+     # retention-helper.sh -d /tmp/ -a 172837470
+----
+To find files with a certain retention. This works on special delete mounts only, since *trusted.worm.attr* is evaluated.
+
+    # retention-helper.sh -d /mnt/special/repo1/sharename/data/ -m show
+    /mnt/special/repo1/sharename/data/fs-manager
+      atime:             Wed Oct  2 07:30:49 UTC 2024 || 1727854249
+      trusted.worm.attr: 3600
+    /mnt/special/repo1/sharename/data/fs-manager-copy
+      atime:             Wed Oct  2 07:32:53 UTC 2024 || 1727854373
+      trusted.worm.attr: 3600
+    ...