xref: /OK3568_Linux_fs/kernel/Documentation/filesystems/befs.rst (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun.. SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun=========================
4*4882a593SmuzhiyunBeOS filesystem for Linux
5*4882a593Smuzhiyun=========================
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunDocument last updated: Dec 6, 2001
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunWarning
10*4882a593Smuzhiyun=======
11*4882a593SmuzhiyunMake sure you understand that this is alpha software.  This means that the
12*4882a593Smuzhiyunimplementation is neither complete nor well-tested.
13*4882a593Smuzhiyun
14*4882a593SmuzhiyunI DISCLAIM ALL RESPONSIBILITY FOR ANY POSSIBLE BAD EFFECTS OF THIS CODE!
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunLicense
17*4882a593Smuzhiyun=======
18*4882a593SmuzhiyunThis software is covered by the GNU General Public License.
19*4882a593SmuzhiyunSee the file COPYING for the complete text of the license.
20*4882a593SmuzhiyunOr the GNU website: <http://www.gnu.org/licenses/licenses.html>
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunAuthor
23*4882a593Smuzhiyun======
24*4882a593SmuzhiyunThe largest part of the code written by Will Dyson <will_dyson@pobox.com>
25*4882a593SmuzhiyunHe has been working on the code since Aug 13, 2001. See the changelog for
26*4882a593Smuzhiyundetails.
27*4882a593Smuzhiyun
28*4882a593SmuzhiyunOriginal Author: Makoto Kato <m_kato@ga2.so-net.ne.jp>
29*4882a593Smuzhiyun
30*4882a593SmuzhiyunHis original code can still be found at:
31*4882a593Smuzhiyun<http://hp.vector.co.jp/authors/VA008030/bfs/>
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunDoes anyone know of a more current email address for Makoto? He doesn't
34*4882a593Smuzhiyunrespond to the address given above...
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunThis filesystem doesn't have a maintainer.
37*4882a593Smuzhiyun
38*4882a593SmuzhiyunWhat is this Driver?
39*4882a593Smuzhiyun====================
40*4882a593SmuzhiyunThis module implements the native filesystem of BeOS http://www.beincorporated.com/
41*4882a593Smuzhiyunfor the linux 2.4.1 and later kernels. Currently it is a read-only
42*4882a593Smuzhiyunimplementation.
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunWhich is it, BFS or BEFS?
45*4882a593Smuzhiyun=========================
46*4882a593SmuzhiyunBe, Inc said, "BeOS Filesystem is officially called BFS, not BeFS".
47*4882a593SmuzhiyunBut Unixware Boot Filesystem is called bfs, too. And they are already in
48*4882a593Smuzhiyunthe kernel. Because of this naming conflict, on Linux the BeOS
49*4882a593Smuzhiyunfilesystem is called befs.
50*4882a593Smuzhiyun
51*4882a593SmuzhiyunHow to Install
52*4882a593Smuzhiyun==============
53*4882a593Smuzhiyunstep 1.  Install the BeFS  patch into the source code tree of linux.
54*4882a593Smuzhiyun
55*4882a593SmuzhiyunApply the patchfile to your kernel source tree.
56*4882a593SmuzhiyunAssuming that your kernel source is in /foo/bar/linux and the patchfile
57*4882a593Smuzhiyunis called patch-befs-xxx, you would do the following:
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun	cd /foo/bar/linux
60*4882a593Smuzhiyun	patch -p1 < /path/to/patch-befs-xxx
61*4882a593Smuzhiyun
62*4882a593Smuzhiyunif the patching step fails (i.e. there are rejected hunks), you can try to
63*4882a593Smuzhiyunfigure it out yourself (it shouldn't be hard), or mail the maintainer
64*4882a593Smuzhiyun(Will Dyson <will_dyson@pobox.com>) for help.
65*4882a593Smuzhiyun
66*4882a593Smuzhiyunstep 2.  Configuration & make kernel
67*4882a593Smuzhiyun
68*4882a593SmuzhiyunThe linux kernel has many compile-time options. Most of them are beyond the
69*4882a593Smuzhiyunscope of this document. I suggest the Kernel-HOWTO document as a good general
70*4882a593Smuzhiyunreference on this topic. http://www.linuxdocs.org/HOWTOs/Kernel-HOWTO-4.html
71*4882a593Smuzhiyun
72*4882a593SmuzhiyunHowever, to use the BeFS module, you must enable it at configure time::
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun	cd /foo/bar/linux
75*4882a593Smuzhiyun	make menuconfig (or xconfig)
76*4882a593Smuzhiyun
77*4882a593SmuzhiyunThe BeFS module is not a standard part of the linux kernel, so you must first
78*4882a593Smuzhiyunenable support for experimental code under the "Code maturity level" menu.
79*4882a593Smuzhiyun
80*4882a593SmuzhiyunThen, under the "Filesystems" menu will be an option called "BeFS
81*4882a593Smuzhiyunfilesystem (experimental)", or something like that. Enable that option
82*4882a593Smuzhiyun(it is fine to make it a module).
83*4882a593Smuzhiyun
84*4882a593SmuzhiyunSave your kernel configuration and then build your kernel.
85*4882a593Smuzhiyun
86*4882a593Smuzhiyunstep 3.  Install
87*4882a593Smuzhiyun
88*4882a593SmuzhiyunSee the kernel howto <http://www.linux.com/howto/Kernel-HOWTO.html> for
89*4882a593Smuzhiyuninstructions on this critical step.
90*4882a593Smuzhiyun
91*4882a593SmuzhiyunUsing BFS
92*4882a593Smuzhiyun=========
93*4882a593SmuzhiyunTo use the BeOS filesystem, use filesystem type 'befs'.
94*4882a593Smuzhiyun
95*4882a593Smuzhiyunex::
96*4882a593Smuzhiyun
97*4882a593Smuzhiyun    mount -t befs /dev/fd0 /beos
98*4882a593Smuzhiyun
99*4882a593SmuzhiyunMount Options
100*4882a593Smuzhiyun=============
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun=============  ===========================================================
103*4882a593Smuzhiyunuid=nnn        All files in the partition will be owned by user id nnn.
104*4882a593Smuzhiyungid=nnn	       All files in the partition will be in group nnn.
105*4882a593Smuzhiyuniocharset=xxx  Use xxx as the name of the NLS translation table.
106*4882a593Smuzhiyundebug          The driver will output debugging information to the syslog.
107*4882a593Smuzhiyun=============  ===========================================================
108*4882a593Smuzhiyun
109*4882a593SmuzhiyunHow to Get Lastest Version
110*4882a593Smuzhiyun==========================
111*4882a593Smuzhiyun
112*4882a593SmuzhiyunThe latest version is currently available at:
113*4882a593Smuzhiyun<http://befs-driver.sourceforge.net/>
114*4882a593Smuzhiyun
115*4882a593SmuzhiyunAny Known Bugs?
116*4882a593Smuzhiyun===============
117*4882a593SmuzhiyunAs of Jan 20, 2002:
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun	None
120*4882a593Smuzhiyun
121*4882a593SmuzhiyunSpecial Thanks
122*4882a593Smuzhiyun==============
123*4882a593SmuzhiyunDominic Giampalo ... Writing "Practical file system design with Be filesystem"
124*4882a593Smuzhiyun
125*4882a593SmuzhiyunHiroyuki Yamada  ... Testing LinuxPPC.
126*4882a593Smuzhiyun
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun
129