libfm-doc 1.2.5-1ubuntu1 / usr / share / gtk-doc / html / libfm / libfm-FmArchiver.html

This file is indexed.

/usr/share/gtk-doc/html/libfm/libfm-FmArchiver.html is in libfm-doc 1.2.5-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
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
359
360
361
362
363
364
365
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>FmArchiver: 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-GAppInfo-extensions.html" title="GAppInfo extensions">
<link rel="next" href="FmBookmarks.html" title="FmBookmarks">
<meta name="generator" content="GTK-Doc V1.25 (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-FmArchiver.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-GAppInfo-extensions.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FmBookmarks.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libfm-FmArchiver"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libfm-FmArchiver.top_of_page"></a>FmArchiver</span></h2>
<p>FmArchiver — Support for packing and unpacking archiver utilities.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libfm-FmArchiver.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="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-FmArchiver.html#fm-archiver-create-archive" title="fm_archiver_create_archive ()">fm_archiver_create_archive</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-FmArchiver.html#fm-archiver-extract-archives" title="fm_archiver_extract_archives ()">fm_archiver_extract_archives</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-FmArchiver.html#fm-archiver-extract-archives-to" title="fm_archiver_extract_archives_to ()">fm_archiver_extract_archives_to</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libfm-FmArchiver.html#fm-archiver-get-all" title="fm_archiver_get_all ()">fm_archiver_get_all</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="returnvalue">FmArchiver</span></a> *
</td>
<td class="function_name">
<a class="link" href="libfm-FmArchiver.html#fm-archiver-get-default" title="fm_archiver_get_default ()">fm_archiver_get_default</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-FmArchiver.html#fm-archiver-is-mime-type-supported" title="fm_archiver_is_mime_type_supported ()">fm_archiver_is_mime_type_supported</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-FmArchiver.html#fm-archiver-set-default" title="fm_archiver_set_default ()">fm_archiver_set_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-FmArchiver.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver">FmArchiver</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libfm-FmArchiver.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm.h</p>
<p>The <a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> represents support for utilities which can pack files
into archive and/or extract them.</p>
</div>
<div class="refsect1">
<a name="libfm-FmArchiver.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="fm-archiver-create-archive"></a><h3>fm_archiver_create_archive ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_archiver_create_archive (<em class="parameter"><code><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> *archiver</code></em>,
                            <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAppInfo.html#GAppLaunchContext-struct"><span class="type">GAppLaunchContext</span></a> *ctx</code></em>,
                            <em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPathList" title="FmPathList"><span class="type">FmPathList</span></a> *files</code></em>);</pre>
<p>Creates an archive for <em class="parameter"><code>files</code></em>
.</p>
<div class="refsect3">
<a name="fm-archiver-create-archive.parameters"></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>archiver</p></td>
<td class="parameter_description"><p>the archiver descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p> a launch context. </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>
<tr>
<td class="parameter_name"><p>files</p></td>
<td class="parameter_description"><p>files to pack into archive</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-archiver-create-archive.returns"></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>.</p>
</div>
<p class="since">Since: 0.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-extract-archives"></a><h3>fm_archiver_extract_archives ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_archiver_extract_archives (<em class="parameter"><code><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> *archiver</code></em>,
                              <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAppInfo.html#GAppLaunchContext-struct"><span class="type">GAppLaunchContext</span></a> *ctx</code></em>,
                              <em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPathList" title="FmPathList"><span class="type">FmPathList</span></a> *files</code></em>);</pre>
<p>Extracts files from archives.</p>
<div class="refsect3">
<a name="fm-archiver-extract-archives.parameters"></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>archiver</p></td>
<td class="parameter_description"><p>the archiver descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p> a launch context. </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>
<tr>
<td class="parameter_name"><p>files</p></td>
<td class="parameter_description"><p>archives to unpack</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-archiver-extract-archives.returns"></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>.</p>
</div>
<p class="since">Since: 0.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-extract-archives-to"></a><h3>fm_archiver_extract_archives_to ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_archiver_extract_archives_to (<em class="parameter"><code><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> *archiver</code></em>,
                                 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAppInfo.html#GAppLaunchContext-struct"><span class="type">GAppLaunchContext</span></a> *ctx</code></em>,
                                 <em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPathList" title="FmPathList"><span class="type">FmPathList</span></a> *files</code></em>,
                                 <em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPath" title="FmPath"><span class="type">FmPath</span></a> *dest_dir</code></em>);</pre>
<p>Extracts files from archives into <em class="parameter"><code>dest_dir</code></em>
.</p>
<div class="refsect3">
<a name="fm-archiver-extract-archives-to.parameters"></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>archiver</p></td>
<td class="parameter_description"><p>archiver descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>ctx</p></td>
<td class="parameter_description"><p> a launch context. </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>
<tr>
<td class="parameter_name"><p>files</p></td>
<td class="parameter_description"><p>archives to unpack</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dest_dir</p></td>
<td class="parameter_description"><p>directory where files should be extracted to</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="fm-archiver-extract-archives-to.returns"></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>.</p>
</div>
<p class="since">Since: 0.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-get-all"></a><h3>fm_archiver_get_all ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
fm_archiver_get_all ();</pre>
<p>Retrieves a list of <a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> of all GUI archivers known to libfm.</p>
<p>This API is not thread-safe and should be used only in default context.</p>
<div class="refsect3">
<a name="fm-archiver-get-all.returns"></a><h4>Returns</h4>
<p> list of archivers.</p>
</div>
<p class="since">Since: 0.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-get-default"></a><h3>fm_archiver_get_default ()</h3>
<pre class="programlisting"><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="returnvalue">FmArchiver</span></a> *
fm_archiver_get_default ();</pre>
<p>Retrieves default GUI archiver used by libfm.</p>
<p>This API is not thread-safe and should be used only in default context.</p>
<div class="refsect3">
<a name="fm-archiver-get-default.returns"></a><h4>Returns</h4>
<p> archiver descriptor.</p>
</div>
<p class="since">Since: 0.1.9</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-is-mime-type-supported"></a><h3>fm_archiver_is_mime_type_supported ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
fm_archiver_is_mime_type_supported (<em class="parameter"><code><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> *archiver</code></em>,
                                    <em class="parameter"><code>const <span class="type">char</span> *type</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-archiver-set-default"></a><h3>fm_archiver_set_default ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_archiver_set_default (<em class="parameter"><code><a class="link" href="libfm-FmArchiver.html#FmArchiver" title="struct FmArchiver"><span class="type">FmArchiver</span></a> *archiver</code></em>);</pre>
<p>Sets default GUI archiver used by libfm.</p>
<p>This API is not thread-safe and should be used only in default context.</p>
<div class="refsect3">
<a name="fm-archiver-set-default.parameters"></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>archiver</p></td>
<td class="parameter_description"><p>archiver descriptor</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: 0.1.9</p>
</div>
</div>
<div class="refsect1">
<a name="libfm-FmArchiver.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmArchiver"></a><h3>struct FmArchiver</h3>
<pre class="programlisting">struct FmArchiver {
    char* program;
    char* create_cmd;
    char* extract_cmd;
    char* extract_to_cmd;
    char** mime_types;
};
</pre>
<div class="refsect3">
<a name="FmArchiver.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmArchiver.program"></a>program</code></em>;</p></td>
<td class="struct_member_description"><p>archiver program</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmArchiver.create-cmd"></a>create_cmd</code></em>;</p></td>
<td class="struct_member_description"><p>command to create archive</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmArchiver.extract-cmd"></a>extract_cmd</code></em>;</p></td>
<td class="struct_member_description"><p>command to extract files from archive</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> *<em class="structfield"><code><a name="FmArchiver.extract-to-cmd"></a>extract_to_cmd</code></em>;</p></td>
<td class="struct_member_description"><p>command to extract files into destined directory</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> **<em class="structfield"><code><a name="FmArchiver.mime-types"></a>mime_types</code></em>;</p></td>
<td class="struct_member_description"><p>list of archive types the archiver supports</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.