--- BasiliskII/README	2001/07/15 02:15:48	1.23
+++ BasiliskII/README	2005/12/29 13:06:12	1.43
@@ -2,7 +2,7 @@
   Basilisk II
   A 68k Macintosh emulator
 
-  Copyright (C) 1997-2001 Christian Bauer et al.
+  Copyright (C) 1997-2005 Christian Bauer et al.
 
 
 License
@@ -26,6 +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, 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)
@@ -68,7 +69,7 @@ The settings are stored in a text file:
 BeOS:
   /boot/home/config/settings/BasiliskII_prefs
 
-Unix:
+Unix, Mac OS X:
   ~/.basilisk_ii_prefs
 
 AmigaOS:
@@ -284,6 +285,18 @@ 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) 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.
+
 seriala <serial port description>
 
   This item describes the serial port to be used as Port A (Modem Port)
@@ -349,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
@@ -419,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
@@ -431,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 now seems to work.
+
   See the next item for an alternative way to do networking with Basilisk II.
 
 udptunnel <"true" or "false">
@@ -511,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.
 
 
@@ -555,6 +639,19 @@ Unix:
     the number of key events sent to MacOS for each wheel movement (the
     number of lines to scroll).
 
+  ignoresegv <"true" or "false">
+
+    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.
+
+  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:
 
   sound <sound output description>
@@ -652,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
 -----
 
@@ -752,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
@@ -762,8 +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:
@@ -787,20 +925,39 @@ versions of Basilisk II and MacOS being
 the exact steps to reproduce the bug, etc.):
   http://sourceforge.net/tracker/?group_id=2123&atid=102123
 
+I also strongly suggest reading this before posting a bug report:
+  http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
+
 
 Author
 ------
 
-You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
-reports, send fixes. Ports to other platforms are also very welcome.
-Please contact me before you intend to make major changes to the source.
-You might be working on something that I have already done, or I may have
-different ideas about the Right Way to do it.
-
-Questions about ROM files will not be answered. There is also no point in
-sending me questions etc. that are specific to the Windows port of
-Basilisk II. I don't have Windows and can't say anything about that.
-Ask Lauri Pesonen instead.
+You can contact me at <Christian.Bauer@uni-mainz.de>, but please don't do
+so unless absolutely necessary. I'm maintaining Basilisk II in my spare
+time and am not able to provide technical support for everyone. If you have
+questions, consider posting them to one of the support forums mentioned
+below.
+
+You are encouraged to contact me personally when
+ - you have bug fixes or small enhancements for the code
+ - you want to port Basilisk II to another platform
+ - you want to discuss technical issues
+ - you intend to make major changes to the source; you might be working on
+   something that I have already done, or I may have different ideas about
+   the Right Way to do it
+
+There is no point in sending me questions about
+ - ROM files and how/where to get them
+ - versions of Basilisk II that run on operating systems other than Unix,
+   BeOS and AmigaOS. If you are using any other operating system, there's
+   no point in asking me how to to X or why Y doesn't work because I won't
+   know either. Instead, you should look in the "Acknowledgements" section
+   of this manual to find the person responsible. For example, if your
+   question is specific to the Windows operating system, ask Lauri Pesonen.
+   I don't have Windows and can't answer your questions and I'm too lazy to
+   forward mail to Lauri myself. In any case, it would probably be better
+   to post your questions to a public forum as it will get a much wider
+   audience there.
 
 
 Support
@@ -821,6 +978,12 @@ There is also a mailing list for Basilis
 And another mailing list for Basilisk II developers:
   http://lists.sourceforge.net/lists/listinfo/basilisk-devel
 
+Some general advice about asking technical support questions can be found at
+  http://www.tuxedo.org/~esr/faqs/smart-questions.html
+
+Keeping this in mind will greatly increase your chances of getting a useful
+answer.
+
 
 History
 -------