DebugFile

Enable debug mode and provide a name for the debug/warnings file.

Synopsis

The default is to not log debug messages.

Scope

This directive is only available for use in the global (interchange.cfg) configuration file, and will affect all websites running under the Interchange installation.  It will not work in a website's local (catalog.cfg) configuration file. 

Description

Names a file, relative to the Interchange instance's installation directory, which should store the output of logDebug() statements and Perl warnings.

If this directive is not present in the global Interchange configuration file then no debug/warning file will be created.

Debug messages are generally generated via calls to the logDebug() subroutine by the Interchange core modules.  Calls to this subroutine are generally commented out in the core.  If you want to see the debug messages then you will need to edit the one or more of the core modules and un-comment the logDebug() call(s) in the area of interest.  Remember to make a backup of the core module(s) before before you edit, so that you can restore the system to normal operation when you have finished debugging.

Certain other events will be debugged if the DEBUG Variable is not set true, in the global (interchange.cfg) configuration file.  Notably, if the DEBUG Variable is true then the

Net::SMTP  module's debug mode will be enabled.

Interchange can be started in "foreground debug mode" by starting Interchange with the "--DEBUG=1" flag.  In this mode, any output (warnings, "print()" output and other messages) will be sent to the debug file (if defined).

Lastly, you can send messages to the debug file, from your pages, by calling the [debug] tag.

The DebugHost directive can be used to restrict the debug mode such that debug messages are only logged for requests that originate from specified IP addresses.  A "debug_qualify" GlobalSub can also be used to restrict the debug output.

Example