[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 |
|
---|
[71aa48f] | 7 | <!ENTITY fuse-download-http "https://github.com/libfuse/libfuse/releases/download/fuse-&fuse-version;/fuse-&fuse-version;.tar.gz">
|
---|
[ee000c3d] | 8 | <!ENTITY fuse-download-ftp " ">
|
---|
[6fbcfdf] | 9 | <!ENTITY fuse-md5sum "9bd4ce8184745fd3d000ca2692adacdb">
|
---|
| 10 | <!ENTITY fuse-size "646 KB">
|
---|
[dc56bc8] | 11 | <!ENTITY fuse-buildsize "8.2 MB (9.8 MB with API documentation)">
|
---|
[ee000c3d] | 12 | <!ENTITY fuse-time "0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[f69944f] | 15 | <sect1 id="fuse" xreflabel="Fuse-&fuse-version;">
|
---|
[ee000c3d] | 16 | <?dbhtml filename="fuse.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[f69944f] | 23 | <title>Fuse-&fuse-version;</title>
|
---|
[ee000c3d] | 24 |
|
---|
| 25 | <indexterm zone="fuse">
|
---|
[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 |
|
---|
[77d57d12] | 40 | &lfs7a_checked;
|
---|
[ee000c3d] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&fuse-download-http;"/>
|
---|
| 47 | </para>
|
---|
| 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
| 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&fuse-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>
|
---|
| 56 | Download MD5 sum: &fuse-md5sum;
|
---|
| 57 | </para>
|
---|
| 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
| 60 | <para>
|
---|
| 61 | Download size: &fuse-size;
|
---|
| 62 | </para>
|
---|
| 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
| 65 | <para>
|
---|
| 66 | Estimated disk space required: &fuse-buildsize;
|
---|
| 67 | </para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>
|
---|
| 71 | Estimated build time: &fuse-time;
|
---|
| 72 | </para>
|
---|
| 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
[c35f51a] | 76 | <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
|
---|
| 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 79 | <para role="optional">
|
---|
| 80 | <xref linkend="doxygen"/> (to build the API documentation)
|
---|
| 81 | </para>
|
---|
| 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 |
|
---|
| 99 | <indexterm zone="fuse fuse-kernel">
|
---|
| 100 | <primary sortas="d-fuse">fuse</primary>
|
---|
| 101 | </indexterm>
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of Fuse</title>
|
---|
| 106 |
|
---|
[5a464e4d] | 107 | <note>
|
---|
| 108 | <para>
|
---|
| 109 | After the <command>configure</command> script has finished you will
|
---|
| 110 | see a warning shown below. You can safely disregard this warning.
|
---|
| 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <screen><computeroutput>configure: WARNING:
|
---|
| 114 | ******************************************************************
|
---|
| 115 | * Please install util-linux version 2.18 or later which supports *
|
---|
| 116 | * --fake and --no-canonicalize options in mount and umount *
|
---|
| 117 | ******************************************************************</computeroutput></screen>
|
---|
| 118 | </note>
|
---|
| 119 |
|
---|
[ee000c3d] | 120 | <para>
|
---|
| 121 | Install <application>Fuse</application> by running the following
|
---|
| 122 | commands:
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
[71aa48f] | 125 | <screen><userinput>./configure --prefix=/usr \
|
---|
[dc56bc8] | 126 | --disable-static \
|
---|
| 127 | INIT_D_PATH=/tmp/init.d &&
|
---|
| 128 |
|
---|
[ee000c3d] | 129 | make</userinput></screen>
|
---|
| 130 |
|
---|
[5a464e4d] | 131 | <para>
|
---|
| 132 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
| 133 | documentation, issue <command>doxygen doc/Doxyfile</command>.
|
---|
| 134 | </para>
|
---|
| 135 |
|
---|
[ee000c3d] | 136 | <para>
|
---|
| 137 | This package does not come with a test suite.
|
---|
| 138 | </para>
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 142 | </para>
|
---|
| 143 |
|
---|
| 144 | <screen role="root"><userinput>make install &&
|
---|
[5a464e4d] | 145 |
|
---|
| 146 | mv -v /usr/lib/libfuse.so.* /lib &&
|
---|
[f69944f] | 147 | ln -sfv ../../lib/libfuse.so.&fuse-version; /usr/lib/libfuse.so &&
|
---|
[5a464e4d] | 148 | rm -rf /tmp/init.d &&
|
---|
| 149 |
|
---|
| 150 | install -v -m755 -d /usr/share/doc/fuse-&fuse-version; &&
|
---|
| 151 | install -v -m644 doc/{how-fuse-works,kernel.txt} \
|
---|
| 152 | /usr/share/doc/fuse-&fuse-version;</userinput></screen>
|
---|
| 153 |
|
---|
| 154 | <para>
|
---|
| 155 | If you built the API documentation, install it as the
|
---|
| 156 | <systemitem class="username">root</systemitem> user by issuing the
|
---|
| 157 | following commands:
|
---|
| 158 | </para>
|
---|
| 159 |
|
---|
| 160 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/fuse-&fuse-version;/api &&
|
---|
| 161 | install -v -m644 doc/html/* \
|
---|
| 162 | /usr/share/doc/fuse-&fuse-version;/api</userinput></screen>
|
---|
[ee000c3d] | 163 | </sect2>
|
---|
| 164 |
|
---|
| 165 | <sect2 role="commands">
|
---|
| 166 | <title>Command Explanations</title>
|
---|
| 167 |
|
---|
[f69944f] | 168 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 169 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 170 |
|
---|
[ee000c3d] | 171 | <para>
|
---|
[5a464e4d] | 172 | <parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter installs
|
---|
| 173 | the bootscript into <filename class="directory">/tmp/init.d</filename> as
|
---|
| 174 | a bootscript is not required.
|
---|
[ee000c3d] | 175 | </para>
|
---|
| 176 |
|
---|
[f69944f] | 177 | <para>
|
---|
[5a464e4d] | 178 | <command>mv -v /usr/lib/libfuse.so.* /lib</command>: This moves the
|
---|
[0d7900a] | 179 | <application>FUSE</application> library to the root filesystem
|
---|
[5a464e4d] | 180 | so that it is available early in the boot process in case
|
---|
| 181 | <filename class="directory">/usr</filename> is mounted on a separate
|
---|
| 182 | partition and <xref linkend="ntfs-3g"/> is built with a system-installed
|
---|
| 183 | version of <application>FUSE</application>.
|
---|
[f69944f] | 184 | </para>
|
---|
| 185 |
|
---|
[ee000c3d] | 186 | <para>
|
---|
| 187 | <command>rm -rf /tmp/init.d</command>: This removes the unneeded
|
---|
| 188 | bootscript.
|
---|
| 189 | </para>
|
---|
[f69944f] | 190 |
|
---|
[ee000c3d] | 191 | </sect2>
|
---|
| 192 |
|
---|
[099a8d0] | 193 | <sect2 role="configuration">
|
---|
| 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"
|
---|
| 207 | # Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
| 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 | #
|
---|
| 215 | #user_allow_other
|
---|
| 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>
|
---|
[eac6532f] | 237 | fusermount, mount.fuse, and ulockmgr_server
|
---|
[ee000c3d] | 238 | </seg>
|
---|
| 239 | <seg>
|
---|
[3caf72a] | 240 | libfuse.so and libulockmgr.so
|
---|
[f69944f] | 241 | </seg>
|
---|
| 242 | <seg>
|
---|
[f0e219c] | 243 | /usr/include/fuse and /usr/share/doc/fuse-&fuse-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 |
|
---|
| 253 | <varlistentry id="fusermount">
|
---|
| 254 | <term><command>fusermount</command></term>
|
---|
| 255 | <listitem>
|
---|
| 256 | <para>
|
---|
| 257 | is a set users ID root program to mount and unmount Fuse
|
---|
| 258 | filesystems.
|
---|
| 259 | </para>
|
---|
| 260 | <indexterm zone="fuse fusermount">
|
---|
| 261 | <primary sortas="b-fusermount">fusermount</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
| 266 | <varlistentry id="mount.fuse">
|
---|
| 267 | <term><command>mount.fuse</command></term>
|
---|
| 268 | <listitem>
|
---|
| 269 | <para>
|
---|
| 270 | is the command <command>mount</command> would call to mount a Fuse
|
---|
| 271 | filesystem.
|
---|
| 272 | </para>
|
---|
| 273 | <indexterm zone="fuse mount.fuse">
|
---|
| 274 | <primary sortas="b-mount.fuse">mount.fuse</primary>
|
---|
| 275 | </indexterm>
|
---|
| 276 | </listitem>
|
---|
| 277 | </varlistentry>
|
---|
| 278 |
|
---|
| 279 | <varlistentry id="ulockmgr_server">
|
---|
| 280 | <term><command>ulockmgr_server</command></term>
|
---|
| 281 | <listitem>
|
---|
| 282 | <para>
|
---|
| 283 | is the Userspace Lock Manager Server for Fuse filesystems.
|
---|
| 284 | </para>
|
---|
| 285 | <indexterm zone="fuse ulockmgr_server">
|
---|
| 286 | <primary sortas="b-ulockmgr_server">ulockmgr_server</primary>
|
---|
| 287 | </indexterm>
|
---|
| 288 | </listitem>
|
---|
| 289 | </varlistentry>
|
---|
| 290 |
|
---|
| 291 | <varlistentry id="libfuse">
|
---|
| 292 | <term><filename class="libraryfile">libfuse.so</filename></term>
|
---|
| 293 | <listitem>
|
---|
| 294 | <para>
|
---|
[f69944f] | 295 | contains the <application>FUSE</application> API functions.
|
---|
[ee000c3d] | 296 | </para>
|
---|
| 297 | <indexterm zone="fuse libfuse">
|
---|
| 298 | <primary sortas="c-libfuse">libfuse.so</primary>
|
---|
| 299 | </indexterm>
|
---|
| 300 | </listitem>
|
---|
| 301 | </varlistentry>
|
---|
| 302 |
|
---|
| 303 | <varlistentry id="libulockmgr">
|
---|
| 304 | <term><filename class="libraryfile">libulockmgr.so</filename></term>
|
---|
| 305 | <listitem>
|
---|
| 306 | <para>
|
---|
| 307 | contains the Userspace Lock Manager API functions.
|
---|
| 308 | </para>
|
---|
| 309 | <indexterm zone="fuse libulockmgr">
|
---|
| 310 | <primary sortas="c-libulockmgr">libulockmgr.so</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 | </variablelist>
|
---|
[f69944f] | 315 |
|
---|
[ee000c3d] | 316 | </sect2>
|
---|
[f69944f] | 317 |
|
---|
[ee000c3d] | 318 | </sect1>
|
---|