From 0007fba1a0c44eeb1025ec9332bd30d598675163 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 17 Feb 2026 17:07:15 -0500 Subject: [PATCH] doc/README: convert to reStructuredText --- doc/README | 68 ------------------------------------------------- doc/README.rst | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+), 68 deletions(-) delete mode 100644 doc/README create mode 100644 doc/README.rst diff --git a/doc/README b/doc/README deleted file mode 100644 index 1295d3a..0000000 --- a/doc/README +++ /dev/null @@ -1,68 +0,0 @@ -djbdns-logparse: make tinydns and dnscache logs human-readable - -== What is it? == - -djbdns is Daniel J. Bernstein's suite of DNS software from, - - https://cr.yp.to/djbdns.html - -Two of its daemons, tinydns and dnscache, resolve DNS queries while -simultaneously logging obscure gibberish to a file. For example, this -is what tinydns logs if I request the 'A' record for www.example.com: - - @4000000063227a320c4f3114 7f000001:9d61:be69 - 0001 www.example.com - -djbdns-logparse converts these into something that you can actually -read. The line above gets turned into, - - 2022-09-14 21:04:40.206516500 dropped query (no authority) from - 127.0.0.1:40289 (id 48745): a www.example.com - -and surely you agree that this is preferable. - - -== Usage == - -Either, - - $ djbdns-logparse < logfile - -or - - $ djbdns-logparse log1 [log2 [log3 ...]] - - -== Requirements == - -There are only two: - - a) python-3.6 or later, for f-strings support - b) the tai64nlocal program from DJB's daemontools on your PATH - - -== History == - -This is a modernish fork of Greg Ward's parse_djbdns_log program -from, - - https://www.gerg.ca/hacks/parse_djbdns_log - -The original was inspired by Faried Nawaz's dnscache log parser, - - http://www.hungry.com/~fn/dnscache-log.pl.txt - -with heavy assistance from Rob Mayoff's documentation: - - * https://www.dqd.com/~mayoff/notes/djbdns/tinydns-log.html - * https://www.dqd.com/~mayoff/notes/djbdns/dnscache-log.html - - -== Tests == - -The (doctest) test suite can be run manually, - - $ python -m doctest -v djbdns/*.py - -Or with tox: - - $ tox diff --git a/doc/README.rst b/doc/README.rst new file mode 100644 index 0000000..a2afa9d --- /dev/null +++ b/doc/README.rst @@ -0,0 +1,69 @@ +djbdns-logparse: make tinydns and dnscache logs human-readable + +What is it? +=========== + +`djbdns `_ is Daniel J. Bernstein's +suite of DNS software. + +Two of its daemons, tinydns and dnscache, resolve DNS queries while +simultaneously logging obscure gibberish to a file. For example, this +is what tinydns logs if I request the ``A`` record for www.example.com:: + + @4000000063227a320c4f3114 7f000001:9d61:be69 - 0001 www.example.com + +djbdns-logparse converts these into something that you can actually +read. The line above gets turned into:: + + 2022-09-14 21:04:40.206516500 dropped query (no authority) from + 127.0.0.1:40289 (id 48745): a www.example.com + +and surely you agree that this is preferable. + + +Usage +===== + +Either, + +.. code-block:: console + + $ djbdns-logparse < logfile + +or + +.. code-block:: console + + $ djbdns-logparse log1 [log2 [log3 ...]] + + +Requirements +============ + +There are only two: + +#. python-3.6 or later, for f-strings support +#. the tai64nlocal program from DJB's daemontools on your ``PATH`` + + +History +======= + +This is a modernish fork of Greg Ward's `parse_djbdns_log +`_ program. The original +was inspired by Faried Nawaz's `dnscache log parser +`_ with heavy +assistance from Rob Mayoff's documentation: + +* https://www.dqd.com/~mayoff/notes/djbdns/tinydns-log.html +* https://www.dqd.com/~mayoff/notes/djbdns/dnscache-log.html + + +Tests +===== + +The (doctest) test suite can be run manually, + +.. code-block:: console + + $ python -m doctest -v djbdns/*.py -- 2.51.0