befs.rst 3.8 KB

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