/usr/share/gtk-doc/html/camel/camel-camel-debug.html is in libcamel1.2-dev 3.2.3-0ubuntu6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>camel-debug</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Camel Reference Manual">
<link rel="up" href="Fundamentals.html" title="Fundamentals">
<link rel="prev" href="camel-camel.html" title="camel">
<link rel="next" href="CamelObject.html" title="CamelObject">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="camel-camel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="Fundamentals.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Camel Reference Manual</th>
<td><a accesskey="n" href="CamelObject.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#camel-camel-debug.synopsis" class="shortcut">Top</a>
|
<a href="#camel-camel-debug.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="camel-camel-debug"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="camel-camel-debug.top_of_page"></a>camel-debug</span></h2>
<p>camel-debug</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="camel-camel-debug.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">#define <a class="link" href="camel-camel-debug.html#CAMEL-DEBUG-IMAP:CAPS" title="CAMEL_DEBUG_IMAP">CAMEL_DEBUG_IMAP</a>
#define <a class="link" href="camel-camel-debug.html#CAMEL-DEBUG-IMAP-FOLDER:CAPS" title="CAMEL_DEBUG_IMAP_FOLDER">CAMEL_DEBUG_IMAP_FOLDER</a>
<span class="returnvalue">void</span> <a class="link" href="camel-camel-debug.html#camel-debug-init" title="camel_debug_init ()">camel_debug_init</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-camel-debug.html#camel-debug" title="camel_debug ()">camel_debug</a> (<em class="parameter"><code>const <span class="type">gchar</span> *mode</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="camel-camel-debug.html#camel-debug-start" title="camel_debug_start ()">camel_debug_start</a> (<em class="parameter"><code>const <span class="type">gchar</span> *mode</code></em>);
<span class="returnvalue">void</span> <a class="link" href="camel-camel-debug.html#camel-debug-end" title="camel_debug_end ()">camel_debug_end</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
#define <a class="link" href="camel-camel-debug.html#CAMEL-CHECK-GERROR:CAPS" title="CAMEL_CHECK_GERROR()">CAMEL_CHECK_GERROR</a> (object,
method,
expr,
error)
</pre>
</div>
<div class="refsect1">
<a name="camel-camel-debug.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="camel-camel-debug.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CAMEL-DEBUG-IMAP:CAPS"></a><h3>CAMEL_DEBUG_IMAP</h3>
<pre class="programlisting">#define CAMEL_DEBUG_IMAP "imap"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-DEBUG-IMAP-FOLDER:CAPS"></a><h3>CAMEL_DEBUG_IMAP_FOLDER</h3>
<pre class="programlisting">#define CAMEL_DEBUG_IMAP_FOLDER "imap:folder"
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-init"></a><h3>camel_debug_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_debug_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Init camel debug.
</p>
<p>
CAMEL_DEBUG is set to a comma separated list of modules to debug.
The modules can contain module-specific specifiers after a ':', or
just act as a wildcard for the module or even specifier. e.g. 'imap'
for imap debug, or 'imap:folder' for imap folder debug. Additionaly,
':folder' can be used for a wildcard for any folder operations.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug"></a><h3>camel_debug ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_debug (<em class="parameter"><code>const <span class="type">gchar</span> *mode</code></em>);</pre>
<p>
Check to see if a debug mode is activated. <em class="parameter"><code>mode</code></em> takes one of two forms,
a fully qualified 'module:target', or a wildcard 'module' name. It
returns a boolean to indicate if the module or module and target is
currently activated for debug output.
</p>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-start"></a><h3>camel_debug_start ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> camel_debug_start (<em class="parameter"><code>const <span class="type">gchar</span> *mode</code></em>);</pre>
<p>
Start debug output for a given mode, used to make sure debug output
is output atomically and not interspersed with unrelated stuff.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Returns true if mode is set, and in which case, you must
call debug_end when finished any screen output.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="camel-debug-end"></a><h3>camel_debug_end ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> camel_debug_end (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Call this when you're done with your debug output. If and only if
you called camel_debug_start, and if it returns TRUE.
</p>
</div>
<hr>
<div class="refsect2">
<a name="CAMEL-CHECK-GERROR:CAPS"></a><h3>CAMEL_CHECK_GERROR()</h3>
<pre class="programlisting">#define CAMEL_CHECK_GERROR(object, method, expr, error)</pre>
<p>
This sanity checks return values and <span class="type">GErrors</span>. If returning
failure, make sure the <span class="type">GError</span> is set. If returning success,
make sure the <span class="type">GError</span> is NOT set.
</p>
<p>
Example:
</p>
<p>
success = class->foo (object, some_data, error);
CAMEL_CHECK_GERROR (object, foo, success, error);
return success;
</p>
<p class="since">Since 2.32</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|