[PATCH] docs: Add 'Configuration concepts' to 'IRC Clients configuration'

This thread contains a patchset. You're looking at the original emails, but you may wish to use the patch review UI. Review patch

[PATCH] docs: Add 'Configuration concepts' to 'IRC Clients configuration'

Peter Marinov <pem@bbox3.com>

Details

Message ID: <20230911234302.55005-1-pem@bbox3.com>
DKIM signature: missing

Download raw message

1 year, 4 months ago

Patch: +23 -0

* Explain how bouncers are instructed to connect to IRC servers
---
 README.md          |  2 ++
 contrib/clients.md | 21 +++++++++++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/README.md b/README.md
index c41a949..276ec54 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ detached channels. It is well-suited for both small and large deployments.
 
 * [Getting started]
 * [Man page]
+* [Configure IRC Clients]
 
 ## Building and installing
 
@@ -47,6 +48,7 @@ Copyright (C) 2020 The soju Contributors
 [soju]: https://soju.im
 [Getting started]: doc/getting-started.md
 [Man page]: https://soju.im/doc/soju.1.html
+[Configure IRC Clients]: contrib/clients.md
 [mailing list]: https://lists.sr.ht/~emersion/soju-dev
 [GitHub]: https://github.com/emersion/soju
 [issue tracker]: https://todo.sr.ht/~emersion/soju
diff --git a/contrib/clients.md b/contrib/clients.md
index fc35e56..8e75ec3 100644
--- a/contrib/clients.md
+++ b/contrib/clients.md
@@ -4,6 +4,27 @@ This page describes how to configure IRC clients to better integrate with soju.
 
 Also see the [IRCv3 support tables] for a more general list of clients.
 
+# Configuration concepts
+
+If you use a client that supports bouncers the configuration is
+similar to any IRC server, only that you connect to the bouncer and
+pass instructions to what IRC server you want it to connect you to.
+
+For example, you are "chatter" and you want to connect to
+irc.libera.chat and as a bouncer you use chat.sr.ht -- your
+configuration is, `server: chat.sr.ht`, `user-name:
+chatter/irc.libera.chat`.
+
+# Bouncer commands
+
+Communication with the bouncer is via commands such as `/msg
+BouncerServ help network`, output handling depends on the client.
+
+For example, in *rirc* this will open a new chat room buffer. If you
+are using chat.sr.ht as a bouncer then look for buffer named
+*BouncerServ@chat.sr.ht*. Commands might be entered from any chat
+room, but the result is always in the devoted bouncer buffer.
+
 # catgirl
 
 catgirl doesn't implement cap-3.2, so many capabilities will be disabled.
-- 
2.25.1