source: postlfs/filesystems/fuse3.xml@ 8d3c348

ken/refactor-virt lazarus qt5new trunk upgradedb
Last change on this file since 8d3c348 was 8d3c348, checked in by Douglas R. Reno <renodr@…>, 5 months ago

Update to fuse-3.10.5

  • Property mode set to 100644
File size: 8.2 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 "d2eb13af5288047dc942fc84e608cfbd">
10 <!ENTITY fuse3-size "2.8 MB">
11 <!ENTITY fuse3-buildsize "161 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 <date>$Date$</date>
20 </sect1info>
21
22 <title>Fuse-&fuse3-version;</title>
23
24 <indexterm zone="fuse3">
25 <primary sortas="a-fuse-3">Fuse 3</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to Fuse</title>
30
31 <para>
32 <application>FUSE</application> (Filesystem in Userspace) is a simple
33 interface for userspace programs to export a virtual filesystem to the
34 Linux kernel. <application>Fuse</application> also aims to provide a
35 secure method for non privileged users to create and mount their own
36 filesystem implementations.
37 </para>
38
39 &lfs110a_checked;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&fuse3-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&fuse3-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &fuse3-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &fuse3-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &fuse3-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &fuse3-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
76 <bridgehead renderas="sect4">Optional</bridgehead>
77 <para role="optional">
78 <xref linkend="doxygen"/> (to rebuild the API documentation) and
79 <ulink url="https://pypi.org/project/pytest/">pytest</ulink> (required for tests)
80 </para>
81
82 <para condition="html" role="usernotes">
83 User Notes: <ulink url="&blfs-wiki;/fuse"/>
84 </para>
85 </sect2>
86
87 <sect2 role="kernel" id="fuse-kernel">
88 <title>Kernel Configuration</title>
89
90 <para>
91 Enable the following options in the kernel configuration and recompile the
92 kernel if necessary:
93 </para>
94
95<screen><literal>File systems ---&gt;
96 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
97
98 <para>
99 Character devices in user space should be enabled too for running the
100 tests:
101 </para>
102
103<screen><literal>File systems ---&gt;
104 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]
105 &lt;*/M&gt; Character device in Userspace support [CONFIG_CUSE]</literal></screen>
106
107 <indexterm zone="fuse3 fuse-kernel">
108 <primary sortas="d-fuse3">Fuse 3</primary>
109 </indexterm>
110 </sect2>
111
112 <sect2 role="installation">
113 <title>Installation of Fuse</title>
114
115 <para>
116 Install <application>Fuse</application> by running the following
117 commands:
118 </para>
119
120<screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &amp;&amp;
121
122mkdir build &amp;&amp;
123cd build &amp;&amp;
124
125meson --prefix=/usr --buildtype=release .. &amp;&amp;
126ninja</userinput></screen>
127
128 <para>
129 The API documentation is included in the package, but
130 if you have <xref linkend="doxygen"/> installed and wish to rebuild
131 it, issue:
132 </para>
133
134<screen remap="doc"><userinput>pushd .. &amp;&amp;
135 doxygen doc/Doxyfile &amp;&amp;
136popd</userinput></screen>
137
138 <para>
139 To test the results, run (as the <systemitem
140 role="username">root</systemitem> user):
141 </para>
142
143 <!-- EDITORS NOTE: To view the results of the tests, look for
144 "short test summary info" at the end of your log. Below skipped tests,
145 you will see "X passed, X skipped, X failed (if any) in X seconds" -->
146
147<screen role="root"
148 remap="test"><userinput>python3 -m pytest test/</userinput></screen>
149
150 <para>
151 The <ulink url="https://pypi.org/project/pytest/">pytest</ulink>
152 Python module is required for the tests.
153 </para>
154
155 <para>
156 Now, as the <systemitem class="username">root</systemitem> user:
157 </para>
158
159<screen role="root"><userinput>ninja install &amp;&amp;
160
161chmod u+s /usr/bin/fusermount3 &amp;&amp;
162
163install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
164install -v -m644 ../doc/{README.NFS,kernel.txt} \
165 /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
166cp -Rv ../doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
167
168 </sect2>
169
170 <sect2 role="commands">
171 <title>Command Explanations</title>
172
173 <para>
174 <command>sed ... util/meson.build</command>: This command disables the
175 installation of a boot script and udev rule that are not needed.
176 </para>
177
178 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
179 href="../../xincludes/meson-buildtype-release.xml"/>
180
181 </sect2>
182
183 <sect2 role="configuration" id="fuse-configuration">
184 <title>Configuring fuse</title>
185
186 <sect3 id="fuse-config">
187 <title>Config Files</title>
188
189 <para>
190 Some options regarding mount policy can be set in the file
191 <filename>/etc/fuse.conf</filename>. To install the file run the
192 following command as the <systemitem class="username">root</systemitem>
193 user:
194 </para>
195
196<screen role="root"><userinput>cat &gt; /etc/fuse.conf &lt;&lt; "EOF"
197<literal># Set the maximum number of FUSE mounts allowed to non-root users.
198# The default is 1000.
199#
200#mount_max = 1000
201
202# Allow non-root users to specify the 'allow_other' or 'allow_root'
203# mount options.
204#
205#user_allow_other</literal>
206EOF</userinput></screen>
207
208 <para>
209 Additional information about the meaning of the configuration
210 options are found in the man page.
211 </para>
212
213 </sect3>
214
215 </sect2>
216
217 <sect2 role="content">
218 <title>Contents</title>
219
220 <segmentedlist>
221 <segtitle>Installed Programs</segtitle>
222 <segtitle>Installed Libraries</segtitle>
223 <segtitle>Installed Directory</segtitle>
224
225 <seglistitem>
226 <seg>
227 fusermount3 and mount.fuse3
228 </seg>
229 <seg>
230 libfuse3.so
231 </seg>
232 <seg>
233 /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
234 </seg>
235 </seglistitem>
236 </segmentedlist>
237
238 <variablelist>
239 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
240 <?dbfo list-presentation="list"?>
241 <?dbhtml list-presentation="table"?>
242
243 <varlistentry id="fusermount3">
244 <term><command>fusermount3</command></term>
245 <listitem>
246 <para>
247 is a suid root program to mount and unmount Fuse filesystems
248 </para>
249 <indexterm zone="fuse3 fusermount3">
250 <primary sortas="b-fusermount3">fusermount3</primary>
251 </indexterm>
252 </listitem>
253 </varlistentry>
254
255 <varlistentry id="mount.fuse3">
256 <term><command>mount.fuse3</command></term>
257 <listitem>
258 <para>
259 is the command <command>mount</command> calls to mount a Fuse
260 filesystem
261 </para>
262 <indexterm zone="fuse3 mount.fuse3">
263 <primary sortas="b-mount.fuse3">mount.fuse3</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 <varlistentry id="libfuse3">
269 <term><filename class="libraryfile">libfuse3.so</filename></term>
270 <listitem>
271 <para>
272 contains the <application>FUSE</application> API functions
273 </para>
274 <indexterm zone="fuse3 libfuse3">
275 <primary sortas="c-libfuse3">libfuse3.so</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 </variablelist>
281
282 </sect2>
283
284</sect1>
Note: See TracBrowser for help on using the repository browser.