This file is indexed.

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

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
<!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</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libgrss Reference Manual">
<link rel="up" href="libgrss-utils.html" title="Part III. 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.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="GrssFeedsPool.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgrss-utils.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">libgrss Reference Manual</th>
<td><a accesskey="n" href="GrssFeedsSubscriber.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GrssFeedsGroup.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GrssFeedsGroup.description" class="shortcut">Description</a>
                   | 
                  <a href="#GrssFeedsGroup.object-hierarchy" class="shortcut">Object Hierarchy</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 valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GrssFeedsGroup.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct              <a class="link" href="GrssFeedsGroup.html#GrssFeedsGroup-struct" title="struct GrssFeedsGroup">GrssFeedsGroup</a>;
<a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="returnvalue">GrssFeedsGroup</span></a> *    <a class="link" href="GrssFeedsGroup.html#grss-feeds-group-new" title="grss_feeds_group_new ()">grss_feeds_group_new</a>                ();
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GrssFeedsGroup.html#grss-feeds-group-get-formats" title="grss_feeds_group_get_formats ()">grss_feeds_group_get_formats</a>        (<em class="parameter"><code><a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a> *group</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="GrssFeedsGroup.html#grss-feeds-group-parse-file" title="grss_feeds_group_parse_file ()">grss_feeds_group_parse_file</a>         (<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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="GrssFeedsGroup.html#grss-feeds-group-export-file" title="grss_feeds_group_export_file ()">grss_feeds_group_export_file</a>        (<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="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *channels</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GrssFeedsGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----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.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GrssFeedsGroup-struct"></a><h3>struct GrssFeedsGroup</h3>
<pre class="programlisting">struct GrssFeedsGroup;</pre>
<p>
</p>
</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="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>a new <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</td>
</tr></tbody>
</table></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="http://library.gnome.org/devel/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a list of constant strings with names of supported formats. The
list must be freed when no longer used</td>
</tr>
</tbody>
</table></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="http://library.gnome.org/devel/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="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>path of the file to parse.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>location for eventual errors.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>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.</td>
</tr>
</tbody>
</table></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="http://library.gnome.org/devel/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="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> *channels</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *format</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/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="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td>a <a class="link" href="GrssFeedsGroup.html" title="GrssFeedsGroup"><span class="type">GrssFeedsGroup</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>channels</code></em> :</span></p></td>
<td>list of <a href="GrssFeedChannel.html"><span class="type">GrssFeedChannels</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>format</code></em> :</span></p></td>
<td>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>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>URI of the file to write.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>location for eventual errors.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the file is created correctly, or <a href="http://library.gnome.org/devel/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.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>