support domain patterns

[ssh-dyndns.git] / README.rst

diff --git a/README.rst b/README.rst
index 55947a979c25a439599335afc0d257fbfb273dce..4a456e0fb6f902558344491a37db015957788e97 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -64,6 +64,14 @@ The configuration file may define the following variables:
     DNS entry TTL (time to live) in seconds
 
     Default: 300
+``domain_patterns``
+    Defines patterns for domains that may be dynamically changed.
+    If the domain name does not match the pattern, the script aborts.
+
+    You may use several patterns by separating them with a space.
+    Shell wildcards are supported (``*`` and ``?``).
+
+    Default: ``home.example.org *.home.example.org``
 
 
 =====