/usr/share/gtk-doc/html/libfm/libfm-Libfm.html is in libfm-doc 1.2.4-1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Libfm: Libfm Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-core.html" title="Libfm Core Reference.">
<link rel="prev" href="libfm-core.html" title="Libfm Core Reference.">
<link rel="next" href="libfm-GAppInfo-extensions.html" title="GAppInfo extensions">
<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="#libfm-Libfm.description" class="shortcut">Description</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="libfm-core.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libfm-core.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libfm-GAppInfo-extensions.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libfm-Libfm"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libfm-Libfm.top_of_page"></a>Libfm</span></h2>
<p>Libfm — Libfm initialization</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libfm-Libfm.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" 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="libfm-Libfm.html#FM-CHECK-VERSION:CAPS" title="FM_CHECK_VERSION()">FM_CHECK_VERSION</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libfm-Libfm.html#fm-finalize" title="fm_finalize ()">fm_finalize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="libfm-Libfm.html#fm-init" title="fm_init ()">fm_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libfm-Libfm.html#fm-version" title="fm_version ()">fm_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-Libfm.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" 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="libfm-Libfm.html#FM-VERSION-MAJOR:CAPS" title="FM_VERSION_MAJOR">FM_VERSION_MAJOR</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libfm-Libfm.html#FM-VERSION-MICRO:CAPS" title="FM_VERSION_MICRO">FM_VERSION_MICRO</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libfm-Libfm.html#FM-VERSION-MINOR:CAPS" title="FM_VERSION_MINOR">FM_VERSION_MINOR</a></td>
</tr>
<tr>
<td class="variable_type">extern GQuark </td>
<td class="function_name"><a class="link" href="libfm-Libfm.html#fm-qdata-id" title="fm_qdata_id">fm_qdata_id</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-Libfm.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm.h</p>
</div>
<div class="refsect1">
<a name="libfm-Libfm.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FM-CHECK-VERSION:CAPS"></a><h3>FM_CHECK_VERSION()</h3>
<pre class="programlisting">#define FM_CHECK_VERSION(_a,_b,_c)</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-finalize"></a><h3>fm_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_finalize ();</pre>
<p>Frees libfm data.</p>
<p>This API should be called exactly that many times the <a class="link" href="libfm-Libfm.html#fm-init" title="fm_init ()"><code class="function">fm_init()</code></a> was
called before.</p>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-init"></a><h3>fm_init ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_init (<em class="parameter"><code><a class="link" href="FmConfig.html" title="FmConfig"><span class="type">FmConfig</span></a> *config</code></em>);</pre>
<p>Initializes libfm data. This API should be always called before any
other Libfm function is called. It is idempotent.</p>
<div class="refsect3">
<a name="id-1.2.3.2.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" 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>config</p></td>
<td class="parameter_description"><p> configuration file data. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.2.6.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> in case of duplicate call.</p>
</div>
<p class="since">Since: 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-version"></a><h3>fm_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
fm_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns text representation of Libfm version.</p>
<div class="refsect3">
<a name="id-1.2.3.2.6.5.5"></a><h4>Returns</h4>
<p> text string. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: 1.2.0</p>
</div>
</div>
<div class="refsect1">
<a name="libfm-Libfm.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FM-VERSION-MAJOR:CAPS"></a><h3>FM_VERSION_MAJOR</h3>
<pre class="programlisting">#define FM_VERSION_MAJOR 1
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FM-VERSION-MICRO:CAPS"></a><h3>FM_VERSION_MICRO</h3>
<pre class="programlisting">#define FM_VERSION_MICRO 4
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FM-VERSION-MINOR:CAPS"></a><h3>FM_VERSION_MINOR</h3>
<pre class="programlisting">#define FM_VERSION_MINOR 2
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-qdata-id"></a><h3>fm_qdata_id</h3>
<pre class="programlisting">extern GQuark fm_qdata_id; /* a quark value used to associate data with objects */
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|