From: Jan Hak <jan.hak@nic.cz>
Date: Mon, 9 Aug 2021 12:33:56 +0000 (+0200)
Subject: doc: add TCP option into kxdpgun doc
X-Git-Tag: v3.1.1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7c368ee11d146a6ef5c165550b877ea8439a9864;p=thirdparty%2Fknot-dns.git

doc: add TCP option into kxdpgun doc
---

diff --git a/doc/man/kxdpgun.8in b/doc/man/kxdpgun.8in
index c916fb36ef..c6cec46cd3 100644
--- a/doc/man/kxdpgun.8in
+++ b/doc/man/kxdpgun.8in
@@ -51,6 +51,9 @@ configured for the network interface.
 Duration of traffic generation, specified as a decimal number in seconds
 (default is 5.0).
 .TP
+\fB\-T\fP, \fB\-\-tcp\fP
+Send queries over TCP.
+.TP
 \fB\-Q\fP, \fB\-\-qps\fP \fIqueries\fP
 Number of queries\-per\-second (approximately) to be sent (default is 1000).
 The program is not optimized for low speeds at which it may lose
@@ -151,23 +154,37 @@ cat ZONE_FILE | awk "{print \e$1,\e$3}" | grep \-E "(NS|DS|A|AAAA|PTR|MX|SOA)$"
 .UNINDENT
 .UNINDENT
 .sp
-Program usage:
+Basic usage:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# kxdpgun \-i ~/queries.txt 2001:DB8::1
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fIUsing UDP with increased batch size\fP:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-# kxdpgun \-i ~/queries.txt 2001:1489:fffe:10::16
+# kxdpgun \-t 20 \-Q 1000000 \-i ~/queries.txt \-b 20 \-p 8853 192.0.2.1
 .ft P
 .fi
 .UNINDENT
 .UNINDENT
+.sp
+\fIUsing TCP\fP:
 .INDENT 0.0
 .INDENT 3.5
 .sp
 .nf
 .ft C
-# kxdpgun \-t 120 \-Q 6000000 \-i ~/queries.txt \-b 5 \-r \-p 8853 192.168.101.2
+# kxdpgun \-t 20 \-Q 100000 \-i ~/queries.txt \-T \-p 8853 192.0.2.1
 .ft P
 .fi
 .UNINDENT
diff --git a/doc/man_kxdpgun.rst b/doc/man_kxdpgun.rst
index 1d1b7e7631..fd2eccbe6c 100644
--- a/doc/man_kxdpgun.rst
+++ b/doc/man_kxdpgun.rst
@@ -28,6 +28,9 @@ Options
   Duration of traffic generation, specified as a decimal number in seconds
   (default is 5.0).
 
+**-T**, **--tcp**
+  Send queries over TCP.
+
 **-Q**, **--qps** *queries*
   Number of queries-per-second (approximately) to be sent (default is 1000).
   The program is not optimized for low speeds at which it may lose
@@ -119,13 +122,17 @@ Queries file generated from a zone file (Knot DNS format)::
 
   cat ZONE_FILE | awk "{print \$1,\$3}" | grep -E "(NS|DS|A|AAAA|PTR|MX|SOA)$" | sort -u -R > queries.txt
 
-Program usage::
+Basic usage::
+
+  # kxdpgun -i ~/queries.txt 2001:DB8::1
+
+*Using UDP with increased batch size*::
 
-  # kxdpgun -i ~/queries.txt 2001:1489:fffe:10::16
+  # kxdpgun -t 20 -Q 1000000 -i ~/queries.txt -b 20 -p 8853 192.0.2.1
 
-::
+*Using TCP*::
 
-  # kxdpgun -t 120 -Q 6000000 -i ~/queries.txt -b 5 -r -p 8853 192.168.101.2
+  # kxdpgun -t 20 -Q 100000 -i ~/queries.txt -T -p 8853 192.0.2.1
 
 See Also
 --------