.\" -*- 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 "DNSPKTFLOW 1"
.TH DNSPKTFLOW 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
dnspktflow \- Analyze and draw DNS flow diagrams from a tcpdump file
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  dnspktflow \-o output.png file.tcpdump
\&
\&  dnspktflow \-o output.png \-x \-a \-t \-q file.tcpdump
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBdnspktflow\fR application takes a \fBtcpdump\fR network traffic dump
file, passes it through the \fBtshark\fR application and then displays the
resulting DNS packet flows in a "flow-diagram" image.  \fBdnspktflow\fR
can output a single image or a series of images which can then be
shown in sequence as an animation.
.PP
\&\fBdnspktflow\fR was written as a debugging utility to help trace DNS
queries and responses, especially as they apply to DNSSEC-enabled lookups.
.SH REQUIREMENTS
.IX Header "REQUIREMENTS"
This application requires the following Perl modules and software
components to work:
.PP
.Vb 3
\&  graphviz                  (http://www.graphviz.org/)
\&  GraphViz                  (Perl module)
\&  tshark                    (http://www.wireshark.org/)
.Ve
.PP
The following is required for outputting screen presentations:
.PP
.Vb 1
\&  MagicPoint                (http://member.wide.ad.jp/wg/mgp/)
.Ve
.PP
If the following modules are installed, a GUI interface will be enabled for
communication with \fBdnspktflow\fR:
.PP
.Vb 2
\&  QWizard                   (Perl module)
\&  Getopt::GUI::Long         (Perl module)
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
\&\fBdnspktflow\fR takes a wide variety of command-line options.  These options
are described below in the following functional groups:  input packet
selection, output file options, output visualization options, graphical
options, and debugging.
.SS "Input Packet Selection"
.IX Subsection "Input Packet Selection"
These options determine the packets that will be selected by \fBdnspktflow\fR.
.IP "\-i STRING" 4
.IX Item "-i STRING"
.PD 0
.IP \-\-ignore\-hosts=STRING 4
.IX Item "--ignore-hosts=STRING"
.PD
A regular expression of host names to ignore in the query/response fields.
.IP "\-r STRING" 4
.IX Item "-r STRING"
.PD 0
.IP \-\-only\-hosts=STRING 4
.IX Item "--only-hosts=STRING"
.PD
A regular expression of host names to analyze in the query/response fields.
.IP \-f 4
.IX Item "-f"
.PD 0
.IP \-\-show\-frame\-num 4
.IX Item "--show-frame-num"
.PD
Display the packet frame numbers.
.IP "\-b INTEGER" 4
.IX Item "-b INTEGER"
.PD 0
.IP \-\-begin\-frame=INTEGER 4
.IX Item "--begin-frame=INTEGER"
.PD
Begin at packet frame NUMBER.
.SS "Output File Options"
.IX Subsection "Output File Options"
These options determine the type and location of \fBdnspktflow\fR's output.
.IP "\-o STRING" 4
.IX Item "-o STRING"
.PD 0
.IP \-\-output\-file=STRING 4
.IX Item "--output-file=STRING"
.PD
Output file name (default: out%03d.png as PNG format.)
.IP \-\-fig 4
.IX Item "--fig"
Output format should be fig.
.IP "\-O STRING" 4
.IX Item "-O STRING"
.PD 0
.IP \-\-tshark\-out=STRING 4
.IX Item "--tshark-out=STRING"
.PD
Save \fBtshark\fR output to this file.
.IP \-m 4
.IX Item "-m"
.PD 0
.IP \-\-multiple\-outputs 4
.IX Item "--multiple-outputs"
.PD
One picture per request (use \f(CW%03d\fR in the filename.)
.IP "\-M STRING" 4
.IX Item "-M STRING"
.PD 0
.IP \-\-magic\-point=STRING 4
.IX Item "--magic-point=STRING"
.PD
Saves a MagicPoint presentation for the output.
.SS "Output Visualization Options:"
.IX Subsection "Output Visualization Options:"
These options determine specifics of \fBdnspktflow\fR's output.
.IP \-\-layout\-style 4
.IX Item "--layout-style"
Selects the graphviz layout style to use (dot, neato, twopi, circo, or fdp).
.IP \-L 4
.IX Item "-L"
.PD 0
.IP \-\-last\-line\-labels\-only 4
.IX Item "--last-line-labels-only"
.PD
Only show data on the last line drawn.
.IP "\-z INTEGER" 4
.IX Item "-z INTEGER"
.PD 0
.IP \-\-most\-lines=INTEGER 4
.IX Item "--most-lines=INTEGER"
.PD
Only show at most INTEGER connections.
.IP \-T 4
.IX Item "-T"
.PD 0
.IP \-\-input\-is\-tshark\-out 4
.IX Item "--input-is-tshark-out"
.PD
The input file is already processed by \fBtshark\fR.
.SS "Graphical Options:"
.IX Subsection "Graphical Options:"
These options determine fields included in \fBdnspktflow\fR's output.
.IP \-t 4
.IX Item "-t"
.PD 0
.IP \-\-show\-type 4
.IX Item "--show-type"
.PD
Shows message type in result image.
.IP \-q 4
.IX Item "-q"
.PD 0
.IP \-\-show\-queries 4
.IX Item "--show-queries"
.PD
Shows query questions in result image.
.IP \-a 4
.IX Item "-a"
.PD 0
.IP \-\-show\-answers 4
.IX Item "--show-answers"
.PD
Shows query answers in result image.
.IP \-A 4
.IX Item "-A"
.PD 0
.IP \-\-show\-authoritative 4
.IX Item "--show-authoritative"
.PD
Shows authoritative information in result image.
.IP \-x 4
.IX Item "-x"
.PD 0
.IP \-\-show\-additional 4
.IX Item "--show-additional"
.PD
Shows additional information in result image.
.IP \-l 4
.IX Item "-l"
.PD 0
.IP \-\-show\-label\-lines 4
.IX Item "--show-label-lines"
.PD
Shows lines attaching labels to lines.
.IP \-\-fontsize=INTEGER 4
.IX Item "--fontsize=INTEGER"
Font Size
.SS Debugging:
.IX Subsection "Debugging:"
These options may assist in debugging \fBdnspktflow\fR.
.IP \-d 4
.IX Item "-d"
.PD 0
.IP \-\-dump\-pkts 4
.IX Item "--dump-pkts"
.PD
Dump data collected from the packets.
.IP \-h 4
.IX Item "-h"
.PD 0
.IP \-\-help 4
.IX Item "--help"
.PD
Show help for command line options.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2004\-2013 SPARTA, Inc.  All rights reserved.
See the COPYING file included with the DNSSEC-Tools package for details.
.SH AUTHOR
.IX Header "AUTHOR"
Wes Hardaker <hardaker@users.sourceforge.net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBGetopt::GUI::Long\|(3)\fR
\&\fBNet::DNS\|(3)\fR
\&\fBQWizard.pm\|(3)\fR
.PP
http://dnssec\-tools.sourceforge.net/