libfm-doc 1.2.0-1ubuntu2 / usr / share / gtk-doc / html / libfm / FmDeepCountJob.html

This file is indexed.

/usr/share/gtk-doc/html/libfm/FmDeepCountJob.html is in libfm-doc 1.2.0-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
<!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 Reference Manual: FmDeepCountJob</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Libfm Reference Manual">
<link rel="up" href="libfm-jobs.html" title="Libfm Jobs.">
<link rel="prev" href="libfm-jobs.html" title="Libfm Jobs.">
<link rel="next" href="FmDirListJob.html" title="FmDirListJob">
<meta name="generator" content="GTK-Doc V1.20 (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="10"><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="#FmDeepCountJob.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 
                  <a href="#FmDeepCountJob.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="libfm-jobs.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libfm-jobs.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="FmDirListJob.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="FmDeepCountJob"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="FmDeepCountJob.top_of_page"></a>FmDeepCountJob</span></h2>
<p>FmDeepCountJob — Job to gather information about file sizes.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="FmDeepCountJob.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="FmDeepCountJob.html#FM-DEEP-COUNT-JOB-TYPE:CAPS" title="FM_DEEP_COUNT_JOB_TYPE">FM_DEEP_COUNT_JOB_TYPE</a></td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="returnvalue">FmDeepCountJob</span></a> *
</td>
<td class="function_name">
<a class="link" href="FmDeepCountJob.html#fm-deep-count-job-new" title="fm_deep_count_job_new ()">fm_deep_count_job_new</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="FmDeepCountJob.html#fm-deep-count-job-set-dest" title="fm_deep_count_job_set_dest ()">fm_deep_count_job_set_dest</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDeepCountJob.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmDeepCountJob.html#FmDeepCountJob-struct" title="struct FmDeepCountJob">FmDeepCountJob</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="FmDeepCountJob.html#FmDeepCountJobClass" title="struct FmDeepCountJobClass">FmDeepCountJobClass</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="FmDeepCountJob.html#FmDeepCountJobFlags" title="enum FmDeepCountJobFlags">FmDeepCountJobFlags</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="FmDeepCountJob.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="FmJob.html" title="FmJob">FmJob</a>
        <span class="lineart">╰──</span> FmDeepCountJob
</pre>
</div>
<div class="refsect1">
<a name="FmDeepCountJob.description"></a><h2>Description</h2>
<p><em class="parameter"><code>include</code></em>
: libfm/fm.h</p>
<p>The <a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="type">FmDeepCountJob</span></a> can be used to recursively gather information about
some files and directories content before copy or move. It counts total
size of all given files and directories, and size on disk for them.
If flags for the job include FM_DC_JOB_PREPARE_MOVE then also count of
files to move between volumes will be counted as well.</p>
</div>
<div class="refsect1">
<a name="FmDeepCountJob.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="FM-DEEP-COUNT-JOB-TYPE:CAPS"></a><h3>FM_DEEP_COUNT_JOB_TYPE</h3>
<pre class="programlisting">#define FM_DEEP_COUNT_JOB_TYPE              (fm_deep_count_job_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="fm-deep-count-job-new"></a><h3>fm_deep_count_job_new ()</h3>
<pre class="programlisting"><a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="returnvalue">FmDeepCountJob</span></a> *
fm_deep_count_job_new (<em class="parameter"><code><a class="link" href="libfm-FmPath.html#FmPathList" title="FmPathList"><span class="type">FmPathList</span></a> *paths</code></em>,
                       <em class="parameter"><code><a class="link" href="FmDeepCountJob.html#FmDeepCountJobFlags" title="enum FmDeepCountJobFlags"><span class="type">FmDeepCountJobFlags</span></a> flags</code></em>);</pre>
<p>Creates a new <a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="type">FmDeepCountJob</span></a> which can be ran via <a class="link" href="FmJob.html" title="FmJob"><span class="type">FmJob</span></a> API.</p>
<div class="refsect3">
<a name="id-1.2.5.2.7.3.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>paths</p></td>
<td class="parameter_description"><p>list of files and directories to count sizes</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flags</p></td>
<td class="parameter_description"><p>flags of the counting behavior</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.5.2.7.3.6"></a><h4>Returns</h4>
<p> a new <a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="type">FmDeepCountJob</span></a> object. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since 0.1.0</p>
</div>
<hr>
<div class="refsect2">
<a name="fm-deep-count-job-set-dest"></a><h3>fm_deep_count_job_set_dest ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
fm_deep_count_job_set_dest (<em class="parameter"><code><a class="link" href="FmDeepCountJob.html" title="FmDeepCountJob"><span class="type">FmDeepCountJob</span></a> *dc</code></em>,
                            <em class="parameter"><code><span class="type">dev_t</span> dev</code></em>,
                            <em class="parameter"><code>const <span class="type">char</span> *fs_id</code></em>);</pre>
<p>Sets destination for the job <em class="parameter"><code>dc</code></em>
 that will be used when the job is
ran with any of flags FM_DC_JOB_SAME_FS or FM_DC_JOB_PREPARE_MOVE.
If <em class="parameter"><code>dev</code></em>
 is 0 (and <em class="parameter"><code>fs_id</code></em>
 is NULL) then destination device is non on
native filesystem.</p>
<div class="refsect3">
<a name="id-1.2.5.2.7.4.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>dc</p></td>
<td class="parameter_description"><p>a job to set the destination</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>dev</p></td>
<td class="parameter_description"><p>UNIX device ID</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>fs_id</p></td>
<td class="parameter_description"><p> filesystem id in gio format. </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>
<p class="since">Since 0.1.0</p>
</div>
</div>
<div class="refsect1">
<a name="FmDeepCountJob.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="FmDeepCountJob-struct"></a><h3>struct FmDeepCountJob</h3>
<pre class="programlisting">struct FmDeepCountJob {
    FmJob parent;
    FmPathList* paths;
    FmDeepCountJobFlags flags;
    goffset total_size;
    goffset total_ondisk_size;
    guint count;
};
</pre>
<div class="refsect3">
<a name="id-1.2.5.2.8.2.4"></a><h4>Members</h4>
<div class="informaltable"><table 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><a class="link" href="FmJob.html" title="FmJob"><span class="type">FmJob</span></a> <em class="structfield"><code><a name="FmDeepCountJob-struct.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>the parent object</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libfm-FmPath.html#FmPathList" title="FmPathList"><span class="type">FmPathList</span></a> *<em class="structfield"><code><a name="FmDeepCountJob-struct.paths"></a>paths</code></em>;</p></td>
<td class="struct_member_description"><p>list of paths to count</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="FmDeepCountJob.html#FmDeepCountJobFlags" title="enum FmDeepCountJobFlags"><span class="type">FmDeepCountJobFlags</span></a> <em class="structfield"><code><a name="FmDeepCountJob-struct.flags"></a>flags</code></em>;</p></td>
<td class="struct_member_description"><p>flags for counting</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">goffset</span> <em class="structfield"><code><a name="FmDeepCountJob-struct.total-size"></a>total_size</code></em>;</p></td>
<td class="struct_member_description"><p>counted total file size</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">goffset</span> <em class="structfield"><code><a name="FmDeepCountJob-struct.total-ondisk-size"></a>total_ondisk_size</code></em>;</p></td>
<td class="struct_member_description"><p>counted total file size on disk</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a> <em class="structfield"><code><a name="FmDeepCountJob-struct.count"></a>count</code></em>;</p></td>
<td class="struct_member_description"><p>number of files to be moved between devices</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="FmDeepCountJobClass"></a><h3>struct FmDeepCountJobClass</h3>
<pre class="programlisting">struct FmDeepCountJobClass {
};
</pre>
</div>
<hr>
<div class="refsect2">
<a name="FmDeepCountJobFlags"></a><h3>enum FmDeepCountJobFlags</h3>
<div class="refsect3">
<a name="id-1.2.5.2.8.4.3"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="FM-DC-JOB-DEFAULT:CAPS"></a>FM_DC_JOB_DEFAULT</p></td>
<td class="enum_member_description">
<p>do deep count for all files/folders</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DC-JOB-FOLLOW-LINKS:CAPS"></a>FM_DC_JOB_FOLLOW_LINKS</p></td>
<td class="enum_member_description">
<p>don't follow symlinks</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DC-JOB-SAME-FS:CAPS"></a>FM_DC_JOB_SAME_FS</p></td>
<td class="enum_member_description">
<p>only do deep count for files on the same devices. what's the use case of this?</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DC-JOB-PREPARE-MOVE:CAPS"></a>FM_DC_JOB_PREPARE_MOVE</p></td>
<td class="enum_member_description">
<p>special handling for moving files. only do deep count for files on different devices</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="FM-DC-JOB-PREPARE-DELETE:CAPS"></a>FM_DC_JOB_PREPARE_DELETE</p></td>
<td class="enum_member_description">
<p>special handling for deleting files</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.20</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.