source: postlfs/filesystems/fuse3.xml@ 2630345

10.0 10.1 11.0 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 2630345 was 2630345, checked in by Pierre Labastie <pieere@…>, 4 years ago

Fix a few longindex entries again

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

  • Property mode set to 100644
File size: 7.8 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 "5dc79e3b7e0afbd6f8c5c335405227d1">
10 <!ENTITY fuse3-size "1.0 MB">
11 <!ENTITY fuse3-buildsize "14 MB">
12 <!ENTITY fuse3-time "less than 0.1 SBU">
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 &lfs82_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)
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 <indexterm zone="fuse3 fuse-kernel">
99 <primary sortas="d-fuse3">Fuse 3</primary>
100 </indexterm>
101 </sect2>
102
103 <sect2 role="installation">
104 <title>Installation of Fuse</title>
105
106 <para>
107 Install <application>Fuse</application> by running the following
108 commands:
109 </para>
110
111<screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &amp;&amp;
112
113mkdir build &amp;&amp;
114cd build &amp;&amp;
115
116meson --prefix=/usr .. &amp;&amp;
117ninja</userinput></screen>
118
119 <para>
120 The API documentation is included in the package, but
121 if you have <xref linkend="doxygen"/> installed and wish to rebuild
122 it, issue <command>doxygen doc/Doxyfile</command>.
123 </para>
124
125 <para>
126 This package does not come with a test suite.
127 </para>
128
129 <para>
130 Now, as the <systemitem class="username">root</systemitem> user:
131 </para>
132
133<screen role="root"><userinput>ninja install &amp;&amp;
134
135mv -vf /usr/lib/libfuse3.so.3* /lib &amp;&amp;
136ln -sfvn ../../lib/libfuse3.so.3.2.1 /usr/lib/libfuse3.so &amp;&amp;
137
138mv -vf /usr/bin/fusermount3 /bin &amp;&amp;
139mv -vf /usr/sbin/mount.fuse3 /sbin &amp;&amp;
140chmod u+s /bin/fusermount3 &amp;&amp;
141
142install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
143install -v -m644 ../doc/{README.NFS,kernel.txt} \
144 /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
145cp -Rv ../doc/html /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
146
147gunzip /usr/share/man/{man1/fusermount3.1,man8/mount.fuse.8}.gz</userinput></screen>
148
149 </sect2>
150
151 <sect2 role="commands">
152 <title>Command Explanations</title>
153
154 <para>
155 <command>sed ... util/meson.build</command>: This command disables the
156 installation of a boot script and udev rule that are not needed.
157 </para>
158
159 <para>
160 <command>mv ... libfuse3.so.3*; ln ... libfuse3.so</command>:
161 These commands install the libraries in the /lib directory.
162 </para>
163
164 <para>
165 <command>unzip ...</command>: This uncompresses the installed man pages
166 to be consistent with the rest of the man pages.
167 </para>
168
169 </sect2>
170
171 <sect2 role="configuration" id="fuse-configuration">
172 <title>Configuring fuse</title>
173
174 <sect3 id="fuse-config">
175 <title>Config Files</title>
176
177 <para>
178 Some options regarding mount policy can be set in the file
179 <filename>/etc/fuse.conf</filename>. To install the file run the
180 following command as the <systemitem class="username">root</systemitem>
181 user:
182 </para>
183
184<screen role="root"><userinput>cat &gt; /etc/fuse.conf &lt;&lt; "EOF"
185# Set the maximum number of FUSE mounts allowed to non-root users.
186# The default is 1000.
187#
188#mount_max = 1000
189
190# Allow non-root users to specify the 'allow_other' or 'allow_root'
191# mount options.
192#
193#user_allow_other
194EOF</userinput></screen>
195
196 <para>
197 Additional information about the meaning of the configuration
198 options are found in the man page.
199 </para>
200
201 </sect3>
202
203 </sect2>
204
205 <sect2 role="content">
206 <title>Contents</title>
207
208 <segmentedlist>
209 <segtitle>Installed Programs</segtitle>
210 <segtitle>Installed Libraries</segtitle>
211 <segtitle>Installed Directory</segtitle>
212
213 <seglistitem>
214 <seg>
215 fusermount3, mount.fuse3
216 </seg>
217 <seg>
218 libfuse3.so
219 </seg>
220 <seg>
221 /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
222 </seg>
223 </seglistitem>
224 </segmentedlist>
225
226 <variablelist>
227 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
228 <?dbfo list-presentation="list"?>
229 <?dbhtml list-presentation="table"?>
230
231 <varlistentry id="fusermount3">
232 <term><command>fusermount3</command></term>
233 <listitem>
234 <para>
235 is a suid root program to mount and unmount Fuse filesystems.
236 </para>
237 <indexterm zone="fuse3 fusermount3">
238 <primary sortas="b-fusermount3">fusermount3</primary>
239 </indexterm>
240 </listitem>
241 </varlistentry>
242
243 <varlistentry id="mount.fuse3">
244 <term><command>mount.fuse3</command></term>
245 <listitem>
246 <para>
247 is the command <command>mount</command> calls to mount a Fuse
248 filesystem.
249 </para>
250 <indexterm zone="fuse3 mount.fuse3">
251 <primary sortas="b-mount.fuse3">mount.fuse3</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="libfuse3">
257 <term><filename class="libraryfile">libfuse3.so</filename></term>
258 <listitem>
259 <para>
260 contains the <application>FUSE</application> API functions.
261 </para>
262 <indexterm zone="fuse3 libfuse3">
263 <primary sortas="c-libfuse3">libfuse3.so</primary>
264 </indexterm>
265 </listitem>
266 </varlistentry>
267
268 </variablelist>
269
270 </sect2>
271
272</sect1>
Note: See TracBrowser for help on using the repository browser.