From 1407aedf1f1ea42d808d99875fc5a39b74b537be Mon Sep 17 00:00:00 2001
From: Michael Meeks <michael.meeks@collabora.com>
Date: Wed, 31 Aug 2022 20:39:09 +0100
Subject: [PATCH] coolstress: add man-page, cleanup somewhat and document a
 little.

Change-Id: I57b6bb7bde6e0fa8ffd9a08cf5b9d8c8b4759bf2
Signed-off-by: Michael Meeks <michael.meeks@collabora.com>
---
 Makefile.am      |  3 ++-
 man/coolstress.1 | 39 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 man/coolstress.1

diff --git a/Makefile.am b/Makefile.am
index e1e6730fd3..4111f562c6 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -17,6 +17,7 @@ export ENABLE_DEBUG
 bin_PROGRAMS = \
 	coolforkit \
 	coolmount \
+        coolstress \
 	coolconvert coolconfig
 
 if ENABLE_LIBFUZZER
@@ -31,6 +32,7 @@ man_MANS = man/coolwsd.1 \
            man/coolforkit.1 \
            man/coolconvert.1 \
            man/coolconfig.1 \
+           man/coolstress.1 \
            man/coolwsd-systemplate-setup.1 \
            man/coolwsd-generate-proof-key.1 \
            man/coolmount.1
@@ -144,7 +146,6 @@ noinst_PROGRAMS = clientnb \
                   connect \
                   lokitclient \
                   coolmap \
-                  coolstress \
                   coolsocketdump
 
 if ENABLE_LIBFUZZER
diff --git a/man/coolstress.1 b/man/coolstress.1
new file mode 100644
index 0000000000..93b154433f
--- /dev/null
+++ b/man/coolstress.1
@@ -0,0 +1,39 @@
+.TH COOLSTRESS "1" "Aug 2022" "coolstress" "User Commands"
+.SH NAME
+coolstress \- stress testing tool for Collabora Online.
+.SH SYNOPSIS
+coolstress [OPTIONS] SERVER PATH1 TRACE1 ...
+.SH DESCRIPTION
+.PP
+Re-play trace files, either gzip compressed or verbatim against
+a given server URL to simulate load against the server. A single
+coolstress command can easily replay many concurrent traces.
+.PP
+If the same PATH is provided for multiple traces, then these are
+both executed against the same document.
+.SH COMMANDS AND OPTIONS
+.PP
+.SS "General options:"
+\fB\-h\fR, \fB\-\-help\fR                Show this usage information.
+.SS "SERVER"
+The server parameter points to a websocket end-point that would be
+used by Collabora Online to drive a document editing session.
+.PP
+\fBExample:\fR coolstress wss://localhost:9980 /tmp/test.odt test/traces/hello-world.txt
+.SS "Generating traces"
+To generate a trace, set the following settings to these values in:
+\fBcoolwsd.xml\fR: \fBtrace\fR true, \fBtrace.path\fR /tmp/trace.txt.gz
+.PP
+Re-start coolwsd, edit some documents and then load and
+edit a document, after terminating coolwsd it should save a trace.
+.PP
+If passing extra parameters to coolwsd pass: --o:trace[@enable]=true --o:trace.path=/tmp/trace.txt.gz.
+.PP
+.SH "NOTE"
+Please note that recording traces generated by mashing the keyboard rapidly creates a pathologically
+unrealistic profile that is 10x faster than the average typer, and 5x worse then a professional typist
+in terms of keys-per-second, as well as creating unusual documents from a spell/grammar checking
+perspective.
+
+.SH "SEE ALSO"
+coolforkit(1), coolconvert(1), coolwsd(1)