1BeOS filesystem for Linux
2
3Document last updated: Dec 6, 2001
4
5WARNING
6=======
7Make sure you understand that this is alpha software.  This means that the
8implementation is neither complete nor well-tested.
9
10I DISCLAIM ALL RESPONSIBILTY FOR ANY POSSIBLE BAD EFFECTS OF THIS CODE!
11
12LICENSE
13=====
14This software is covered by the GNU General Public License.
15See the file COPYING for the complete text of the license.
16Or the GNU website: <http://www.gnu.org/licenses/licenses.html>
17
18AUTHOR
19=====
20Current maintainer: Will Dyson <will_dyson@pobox.com>
21Has been working on the code since Aug 13, 2001. See the changelog for
22details.
23
24Original Author: Makoto Kato <m_kato@ga2.so-net.ne.jp>
25His orriginal code can still be found at:
26<http://hp.vector.co.jp/authors/VA008030/bfs/>
27Does anyone know of a more current email address for Makoto? He doesn't
28respond to the address given above...
29
30WHAT IS THIS DRIVER?
31==================
32This module implements the native filesystem of BeOS <http://www.be.com/>
33for the linux 2.4.1 and later kernels. Currently it is a read-only
34implementation.
35
36Which is it, BFS or BEFS?
37================
38Be, Inc said, "BeOS Filesystem is officially called BFS, not BeFS".
39But Unixware Boot Filesystem is called bfs, too. And they are already in
40the kernel. Because of this nameing conflict, on Linux the BeOS
41filesystem is called befs.
42
43HOW TO INSTALL
44==============
45step 1.  Install the BeFS  patch into the source code tree of linux.
46
47Apply the patchfile to your kernel source tree.
48Assuming that your kernel source is in /foo/bar/linux and the patchfile
49is called patch-befs-xxx, you would do the following:
50
51	cd /foo/bar/linux
52	patch -p1 < /path/to/patch-befs-xxx
53
54if the patching step fails (i.e. there are rejected hunks), you can try to
55figure it out yourself (it shouldn't be hard), or mail the maintainer
56(Will Dyson <will_dyson@pobox.com>) for help.
57
58step 2.  Configuretion & make kernel
59
60The linux kernel has many compile-time options. Most of them are beyond the
61scope of this document. I suggest the Kernel-HOWTO document as a good general
62reference on this topic. <http://www.linux.com/howto/Kernel-HOWTO.html>
63
64However, to use the BeFS module, you must enable it at configure time.
65
66	cd /foo/bar/linux
67	make menuconfig (or xconfig)
68
69The BeFS module is not a standard part of the linux kernel, so you must first
70enable support for experimental code under the "Code maturity level" menu.
71
72Then, under the "Filesystems" menu will be an option called "BeFS
73filesystem (experimental)", or something like that. Enable that option
74(it is fine to make it a module).
75
76Save your kernel configuration and then build your kernel.
77
78step 3.  Install
79
80See the kernel howto <http://www.linux.com/howto/Kernel-HOWTO.html> for
81instructions on this critical step.
82
83USING BFS
84=========
85To use the BeOS filesystem, use filesystem type 'befs'.
86
87ex)
88    mount -t befs /dev/fd0 /beos
89
90MOUNT OPTIONS
91=============
92uid=nnn        All files in the partition will be owned by user id nnn.
93gid=nnn	       All files in the partition will be in group nnn.
94iocharset=xxx  Use xxx as the name of the NLS translation table.
95debug          The driver will output debugging information to the syslog.
96
97HOW TO GET LASTEST VERSION
98==========================
99
100The latest version is currently available at:
101<http://befs-driver.sourceforge.net/>
102
103ANY KNOWN BUGS?
104===========
105As of Jan 20, 2002:
106
107	None
108
109SPECIAL THANKS
110==============
111Dominic Giampalo ... Writing "Practical file system design with Be filesystem"
112Hiroyuki Yamada  ... Testing LinuxPPC.
113
114
115
116