[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 |
|
---|
[ff9b2cd] | 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 " ">
|
---|
[26bb7e15] | 9 | <!ENTITY fuse3-md5sum "20b10f24b825062c1db9a21a35157f97">
|
---|
| 10 | <!ENTITY fuse3-size "804 KB">
|
---|
[a770b0e] | 11 | <!ENTITY fuse3-buildsize "8.5 MB">
|
---|
[ff9b2cd] | 12 | <!ENTITY fuse3-time "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">
|
---|
[f69944f] | 26 | <primary sortas="a-Fuse">Fuse</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 |
|
---|
[63a26beb] | 40 | &lfs80_checked;
|
---|
[8c08e6a] | 41 | &gcc7_checked;
|
---|
[ee000c3d] | 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
[81060947] | 47 | Download (HTTP): <ulink url="&fuse3-download-http;"/>
|
---|
[ee000c3d] | 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
[81060947] | 52 | Download (FTP): <ulink url="&fuse3-download-ftp;"/>
|
---|
[ee000c3d] | 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
[81060947] | 57 | Download MD5 sum: &fuse3-md5sum;
|
---|
[ee000c3d] | 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
[81060947] | 62 | Download size: &fuse3-size;
|
---|
[ee000c3d] | 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
[81060947] | 67 | Estimated disk space required: &fuse3-buildsize;
|
---|
[ee000c3d] | 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>
|
---|
[81060947] | 72 | Estimated build time: &fuse3-time;
|
---|
[ee000c3d] | 73 | </para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
[c35f51a] | 77 | <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
|
---|
| 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 79 | <para role="optional">
|
---|
[ff9b2cd] | 80 | <xref linkend="doxygen"/> (to rebuild the API documentation)
|
---|
[c35f51a] | 81 | </para>
|
---|
[ff9b2cd] | 82 |
|
---|
[ee000c3d] | 83 | <para condition="html" role="usernotes">
|
---|
| 84 | User Notes: <ulink url="&blfs-wiki;/fuse"/>
|
---|
| 85 | </para>
|
---|
| 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2 role="kernel" id="fuse-kernel">
|
---|
| 89 | <title>Kernel Configuration</title>
|
---|
| 90 |
|
---|
| 91 | <para>
|
---|
| 92 | Enable the following options in the kernel configuration and recompile the
|
---|
| 93 | kernel if necessary:
|
---|
| 94 | </para>
|
---|
| 95 |
|
---|
| 96 | <screen><literal>File systems --->
|
---|
[421128a1] | 97 | <*/M> FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
|
---|
[ee000c3d] | 98 |
|
---|
[81060947] | 99 | <indexterm zone="fuse3 fuse-kernel">
|
---|
| 100 | <primary sortas="d-fuse3">fuse</primary>
|
---|
[ee000c3d] | 101 | </indexterm>
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of Fuse</title>
|
---|
| 106 |
|
---|
| 107 | <para>
|
---|
| 108 | Install <application>Fuse</application> by running the following
|
---|
| 109 | commands:
|
---|
| 110 | </para>
|
---|
| 111 |
|
---|
[26bb7e15] | 112 | <screen><userinput>./configure --prefix=/usr \
|
---|
[dc56bc8] | 113 | --disable-static \
|
---|
[f71807c2] | 114 | --exec-prefix=/ \
|
---|
[ff9b2cd] | 115 | --with-pkgconfigdir=/usr/lib/pkgconfig \
|
---|
[dc56bc8] | 116 | INIT_D_PATH=/tmp/init.d &&
|
---|
[ee000c3d] | 117 | make</userinput></screen>
|
---|
| 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 |
|
---|
[ff9b2cd] | 133 | <screen role="root"><userinput>make install &&
|
---|
| 134 | rm -v /lib/libfuse3.{so,la} &&
|
---|
| 135 | ln -sfv ../../lib/libfuse3.so.3 /usr/lib/libfuse3.so &&
|
---|
[5a464e4d] | 136 |
|
---|
| 137 | rm -rf /tmp/init.d &&
|
---|
[ff9b2cd] | 138 |
|
---|
[81060947] | 139 | install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &&
|
---|
[1647d338] | 140 | install -v -m644 doc/{README.NFS,kernel.txt} \
|
---|
[81060947] | 141 | /usr/share/doc/fuse-&fuse3-version; &&
|
---|
| 142 | cp -Rv doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
|
---|
[5a464e4d] | 143 |
|
---|
[ee000c3d] | 144 | </sect2>
|
---|
| 145 |
|
---|
| 146 | <sect2 role="commands">
|
---|
| 147 | <title>Command Explanations</title>
|
---|
| 148 |
|
---|
[f69944f] | 149 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 150 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 151 |
|
---|
[ee000c3d] | 152 | <para>
|
---|
[f71807c2] | 153 | <parameter>--exec-prefix=/</parameter>: This parameter moves programs and
|
---|
| 154 | libraries that could be needed before the
|
---|
| 155 | <filename class="directory">/usr</filename> directory is mounted, to the
|
---|
| 156 | root filesystem.
|
---|
[ee000c3d] | 157 | </para>
|
---|
| 158 |
|
---|
[f69944f] | 159 | <para>
|
---|
[f71807c2] | 160 | <parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter installs
|
---|
| 161 | the bootscript into <filename class="directory">/tmp/init.d</filename> as
|
---|
| 162 | a bootscript is not required.
|
---|
[f69944f] | 163 | </para>
|
---|
| 164 |
|
---|
[ee000c3d] | 165 | <para>
|
---|
| 166 | <command>rm -rf /tmp/init.d</command>: This removes the unneeded
|
---|
| 167 | bootscript.
|
---|
| 168 | </para>
|
---|
[f69944f] | 169 |
|
---|
[ee000c3d] | 170 | </sect2>
|
---|
| 171 |
|
---|
[1647d338] | 172 | <sect2 role="configuration" id="fuse-configuration">
|
---|
[099a8d0] | 173 | <title>Configuring fuse</title>
|
---|
| 174 |
|
---|
| 175 | <sect3 id="fuse-config">
|
---|
| 176 | <title>Config Files</title>
|
---|
| 177 |
|
---|
[f69944f] | 178 | <para>
|
---|
| 179 | Some options regarding mount policy can be set in the file
|
---|
| 180 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
| 181 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 182 | user:
|
---|
| 183 | </para>
|
---|
[099a8d0] | 184 |
|
---|
| 185 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
| 186 | # Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
| 187 | # The default is 1000.
|
---|
| 188 | #
|
---|
| 189 | #mount_max = 1000
|
---|
| 190 |
|
---|
| 191 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
| 192 | # mount options.
|
---|
| 193 | #
|
---|
| 194 | #user_allow_other
|
---|
| 195 | EOF</userinput></screen>
|
---|
| 196 |
|
---|
[f69944f] | 197 | <para>
|
---|
| 198 | Additional information about the meaning of the configuration
|
---|
| 199 | options are found in the man page.
|
---|
| 200 | </para>
|
---|
[099a8d0] | 201 |
|
---|
| 202 | </sect3>
|
---|
| 203 |
|
---|
| 204 | </sect2>
|
---|
| 205 |
|
---|
[ee000c3d] | 206 | <sect2 role="content">
|
---|
| 207 | <title>Contents</title>
|
---|
| 208 |
|
---|
| 209 | <segmentedlist>
|
---|
| 210 | <segtitle>Installed Programs</segtitle>
|
---|
| 211 | <segtitle>Installed Libraries</segtitle>
|
---|
| 212 | <segtitle>Installed Directory</segtitle>
|
---|
| 213 |
|
---|
| 214 | <seglistitem>
|
---|
| 215 | <seg>
|
---|
[1647d338] | 216 | fusermount3, mount.fuse3
|
---|
[ee000c3d] | 217 | </seg>
|
---|
| 218 | <seg>
|
---|
[1647d338] | 219 | libfuse3.so
|
---|
[f69944f] | 220 | </seg>
|
---|
| 221 | <seg>
|
---|
[81060947] | 222 | /usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
|
---|
[ee000c3d] | 223 | </seg>
|
---|
| 224 | </seglistitem>
|
---|
| 225 | </segmentedlist>
|
---|
| 226 |
|
---|
| 227 | <variablelist>
|
---|
| 228 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 229 | <?dbfo list-presentation="list"?>
|
---|
| 230 | <?dbhtml list-presentation="table"?>
|
---|
| 231 |
|
---|
[1647d338] | 232 | <varlistentry id="fusermount3">
|
---|
| 233 | <term><command>fusermount3</command></term>
|
---|
[ee000c3d] | 234 | <listitem>
|
---|
| 235 | <para>
|
---|
| 236 | is a set users ID root program to mount and unmount Fuse
|
---|
| 237 | filesystems.
|
---|
| 238 | </para>
|
---|
[81060947] | 239 | <indexterm zone="fuse3 fusermount3">
|
---|
[1647d338] | 240 | <primary sortas="b-fusermount3">fusermount3</primary>
|
---|
[ee000c3d] | 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
[1647d338] | 245 | <varlistentry id="mount.fuse3">
|
---|
| 246 | <term><command>mount.fuse3</command></term>
|
---|
[ee000c3d] | 247 | <listitem>
|
---|
| 248 | <para>
|
---|
| 249 | is the command <command>mount</command> would call to mount a Fuse
|
---|
| 250 | filesystem.
|
---|
| 251 | </para>
|
---|
[81060947] | 252 | <indexterm zone="fuse3 mount.fuse3">
|
---|
[1647d338] | 253 | <primary sortas="b-mount.fuse3">mount.fuse3</primary>
|
---|
[ee000c3d] | 254 | </indexterm>
|
---|
| 255 | </listitem>
|
---|
| 256 | </varlistentry>
|
---|
| 257 |
|
---|
[1647d338] | 258 | <varlistentry id="libfuse3">
|
---|
| 259 | <term><filename class="libraryfile">libfuse3.so</filename></term>
|
---|
[ee000c3d] | 260 | <listitem>
|
---|
| 261 | <para>
|
---|
[f69944f] | 262 | contains the <application>FUSE</application> API functions.
|
---|
[ee000c3d] | 263 | </para>
|
---|
[81060947] | 264 | <indexterm zone="fuse3 libfuse3">
|
---|
[1647d338] | 265 | <primary sortas="c-libfuse3">libfuse3.so</primary>
|
---|
[ee000c3d] | 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
| 270 | </variablelist>
|
---|
[f69944f] | 271 |
|
---|
[ee000c3d] | 272 | </sect2>
|
---|
[f69944f] | 273 |
|
---|
[ee000c3d] | 274 | </sect1>
|
---|