View source for Log

{{DISPLAYTITLE:log}}
{{Core Module}}

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

== '''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

Since ZNC 1.2, this module mimics directory permissions set on its data directory (<tt>moddata/log</tt>, 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 [https://raw.github.com/dgw/znc/log-permissions-1.0-backport/modules/log.cpp this file] and <code>znc-buildmod log.cpp</code>, then move the module to the ZNC modules directory.

== Usage ==

{{Module arguments
|count=one through three
|extra=<br>This user module takes one through three arguments. 
|extra=<br>First argument: <code>-sanitize</code> If presented, removes color codes and [https://en.wikipedia.org/wiki/C0_and_C1_control_codes C0 control codes] from the lines before logged. 
<br>Second argument: <code>-timestamp</code> If presented, permits manually specifying a timestamp that will be passed through <code>strftime</code>.
<br>Third argument: Relative path where to store logs. It can contain <code>$USER</code>, <code>$NETWORK</code> and <code>$WINDOW</code> tokens as well as [[Timestamps|time format tokens]].
<br>Depending on the scope in which the log module is loaded, the path argument is relative to the following paths: (Note: <code>~/.znc/</code> might be different if you use a non-standard data directory):
  global:  ~/.znc/moddata/log/
  user:    ~/.znc/users/$USER/moddata/log/
  network: ~/.znc/users/$USER/networks/$NETWORK/moddata/log/
Default paths since 1.6:
  global:  $USER/$NETWORK/$WINDOW/%Y-%m-%d.log
  user:    $NETWORK/$WINDOW/%Y-%m-%d.log
  network: $WINDOW/%Y-%m-%d.log
Default paths prior 1.6:
  global:  $USER_$NETWORK_$WINDOW_%Y%m%d.log
  user:    $NETWORK_$WINDOW_%Y%m%d.log
  network: $WINDOW_%Y%m%d.log
To convert your old logs to the 1.6 format, you can use [https://github.com/ZacharyDuBois/Random-Scripts/blob/master/convert-znc-1.4-logs-to-1.6.sh this user created script].
If you want to log to some other place, make a symlink.
}}

Load the module to start logging, unload it to stop logging. Kinda easy, eh?

=== Commands ===

; <code>ClearRules</code>
: Clear all logging rules

; <code>Help <search term></code>
: Generate this output. Optionally search for a given word/phrase.

; <code>ListRules</code>
: List all logging rules

; <code>Set boolean</code> ''(added in 1.7)''
: Set one of the following booleans: joins, quits, nickchanges.
: For example, <code>/msg *log Set quits false</code> to exclude quit messages from the log.

; <code>SetRules <rules></code>
: Filter chat rooms which should be logged (all by default). Use <code>!#chan</code> or <code>!query</code> to negate and <code>*</code> for wildcards. For example, <code>SetRules #znc !*</code> would log only #znc and no other channel.

; <code>ShowSettings</code> ''(added in 1.7)''
: Show current settings set by Set command

== pisg ==

The log module uses the "energymech" format so it can be used with [http://pisg.sourceforge.net/ pisg] if so desired.

=== Example Config ===

    <channel="#znc">
        # Before ZNC 1.6.0
        Logfile = "/home/znc/.znc/users/efnet/moddata/log/#znc_*.log"
        # Since ZNC 1.6.0
        LogDir="/home/znc/.znc/moddata/log/user/efnet/#znc"
        Format = "energymech"
        Network = "EFnet"
        OutputFile = "znc.html"
    </channel>