summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorlouiz’ <louiz@louiz.org>2018-03-12 01:00:17 +0100
committerlouiz’ <louiz@louiz.org>2018-03-12 01:00:17 +0100
commitbb476f4a0d60bbc41393a86a370aa94ab405b081 (patch)
tree82d15a2f36ae284ac693927c367bb57b89ddda51 /doc
parent9e4a3e2b054ee4604b6a42c73895216c68fa96e7 (diff)
downloadbiboumi-bb476f4a0d60bbc41393a86a370aa94ab405b081.tar.gz
biboumi-bb476f4a0d60bbc41393a86a370aa94ab405b081.tar.bz2
biboumi-bb476f4a0d60bbc41393a86a370aa94ab405b081.tar.xz
biboumi-bb476f4a0d60bbc41393a86a370aa94ab405b081.zip
Allow to override the addresses used to connect to an IRC network
fix #3273
Diffstat (limited to 'doc')
-rw-r--r--doc/biboumi.1.rst11
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.