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