path: root/doc/kdebugdialog
diff options
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commit4aed2c8219774f5d797760606b8489a92ddc5163 (patch)
tree3f8c130f7d269626bf6a9447407ef6c35954426a /doc/kdebugdialog
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn:// 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc/kdebugdialog')
2 files changed, 137 insertions, 0 deletions
diff --git a/doc/kdebugdialog/ b/doc/kdebugdialog/
new file mode 100644
index 000000000..e786da562
--- /dev/null
+++ b/doc/kdebugdialog/
@@ -0,0 +1,3 @@
+KDE_LANG = en
diff --git a/doc/kdebugdialog/index.docbook b/doc/kdebugdialog/index.docbook
new file mode 100644
index 000000000..72634224d
--- /dev/null
+++ b/doc/kdebugdialog/index.docbook
@@ -0,0 +1,134 @@
+<?xml version="1.0" ?>
+<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
+"dtd/kdex.dtd" [
+ <!ENTITY kdebugdialog "<application>KDebugDialog</application>">
+ <!ENTITY kappname "&kdebugdialog;">
+ <!ENTITY % addindex "IGNORE">
+ <!ENTITY % English "INCLUDE" > <!-- change language only here -->
+<book lang="&language;">
+<title>The &kdebugdialog; Handbook</title>
+<author>&David.Faure; &David.Faure.mail;</author>
+<para>This document describes &kdebugdialog;.</para>
+<chapter id="Introduction">
+<title>What is KDebugDialog?</title>
+<para>It is a dialog box for managing diagnostic messages at runtime.
+<para>If you simply start <command>kdebugdialog</command>, you will
+see a list of <quote>areas</quote>, that can be disabled or enabled. A
+<function>kdDebug(area)</function> call in the code will show
+something in the debug output only if the area is enabled.</para>
+<note><para>Note that kdWarning, kdError and kdFatal always appear,
+they are NOT controlled by this setting. </para></note>
+<para>The areas which should only be output. Every message
+that is not mentioned here will simply not be output (unless
+this field remains empty, which is the default, and means that all
+messages should be output). You can enter several areas
+separated by commas here, and you can also use area ranges with
+the syntax start-end. Thus a valid entry could be:
+117,214-289,356-359,221. Do not use whitespaces.</para>
+<para>If you start <command>kdebugdialog</command>
+<option>--fullmode</option>, then for every severity level you can
+define separately what should be done with the diagnostic messages of
+that level, and the same for each debug area.</para>
+<para>In full mode, first you should select the debug area you are
+interested in from the drop down list at the top.</para>
+<para>You may independently set the output for various types of
+<listitem><para><guilabel>Fatal Error</guilabel></para></listitem>
+<para>For each of these types, you can set the following:</para>
+<term><guilabel>Output to:</guilabel></term>
+<para>In this Combobox, you can choose where the messages
+should be output. The choices are: <quote>File</quote>, <quote>Message
+Box</quote>, <quote>Shell</quote> (meaning stderr) and
+<quote>Syslog</quote>. Please do not direct fatal messages to syslog
+unless you are the system administrator yourself. The default is
+<quote>Message Box</quote>.</para>
+<listitem><para>This is only enabled when you have chosen
+<quote>File</quote> as the output and provides the name of that file
+(which is interpreted as relative to the current folder). The
+default is <filename>kdebug.dbg</filename>.</para>
+<para>Apart from this, you can also tick the checkbox <guilabel>Abort
+on fatal errors</guilabel>. In this case, if a diagnostic message with
+the severity level <computeroutput>KDEBUG_FATAL</computeroutput> is
+output, the application aborts with a SIGABRT after outputting the
+<para>When you close the dialog by pressing <guibutton>OK</guibutton>,
+your entries apply immediately and are saved in
+<filename>kdebugrc</filename>. When you press
+<guibutton>Cancel</guibutton>, your entries are discarded and the old
+ones are restored.</para>
+<para>Credits to Kalle Dalheimer for the original version of
+Local Variables:
+mode: sgml
+sgml-omittag: nil
+sgml-general-insert-case: lower
+sgml-shorttag: t