document single-v verbosity

[dyn-nsupdate.git] / README.rst

diff --git a/README.rst b/README.rst
index b7dad71646e488b250a51bb892af36e743fac76c..8e3104034dd5153a450a8bac0578b5a20d00b806 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -33,7 +33,7 @@ the passwords, and applies the updates; and some CGI scripts offered through a
 webserver. Please read this guide carefully and make sure you understand the
 security implications of what you are doing. setuid wrappers are not toys!
 
-Let's setting up the setuid wrapper. To compile it, you will need cmake and 
+Let's first set up the setuid wrapper. To compile it, you will need cmake and 
 boost, including the regex and program_options boost packages. Starting in the 
 source directory, run::
 
@@ -49,7 +49,7 @@ configuration file will be hard-coded into the binary. If it were run-time
 configurable, then a user could call the script with her own configuration file, 
 gaining access to all domains BIND lets you configure. If you want to put the 
 files in another directory, change the configuration file name accordingly. Make 
-sure the file (nor any of the directories it is in) can *not be written by 
+sure the file (and all of the directories it is in) can *not be written by 
 non-root*. The setuid wrapper trusts that file. You can now install it and the 
 sample configuration file, and set their permissions::
 
@@ -117,6 +117,10 @@ This sets the update interval to 15min. If your IP address changes daily, you
 may want to reduce this to 5min to have a smaller timeframe during which your 
 server is not available.
 
+If you want to be emailed about changes in your IP address, pass ``-v`` as 
+argument. The script will then only produce output if it has to update the DNS
+record.
+
 Client setup (using a router)
 -----------------------------
 
@@ -137,10 +141,13 @@ Note that the user name is ignored.
 Source, License
 ---------------
 
-You can find the sources in the `git repository`_. They are provided under a 
-2-clause BSD license.
+You can find the sources in the `git repository`_ (also available `on GitHub`_). 
+They are provided under a `2-clause BSD license`_. See the file ``LICENSE-BSD`` 
+for more details.
 
 .. _git repository: http://www.ralfj.de/git/dyn-nsupdate.git
+.. _on GitHub: https://github.com/RalfJung/dyn-nsupdate
+.. _2-clause BSD license: http://opensource.org/licenses/bsd-license.php
 
 Contact
 -------