From 086fabfe9c5251d08184706567415b3751894716 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Wed, 21 Oct 2020 11:19:50 -0400 Subject: [PATCH] README: remove information now contained in the man page. --- README | 161 +++++++++------------------------------------------------ 1 file changed, 25 insertions(+), 136 deletions(-) diff --git a/README b/README index 90df91e..afb09f0 100644 --- a/README +++ b/README @@ -1,148 +1,37 @@ -valtz 0.8 -============================================================ +valtz 0.8 - a simple tool to validate tinydns-data files +======================================================== -Validation tool for tinydns-data zone files. +== What is it? == -Usage: +This is a fork of Magnus Bodin's simple utility to validate +tinydns-data files. The original has not been updated in many years. - Simple validation: - valtz [-qrRi] +== How do I install it? == - Simple filtering: - valtz -f[qrRiItT] +It's a Perl script, so download it and put it in your $PATH. It comes +with a man page that can be installed to your system's $MANPATH as +well. - Extensive filtering: - valtz -F[qrRiItT] +== How do I use it? == -General usage: - valtz [-hfFqrRiItT] +Run it on your tinydns-data files. If it finds errors, it will complain: - -h shows this help. + $ valtz example.com.tinydns + File example.com.tinydns + line 1; err 32 @example.com.::127.0.0.1: + expected: fqdn:ip:x:dist:ttl:timestamp:lo + pos 2; x; IP address found where hostname expected + $ echo $? + 1 +If it doesn't, it won't: - -f filter (don't just validate) file and output accepted lines to STDOUT. + $ valtz example.org.tinydns + $ echo $? + 0 +For more details, see the included man page. - -F treat files as filter configuration files for more advanced filtering. - These filterfiles one or several of the following filter directives: +== How do I report bugs? == - zonefile - zonefile file: - Defines the file(s) to be filtered. Can be a globbed value, like - /var/zones/external/* - - extralog - Defines an extra logfile that the STDERR output will be copied for - this specific filterfile. Useful if you have a lot of filterfiles - and want to separate the logs. - - deny - deny file: - Defines a zonepattern to explicitly DENY after implicitly allowing all. - (cannot be combined with allow) - - allow - allow file: - Defines a zonepattern to explicitly ALLOW after implicitly denying all. - - allowtype - Explicitly sets the allowed recordtypes. Note that even comments - has to be allowed (but these will not result in errors unless -t) - to be copied to the output. - - 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. - - - -t Give error even on #comment-lines when they are not allowed. - (These errors are silently ignored per default) - - - -T - A commandline way to explicitly set the allowed recordtypes. - This is _concatenated_ to the allowtype-allowed recordtypes. - - - -All errors in the zonefiles are sent to STDERR. - - Example; simple use: - valtz zone-bodin-org - - Example; simple filter-use; - 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 - 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 - - Example #2, strict filter for a certain user editing just A-records - - zonefile /home/felix/zones/zone-fl3x-net - allow fl3x.net - allowtype + - extralog /var/log/tinydns/fl3x-net.log - - Example #3, export filter to secondary - - zonefile /var/zones/primary/zone-* - # just allow OUR zones to be exported, not to annoy secondary partner - allow file:/var/zones/primary-zones.txt - # don't allow any other types than this; e.g. comments won't be exported - allowtype Z + @ . C - extralog /var/log/tinydns/primary-export.log - - Example #4, /etc/zones/minimalistic-filterfile - - deny file:/etc/zones/primary-zones.txt - allowtype Z + @ . C - - and on the commandline; - - ssh remote.example.org cat /etc/export-zones.txt | \ - valtz -F /etc/zones/minimalistic-filterfile \ - >/etc/tinydns/remote.example.org-data \ - 2>/var/log/remote.example.org-zones.log - - -Please mail comments and errors and general feedback to . - - -Thanks to - * Magnus Bodin - * Paul Jarc - * Otto Dandenell +Email them to me at michael@orlitzky.com. -- 2.44.2