Debugging Information

Sometimes there are behaviors or bugs that you can reliably reproduce but we cannot. In these instances it is often helpful to have a "full debug.out" which contains all of the keystrokes you pressed, the accessibility events that were emitted, what was spoken and brailled as a result, and any errors that may have occurred.

Obtaining a "full debug.out"

There are different debugging levels and different options/strategies for obtaining a full debug.out. We should outline them all here. For now, however, here's two approaches:

1. Open Orca preferences and switch to the "key bindings" tab. Find the "cycle debug level at run time" key binding and assign a key to it by pressing right arrow to get on the key column and pressing enter. It will ask for the key. Press the key you want, for example, Orca+e then press enter to confirm. Then to create the debug file start orca by pressing alt+f2 then type:

orca --debug

The file will be named in the format:


If you would like the file to have a different name other than the default use the --debug-file=name as in:

orca --debug --debug-file=debug.txt

After you have captured the info you need be sure to restart Orca normally with:


so the file won't get too large.

2. In your $HOME/.local/share/orca/ file, add the following lines:

import orca.debug
import time
orca.debug.debugLevel = orca.debug.LEVEL_ALL
orca.debug.eventDebugLevel = orca.debug.LEVEL_OFF
orca.debug.debugFile = open(time.strftime('debug-%Y-%m-%d-%H:%M:%S.out'), 'w')

Quit Orca. Then relaunch it (and any offending applications), reproduce the problem, and quit Orca. This will cause the debugging output to be in a file in your home directory (or wherever you launched Orca from if you manually launch it). The file's name will begin with "debug" end with ".out" and have a time stamp in between. Now comment the lines above so that Orca will no longer be recording all of that debugging information. When you relaunch Orca the next time, things should be back to normal.

Note that if you use Orca in order to perform the above edits to your the lines, you will have two debug.outs (the first from reproducing the problem; the second from recommenting the lines). We of course need the first of the two. :-) Because this file is likely quite large, bzipping or gzipping it is appreciated.


The information on this page and the other Orca-related pages on this site are distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Projects/Orca/Debugging (last edited 2013-12-28 19:19:41 by WilliamJonMcCann)