.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DRAWVALMAP 1"
.TH DRAWVALMAP 1 2023-07-29 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
drawvalmap \- Generate a graphical output of validation status values
             encountered by the validator library.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
drawvalmap <logfile>
.PP
drawvalmap
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdrawvalmap\fR is a simple utility that can be used to display the validator
status values in a graphical format.  The input to this script is a set of log
messages that can be read either from file or from a socket.  The output is an
image file containing an image of the various validator authentication chain
status values.
.PP
\&\fBdrawvalmap\fR reads data from STDIN if the logfile and the socket option are
both unspecified.  If the \fI\-f\fR option is given, the output image file is
embedded in an HTML file with the given name.  The HTML file auto-refreshes
according to the refresh time supplied by the \fI\-r\fR option, allowing changes
to the validator graph to be constantly tracked.
.PP
The typical usage of this script is in the following way:
.PP
.Vb 1
\&    # drawvalmap <logfile>
.Ve
.PP
It would not be uncommon to use this script for troubleshooting purposes, in
which case output generated by a driver program would be "piped" to this
script in the manner shown below.
.PP
.Vb 1
\&    # dt\-validate \-o6:stdout secure.example.com. | drawvalmap \-f val_log_map.html
.Ve
.PP
In each case the script generates the results in a \fBval_log_map.png\fR file.
In the second case, an HTML file with the name \fBval_log_map.html\fR is also
generated.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-a IP-address\fR" 4
.IX Item "-a IP-address"
This changes the address to which \fBdrawvalmap\fR binds itself to
the specified value. This option takes effect only if the
\&\fI\-s\fR option is also specified.
.IP "\fB\-f file.ext\fR" 4
.IX Item "-f file.ext"
This creates an image of the type determined by the file extension
.IP "\fB\-g xxxx\fR (deprecated)" 4
.IX Item "-g xxxx (deprecated)"
Use \-f instead.
.IP "\fB\-h file.html\fR" 4
.IX Item "-h file.html"
This creates an HTML file with the given name, which contains the image of
the validation map.
.IP "\fB\-i ignore_pattern_string\fR" 4
.IX Item "-i ignore_pattern_string"
This causes \fBdrawvalmap\fR to ignore log records that match the given ignore
pattern.
.IP "\fB\-l log_event1,log_event2\fR" 4
.IX Item "-l log_event1,log_event2"
This causes \fBdrawvalmap\fR to enable display of events for the given list of  
log types. The following log event types are defined with their default enabled 
status indicated in parenthesis: \fBSUCCESS\fR\|(1), \fBBOGUS\fR\|(1), \fBDATA_MISSING\fR\|(1), 
\&\fBERROR\fR\|(1), and \fBIGNORED\fR\|(0).
.IP "\fB\-m match_pattern_string\fR" 4
.IX Item "-m match_pattern_string"
This causes \fBdrawvalmap\fR to include only log records that match the given
pattern.  If a given log record matches a pattern given by the \fI\-m\fR option
and also matches the pattern given by the \fI\-i\fR option the effective result
is that of ignoring the record.
.IP "\fB\-p port\fR" 4
.IX Item "-p port"
This changes the port to which \fBdrawvalmap\fR binds itself to
the specified value. This option takes effect only if the
\&\fI\-s\fR option is also specified.
.IP "\fB\-r refresh-period\fR" 4
.IX Item "-r refresh-period"
This changes the refresh period in the HTML file to the given value. The
default is 5 seconds.
.IP \fB\-s\fR 4
.IX Item "-s"
This changes the mode of operation to read input from a socket.
The default address and port to which \fBdrawvalmap\fR binds are
127.0.0.1:1053.
.SH PRE-REQUISITES
.IX Header "PRE-REQUISITES"
GraphViz
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2005\-2013 SPARTA, Inc.  All rights reserved.
See the COPYING file included with the DNSSEC-Tools package for details.
.SH AUTHOR
.IX Header "AUTHOR"
Suresh Krishnaswamy, hserus@users.sourceforge.net
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBlibval\|(3)\fR