~ubuntu-branches/ubuntu/trusty/udisks2/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/man/udisks.xml

  • Committer: Package Import Robot
  • Author(s): Martin Pitt
  • Date: 2012-07-28 13:35:04 UTC
  • mfrom: (1.1.2)
  • Revision ID: package-import@ubuntu.com-20120728133504-jmxgy789jegi5vmo
Tags: 1.99.0-1
* New upstream release (LP: #1030268)
  - Support Realtek rts5229 SD/MMC card readers. (LP: #1022497)
* Drop 00git_no_polkit_fallback.patch, upstream now.
* Drop debian/local/integration-test, shipped in upstream tarball now.
* debian/tests/upstream-system: Run test suite from upstream source.
* debian/tests/control: Simplify Depends: line using "@".
* debian/tests/control: Drop undefined "no-build-needed" feature.

Show diffs side-by-side

added added

removed removed

Lines of Context:
21
21
      udisks provides interfaces to enumerate and perform operations
22
22
      on disks and storage devices. Any application (including
23
23
      unprivileged ones) can access the
24
 
      <citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 
24
      <link linkend="udisksd.8"><citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>
25
25
      daemon via the name <emphasis>org.freedesktop.UDisks2</emphasis>
26
26
      on the system message bus. In addition to the D-Bus API, a
27
27
      library, <filename>libudisks2</filename> is also provided. This
58
58
    </para>
59
59
  </refsect1>
60
60
 
 
61
  <refsect1><title>DRIVE CONFIGURATION</title>
 
62
    <para>
 
63
      At start-up and when a drive is connected,
 
64
      <link linkend="udisksd.8"><citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>
 
65
      will apply configuration stored in the file
 
66
      <filename class='directory'>/etc/udisks2/IDENTIFIER.conf</filename>
 
67
      where <emphasis>IDENTIFIER</emphasis> is the value of the
 
68
      <link linkend="gdbus-property-org-freedesktop-UDisks2-Drive.Id">Drive:Id</link>
 
69
      property for the drive. If the file changes on disk its new
 
70
      contents will also be applied to the drive.
 
71
      Typically, users or administrators will never need to edit drive
 
72
      configuration files as they are effectively managed through
 
73
      graphical applications such as
 
74
      <citerefentry><refentrytitle>gnome-disks</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
 
75
      Manually editing configuration files is however supported — the file
 
76
      format is a simple <emphasis>.ini-like format</emphasis>
 
77
      (see the
 
78
      <ulink url="http://freedesktop.org/wiki/Specifications/desktop-entry-spec">Desktop Entry Specification</ulink>
 
79
      for the exact syntax). New groups and keys may
 
80
      be added in the future.
 
81
    </para>
 
82
 
 
83
    <refsect2>
 
84
      <title>ATA group</title>
 
85
      <para>
 
86
        The <literal>ATA</literal> group is for settings that apply to
 
87
        drives using the ATA command-set. The following keys are
 
88
        supported:
 
89
      </para>
 
90
 
 
91
      <variablelist>
 
92
        <varlistentry>
 
93
          <term><option>StandbyTimeout</option></term>
 
94
          <listitem>
 
95
            <para>
 
96
              The standby timeout.  A value of zero means "timeouts
 
97
              are disabled": the device will not automatically enter
 
98
              standby mode.  Values from 1 to 240 specify multiples of
 
99
              5 seconds, yielding timeouts from 5 seconds to 20
 
100
              minutes. Values from 241 to 251 specify from 1 to 11
 
101
              units of 30 minutes, yielding timeouts from 30 minutes
 
102
              to 5.5 hours.  A value of 252 signifies a timeout of 21
 
103
              minutes. A value of 253 sets a vendor-defined timeout
 
104
              period between 8 and 12 hours, and the value 254 is
 
105
              reserved.  255 is interpreted as 21 minutes plus 15
 
106
              seconds. Note that some older drives may have very
 
107
              different interpretations of these values.
 
108
              This is similar to the <option>-S</option> option in
 
109
              <citerefentry><refentrytitle>hdparm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
110
            </para>
 
111
          </listitem>
 
112
        </varlistentry>
 
113
        <varlistentry>
 
114
          <term><option>APMLevel</option></term>
 
115
          <listitem>
 
116
            <para>
 
117
              The Advanced Power Management level.  A low value means
 
118
              aggressive power management and a high value means
 
119
              better performance. Possible settings range from values
 
120
              1 through 127 (which permit spin-down), and values 128
 
121
              through 254 (which do not permit spin-down).  The
 
122
              highest degree of power management is attained with a
 
123
              setting of 1, and the highest I/O performance with a
 
124
              setting of 254. A value of 255 tells hdparm to disable
 
125
              Advanced Power Management altogether on the drive (not
 
126
              all drives support disabling it, but most do).
 
127
              This is similar to the <option>-B</option> option in
 
128
              <citerefentry><refentrytitle>hdparm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
129
            </para>
 
130
          </listitem>
 
131
        </varlistentry>
 
132
        <varlistentry>
 
133
          <term><option>AAMLevel</option></term>
 
134
          <listitem>
 
135
            <para>
 
136
              The Automatic Acoustic Management level. Most modern
 
137
              harddisk drives have the ability to speed down the head
 
138
              movements to reduce their noise output. The possible
 
139
              values are between 0 and 254. 128 is the most quiet (and
 
140
              therefore slowest) setting and 254 the fastest (and
 
141
              loudest). Some drives have only two levels (quiet /
 
142
              fast), while others may have different levels between
 
143
              128 and 254. At the moment, most drives only support 3
 
144
              options, off, quiet, and fast. These have been assigned
 
145
              the values 0, 128, and 254 at present, respectively, but
 
146
              integer space has been incorporated for future
 
147
              expansion, should this change.
 
148
              This is similar to the <option>-M</option> option in
 
149
              <citerefentry><refentrytitle>hdparm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
150
            </para>
 
151
          </listitem>
 
152
        </varlistentry>
 
153
      </variablelist>
 
154
    </refsect2>
 
155
  </refsect1>
 
156
 
61
157
  <refsect1>
62
158
    <title>DEVICE INFORMATION</title>
63
159
    <para>
165
261
        <refentrytitle>gdbus</refentrytitle><manvolnum>1</manvolnum>
166
262
      </citerefentry>
167
263
      to interact with
168
 
      <citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
 
264
      <link linkend="udisksd.8"><citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>.
169
265
    </para>
170
266
  </refsect1>
171
267
 
248
344
        <refentrytitle>polkit</refentrytitle><manvolnum>8</manvolnum>
249
345
      </citerefentry>,
250
346
      <link linkend="udisksd.8"><citerefentry><refentrytitle>udisksd</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>,
251
 
      <link linkend="udisksctl.1"><citerefentry><refentrytitle>udisksctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>
 
347
      <link linkend="udisksctl.1"><citerefentry><refentrytitle>udisksctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
 
348
      <citerefentry><refentrytitle>gnome-disks</refentrytitle><manvolnum>1</manvolnum></citerefentry>
252
349
    </para>
253
350
  </refsect1>
254
351
</refentry>