To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.
Clientbuffer: Difference between revisions
>Jpnurmi Created page with "<!--{{External Module}}--> {{ambox | type = delete | text = '''This external module is a work in progress.'''<br/><small>Please note that it requires the latest development ve..." |
mNo edit summary |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
<!--{{External Module}}--> | <!--{{External Module}}--> | ||
{{ | {{External Module}} | ||
The client buffer module maintains client specific buffers for identified clients. | The client buffer module maintains client specific buffers for identified clients. | ||
The source code | The source code is available on [https://github.com/CyberShadow/znc-clientbuffer GitHub]. See also instructions for [[compiling modules]]. | ||
{{Module arguments| | This is an updated version to the original Clientbuffer. Some additional modules which you may find useful when using multiple clients, as well as information between this and the original Clientbuffer, can be found at [[Multiple clients]]. | ||
{{Module arguments|count=up to two|extra=<br> | |||
; autoadd | |||
: If specified, causes any clients that haven't been previously registered to be automatically registered, thus making it unnecessary to use the '''AddClient''' command. | |||
; timelimit=''seconds'' | |||
: Does not send log lines that are older than the specified number of seconds. For example, use '''timelimit=86400''' to only send buffer lines that are at most one day long. | |||
}} | |||
=== Configuration === | === Configuration === | ||
In order to make it possible for the module to control client specific buffers, you must disable the <code> | In order to make it possible for the module to control client specific buffers, you must disable the <code>AutoClearChanBuffer</code> and <code>AutoClearQueryBuffer</code> config options that are enabled by default. This can be done via [[controlpanel]], [[webadmin]], or [[configuration|znc.conf]]. | ||
The [[savebuff]] module is recommended to allow buffers survive ZNC restarts. | |||
It is very important that you disable "Auto Clear Chan Buffer" and "Auto Clear Query Buffer" on the Your Settings page, or this module will not work correctly. The buffers will otherwise be cleared when first client that downloads it, meaning it is not available for the next client later. | |||
=== Commands === | |||
/msg *clientbuffer AddClient <identifier> | |||
/msg * | /msg *clientbuffer DelClient <identifier> | ||
/msg *clientbuffer ListClients | |||
=== Identifiers === | === Identifiers === | ||
Latest revision as of 16:06, 23 October 2017
 |
This is an external module. Please note that it may or may not work with the current release (1.9.1). This module is not included in the default ZNC installation, and you will need to manually compile it before you can load this module. Contact the author if you have any questions, but feel free to ask in #znc on Libera.Chat. Someone might be able to help you there. |
The client buffer module maintains client specific buffers for identified clients.
The source code is available on GitHub. See also instructions for compiling modules.
This is an updated version to the original Clientbuffer. Some additional modules which you may find useful when using multiple clients, as well as information between this and the original Clientbuffer, can be found at Multiple clients.
Arguments
This user module takes up to two arguments.
- autoadd
- If specified, causes any clients that haven't been previously registered to be automatically registered, thus making it unnecessary to use the AddClient command.
- timelimit=seconds
- Does not send log lines that are older than the specified number of seconds. For example, use timelimit=86400 to only send buffer lines that are at most one day long.
Read loading modules to learn more about loading modules.
Configuration
In order to make it possible for the module to control client specific buffers, you must disable the AutoClearChanBuffer and AutoClearQueryBuffer config options that are enabled by default. This can be done via controlpanel, webadmin, or znc.conf.
The savebuff module is recommended to allow buffers survive ZNC restarts.
It is very important that you disable "Auto Clear Chan Buffer" and "Auto Clear Query Buffer" on the Your Settings page, or this module will not work correctly. The buffers will otherwise be cleared when first client that downloads it, meaning it is not available for the next client later.
Commands
/msg *clientbuffer AddClient <identifier> /msg *clientbuffer DelClient <identifier> /msg *clientbuffer ListClients
Identifiers
ZNC supports passing a client identifier in the password:
username@identifier/network:password
or in the username:
username@identifier/network