[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[f8efa5b] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[0e7f80e4] | 7 | <!ENTITY udisks2-download-http "https://github.com/storaged-project/udisks/releases/download/udisks-&udisks2-version;/udisks-&udisks2-version;.tar.bz2">
|
---|
[f8efa5b] | 8 | <!ENTITY udisks2-download-ftp " ">
|
---|
[c1caa22f] | 9 | <!ENTITY udisks2-md5sum "613af9bfea52cde74d2ac34d96de544d">
|
---|
| 10 | <!ENTITY udisks2-size "1.8 MB">
|
---|
| 11 | <!ENTITY udisks2-buildsize "44 MB (with tests)">
|
---|
[f0454b5] | 12 | <!ENTITY udisks2-time "0.2 SBU (with tests)">
|
---|
[f8efa5b] | 13 | ]>
|
---|
| 14 |
|
---|
[880c568] | 15 | <sect1 id="udisks2" xreflabel="UDisks-&udisks2-version;">
|
---|
[f8efa5b] | 16 | <?dbhtml filename="udisks2.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[880c568] | 19 | <title>UDisks-&udisks2-version;</title>
|
---|
[f8efa5b] | 20 |
|
---|
| 21 | <indexterm zone="udisks2">
|
---|
[2630345] | 22 | <primary sortas="a-UDisks2">UDisks2</primary>
|
---|
[f8efa5b] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[73d97caf] | 26 | <title>Introduction to UDisks</title>
|
---|
[f8efa5b] | 27 |
|
---|
| 28 | <para>
|
---|
[0d7900a] | 29 | The <application>UDisks</application> package provides a daemon,
|
---|
| 30 | tools and libraries to access and manipulate disks and storage
|
---|
[f8efa5b] | 31 | devices.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[56b0b0b] | 34 | &lfs122_checked;
|
---|
[f8efa5b] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&udisks2-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&udisks2-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &udisks2-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &udisks2-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &udisks2-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &udisks2-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
[73d97caf] | 70 | <bridgehead renderas="sect3">UDisks Dependencies</bridgehead>
|
---|
[f8efa5b] | 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
| 74 | <xref linkend="libatasmart"/>,
|
---|
[6dcb9e77] | 75 | <xref linkend="libblockdev"/>,
|
---|
[f175d6f6] | 76 | <xref linkend="libgudev"/>,
|
---|
| 77 | <xref linkend="libxslt"/>, and
|
---|
| 78 | <xref linkend="polkit"/>
|
---|
[f8efa5b] | 79 | </para>
|
---|
| 80 |
|
---|
[560d49c] | 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 82 | <para role="recommended">
|
---|
[4a00a6d] | 83 | <phrase revision="systemd"><xref role='runtime' linkend="systemd"/>
|
---|
| 84 | (runtime)</phrase>
|
---|
[560d49c] | 85 | <phrase revision="sysv"><xref linkend="elogind"/></phrase>
|
---|
[1552ac8] | 86 | </para>
|
---|
| 87 |
|
---|
[b84342d6] | 88 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
| 89 | <para role="optional">
|
---|
[c0bc0a9] | 90 | &gobject-introspection;
|
---|
[b84342d6] | 91 | </para>
|
---|
| 92 |
|
---|
[f8efa5b] | 93 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 94 | <para role="optional">
|
---|
[aff1dbb] | 95 | <xref linkend="dbus-python"/> (for the integration tests),
|
---|
[0f23f29] | 96 | <xref linkend="gtk-doc"/>,
|
---|
[0e7f80e4] | 97 | <xref linkend="lvm2"/>,
|
---|
[c47e525] | 98 | <!-- <xref linkend="ntfs-3g"/>, -->
|
---|
[aff1dbb] | 99 | <xref linkend="pygobject3"/> (for the integration tests),
|
---|
| 100 | <ulink url="https://github.com/relan/exfat">exFAT</ulink>, and
|
---|
[6dcb9e77] | 101 | <ulink url="https://github.com/sahlberg/libiscsi">libiscsi</ulink>
|
---|
[f8efa5b] | 102 | </para>
|
---|
| 103 |
|
---|
[6af6704] | 104 | <bridgehead renderas="sect4">Optional Runtime Dependencies</bridgehead>
|
---|
| 105 | <para role="runtime">
|
---|
| 106 | <xref linkend="btrfs-progs"/>,
|
---|
| 107 | <phrase revision="sysv"><xref linkend="dbus"/>,</phrase>
|
---|
| 108 | <xref linkend="dosfstools"/>,
|
---|
| 109 | <xref linkend="gptfdisk"/>,
|
---|
| 110 | <xref linkend="mdadm"/>, and
|
---|
| 111 | <xref linkend="xfsprogs"/>
|
---|
| 112 | </para>
|
---|
| 113 |
|
---|
[f8efa5b] | 114 | </sect2>
|
---|
| 115 |
|
---|
| 116 | <sect2 role="installation">
|
---|
[73d97caf] | 117 | <title>Installation of UDisks</title>
|
---|
[f8efa5b] | 118 |
|
---|
[f4327ad9] | 119 | <!-- Applied upstream in version 2.9.0.
|
---|
[477d66d] | 120 | <para>
|
---|
| 121 | First, fix a regression caused by glib-2.64:
|
---|
| 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <screen><userinput remap="pre">sed -i '/stdout_channel = g/a g_io_channel_set_encoding (job->child_stdout_channel, NULL, NULL);' src/udisksspawnedjob.c &&
|
---|
| 125 | sed -i '/stderr_channel = g/a g_io_channel_set_encoding (job->child_stderr_channel, NULL, NULL);' src/udisksspawnedjob.c</userinput></screen>
|
---|
[f4327ad9] | 126 | -->
|
---|
[477d66d] | 127 |
|
---|
[f8efa5b] | 128 | <para>
|
---|
[73d97caf] | 129 | Install <application>UDisks</application> by running the following
|
---|
[f8efa5b] | 130 | commands:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
[3546fda] | 133 | <screen><userinput>./configure --prefix=/usr \
|
---|
[18c9ee54] | 134 | --sysconfdir=/etc \
|
---|
[f8efa5b] | 135 | --localstatedir=/var \
|
---|
[d5e4de79] | 136 | --disable-static \
|
---|
| 137 | --enable-available-modules &&
|
---|
[aff1dbb] | 138 | make</userinput></screen>
|
---|
[f8efa5b] | 139 |
|
---|
| 140 | <para>
|
---|
[aff1dbb] | 141 | To test the results, issue: <command>make check</command>. A more
|
---|
| 142 | thorough test can be run with <command>make ci</command>. You must first
|
---|
| 143 | create the directories
|
---|
| 144 | <filename class="directory">/var/run/udisks2</filename> and
|
---|
| 145 | <filename class="directory">/var/lib/udisks2</filename>, and the optional
|
---|
| 146 | python modules should be present.
|
---|
[f8efa5b] | 147 | </para>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
| 150 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 151 | </para>
|
---|
| 152 |
|
---|
| 153 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 154 | </sect2>
|
---|
| 155 |
|
---|
| 156 | <sect2 role="commands">
|
---|
| 157 | <title>Command Explanations</title>
|
---|
| 158 |
|
---|
| 159 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[0d7900a] | 160 | href="../../xincludes/static-libraries.xml"/>
|
---|
[f8efa5b] | 161 |
|
---|
| 162 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 163 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 164 |
|
---|
[d5e4de79] | 165 | <para>
|
---|
| 166 | <parameter>--enable-available-modules</parameter>: This switch enables
|
---|
| 167 | additional <application>UDisks2</application> functionalities if
|
---|
| 168 | <xref linkend='libblockdev'/> has been built with optional
|
---|
| 169 | dependencies.
|
---|
| 170 | </para>
|
---|
| 171 |
|
---|
[f8efa5b] | 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | <sect2 role="content">
|
---|
| 175 | <title>Contents</title>
|
---|
| 176 |
|
---|
| 177 | <segmentedlist>
|
---|
| 178 | <segtitle>Installed Programs</segtitle>
|
---|
| 179 | <segtitle>Installed Library</segtitle>
|
---|
| 180 | <segtitle>Installed Directories</segtitle>
|
---|
| 181 |
|
---|
| 182 | <seglistitem>
|
---|
| 183 | <seg>
|
---|
[fa30d84] | 184 | udisksctl and umount.udisks2
|
---|
[f8efa5b] | 185 | </seg>
|
---|
| 186 | <seg>
|
---|
| 187 | libudisks2.so
|
---|
| 188 | </seg>
|
---|
| 189 | <seg>
|
---|
[45ada554] | 190 | /etc/udisks2,
|
---|
[0d7900a] | 191 | /usr/include/udisks2,
|
---|
[99feb0ce] | 192 | /usr/libexec/udisks2,
|
---|
| 193 | /usr/share/gtk-doc/html/udisks2, and
|
---|
[3713bc71] | 194 | /var/lib/udisks2
|
---|
[f8efa5b] | 195 | </seg>
|
---|
| 196 | </seglistitem>
|
---|
| 197 | </segmentedlist>
|
---|
| 198 |
|
---|
| 199 | <variablelist>
|
---|
| 200 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 201 | <?dbfo list-presentation="list"?>
|
---|
| 202 | <?dbhtml list-presentation="table"?>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="udisksctl">
|
---|
| 205 | <term><command>udisksctl</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>
|
---|
[0d7900a] | 208 | is a command-line program used to interact with the
|
---|
[4c24eb0a] | 209 | <command>udisksd</command> daemon
|
---|
[f8efa5b] | 210 | </para>
|
---|
| 211 | <indexterm zone="udisks2 udisksctl">
|
---|
| 212 | <primary sortas="b-udisksctl">udisksctl</primary>
|
---|
| 213 | </indexterm>
|
---|
| 214 | </listitem>
|
---|
| 215 | </varlistentry>
|
---|
| 216 |
|
---|
[55781c2] | 217 | <!-- Removed since the user shouldn't use this, and it is in /usr/libexec
|
---|
[f8efa5b] | 218 | <varlistentry id="udisksd">
|
---|
| 219 | <term><command>udisksd</command></term>
|
---|
| 220 | <listitem>
|
---|
| 221 | <para>
|
---|
[73d97caf] | 222 | is the <application>UDisks</application> daemon itself.
|
---|
[f8efa5b] | 223 | </para>
|
---|
| 224 | <indexterm zone="udisks2 udisksd">
|
---|
| 225 | <primary sortas="b-udisksd">udisksd</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
[55781c2] | 229 | -->
|
---|
| 230 | <varlistentry id="umountudisks2">
|
---|
[1552ac8] | 231 | <term><command>umount.udisks2</command></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
| 234 | is a command-line program used to unmount file systems
|
---|
| 235 | that have been mounted by the
|
---|
[4c24eb0a] | 236 | <application>UDisks</application> daemon
|
---|
[1552ac8] | 237 | </para>
|
---|
| 238 | <indexterm zone="udisks2 umountudisks2">
|
---|
[55781c2] | 239 | <primary sortas="b-umountudisks2">umount.udisks2</primary>
|
---|
[1552ac8] | 240 | </indexterm>
|
---|
| 241 | </listitem>
|
---|
| 242 | </varlistentry>
|
---|
| 243 |
|
---|
[f8efa5b] | 244 | <varlistentry id="libudisks2">
|
---|
| 245 | <term><filename class="libraryfile">libudisks2.so</filename></term>
|
---|
| 246 | <listitem>
|
---|
| 247 | <para>
|
---|
[4c24eb0a] | 248 | contains the <application>UDisks</application> API functions
|
---|
[f8efa5b] | 249 | </para>
|
---|
| 250 | <indexterm zone="udisks2 libudisks2">
|
---|
| 251 | <primary sortas="c-libudisks2">libudisks2.so</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
[0331c46] | 255 |
|
---|
[f8efa5b] | 256 | </variablelist>
|
---|
[0331c46] | 257 |
|
---|
[f8efa5b] | 258 | </sect2>
|
---|
[0331c46] | 259 |
|
---|
[f8efa5b] | 260 | </sect1>
|
---|