source: general/sysutils/udisks2.xml@ c945f8f

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since c945f8f was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 19 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.
  • Property mode set to 100644
File size: 9.1 KB
Line 
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
7 <!ENTITY udisks2-download-http "https://github.com/storaged-project/udisks/releases/download/udisks-&udisks2-version;/udisks-&udisks2-version;.tar.bz2">
8 <!ENTITY udisks2-download-ftp " ">
9 <!ENTITY udisks2-md5sum "576e057d2654894fab58f0393d105b7b">
10 <!ENTITY udisks2-size "1.6 MB">
11 <!ENTITY udisks2-buildsize "52 MB (with tests)">
12 <!ENTITY udisks2-time "0.3 SBU (with tests)">
13]>
14
15<sect1 id="udisks2" xreflabel="UDisks-&udisks2-version;">
16 <?dbhtml filename="udisks2.html"?>
17
18
19 <title>UDisks-&udisks2-version;</title>
20
21 <indexterm zone="udisks2">
22 <primary sortas="a-UDisks2">UDisks2</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to UDisks</title>
27
28 <para>
29 The <application>UDisks</application> package provides a daemon,
30 tools and libraries to access and manipulate disks and storage
31 devices.
32 </para>
33
34 &lfs112_checked;
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
70 <bridgehead renderas="sect3">UDisks Dependencies</bridgehead>
71
72 <bridgehead renderas="sect4">Required</bridgehead>
73 <para role="required">
74 <xref linkend="libatasmart"/>,
75 <xref linkend="libblockdev"/>,
76 <xref linkend="libgudev"/>,
77 <xref linkend="libxslt"/>, and
78 <xref linkend="polkit"/>
79 </para>
80
81 <bridgehead renderas="sect4">Required at runtime</bridgehead>
82 <para role="required">
83 <xref role="runtime" linkend="btrfs-progs"/>,
84 <phrase revision="sysv"><xref role="runtime" linkend="dbus"/>,</phrase>
85 <xref role="runtime" linkend="dosfstools"/>,
86 <xref role="runtime" linkend="gptfdisk"/>,
87 <xref role="runtime" linkend="mdadm"/>, and
88 <xref role="runtime" linkend="xfsprogs"/>
89 </para>
90
91 <bridgehead renderas="sect4">Recommended</bridgehead>
92 <para role="recommended">
93 <phrase revision="systemd"><xref linkend="systemd"/></phrase>
94 <phrase revision="sysv"><xref linkend="elogind"/></phrase>
95 </para>
96
97 <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
98 <para role="optional">
99 <xref linkend="gobject-introspection"/>
100 </para>
101
102 <bridgehead renderas="sect4">Optional</bridgehead>
103 <para role="optional">
104 <xref linkend="dbus-python"/> (for the integration tests),
105 <xref linkend="gtk-doc"/>,
106 <xref linkend="lvm2"/>,
107 <xref linkend="ntfs-3g"/>,
108 <xref linkend="pygobject3"/> (for the integration tests),
109 <ulink url="https://github.com/relan/exfat">exFAT</ulink>, and
110 <ulink url="https://github.com/sahlberg/libiscsi">libiscsi</ulink>
111 </para>
112
113 <para condition="html" role="usernotes">
114 User Notes: <ulink url="&blfs-wiki;/udisks2"/>
115 </para>
116 </sect2>
117
118 <sect2 role="installation">
119 <title>Installation of UDisks</title>
120
121<!-- Applied upstream in version 2.9.0.
122 <para>
123 First, fix a regression caused by glib-2.64:
124 </para>
125
126<screen><userinput remap="pre">sed -i '/stdout_channel = g/a g_io_channel_set_encoding (job->child_stdout_channel, NULL, NULL);' src/udisksspawnedjob.c &amp;&amp;
127sed -i '/stderr_channel = g/a g_io_channel_set_encoding (job->child_stderr_channel, NULL, NULL);' src/udisksspawnedjob.c</userinput></screen>
128-->
129
130 <para>
131 Install <application>UDisks</application> by running the following
132 commands:
133 </para>
134
135<screen><userinput>./configure --prefix=/usr \
136 --sysconfdir=/etc \
137 --localstatedir=/var \
138 --disable-static &amp;&amp;
139make</userinput></screen>
140
141 <para>
142 To test the results, issue: <command>make check</command>. A more
143 thorough test can be run with <command>make ci</command>. You must first
144 create the directories
145 <filename class="directory">/var/run/udisks2</filename> and
146 <filename class="directory">/var/lib/udisks2</filename>, and the optional
147 python modules should be present.
148 </para>
149
150 <para>
151 Now, as the <systemitem class="username">root</systemitem> user:
152 </para>
153
154<screen role="root"><userinput>make install</userinput></screen>
155 </sect2>
156
157 <sect2 role="commands">
158 <title>Command Explanations</title>
159
160 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
161 href="../../xincludes/static-libraries.xml"/>
162
163 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
164 href="../../xincludes/gtk-doc-rebuild.xml"/>
165
166 </sect2>
167
168 <sect2 role="configuration">
169 <title>Configuring UDisks2</title>
170
171 <sect3 id="udisks2-config">
172 <title>Config Files</title>
173 <para>
174 <filename>/etc/udisks2/mount_options.conf</filename> and
175 <filename>/etc/udisks2/udisks2.conf</filename>
176 </para>
177
178 <indexterm zone="udisks2 udisks2-config">
179 <primary sortas="e-etc-udisks2-mount_options.conf">/etc/udisks2/mount_options.conf</primary>
180 </indexterm>
181
182 <indexterm zone="udisks2 udisks2-config">
183 <primary sortas="e-etc-udisks2-udisks2.conf">/etc/udisks2/udisks2.conf</primary>
184 </indexterm>
185 </sect3>
186
187 <sect3>
188 <title>Configuration Information</title>
189 <para>
190 The default configuration of UDisks2 assumes ntfs-3g is used to
191 mount NTFS filesystems. If the wrapper script for in-kernel NTFS3
192 driver (recommended in the <xref linkend="ntfs-3g"/> page) is used
193 instead, create a configuration file for UDisks2 compatible with
194 NTFS3 to allow mounting NTFS filesystems:
195 </para>
196
197<screen role="root"><userinput>cat &gt; /etc/udisks2/mount_options.conf &lt;&lt; "EOF"
198<literal>[defaults]
199ntfs_defaults=uid=$UID,gid=$GID</literal>
200EOF</userinput></screen>
201
202 </sect3>
203 </sect2>
204
205 <sect2 role="content">
206 <title>Contents</title>
207
208 <segmentedlist>
209 <segtitle>Installed Programs</segtitle>
210 <segtitle>Installed Library</segtitle>
211 <segtitle>Installed Directories</segtitle>
212
213 <seglistitem>
214 <seg>
215 udisksctl and umount.udisks2
216 </seg>
217 <seg>
218 libudisks2.so
219 </seg>
220 <seg>
221 /etc/udisks2,
222 /usr/include/udisks2,
223 /usr/libexec/udisks2,
224 /usr/share/gtk-doc/html/udisks2, and
225 /var/lib/udisks2
226 </seg>
227 </seglistitem>
228 </segmentedlist>
229
230 <variablelist>
231 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
232 <?dbfo list-presentation="list"?>
233 <?dbhtml list-presentation="table"?>
234
235 <varlistentry id="udisksctl">
236 <term><command>udisksctl</command></term>
237 <listitem>
238 <para>
239 is a command-line program used to interact with the
240 <command>udisksd</command> daemon
241 </para>
242 <indexterm zone="udisks2 udisksctl">
243 <primary sortas="b-udisksctl">udisksctl</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248<!-- Removed since the user shouldn't use this, and it is in /usr/libexec
249 <varlistentry id="udisksd">
250 <term><command>udisksd</command></term>
251 <listitem>
252 <para>
253 is the <application>UDisks</application> daemon itself.
254 </para>
255 <indexterm zone="udisks2 udisksd">
256 <primary sortas="b-udisksd">udisksd</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260-->
261 <varlistentry id="umountudisks2">
262 <term><command>umount.udisks2</command></term>
263 <listitem>
264 <para>
265 is a command-line program used to unmount file systems
266 that have been mounted by the
267 <application>UDisks</application> daemon
268 </para>
269 <indexterm zone="udisks2 umountudisks2">
270 <primary sortas="b-umountudisks2">umount.udisks2</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="libudisks2">
276 <term><filename class="libraryfile">libudisks2.so</filename></term>
277 <listitem>
278 <para>
279 contains the <application>UDisks</application> API functions
280 </para>
281 <indexterm zone="udisks2 libudisks2">
282 <primary sortas="c-libudisks2">libudisks2.so</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 </variablelist>
288
289 </sect2>
290
291</sect1>
Note: See TracBrowser for help on using the repository browser.