/usr/share/doc/libgnomevfs2-common/html/gnome-vfs-2.0-gnome-vfs-mime.html is in libgnomevfs2-dev 1:2.24.4-1ubuntu2.
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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>MIME typing</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="mime-registry.html" title="MIME Registry">
<link rel="prev" href="mime-registry.html" title="MIME Registry">
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html" title="gnome-vfs-mime-utils">
<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="mime-registry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="mime-registry.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">GnomeVFS - Filesystem Abstraction library</th>
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gnome-vfs-2.0-gnome-vfs-mime.synopsis" class="shortcut">Top</a>
|
<a href="#gnome-vfs-2.0-gnome-vfs-mime.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-mime"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-mime.top_of_page"></a>MIME typing</span></h2>
<p>MIME typing — functions to get a mime-type for a file using its name or its content</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gnome-vfs-2.0-gnome-vfs-mime.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-from-name" title="gnome_vfs_mime_type_from_name ()">gnome_vfs_mime_type_from_name</a> (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-from-name-or-default" title="gnome_vfs_mime_type_from_name_or_default ()">gnome_vfs_mime_type_from_name_or_default</a>
(<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *defaultv</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-common" title="gnome_vfs_get_mime_type_common ()">gnome_vfs_get_mime_type_common</a> (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-from-uri" title="gnome_vfs_get_mime_type_from_uri ()">gnome_vfs_get_mime_type_from_uri</a> (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-from-file-data" title="gnome_vfs_get_mime_type_from_file_data ()">gnome_vfs_get_mime_type_from_file_data</a>
(<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type-fast" title="gnome_vfs_get_file_mime_type_fast ()">gnome_vfs_get_file_mime_type_fast</a> (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code>const <span class="type">struct stat</span> *optional_stat_info</code></em>);
const <span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type" title="gnome_vfs_get_file_mime_type ()">gnome_vfs_get_file_mime_type</a> (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code>const <span class="type">struct stat</span> *optional_stat_info</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> suffix_only</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-is-supertype" title="gnome_vfs_mime_type_is_supertype ()">gnome_vfs_mime_type_is_supertype</a> (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);
<span class="returnvalue">char</span> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-supertype-from-mime-type" title="gnome_vfs_get_supertype_from_mime_type ()">gnome_vfs_get_supertype_from_mime_type</a>
(<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-info-cache-reload" title="gnome_vfs_mime_info_cache_reload ()">gnome_vfs_mime_info_cache_reload</a> (<em class="parameter"><code>const <span class="type">char</span> *dir</code></em>);
<span class="returnvalue">void</span> <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-reload" title="gnome_vfs_mime_reload ()">gnome_vfs_mime_reload</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-shutdown" title="gnome_vfs_mime_shutdown ()">gnome_vfs_mime_shutdown</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-mime.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-mime.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="gnome-vfs-mime-type-from-name"></a><h3>gnome_vfs_mime_type_from_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_mime_type_from_name (<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_vfs_mime_type_from_name</code> is deprecated and should not be used in newly-written code. This function is deprecated, use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html#gnome-vfs-get-mime-type-for-name" title="gnome_vfs_get_mime_type_for_name ()"><code class="function">gnome_vfs_get_mime_type_for_name()</code></a> instead.</p>
</div>
<p>
Determine the mime type for <em class="parameter"><code>filename</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a filename (the file does not necessarily exist).</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for this filename. Will return
<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html#GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS" title="GNOME_VFS_MIME_TYPE_UNKNOWN"><code class="literal">GNOME_VFS_MIME_TYPE_UNKNOWN</code></a> if mime-type could not be found.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-mime-type-from-name-or-default"></a><h3>gnome_vfs_mime_type_from_name_or_default ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_mime_type_from_name_or_default
(<em class="parameter"><code>const <span class="type">char</span> *filename</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *defaultv</code></em>);</pre>
<p>
This routine tries to determine the mime-type of the filename
only by looking at the filename from the GNOME database of mime-types.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a filename (the file does not necessarily exist).</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>defaultv</code></em> :</span></p></td>
<td>a default value to be returned if no match is found.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type of the <em class="parameter"><code>filename</code></em>. If no value could be
determined, it will return <em class="parameter"><code>defaultv</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-mime-type-common"></a><h3>gnome_vfs_get_mime_type_common ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_get_mime_type_common (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);</pre>
<p>
Tries to guess the mime type of the file represented by <em class="parameter"><code>uri</code></em>.
Favors using the file data to the <em class="parameter"><code>uri</code></em> extension.
Handles <em class="parameter"><code>uri</code></em> of a non-existent file by falling back
on returning a type based on the extension. If cant find the mime-type based on the
extension also then returns 'application/octet-stream'.
</p>
<p>
FIXME: This function will not necessarily return the same mime type as doing a
get file info on the text uri.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a real file or a non-existent uri.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for <em class="parameter"><code>uri</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-mime-type-from-uri"></a><h3>gnome_vfs_get_mime_type_from_uri ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_get_mime_type_from_uri (<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);</pre>
<p>
Tries to guess the mime type of the file <em class="parameter"><code>uri</code></em> by
checking the file name extension. Works on non-existent
files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a file uri.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for file at <em class="parameter"><code>uri</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-mime-type-from-file-data"></a><h3>gnome_vfs_get_mime_type_from_file_data ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_get_mime_type_from_file_data
(<em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_vfs_get_mime_type_from_file_data</code> is deprecated and should not be used in newly-written code. </p>
</div>
<p>
Tries to guess the mime type of the file <em class="parameter"><code>uri</code></em> by
checking the file data using the magic patterns. Does not handle text files properly.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>a file uri.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for this filename.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-file-mime-type-fast"></a><h3>gnome_vfs_get_file_mime_type_fast ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_get_file_mime_type_fast (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code>const <span class="type">struct stat</span> *optional_stat_info</code></em>);</pre>
<p>
Tries to guess the mime type of the file represented by <em class="parameter"><code>path</code></em>.
It uses extention/name detection first, and if that fails
it falls back to mime-magic based lookup. This is faster
than always doing mime-magic but doesn't always produce
the right answer, so for important decisions
you should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type" title="gnome_vfs_get_file_mime_type ()"><code class="function">gnome_vfs_get_file_mime_type()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>path of the file whose mime type is to be found out.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>optional_stat_info</code></em> :</span></p></td>
<td>optional stat buffer.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for file at <em class="parameter"><code>path</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-file-mime-type"></a><h3>gnome_vfs_get_file_mime_type ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> * gnome_vfs_get_file_mime_type (<em class="parameter"><code>const <span class="type">char</span> *path</code></em>,
<em class="parameter"><code>const <span class="type">struct stat</span> *optional_stat_info</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> suffix_only</code></em>);</pre>
<p>
Tries to guess the mime type of the file represented by <em class="parameter"><code>path</code></em>.
If <em class="parameter"><code>suffix_only</code></em> is false, uses the mime-magic based lookup first.
Handles <em class="parameter"><code>path</code></em> of a non-existent file by falling back
on returning a type based on the extension.
</p>
<p>
If you need a faster, less accurate version, use
<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type-fast" title="gnome_vfs_get_file_mime_type_fast ()"><code class="function">gnome_vfs_get_file_mime_type_fast()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>path of a file whose mime type is to be found out.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>optional_stat_info</code></em> :</span></p></td>
<td>optional stat buffer.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>suffix_only</code></em> :</span></p></td>
<td>whether or not to do a magic-based lookup.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the mime-type for file at <em class="parameter"><code>path</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-mime-type-is-supertype"></a><h3>gnome_vfs_mime_type_is_supertype ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> gnome_vfs_mime_type_is_supertype (<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td>a const char * identifying a mime type.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether <em class="parameter"><code>mime_type</code></em> is of the form "foo<code class="literal">/</code>*".</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-get-supertype-from-mime-type"></a><h3>gnome_vfs_get_supertype_from_mime_type ()</h3>
<pre class="programlisting"><span class="returnvalue">char</span> * gnome_vfs_get_supertype_from_mime_type
(<em class="parameter"><code>const <span class="type">char</span> *mime_type</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td>mime type to get the supertype for.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The supertype for <em class="parameter"><code>mime_type</code></em>, allocating new memory.
The supertype of an application is computed by removing its
suffix, and replacing it with "*". Thus, "foo/bar" will be
converted to "foo<code class="literal">/</code>*".
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>
If this function is called on a supertype, it will return a copy of the supertype.
</div>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-mime-info-cache-reload"></a><h3>gnome_vfs_mime_info_cache_reload ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_vfs_mime_info_cache_reload (<em class="parameter"><code>const <span class="type">char</span> *dir</code></em>);</pre>
<p>
Reload the mime information for the <em class="parameter"><code>dir</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>dir</code></em> :</span></p></td>
<td>directory path which needs reloading.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-mime-reload"></a><h3>gnome_vfs_mime_reload ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_vfs_mime_reload (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Reload the MIME database.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-mime-shutdown"></a><h3>gnome_vfs_mime_shutdown ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_vfs_mime_shutdown (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_vfs_mime_shutdown</code> is deprecated and should not be used in newly-written code. This function doesn't have to be called as the
operating system automatically cleans up resources when exiting.
</p>
<p>
Unload the MIME database from memory.</p>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|