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