← Back to branch summary

~ubuntu-branches/debian/squeeze/devicekit-disks/squeeze

« back to all changes in this revision

Viewing changes to doc/html/Disks.html

  • Committer: Bazaar Package Importer
  • Author(s): Michael Biebl, Martin Pitt, Michael Biebl
  • Date: 2009-11-05 14:26:06 UTC
  • mfrom: (1.2.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20091105142606-gv7df6uk7s7voro1
Tags: 009-1
http://bugs.debian.org/548758
http://bugs.debian.org/545032
[ Martin Pitt ]
* New upstream release.
* 08-dont-probe-dm-devices.patch: Update for new release.
* Drop 07-media-player-icon.patch as well, it was included upstream in 008.
* debian/devicekit-disks.postinst: Update udev after installation to pick up
  (changes of) our udev rules. (Closes: #548758)
* debian/control: Add missing udev dependency.
* debian/control: Add dependencies to various file system tools which DK-D
  uses to implement its functionality:
  - Recommends: dosfstools, mtools, ntfs-3g (the more popular ones)
  - Suggests: xfsprogs, reiserfsprogs, mdadm, cryptsetup
* Add 00git-lv-nopolicy.patch: Fix LVM LVs to have NOPOLICY=1 again.
  (Accepted into upstream trunk.)

[ Michael Biebl ]
* debian/patches/08-dont-probe-dm-devices.patch
  - Skip probing dm devices (using devkit-disks-part-id) for which DM_HIDE
    is set. (Closes: #545032)
  - Instead of checking for DKD_DM_STATE, test if DM_NAME is setup.
* Add debian/README.source which refers to the quilt documentation.
* debian/control: Add Recommends on ntfsprogs for proper NTFS support.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/Disks.html
75
75
</pre>
76
76
</div>
77
77
<div class="refsect1" title="Signals">
78
 
<a name="id330771"></a><h2>Signals</h2>
 
78
<a name="id531543"></a><h2>Signals</h2>
79
79
<pre class="synopsis"><a class="link" href="Disks.html#Disks::DeviceAdded">DeviceAdded</a>      ('o' device)
80
80
<a class="link" href="Disks.html#Disks::DeviceRemoved">DeviceRemoved</a>    ('o' device)
81
81
<a class="link" href="Disks.html#Disks::DeviceChanged">DeviceChanged</a>    ('o' device)
82
82
<a class="link" href="Disks.html#Disks::DeviceJobChanged">DeviceJobChanged</a> ('o' device,
83
 
                  'b' job-in-progress,
84
 
                  'b' job-is-cancellable,
85
 
                  's' job-id,
86
 
                  'i' job-num-tasks,
87
 
                  'i' job-cur-task,
88
 
                  's' job-cur-task-id,
89
 
                  'd' job-cur-task-percentage)
 
83
                  'b' job_in_progress,
 
84
                  'b' job_is_cancellable,
 
85
                  's' job_id,
 
86
                  'i' job_num_tasks,
 
87
                  'i' job_cur_task,
 
88
                  's' job_cur_task_id,
 
89
                  'd' job_cur_task_percentage)
90
90
</pre>
91
91
</div>
92
92
<div class="refsect1" title="Implemented Interfaces">
93
 
<a name="id330837"></a><h2>Implemented Interfaces</h2>
 
93
<a name="id531610"></a><h2>Implemented Interfaces</h2>
94
94
<p>
95
95
    Objects implementing org.freedesktop.DeviceKit.Disks also implements
96
96
    org.freedesktop.DBus.Introspectable,
98
98
    </p>
99
99
</div>
100
100
<div class="refsect1" title="Properties">
101
 
<a name="id330854"></a><h2>Properties</h2>
 
101
<a name="id531627"></a><h2>Properties</h2>
102
102
<pre class="synopsis"><a class="link" href="Disks.html#Disks:DaemonVersion">'DaemonVersion'</a>       read      's'
103
103
<a class="link" href="Disks.html#Disks:DaemonIsInhibited">'DaemonIsInhibited'</a>   read      'b'
104
104
<a class="link" href="Disks.html#Disks:SupportsLuksDevices">'SupportsLuksDevices'</a> read      'b'
106
106
</pre>
107
107
</div>
108
108
<div class="refsect1" title="Description">
109
 
<a name="id332074"></a><h2>Description</h2>
 
109
<a name="id532846"></a><h2>Description</h2>
110
110
<p></p>
111
111
</div>
112
112
<div class="refsect1" title="Details">
113
 
<a name="id332088"></a><h2>Details</h2>
 
113
<a name="id532860"></a><h2>Details</h2>
114
114
<div class="refsect2" title="EnumerateDevices ()">
115
 
<a name="id332096"></a><h3>
 
115
<a name="id532868"></a><h3>
116
116
<a name="Disks.EnumerateDevices"></a>EnumerateDevices ()</h3>
117
117
<pre class="programlisting">EnumerateDevices (out 'ao' devices)</pre>
118
118
</div>
128
128
</table></div>
129
129
<hr>
130
130
<div class="refsect2" title="EnumerateDeviceFiles ()">
131
 
<a name="id331567"></a><h3>
 
131
<a name="id532339"></a><h3>
132
132
<a name="Disks.EnumerateDeviceFiles"></a>EnumerateDeviceFiles ()</h3>
133
133
<pre class="programlisting">EnumerateDeviceFiles (out 'as' device_files)</pre>
134
134
</div>
144
144
</table></div>
145
145
<hr>
146
146
<div class="refsect2" title="FindDeviceByDeviceFile ()">
147
 
<a name="id331610"></a><h3>
 
147
<a name="id532382"></a><h3>
148
148
<a name="Disks.FindDeviceByDeviceFile"></a>FindDeviceByDeviceFile ()</h3>
149
149
<pre class="programlisting">FindDeviceByDeviceFile (in  's' device_file,
150
150
                        out 'o' device)</pre>
167
167
</table></div>
168
168
<hr>
169
169
<div class="refsect2" title="FindDeviceByMajorMinor ()">
170
 
<a name="id331663"></a><h3>
 
170
<a name="id532436"></a><h3>
171
171
<a name="Disks.FindDeviceByMajorMinor"></a>FindDeviceByMajorMinor ()</h3>
172
172
<pre class="programlisting">FindDeviceByMajorMinor (in  'x' device_major,
173
173
                        in  'x' device_minor,
195
195
</table></div>
196
196
<hr>
197
197
<div class="refsect2" title="DriveInhibitAllPolling ()">
198
 
<a name="id387709"></a><h3>
 
198
<a name="id588481"></a><h3>
199
199
<a name="Disks.DriveInhibitAllPolling"></a>DriveInhibitAllPolling ()</h3>
200
200
<pre class="programlisting">DriveInhibitAllPolling (in  'as' options,
201
201
                        out 's'  cookie)</pre>
221
221
</tbody>
222
222
</table></div>
223
223
<div class="refsect3" title="Errors">
224
 
<a name="id387771"></a><h4>Errors</h4>
 
224
<a name="id588544"></a><h4>Errors</h4>
225
225
<div class="variablelist"><table border="0">
226
226
<col align="left" valign="top">
227
227
<tbody>
237
237
</table></div>
238
238
</div>
239
239
<div class="refsect3" title="Permissions">
240
 
<a name="id387801"></a><h4>Permissions</h4>
 
240
<a name="id588573"></a><h4>Permissions</h4>
241
241
<p class="permission">
242
242
          The caller will need one of the following PolicyKit authorizations:
243
243
          </p>
248
248
</div>
249
249
<hr>
250
250
<div class="refsect2" title="DriveUninhibitAllPolling ()">
251
 
<a name="id387820"></a><h3>
 
251
<a name="id588592"></a><h3>
252
252
<a name="Disks.DriveUninhibitAllPolling"></a>DriveUninhibitAllPolling ()</h3>
253
253
<pre class="programlisting">DriveUninhibitAllPolling (in  's' cookie)</pre>
254
254
</div>
266
266
</tr></tbody>
267
267
</table></div>
268
268
<div class="refsect3" title="Errors">
269
 
<a name="id387871"></a><h4>Errors</h4>
 
269
<a name="id588643"></a><h4>Errors</h4>
270
270
<div class="variablelist"><table border="0">
271
271
<col align="left" valign="top">
272
272
<tbody><tr>
277
277
</div>
278
278
<hr>
279
279
<div class="refsect2" title="DriveSetAllSpindownTimeouts ()">
280
 
<a name="id387889"></a><h3>
 
280
<a name="id588662"></a><h3>
281
281
<a name="Disks.DriveSetAllSpindownTimeouts"></a>DriveSetAllSpindownTimeouts ()</h3>
282
282
<pre class="programlisting">DriveSetAllSpindownTimeouts (in  'i'  timeout_seconds,
283
283
                             in  'as' options,
315
315
</tbody>
316
316
</table></div>
317
317
<div class="refsect3" title="Errors">
318
 
<a name="id387974"></a><h4>Errors</h4>
 
318
<a name="id588746"></a><h4>Errors</h4>
319
319
<div class="variablelist"><table border="0">
320
320
<col align="left" valign="top">
321
321
<tbody>
335
335
</table></div>
336
336
</div>
337
337
<div class="refsect3" title="Permissions">
338
 
<a name="id388014"></a><h4>Permissions</h4>
 
338
<a name="id588786"></a><h4>Permissions</h4>
339
339
<p class="permission">
340
340
          The caller will need one of the following PolicyKit authorizations:
341
341
          </p>
346
346
</div>
347
347
<hr>
348
348
<div class="refsect2" title="DriveUnsetAllSpindownTimeouts ()">
349
 
<a name="id388033"></a><h3>
 
349
<a name="id588806"></a><h3>
350
350
<a name="Disks.DriveUnsetAllSpindownTimeouts"></a>DriveUnsetAllSpindownTimeouts ()</h3>
351
351
<pre class="programlisting">DriveUnsetAllSpindownTimeouts (in  's' cookie)</pre>
352
352
</div>
364
364
</tr></tbody>
365
365
</table></div>
366
366
<div class="refsect3" title="Errors">
367
 
<a name="id388085"></a><h4>Errors</h4>
 
367
<a name="id588858"></a><h4>Errors</h4>
368
368
<div class="variablelist"><table border="0">
369
369
<col align="left" valign="top">
370
370
<tbody>
380
380
</table></div>
381
381
</div>
382
382
<div class="refsect3" title="Permissions">
383
 
<a name="id388115"></a><h4>Permissions</h4>
 
383
<a name="id588888"></a><h4>Permissions</h4>
384
384
<p class="permission">
385
385
          The caller will need one of the following PolicyKit authorizations:
386
386
          </p>
391
391
</div>
392
392
<hr>
393
393
<div class="refsect2" title="LinuxMdStart ()">
394
 
<a name="id388134"></a><h3>
 
394
<a name="id588907"></a><h3>
395
395
<a name="Disks.LinuxMdStart"></a>LinuxMdStart ()</h3>
396
396
<pre class="programlisting">LinuxMdStart (in  'ao' components,
397
397
              in  'as' options,
420
420
</tbody>
421
421
</table></div>
422
422
<div class="refsect3" title="Errors">
423
 
<a name="id388202"></a><h4>Errors</h4>
 
423
<a name="id588975"></a><h4>Errors</h4>
424
424
<div class="variablelist"><table border="0">
425
425
<col align="left" valign="top">
426
426
<tbody>
444
444
</table></div>
445
445
</div>
446
446
<div class="refsect3" title="Permissions">
447
 
<a name="id388255"></a><h4>Permissions</h4>
 
447
<a name="id589028"></a><h4>Permissions</h4>
448
448
<p class="permission">
449
449
          The caller will need the following PolicyKit authorization:
450
450
          </p>
457
457
</div>
458
458
<hr>
459
459
<div class="refsect2" title="LinuxMdCreate ()">
460
 
<a name="id388273"></a><h3>
 
460
<a name="id589045"></a><h3>
461
461
<a name="Disks.LinuxMdCreate"></a>LinuxMdCreate ()</h3>
462
462
<pre class="programlisting">LinuxMdCreate (in  'ao' components,
463
463
               in  's'  level,
500
500
</tbody>
501
501
</table></div>
502
502
<div class="refsect3" title="Errors">
503
 
<a name="id388376"></a><h4>Errors</h4>
 
503
<a name="id589149"></a><h4>Errors</h4>
504
504
<div class="variablelist"><table border="0">
505
505
<col align="left" valign="top">
506
506
<tbody>
524
524
</table></div>
525
525
</div>
526
526
<div class="refsect3" title="Permissions">
527
 
<a name="id388429"></a><h4>Permissions</h4>
 
527
<a name="id589202"></a><h4>Permissions</h4>
528
528
<p class="permission">
529
529
          The caller will need the following PolicyKit authorization:
530
530
          </p>
537
537
</div>
538
538
<hr>
539
539
<div class="refsect2" title="Inhibit ()">
540
 
<a name="id388447"></a><h3>
 
540
<a name="id589219"></a><h3>
541
541
<a name="Disks.Inhibit"></a>Inhibit ()</h3>
542
542
<pre class="programlisting">Inhibit (out 's' cookie)</pre>
543
543
</div>
562
562
</tr></tbody>
563
563
</table></div>
564
564
<div class="refsect3" title="Errors">
565
 
<a name="id388508"></a><h4>Errors</h4>
 
565
<a name="id589281"></a><h4>Errors</h4>
566
566
<div class="variablelist"><table border="0">
567
567
<col align="left" valign="top">
568
568
<tbody><tr>
572
572
</table></div>
573
573
</div>
574
574
<div class="refsect3" title="Permissions">
575
 
<a name="id388527"></a><h4>Permissions</h4>
 
575
<a name="id589299"></a><h4>Permissions</h4>
576
576
<p class="permission">
577
577
          Only the super user can invoke this method.
578
578
        </p>
579
579
</div>
580
580
<hr>
581
581
<div class="refsect2" title="Uninhibit ()">
582
 
<a name="id388535"></a><h3>
 
582
<a name="id589307"></a><h3>
583
583
<a name="Disks.Uninhibit"></a>Uninhibit ()</h3>
584
584
<pre class="programlisting">Uninhibit (in  's' cookie)</pre>
585
585
</div>
597
597
</tr></tbody>
598
598
</table></div>
599
599
<div class="refsect3" title="Errors">
600
 
<a name="id388587"></a><h4>Errors</h4>
 
600
<a name="id589359"></a><h4>Errors</h4>
601
601
<div class="variablelist"><table border="0">
602
602
<col align="left" valign="top">
603
603
<tbody><tr>
608
608
</div>
609
609
</div>
610
610
<div class="refsect1" title="Signal Details">
611
 
<a name="id388606"></a><h2>Signal Details</h2>
 
611
<a name="id589379"></a><h2>Signal Details</h2>
612
612
<div class="refsect2" title="The DeviceAdded signal">
613
 
<a name="id388614"></a><h3>
 
613
<a name="id589387"></a><h3>
614
614
<a name="Disks::DeviceAdded"></a>The DeviceAdded signal</h3>
615
615
<pre class="programlisting">DeviceAdded ('o' device)</pre>
616
616
</div>
626
626
</table></div>
627
627
<hr>
628
628
<div class="refsect2" title="The DeviceRemoved signal">
629
 
<a name="id388657"></a><h3>
 
629
<a name="id589429"></a><h3>
630
630
<a name="Disks::DeviceRemoved"></a>The DeviceRemoved signal</h3>
631
631
<pre class="programlisting">DeviceRemoved ('o' device)</pre>
632
632
</div>
642
642
</table></div>
643
643
<hr>
644
644
<div class="refsect2" title="The DeviceChanged signal">
645
 
<a name="id388700"></a><h3>
 
645
<a name="id589472"></a><h3>
646
646
<a name="Disks::DeviceChanged"></a>The DeviceChanged signal</h3>
647
647
<pre class="programlisting">DeviceChanged ('o' device)</pre>
648
648
</div>
658
658
</table></div>
659
659
<hr>
660
660
<div class="refsect2" title="The DeviceJobChanged signal">
661
 
<a name="id388742"></a><h3>
 
661
<a name="id589514"></a><h3>
662
662
<a name="Disks::DeviceJobChanged"></a>The DeviceJobChanged signal</h3>
663
663
<pre class="programlisting">DeviceJobChanged ('o' device,
664
 
                  'b' job-in-progress,
665
 
                  'b' job-is-cancellable,
666
 
                  's' job-id,
667
 
                  'i' job-num-tasks,
668
 
                  'i' job-cur-task,
669
 
                  's' job-cur-task-id,
670
 
                  'd' job-cur-task-percentage)</pre>
 
664
                  'b' job_in_progress,
 
665
                  'b' job_is_cancellable,
 
666
                  's' job_id,
 
667
                  'i' job_num_tasks,
 
668
                  'i' job_cur_task,
 
669
                  's' job_cur_task_id,
 
670
                  'd' job_cur_task_percentage)</pre>
671
671
</div>
672
672
<p>
673
673
            Emitted when a job on a device changes.
680
680
<td>The object path of the device.</td>
681
681
</tr>
682
682
<tr>
683
 
<td><p><span class="term"><em class="parameter"><code>job-in-progress</code></em>:</span></p></td>
 
683
<td><p><span class="term"><em class="parameter"><code>job_in_progress</code></em>:</span></p></td>
684
684
<td>Whether a job is currently in progress.</td>
685
685
</tr>
686
686
<tr>
687
 
<td><p><span class="term"><em class="parameter"><code>job-is-cancellable</code></em>:</span></p></td>
 
687
<td><p><span class="term"><em class="parameter"><code>job_is_cancellable</code></em>:</span></p></td>
688
688
<td>Whether the job is cancellable.</td>
689
689
</tr>
690
690
<tr>
691
 
<td><p><span class="term"><em class="parameter"><code>job-id</code></em>:</span></p></td>
 
691
<td><p><span class="term"><em class="parameter"><code>job_id</code></em>:</span></p></td>
692
692
<td>The identifier of the job.</td>
693
693
</tr>
694
694
<tr>
695
 
<td><p><span class="term"><em class="parameter"><code>job-num-tasks</code></em>:</span></p></td>
 
695
<td><p><span class="term"><em class="parameter"><code>job_num_tasks</code></em>:</span></p></td>
696
696
<td>Number of tasks in the job.</td>
697
697
</tr>
698
698
<tr>
699
 
<td><p><span class="term"><em class="parameter"><code>job-cur-task</code></em>:</span></p></td>
 
699
<td><p><span class="term"><em class="parameter"><code>job_cur_task</code></em>:</span></p></td>
700
700
<td>Current task number (zero-based offset).</td>
701
701
</tr>
702
702
<tr>
703
 
<td><p><span class="term"><em class="parameter"><code>job-cur-task-id</code></em>:</span></p></td>
 
703
<td><p><span class="term"><em class="parameter"><code>job_cur_task_id</code></em>:</span></p></td>
704
704
<td>Task identifier for current task.</td>
705
705
</tr>
706
706
<tr>
707
 
<td><p><span class="term"><em class="parameter"><code>job-cur-task-percentage</code></em>:</span></p></td>
 
707
<td><p><span class="term"><em class="parameter"><code>job_cur_task_percentage</code></em>:</span></p></td>
708
708
<td>Percentage completed of current task (between 0 and 100, negative if unknown).</td>
709
709
</tr>
710
710
</tbody>
711
711
</table></div>
712
712
</div>
713
713
<div class="refsect1" title="Property Details">
714
 
<a name="id388870"></a><h2>Property Details</h2>
 
714
<a name="id589642"></a><h2>Property Details</h2>
715
715
<div class="refsect2" title='The "DaemonVersion" property'>
716
 
<a name="id388880"></a><h3>
 
716
<a name="id589653"></a><h3>
717
717
<a name="Disks:DaemonVersion"></a>The "DaemonVersion" property</h3>
718
718
<pre class="programlisting">'DaemonVersion'  read      's'
719
719
</pre>
727
727
</table></div>
728
728
<hr>
729
729
<div class="refsect2" title='The "DaemonIsInhibited" property'>
730
 
<a name="id388922"></a><h3>
 
730
<a name="id589694"></a><h3>
731
731
<a name="Disks:DaemonIsInhibited"></a>The "DaemonIsInhibited" property</h3>
732
732
<pre class="programlisting">'DaemonIsInhibited'  read      'b'
733
733
</pre>
741
741
</table></div>
742
742
<hr>
743
743
<div class="refsect2" title='The "SupportsLuksDevices" property'>
744
 
<a name="id388963"></a><h3>
 
744
<a name="id589736"></a><h3>
745
745
<a name="Disks:SupportsLuksDevices"></a>The "SupportsLuksDevices" property</h3>
746
746
<pre class="programlisting">'SupportsLuksDevices'  read      'b'
747
747
</pre>
758
758
</table></div>
759
759
<hr>
760
760
<div class="refsect2" title='The "KnownFilesystems" property'>
761
 
<a name="id389024"></a><h3>
 
761
<a name="id589796"></a><h3>
762
762
<a name="Disks:KnownFilesystems"></a>The "KnownFilesystems" property</h3>
763
763
<pre class="programlisting">'KnownFilesystems'  read      'a(ssbbbubbbbbbbb)'
764
764
</pre>