From: Petr Menšík <pemensik@redhat.com>
Date: Mon, 18 Nov 2019 21:19:21 +0000 (+0100)
Subject: Document return codes of dig
X-Git-Tag: v9.17.18~38^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=f20cc30a6af045c0fe1c0b9499d4501678d0f306;p=thirdparty%2Fbind9.git

Document return codes of dig

The dig tool reports some states as exit status. Document them briefly
in the manual page.
---

diff --git a/bin/dig/dig.rst b/bin/dig/dig.rst
index b54d22ef5c4..93c0b26c43a 100644
--- a/bin/dig/dig.rst
+++ b/bin/dig/dig.rst
@@ -647,6 +647,26 @@ To turn off IDN support, use the parameters
 ``+noidnin`` and ``+noidnout``, or define the ``IDN_DISABLE`` environment
 variable.
 
+Return Codes
+~~~~~~~~~~~~
+
+``dig`` return codes are:
+
+``0``
+   DNS response received, including NXDOMAIN status
+
+``1``
+   Usage error
+
+``8``
+   Couldn't open batch file
+
+``9``
+   No reply from server
+
+``10``
+   Internal error
+
 Files
 ~~~~~
 
diff --git a/doc/man/dig.1in b/doc/man/dig.1in
index bc42c4d5436..10d7a449118 100644
--- a/doc/man/dig.1in
+++ b/doc/man/dig.1in
@@ -661,6 +661,26 @@ a request to a DNS server or displaying a reply from the server.
 To turn off IDN support, use the parameters
 \fB+noidnin\fP and \fB+noidnout\fP, or define the \fBIDN_DISABLE\fP environment
 variable.
+.SH RETURN CODES
+.sp
+\fBdig\fP return codes are:
+.INDENT 0.0
+.TP
+.B \fB0\fP
+DNS response received, including NXDOMAIN status
+.TP
+.B \fB1\fP
+Usage error
+.TP
+.B \fB8\fP
+Couldn\(aqt open batch file
+.TP
+.B \fB9\fP
+No reply from server
+.TP
+.B \fB10\fP
+Internal error
+.UNINDENT
 .SH FILES
 .sp
 \fB/etc/resolv.conf\fP