[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 " ">
|
---|
[4852356] | 9 | <!ENTITY fuse3-md5sum "2640cd55b3c2a2eb9e78054f77f5c87a">
|
---|
| 10 | <!ENTITY fuse3-size "3.1 MB">
|
---|
| 11 | <!ENTITY fuse3-buildsize "95 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 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
[81060947] | 22 | <title>Fuse-&fuse3-version;</title>
|
---|
[ee000c3d] | 23 |
|
---|
[81060947] | 24 | <indexterm zone="fuse3">
|
---|
[2630345] | 25 | <primary sortas="a-fuse-3">Fuse 3</primary>
|
---|
[ee000c3d] | 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 |
|
---|
[ce1dd9df] | 39 | &lfs112_checked;
|
---|
[ee000c3d] | 40 |
|
---|
| 41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 42 | <itemizedlist spacing="compact">
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
[81060947] | 45 | Download (HTTP): <ulink url="&fuse3-download-http;"/>
|
---|
[ee000c3d] | 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
[81060947] | 50 | Download (FTP): <ulink url="&fuse3-download-ftp;"/>
|
---|
[ee000c3d] | 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
[81060947] | 55 | Download MD5 sum: &fuse3-md5sum;
|
---|
[ee000c3d] | 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
[81060947] | 60 | Download size: &fuse3-size;
|
---|
[ee000c3d] | 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
[81060947] | 65 | Estimated disk space required: &fuse3-buildsize;
|
---|
[ee000c3d] | 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | <listitem>
|
---|
| 69 | <para>
|
---|
[81060947] | 70 | Estimated build time: &fuse3-time;
|
---|
[ee000c3d] | 71 | </para>
|
---|
| 72 | </listitem>
|
---|
| 73 | </itemizedlist>
|
---|
| 74 |
|
---|
[c35f51a] | 75 | <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
|
---|
| 76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 77 | <para role="optional">
|
---|
[8ec0245] | 78 | <xref linkend="doxygen"/> (to rebuild the API documentation) and
|
---|
[8b819c5] | 79 | <xref linkend="pytest"/> (required for tests)
|
---|
[c35f51a] | 80 | </para>
|
---|
[ff9b2cd] | 81 |
|
---|
[ee000c3d] | 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 --->
|
---|
[421128a1] | 96 | <*/M> FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
|
---|
[ee000c3d] | 97 |
|
---|
[8ec0245] | 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 --->
|
---|
| 104 | <*/M> FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]
|
---|
| 105 | <*/M> Character device in Userspace support [CONFIG_CUSE]</literal></screen>
|
---|
| 106 |
|
---|
[81060947] | 107 | <indexterm zone="fuse3 fuse-kernel">
|
---|
[2630345] | 108 | <primary sortas="d-fuse3">Fuse 3</primary>
|
---|
[ee000c3d] | 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 |
|
---|
[7f5826e7] | 120 | <screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &&
|
---|
[d58c5b7] | 121 |
|
---|
[4da56e0] | 122 | mkdir build &&
|
---|
| 123 | cd build &&
|
---|
| 124 |
|
---|
[adf17153] | 125 | meson --prefix=/usr --buildtype=release .. &&
|
---|
[d58c5b7] | 126 | ninja</userinput></screen>
|
---|
[ee000c3d] | 127 |
|
---|
[ff9b2cd] | 128 | <para>
|
---|
[8558044] | 129 | The API documentation is included in the package, but
|
---|
| 130 | if you have <xref linkend="doxygen"/> installed and wish to rebuild
|
---|
[2f3e3de9] | 131 | it, issue:
|
---|
[8558044] | 132 | </para>
|
---|
[5a464e4d] | 133 |
|
---|
[5c2571e3] | 134 | <screen remap="doc"><userinput>pushd .. &&
|
---|
| 135 | doxygen doc/Doxyfile &&
|
---|
| 136 | popd</userinput></screen>
|
---|
[8ec0245] | 137 |
|
---|
| 138 | <para>
|
---|
| 139 | To test the results, run (as the <systemitem
|
---|
| 140 | role="username">root</systemitem> user):
|
---|
| 141 | </para>
|
---|
| 142 |
|
---|
[8d3c348] | 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 |
|
---|
[8ec0245] | 147 | <screen role="root"
|
---|
| 148 | remap="test"><userinput>python3 -m pytest test/</userinput></screen>
|
---|
| 149 |
|
---|
| 150 | <para>
|
---|
[8b819c5] | 151 | The <xref linkend="pytest"/> Python
|
---|
[4852356] | 152 | module is required for the tests. One test named
|
---|
[0f21ee62] | 153 | <filename>test_cuse</filename> will fail if the
|
---|
[1fe05eb] | 154 | <parameter>CONFIG_CUSE</parameter> configuration item was not enabled
|
---|
[4852356] | 155 | when the kernel was built. Two tests,
|
---|
| 156 | <filename>test_ctests.py</filename> and
|
---|
| 157 | <filename>test_examples.py</filename> will produce a warning because a
|
---|
| 158 | deprecated Python module is used.
|
---|
[8ec0245] | 159 | </para>
|
---|
[ee000c3d] | 160 |
|
---|
| 161 | <para>
|
---|
| 162 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 163 | </para>
|
---|
| 164 |
|
---|
[c2f9a33] | 165 | <screen role="root"><userinput>ninja install &&
|
---|
| 166 | chmod u+s /usr/bin/fusermount3 &&
|
---|
| 167 |
|
---|
| 168 | cd .. &&
|
---|
| 169 | install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &&
|
---|
| 170 | install -v -m644 doc/{README.NFS,kernel.txt} \
|
---|
| 171 | /usr/share/doc/fuse-&fuse3-version; &&
|
---|
| 172 | cp -Rv doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
|
---|
[5a464e4d] | 173 |
|
---|
[ee000c3d] | 174 | </sect2>
|
---|
| 175 |
|
---|
| 176 | <sect2 role="commands">
|
---|
| 177 | <title>Command Explanations</title>
|
---|
| 178 |
|
---|
| 179 | <para>
|
---|
[d58c5b7] | 180 | <command>sed ... util/meson.build</command>: This command disables the
|
---|
| 181 | installation of a boot script and udev rule that are not needed.
|
---|
[ee000c3d] | 182 | </para>
|
---|
| 183 |
|
---|
[adf17153] | 184 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 185 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 186 |
|
---|
[ee000c3d] | 187 | </sect2>
|
---|
| 188 |
|
---|
[1647d338] | 189 | <sect2 role="configuration" id="fuse-configuration">
|
---|
[099a8d0] | 190 | <title>Configuring fuse</title>
|
---|
| 191 |
|
---|
| 192 | <sect3 id="fuse-config">
|
---|
| 193 | <title>Config Files</title>
|
---|
| 194 |
|
---|
[f69944f] | 195 | <para>
|
---|
| 196 | Some options regarding mount policy can be set in the file
|
---|
| 197 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
| 198 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 199 | user:
|
---|
| 200 | </para>
|
---|
[099a8d0] | 201 |
|
---|
| 202 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
[51dfb3e] | 203 | <literal># Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
[099a8d0] | 204 | # The default is 1000.
|
---|
| 205 | #
|
---|
| 206 | #mount_max = 1000
|
---|
| 207 |
|
---|
| 208 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
| 209 | # mount options.
|
---|
| 210 | #
|
---|
[51dfb3e] | 211 | #user_allow_other</literal>
|
---|
[099a8d0] | 212 | EOF</userinput></screen>
|
---|
| 213 |
|
---|
[f69944f] | 214 | <para>
|
---|
| 215 | Additional information about the meaning of the configuration
|
---|
| 216 | options are found in the man page.
|
---|
| 217 | </para>
|
---|
[099a8d0] | 218 |
|
---|
| 219 | </sect3>
|
---|
| 220 |
|
---|
| 221 | </sect2>
|
---|
| 222 |
|
---|
[ee000c3d] | 223 | <sect2 role="content">
|
---|
| 224 | <title>Contents</title>
|
---|
| 225 |
|
---|
| 226 | <segmentedlist>
|
---|
| 227 | <segtitle>Installed Programs</segtitle>
|
---|
| 228 | <segtitle>Installed Libraries</segtitle>
|
---|
| 229 | <segtitle>Installed Directory</segtitle>
|
---|
| 230 |
|
---|
| 231 | <seglistitem>
|
---|
| 232 | <seg>
|
---|
[0a7ee10] | 233 | fusermount3 and mount.fuse3
|
---|
[ee000c3d] | 234 | </seg>
|
---|
| 235 | <seg>
|
---|
[1647d338] | 236 | libfuse3.so
|
---|
[f69944f] | 237 | </seg>
|
---|
| 238 | <seg>
|
---|
[81060947] | 239 | /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
|
---|
[ee000c3d] | 240 | </seg>
|
---|
| 241 | </seglistitem>
|
---|
| 242 | </segmentedlist>
|
---|
| 243 |
|
---|
| 244 | <variablelist>
|
---|
| 245 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 246 | <?dbfo list-presentation="list"?>
|
---|
| 247 | <?dbhtml list-presentation="table"?>
|
---|
| 248 |
|
---|
[1647d338] | 249 | <varlistentry id="fusermount3">
|
---|
| 250 | <term><command>fusermount3</command></term>
|
---|
[ee000c3d] | 251 | <listitem>
|
---|
| 252 | <para>
|
---|
[4c24eb0a] | 253 | is a suid root program to mount and unmount Fuse filesystems
|
---|
[ee000c3d] | 254 | </para>
|
---|
[81060947] | 255 | <indexterm zone="fuse3 fusermount3">
|
---|
[1647d338] | 256 | <primary sortas="b-fusermount3">fusermount3</primary>
|
---|
[ee000c3d] | 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
[1647d338] | 261 | <varlistentry id="mount.fuse3">
|
---|
| 262 | <term><command>mount.fuse3</command></term>
|
---|
[ee000c3d] | 263 | <listitem>
|
---|
| 264 | <para>
|
---|
[d58c5b7] | 265 | is the command <command>mount</command> calls to mount a Fuse
|
---|
[4c24eb0a] | 266 | filesystem
|
---|
[ee000c3d] | 267 | </para>
|
---|
[81060947] | 268 | <indexterm zone="fuse3 mount.fuse3">
|
---|
[1647d338] | 269 | <primary sortas="b-mount.fuse3">mount.fuse3</primary>
|
---|
[ee000c3d] | 270 | </indexterm>
|
---|
| 271 | </listitem>
|
---|
| 272 | </varlistentry>
|
---|
| 273 |
|
---|
[1647d338] | 274 | <varlistentry id="libfuse3">
|
---|
| 275 | <term><filename class="libraryfile">libfuse3.so</filename></term>
|
---|
[ee000c3d] | 276 | <listitem>
|
---|
| 277 | <para>
|
---|
[4c24eb0a] | 278 | contains the <application>FUSE</application> API functions
|
---|
[ee000c3d] | 279 | </para>
|
---|
[81060947] | 280 | <indexterm zone="fuse3 libfuse3">
|
---|
[1647d338] | 281 | <primary sortas="c-libfuse3">libfuse3.so</primary>
|
---|
[ee000c3d] | 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | </variablelist>
|
---|
[f69944f] | 287 |
|
---|
[ee000c3d] | 288 | </sect2>
|
---|
[f69944f] | 289 |
|
---|
[ee000c3d] | 290 | </sect1>
|
---|