WINEDEBUG is an environment variable that turns debugging messages on or off.

Syntax

WINEDEBUG=[class][+/-]channel[,[class2][+/-]channel2]

class is optional and can be one of the following: err, warn, fixme, or trace. If class is not specified, all debugging messages for the specified channel are turned on. Each channel will print messages about a particular component of Wine. The following character can be either + or - to switch the specified channel on or off respectively. If there is no class part before it, a leading + can be omitted. Note that spaces are not allowed any where in the string.

channel specifies which debug channel to turn on or off. For complete list of channels run this command in the source dir

grep -r --include='*.c' --include='*.h' 'WINE_\(DEFAULT\|DECLARE\)_DEBUG_CHANNEL' dlls/ programs/

And with some more work we have sorted and formatted list in BASH (you may want to adjust number 26 near the end of this composite to match your indentation taste):

for modname in $(find dlls/ programs/ -mindepth 1 -type d | sort); do
  echo $(grep -rE --include='*.[ch]' '^WINE_(DEFAULT|DECLARE)_DEBUG_CHANNEL' $modname \
         | awk -F "[()]" '{print $2}' | sort | uniq) \
         | awk -v modname=$modname '{if (NF>0) printf("%-*s%s\n", 26, modname": ", $0)}';
done

List of Debug Channels

Useful or special channels

• all -- logs everything
• heap -- logs heap functions and turns on extra checks
• message -- logs Windows messages
• msgbox -- logs the display of message boxes
• relay -- logs every cross-module function call to Wine builtin DLLs
• seh -- logs Windows exceptions (Structured Exception Handling)
• snoop -- logs every function call in native DLLs (may break them)
• synchronous -- force X11 into synchronous mode
• tid -- prepends each log message with the ID of the thread it came from

Examples

• WINEDEBUG=warn+all
  • will turn on all warning messages.
• WINEDEBUG=warn+dll,+heap
  • will turn on DLL warning messages and all heap messages.
• WINEDEBUG=fixme-all,warn+cursor,+relay
  • will turn off all FIXME messages, turn on cursor warning messages, and turn on all relay messages (API calls).
• WINEDEBUG=+relay

  • will turn on all relay messages. For more control on including or excluding functions and dlls from the relay trace look into the [HKCU\Software\Wine\Debug] registry key (See UsefulRegistryKeys and example below).

Making +relay less verbose

If you're looking for a problem that happens a couple minutes into the run of an app, +relay can be too verbose. In that case, run it once, then send the log through a script like

# Make grep go fast
LANG=C
# Find top ten calls
freq=`grep ':Ret ' | sed 's/(.*//;s/.* //' | sort | uniq -c | sort -n | tail | awk '{print $2}' | tr '\012' ';'`
cat > quiet.reg << _EOF
REGEDIT4

[HKEY_CURRENT_USER\Software\Wine\Debug]
"RelayExclude"="ntdll.RtlEnterCriticalSection;ntdll.RtlLeaveCriticalSection;kernel32.48;kernel32.49;kernel32.94;kernel32.95;kernel32.96;kernel32.97;kernel32.98;$freq"

_EOF

wine regedit quiet.reg

This will tell Wine to not log the ten most frequent calls in your app, which should make your +relay log much more managable in size.

See Also

• Debug_trace_toggle_key A patch to toggle tracing on and off while running an application

• Environment Variables: WINEDEBUG - chapter of the Wine User Guide

• WineAPI documentation - For each function the used debug channels are listed.

• Bug 638 - Bug tracking documenting the debugging channel. Has a perl script to list all channels in a function.

• CategoryListofCommands