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 fuse-download-http "&sourceforge-repo;/fuse/fuse-&fuse-version;.tar.gz">
|
---|
8 | <!ENTITY fuse-download-ftp " ">
|
---|
9 | <!ENTITY fuse-md5sum "ecb712b5ffc6dffd54f4a405c9b372d8">
|
---|
10 | <!ENTITY fuse-size "564 KB">
|
---|
11 | <!ENTITY fuse-buildsize "9.9 MB (with API documentation)">
|
---|
12 | <!ENTITY fuse-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="fuse" xreflabel="Fuse-&fuse-version;">
|
---|
16 | <?dbhtml filename="fuse.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>Fuse-&fuse-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="fuse">
|
---|
26 | <primary sortas="a-Fuse">Fuse</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Fuse</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | <application>FUSE</application> (Filesystem in Userspace) is a simple
|
---|
34 | interface for userspace programs to export a virtual filesystem to the
|
---|
35 | Linux kernel. <application>Fuse</application> also aims to provide a
|
---|
36 | secure method for non privileged users to create and mount their own
|
---|
37 | filesystem implementations.
|
---|
38 | </para>
|
---|
39 |
|
---|
40 | &lfs77_checked; &gcc5_checked;
|
---|
41 |
|
---|
42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
43 | <itemizedlist spacing="compact">
|
---|
44 | <listitem>
|
---|
45 | <para>
|
---|
46 | Download (HTTP): <ulink url="&fuse-download-http;"/>
|
---|
47 | </para>
|
---|
48 | </listitem>
|
---|
49 | <listitem>
|
---|
50 | <para>
|
---|
51 | Download (FTP): <ulink url="&fuse-download-ftp;"/>
|
---|
52 | </para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>
|
---|
56 | Download MD5 sum: &fuse-md5sum;
|
---|
57 | </para>
|
---|
58 | </listitem>
|
---|
59 | <listitem>
|
---|
60 | <para>
|
---|
61 | Download size: &fuse-size;
|
---|
62 | </para>
|
---|
63 | </listitem>
|
---|
64 | <listitem>
|
---|
65 | <para>
|
---|
66 | Estimated disk space required: &fuse-buildsize;
|
---|
67 | </para>
|
---|
68 | </listitem>
|
---|
69 | <listitem>
|
---|
70 | <para>
|
---|
71 | Estimated build time: &fuse-time;
|
---|
72 | </para>
|
---|
73 | </listitem>
|
---|
74 | </itemizedlist>
|
---|
75 |
|
---|
76 | <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
79 | <para role="optional">
|
---|
80 | <xref linkend="doxygen"/> (to build the API documentation)
|
---|
81 | </para>
|
---|
82 |
|
---|
83 | <para condition="html" role="usernotes">
|
---|
84 | User Notes: <ulink url="&blfs-wiki;/fuse"/>
|
---|
85 | </para>
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2 role="kernel" id="fuse-kernel">
|
---|
89 | <title>Kernel Configuration</title>
|
---|
90 |
|
---|
91 | <para>
|
---|
92 | Enable the following options in the kernel configuration and recompile the
|
---|
93 | kernel if necessary:
|
---|
94 | </para>
|
---|
95 |
|
---|
96 | <screen><literal>File systems --->
|
---|
97 | <*/M> FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
|
---|
98 |
|
---|
99 | <indexterm zone="fuse fuse-kernel">
|
---|
100 | <primary sortas="d-fuse">fuse</primary>
|
---|
101 | </indexterm>
|
---|
102 | </sect2>
|
---|
103 |
|
---|
104 | <sect2 role="installation">
|
---|
105 | <title>Installation of Fuse</title>
|
---|
106 |
|
---|
107 | <note>
|
---|
108 | <para>
|
---|
109 | After the <command>configure</command> script has finished you will
|
---|
110 | see a warning shown below. You can safely disregard this warning.
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen><computeroutput>configure: WARNING:
|
---|
114 | ******************************************************************
|
---|
115 | * Please install util-linux version 2.18 or later which supports *
|
---|
116 | * --fake and --no-canonicalize options in mount and umount *
|
---|
117 | ******************************************************************</computeroutput></screen>
|
---|
118 | </note>
|
---|
119 |
|
---|
120 | <para>
|
---|
121 | Install <application>Fuse</application> by running the following
|
---|
122 | commands:
|
---|
123 | </para>
|
---|
124 |
|
---|
125 | <screen><userinput>./configure --prefix=/usr --disable-static INIT_D_PATH=/tmp/init.d &&
|
---|
126 | make</userinput></screen>
|
---|
127 |
|
---|
128 | <para>
|
---|
129 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
130 | documentation, issue <command>doxygen doc/Doxyfile</command>.
|
---|
131 | </para>
|
---|
132 |
|
---|
133 | <para>
|
---|
134 | This package does not come with a test suite.
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <para>
|
---|
138 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
139 | </para>
|
---|
140 |
|
---|
141 | <screen role="root"><userinput>make install &&
|
---|
142 |
|
---|
143 | mv -v /usr/lib/libfuse.so.* /lib &&
|
---|
144 | ln -sfv ../../lib/libfuse.so.&fuse-version; /usr/lib/libfuse.so &&
|
---|
145 | rm -rf /tmp/init.d &&
|
---|
146 |
|
---|
147 | install -v -m755 -d /usr/share/doc/fuse-&fuse-version; &&
|
---|
148 | install -v -m644 doc/{how-fuse-works,kernel.txt} \
|
---|
149 | /usr/share/doc/fuse-&fuse-version;</userinput></screen>
|
---|
150 |
|
---|
151 | <para>
|
---|
152 | If you built the API documentation, install it as the
|
---|
153 | <systemitem class="username">root</systemitem> user by issuing the
|
---|
154 | following commands:
|
---|
155 | </para>
|
---|
156 |
|
---|
157 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/fuse-&fuse-version;/api &&
|
---|
158 | install -v -m644 doc/html/* \
|
---|
159 | /usr/share/doc/fuse-&fuse-version;/api</userinput></screen>
|
---|
160 | </sect2>
|
---|
161 |
|
---|
162 | <sect2 role="commands">
|
---|
163 | <title>Command Explanations</title>
|
---|
164 |
|
---|
165 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
166 | href="../../xincludes/static-libraries.xml"/>
|
---|
167 |
|
---|
168 | <para>
|
---|
169 | <parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter installs
|
---|
170 | the bootscript into <filename class="directory">/tmp/init.d</filename> as
|
---|
171 | a bootscript is not required.
|
---|
172 | </para>
|
---|
173 |
|
---|
174 | <para>
|
---|
175 | <command>mv -v /usr/lib/libfuse.so.* /lib</command>: This moves the
|
---|
176 | <application>FUSE</application> library to the root filesystem
|
---|
177 | so that it is available early in the boot process in case
|
---|
178 | <filename class="directory">/usr</filename> is mounted on a separate
|
---|
179 | partition and <xref linkend="ntfs-3g"/> is built with a system-installed
|
---|
180 | version of <application>FUSE</application>.
|
---|
181 | </para>
|
---|
182 |
|
---|
183 | <para>
|
---|
184 | <command>rm -rf /tmp/init.d</command>: This removes the unneeded
|
---|
185 | bootscript.
|
---|
186 | </para>
|
---|
187 |
|
---|
188 | </sect2>
|
---|
189 |
|
---|
190 | <sect2 role="configuration">
|
---|
191 | <title>Configuring fuse</title>
|
---|
192 |
|
---|
193 | <sect3 id="fuse-config">
|
---|
194 | <title>Config Files</title>
|
---|
195 |
|
---|
196 | <para>
|
---|
197 | Some options regarding mount policy can be set in the file
|
---|
198 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
199 | following command as the <systemitem class="username">root</systemitem>
|
---|
200 | user:
|
---|
201 | </para>
|
---|
202 |
|
---|
203 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
204 | # Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
205 | # The default is 1000.
|
---|
206 | #
|
---|
207 | #mount_max = 1000
|
---|
208 |
|
---|
209 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
210 | # mount options.
|
---|
211 | #
|
---|
212 | #user_allow_other
|
---|
213 | EOF</userinput></screen>
|
---|
214 |
|
---|
215 | <para>
|
---|
216 | Additional information about the meaning of the configuration
|
---|
217 | options are found in the man page.
|
---|
218 | </para>
|
---|
219 |
|
---|
220 | </sect3>
|
---|
221 |
|
---|
222 | </sect2>
|
---|
223 |
|
---|
224 | <sect2 role="content">
|
---|
225 | <title>Contents</title>
|
---|
226 |
|
---|
227 | <segmentedlist>
|
---|
228 | <segtitle>Installed Programs</segtitle>
|
---|
229 | <segtitle>Installed Libraries</segtitle>
|
---|
230 | <segtitle>Installed Directory</segtitle>
|
---|
231 |
|
---|
232 | <seglistitem>
|
---|
233 | <seg>
|
---|
234 | fusermount, mount.fuse, and ulockmgr_server
|
---|
235 | </seg>
|
---|
236 | <seg>
|
---|
237 | libfuse.so and libulockmgr.so
|
---|
238 | </seg>
|
---|
239 | <seg>
|
---|
240 | /usr/include/fuse and /usr/share/doc/fuse-&fuse-version;
|
---|
241 | </seg>
|
---|
242 | </seglistitem>
|
---|
243 | </segmentedlist>
|
---|
244 |
|
---|
245 | <variablelist>
|
---|
246 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
247 | <?dbfo list-presentation="list"?>
|
---|
248 | <?dbhtml list-presentation="table"?>
|
---|
249 |
|
---|
250 | <varlistentry id="fusermount">
|
---|
251 | <term><command>fusermount</command></term>
|
---|
252 | <listitem>
|
---|
253 | <para>
|
---|
254 | is a set users ID root program to mount and unmount Fuse
|
---|
255 | filesystems.
|
---|
256 | </para>
|
---|
257 | <indexterm zone="fuse fusermount">
|
---|
258 | <primary sortas="b-fusermount">fusermount</primary>
|
---|
259 | </indexterm>
|
---|
260 | </listitem>
|
---|
261 | </varlistentry>
|
---|
262 |
|
---|
263 | <varlistentry id="mount.fuse">
|
---|
264 | <term><command>mount.fuse</command></term>
|
---|
265 | <listitem>
|
---|
266 | <para>
|
---|
267 | is the command <command>mount</command> would call to mount a Fuse
|
---|
268 | filesystem.
|
---|
269 | </para>
|
---|
270 | <indexterm zone="fuse mount.fuse">
|
---|
271 | <primary sortas="b-mount.fuse">mount.fuse</primary>
|
---|
272 | </indexterm>
|
---|
273 | </listitem>
|
---|
274 | </varlistentry>
|
---|
275 |
|
---|
276 | <varlistentry id="ulockmgr_server">
|
---|
277 | <term><command>ulockmgr_server</command></term>
|
---|
278 | <listitem>
|
---|
279 | <para>
|
---|
280 | is the Userspace Lock Manager Server for Fuse filesystems.
|
---|
281 | </para>
|
---|
282 | <indexterm zone="fuse ulockmgr_server">
|
---|
283 | <primary sortas="b-ulockmgr_server">ulockmgr_server</primary>
|
---|
284 | </indexterm>
|
---|
285 | </listitem>
|
---|
286 | </varlistentry>
|
---|
287 |
|
---|
288 | <varlistentry id="libfuse">
|
---|
289 | <term><filename class="libraryfile">libfuse.so</filename></term>
|
---|
290 | <listitem>
|
---|
291 | <para>
|
---|
292 | contains the <application>FUSE</application> API functions.
|
---|
293 | </para>
|
---|
294 | <indexterm zone="fuse libfuse">
|
---|
295 | <primary sortas="c-libfuse">libfuse.so</primary>
|
---|
296 | </indexterm>
|
---|
297 | </listitem>
|
---|
298 | </varlistentry>
|
---|
299 |
|
---|
300 | <varlistentry id="libulockmgr">
|
---|
301 | <term><filename class="libraryfile">libulockmgr.so</filename></term>
|
---|
302 | <listitem>
|
---|
303 | <para>
|
---|
304 | contains the Userspace Lock Manager API functions.
|
---|
305 | </para>
|
---|
306 | <indexterm zone="fuse libulockmgr">
|
---|
307 | <primary sortas="c-libulockmgr">libulockmgr.so</primary>
|
---|
308 | </indexterm>
|
---|
309 | </listitem>
|
---|
310 | </varlistentry>
|
---|
311 | </variablelist>
|
---|
312 |
|
---|
313 | </sect2>
|
---|
314 |
|
---|
315 | </sect1>
|
---|