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