Documentation/filesystems/befs.rst

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