<FILENAME filename="index.html"><html><head><title>KDebugDialog</title><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-default.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-docs.css"><link rel="stylesheet" type="text/css" href="help:/kdoctools5-common/kde-localised.css"><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><meta name="keywords" content="KDE, KDebugdialog, Debug"><link rel="home" href="index.html" title="KDebugDialog"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="GENERATOR" content="KDE XSL Stylesheet V1.14 using libxslt"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div id="content"><div id="header"><div id="header_content"><div id="header_left"><div id="header_right"><img src="help:/kdoctools5-common/top-kde.jpg" width="36" height="34"> KDebugDialog</div></div></div></div><div class="navCenter"><table class="navigation"><tr><td class="prevCell"></td><td class="upCell"> </td><td class="nextCell"></td></tr></table></div><div id="contentBody"><div lang="en" class="article"><div class="titlepage"><div><div><h2 class="title"><a name="kdebugdialog5"></a>KDebugDialog</h2></div><div><div class="authorgroup"><p class="author"><span class="firstname">David</span> <span class="surname">Faure</span> <code class="email"><faure@kde.org></code></p></div></div><div>Revision <span class="releaseinfo">Frameworks 5.21 (<span class="date">2016-04-02</span>)</span></div></div><hr></div><p><span class="application">KDebugDialog</span> is a dialog box for managing diagnostic messages at runtime. It features a simple and a full mode.</p><p>In order to be able to make changes <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Disable all debug output</span></span> has to be unchecked.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Only for applications using the <span class="productname">Frameworks</span> library kdelibs4support.</p><p>kDebug() has been deprecated in <span class="productname"><span class="orgname">KDE</span> Frameworks</span> <span class="productnumber">5</span>, in favour of <span class="trademark">Qt</span>™'s builtin categorized logging, see<a class="ulink" href="https://doc.qt.io/qt-5/qloggingcategory.html" target="_top">QLoggingCategory</a>. Use the program <a class="ulink" href="https://invent.kde.org/utilities/kdebugsettings" target="_top">KDebugSettings</a> to enable/disable qCDebug. </p></div><div class="variablelist"><dl class="variablelist"><dt><span class="term">Simple mode</span></dt><dd><p>If you simply start <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><span class="command"><strong>kdebugdialog5</strong></span></span>, you will see a list of <span class="quote">“<span class="quote">areas</span>”</span>, that can be disabled or enabled. A <code class="function">kDebug(area)</code> call in the code will show something in the debug output only if the area is enabled.</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>Note that kWarning, kError and kFatal always appear, they are <span class="emphasis"><em>NOT</em></span> controlled by this setting. </p></div><p>Enter a matching string into the <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Search</span></span> box at the top of the list, this allows you to filter the areas which are displayed in the list view. Use the buttons below the list to select or deselect all items in the view (the other areas are not effected) or change the debug output for a single item using the check box in front of it. </p></dd><dt><span class="term">Full mode</span></dt><dd><p>If you start <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="command"><span class="command"><strong>kdebugdialog5</strong></span></span> <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="option"><code class="option">--fullmode</code></span>, 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.</p><p>In full mode, first you should select the debug area you are interested in from the list at the left of the dialog using the search box at the top of the list.</p><p>You may independently set the output for various types of messages:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Information</span></span></p></li><li class="listitem"><p><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Warning</span></span></p></li><li class="listitem"><p><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Error</span></span></p></li><li class="listitem"><p><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Fatal Error</span></span></p></li></ul></div><p>For each of these types, you can set the following:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Output to:</span></span></span></dt><dd><p>In this Combobox, you can choose where the messages should be output. The choices are: <span class="quote">“<span class="quote">File</span>”</span>, <span class="quote">“<span class="quote">Message Box</span>”</span>, <span class="quote">“<span class="quote">Shell</span>”</span> (meaning stderr) and <span class="quote">“<span class="quote">Syslog</span>”</span>. Please do not direct fatal messages to syslog unless you are the system administrator yourself. The default is <span class="quote">“<span class="quote">Shell</span>”</span>.</p></dd><dt><span class="term"><span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Filename:</span></span></span></dt><dd><p>This is only enabled when you have chosen <span class="quote">“<span class="quote">File</span>”</span> as the output and provides the name of that file (which is interpreted as relative to the current folder). The default is <code class="filename">kdebug.dbg</code>.</p></dd></dl></div><p>Apart from this, you can also tick the check box <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guilabel">Abort on fatal errors</span></span>. In this case, if a diagnostic message with the severity level <code class="computeroutput">KDEBUG_FATAL</code> is output, the application aborts with a SIGABRT after outputting the message.</p></dd></dl></div><p>When you close the dialog by pressing <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guibutton">OK</span></span>, your entries apply immediately and are saved in <code class="filename">$<span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="envar"><code class="envar">XDG_CONFIG_HOME</code></span>/kdebugrc</code> (<code class="filename">~/.config/kdebugrc</code> by default). When you press <span xmlns:doc="http://nwalsh.com/xsl/documentation/1.0" class="guiitem"><span class="guibutton">Cancel</span></span>, your entries are discarded and the old ones are restored.</p><p>Credits to Kalle Dalheimer for the original version of <span class="application">KDebugDialog</span></p><p><a name="gnu-fdl"></a>This documentation is licensed under the terms of the <a class="ulink" href="help:/kdoctools5-common/fdl-license.html" target="_top">GNU Free Documentation License</a>.</p></div></div><div id="footer"><div class="navCenter"><table class="navigation"><tr><td class="prevCell"></td><td class="upCell"> </td><td class="nextCell"></td></tr><tr><td class="prevCell"> </td><td class="upCell"> </td><td class="nextCell"> </td></tr></table></div><div id="footer_text">Would you like to make a comment or contribute an update to this page?<br>Send feedback to the <a href="mailto:kde-doc-english@kde.org" class="footer_email">KDE Docs Team</a></div></div></div></body></html></FILENAME>
Generated by dwww version 1.15 on Fri May 24 02:35:24 CEST 2024.