Add a man page.

[valtz.git] / README

diff --git a/README b/README
index 59b833e6f40ff679743bc9499540f55bd04d8f08..90df91eedd2a529943a2d5db74b36b1413329883 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,4 @@
-
-valtz 0.7, ; (C) 2003 Magnus Bodin, http://x42.com/software/ 
+valtz 0.8
 ============================================================
 
 Validation tool for tinydns-data zone files.
@@ -7,22 +6,22 @@ Validation tool for tinydns-data zone files.
 Usage:
 
   Simple validation:
-    valtz [-qrRix] <zonefiles>
+    valtz [-qrRi] <zonefiles>
 
   Simple filtering:
-    valtz -f[qrRiItTx] <zonefiles>
+    valtz -f[qrRiItT] <zonefiles>
 
   Extensive filtering:
-    valtz -F[qrRiItTx] <filterfiles>
+    valtz -F[qrRiItT] <filterfiles>
 
 General usage:
-    valtz [-hfFqrRiItTx] <file(s)>
+    valtz [-hfFqrRiItT] <file(s)>
 
   -h shows this help.
 
 
   -f filter (don't just validate) file and output accepted lines to STDOUT.
-     
+
 
   -F treat files as filter configuration files for more advanced filtering.
      These filterfiles one or several of the following filter directives:
@@ -54,27 +53,27 @@ General usage:
      Multiple zonefile, allow- and deny-lines are allowed, but also the
      alternative file:-line that points to a textfile containing one
      value per line.
-    
-    
+
+
   -r allows fqdn to be empty thus denoting the root.
      This is also allowed per default when doing implict allow - see deny,
      or when specifying 'allow .', i.e. explictly allowing root as such.
      (cannot be combined with deny)
 
-     
+
   -R relaxes the validation and allows empty mname and p-fields.xi
      This is probably not very useful.
 
-     
+
   -i allows the ip-fields to be empty as well. These will then not generate any
      records.
 
 
   -I Include rejected lines as comments in output (valid when filtering).
 
- 
+
   -q Do not echo valid lines to STDOUT.
-    
+
   -s DO NOT ignore files ending with ,v ~ .bak .log .old .swp .tmp
      which is done per default.
 
@@ -87,10 +86,6 @@ General usage:
      A commandline way to explicitly set the allowed recordtypes.
      This is _concatenated_ to the allowtype-allowed recordtypes.
 
-  -x Exit with non-null exit code on errors; i.e. make errors detectable by
-     e.g. shell scripts; 1 = validation error, 2 = permission error,
-     3 = combination of 1 and 2.
-
 
 
 All errors in the zonefiles are sent to STDERR.
@@ -99,27 +94,27 @@ All errors in the zonefiles are sent to STDERR.
        valtz zone-bodin-org
 
      Example; simple filter-use;
-       valtz -f /etc/zones/zone-* 
-                >/etc/tinydns/data.filtered 
+       valtz -f /etc/zones/zone-*
+                >/etc/tinydns/data.filtered
                 2>/var/log/tinydns/valtz.log
 
      Example; filterfile use;
-       valtz -F /etc/zones/filter/zones-otto 
-                >/etc/tinydns/data.otto 
+       valtz -F /etc/zones/filter/zones-otto
+                >/etc/tinydns/data.otto
                 2>/var/log/tinydns/valtz.log
 
-                
+
      Example filterfile for using as import from primary (as above):
        zonefile   /var/zones/external/otto/zone-*
        deny       bodin.org
        deny       x42.com
-       extralog   /var/log/tinydns/external-otto.log    
+       extralog   /var/log/tinydns/external-otto.log
 
      Example #2, strict filter for a certain user editing just A-records
 
        zonefile  /home/felix/zones/zone-fl3x-net
        allow     fl3x.net
-       allowtype + 
+       allowtype +
        extralog  /var/log/tinydns/fl3x-net.log
 
      Example #3, export filter to secondary
@@ -132,7 +127,7 @@ All errors in the zonefiles are sent to STDERR.
        extralog  /var/log/tinydns/primary-export.log
 
      Example #4, /etc/zones/minimalistic-filterfile
-       
+
        deny file:/etc/zones/primary-zones.txt
        allowtype Z + @ . C
 
@@ -144,10 +139,10 @@ All errors in the zonefiles are sent to STDERR.
            2>/var/log/remote.example.org-zones.log
 
 
-Please mail comments and errors and general feedback to <magnus@bodin.org>.
+Please mail comments and errors and general feedback to <michael@orlitzky.com>.
 
 
-Thanks to 
+Thanks to
+  * Magnus Bodin
   * Paul Jarc
   * Otto Dandenell
-