LoggingErrors

#summary Instructions for users to use debug mode to log errors.

= Introduction =

K-9 Mail has controllable debug logging. Users can activate logging to help diagnosing problems and errors.

= Details =

== Step 1: Activate Debug Logging in K-9 Mail == At the accounts screen of K-9 Mail press the menu button and choose "Preferences". Under the heading "Debugging" check the "Enable debug logging?" checkbox. Hit the back button to save the changes.

Note: In versions 1.106 and prior: At the accounts screen, type debug (there's no text box or anything, just press the keys). You should get the 'secret' debugging menu. Check the "Enable extra debug logging?" checkbox. Hit the back button to save the changes.

== Step 2: Trigger error == Do whatever causes the problem/error.

== Step 3: Get Debug Log == To fetch the debug log you can either attach the device to your PC and use the tool adb from the Android SDK or you can use the application aLogcat to display the debug log on the device.

• === Using adb (Android SDK) ===

Install the [http://developer.android.com/sdk/index.html Android SDK] if not already installed. Follow these [http://developer.android.com/sdk/installing.html installation instructions]. Step 3 (Installing the ADT Plugin for Eclipse) and above can be skipped.

Change to the directory: /<path to android sdk>/tools/

Attach your device via USB or fire up the emulator using the command emulator. If you're using a hardware device you have to enable USB debugging. Go into "Settings", "Applications", "Development", and enable the "USB debugging" option.

To show the debug log enter the command: adb logcat k9:V *:S AndroidRuntime:E

Press Ctrl-C to exit adb

• === Using aLogcat (from Android Market) ===

Install the application [market://search?q=pname:org.jtb.alogcat aLogcat] via the Android Market.

In aLogcat press the menu button and select "Filter". Enter /k9 and press "Okay".
Note: If you're logging program crashes ("Force close" dialog) do NOT use a filter!

Make sure that "Level" is set to "Verbose" (default setting)

== Step 4: Create an Issue in our Bug Tracker == To be able to fix your problem we need to know about it. Please create a [http://code.google.com/p/k9mail/issues/entry new issue] in our [http://code.google.com/p/k9mail/issues/list bug tracker]. Attach a copy of the debug log you just created.

Important: Include the exact version number of your installed K-9 Mail in the bug report. Read [GetVersionNumber] if you need help on finding out which version of K-9 you're running.