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