[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 |
|
---|
[f69944f] | 7 | <!ENTITY fuse-download-http "&sourceforge-repo;/fuse/fuse-&fuse-version;.tar.gz">
|
---|
[ee000c3d] | 8 | <!ENTITY fuse-download-ftp " ">
|
---|
[3caf72a] | 9 | <!ENTITY fuse-md5sum "7d80d0dc9cc2b9199a0c53787c151205">
|
---|
[ee000c3d] | 10 | <!ENTITY fuse-size "548 KB">
|
---|
[3caf72a] | 11 | <!ENTITY fuse-buildsize "7.0 MB">
|
---|
[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 |
|
---|
[e317beb] | 40 | &lfs72_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 |
|
---|
| 76 | <para condition="html" role="usernotes">
|
---|
| 77 | User Notes: <ulink url="&blfs-wiki;/fuse"/>
|
---|
| 78 | </para>
|
---|
| 79 | </sect2>
|
---|
| 80 |
|
---|
| 81 | <sect2 role="kernel" id="fuse-kernel">
|
---|
| 82 | <title>Kernel Configuration</title>
|
---|
| 83 |
|
---|
| 84 | <para>
|
---|
| 85 | Enable the following options in the kernel configuration and recompile the
|
---|
| 86 | kernel if necessary:
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <screen><literal>File systems --->
|
---|
| 90 | [*] FUSE (Filesystem in Userspace) support</literal></screen>
|
---|
| 91 |
|
---|
| 92 | <indexterm zone="fuse fuse-kernel">
|
---|
| 93 | <primary sortas="d-fuse">fuse</primary>
|
---|
| 94 | </indexterm>
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of Fuse</title>
|
---|
| 99 |
|
---|
[5a464e4d] | 100 | <note>
|
---|
| 101 | <para>
|
---|
| 102 | After the <command>configure</command> script has finished you will
|
---|
| 103 | see a warning shown below. You can safely disregard this warning.
|
---|
| 104 | </para>
|
---|
| 105 |
|
---|
| 106 | <screen><computeroutput>configure: WARNING:
|
---|
| 107 | ******************************************************************
|
---|
| 108 | * Please install util-linux version 2.18 or later which supports *
|
---|
| 109 | * --fake and --no-canonicalize options in mount and umount *
|
---|
| 110 | ******************************************************************</computeroutput></screen>
|
---|
| 111 | </note>
|
---|
| 112 |
|
---|
[ee000c3d] | 113 | <para>
|
---|
| 114 | Install <application>Fuse</application> by running the following
|
---|
| 115 | commands:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
[f69944f] | 118 | <screen><userinput>./configure --prefix=/usr --disable-static INIT_D_PATH=/tmp/init.d &&
|
---|
[ee000c3d] | 119 | make</userinput></screen>
|
---|
| 120 |
|
---|
[5a464e4d] | 121 | <para>
|
---|
| 122 | If you have <xref linkend="doxygen"/> installed and wish to build the API
|
---|
| 123 | documentation, issue <command>doxygen doc/Doxyfile</command>.
|
---|
| 124 | </para>
|
---|
| 125 |
|
---|
[ee000c3d] | 126 | <para>
|
---|
| 127 | This package does not come with a test suite.
|
---|
| 128 | </para>
|
---|
| 129 |
|
---|
| 130 | <para>
|
---|
| 131 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 132 | </para>
|
---|
| 133 |
|
---|
| 134 | <screen role="root"><userinput>make install &&
|
---|
[5a464e4d] | 135 |
|
---|
| 136 | mv -v /usr/lib/libfuse.so.* /lib &&
|
---|
[f69944f] | 137 | ln -sfv ../../lib/libfuse.so.&fuse-version; /usr/lib/libfuse.so &&
|
---|
[5a464e4d] | 138 | rm -rf /tmp/init.d &&
|
---|
| 139 |
|
---|
| 140 | install -v -m755 -d /usr/share/doc/fuse-&fuse-version; &&
|
---|
| 141 | install -v -m644 doc/{how-fuse-works,kernel.txt} \
|
---|
| 142 | /usr/share/doc/fuse-&fuse-version;</userinput></screen>
|
---|
| 143 |
|
---|
| 144 | <para>
|
---|
| 145 | If you built the API documentation, install it as the
|
---|
| 146 | <systemitem class="username">root</systemitem> user by issuing the
|
---|
| 147 | following commands:
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
| 150 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/fuse-&fuse-version;/api &&
|
---|
| 151 | install -v -m644 doc/html/* \
|
---|
| 152 | /usr/share/doc/fuse-&fuse-version;/api</userinput></screen>
|
---|
[ee000c3d] | 153 | </sect2>
|
---|
| 154 |
|
---|
| 155 | <sect2 role="commands">
|
---|
| 156 | <title>Command Explanations</title>
|
---|
| 157 |
|
---|
[f69944f] | 158 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 159 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 160 |
|
---|
[ee000c3d] | 161 | <para>
|
---|
[5a464e4d] | 162 | <parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter installs
|
---|
| 163 | the bootscript into <filename class="directory">/tmp/init.d</filename> as
|
---|
| 164 | a bootscript is not required.
|
---|
[ee000c3d] | 165 | </para>
|
---|
| 166 |
|
---|
[f69944f] | 167 | <para>
|
---|
[5a464e4d] | 168 | <command>mv -v /usr/lib/libfuse.so.* /lib</command>: This moves the
|
---|
[0d7900a] | 169 | <application>FUSE</application> library to the root filesystem
|
---|
[5a464e4d] | 170 | so that it is available early in the boot process in case
|
---|
| 171 | <filename class="directory">/usr</filename> is mounted on a separate
|
---|
| 172 | partition and <xref linkend="ntfs-3g"/> is built with a system-installed
|
---|
| 173 | version of <application>FUSE</application>.
|
---|
[f69944f] | 174 | </para>
|
---|
| 175 |
|
---|
[ee000c3d] | 176 | <para>
|
---|
| 177 | <command>rm -rf /tmp/init.d</command>: This removes the unneeded
|
---|
| 178 | bootscript.
|
---|
| 179 | </para>
|
---|
[f69944f] | 180 |
|
---|
[ee000c3d] | 181 | </sect2>
|
---|
| 182 |
|
---|
[099a8d0] | 183 | <sect2 role="configuration">
|
---|
| 184 | <title>Configuring fuse</title>
|
---|
| 185 |
|
---|
| 186 | <sect3 id="fuse-config">
|
---|
| 187 | <title>Config Files</title>
|
---|
| 188 |
|
---|
[f69944f] | 189 | <para>
|
---|
| 190 | Some options regarding mount policy can be set in the file
|
---|
| 191 | <filename>/etc/fuse.conf</filename>. To install the file run the
|
---|
| 192 | following command as the <systemitem class="username">root</systemitem>
|
---|
| 193 | user:
|
---|
| 194 | </para>
|
---|
[099a8d0] | 195 |
|
---|
| 196 | <screen role="root"><userinput>cat > /etc/fuse.conf << "EOF"
|
---|
| 197 | # Set the maximum number of FUSE mounts allowed to non-root users.
|
---|
| 198 | # The default is 1000.
|
---|
| 199 | #
|
---|
| 200 | #mount_max = 1000
|
---|
| 201 |
|
---|
| 202 | # Allow non-root users to specify the 'allow_other' or 'allow_root'
|
---|
| 203 | # mount options.
|
---|
| 204 | #
|
---|
| 205 | #user_allow_other
|
---|
| 206 | EOF</userinput></screen>
|
---|
| 207 |
|
---|
[f69944f] | 208 | <para>
|
---|
| 209 | Additional information about the meaning of the configuration
|
---|
| 210 | options are found in the man page.
|
---|
| 211 | </para>
|
---|
[099a8d0] | 212 |
|
---|
| 213 | </sect3>
|
---|
| 214 |
|
---|
| 215 | </sect2>
|
---|
| 216 |
|
---|
[ee000c3d] | 217 | <sect2 role="content">
|
---|
| 218 | <title>Contents</title>
|
---|
| 219 |
|
---|
| 220 | <segmentedlist>
|
---|
| 221 | <segtitle>Installed Programs</segtitle>
|
---|
| 222 | <segtitle>Installed Libraries</segtitle>
|
---|
| 223 | <segtitle>Installed Directory</segtitle>
|
---|
| 224 |
|
---|
| 225 | <seglistitem>
|
---|
| 226 | <seg>
|
---|
[3caf72a] | 227 | fusermount, mount.fuse and ulockmgr_server
|
---|
[ee000c3d] | 228 | </seg>
|
---|
| 229 | <seg>
|
---|
[3caf72a] | 230 | libfuse.so and libulockmgr.so
|
---|
[f69944f] | 231 | </seg>
|
---|
| 232 | <seg>
|
---|
| 233 | /usr/include/fuse
|
---|
[ee000c3d] | 234 | </seg>
|
---|
| 235 | </seglistitem>
|
---|
| 236 | </segmentedlist>
|
---|
| 237 |
|
---|
| 238 | <variablelist>
|
---|
| 239 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 240 | <?dbfo list-presentation="list"?>
|
---|
| 241 | <?dbhtml list-presentation="table"?>
|
---|
| 242 |
|
---|
| 243 | <varlistentry id="fusermount">
|
---|
| 244 | <term><command>fusermount</command></term>
|
---|
| 245 | <listitem>
|
---|
| 246 | <para>
|
---|
| 247 | is a set users ID root program to mount and unmount Fuse
|
---|
| 248 | filesystems.
|
---|
| 249 | </para>
|
---|
| 250 | <indexterm zone="fuse fusermount">
|
---|
| 251 | <primary sortas="b-fusermount">fusermount</primary>
|
---|
| 252 | </indexterm>
|
---|
| 253 | </listitem>
|
---|
| 254 | </varlistentry>
|
---|
| 255 |
|
---|
| 256 | <varlistentry id="mount.fuse">
|
---|
| 257 | <term><command>mount.fuse</command></term>
|
---|
| 258 | <listitem>
|
---|
| 259 | <para>
|
---|
| 260 | is the command <command>mount</command> would call to mount a Fuse
|
---|
| 261 | filesystem.
|
---|
| 262 | </para>
|
---|
| 263 | <indexterm zone="fuse mount.fuse">
|
---|
| 264 | <primary sortas="b-mount.fuse">mount.fuse</primary>
|
---|
| 265 | </indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
| 269 | <varlistentry id="ulockmgr_server">
|
---|
| 270 | <term><command>ulockmgr_server</command></term>
|
---|
| 271 | <listitem>
|
---|
| 272 | <para>
|
---|
| 273 | is the Userspace Lock Manager Server for Fuse filesystems.
|
---|
| 274 | </para>
|
---|
| 275 | <indexterm zone="fuse ulockmgr_server">
|
---|
| 276 | <primary sortas="b-ulockmgr_server">ulockmgr_server</primary>
|
---|
| 277 | </indexterm>
|
---|
| 278 | </listitem>
|
---|
| 279 | </varlistentry>
|
---|
| 280 |
|
---|
| 281 | <varlistentry id="libfuse">
|
---|
| 282 | <term><filename class="libraryfile">libfuse.so</filename></term>
|
---|
| 283 | <listitem>
|
---|
| 284 | <para>
|
---|
[f69944f] | 285 | contains the <application>FUSE</application> API functions.
|
---|
[ee000c3d] | 286 | </para>
|
---|
| 287 | <indexterm zone="fuse libfuse">
|
---|
| 288 | <primary sortas="c-libfuse">libfuse.so</primary>
|
---|
| 289 | </indexterm>
|
---|
| 290 | </listitem>
|
---|
| 291 | </varlistentry>
|
---|
| 292 |
|
---|
| 293 | <varlistentry id="libulockmgr">
|
---|
| 294 | <term><filename class="libraryfile">libulockmgr.so</filename></term>
|
---|
| 295 | <listitem>
|
---|
| 296 | <para>
|
---|
| 297 | contains the Userspace Lock Manager API functions.
|
---|
| 298 | </para>
|
---|
| 299 | <indexterm zone="fuse libulockmgr">
|
---|
| 300 | <primary sortas="c-libulockmgr">libulockmgr.so</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 | </variablelist>
|
---|
[f69944f] | 305 |
|
---|
[ee000c3d] | 306 | </sect2>
|
---|
[f69944f] | 307 |
|
---|
[ee000c3d] | 308 | </sect1>
|
---|