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 "Savebuff"

From ZNC
Jump to: navigation, search
(Insert correct description from archive.org's 2011-Jul-04 copy of this page.)
(make buffextras link)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{DISPLAYTITLE:savebuff}}
 
{{DISPLAYTITLE:savebuff}}
 +
{{Core Module}}
 
This module saves your channel buffers into an encrypted file so they can survive restarts and reboots.
 
This module saves your channel buffers into an encrypted file so they can survive restarts and reboots.
  
In previous versions, this module helped parsing actions which happened on IRC, by adding JOINs, QUITs, etc. to the playback buffer with a not-really-human-readable format. It was recommened to be used in combination with a client script or plugin, otherwise the output was pretty much useless or rather annoying. This feature was deprecated, however, and that functionality has moved to its own module, buffextras.
+
In previous versions, this module helped parsing actions which happened on IRC, by adding JOINs, QUITs, etc. to the playback buffer with a not-really-human-readable format. It was recommened to be used in combination with a client script or plugin, otherwise the output was pretty much useless or rather annoying. This feature was deprecated, however, and that functionality has moved to its own module, [[buffextras]].
  
 
== Usage ==
 
== Usage ==
  
{{Module arguments}}
+
{{Module arguments
 +
| type  = network
 +
| count=up to one
 +
| extra=Either <code>--ask-pass</code> or the password itself (which may contain spaces) or nothing}}
  
Savebuff stores information in <code>~/.znc/users/<user>/savebuff/</code>. The filename is a MD5 hash of the username and channel name (in lowercase).
+
Savebuff stores information in <code>~/.znc/users/<user>/networks/<network>/moddata/savebuff/</code>. The filename is a MD5 hash of the username and channel name (in lowercase).
  
 
=== Client scripts and plugins ===
 
=== Client scripts and plugins ===
Line 24: Line 28:
  
 
The second easiest way is to remove savebuff's saved messages:
 
The second easiest way is to remove savebuff's saved messages:
  rm ~/.znc/users/*/moddata/savebuff/.*
+
  rm ~/.znc/users/*/networks/*/moddata/savebuff/.*
 
If you only want to remove the messages of some user, use this:
 
If you only want to remove the messages of some user, use this:
  rm ~/.znc/users/'''<username>'''/moddata/savebuff/.*
+
  rm ~/.znc/users/'''<username>'''/networks/*/moddata/savebuff/.*
  
 
To avoid this error in the future and if you don't have problems with saving the password in the ZNC config file, you can add your password there:
 
To avoid this error in the future and if you don't have problems with saving the password in the ZNC config file, you can add your password there:

Latest revision as of 10:15, 18 December 2014

This module saves your channel buffers into an encrypted file so they can survive restarts and reboots.

In previous versions, this module helped parsing actions which happened on IRC, by adding JOINs, QUITs, etc. to the playback buffer with a not-really-human-readable format. It was recommened to be used in combination with a client script or plugin, otherwise the output was pretty much useless or rather annoying. This feature was deprecated, however, and that functionality has moved to its own module, buffextras.

Usage[edit]

Arguments

This network module takes up to one arguments. Either --ask-pass or the password itself (which may contain spaces) or nothing

Read loading modules to learn more about loading modules.

Savebuff stores information in ~/.znc/users/<user>/networks/<network>/moddata/savebuff/. The filename is a MD5 hash of the username and channel name (in lowercase).

Client scripts and plugins[edit]

There are several scripts and plugins available to parse the actions sent by this module. You can find them below.

Known Issues[edit]

Savebuff blocks starting ZNC[edit]

What am I supposed to do if I can't start ZNC because the savebuff module fails to decrypt its saved messages?
The easiest way to fix this is to enter the correct password.

The second easiest way is to remove savebuff's saved messages:

rm ~/.znc/users/*/networks/*/moddata/savebuff/.*

If you only want to remove the messages of some user, use this:

rm ~/.znc/users/<username>/networks/*/moddata/savebuff/.*

To avoid this error in the future and if you don't have problems with saving the password in the ZNC config file, you can add your password there:

LoadModule = savebuff This is my secret pass