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