← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« back to all changes in this revision

Viewing changes to docs/reference/camel/xml/camel-debug.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/camel/xml/camel-debug.xml
1
 
<refentry id="camel-camel-debug">
2
 
<refmeta>
3
 
<refentrytitle role="top_of_page" id="camel-camel-debug.top_of_page">camel-debug</refentrytitle>
4
 
<manvolnum>3</manvolnum>
5
 
<refmiscinfo>CAMEL Library</refmiscinfo>
6
 
</refmeta>
7
 
 
8
 
<refnamediv>
9
 
<refname>camel-debug</refname>
10
 
<refpurpose></refpurpose>
11
 
</refnamediv>
12
 
 
13
 
<refsynopsisdiv id="camel-camel-debug.synopsis" role="synopsis">
14
 
<title role="synopsis.title">Synopsis</title>
15
 
 
16
 
<synopsis>
17
 
#define             <link linkend="CAMEL-DEBUG-IMAP--CAPS">CAMEL_DEBUG_IMAP</link>
18
 
#define             <link linkend="CAMEL-DEBUG-IMAP-FOLDER--CAPS">CAMEL_DEBUG_IMAP_FOLDER</link>
19
 
<link linkend="void">void</link>                <link linkend="camel-debug-init">camel_debug_init</link>                    (void);
20
 
<link linkend="gboolean">gboolean</link>            <link linkend="camel-debug">camel_debug</link>                         (const <link linkend="gchar">gchar</link> *mode);
21
 
<link linkend="gboolean">gboolean</link>            <link linkend="camel-debug-start">camel_debug_start</link>                   (const <link linkend="gchar">gchar</link> *mode);
22
 
<link linkend="void">void</link>                <link linkend="camel-debug-end">camel_debug_end</link>                     (void);
23
 
extern              gint <link linkend="camel-verbose-debug">camel_verbose_debug</link>;
24
 
</synopsis>
25
 
</refsynopsisdiv>
26
 
 
27
 
 
28
 
 
29
 
 
30
 
 
31
 
 
32
 
 
33
 
 
34
 
 
35
 
<refsect1 id="camel-camel-debug.description" role="desc">
36
 
<title role="desc.title">Description</title>
37
 
<para>
38
 
</para>
39
 
</refsect1>
40
 
 
41
 
<refsect1 id="camel-camel-debug.details" role="details">
42
 
<title role="details.title">Details</title>
43
 
<refsect2 id="CAMEL-DEBUG-IMAP--CAPS" role="macro">
44
 
<title>CAMEL_DEBUG_IMAP</title>
45
 
<indexterm zone="CAMEL-DEBUG-IMAP--CAPS"><primary sortas="CAMEL_DEBUG_IMAP">CAMEL_DEBUG_IMAP</primary></indexterm><programlisting>#define CAMEL_DEBUG_IMAP "imap"
46
 
</programlisting>
47
 
<para>
48
 
</para></refsect2>
49
 
<refsect2 id="CAMEL-DEBUG-IMAP-FOLDER--CAPS" role="macro">
50
 
<title>CAMEL_DEBUG_IMAP_FOLDER</title>
51
 
<indexterm zone="CAMEL-DEBUG-IMAP-FOLDER--CAPS"><primary sortas="CAMEL_DEBUG_IMAP_FOLDER">CAMEL_DEBUG_IMAP_FOLDER</primary></indexterm><programlisting>#define CAMEL_DEBUG_IMAP_FOLDER "imap:folder"
52
 
</programlisting>
53
 
<para>
54
 
</para></refsect2>
55
 
<refsect2 id="camel-debug-init" role="function">
56
 
<title>camel_debug_init ()</title>
57
 
<indexterm zone="camel-debug-init"><primary sortas="camel_debug_init">camel_debug_init</primary></indexterm><programlisting><link linkend="void">void</link>                camel_debug_init                    (void);</programlisting>
58
 
<para>
59
 
Init camel debug.  Maintain legacy CAMEL_VERBOSE_DEBUG as well as the
60
 
new CAMEL_DEBUG based environment variable interfaces.
61
 
</para>
62
 
<para>
63
 
CAMEL_VERBOSE_DEBUG is set to a number to turn debug on.
64
 
</para>
65
 
<para>
66
 
CAMEL_DEBUG is set to a comma separated list of modules to debug.
67
 
The modules can contain module-specific specifiers after a ':', or
68
 
just act as a wildcard for the module or even specifier.  e.g. 'imap'
69
 
for imap debug, or 'imap:folder' for imap folder debug.  Additionaly,
70
 
':folder' can be used for a wildcard for any folder operations.</para>
71
 
<para>
72
 
</para><variablelist role="params">
73
 
<varlistentry><term><parameter>void</parameter>&#160;:</term>
74
 
<listitem><simpara>
75
 
</simpara></listitem></varlistentry>
76
 
</variablelist></refsect2>
77
 
<refsect2 id="camel-debug" role="function">
78
 
<title>camel_debug ()</title>
79
 
<indexterm zone="camel-debug"><primary sortas="camel_debug">camel_debug</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_debug                         (const <link linkend="gchar">gchar</link> *mode);</programlisting>
80
 
<para>
81
 
Check to see if a debug mode is activated.  <parameter>mode</parameter> takes one of two forms,
82
 
a fully qualified 'module:target', or a wildcard 'module' name.  It
83
 
returns a boolean to indicate if the module or module and target is
84
 
currently activated for debug output.</para>
85
 
<para>
86
 
</para><variablelist role="params">
87
 
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
88
 
<listitem><simpara>
89
 
</simpara></listitem></varlistentry>
90
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
91
 
</simpara></listitem></varlistentry>
92
 
</variablelist></refsect2>
93
 
<refsect2 id="camel-debug-start" role="function">
94
 
<title>camel_debug_start ()</title>
95
 
<indexterm zone="camel-debug-start"><primary sortas="camel_debug_start">camel_debug_start</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            camel_debug_start                   (const <link linkend="gchar">gchar</link> *mode);</programlisting>
96
 
<para>
97
 
Start debug output for a given mode, used to make sure debug output
98
 
is output atomically and not interspersed with unrelated stuff.</para>
99
 
<para>
100
 
</para><variablelist role="params">
101
 
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
102
 
<listitem><simpara>
103
 
</simpara></listitem></varlistentry>
104
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> Returns true if mode is set, and in which case, you must
105
 
call debug_end when finished any screen output.
106
 
</simpara></listitem></varlistentry>
107
 
</variablelist></refsect2>
108
 
<refsect2 id="camel-debug-end" role="function">
109
 
<title>camel_debug_end ()</title>
110
 
<indexterm zone="camel-debug-end"><primary sortas="camel_debug_end">camel_debug_end</primary></indexterm><programlisting><link linkend="void">void</link>                camel_debug_end                     (void);</programlisting>
111
 
<para>
112
 
Call this when you're done with your debug output.  If and only if
113
 
you called camel_debug_start, and if it returns TRUE.</para>
114
 
<para>
115
 
</para></refsect2>
116
 
<refsect2 id="camel-verbose-debug" role="variable" condition="deprecated:">
117
 
<title>camel_verbose_debug</title>
118
 
<indexterm zone="camel-verbose-debug" role="deprecated"><primary sortas="camel_verbose_debug">camel_verbose_debug</primary></indexterm><programlisting>extern gint camel_verbose_debug;
119
 
</programlisting>
120
 
<warning><para><literal>camel_verbose_debug</literal> is deprecated and should not be used in newly-written code.</para></warning>
121
 
<para>
122
 
</para></refsect2>
123
 
 
124
 
</refsect1>
125
 
 
126
 
 
127
 
 
128
 
 
129
 
</refentry>