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.

Log: Difference between revisions

From ZNC
Jump to navigation Jump to search
>Dgw
Notes: published backport of log-permissions for 1.0
>Resistance
Added a disclaimer to the default paths regarding `$channel$ being a human-readable placeholder and not an argument. Changed the grammar on the "Replace `~/.znc` with your directory path" notification so that it's more complete english.
Line 10: Line 10:
   network: ~/.znc/users/$user/networks/$network/moddata/log/$channel_YYYYMMDD.log
   network: ~/.znc/users/$user/networks/$network/moddata/log/$channel_YYYYMMDD.log


(Replace ~/.znc/ with your data dir if you use a non-standard one).
(Note that <code>$channel</code> is not an acceptable argument, it's simply there for human readability purposes.  Also note that you will need to replace <code>~/.znc/</code> with the correct path to the data directory on your system if you use a non-standard setup.)


You can make a symlink for easier access to that location, e.g.
You can make a symlink for easier access to that location, e.g.

Revision as of 20:40, 17 January 2014


This module logs your conversations to some special place on your disk.

Depending on how the log module is loaded, the logs are stored:

 global:  ~/.znc/moddata/log/$user_$network_$channel_YYYYMMDD.log
 user:    ~/.znc/users/$user/moddata/log/$network_$channel_YYYYMMDD.log
 network: ~/.znc/users/$user/networks/$network/moddata/log/$channel_YYYYMMDD.log

(Note that $channel is not an acceptable argument, it's simply there for human readability purposes. Also note that you will need to replace ~/.znc/ with the correct path to the data directory on your system if you use a non-standard setup.)

You can make a symlink for easier access to that location, e.g.

ln -s $HOME/.znc/users/dude/moddata/log/ $HOME/dude_irc_logs


Notes

In the znc-0.206 release this module is NOT a core module, see ZNC-Extra for more information on how to use it

In a future ZNC release, this module will mimic directory permissions set on its data directory (moddata/log, in whatever location appropriate to the mode it is running in; see above) when creating new subdirectories. However, as of 2013-08-20, umasks may interfere with it and result in less access being granted than expected. For example, the module may be unable to grant write access to Group or World (umask 0022).

To get the directory permission inheritance under ZNC 1.0, use this file and znc-buildmod log.cpp, then move the module to the ZNC modules directory.

Usage

Arguments

This user module takes up to one argument. Path where to store logs. It can contain $USER, $NETWORK and $WINDOW substitutes.

Read loading modules to learn more about loading modules. Load the module to start logging, unload it to stop logging. Kinda easy, eh?

Commands

This module does not support any commands.

pisg

The log module uses the "energymech" format so it can be used with pisg if so desired.

Example Config

   <channel="#znc">
       Logfile = "/home/znc/.znc/users/efnet/moddata/log/#znc_*.log"
       Format = "energymech"
       Network = "EFnet"
       OutputFile = "znc.html"
   </channel>