doc: add man page for sojuctl

This commit is contained in:
Simon Ser 2023-03-15 18:34:50 +01:00
parent 4c8e955946
commit c183d938ff
2 changed files with 41 additions and 2 deletions

View File

@ -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

36
doc/sojuctl.1.scd Normal file
View File

@ -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)