commit 81f6fe189ebf440b19b3a31b99c628a4813929dd
parent 37cd24103a4af78555a69b61c41c0250928140c4
Author: Nibo <kroekerrobin@gmail.com>
Date: Mon, 13 Nov 2023 16:05:53 +0100
Add some documentation
Diffstat:
1 file changed, 11 insertions(+), 13 deletions(-)
diff --git a/dinoco.1 b/dinoco.1
@@ -3,19 +3,15 @@
dinoco - Query DNS records
.SH SYNOPSIS
.B dinoco
-.B -d
-\fI\,domain\/\fR
.B -t
\fI\,type\/\fR
+\fI\,domain\/\fR
[
.B -h
]
.SH DESCRIPTION
.PP
-Query a DNS record or possibly multiple records. The DNS class will always be IN (the Internet). Only the RDATA field of the answer will be printed to stdout according to the DNS type.
-.TP
-\fB\,-d\/\fR, \fB\,--domain\/\fR \fI\,domain\/\fR
-A domain.
+Query a DNS record or possibly multiple records. The DNS class will always be IN (the Internet). Only the RDATA field of the answer will be printed to stdout according to the DNS type. \fI\,domain\/\fR represents a domain except in the case of the \fB\,--type\/\fR PTR. In that case you provide an IP address.
.TP
\fB\,-t\/\fR, \fB\,--type\/\fR \fI\,type\/\fR
A DNS type. One of the following:
@@ -29,21 +25,23 @@ A DNS type. One of the following:
.B MX,
.B TXT.
-Not (yet) supported types: WKS, MB, MD, MF, MG, MR, MINFO, NULL.
+Not supported types: WKS, MB, MD, MF, MG, MR, MINFO, NULL.
.TP
\fB\,-h\/\fR
Disable the printing of the header line.
.SH EXAMPLES
.EX
-$ dinoco -d blubiblub.org -t MX
+\fB\,$\/\fR dinoco -d blubiblub.org -t MX
Mail Exchange Preference
mail.blubiblub.org 10
-$
-$ dinoco -d blubiblub.org -t A
+\fB\,$\/\fR
+\fB\,$\/\fR dinoco -d blubiblub.org -t A
Address
221.180.67.12
-$
-$ dinoco -d honkaponka.org -t MX -h
+\fB\,$\/\fR
+\fB\,$\/\fR dinoco -d honkaponka.org -t MX -h
mail.honkaponla.org 10
alt1.mail.honkaponla.org 20
-$
+\fB\,$\/\fR
+.SH NOTES
+This program is solely based on RFC 1035 and isn't tested enough to be called stable.