--- a/README Thu Feb 26 19:30:27 2015 +0200
+++ b/README Thu Feb 26 19:49:10 2015 +0200
@@ -180,7 +180,10 @@
fixed-address 10.2.0.1;
}
-== Host structure ==
+= `update` =
+A script to drive the *pvl.hosts* tools for maintaing a set of zone/host files for a DNS/DHCP server.
+
+== Source host files ==
Creating a tree of symlinks for managing split zonefile domains can be useful:
@@ -211,6 +214,75 @@
2 PTR bar.test.
5 PTR quux.asdf.test.
+== Usage ==
+
+=== `bin/update` ===
+*update* reads host/zone file sources from `etc/`, and generates zonefiles/dhcp configs under `var/`.
+
+`update` will also shows and commits changes to `etc/` in any supported version-control system, and use commit timestamps for stable zone serials.
+
+ -d DIR
+ Do data operations under given dir-root, as opposed to CWD.
+
+ -q
+ Quiet. No log messages except errors.
+
+ -vDV
+ Increasing logging verbosity.
+
+ -p
+ Show diffs for changed output on stdout.
+
+ -F
+ Force-update output files, even if newer than input files.
+
+ -S
+ Do not generate new serials for zones.
+
+ -d DIR
+ Do data operations under given dir-root, as opposed to CWD.
+
+ -q
+ Quiet. No log messages except errors.
+
+ -vDV
+ Increasing logging verbosity.
+
+ -p
+ Show diffs for changed output on stdout.
+
+ -F
+ Force-update output files, even if newer than input files.
+
+ -S
+ Do not generate new serials for zones.
+
+ -s
+ Generate new serials for all zones.
+
+ -n
+ Fake-update; show changes, but don't actually commit/deploy them.
+
+ Useful for testing.
+
+ -C
+ Do not commit source changes.
+
+ -c
+ Force-commit source changes, even though -n
+
+ -m MSG
+ Commit message for source changes; optional
+
+== Output structure ==
+Generated file structure.
+
+=== `var/dhcp/` ===
+Generated dhcpd.conf fragments, loaded by dhcpd.
+
+=== `var/zones/` ===
+Generated zonefiles, loaded by bind.
+
= Experimental features =
Features that are still under development