[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 " ">
|
---|
[565321fe] | 9 | <!ENTITY fuse3-md5sum "8408813fc357ca2dada73c7992dc7ca3">
|
---|
[5d01724] | 10 | <!ENTITY fuse3-size "1.0 MB">
|
---|
[565321fe] | 11 | <!ENTITY fuse3-buildsize "13 MB">
|
---|
[d58c5b7] | 12 | <!ENTITY fuse3-time "less than 0.1 SBU">
|
---|
[ee000c3d] | 13 | ]>
|
---|
| 14 |
|
---|
[81060947] | 15 | <sect1 id="fuse3" xreflabel="Fuse-&fuse3-version;">
|
---|
[ee000c3d] | 16 | <?dbhtml filename="fuse.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[81060947] | 23 | <title>Fuse-&fuse3-version;</title>
|
---|
[ee000c3d] | 24 |
|
---|
[81060947] | 25 | <indexterm zone="fuse3">
|
---|
[2630345] | 26 | <primary sortas="a-fuse-3">Fuse 3</primary>
|
---|
[ee000c3d] | 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 |
|
---|
[1005be4] | 40 | &lfs84_checked;
|
---|
[ee000c3d] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
[81060947] | 46 | Download (HTTP): <ulink url="&fuse3-download-http;"/>
|
---|
[ee000c3d] | 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
[81060947] | 51 | Download (FTP): <ulink url="&fuse3-download-ftp;"/>
|
---|
[ee000c3d] | 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
[81060947] | 56 | Download MD5 sum: &fuse3-md5sum;
|
---|
[ee000c3d] | 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
[81060947] | 61 | Download size: &fuse3-size;
|
---|
[ee000c3d] | 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
[81060947] | 66 | Estimated disk space required: &fuse3-buildsize;
|
---|
[ee000c3d] | 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
[81060947] | 71 | Estimated build time: &fuse3-time;
|
---|
[ee000c3d] | 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
[c35f51a] | 76 | <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
|
---|
| 77 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 78 | <para role="optional">
|
---|
[ff9b2cd] | 79 | <xref linkend="doxygen"/> (to rebuild the API documentation)
|
---|
[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 |
|
---|
[81060947] | 98 | <indexterm zone="fuse3 fuse-kernel">
|
---|
[2630345] | 99 | <primary sortas="d-fuse3">Fuse 3</primary>
|
---|
[ee000c3d] | 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 |
|
---|
[7f5826e7] | 111 | <screen><userinput>sed -i '/^udev/,$ s/^/#/' util/meson.build &&
|
---|
[d58c5b7] | 112 |
|
---|
[4da56e0] | 113 | mkdir build &&
|
---|
| 114 | cd build &&
|
---|
| 115 |
|
---|
| 116 | meson --prefix=/usr .. &&
|
---|
[d58c5b7] | 117 | ninja</userinput></screen>
|
---|
[ee000c3d] | 118 |
|
---|
[ff9b2cd] | 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>
|
---|
[5a464e4d] | 124 |
|
---|
[ee000c3d] | 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 |
|
---|
[d58c5b7] | 133 | <screen role="root"><userinput>ninja install &&
|
---|
| 134 |
|
---|
| 135 | mv -vf /usr/lib/libfuse3.so.3* /lib &&
|
---|
[7e6b462] | 136 | ln -sfvn ../../lib/libfuse3.so.&fuse3-version; /usr/lib/libfuse3.so &&
|
---|
[5a464e4d] | 137 |
|
---|
[2e0d6b9] | 138 | mv -vf /usr/bin/fusermount3 /bin &&
|
---|
| 139 | mv -vf /usr/sbin/mount.fuse3 /sbin &&
|
---|
| 140 | chmod u+s /bin/fusermount3 &&
|
---|
[ff9b2cd] | 141 |
|
---|
[d58c5b7] | 142 | install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &&
|
---|
| 143 | install -v -m644 ../doc/{README.NFS,kernel.txt} \
|
---|
| 144 | /usr/share/doc/fuse-&fuse3-version; &&
|
---|
[6121fe5] | 145 | cp -Rv ../doc/html /usr/share/doc/fuse-&fuse3-version;
|
---|
| 146 | <!-- gunzip /usr/share/man/{man1/fusermount3.1,man8/mount.fuse.8}.gz --></userinput></screen>
|
---|
[5a464e4d] | 147 |
|
---|
[ee000c3d] | 148 | </sect2>
|
---|
| 149 |
|
---|
| 150 | <sect2 role="commands">
|
---|
| 151 | <title>Command Explanations</title>
|
---|
| 152 |
|
---|
| 153 | <para>
|
---|
[d58c5b7] | 154 | <command>sed ... util/meson.build</command>: This command disables the
|
---|
| 155 | installation of a boot script and udev rule that are not needed.
|
---|
[ee000c3d] | 156 | </para>
|
---|
| 157 |
|
---|
[f69944f] | 158 | <para>
|
---|
[d58c5b7] | 159 | <command>mv ... libfuse3.so.3*; ln ... libfuse3.so</command>:
|
---|
| 160 | These commands install the libraries in the /lib directory.
|
---|
[f69944f] | 161 | </para>
|
---|
[e7b74b8] | 162 | <!--
|
---|
[ee000c3d] | 163 | <para>
|
---|
[d58c5b7] | 164 | <command>unzip ...</command>: This uncompresses the installed man pages
|
---|
| 165 | to be consistent with the rest of the man pages.
|
---|
[ee000c3d] | 166 | </para>
|
---|
[e7b74b8] | 167 | -->
|
---|
[ee000c3d] | 168 | </sect2>
|
---|
| 169 |
|
---|
[1647d338] | 170 | <sect2 role="configuration" id="fuse-configuration">
|
---|
[099a8d0] | 171 | <title>Configuring fuse</title>
|
---|
| 172 |
|
---|
| 173 | <sect3 id="fuse-config">
|
---|
| 174 | <title>Config Files</title>
|
---|
| 175 |
|
---|
[f69944f] | 176 | <para>
|
---|
| 177 | Some options regarding mount policy can be set in the file
|
---|
| 178 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
| 179 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 180 | user:
|
---|
| 181 | </para>
|
---|
[099a8d0] | 182 |
|
---|
| 183 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
| 184 | # Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
| 185 | # The default is 1000.
|
---|
| 186 | #
|
---|
| 187 | #mount_max = 1000
|
---|
| 188 |
|
---|
| 189 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
| 190 | # mount options.
|
---|
| 191 | #
|
---|
| 192 | #user_allow_other
|
---|
| 193 | EOF</userinput></screen>
|
---|
| 194 |
|
---|
[f69944f] | 195 | <para>
|
---|
| 196 | Additional information about the meaning of the configuration
|
---|
| 197 | options are found in the man page.
|
---|
| 198 | </para>
|
---|
[099a8d0] | 199 |
|
---|
| 200 | </sect3>
|
---|
| 201 |
|
---|
| 202 | </sect2>
|
---|
| 203 |
|
---|
[ee000c3d] | 204 | <sect2 role="content">
|
---|
| 205 | <title>Contents</title>
|
---|
| 206 |
|
---|
| 207 | <segmentedlist>
|
---|
| 208 | <segtitle>Installed Programs</segtitle>
|
---|
| 209 | <segtitle>Installed Libraries</segtitle>
|
---|
| 210 | <segtitle>Installed Directory</segtitle>
|
---|
| 211 |
|
---|
| 212 | <seglistitem>
|
---|
| 213 | <seg>
|
---|
[1647d338] | 214 | fusermount3, mount.fuse3
|
---|
[ee000c3d] | 215 | </seg>
|
---|
| 216 | <seg>
|
---|
[1647d338] | 217 | libfuse3.so
|
---|
[f69944f] | 218 | </seg>
|
---|
| 219 | <seg>
|
---|
[81060947] | 220 | /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
|
---|
[ee000c3d] | 221 | </seg>
|
---|
| 222 | </seglistitem>
|
---|
| 223 | </segmentedlist>
|
---|
| 224 |
|
---|
| 225 | <variablelist>
|
---|
| 226 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 227 | <?dbfo list-presentation="list"?>
|
---|
| 228 | <?dbhtml list-presentation="table"?>
|
---|
| 229 |
|
---|
[1647d338] | 230 | <varlistentry id="fusermount3">
|
---|
| 231 | <term><command>fusermount3</command></term>
|
---|
[ee000c3d] | 232 | <listitem>
|
---|
| 233 | <para>
|
---|
[d58c5b7] | 234 | is a suid root program to mount and unmount Fuse filesystems.
|
---|
[ee000c3d] | 235 | </para>
|
---|
[81060947] | 236 | <indexterm zone="fuse3 fusermount3">
|
---|
[1647d338] | 237 | <primary sortas="b-fusermount3">fusermount3</primary>
|
---|
[ee000c3d] | 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
[1647d338] | 242 | <varlistentry id="mount.fuse3">
|
---|
| 243 | <term><command>mount.fuse3</command></term>
|
---|
[ee000c3d] | 244 | <listitem>
|
---|
| 245 | <para>
|
---|
[d58c5b7] | 246 | is the command <command>mount</command> calls to mount a Fuse
|
---|
[ee000c3d] | 247 | filesystem.
|
---|
| 248 | </para>
|
---|
[81060947] | 249 | <indexterm zone="fuse3 mount.fuse3">
|
---|
[1647d338] | 250 | <primary sortas="b-mount.fuse3">mount.fuse3</primary>
|
---|
[ee000c3d] | 251 | </indexterm>
|
---|
| 252 | </listitem>
|
---|
| 253 | </varlistentry>
|
---|
| 254 |
|
---|
[1647d338] | 255 | <varlistentry id="libfuse3">
|
---|
| 256 | <term><filename class="libraryfile">libfuse3.so</filename></term>
|
---|
[ee000c3d] | 257 | <listitem>
|
---|
| 258 | <para>
|
---|
[f69944f] | 259 | contains the <application>FUSE</application> API functions.
|
---|
[ee000c3d] | 260 | </para>
|
---|
[81060947] | 261 | <indexterm zone="fuse3 libfuse3">
|
---|
[1647d338] | 262 | <primary sortas="c-libfuse3">libfuse3.so</primary>
|
---|
[ee000c3d] | 263 | </indexterm>
|
---|
| 264 | </listitem>
|
---|
| 265 | </varlistentry>
|
---|
| 266 |
|
---|
| 267 | </variablelist>
|
---|
[f69944f] | 268 |
|
---|
[ee000c3d] | 269 | </sect2>
|
---|
[f69944f] | 270 |
|
---|
[ee000c3d] | 271 | </sect1>
|
---|