caching and cache time configuration

[phancap.git] / README.rst

diff --git a/README.rst b/README.rst
index 3b71795b8d67d1af4e8eaa198a589328e6feac0c..78a67ec7be8766a891701539a2e090daf94e1102 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -31,6 +31,17 @@ Screenshot parameters
   Screenshot format (``png``, ``jpg``, ``pdf``, default: ``png``)
 ``smode``
   Screenshot mode (``screen`` (4:3) or ``page`` (full website height))
+``smaxage``
+  Maximum age of screenshot in seconds.
+  ISO 8601 duration specifications accepted:
+
+  - ``P1Y`` - 1 year
+  - ``P2W`` - 2 weeks
+  - ``P1D`` - 1 day
+  - ``PT4H`` - 4 hours
+
+  The configuration file defines a minimum age that the user cannot undercut
+  (``$screenshotMinAge``), as well as a default value (``$screenshotMaxAge``).
 
 Authentication parameters
 =========================