From c183d938ff511ef7a47e76cd233e20dbdbf6b380 Mon Sep 17 00:00:00 2001
From: Simon Ser <contact@emersion.fr>
Date: Wed, 15 Mar 2023 18:34:50 +0100
Subject: [PATCH] doc: add man page for sojuctl

---
 Makefile          |  7 +++++--
 doc/sojuctl.1.scd | 36 ++++++++++++++++++++++++++++++++++++
 2 files changed, 41 insertions(+), 2 deletions(-)
 create mode 100644 doc/sojuctl.1.scd

diff --git a/Makefile b/Makefile
index 4cdb496..24146c7 100644
--- a/Makefile
+++ b/Makefile
@@ -14,14 +14,17 @@ admin_socket_path := $(RUNDIR)/soju/admin
 goflags := $(GOFLAGS) -ldflags=" \
 	-X 'git.sr.ht/~emersion/soju/config.DefaultPath=$(config_path)' \
 	-X 'git.sr.ht/~emersion/soju/config.DefaultUnixAdminPath=$(admin_socket_path)'"
+man_pages := doc/soju.1 doc/sojuctl.1
 
-all: soju sojudb sojuctl doc/soju.1
+all: soju sojudb sojuctl $(man_pages)
 
 soju:
 	$(GO) build $(goflags) -o . ./cmd/soju ./cmd/sojudb ./cmd/sojuctl
 sojudb sojuctl: soju
 doc/soju.1: doc/soju.1.scd
 	$(SCDOC) <doc/soju.1.scd >doc/soju.1
+doc/sojuctl.1: doc/sojuctl.1.scd
+	$(SCDOC) <doc/sojuctl.1.scd >doc/sojuctl.1
 
 clean:
 	$(RM) -f soju sojudb sojuctl doc/soju.1
@@ -31,7 +34,7 @@ install:
 	mkdir -p $(DESTDIR)$(SYSCONFDIR)/soju
 	mkdir -p $(DESTDIR)$(sharedstatedir)/soju
 	cp -f soju sojudb sojuctl $(DESTDIR)$(PREFIX)/$(BINDIR)
-	cp -f doc/soju.1 $(DESTDIR)$(PREFIX)/$(MANDIR)/man1
+	cp -f $(man_pages) $(DESTDIR)$(PREFIX)/$(MANDIR)/man1
 	[ -f $(DESTDIR)$(config_path) ] || cp -f config.in $(DESTDIR)$(config_path)
 
 .PHONY: soju sojudb sojuctl clean install
diff --git a/doc/sojuctl.1.scd b/doc/sojuctl.1.scd
new file mode 100644
index 0000000..735188c
--- /dev/null
+++ b/doc/sojuctl.1.scd
@@ -0,0 +1,36 @@
+sojuctl(1)
+
+# NAME
+
+sojuctl - Manage a running instance of the soju IRC bouncer
+
+# SYNOPSIS
+
+*sojuctl* [options...] <command...>
+
+# DESCRIPTION
+
+sojuctl sends a _BouncerServ_ command to a running soju instance. See the
+_IRC SERVICE_ section in *soju*(1) for more information.
+
+sojuctl requires a _listen unix+admin://_ directive in the soju configuration
+file. sojuctl needs to be run with write permissions on the soju admin socket.
+
+# OPTIONS
+
+*-h, -help*
+	Show help message and quit.
+
+*-config* <path>
+	Path to the config file. If unset, the default config file path is used,
+	if any.
+
+# AUTHORS
+
+Maintained by Simon Ser <contact@emersion.fr>, who is assisted by other
+open-source contributors. For more information about soju development, see
+<https://sr.ht/~emersion/soju>.
+
+# SEE ALSO
+
+*soju*(1)