source: postlfs/filesystems/fuse3.xml@ 8558044

ken/refactor-virt lazarus qt5new trunk upgradedb
Last change on this file since 8558044 was 8558044, checked in by Pierre Labastie <pierre.labastie@…>, 5 months ago

Remove spaces at the end of lines

I know it is somewhat useless, but I don't like them for
two reasons: first they cannot be seen, and I do not like things I
cannot see. Second, git highlights them, and this is disturbing...

  • Property mode set to 100644
File size: 8.0 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 "55b87e9ed691c2fa698e491241985b4a">
10 <!ENTITY fuse3-size "2.7 MB">
11 <!ENTITY fuse3-buildsize "150 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<screen role="root"
144 remap="test"><userinput>python3 -m pytest test/</userinput></screen>
145
146 <para>
147 The <ulink url="https://pypi.org/project/pytest/">pytest</ulink>
148 Python module is required for the tests.
149 </para>
150
151 <para>
152 Now, as the <systemitem class="username">root</systemitem> user:
153 </para>
154
155<screen role="root"><userinput>ninja install &amp;&amp;
156
157chmod u+s /usr/bin/fusermount3 &amp;&amp;
158
159install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
160install -v -m644 ../doc/{README.NFS,kernel.txt} \
161 /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
162cp -Rv ../doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
163
164 </sect2>
165
166 <sect2 role="commands">
167 <title>Command Explanations</title>
168
169 <para>
170 <command>sed ... util/meson.build</command>: This command disables the
171 installation of a boot script and udev rule that are not needed.
172 </para>
173
174 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
175 href="../../xincludes/meson-buildtype-release.xml"/>
176
177 </sect2>
178
179 <sect2 role="configuration" id="fuse-configuration">
180 <title>Configuring fuse</title>
181
182 <sect3 id="fuse-config">
183 <title>Config Files</title>
184
185 <para>
186 Some options regarding mount policy can be set in the file
187 <filename>/etc/fuse.conf</filename>. To install the file run the
188 following command as the <systemitem class="username">root</systemitem>
189 user:
190 </para>
191
192<screen role="root"><userinput>cat &gt; /etc/fuse.conf &lt;&lt; "EOF"
193<literal># Set the maximum number of FUSE mounts allowed to non-root users.
194# The default is 1000.
195#
196#mount_max = 1000
197
198# Allow non-root users to specify the 'allow_other' or 'allow_root'
199# mount options.
200#
201#user_allow_other</literal>
202EOF</userinput></screen>
203
204 <para>
205 Additional information about the meaning of the configuration
206 options are found in the man page.
207 </para>
208
209 </sect3>
210
211 </sect2>
212
213 <sect2 role="content">
214 <title>Contents</title>
215
216 <segmentedlist>
217 <segtitle>Installed Programs</segtitle>
218 <segtitle>Installed Libraries</segtitle>
219 <segtitle>Installed Directory</segtitle>
220
221 <seglistitem>
222 <seg>
223 fusermount3 and mount.fuse3
224 </seg>
225 <seg>
226 libfuse3.so
227 </seg>
228 <seg>
229 /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
230 </seg>
231 </seglistitem>
232 </segmentedlist>
233
234 <variablelist>
235 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
236 <?dbfo list-presentation="list"?>
237 <?dbhtml list-presentation="table"?>
238
239 <varlistentry id="fusermount3">
240 <term><command>fusermount3</command></term>
241 <listitem>
242 <para>
243 is a suid root program to mount and unmount Fuse filesystems
244 </para>
245 <indexterm zone="fuse3 fusermount3">
246 <primary sortas="b-fusermount3">fusermount3</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="mount.fuse3">
252 <term><command>mount.fuse3</command></term>
253 <listitem>
254 <para>
255 is the command <command>mount</command> calls to mount a Fuse
256 filesystem
257 </para>
258 <indexterm zone="fuse3 mount.fuse3">
259 <primary sortas="b-mount.fuse3">mount.fuse3</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="libfuse3">
265 <term><filename class="libraryfile">libfuse3.so</filename></term>
266 <listitem>
267 <para>
268 contains the <application>FUSE</application> API functions
269 </para>
270 <indexterm zone="fuse3 libfuse3">
271 <primary sortas="c-libfuse3">libfuse3.so</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 </variablelist>
277
278 </sect2>
279
280</sect1>
Note: See TracBrowser for help on using the repository browser.