glfs/postlfs/filesystems/fuse3.xml
Bruce Dubbs 810609470e Internal clarifications of fuse versions
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18583 af4574ff-66df-0310-9fd7-8a98e5e911e0
2017-04-11 18:16:32 +00:00

283 lines
8.0 KiB
XML

<?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 fuse3-download-http "https://github.com/libfuse/libfuse/releases/download/fuse-&fuse3-version;/fuse3-&fuse3-version;.tar.gz">
<!ENTITY fuse3-download-ftp " ">
<!ENTITY fuse3-md5sum "d4d8bc7aa8202e4fca1ad47ff844206f">
<!ENTITY fuse3-size "732 KB">
<!ENTITY fuse3-buildsize "11 MB">
<!ENTITY fuse3-time "0.2 SBU">
]>
<sect1 id="fuse3" xreflabel="Fuse-&fuse3-version;">
<?dbhtml filename="fuse.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>Fuse-&fuse3-version;</title>
<indexterm zone="fuse3">
<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>
&lfs80_checked;
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>
Download (HTTP): <ulink url="&fuse3-download-http;"/>
</para>
</listitem>
<listitem>
<para>
Download (FTP): <ulink url="&fuse3-download-ftp;"/>
</para>
</listitem>
<listitem>
<para>
Download MD5 sum: &fuse3-md5sum;
</para>
</listitem>
<listitem>
<para>
Download size: &fuse3-size;
</para>
</listitem>
<listitem>
<para>
Estimated disk space required: &fuse3-buildsize;
</para>
</listitem>
<listitem>
<para>
Estimated build time: &fuse3-time;
</para>
</listitem>
</itemizedlist>
<!--
<bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
-->
<!-- HTML documentation is prebuilt now, dox/Doxyfile appares not to work
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="doxygen"/> (to build the API documentation)
</para>
-->
<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;
&lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
<indexterm zone="fuse3 fuse-kernel">
<primary sortas="d-fuse3">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 \
--disable-static \
--exec-prefix=/ \
INIT_D_PATH=/tmp/init.d &amp;&amp;
make</userinput></screen>
<!-- <para>
If you have <xref linkend="doxygen"/> installed and wish to build the API
documentation, issue <command>doxygen doc/Doxyfile</command>.
</para> -->
<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 &amp;&amp;
install -v -m755 -d /usr/share/doc/fuse-&fuse3-version; &amp;&amp;
install -v -m644 doc/{README.NFS,kernel.txt} \
/usr/share/doc/fuse-&fuse3-version; &amp;&amp;
cp -Rv doc/html /usr/share/doc/fuse-&fuse3-version;</userinput></screen>
<!--
<para>
If you built the API documentation, install it as the
<systemitem class="username">root</systemitem> user by issuing the
following commands:
</para>
<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/fuse-&fuse-version;/api &amp;&amp;
install -v -m644 doc/html/* \
/usr/share/doc/fuse-&fuse-version;/api</userinput></screen>
-->
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
href="../../xincludes/static-libraries.xml"/>
<para>
<parameter>--exec-prefix=/</parameter>: This parameter moves programs and
libraries that could be needed before the
<filename class="directory">/usr</filename> directory is mounted, to the
root filesystem.
</para>
<para>
<parameter>INIT_D_PATH=/tmp/init.d</parameter>: This parameter installs
the bootscript into <filename class="directory">/tmp/init.d</filename> as
a bootscript is not required.
</para>
<para>
<command>rm -rf /tmp/init.d</command>: This removes the unneeded
bootscript.
</para>
</sect2>
<sect2 role="configuration" id="fuse-configuration">
<title>Configuring fuse</title>
<sect3 id="fuse-config">
<title>Config Files</title>
<para>
Some options regarding mount policy can be set in the file
<filename>/etc/fuse.conf</filename>. To install the file run the
following command as the <systemitem class="username">root</systemitem>
user:
</para>
<screen role="root"><userinput>cat &gt; /etc/fuse.conf &lt;&lt; "EOF"
# Set the maximum number of FUSE mounts allowed to non-root users.
# The default is 1000.
#
#mount_max = 1000
# Allow non-root users to specify the 'allow_other' or 'allow_root'
# mount options.
#
#user_allow_other
EOF</userinput></screen>
<para>
Additional information about the meaning of the configuration
options are found in the man page.
</para>
</sect3>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>
fusermount3, mount.fuse3
</seg>
<seg>
libfuse3.so
</seg>
<seg>
/usr/include/fuse3 and /usr/share/doc/fuse-&fuse3-version;
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="fusermount3">
<term><command>fusermount3</command></term>
<listitem>
<para>
is a set users ID root program to mount and unmount Fuse
filesystems.
</para>
<indexterm zone="fuse3 fusermount3">
<primary sortas="b-fusermount3">fusermount3</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="mount.fuse3">
<term><command>mount.fuse3</command></term>
<listitem>
<para>
is the command <command>mount</command> would call to mount a Fuse
filesystem.
</para>
<indexterm zone="fuse3 mount.fuse3">
<primary sortas="b-mount.fuse3">mount.fuse3</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libfuse3">
<term><filename class="libraryfile">libfuse3.so</filename></term>
<listitem>
<para>
contains the <application>FUSE</application> API functions.
</para>
<indexterm zone="fuse3 libfuse3">
<primary sortas="c-libfuse3">libfuse3.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>