source: postlfs/filesystems/fuse3.xml@ 0a7ee10

10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 0a7ee10 was 0a7ee10, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Update to pcmanfm-1.3.2
Update to libfm-1.3.2
Update to libfm-extra-1.3.2
Update to fuse-3.10.2
Update to btrfs-progs-5.10.1
Update to libisoburn-1.5.4
Update to libisofs-1.5.4
Update to libburn-1.5.4

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@24203 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 8.5 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 fuse3-download-http "https://github.com/libfuse/libfuse/releases/download/fuse-&fuse3-version;/fuse-&fuse3-version;.tar.xz">
8 <!ENTITY fuse3-download-ftp " ">
9 <!ENTITY fuse3-md5sum "1c60ab35e72f1b6cb3903a49f3563aee">
10 <!ENTITY fuse3-size "2.0 MB">
11 <!ENTITY fuse3-buildsize "146 MB">
12 <!ENTITY fuse3-time "0.1 SBU (add 0.4 SBU for tests)">
13]>
14
15<sect1 id="fuse3" xreflabel="Fuse-&fuse3-version;">
16 <?dbhtml filename="fuse.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>Fuse-&fuse3-version;</title>
24
25 <indexterm zone="fuse3">
26 <primary sortas="a-fuse-3">Fuse 3</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 &lfs10_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&fuse3-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&fuse3-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &fuse3-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &fuse3-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &fuse3-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &fuse3-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
77 <bridgehead renderas="sect4">Optional</bridgehead>
78 <para role="optional">
79 <xref linkend="doxygen"/> (to rebuild the API documentation) and
80 <ulink url="https://pypi.org/project/pytest/">pytest</ulink> (for tests)
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 ---&gt;
97 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
98
99 <para>
100 Character devices in user space should be enabled too for running the
101 tests:
102 </para>
103
104<screen><literal>File systems ---&gt;
105 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]
106 &lt;*/M&gt; Character device in Userspace support [CONFIG_CUSE]</literal></screen>
107
108 <indexterm zone="fuse3 fuse-kernel">
109 <primary sortas="d-fuse3">Fuse 3</primary>
110 </indexterm>
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Fuse</title>
115
116 <para>
117 Install <application>Fuse</application> by running the following
118 commands:
119 </para>
120
121<screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &amp;&amp;
122
123mkdir build &amp;&amp;
124cd build &amp;&amp;
125
126meson --prefix=/usr .. &amp;&amp;
127ninja</userinput></screen>
128
129 <para>
130 The API documentation is included in the package, but
131 if you have <xref linkend="doxygen"/> installed and wish to rebuild
132 it, issue:
133 </para>
134
135<screen remap="doc"><userinput>doxygen doc/Doxyfile</userinput></screen>
136
137<!--
138 <para>
139 This package does not come with a test suite.
140 </para>
141-->
142
143 <para>
144 To test the results, run (as the <systemitem
145 role="username">root</systemitem> user):
146 </para>
147
148<screen role="root"
149 remap="test"><userinput>python3 -m pytest test/</userinput></screen>
150
151 <para>
152 The <ulink url="https://pypi.org/project/pytest/">pytest</ulink>
153 Python module is needed for the tests.
154 </para>
155
156 <para>
157 Now, as the <systemitem class="username">root</systemitem> user:
158 </para>
159
160<screen role="root"><userinput>ninja install &amp;&amp;
161
162mv -vf /usr/lib/libfuse3.so.3* /lib &amp;&amp;
163ln -sfvn ../../lib/libfuse3.so.&fuse3-version; /usr/lib/libfuse3.so &amp;&amp;
164
165mv -vf /usr/bin/fusermount3 /bin &amp;&amp;
166mv -vf /usr/sbin/mount.fuse3 /sbin &amp;&amp;
167chmod u+s /bin/fusermount3 &amp;&amp;
168
169install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
170install -v -m644 ../doc/{README.NFS,kernel.txt} \
171 /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
172cp -Rv ../doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
173
174 </sect2>
175
176 <sect2 role="commands">
177 <title>Command Explanations</title>
178
179 <para>
180 <command>sed ... util/meson.build</command>: This command disables the
181 installation of a boot script and udev rule that are not needed.
182 </para>
183
184 <para>
185 <command>mv ... libfuse3.so.3*; ln ... libfuse3.so</command>:
186 These commands install the libraries in the /lib directory.
187 </para>
188<!--
189 <para>
190 <command>unzip ...</command>: This uncompresses the installed man pages
191 to be consistent with the rest of the man pages.
192 </para>
193-->
194 </sect2>
195
196 <sect2 role="configuration" id="fuse-configuration">
197 <title>Configuring fuse</title>
198
199 <sect3 id="fuse-config">
200 <title>Config Files</title>
201
202 <para>
203 Some options regarding mount policy can be set in the file
204 <filename>/etc/fuse.conf</filename>. To install the file run the
205 following command as the <systemitem class="username">root</systemitem>
206 user:
207 </para>
208
209<screen role="root"><userinput>cat &gt; /etc/fuse.conf &lt;&lt; "EOF"
210<literal># Set the maximum number of FUSE mounts allowed to non-root users.
211# The default is 1000.
212#
213#mount_max = 1000
214
215# Allow non-root users to specify the 'allow_other' or 'allow_root'
216# mount options.
217#
218#user_allow_other</literal>
219EOF</userinput></screen>
220
221 <para>
222 Additional information about the meaning of the configuration
223 options are found in the man page.
224 </para>
225
226 </sect3>
227
228 </sect2>
229
230 <sect2 role="content">
231 <title>Contents</title>
232
233 <segmentedlist>
234 <segtitle>Installed Programs</segtitle>
235 <segtitle>Installed Libraries</segtitle>
236 <segtitle>Installed Directory</segtitle>
237
238 <seglistitem>
239 <seg>
240 fusermount3 and mount.fuse3
241 </seg>
242 <seg>
243 libfuse3.so
244 </seg>
245 <seg>
246 /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
247 </seg>
248 </seglistitem>
249 </segmentedlist>
250
251 <variablelist>
252 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
253 <?dbfo list-presentation="list"?>
254 <?dbhtml list-presentation="table"?>
255
256 <varlistentry id="fusermount3">
257 <term><command>fusermount3</command></term>
258 <listitem>
259 <para>
260 is a suid root program to mount and unmount Fuse filesystems.
261 </para>
262 <indexterm zone="fuse3 fusermount3">
263 <primary sortas="b-fusermount3">fusermount3</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="mount.fuse3">
269 <term><command>mount.fuse3</command></term>
270 <listitem>
271 <para>
272 is the command <command>mount</command> calls to mount a Fuse
273 filesystem.
274 </para>
275 <indexterm zone="fuse3 mount.fuse3">
276 <primary sortas="b-mount.fuse3">mount.fuse3</primary>
277 </indexterm>
278 </listitem>
279 </varlistentry>
280
281 <varlistentry id="libfuse3">
282 <term><filename class="libraryfile">libfuse3.so</filename></term>
283 <listitem>
284 <para>
285 contains the <application>FUSE</application> API functions.
286 </para>
287 <indexterm zone="fuse3 libfuse3">
288 <primary sortas="c-libfuse3">libfuse3.so</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 </variablelist>
294
295 </sect2>
296
297</sect1>
Note: See TracBrowser for help on using the repository browser.