To create new wiki account, please join us on #znc at freenode and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Difference between revisions of "Clientbuffer"

From ZNC
Jump to: navigation, search
m (Configuration)
(Change upstream URL to my fork and document added features)
Line 4: Line 4:
 
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 is available on [https://github.com/jpnurmi/znc-clientbuffer GitHub]. See also instructions for [[compiling modules]].
+
The source code is available on [https://github.com/CyberShadow/znc-clientbuffer GitHub]. See also instructions for [[compiling modules]].
  
{{Module arguments|no}}
+
{{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>AutoClearChanBuffer</code> and <code>AutoClearQueryBuffer</code> config options that are enabled by default. This can be done via [[controlpanel]], [[webadmin]], or [[configuration|znc.conf]].
 
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.
  
 
=== Commands ===
 
=== Commands ===

Revision as of 06:03, 8 October 2017

The client buffer module maintains client specific buffers for identified clients.

The source code is available on GitHub. See also instructions for compiling modules.

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.

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