Create a debugfile - Rookiestyle/KPColorChange GitHub Wiki

KPColorChange allows you to create a debugfile.
A debugfile contains valuable information that can help to fix issues sooner, it is created when debug mode is activated.

When you exit KeePass, the debugfile is saved in your temp-folder and the filename is shown.

Please always attach a debugfile to a bug report.

How to create a debugfile?

There are two options for creating a debugfile.

GUI: Plugin options

You can activate debug mode using Tools -> Options... -> Plugin Options -> Overview

Startup parameter

You can also activate debugmode using a parameter during start of KeePass.
This is especially useful if you observe issues before you can activate debugmode in the GUI.

You can either provide the plugins' names you want to have debugfiles created for or you can simply have debugfiles created for all of them.

Example: KeePass.exe -debugplugin:kpcolorchange
This will activate debugmode for KPColorChange\

Example: KeePass.exe -debugplugin:kpcolorchange,plugin3
This will activate debugmode for the plugins named KPColorChange and plugin3

Example: KeePass.exe -debugplugin:all
This will activate debugmode for all of my plugins

What is contained in the debugfile?

A debugfile contains valuable non-sensitive information, e. g.

  • Plugin name and version
  • OS name and version
  • .NET version
  • KeePass version
  • Name and version of other plugins
  • Specific debug messages

KeePass crashes, what to do?

A debugfile can only be created properly, if you close KeePass manually.

If KeePass crashes, you can create a debugfile only using a startup parameter.
Examples:
KeePass.exe -debugautosave
KeePass.exe -debugplugin:kpcolorchange,plugin2 -debugautosave
KeePass.exe -debugplugin:all -debugautosave