Warning, /frameworks/kdelibs4support/docs/kdebugdialog5/index.docbook is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0" ?> 0002 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" 0003 "dtd/kdedbx45.dtd" [ 0004 <!ENTITY kdebugdialog5 "<application>KDebugDialog</application>"> 0005 <!ENTITY kappname "&kdebugdialog;"> 0006 <!ENTITY % addindex "IGNORE"> 0007 <!ENTITY % English "INCLUDE" > <!-- change language only here --> 0008 0009 0010 ]> 0011 0012 <article id="kdebugdialog5" lang="&language;"> 0013 <title>KDebugDialog</title> 0014 <articleinfo> 0015 <authorgroup> 0016 <author>&David.Faure; &David.Faure.mail;</author> 0017 <!-- TRANS:ROLES_OF_TRANSLATORS --> 0018 </authorgroup> 0019 0020 <date>2016-04-02</date> 0021 <releaseinfo>Frameworks 5.21</releaseinfo> 0022 0023 <keywordset> 0024 <keyword>KDE</keyword> 0025 <keyword>KDebugdialog</keyword> 0026 <keyword>Debug</keyword> 0027 </keywordset> 0028 </articleinfo> 0029 0030 0031 <para>&kdebugdialog; is a dialog box for managing diagnostic messages at runtime. 0032 It features a simple and a full mode.</para> 0033 <para>In order to be able to make changes 0034 <guilabel>Disable all debug output</guilabel> has to be unchecked.</para> 0035 0036 <note> 0037 <para>Only for applications using the &frameworks; library kdelibs4support.</para> 0038 <para>kDebug() has been deprecated in &kf5-full;, in favour of &Qt;'s builtin categorized 0039 logging, see<ulink url="https://doc.qt.io/qt-5/qloggingcategory.html">QLoggingCategory</ulink>. 0040 Use the program <ulink url="https://invent.kde.org/utilities/kdebugsettings">KDebugSettings</ulink> 0041 to enable/disable qCDebug. 0042 </para> 0043 </note> 0044 0045 <variablelist> 0046 <varlistentry> 0047 <term>Simple mode</term> 0048 <listitem> 0049 <para>If you simply start <command>kdebugdialog5</command>, you will 0050 see a list of <quote>areas</quote>, that can be disabled or enabled. A 0051 <function>kDebug(area)</function> call in the code will show 0052 something in the debug output only if the area is enabled.</para> 0053 0054 <note><para>Note that kWarning, kError and kFatal always appear, 0055 they are <emphasis>NOT</emphasis> controlled by this setting. </para></note> 0056 0057 <para>Enter a matching string into the <guilabel>Search</guilabel> 0058 box at the top of the list, this allows you to filter the areas 0059 which are displayed in the list view. 0060 Use the buttons below the list to select or deselect all items in the view 0061 (the other areas are not effected) or change the debug output for a single 0062 item using the check box in front of it. 0063 </para> 0064 0065 </listitem> 0066 </varlistentry> 0067 0068 <varlistentry> 0069 <term>Full mode</term> 0070 <listitem> 0071 <para>If you start <command>kdebugdialog5</command> 0072 <option>--fullmode</option>, then for every severity level you can 0073 define separately what should be done with the diagnostic messages of 0074 that level, and the same for each debug area.</para> 0075 0076 <para>In full mode, first you should select the debug area you are 0077 interested in from the list at the left of the dialog using the 0078 search box at the top of the list.</para> 0079 0080 <para>You may independently set the output for various types of 0081 messages:</para> 0082 0083 <itemizedlist> 0084 <listitem><para><guilabel>Information</guilabel></para></listitem> 0085 <listitem><para><guilabel>Warning</guilabel></para></listitem> 0086 <listitem><para><guilabel>Error</guilabel></para></listitem> 0087 <listitem><para><guilabel>Fatal Error</guilabel></para></listitem> 0088 </itemizedlist> 0089 0090 <para>For each of these types, you can set the following:</para> 0091 0092 <variablelist> 0093 <varlistentry> 0094 <term><guilabel>Output to:</guilabel></term> 0095 <listitem> 0096 <para>In this Combobox, you can choose where the messages 0097 should be output. The choices are: <quote>File</quote>, <quote>Message 0098 Box</quote>, <quote>Shell</quote> (meaning stderr) and 0099 <quote>Syslog</quote>. Please do not direct fatal messages to syslog 0100 unless you are the system administrator yourself. The default is 0101 <quote>Shell</quote>.</para> 0102 </listitem> 0103 </varlistentry> 0104 0105 <varlistentry> 0106 <term><guilabel>Filename:</guilabel></term> 0107 <listitem><para>This is only enabled when you have chosen 0108 <quote>File</quote> as the output and provides the name of that file 0109 (which is interpreted as relative to the current folder). The 0110 default is <filename>kdebug.dbg</filename>.</para> 0111 </listitem> 0112 </varlistentry> 0113 </variablelist> 0114 0115 <para>Apart from this, you can also tick the check box <guilabel>Abort 0116 on fatal errors</guilabel>. In this case, if a diagnostic message with 0117 the severity level <computeroutput>KDEBUG_FATAL</computeroutput> is 0118 output, the application aborts with a SIGABRT after outputting the 0119 message.</para> 0120 0121 </listitem> 0122 </varlistentry> 0123 </variablelist> 0124 0125 <para>When you close the dialog by pressing <guibutton>OK</guibutton>, 0126 your entries apply immediately and are saved in 0127 <filename>$<envar>XDG_CONFIG_HOME</envar>/kdebugrc</filename> 0128 (<filename>~/.config/kdebugrc</filename> by default). When you press 0129 <guibutton>Cancel</guibutton>, your entries are discarded and the old 0130 ones are restored.</para> 0131 0132 <para>Credits to Kalle Dalheimer for the original version of 0133 &kdebugdialog;</para> 0134 0135 <!-- TRANS:CREDIT_FOR_TRANSLATORS --> 0136 0137 &underFDL; 0138 0139 </article> 0140 <!-- 0141 Local Variables: 0142 mode: sgml 0143 sgml-omittag: nil 0144 sgml-general-insert-case: lower 0145 sgml-shorttag: t 0146 End: 0147 --> 0148