From: Michael Tremer <michael.tremer@ipfire.org>
Date: Tue, 2 Feb 2021 18:49:59 +0000 (+0000)
Subject: man: Add fireperf.8
X-Git-Tag: 0.1.0~17
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=47fd5a8a929c263839fd09211daee5791ec36453;p=fireperf.git

man: Add fireperf.8

Signed-off-by: Michael Tremer <michael.tremer@ipfire.org>
---

diff --git a/Makefile.am b/Makefile.am
index 4956875..c309678 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -71,7 +71,8 @@ fireperf_SOURCES = \
 
 # ------------------------------------------------------------------------------
 
-MANPAGES =
+MANPAGES = \
+	man/fireperf.8
 
 MANPAGES_TXT  = $(patsubst %.8,%.txt,$(MANPAGES))
 MANPAGES_HTML = $(patsubst %.txt,%.html,$(MANPAGES_TXT))
diff --git a/man/.gitignore b/man/.gitignore
new file mode 100644
index 0000000..f891826
--- /dev/null
+++ b/man/.gitignore
@@ -0,0 +1,3 @@
+/*.[13578]
+/*.html
+/*.xml
diff --git a/man/asciidoc.conf b/man/asciidoc.conf
new file mode 100644
index 0000000..243f81f
--- /dev/null
+++ b/man/asciidoc.conf
@@ -0,0 +1,12 @@
+ifdef::backend-docbook[]
+[link-inlinemacro]
+{0%{target}}
+{0#<citerefentry>}
+{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
+{0#</citerefentry>}
+endif::backend-docbook[]
+
+ifdef::backend-html5[]
+[link-inlinemacro]
+<a href="{target}.html">{target}{0?({0})}</a>
+endif::backend-html5[]
diff --git a/man/fireperf.txt b/man/fireperf.txt
new file mode 100644
index 0000000..bbe69dc
--- /dev/null
+++ b/man/fireperf.txt
@@ -0,0 +1,90 @@
+= fireperf(8)
+
+== NAME
+fireperf - A Network Benchmarking Tool
+
+== SYNOPSIS
+[verse]
+`fireperf --server ...`
+`fireperf --client ADDRESS ...`
+
+== DESCRIPTION
+`fireperf` can perform network benchmarks to test throughput and quality of
+a network between a fireperf client and fireperf server.
+
+
+== COMMON OPTIONS
+
+-d::
+	Enables debugging output
+	+
+	If `fireperf` has been compiled with debugging support, this command will print
+	various debug messages that will help to find bugs in the program.
+
+--parallel=N::
+-P N::
+	If this option is set on the client side, it will instruct the client to open N
+	connections and keep them open.
+	+
+	On the server side, it will set a limit how many connections the server is willing
+	to accept.
+
+--port=N::
+-p N::
+--port=N:M::
+-p N:M::
+	Both server and client take a single port (N) or a port range (N:M).
+	+
+	The server will open a listening socket the port given or each port in the range
+	and waits for the client to connect.
+	+
+	The client will for each connection randomly select a port in the range or use the
+	specified port to connect to the server.
+
+--version::
+-V::
+	Prints the version of this program
+
+
+== SERVER-SPECIFIC OPTIONS
+
+--server::
+-s::
+	This starts the program in server mode which makes it connect to the specified
+	port and waits for clients to connect.
+
+
+== CLIENT-SPECIFIC OPTIONS
+
+--client ADDRESS::
+-c ADDRESS::
+	This starts the program in client mode. In this mode, the client will connect to
+	the server at ADDRESS and start a throughput test.
+
+--keepalive::
+-k::
+	Instead of sending data to the server, this will configure the client to only
+	send keepalive packets.
+	+
+	If a large number of connections is being created, it might become undesirable to
+	saturate the link between client and server. This option will send some packets to
+	keep the connection alive through for example NAT gateways.
+
+--timeout=T::
+-t T::
+	If set, the client will automatically terminate itself after T seconds.
+	Otherwise it will run for forever.
+
+--zero::
+-z::
+	Instead of sending random data, this option will set the client to send packets
+	filled with zeroes.
+	+
+	This is useful for testing compression between the client and server.
+
+
+== BUGS
+Please report all bugs to the bugtracker at https://bugzilla.ipfire.org/
+
+== AUTHORS
+Michael Tremer