source: postlfs/filesystems/fuse.xml@ ee000c3d

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY fuse-download-http
    "&sourceforge-repo;/fuse/fuse-&fuse-version;.tar.gz">
  <!ENTITY fuse-download-ftp  " ">
  <!ENTITY fuse-md5sum        "894ee11674f89a915ae87524aed55bc4">
  <!ENTITY fuse-size          "548 KB">
  <!ENTITY fuse-buildsize     "8.2 MB">
  <!ENTITY fuse-time          "0.1 SBU">
]>

<sect1 id="fuse" xreflabel="fuse-&fuse-version;">
  <?dbhtml filename="fuse.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>fuse-&fuse-version;</title>

  <indexterm zone="fuse">
    <primary sortas="a-fuse">fuse</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Fuse</title>

    <para>
      <application>FUSE</application> (Filesystem in Userspace) is a simple
      interface for userspace programs to export a virtual filesystem to the
      Linux kernel. <application>Fuse</application> also aims to provide a
      secure method for non privileged users to create and mount their own
      filesystem implementations.
    </para>

    &lfs71_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&fuse-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&fuse-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &fuse-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &fuse-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &fuse-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &fuse-time;
        </para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/fuse"/>
    </para>
  </sect2>

  <sect2 role="kernel" id="fuse-kernel">
    <title>Kernel Configuration</title>

    <para>
      Enable the following options in the kernel configuration and recompile the
      kernel if necessary:
    </para>

<screen><literal>File systems  ---&gt;
  [*] FUSE (Filesystem in Userspace) support</literal></screen>

    <indexterm zone="fuse fuse-kernel">
      <primary sortas="d-fuse">fuse</primary>
    </indexterm>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Fuse</title>

    <para>
      Install <application>Fuse</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr INIT_D_PATH=/tmp/init.d &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install &amp;&amp;
rm -rf /tmp/init.d</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter makes it
      install its bootscript into /tmp/init.d.
    </para>

    <para>
      <command>rm -rf /tmp/init.d</command>: This removes the unneeded
      bootscript.
    </para>
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          fusermount,
          mount.fuse and
          ulockmgr_server.
        </seg>
        <seg>
          libfuse.so and
          libulockmgr.so.
        </seg>
        <seg>/usr/include/fuse.</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="fusermount">
        <term><command>fusermount</command></term>
        <listitem>
          <para>
            is a set users ID root program to mount and unmount Fuse
            filesystems.
          </para>
          <indexterm zone="fuse fusermount">
            <primary sortas="b-fusermount">fusermount</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mount.fuse">
        <term><command>mount.fuse</command></term>
        <listitem>
          <para>
            is the command <command>mount</command> would call to mount a Fuse
            filesystem.
          </para>
          <indexterm zone="fuse mount.fuse">
            <primary sortas="b-mount.fuse">mount.fuse</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ulockmgr_server">
        <term><command>ulockmgr_server</command></term>
        <listitem>
          <para>
            is the Userspace Lock Manager Server for Fuse filesystems.
          </para>
          <indexterm zone="fuse ulockmgr_server">
            <primary sortas="b-ulockmgr_server">ulockmgr_server</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfuse">
        <term><filename class="libraryfile">libfuse.so</filename></term>
        <listitem>
          <para>
            contains the Fuse API functions.
          </para>
          <indexterm zone="fuse libfuse">
            <primary sortas="c-libfuse">libfuse.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libulockmgr">
        <term><filename class="libraryfile">libulockmgr.so</filename></term>
        <listitem>
          <para>
            contains the Userspace Lock Manager API functions.
          </para>
          <indexterm zone="fuse libulockmgr">
            <primary sortas="c-libulockmgr">libulockmgr.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>