summaryrefslogtreecommitdiff
path: root/doc/biboumi.1.md
diff options
context:
space:
mode:
authorFlorent Le Coz <louiz@louiz.org>2015-02-26 17:43:24 +0100
committerFlorent Le Coz <louiz@louiz.org>2015-02-26 17:43:24 +0100
commit82256d40a32e1401c7884b1c9ff26ea77d775d3d (patch)
tree0661670f87c6cca2b43f2a35bc5c5d71ccfff78a /doc/biboumi.1.md
parentc01befb054075ab414fd602859e5999a138aa5bf (diff)
parentc307df85c8e7d9bcd4570269bf13c3e92c3f5954 (diff)
downloadbiboumi-82256d40a32e1401c7884b1c9ff26ea77d775d3d.tar.gz
biboumi-82256d40a32e1401c7884b1c9ff26ea77d775d3d.tar.bz2
biboumi-82256d40a32e1401c7884b1c9ff26ea77d775d3d.tar.xz
biboumi-82256d40a32e1401c7884b1c9ff26ea77d775d3d.zip
Merge branch 'fixed_server'
Diffstat (limited to 'doc/biboumi.1.md')
-rw-r--r--doc/biboumi.1.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/biboumi.1.md b/doc/biboumi.1.md
index 18df220..3fd5a25 100644
--- a/doc/biboumi.1.md
+++ b/doc/biboumi.1.md
@@ -59,6 +59,24 @@ The configuration file uses a simple format of the form
privileges), for example some administration ad-hoc commands will only be
available to that JID.
+`fixed_irc_server`
+
+ If this option contains the hostname of an IRC server (for example
+ irc.example.org), then biboumi will enforce the connexion to that IRC
+ server only. This means that a JID like "#chan@biboumi.example.com" must
+ be used instead of "#chan%irc.example.org@biboumi.example.com". In that
+ mode, the virtual channel (see *Connect to an IRC server*) is not
+ available and you still need to use the ! separator to send message to an
+ IRC user (for example "foo!@biboumi.example.com" to send a message to
+ foo), although the in-room JID still work as expected
+ ("#channel@biboumi.example.com/Nick"). On the other hand, the '%' lose
+ any meaning. It can appear in the JID but will not be interpreted as a
+ separator (thus the JID "#channel%hello@biboumi.example.com" points to the
+ channel named "#channel%hello" on the configured IRC server) This option
+ can for example be used by an administrator that just wants to let their
+ users join their own IRC server using an XMPP client, while forbidding
+ access to any other IRC server.
+
`log_file`
A filename into which logs are written. If none is provided, the logs are