[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[ee000c3d] | 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 |
|
---|
[0087231b] | 7 | <!ENTITY fuse3-download-http "https://github.com/libfuse/libfuse/releases/download/fuse-&fuse3-version;/fuse-&fuse3-version;.tar.gz">
|
---|
[81060947] | 8 | <!ENTITY fuse3-download-ftp " ">
|
---|
[0d0da5c6] | 9 | <!ENTITY fuse3-md5sum "b00bf08b27ead4a9411578777e94a1cc">
|
---|
[ea7abff3] | 10 | <!ENTITY fuse3-size "14 MB">
|
---|
[0d0da5c6] | 11 | <!ENTITY fuse3-buildsize "222 MB (with tests and documentation)">
|
---|
[c1be7853] | 12 | <!ENTITY fuse3-time "0.2 SBU (add 0.3 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 |
|
---|
[57791dd] | 36 | &lfs122_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">
|
---|
[60e8d690] | 75 | <xref linkend="doxygen"/> (to rebuild the API documentation),
|
---|
| 76 | <xref linkend="pytest"/> (required for tests), and
|
---|
| 77 | <ulink url="https://pypi.org/project/looseversion/">looseversion</ulink>
|
---|
| 78 | (for tests)
|
---|
[c35f51a] | 79 | </para>
|
---|
[ff9b2cd] | 80 |
|
---|
[ee000c3d] | 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="kernel" id="fuse-kernel">
|
---|
| 84 | <title>Kernel Configuration</title>
|
---|
| 85 |
|
---|
| 86 | <para>
|
---|
| 87 | Enable the following options in the kernel configuration and recompile the
|
---|
| 88 | kernel if necessary:
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
[4955b595] | 91 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 92 | href="fuse-kernel.xml"/>
|
---|
[ee000c3d] | 93 |
|
---|
[8ec0245] | 94 | <para>
|
---|
[a0e08b2] | 95 | Character devices in userspace should be enabled too for running the
|
---|
[8ec0245] | 96 | tests:
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
[4955b595] | 99 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 100 | href="fuse-test-kernel.xml"/>
|
---|
[8ec0245] | 101 |
|
---|
[81060947] | 102 | <indexterm zone="fuse3 fuse-kernel">
|
---|
[2630345] | 103 | <primary sortas="d-fuse3">Fuse 3</primary>
|
---|
[ee000c3d] | 104 | </indexterm>
|
---|
| 105 | </sect2>
|
---|
| 106 |
|
---|
| 107 | <sect2 role="installation">
|
---|
| 108 | <title>Installation of Fuse</title>
|
---|
| 109 |
|
---|
| 110 | <para>
|
---|
| 111 | Install <application>Fuse</application> by running the following
|
---|
| 112 | commands:
|
---|
| 113 | </para>
|
---|
| 114 |
|
---|
[7f5826e7] | 115 | <screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &&
|
---|
[d58c5b7] | 116 |
|
---|
[4da56e0] | 117 | mkdir build &&
|
---|
| 118 | cd build &&
|
---|
| 119 |
|
---|
[91318eb] | 120 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
[d58c5b7] | 121 | ninja</userinput></screen>
|
---|
[ee000c3d] | 122 |
|
---|
[ff9b2cd] | 123 | <para>
|
---|
[8558044] | 124 | The API documentation is included in the package, but
|
---|
| 125 | if you have <xref linkend="doxygen"/> installed and wish to rebuild
|
---|
[2f3e3de9] | 126 | it, issue:
|
---|
[8558044] | 127 | </para>
|
---|
[5a464e4d] | 128 |
|
---|
[5c2571e3] | 129 | <screen remap="doc"><userinput>pushd .. &&
|
---|
| 130 | doxygen doc/Doxyfile &&
|
---|
| 131 | popd</userinput></screen>
|
---|
[8ec0245] | 132 |
|
---|
| 133 | <para>
|
---|
[60e8d690] | 134 | To test the results, issue the following commands (as the <systemitem
|
---|
[8ec0245] | 135 | role="username">root</systemitem> user):
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[4955b595] | 138 | <!-- EDITORS NOTE:
|
---|
| 139 |
|
---|
| 140 | Don't use 'pytest' instead of 'python3 -m pytest'. There is no
|
---|
| 141 | testenv/bin/pytest (as at pytest-7.4.0) so 'pytest' resolves to
|
---|
| 142 | /usr/bin/pytest, and the shebang of it is /usr/bin/python3.11.
|
---|
| 143 | So it won't find the looseversion installed in testenv.
|
---|
| 144 |
|
---|
| 145 | To view the results of the tests, look for
|
---|
[8d3c348] | 146 | "short test summary info" at the end of your log. Below skipped tests,
|
---|
| 147 | you will see "X passed, X skipped, X failed (if any) in X seconds" -->
|
---|
| 148 |
|
---|
[60e8d690] | 149 | <screen role="root" remap="test"><userinput>python3 -m venv --system-site-packages testenv &&
|
---|
| 150 | source testenv/bin/activate &&
|
---|
| 151 | pip3 install looseversion &&
|
---|
[df1816be] | 152 | python3 -m pytest
|
---|
[60e8d690] | 153 | deactivate</userinput></screen>
|
---|
[8ec0245] | 154 |
|
---|
| 155 | <para>
|
---|
[8b819c5] | 156 | The <xref linkend="pytest"/> Python
|
---|
[60e8d690] | 157 | module is required for the tests. One test named
|
---|
[0f21ee62] | 158 | <filename>test_cuse</filename> will fail if the
|
---|
[1fe05eb] | 159 | <parameter>CONFIG_CUSE</parameter> configuration item was not enabled
|
---|
[60e8d690] | 160 | when the kernel was built. One test,
|
---|
| 161 | <filename>test/util.py</filename>, will output a warning due to the usage
|
---|
| 162 | of an unknown mark in pytest.
|
---|
[8ec0245] | 163 | </para>
|
---|
[ee000c3d] | 164 |
|
---|
| 165 | <para>
|
---|
| 166 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 167 | </para>
|
---|
| 168 |
|
---|
[c2f9a33] | 169 | <screen role="root"><userinput>ninja install &&
|
---|
| 170 | chmod u+s /usr/bin/fusermount3 &&
|
---|
| 171 |
|
---|
| 172 | cd .. &&
|
---|
[4955b595] | 173 | cp -Rv doc/html -T /usr/share/doc/fuse-&fuse3-version; &&
|
---|
| 174 | install -v -m644 doc/{README.NFS,kernel.txt} \
|
---|
| 175 | /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
|
---|
[5a464e4d] | 176 |
|
---|
[ee000c3d] | 177 | </sect2>
|
---|
| 178 |
|
---|
| 179 | <sect2 role="commands">
|
---|
| 180 | <title>Command Explanations</title>
|
---|
| 181 |
|
---|
| 182 | <para>
|
---|
[d58c5b7] | 183 | <command>sed ... util/meson.build</command>: This command disables the
|
---|
| 184 | installation of a boot script and udev rule that are not needed.
|
---|
[ee000c3d] | 185 | </para>
|
---|
| 186 |
|
---|
[adf17153] | 187 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 188 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 189 |
|
---|
[ee000c3d] | 190 | </sect2>
|
---|
| 191 |
|
---|
[1647d338] | 192 | <sect2 role="configuration" id="fuse-configuration">
|
---|
[099a8d0] | 193 | <title>Configuring fuse</title>
|
---|
| 194 |
|
---|
| 195 | <sect3 id="fuse-config">
|
---|
| 196 | <title>Config Files</title>
|
---|
| 197 |
|
---|
[f69944f] | 198 | <para>
|
---|
| 199 | Some options regarding mount policy can be set in the file
|
---|
| 200 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
| 201 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 202 | user:
|
---|
| 203 | </para>
|
---|
[099a8d0] | 204 |
|
---|
| 205 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
[51dfb3e] | 206 | <literal># Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
[099a8d0] | 207 | # The default is 1000.
|
---|
| 208 | #
|
---|
| 209 | #mount_max = 1000
|
---|
| 210 |
|
---|
| 211 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
| 212 | # mount options.
|
---|
| 213 | #
|
---|
[51dfb3e] | 214 | #user_allow_other</literal>
|
---|
[099a8d0] | 215 | EOF</userinput></screen>
|
---|
| 216 |
|
---|
[f69944f] | 217 | <para>
|
---|
| 218 | Additional information about the meaning of the configuration
|
---|
| 219 | options are found in the man page.
|
---|
| 220 | </para>
|
---|
[099a8d0] | 221 |
|
---|
| 222 | </sect3>
|
---|
| 223 |
|
---|
| 224 | </sect2>
|
---|
| 225 |
|
---|
[ee000c3d] | 226 | <sect2 role="content">
|
---|
| 227 | <title>Contents</title>
|
---|
| 228 |
|
---|
| 229 | <segmentedlist>
|
---|
| 230 | <segtitle>Installed Programs</segtitle>
|
---|
| 231 | <segtitle>Installed Libraries</segtitle>
|
---|
| 232 | <segtitle>Installed Directory</segtitle>
|
---|
| 233 |
|
---|
| 234 | <seglistitem>
|
---|
| 235 | <seg>
|
---|
[0a7ee10] | 236 | fusermount3 and mount.fuse3
|
---|
[ee000c3d] | 237 | </seg>
|
---|
| 238 | <seg>
|
---|
[1647d338] | 239 | libfuse3.so
|
---|
[f69944f] | 240 | </seg>
|
---|
| 241 | <seg>
|
---|
[81060947] | 242 | /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
|
---|
[ee000c3d] | 243 | </seg>
|
---|
| 244 | </seglistitem>
|
---|
| 245 | </segmentedlist>
|
---|
| 246 |
|
---|
| 247 | <variablelist>
|
---|
| 248 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 249 | <?dbfo list-presentation="list"?>
|
---|
| 250 | <?dbhtml list-presentation="table"?>
|
---|
| 251 |
|
---|
[1647d338] | 252 | <varlistentry id="fusermount3">
|
---|
| 253 | <term><command>fusermount3</command></term>
|
---|
[ee000c3d] | 254 | <listitem>
|
---|
| 255 | <para>
|
---|
[4c24eb0a] | 256 | is a suid root program to mount and unmount Fuse filesystems
|
---|
[ee000c3d] | 257 | </para>
|
---|
[81060947] | 258 | <indexterm zone="fuse3 fusermount3">
|
---|
[1647d338] | 259 | <primary sortas="b-fusermount3">fusermount3</primary>
|
---|
[ee000c3d] | 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
| 263 |
|
---|
[1647d338] | 264 | <varlistentry id="mount.fuse3">
|
---|
| 265 | <term><command>mount.fuse3</command></term>
|
---|
[ee000c3d] | 266 | <listitem>
|
---|
| 267 | <para>
|
---|
[d58c5b7] | 268 | is the command <command>mount</command> calls to mount a Fuse
|
---|
[4c24eb0a] | 269 | filesystem
|
---|
[ee000c3d] | 270 | </para>
|
---|
[81060947] | 271 | <indexterm zone="fuse3 mount.fuse3">
|
---|
[1647d338] | 272 | <primary sortas="b-mount.fuse3">mount.fuse3</primary>
|
---|
[ee000c3d] | 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
[1647d338] | 277 | <varlistentry id="libfuse3">
|
---|
| 278 | <term><filename class="libraryfile">libfuse3.so</filename></term>
|
---|
[ee000c3d] | 279 | <listitem>
|
---|
| 280 | <para>
|
---|
[4c24eb0a] | 281 | contains the <application>FUSE</application> API functions
|
---|
[ee000c3d] | 282 | </para>
|
---|
[81060947] | 283 | <indexterm zone="fuse3 libfuse3">
|
---|
[1647d338] | 284 | <primary sortas="c-libfuse3">libfuse3.so</primary>
|
---|
[ee000c3d] | 285 | </indexterm>
|
---|
| 286 | </listitem>
|
---|
| 287 | </varlistentry>
|
---|
| 288 |
|
---|
| 289 | </variablelist>
|
---|
[f69944f] | 290 |
|
---|
[ee000c3d] | 291 | </sect2>
|
---|
[f69944f] | 292 |
|
---|
[ee000c3d] | 293 | </sect1>
|
---|