This file is indexed.

/usr/share/gtk-doc/html/libgrss/GrssFeedsGroup.html is in libgrss-dev 0.7.0-2.

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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GrssFeedsGroup: libgrss Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libgrss Reference Manual">
<link rel="up" href="libgrss-useful.html" title="Part IV. Useful Objects">
<link rel="prev" href="GrssFeedsPool.html" title="GrssFeedsPool">
<link rel="next" href="GrssFeedsSubscriber.html" title="GrssFeedsSubscriber">
<meta name="generator" content="GTK-Doc V1.24 (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">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GrssFeedsGroup.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GrssFeedsGroup.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</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="libgrss-useful.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GrssFeedsPool.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GrssFeedsSubscriber.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GrssFeedsGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GrssFeedsGroup.top_of_page"></a>GrssFeedsGroup</span></h2>
<p>GrssFeedsGroup — import and export group of channels</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GrssFeedsGroup.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#FEEDS-GROUP:CAPS" title="FEEDS_GROUP()">FEEDS_GROUP</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#FEEDS-GROUP-CLASS:CAPS" title="FEEDS_GROUP_CLASS()">FEEDS_GROUP_CLASS</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#FEEDS-GROUP-GET-CLASS:CAPS" title="FEEDS_GROUP_GET_CLASS()">FEEDS_GROUP_GET_CLASS</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="returnvalue">GrssFeedsGroup</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#grss-feeds-group-new" title="grss_feeds_group_new ()">grss_feeds_group_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#grss-feeds-group-get-formats" title="grss_feeds_group_get_formats ()">grss_feeds_group_get_formats</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#grss-feeds-group-parse-file" title="grss_feeds_group_parse_file ()">grss_feeds_group_parse_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GrssFeedsGroup.html#grss-feeds-group-export-file" title="grss_feeds_group_export_file ()">grss_feeds_group_export_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="GrssFeedsGroup.html#FEEDS-GROUP-TYPE:CAPS" title="FEEDS_GROUP_TYPE">FEEDS_GROUP_TYPE</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> GrssFeedsGroup
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.description"></a><h2>Description</h2>
<p><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a> is an utility to read and write lists of <a href="GrssFeedChannel.html"><span class="type">GrssFeedChannels</span></a>
in different formats, such as OPML and XOXO.</p>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FEEDS-GROUP:CAPS"></a><h3>FEEDS_GROUP()</h3>
<pre class="programlisting">#define FEEDS_GROUP(o)			(G_TYPE_CHECK_INSTANCE_CAST ((o), FEEDS_GROUP_TYPE, GrssFeedsGroup))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FEEDS-GROUP-CLASS:CAPS"></a><h3>FEEDS_GROUP_CLASS()</h3>
<pre class="programlisting">#define FEEDS_GROUP_CLASS(c)		(G_TYPE_CHECK_CLASS_CAST ((c), FEEDS_GROUP_TYPE, GrssFeedsGroupClass))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FEEDS-GROUP-GET-CLASS:CAPS"></a><h3>FEEDS_GROUP_GET_CLASS()</h3>
<pre class="programlisting">#define FEEDS_GROUP_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), FEEDS_GROUP_TYPE, GrssFeedsGroupClass))
</pre>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-group-new"></a><h3>grss_feeds_group_new ()</h3>
<pre class="programlisting"><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="returnvalue">GrssFeedsGroup</span></a> *
grss_feeds_group_new ();</pre>
<p>Allocates a new <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</p>
<div class="refsect3">
<a name="id-1.5.3.7.5.5"></a><h4>Returns</h4>
<p> a new <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-group-get-formats"></a><h3>grss_feeds_group_get_formats ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
grss_feeds_group_get_formats (<em class="parameter"><code><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a> *group</code></em>);</pre>
<p>Returns the list of supported file formats.</p>
<div class="refsect3">
<a name="id-1.5.3.7.6.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.7.6.6"></a><h4>Returns</h4>
<p> a list of
constant strings with names of supported formats. The list must be
freed when no longer used. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-group-parse-file"></a><h3>grss_feeds_group_parse_file ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
grss_feeds_group_parse_file (<em class="parameter"><code><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a> *group</code></em>,
                             <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                             <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Parses the given file to obtain list of listed feeds.</p>
<div class="refsect3">
<a name="id-1.5.3.7.7.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>path</p></td>
<td class="parameter_description"><p>path of the file to parse.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location for eventual errors.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.7.7.6"></a><h4>Returns</h4>
<p> a list
of <a href="GrssFeedChannel.html"><span class="type">GrssFeedChannels</span></a>, or NULL if an error occours and <em class="parameter"><code>error</code></em>
is
set. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GrssFeedChannel][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="grss-feeds-group-export-file"></a><h3>grss_feeds_group_export_file ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
grss_feeds_group_export_file (<em class="parameter"><code><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a> *group</code></em>,
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *channels</code></em>,
                              <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                              <em class="parameter"><code>const <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
                              <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Creates a new file with the list of <em class="parameter"><code>channels</code></em>
 rappresented in the required
<em class="parameter"><code>format</code></em>
. It a file already exists at the <em class="parameter"><code>uri</code></em>
 location, it is overwritten.</p>
<div class="refsect3">
<a name="id-1.5.3.7.8.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>channels</p></td>
<td class="parameter_description"><p> list of <a href="GrssFeedChannel.html"><span class="type">GrssFeedChannels</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GrssFeedChannel]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>format</p></td>
<td class="parameter_description"><p>string rappresenting the desired export format, as returnes by
<a class="link" href="GrssFeedsGroup.html#grss-feeds-group-get-formats" title="grss_feeds_group_get_formats ()"><code class="function">grss_feeds_group_get_formats()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>uri</p></td>
<td class="parameter_description"><p>URI of the file to write.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>location for eventual errors.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.5.3.7.8.6"></a><h4>Returns</h4>
<p> <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file is created correctly, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if an error
occours and <em class="parameter"><code>error</code></em>
is set.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FEEDS-GROUP-TYPE:CAPS"></a><h3>FEEDS_GROUP_TYPE</h3>
<pre class="programlisting">#define FEEDS_GROUP_TYPE		(grss_feeds_group_get_type())
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>