runtime/doc/kdebugdialog/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4   <!ENTITY kdebugdialog "<application>KDebugDialog</application>">
   5   <!ENTITY kappname "&kdebugdialog;">
   6   <!ENTITY % addindex "IGNORE">
   7   <!ENTITY % English "INCLUDE" > <!-- change language only here -->
   8
   9
  10 ]>
  11
  12 <book lang="&language;">
  13 <bookinfo>
  14 <title>The &kdebugdialog; Handbook</title>
  15
  16 <authorgroup>
  17 <author>&David.Faure; &David.Faure.mail;</author>
  18 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  19 </authorgroup>
  20
  21 <date>2001-02-13</date>
  22 <releaseinfo>0.03.00</releaseinfo>
  23
  24 <abstract>
  25 <para>This document describes &kdebugdialog;.</para>
  26 </abstract>
  27
  28 <keywordset>
  29 <keyword>KDE</keyword>
  30 <keyword>KDebugdialog</keyword>
  31 </keywordset>
  32 </bookinfo>
  33
  34 <chapter id="Introduction">
  35 <title>What is &kdebugdialog;?</title>
  36
  37 <para>It is a dialog box for managing diagnostic messages at runtime.
  38 </para>
  39
  40 <para>If you simply start <command>kdebugdialog</command>, you will
  41 see a list of <quote>areas</quote>, that can be disabled or enabled. A
  42 <function>kDebug(area)</function> call in the code will show
  43 something in the debug output only if the area is enabled.</para>
  44
  45 <note><para>Note that kWarning, kError and kFatal always appear,
  46 they are NOT controlled by this setting.  </para></note>
  47
  48 <variablelist>
  49 <varlistentry>
  50 <term><guilabel>Area</guilabel></term>
  51 <listitem>
  52 <para>The areas which should only be output. Every message
  53 that is not mentioned here will simply not be output (unless
  54 this field remains empty, which is the default, and means that all
  55 messages should be output). You can enter several areas
  56 separated by commas here, and you can also use area ranges with
  57 the syntax start-end. Thus a valid entry could be:
  58 117,214-289,356-359,221. Do not use whitespaces.</para>
  59 </listitem>
  60 </varlistentry>
  61 </variablelist>
  62
  63 <para>If you start <command>kdebugdialog</command>
  64 <option>--fullmode</option>, then for every severity level you can
  65 define separately what should be done with the diagnostic messages of
  66 that level, and the same for each debug area.</para>
  67
  68 <para>In full mode, first you should select the debug area you are
  69 interested in from the drop down box at the top.</para>
  70
  71 <para>You may independently set the output for various types of
  72 messages:</para>
  73
  74 <itemizedlist>
  75 <listitem><para><guilabel>Information</guilabel></para></listitem>
  76 <listitem><para><guilabel>Warning</guilabel></para></listitem>
  77 <listitem><para><guilabel>Error</guilabel></para></listitem>
  78 <listitem><para><guilabel>Fatal Error</guilabel></para></listitem>
  79 </itemizedlist>
  80
  81 <para>For each of these types, you can set the following:</para>
  82
  83 <variablelist>
  84 <varlistentry>
  85 <term><guilabel>Output to:</guilabel></term>
  86 <listitem>
  87 <para>In this Combobox, you can choose where the messages
  88 should be output. The choices are: <quote>File</quote>, <quote>Message
  89 Box</quote>, <quote>Shell</quote> (meaning stderr) and
  90 <quote>Syslog</quote>. Please do not direct fatal messages to syslog
  91 unless you are the system administrator yourself. The default is
  92 <quote>Message Box</quote>.</para>
  93 </listitem>
  94 </varlistentry>
  95
  96 <varlistentry>
  97 <term><guilabel>Filename:</guilabel></term>
  98 <listitem><para>This is only enabled when you have chosen
  99 <quote>File</quote> as the output and provides the name of that file
 100 (which is interpreted as relative to the current folder). The
 101 default is <filename>kdebug.dbg</filename>.</para>
 102 </listitem>
 103 </varlistentry>
 104 </variablelist>
 105
 106 <para>Apart from this, you can also tick the check box <guilabel>Abort
 107 on fatal errors</guilabel>. In this case, if a diagnostic message with
 108 the severity level <computeroutput>KDEBUG_FATAL</computeroutput> is
 109 output, the application aborts with a SIGABRT after outputting the
 110 message.</para>
 111
 112 <para>When you close the dialog by pressing <guibutton>OK</guibutton>,
 113 your entries apply immediately and are saved in
 114 <filename>kdebugrc</filename>. When you press
 115 <guibutton>Cancel</guibutton>, your entries are discarded and the old
 116 ones are restored.</para>
 117
 118 <para>Credits to Kalle Dalheimer for the original version of
 119 &kdebugdialog;</para>
 120
 121 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 122
 123 &underFDL;
 124
 125 </chapter>
 126
 127 &documentation.index;
 128 </book>
 129 <!--
 130 Local Variables:
 131 mode: sgml
 132 sgml-omittag: nil
 133 sgml-general-insert-case: lower
 134 sgml-shorttag: t
 135 End:
 136 -->
 137