--- BasiliskII/README	1999/10/03 20:40:05	1.4
+++ BasiliskII/README	2001/07/09 11:21:58	1.21
@@ -1,9 +1,8 @@
 
-	Basilisk II, Version 0.7
-	A free, portable Mac II emulator
+  Basilisk II
+  A 68k Macintosh emulator
 
-	Copyright (C) 1997-1999 Christian Bauer et al.
-	Freely distributable
+  Copyright (C) 1997-2001 Christian Bauer et al.
 
 
 License
@@ -16,13 +15,15 @@ See the file "COPYING" that is included
 Overview
 --------
 
-Basilisk II is a free, portable, Open Source 68k Mac emulator. It requires
-a copy of a Mac ROM and a copy of MacOS to run. Basilisk II is freeware and
-distributed under the GNU General Public License.
+Basilisk II is an Open Source 68k Macintosh emulator. That is, it enables
+you to run 68k MacOS software on you computer, even if you are using a
+different operating system. However, you still need a copy of MacOS and
+a Macintosh ROM image to use Basilisk II.
 
 Basilisk II has currently been ported to the following systems:
   - BeOS R4 (PowerPC and x86)
-  - Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x and IRIX 6.5)
+  - Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x, NetBSD 1.4.2 and
+    IRIX 6.5)
   - AmigaOS 3.x
   - Windows NT 4.0 (mostly works under Windows 95/98, too)
 
@@ -35,11 +36,14 @@ Some features of Basilisk II:
   - Floppy disk driver (only 1.44MB disks supported)
   - Driver for HFS partitions and hardfiles
   - CD-ROM driver with basic audio functions
+  - Easy file exchange with the host OS via a "Host Directory Tree" icon
+    on the Mac desktop
   - Ethernet driver
   - Serial drivers
   - SCSI Manager (old-style) emulation
   - Emulates extended ADB keyboard and 3-button mouse
-  - Uses UAE 68k emulation or (under AmigaOS) real 68k processor
+  - Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k
+    processor
 
 The emulator is not yet complete. See the file "TODO" for a list of
 unimplemented stuff.
@@ -137,6 +141,16 @@ cdrom <CD-ROM drive description>
   installed CD-ROM drives. The format of the "CD-ROM drive description"
   is the same as that of "disk" lines.
 
+extfs <direcory path>
+
+  This item specifies the root directory for the "Host Directory Tree"
+  file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
+  All objects contained in that directory are accessible by Mac applications.
+  This feature is only available when File System Manager V1.2 or later
+  is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
+  and can be installed as a system extension (downloadable from Apple, look
+  for the FSM SDK in the developer section) for earlier MacOS versions.
+
 scsi0 <SCSI target> ... scsi6 <SCSI target>
 
   These items describe the SCSI target to be used for a given Mac SCSI
@@ -166,9 +180,8 @@ scsi0 <SCSI target> ... scsi6 <SCSI targ
     "scsi.device/2").
 
   Windows:
-    Ignored. Basilisk II scans for all SCSI devices and the first 6 found
-    devices are made visible to the MacOS. You cannot explicitly enable a
-    device, but you can disable a device (see the "disablescsi" command).
+    The "SCSI target" has the format <"Vendor"> <"Model"> (e.g.
+    scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes.
 
 screen <video mode>
 
@@ -199,12 +212,19 @@ screen <video mode>
         (8/15/24 bit) depends on the depth of the underlying X11 screen.
         This is the default.
       dga/<width>/<height>
-        Full-screen display using the X11 DGA extensions. The color depth
+        [if Basilisk II was configured with --enable-xf86-dga]
+        Full-screen display using the XFree86 DGA extension. The color depth
         (8/15/24 bit) depends on the depth of the underlying X11 screen.
         "width" and "height" specify the maximum width/height to use.
-        Saying "dga/0/0" means "complete screen". For DGA to work, Basilisk II
-        must be compiled with DGA support enabled (selectable in the configure
-        script).
+        Saying "dga/0/0" means "complete screen".
+      dga/<frame buffer name>
+        [if Basilisk II was configured with --enable-fbdev-dga]
+        Full-screen display using the frame buffer device /dev/fb. The color
+        depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
+        The "frame buffer name" is looked up in the "fbdevices" file (whose
+        path can be specified with the "fbdevicefile" prefs item) to determine
+        certain characteristics of the device (doing a "ls -l /dev/fb" should
+        tell you what your frame buffer name is).
 
   AmigaOS:
     The "video mode" is one of the following:
@@ -216,11 +236,11 @@ screen <video mode>
         15-bit truecolor display in a Picasso96 PIP. This requires
         Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
       scr/<hexadecimal mode ID>
-        8/15/24-bit fullscreen display on a Picasso96 screen with the given
-        mode ID. This requires Picasso96. For 15 and 24 bit, the frame buffer
-        format must be QuickDraw-compatible (big-endian, xRGB 1:5:5:5 or
-        xRGB 8:8:8:8). The screen size will be the default size for that
-        mode ID.
+        8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
+        the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
+        24 bit, the frame buffer format must be QuickDraw-compatible
+        (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
+        the default size for that mode ID.
 
   Windows:
     The "video mode" is one of the following:
@@ -307,13 +327,15 @@ ether <ethernet card description>
   BeOS:
     It doesn't matter what you give as "ethernet card description", Basilisk II
     will always use the first Ethernet card it finds as long an an "ether"
-    line exists (e.g. say "ether yes"). As Basilisk II requires the sheep_net
-    net server add-on from SheepShaver, you can only use Ethernet on PowerPC
-    machines.
+    line exists (e.g. say "ether yes"). Using Ethernet requires the "sheep_net"
+    Net Server add-on to be installed. The first time you start Basilisk II
+    with Ethernet enabled you will be asked whether it's OK to make the
+    necessary changes to your BeOS network configuration to enable sheep_net.
 
   Linux:
     The "ethernet card description" is the name of an Ethernet interface.
     There are two approaches to networking with Basilisk II:
+
       1. Direct access to an Ethernet card via the "sheep_net" driver.
          In this case, the "ethernet card description" must be the name
          of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net"
@@ -323,23 +345,47 @@ ether <ethernet card description>
          networking. MacOS will only be able to talk to other machines on
          the Ethernet, but not to other networks that your Linux box routes
          (e.g. a second Ethernet or a PPP connection to the Internet).
+
       2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
          In this case, the "ethernet card description" must be the name
          of an ethertap interface, e.g. "tap0". It also requires that you
          configure your kernel to enable routing and the ethertap device:
          under "Networking options", enable "Kernel/User netlink socket" and
          "Netlink device emulation", under "Network device support", activate
-         "Ethertap network tap". Next, see /usr/src/linux/Documentation/
-         networking/ethertap.txt for information on how to set up /dev/tap*
-         device nodes and activate the ethertap interface. Under MacOS,
-         select an IP address that is on the virtual network and set the
-         default gateway to the IP address of the ethertap interface. This
-         approach will let you access all networks that your Linux box has
-         access to (especially, if your Linux box has a dial-up Internet
-         connection and is configured for IP masquerading, you can access
-         the Internet from MacOS). The drawback is that you can only use
-         network protocols that Linux can route, so you have to install and
-         configure netatalk if you want to use AppleTalk.
+         "Ethertap network tap". You also have to modify drivers/net/ethertap.c
+         a bit before compiling the new kernel:
+
+          - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
+            #include lines)
+          - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
+
+         Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
+         information on how to set up /dev/tap* device nodes and activate the
+         ethertap interface. Under MacOS, select an IP address that is on the
+         virtual network and set the default gateway to the IP address of the
+         ethertap interface. This approach will let you access all networks
+         that your Linux box has access to (especially, if your Linux box has
+         a dial-up Internet connection and is configured for IP masquerading,
+         you can access the Internet from MacOS). The drawback is that you
+         can only use network protocols that Linux can route, so you have to
+         install and configure netatalk if you want to use AppleTalk. Here is
+         an example /etc/atalk/atalkd.conf for a LAN:
+
+           eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
+           tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
+
+         (the "47" is an arbitrary node number). This will set up a zone
+         "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
+         for the internal network connection of the ethertap interface.
+         MacOS should automatically recognize the nets and zones upon startup.
+         If you are in an existing AppleTalk network, you should contact
+         your network administrator about the nets and zones you can use
+         (instead of the ones given in the example above).
+
+  FreeBSD:
+    The "ethertap" method described above also works under FreeBSD, but since
+    no-one has found the time to write a section for this manual, you're on
+    your own here...
 
   AmigaOS:
     You have to specify the name of the SANA-II Ethernet device and the device
@@ -376,7 +422,9 @@ frameskip <frames to skip>
   For refreshed graphics modes (usually window modes), this specifies
   how many frames to skip after drawing one frame. Higher values make
   the video display more responsive but require more processing power.
-  The default is "8".
+  The default is "8". Under Unix/X11, a value of "0" selects a "dynamic"
+  update mode that cuts the display into rectangles and updates each
+  rectangle individually, depending on display changes.
 
 modelid <MacOS model ID>
 
@@ -415,7 +463,7 @@ System-specific configuration
 Unix:
 
   keycodes <"true" or "false">
-  keycodefile <Keycode file path>
+  keycodefile <keycodes file path>
 
     By default, the X11 event handler in Basilisk II uses KeySyms to
     translate keyboard event to Mac keycodes. While this method is very
@@ -426,10 +474,29 @@ Unix:
     not on the selected keymap. Unfortunately it depends on the X server
     being used and possibly also on the type of keyboard attached. So
     Basilisk II needs a table to translate X keycodes to Mac keycodes.
-    This table is read by default from /usr/local/lib/basilisk_ii_keycodes
+    This table is read by default from /usr/local/share/BasiliskII/keycodes
     unless you specify a different file with the "keycodefile" item.
-    A sample keycode file ("basilisk_ii_keycodes") is included with
-    Basilisk II.
+    A sample keycode file is included with Basilisk II.
+
+  fbdevicefile <fbdevices file path>
+
+    This option specifies the file that contains frame buffer device
+    specifications for the fbdev-DGA video mode (when Basilisk II was
+    configured with --enable-fbdev-dga). The default location of the file
+    is /usr/local/share/BasiliskII/fbdevices. A sample file is included
+    with Basilisk II.
+
+  mousewheelmode <mode>
+
+    If you have a mouse with a wheel, this option specifies whether moving
+    the wheel will be reported to the MacOS as "Page up/down" (mode 0) or
+    "Cursor up/down" (mode 1) keys.
+
+  mousewheellines <number of lines>
+
+    If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets
+    the number of key events sent to MacOS for each wheel movement (the
+    number of lines to scroll).
 
 AmigaOS:
 
@@ -441,6 +508,19 @@ AmigaOS:
 
       ahi/<hexadecimal mode ID>
 
+  scsimemtype <type>
+
+    This item controls the type of memory to use for SCSI buffers. Possible
+    values are:
+      0 Chip memory
+      1 24-bit DMA capable memory
+      2 Any memory
+
+    Be warned that many SCSI host adapters will not work with the "Any memory"
+    setting. Basilisk II has no way of knowing which memory type is supported
+    by the host adapter and setting an unsupported type will result in data
+    corruption.
+
 Windows:
 
   noscsi <"true" or "false">
@@ -470,15 +550,42 @@ Windows:
   
     Note the use of quotes.
 
-  disablescsi <"Vendor"> <"Model">
+  rightmouse <0/1>
 
-    Disables this vendor/model combination. You may need this simply because
-    you have more than 6 SCSI devices, or the particular device has problems
-    under BasiliskII. E.g.
+    Defines what the right mouse button is used for. The default values of 0
+    means that it is used to move windowed mode BasiliskII screen.
+    Value 1 sends a combination Control and mouse click to the MacOS.
+    This may be useful under OS versions 8 and above.
 
-      disablescsi "HP" "CD-Writer+ 7100"
-  
-    Again, note the use of quotes.
+  keyboardfile <path>
+
+    Defines the path of the customized keyboard code file.
+
+  pollmedia <"true" or "false">
+
+    If true (default), tries to automatically detect new media.
+    Applies to all "floppy", "cd" or "disk" removable media except
+    1.44 MB floppies. May cause modest slow down. If unchecked, 
+    use Ctrl-Shift-F11 to manually mount new media.
+    If you have auto-insert notification (AIN) enabled, you may turn this
+    option off. Note that some CD related software require AIN,
+    and some other need it to be turned off. Consult the documentation
+    of your CD software to learn which one is optimal for you.
+
+  framesleepticks <milliseconds>    
+
+    The amount of time between video frames.
+
+  showfps <true/false>
+
+    If true, the real frame rate is displayed.
+
+  stickymenu <true/false>
+
+    If true, the main menu bar is kept open even after the mouse button is released,
+    under all OS versions (OS 8 has this feature already). There are extensions to do 
+    the same thing, but it's faster to handle this in native code.
+    Default is "true".
 
   ntdx5hack <"true" or "false">
 
@@ -509,9 +616,14 @@ Keyboard:
   On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
   key is the Mac "Option" key.
 
+Mouse:
+  Under Unix, press Ctrl-F5 while the Basilisk II window is active will grab
+  the mouse. This is needed for compatibility with some MacOS programs,
+  especially games. Press Ctrl-F5 again to return to normal mouse operation.
+
 Floppy:
   Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
-  flopyy disk changes might not be detected automatically. Under Linux, press
+  floppy disk changes might not be detected automatically. Under Unix, press
   Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
   item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
 
@@ -570,17 +682,22 @@ Please see the included file "TECH" for
 Acknowledgements
 ----------------
 
-Contributions by:
- - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
- - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
-   and networking
- - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
+Contributions by (in alphabetical order):
  - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
- - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
+ - Gwenole Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations and
+   fbdev video code
  - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
+ - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
+   and networking
  - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
    window support
+ - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
+ - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
+ - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
  - David Lawrence <davidl@jlab.org>: incremental window refresh code
+ - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
+ - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
+ - and others...
 
 Special thanks to:
  - Bernd Schmidt for letting me use his UAE 68k emulation