--- BasiliskII/README	2002/05/20 17:50:39	1.29
+++ BasiliskII/README	2005/10/15 10:21:40	1.42
@@ -2,7 +2,7 @@
   Basilisk II
   A 68k Macintosh emulator
 
-  Copyright (C) 1997-2002 Christian Bauer et al.
+  Copyright (C) 1997-2005 Christian Bauer et al.
 
 
 License
@@ -26,7 +26,7 @@ Basilisk II has currently been ported to
     IRIX 6.5)
   - AmigaOS 3.x
   - Windows NT 4.0 (mostly works under Windows 95/98, too)
-  - Mac OS X 10.1
+  - Mac OS X 10.1, 10.2, 10.3 (native windowing port has UI bugs with 10.4)
 
 Some features of Basilisk II:
   - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
@@ -285,23 +285,17 @@ screen <video mode>
     application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
     is frozen).
 
-
   Mac OS X:
     The "video mode" is one of the following:
       win/<width>/<height>
       win/<width>/<height>/<bits per pixel>
-        A refreshed (and buffered) [and very slow] Quartz window.
-        The default <bits> is 32, which is the only depth currently supported.
+        A refreshed (and buffered) Quartz window.
       full/<width>/<height>
       full/<width>/<height>/<bits per pixel>
         A CGDirectDisplay full screen mode. <bits> can currently be 8, 16 or 32.
         If not specified, the default is 32. There is currently no way to switch
         between the Mac OS X and Basilisk II display, but Apple-Option-Escape
         instantly and safely terminates the Basilisk II program.
-      opengl/<width>/<height>
-      opengl/<width>/<height>/<bits per pixel>
-        Currently unimplemented, will be a fast windowed mode.
-
 
 seriala <serial port description>
 
@@ -368,7 +362,7 @@ ether <ethernet card description>
 
   Linux:
     The "ethernet card description" is the name of an Ethernet interface.
-    There are two approaches to networking with Basilisk II:
+    There are four approaches to networking with Basilisk II:
 
       1. Direct access to an Ethernet card via the "sheep_net" kernel module.
          The "ethernet card description" must be the name of a real Ethernet
@@ -438,6 +432,66 @@ ether <ethernet card description>
          your network administrator about the nets and zones you can use
          (instead of the ones given in the example above).
 
+      3. Access the network through a "tuntap" interface.
+         The "ethernet card description" must be set to "tun".
+
+         TUN/TAP provides packet reception and transmission for user
+         space programs.  It can be viewed as a simple Point-to-Point
+         or Ethernet device, which instead of receiving packets from a
+         physical media, receives them from user space program and
+         instead of sending packets via physical media writes them to
+         the user space program.
+
+         Prerequesties:
+         - Make sure the "tun" kernel module is loaded
+           # modprobe tun
+         - Make sure IP Fordwarding is enabled on your system
+           # echo 1 >/proc/sys/net/ipv4/ip_forward
+
+         A virtual network configuration script is required and the
+         default is /usr/local/BasiliskII/tunconfig unless you specify
+         a different file with the "etherconfig" item.
+
+         This script requires you that "sudo" is properly configured
+         so that "/sbin/ifconfig" and "/sbin/iptables" can be executed
+         as root. Otherwise, you can still write a helper script which
+         invokes your favorite program to enhance a user priviledges.
+         e.g. in a KDE environment, kdesu can be used as follows:
+
+           #!/bin/sh
+           exec /usr/bin/kdesu -c /path/to/tunconfig $1 $2
+
+      4. Access the network through the user mode network stack.
+         (the code and this documentation come from QEMU)
+
+         By setting the "ethernet card description" to "slirp",
+         Basilisk II uses a completely user mode network stack (you
+         don't need root priviledges to use the virtual network). The
+         virtual network configuration is the following:
+
+           Basilisk II <------> Firewall/DHCP server <-----> Internet
+           (10.0.2.x)      |         (10.0.2.2)
+                           |
+                           ----> DNS server (10.0.2.3)
+                           |
+                           ----> SMB server (10.0.2.4)
+
+         Basilisk II behaves as if it was behind a firewall which
+         blocks all incoming connections. You can use a DHCP client to
+         automatically configure the network in Basilisk II.
+
+         In order to check that the user mode network is working, you
+         can ping the address 10.0.2.2 and verify that you got an
+         address in the range 10.0.2.x from the Basilisk II virtual
+         DHCP server.
+
+         Note that ping is not supported reliably to the internet as
+         it would require root priviledges. It means you can only ping
+         the local router (10.0.2.2).
+
+         When using the built-in TFTP server, the router is also the
+         TFTP server.
+
   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
@@ -450,6 +504,9 @@ ether <ethernet card description>
     not an Ethernet device, Basilisk II will display a warning message and
     disable Ethernet networking.
 
+  Mac OS X:
+    The "slirp" method described above nearly works.
+
   See the next item for an alternative way to do networking with Basilisk II.
 
 udptunnel <"true" or "false">
@@ -530,6 +587,14 @@ nogui <"true" or "false">
   error alerts. All errors will then be reported to stdout. The default
   is "false".
 
+keyboardtype <keyboard-id>
+
+  Specifies the keyboard type that BasiliskII should report to the MacOS.
+  The default is "5" which is a "Apple Extended Keyboard II (ISO)",
+  but many other numbers are understood by most versions of the MacOS
+  (e.g. 11 is a "Macintosh Plus Keyboard with keypad",
+        13 is a "Apple PowerBook Keyboard (ISO)" )
+
 For additional information, consult the source.
 
 
@@ -578,7 +643,14 @@ Unix:
 
     Set this to "true" to ignore illegal memory accesses. The default
     is "false". This feature is only implemented on the following
-    platforms: Linux/x86, Linux/ppc, Darwin/ppc, FreeBSD/x86.
+    platforms: Linux/x86, Linux/ppc, Darwin/ppc.
+
+  dsp <device name>
+  mixer <device name>
+
+    Under Linux and FreeBSD, this specifies the devices to be used for sound
+    output and volume control, respectively. The defaults are "/dev/dsp" and
+    "/dev/mixer".
 
 AmigaOS:
 
@@ -677,6 +749,43 @@ Windows:
     false.
 
 
+JIT-specific configuration
+--------------------------
+
+A Just-In-Time (JIT) translation engine is available for x86. This is
+aimed at translating 68040 instructions to native equivalent code
+sequences, thus providing faster emulation speeds.
+
+  jit <"true" or "false">
+
+    Set this to "true" to enable the JIT compiler. Default value is
+    "true" if the JIT compiler was compiled in. Besides, this is
+    effective only if Basilisk II is configured to emulate a 68040.
+
+  jitfpu <"true" or "false">
+
+    Set this to "true" to enable translation of floating-point (FPU)
+    instructions. Default is "true".
+
+  jitcachesize <size>
+
+    Allocate "size" kilobytes of RAM for the translation cache. The
+    value given will be rounded down to the nearest multiple of a page
+    size. Minimal value is "2048" (2MB). Default value is "8192" (8MB).
+
+  jitlazyflush <"true" or "false">
+
+    Set this to "true" to enable lazy invalidation of the translation
+    cache. This is always recommended as it usually makes the system
+    more responsive and faster, especially while running MacOS
+    8.X. Default value is "true".
+
+  jitdebug <"true" or "false">
+
+    Set this to "true" to enable the JIT debugger. This requires a
+    build of Basilisk II with the cxmon debugger. Default is "false".
+
+
 Usage
 -----
 
@@ -777,7 +886,8 @@ Acknowledgements
 Contributions by (in alphabetical order):
  - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
  - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
-   lots of work on the Unix video code
+   lots of work on the Unix video code, fixes and improvements to the
+   JIT compiler
  - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
  - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
    and networking
@@ -787,9 +897,11 @@ Contributions by (in alphabetical order)
  - 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
+ - Bernie Meyer <bmeyer@csse.monash.edu.au>: original UAE-JIT code
  - Nigel Pearson <nigel@ind.tansu.com.au>: Mac OS X port
  - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
  - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
+ - Michael Z. Sliczniak <msliczniak@comcast.net>: Mach memory fault recovery
  - and others...
 
 Special thanks to: