diff options
| author | louiz’ <louiz@louiz.org> | 2017-09-09 17:09:17 +0200 |
|---|---|---|
| committer | louiz’ <louiz@louiz.org> | 2017-09-09 17:09:17 +0200 |
| commit | bfcf29451787d10c747ad79cb3fd177ac86e9cf1 (patch) | |
| tree | 20e34434b136300cdfb3f99f07c76e6b7b9c726c /doc | |
| parent | 8d99374f1f02a4d229b49f6697247eb1e1f4f940 (diff) | |
| download | biboumi-bfcf29451787d10c747ad79cb3fd177ac86e9cf1.tar.gz biboumi-bfcf29451787d10c747ad79cb3fd177ac86e9cf1.tar.bz2 biboumi-bfcf29451787d10c747ad79cb3fd177ac86e9cf1.tar.xz biboumi-bfcf29451787d10c747ad79cb3fd177ac86e9cf1.zip | |
Add the persistent_by_default configuration option
fix #3293
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/biboumi.1.rst | 26 |
1 files changed, 22 insertions, 4 deletions
diff --git a/doc/biboumi.1.rst b/doc/biboumi.1.rst index 3c5ec8e..9227ff6 100644 --- a/doc/biboumi.1.rst +++ b/doc/biboumi.1.rst @@ -100,6 +100,21 @@ 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. +persistent_by_default +--------------------- + +If this option is set to `true`, all rooms will be persistent by default: +the value of the “persistent” option in the global configuration of each +user will be “true”, but the value of each individual room will still +default to false. This means that a user just needs to change the global +“persistent” configuration option to false in order to override this. + +If it is set to false (the default value), all rooms are not persistent by +default. + +Each room can be configured individually by each user, to override this +default value. See `Ad-hoc commands`_. + realname_customization ---------------------- @@ -595,10 +610,13 @@ On the gateway itself (e.g on the JID biboumi.example.com): the database. * Max history length: The maximum number of lines in the history that the server is allowed to send when joining a channel. - * Persistent: Overrides the value specified in each individual channel, - all channels are persistent, whether or not their specific value is - true or false. See below for more details on what a persistent - channel is. + + * Persistent: Overrides the value specified in each individual channel. + If this option is set to true, all channels are persistent, whether + or not their specific value is true or false. This option is true by + default for everyone if the `persistent_by_default` configuration + option is true, otherwise it’s false. See below for more details on + what a persistent channel is. This value is On a server JID (e.g on the JID chat.freenode.org@biboumi.example.com) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |