/usr/share/gtk-doc/html/gdata/gdata-running.html is in libgdata-doc 0.16.1-1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GData Reference Manual: Running GData Applications</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="pt01.html" title="Part I. GData Overview">
<link rel="prev" href="gdata-overview.html" title="GData Overview">
<link rel="next" href="ch01.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.21.1 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="pt01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gdata-overview.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch01.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gdata-running"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gdata-overview.top_of_page"></a>Running GData Applications</span></h2>
<p>Running GData Applications — running and debugging GData applications</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="id-1.2.3.3"></a><h2>Running and Debugging GData Applications</h2>
<div class="refsect2">
<a name="id-1.2.3.3.2"></a><h3>Environment variables</h3>
<p>libgdata makes use of a few environment variables which affect how it runs, mainly with respect to debugging.</p>
<p><a name="LIBGDATA_DEBUG"></a><b><code class="envar">LIBGDATA_DEBUG</code>. </b>If this environment variable is set to one of the following values, libgdata will give debug output
(at various levels). If it's unset, no debug output will be produced.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">0</span></p></td>
<td><p>Output no debug messages or network logs.</p></td>
</tr>
<tr>
<td><p><span class="term">1</span></p></td>
<td><p>Output debug messages, but not network logs.</p></td>
</tr>
<tr>
<td><p><span class="term">2</span></p></td>
<td><p>Output debug messages and network traffic headers.</p></td>
</tr>
<tr>
<td><p><span class="term">3</span></p></td>
<td><p>Output debug messages and full network traffic logs.</p></td>
</tr>
</tbody>
</table></div>
<p>
So, to debug a program which uses libgdata, run it from a terminal with the following command:</p>
<pre class="screen"><code class="prompt">$</code><strong class="userinput"><code>LIBGDATA_DEBUG=3 ./my-program-name &> libgdata.log</code></strong></pre>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.3.3.3"></a><h3>Debugging Advice</h3>
<p>The easiest way to debug problems with libgdata is to use the
<a class="link" href="gdata-running.html#LIBGDATA_DEBUG" title="LIBGDATA_DEBUG"><code class="envar">LIBGDATA_DEBUG</code></a> environment variable to observe all the network
traffic being transmitted and received by libgdata. Typically, any problems will occur in the final network
request/response, which is the last one in the log output.</p>
<p>If debugging using the environment variables and log output is not possible, it is sometimes possible to diagnose problems
by examining the error responses sent by the Google servers to libgdata. These are exposed as the error messages returned
by libgdata methods; so when handling errors from libgdata method calls, it is a good idea to output the message from
the <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> to a debug log, or even as a warning in the user's
<code class="filename">.xsession-errors</code> file.</p>
<div class="example">
<a name="id-1.2.3.3.3.4"></a><p class="title"><b>Example 1. Error Handling when Uploading a Document</b></p>
<div class="example-contents">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17</pre></td>
<td class="listing_code"><pre class="programlisting">GDataUploadStream <span class="gtkdoc opt">*</span>upload_stream<span class="gtkdoc opt">;</span>
GError <span class="gtkdoc opt">*</span>error <span class="gtkdoc opt">=</span> NULL<span class="gtkdoc opt">;</span> <span class="comment">/* make sure to initialise the GError to NULL */</span>
<span class="comment">/* Other code goes here. */</span>
upload_stream <span class="gtkdoc opt">=</span> <span class="function"><a href="GDataDocumentsService.html#gdata-documents-service-upload-document">gdata_documents_service_upload_document</a></span> <span class="gtkdoc opt">(</span>service<span class="gtkdoc opt">,</span> document<span class="gtkdoc opt">,</span> slug<span class="gtkdoc opt">,</span> content_type<span class="gtkdoc opt">,</span> destination_folder<span class="gtkdoc opt">,</span> NULL<span class="gtkdoc opt">,</span>
<span class="gtkdoc opt">&</span>error<span class="gtkdoc opt">);</span>
<span class="comment">/* Handle any errors. */</span>
<span class="keyword">if</span> <span class="gtkdoc opt">(</span>error <span class="gtkdoc opt">!=</span> NULL<span class="gtkdoc opt">) {</span>
<span class="comment">/* Note that the error message is outputted to the terminal/logs.</span>
<span class="comment"> * It will contain important debugging information from the Google servers. */</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Message-Logging.html#g-error">g_error</a></span> <span class="gtkdoc opt">(</span><span class="string">"Error getting upload stream: %s"</span><span class="gtkdoc opt">,</span> error<span class="gtkdoc opt">-></span>message<span class="gtkdoc opt">);</span>
<span class="function"><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#g-error-free">g_error_free</a></span> <span class="gtkdoc opt">(</span>error<span class="gtkdoc opt">);</span>
<span class="keyword">return</span><span class="gtkdoc opt">;</span>
<span class="gtkdoc opt">}</span></pre></td>
</tr>
</tbody>
</table>
</div>
</div>
<br class="example-break">
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21.1</div>
</body>
</html>
|