blob: 67391a15949ab0af32ce313df370a8a99b0ae647 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001BeOS 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
Matt LaPlanted6bc8ac2006-10-03 22:54:15 +020010I DISCLAIM ALL RESPONSIBILITY FOR ANY POSSIBLE BAD EFFECTS OF THIS CODE!
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
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=====
20The largest part of the code written by Will Dyson <will_dyson@pobox.com>
21He has 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>
Matt LaPlante992caac2006-10-03 22:52:05 +020025His original code can still be found at:
Linus Torvalds1da177e2005-04-16 15:20:36 -070026<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
30Current maintainer: Sergey S. Kostyliov <rathamahata@php4.ru>
31
32WHAT IS THIS DRIVER?
33==================
34This module implements the native filesystem of BeOS <http://www.be.com/>
35for the linux 2.4.1 and later kernels. Currently it is a read-only
36implementation.
37
38Which is it, BFS or BEFS?
39================
40Be, Inc said, "BeOS Filesystem is officially called BFS, not BeFS".
41But Unixware Boot Filesystem is called bfs, too. And they are already in
Matt LaPlante992caac2006-10-03 22:52:05 +020042the kernel. Because of this naming conflict, on Linux the BeOS
Linus Torvalds1da177e2005-04-16 15:20:36 -070043filesystem is called befs.
44
45HOW TO INSTALL
46==============
47step 1. Install the BeFS patch into the source code tree of linux.
48
49Apply the patchfile to your kernel source tree.
50Assuming that your kernel source is in /foo/bar/linux and the patchfile
51is called patch-befs-xxx, you would do the following:
52
53 cd /foo/bar/linux
54 patch -p1 < /path/to/patch-befs-xxx
55
56if the patching step fails (i.e. there are rejected hunks), you can try to
57figure it out yourself (it shouldn't be hard), or mail the maintainer
58(Will Dyson <will_dyson@pobox.com>) for help.
59
Matt LaPlante6c28f2c2006-10-03 22:46:31 +020060step 2. Configuration & make kernel
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62The linux kernel has many compile-time options. Most of them are beyond the
63scope of this document. I suggest the Kernel-HOWTO document as a good general
64reference on this topic. <http://www.linux.com/howto/Kernel-HOWTO.html>
65
66However, to use the BeFS module, you must enable it at configure time.
67
68 cd /foo/bar/linux
69 make menuconfig (or xconfig)
70
71The BeFS module is not a standard part of the linux kernel, so you must first
72enable support for experimental code under the "Code maturity level" menu.
73
74Then, under the "Filesystems" menu will be an option called "BeFS
75filesystem (experimental)", or something like that. Enable that option
76(it is fine to make it a module).
77
78Save your kernel configuration and then build your kernel.
79
80step 3. Install
81
82See the kernel howto <http://www.linux.com/howto/Kernel-HOWTO.html> for
83instructions on this critical step.
84
85USING BFS
86=========
87To use the BeOS filesystem, use filesystem type 'befs'.
88
89ex)
90 mount -t befs /dev/fd0 /beos
91
92MOUNT OPTIONS
93=============
94uid=nnn All files in the partition will be owned by user id nnn.
95gid=nnn All files in the partition will be in group nnn.
96iocharset=xxx Use xxx as the name of the NLS translation table.
97debug The driver will output debugging information to the syslog.
98
99HOW TO GET LASTEST VERSION
100==========================
101
102The latest version is currently available at:
103<http://befs-driver.sourceforge.net/>
104
105ANY KNOWN BUGS?
106===========
107As of Jan 20, 2002:
108
109 None
110
111SPECIAL THANKS
112==============
113Dominic Giampalo ... Writing "Practical file system design with Be filesystem"
114Hiroyuki Yamada ... Testing LinuxPPC.
115
116
117