Allow to override the addresses used to connect to an IRC network

fix #3273

1 files changed, 11 insertions, 0 deletions

diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst
index 2d83dfe..3cb379b 100644
--- a/doc/biboumi.1.rst
+++ b/doc/biboumi.1.rst
@@ -621,6 +621,17 @@ On a server JID (e.g on the JID chat.freenode.org@biboumi.example.com)
 - configure: Lets each user configure some options that applies to the
   concerned IRC server.  The provided configuration form contains these
   fields:
+
+    * Address: This address (IPv4, IPv6 or hostname) will be used, when
+      biboumi connects to this server. This is a very handy way to have a
+      custom name for a network, and be able to edit the address to use
+      if one endpoint for that server is dead, but continue using the same
+      JID. For example, a user could configure the server
+      “freenode@biboumi.example.com”, set “chat.freenode.net” in its
+      “Address” field, and then they would be able to user “freenode” as
+      the network name forever: if “chat.freenode.net” breaks for some
+      reason, it can be changed to “irc.freenode.org” instead, and the user
+      would not need to change all their bookmarks and settings.
     * Realname: The customized “real name” as it will appear on the
       user’s whois. This option is not available if biboumi is configured
       with realname_customization to false.