source: archive/fuse2.xml

trunk
Last change on this file was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 17 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 8.5 KB
Line 
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
7 <!ENTITY fuse2-download-http "https://github.com/libfuse/libfuse/releases/download/fuse-&fuse2-version;/fuse-&fuse2-version;.tar.gz">
8 <!ENTITY fuse2-download-ftp " ">
9 <!ENTITY fuse2-md5sum "9bd4ce8184745fd3d000ca2692adacdb">
10 <!ENTITY fuse2-size "646 KB">
11 <!ENTITY fuse2-buildsize "8.2 MB (9.8 MB with API documentation)">
12 <!ENTITY fuse2-time "0.1 SBU">
13]>
14
15<sect1 id="fuse2" xreflabel="Fuse-&fuse2-version;">
16 <?dbhtml filename="fuse2.html"?>
17
18
19 <title>Fuse-&fuse2-version;</title>
20
21 <indexterm zone="fuse2">
22 <primary sortas="a-Fuse-2">Fuse 2</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Fuse</title>
27
28 <para>
29 <application>FUSE</application> (Filesystem in Userspace) is a simple
30 interface for userspace programs to export a virtual filesystem to the
31 Linux kernel. <application>Fuse</application> also aims to provide a
32 secure method for non privileged users to create and mount their own
33 filesystem implementations.
34 </para>
35
36 <para>
37 This package is only installed for compatibility with
38 <xref linkend="gvfs"/>. It is not needed with other packages.
39 For full fuse functionality, install <xref linkend="fuse3"/> which
40 does not interfere with these instructions.
41 </para>
42
43 &lfs90_checked;
44
45 <bridgehead renderas="sect3">Package Information</bridgehead>
46 <itemizedlist spacing="compact">
47 <listitem>
48 <para>
49 Download (HTTP): <ulink url="&fuse2-download-http;"/>
50 </para>
51 </listitem>
52 <listitem>
53 <para>
54 Download (FTP): <ulink url="&fuse2-download-ftp;"/>
55 </para>
56 </listitem>
57 <listitem>
58 <para>
59 Download MD5 sum: &fuse2-md5sum;
60 </para>
61 </listitem>
62 <listitem>
63 <para>
64 Download size: &fuse2-size;
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Estimated disk space required: &fuse2-buildsize;
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Estimated build time: &fuse2-time;
75 </para>
76 </listitem>
77 </itemizedlist>
78
79 <bridgehead renderas="sect3">Fuse Dependencies</bridgehead>
80
81<!-- What is this?
82 <bridgehead renderas="sect3">Required</bridgehead>
83 <para role="required">
84 <xref linkend="fuse3"/> (runtime only)
85 </para>
86-->
87 <bridgehead renderas="sect4">Optional</bridgehead>
88 <para role="optional">
89 <xref linkend="doxygen"/> (to rebuild the API documentation)
90 </para>
91
92 <para condition="html" role="usernotes">
93 User Notes: <ulink url="&blfs-wiki;/fuse2"/>
94 </para>
95 </sect2>
96
97 <sect2 role="kernel" id="fuse2-kernel">
98 <title>Kernel Configuration</title>
99
100 <para>
101 Enable the following options in the kernel configuration and recompile the
102 kernel if necessary:
103 </para>
104
105<screen><literal>File systems ---&gt;
106 &lt;*/M&gt; FUSE (Filesystem in Userspace) support [CONFIG_FUSE_FS]</literal></screen>
107
108 <indexterm zone="fuse2 fuse2-kernel">
109 <primary sortas="d-fuse2">Fuse 2</primary>
110 </indexterm>
111 </sect2>
112
113 <sect2 role="installation">
114 <title>Installation of Fuse</title>
115
116 <para>
117 Install <application>Fuse</application> by running the following
118 commands:
119 </para>
120
121<screen><userinput>./configure --prefix=/usr \
122 --disable-static \
123 --exec-prefix=/ &amp;&amp;
124
125make &amp;&amp;
126make DESTDIR=$PWD/Dest install</userinput></screen>
127
128 <para>
129 This package does not come with a test suite.
130 </para>
131
132 <para>
133 Now, as the <systemitem class="username">root</systemitem> user:
134 </para>
135
136<screen role="root"><userinput>install -vm755 Dest/lib/libfuse.so.&fuse2-version; /lib &amp;&amp;
137install -vm755 Dest/lib/libulockmgr.so.1.0.1 /lib &amp;&amp;
138ln -sfv ../../lib/libfuse.so.&fuse2-version; /usr/lib/libfuse.so &amp;&amp;
139ln -sfv ../../lib/libulockmgr.so.1.0.1 /usr/lib/libulockmgr.so &amp;&amp;
140
141install -vm644 Dest/lib/pkgconfig/fuse.pc /usr/lib/pkgconfig &amp;&amp;
142
143install -vm4755 Dest/bin/fusermount /bin &amp;&amp;
144install -vm755 Dest/bin/ulockmgr_server /bin &amp;&amp;
145
146install -vm755 Dest/sbin/mount.fuse /sbin &amp;&amp;
147
148install -vdm755 /usr/include/fuse &amp;&amp;
149
150install -vm644 Dest/usr/include/*.h /usr/include &amp;&amp;
151install -vm644 Dest/usr/include/fuse/*.h /usr/include/fuse/ &amp;&amp;
152
153install -vm644 Dest/usr/share/man/man1/* /usr/share/man/man1 &amp;&amp;
154/sbin/ldconfig -v</userinput></screen>
155
156 </sect2>
157
158 <sect2 role="commands">
159 <title>Command Explanations</title>
160
161 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
162 href="../../xincludes/static-libraries.xml"/>
163
164 <para>
165 <parameter>--exec-prefix=/</parameter>: This parameter moves programs and
166 libraries that could be needed before the
167 <filename class="directory">/usr</filename> directory is mounted, to the
168 root filesystem.
169 </para>
170
171 <para>
172 <command>make DESTDIR=$PWD/Dest install</command>: This command installs
173 the files to a temporary directory, so that the needed files can be
174 installed.
175 </para>
176
177 </sect2>
178
179 <sect2 role="configuration">
180 <title>Configuring fuse</title>
181
182 <sect3 id="fuse2-config">
183 <title>Config Files</title>
184
185 <para>
186 Information on configuring fuse can be found at
187 <xref linkend="fuse-configuration"/>.
188 </para>
189
190 </sect3>
191
192 </sect2>
193
194 <sect2 role="content">
195 <title>Contents</title>
196
197 <segmentedlist>
198 <segtitle>Installed Programs</segtitle>
199 <segtitle>Installed Libraries</segtitle>
200 <segtitle>Installed Directory</segtitle>
201
202 <seglistitem>
203 <seg>
204 fusermount, mount.fuse, and ulockmgr_server
205 </seg>
206 <seg>
207 libfuse.so and libulockmgr.so
208 </seg>
209 <seg>
210 /usr/include/fuse
211 </seg>
212 </seglistitem>
213 </segmentedlist>
214
215 <variablelist>
216 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
217 <?dbfo list-presentation="list"?>
218 <?dbhtml list-presentation="table"?>
219
220 <varlistentry id="fusermount2">
221 <term><command>fusermount</command></term>
222 <listitem>
223 <para>
224 is a suid root program to mount and unmount Fuse
225 filesystems.
226 </para>
227 <indexterm zone="fuse2 fusermount2">
228 <primary sortas="b-fusermount2">fusermount</primary>
229 </indexterm>
230 </listitem>
231 </varlistentry>
232
233 <varlistentry id="mount.fuse2">
234 <term><command>mount.fuse</command></term>
235 <listitem>
236 <para>
237 is the command <command>mount</command> would call to mount a Fuse
238 filesystem.
239 </para>
240 <indexterm zone="fuse2 mount.fuse2">
241 <primary sortas="b-mount.fuse2">mount.fuse</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="ulockmgr_server2">
247 <term><command>ulockmgr_server</command></term>
248 <listitem>
249 <para>
250 is the Userspace Lock Manager Server for Fuse filesystems.
251 </para>
252 <indexterm zone="fuse2 ulockmgr_server2">
253 <primary sortas="b-ulockmgr_server2">ulockmgr_server</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="libfuse2">
259 <term><filename class="libraryfile">libfuse.so</filename></term>
260 <listitem>
261 <para>
262 contains the <application>FUSE</application> API functions.
263 </para>
264 <indexterm zone="fuse2 libfuse2">
265 <primary sortas="c-libfuse2">libfuse.so</primary>
266 </indexterm>
267 </listitem>
268 </varlistentry>
269
270 <varlistentry id="libulockmgr2">
271 <term><filename class="libraryfile">libulockmgr.so</filename></term>
272 <listitem>
273 <para>
274 contains the Userspace Lock Manager API functions.
275 </para>
276 <indexterm zone="fuse2 libulockmgr2">
277 <primary sortas="c-libulockmgr2">libulockmgr.so</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281 </variablelist>
282
283 </sect2>
284
285</sect1>
Note: See TracBrowser for help on using the repository browser.