From: Michael Orlitzky <michael@orlitzky.com>
Date: Tue, 20 Sep 2022 00:32:58 +0000 (-0400)
Subject: doc/man1/djbdns-logparse.1: utilize some fancy groff_man macros.
X-Git-Tag: 0.0.1~20
X-Git-Url: https://gitweb.michael.orlitzky.com/?a=commitdiff_plain;h=1351de7cf50709c787e111e2c635d46f714858f0;p=djbdns-logparse.git

doc/man1/djbdns-logparse.1: utilize some fancy groff_man macros.
---

diff --git a/doc/man1/djbdns-logparse.1 b/doc/man1/djbdns-logparse.1
index fbd4da0..942d8ab 100644
--- a/doc/man1/djbdns-logparse.1
+++ b/doc/man1/djbdns-logparse.1
@@ -3,8 +3,16 @@
 .SH NAME
 djbdns-logparse \- Convert tinydns and dnscache logs to human-readable form
 .SH SYNOPSIS
+.SY djbdns-logparse
+.OP LOGFILE ...
+.YS
+
+.SY djbdns-logparse
+.B \-h
+.SY djbdns-logparse
+.B \-\-help
+.YS
 
-\fBdjbdns-logparse\fR [\fBLOGFILE\fR [\fBLOGFILE\fR...]]
 .SH INPUT
 .P
 Each \fILOGFILE\fR should be a tinydns or dnscache log file; if none
@@ -19,7 +27,7 @@ them human-readable with a minimal amount of interference.
 .P
 Reading the current dnscache log from stdin:
 
-.nf
+.EX
 .I $ djbdns-logparse < /var/dnscache/log/main/current
 2022-09-19 10:47:12.953666500 starting
 2022-09-19 10:47:33.084125500 query #1 127.0.0.1:44339 (id 9929) a www.example.com.
@@ -33,13 +41,28 @@ Reading the current dnscache log from stdin:
 2022-09-19 10:47:37.931255500 rr 192.168.1.1 TTL=86400 txt www.example.com. 32:"wgyf8z8cgvm2qmxpnbnldrcltvk4xqf..."
 2022-09-19 10:47:37.931297500 stats count=2 motion=131 udp-active=1 tcp-active=0
 2022-09-19 10:47:37.931332500 sent #2 102
-.fi
+.EE
 .SH OPTIONS
 
-.IP \fB\-\-help\fR,\ \fB\-h\fR
+.TP
+.B \-\-help, \-h
 Display detailed program usage.
 .SH TRANSFORMATIONS
 
+A number of transformations are applied to the raw logs. Some are
+specific to tinydns, others are specific to dnscache, and some apply
+to both. In explaining these, we borrow terminology from the following:
+
+.IP \(bu 2
+.UR https://www.dqd.com/~mayoff/notes/djbdns/tinydns-log.html
+Rob Mayoff's notes on the tinydns log file format
+.UE
+.IP \(bu
+.UR https://www.dqd.com/~mayoff/notes/djbdns/dnscache-log.html
+Rob Mayoff's notes on the dnscache log file format
+.UE
+
+.P
 The following transformations are common to  both daemons' logs:
 .IP \(bu 2
 The leading timestamps are piped through the
@@ -62,4 +85,7 @@ as in https://en.wikipedia.org/wiki/List_of_DNS_record_types
 
 .SH BUGS
 
-Send bugs to michael@orlitzky.com.
+Send bugs to
+.MT michael@orlitzky.com
+Michael Orlitzky
+.ME