Implement use flags for subcommants

Optimize synapse pipeline

1 files changed, 67 insertions, 0 deletions

diff --git a/wh.1 b/wh.1
new file mode 100644
index 0000000..8a6230f
--- /dev/null
+++ b/wh.1
@@ -0,0 +1,67 @@
+.\" Manpage for whiterabbit
+.TH WHITERABBIT 1 "2025-09-25" "1.0.0" "whiterabbit manual"
+.SH NAME
+whiterabbit \- auto-configure Matrix homeservers (Dendrite or Synapse)
+.SH SYNOPSIS
+.B whiterabbit
+[\fIturn\fR|\fIdendrite\fR|\fIsynapse\fR|\fIlist\fR|\fIremove <domain>\fR|
+\fI-t\fR|\fI-d\fR|\fI-s\fR|\fI-l\fR|\fI-r <domain>\fR]
+.SH DESCRIPTION
+whiterabbit sets up Matrix homeservers with a global Coturn server and Nginx/Let's Encrypt support.
+
+Main commands and their short flag equivalents:
+.TP
+.B turn, -t
+Install or configure the global Coturn server.
+.TP
+.B dendrite, -d
+Add a new Matrix Dendrite server.
+.TP
+.B synapse, -s
+Add a new Matrix Synapse server.
+.TP
+.B list, -l
+List all configured Matrix servers.
+.TP
+.B remove <domain>, -r <domain>
+Remove a Matrix server by domain.
+
+.SH EXAMPLES
+.TP
+whiterabbit turn
+Set up the global Coturn server.
+.TP
+whiterabbit -t
+Same as above using flag.
+.TP
+whiterabbit dendrite
+Add a Dendrite server with TLS and Nginx.
+.TP
+whiterabbit -d
+Same as above using flag.
+.TP
+whiterabbit synapse
+Add a Synapse server with TLS and Nginx.
+.TP
+whiterabbit -s
+Same as above using flag.
+.TP
+whiterabbit list
+Show all servers.
+.TP
+whiterabbit -l
+Same as above using flag.
+.TP
+whiterabbit remove matrix.example.com
+Remove a server.
+.TP
+whiterabbit -r matrix.example.com
+Same as above using flag.
+
+.SH NOTES
+All Matrix servers share the same Coturn instance.
+TLS certificates are issued automatically via Let's Encrypt.
+Requires docker, docker-compose, nginx, certbot, and coturn.
+
+.SH AUTHOR
+Filip Wandzio <contact@philw.dev>