summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorgrabner <pjg.github@ubergrabner.net>2013-08-26 17:19:30 -0400
committergrabner <pjg.github@ubergrabner.net>2013-08-26 17:19:30 -0400
commitacc247d43859415f7f4151b473a26f27ee75131c (patch)
tree031a42b2e6ca0bcf1a1d4dac72fd137fa8411e04
parent1c996dfbd0484b89fa47777bb290702a99c5e043 (diff)
downloadiniherit-acc247d43859415f7f4151b473a26f27ee75131c.tar.gz
added documentation re "iniherit" script
-rw-r--r--README.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index bd7e461..eccd17b 100644
--- a/README.rst
+++ b/README.rst
@@ -67,6 +67,16 @@ Note that the call to `install_globally()` must be invoked **before**
any other module imports ConfigParser for the global override to have
an effect.
+The command-line program `iniherit` allows flattening of INI files
+(i.e. collapsing all inheritance rules), optionally in "watch" mode:
+
+.. code-block:: shell
+
+ $ iniherit --watch --interval 2 --verbose input.ini output.ini
+ INFO:iniherit.cli:"source.ini" changed; updating output...
+ INFO:iniherit.cli:"inherited-file.ini" changed; updating output...
+ ^C
+
Installation
============