source: general/sysutils/udisks2.xml@ 6fa16a5

11.1 11.2 lazarus qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 6fa16a5 was 6fa16a5, checked in by Xi Ruoyao <xry111@…>, 11 months ago

udisks2: add a configuration for kernel NTFS3 driver

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