path: root/doc
diff options
authorlouiz’ <>2017-06-16 10:48:54 +0200
committerlouiz’ <>2017-06-16 10:48:54 +0200
commite75d7ad8ea72044fdfd2317e03f91ba5bea06b86 (patch)
treed6e289cd1026bfcd346956f4eaa378c893119700 /doc
parent40db183e3753486deaa43e950fff38579c5ced6f (diff)
Add a Record History option in the Channel configuration form
fix #3269
Diffstat (limited to 'doc')
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst
index 5396015..4a2225e 100644
--- a/doc/biboumi.1.rst
+++ b/doc/biboumi.1.rst
@@ -358,7 +358,7 @@ History
Public channel messages are saved into archives, inside the database, unless
-the `record_history` option is set to false for that user `Ad-hoc commands`.
+the `record_history` option is set to false by that user (see `Ad-hoc commands`).
Private messages (messages that are sent directly to a nickname, not a
channel) are never stored in the database. When a channel is joined, biboumi
sends the `max_history_length` messages found in the database as the MUC
@@ -631,6 +631,11 @@ On a channel JID (e.g on the JID
the archiving of messages is enabled for this room, the client will
receive the messages that where sent in this channel. This option can be
used to make biboumi act as an IRC bouncer.
+ * Record History: whether or not history messages should be saved in
+ the database, for this specific channel. If the value is “unset” (the
+ default), then the value configured globally is used. This option is there,
+ for example, to be able to enable history recording globally while disabling
+ it for a few specific “private” channels.
Raw IRC messages