Changeset 765 in code for trunk/contrib

Timestamp:

Jan 13, 2022, 3:06:54 PM (3 years ago)

Author:

theo

Message:

contrib/clients: Add information about emacs irc clients

File:

• trunk/contrib/clients.md (modified) (2 diffs)

trunk/contrib/clients.md

@@ -4 +4 @@
 
 Also see the [IRCv3 support tables] for a more general list of clients.
+
+# [Emacs]
+
+There are two clients provided with Emacs. They require some setup to work
+properly.
+
+## Erc
+
+You need to explicitly set the username, which is the defcustom
+`erc-email-userid`.
+
+```elisp
+(setq erc-email-userid "<username>/irc.libera.chat") ;; Example with Libera.Chat
+(defun run-erc ()
+  (interactive)
+  (erc-tls :server "<server>"
+           :port 6697
+           :nick "<nick>"
+           :password "<password>"))
+```
+
+Then run `M-x run-erc`.
+
+## Rcirc
+
+The only thing needed here is the general config:
+
+```elisp
+(setq rcirc-server-alist
+      '(("<server>"
+         :port 6697
+         :encryption tls
+         :nick "<nick>"
+         :user-name "<username>/irc.libera.chat" ;; Example with Libera.Chat
+         :password "<password>")))
+```
+
+Then run `M-x irc`.
 
 # [gamja]
@@ -46 +84 @@
 [Weechat script]: https://github.com/weechat/scripts/blob/master/python/soju.py
 [Hexchat]: https://hexchat.github.io/
+[Emacs]: https://www.gnu.org/software/emacs/