ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/cebix/BasiliskII/README
(Generate patch)

Comparing BasiliskII/README (file contents):
Revision 1.24 by cebix, 2002-01-15T14:58:31Z vs.
Revision 1.45 by gbeauche, 2008-01-01T09:40:31Z

# Line 2 | Line 2
2    Basilisk II
3    A 68k Macintosh emulator
4  
5 <  Copyright (C) 1997-2002 Christian Bauer et al.
5 >  Copyright (C) 1997-2008 Christian Bauer et al.
6  
7  
8   License
# Line 26 | Line 26 | Basilisk II has currently been ported to
26      IRIX 6.5)
27    - AmigaOS 3.x
28    - Windows NT 4.0 (mostly works under Windows 95/98, too)
29 +  - Mac OS X 10.1 thru 10.4
30  
31   Some features of Basilisk II:
32    - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
# Line 68 | Line 69 | The settings are stored in a text file:
69   BeOS:
70    /boot/home/config/settings/BasiliskII_prefs
71  
72 < Unix:
72 > Unix, Mac OS X:
73    ~/.basilisk_ii_prefs
74  
75   AmigaOS:
# Line 284 | Line 285 | screen <video mode>
285      application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
286      is frozen).
287  
288 +  Mac OS X:
289 +    The "video mode" is one of the following:
290 +      win/<width>/<height>
291 +      win/<width>/<height>/<bits per pixel>
292 +        A refreshed (and buffered) Quartz window.
293 +      full/<width>/<height>
294 +      full/<width>/<height>/<bits per pixel>
295 +        A CGDirectDisplay full screen mode. <bits> can currently be 8, 16 or 32.
296 +        If not specified, the default is 32. There is currently no way to switch
297 +        between the Mac OS X and Basilisk II display, but Apple-Option-Escape
298 +        instantly and safely terminates the Basilisk II program.
299 +
300   seriala <serial port description>
301  
302    This item describes the serial port to be used as Port A (Modem Port)
# Line 349 | Line 362 | ether <ethernet card description>
362  
363    Linux:
364      The "ethernet card description" is the name of an Ethernet interface.
365 <    There are two approaches to networking with Basilisk II:
365 >    There are four approaches to networking with Basilisk II:
366  
367        1. Direct access to an Ethernet card via the "sheep_net" kernel module.
368           The "ethernet card description" must be the name of a real Ethernet
# Line 419 | Line 432 | ether <ethernet card description>
432           your network administrator about the nets and zones you can use
433           (instead of the ones given in the example above).
434  
435 +      3. Access the network through a "tuntap" interface.
436 +         The "ethernet card description" must be set to "tun".
437 +
438 +         TUN/TAP provides packet reception and transmission for user
439 +         space programs.  It can be viewed as a simple Point-to-Point
440 +         or Ethernet device, which instead of receiving packets from a
441 +         physical media, receives them from user space program and
442 +         instead of sending packets via physical media writes them to
443 +         the user space program.
444 +
445 +         Prerequesties:
446 +         - Make sure the "tun" kernel module is loaded
447 +           # modprobe tun
448 +         - Make sure IP Fordwarding is enabled on your system
449 +           # echo 1 >/proc/sys/net/ipv4/ip_forward
450 +
451 +         A virtual network configuration script is required and the
452 +         default is /usr/local/BasiliskII/tunconfig unless you specify
453 +         a different file with the "etherconfig" item.
454 +
455 +         This script requires you that "sudo" is properly configured
456 +         so that "/sbin/ifconfig" and "/sbin/iptables" can be executed
457 +         as root. Otherwise, you can still write a helper script which
458 +         invokes your favorite program to enhance a user priviledges.
459 +         e.g. in a KDE environment, kdesu can be used as follows:
460 +
461 +           #!/bin/sh
462 +           exec /usr/bin/kdesu -c /path/to/tunconfig $1 $2
463 +
464 +      4. Access the network through the user mode network stack.
465 +         (the code and this documentation come from QEMU)
466 +
467 +         By setting the "ethernet card description" to "slirp",
468 +         Basilisk II uses a completely user mode network stack (you
469 +         don't need root priviledges to use the virtual network). The
470 +         virtual network configuration is the following:
471 +
472 +           Basilisk II <------> Firewall/DHCP server <-----> Internet
473 +           (10.0.2.x)      |         (10.0.2.2)
474 +                           |
475 +                           ----> DNS server (10.0.2.3)
476 +                           |
477 +                           ----> SMB server (10.0.2.4)
478 +
479 +         Basilisk II behaves as if it was behind a firewall which
480 +         blocks all incoming connections. You can use a DHCP client to
481 +         automatically configure the network in Basilisk II.
482 +
483 +         In order to check that the user mode network is working, you
484 +         can ping the address 10.0.2.2 and verify that you got an
485 +         address in the range 10.0.2.x from the Basilisk II virtual
486 +         DHCP server.
487 +
488 +         Note that ping is not supported reliably to the internet as
489 +         it would require root priviledges. It means you can only ping
490 +         the local router (10.0.2.2).
491 +
492 +         When using the built-in TFTP server, the router is also the
493 +         TFTP server.
494 +
495    FreeBSD:
496      The "ethertap" method described above also works under FreeBSD, but since
497      no-one has found the time to write a section for this manual, you're on
# Line 431 | Line 504 | ether <ethernet card description>
504      not an Ethernet device, Basilisk II will display a warning message and
505      disable Ethernet networking.
506  
507 +  Mac OS X:
508 +    The "slirp" method described above now seems to work.
509 +
510 +
511    See the next item for an alternative way to do networking with Basilisk II.
512  
513   udptunnel <"true" or "false">
# Line 511 | Line 588 | nogui <"true" or "false">
588    error alerts. All errors will then be reported to stdout. The default
589    is "false".
590  
591 + keyboardtype <keyboard-id>
592 +
593 +  Specifies the keyboard type that BasiliskII should report to the MacOS.
594 +  The default is "5" which is a "Apple Extended Keyboard II (ISO)",
595 +  but many other numbers are understood by most versions of the MacOS
596 +  (e.g. 11 is a "Macintosh Plus Keyboard with keypad",
597 +        13 is a "Apple PowerBook Keyboard (ISO)" )
598 +
599   For additional information, consult the source.
600  
601  
# Line 555 | Line 640 | Unix:
640      the number of key events sent to MacOS for each wheel movement (the
641      number of lines to scroll).
642  
643 +  ignoresegv <"true" or "false">
644 +
645 +    Set this to "true" to ignore illegal memory accesses. The default
646 +    is "false". This feature is only implemented on the following
647 +    platforms: Linux/x86, Linux/ppc, Darwin/ppc.
648 +
649 +  dsp <device name>
650 +  mixer <device name>
651 +
652 +    Under Linux and FreeBSD, this specifies the devices to be used for sound
653 +    output and volume control, respectively. The defaults are "/dev/dsp" and
654 +    "/dev/mixer".
655 +
656   AmigaOS:
657  
658    sound <sound output description>
# Line 652 | Line 750 | Windows:
750      false.
751  
752  
753 + JIT-specific configuration
754 + --------------------------
755 +
756 + A Just-In-Time (JIT) translation engine is available for x86. This is
757 + aimed at translating 68040 instructions to native equivalent code
758 + sequences, thus providing faster emulation speeds.
759 +
760 +  jit <"true" or "false">
761 +
762 +    Set this to "true" to enable the JIT compiler. Default value is
763 +    "true" if the JIT compiler was compiled in. Besides, this is
764 +    effective only if Basilisk II is configured to emulate a 68040.
765 +
766 +  jitfpu <"true" or "false">
767 +
768 +    Set this to "true" to enable translation of floating-point (FPU)
769 +    instructions. Default is "true".
770 +
771 +  jitcachesize <size>
772 +
773 +    Allocate "size" kilobytes of RAM for the translation cache. The
774 +    value given will be rounded down to the nearest multiple of a page
775 +    size. Minimal value is "2048" (2MB). Default value is "8192" (8MB).
776 +
777 +  jitlazyflush <"true" or "false">
778 +
779 +    Set this to "true" to enable lazy invalidation of the translation
780 +    cache. This is always recommended as it usually makes the system
781 +    more responsive and faster, especially while running MacOS
782 +    8.X. Default value is "true".
783 +
784 +  jitdebug <"true" or "false">
785 +
786 +    Set this to "true" to enable the JIT debugger. This requires a
787 +    build of Basilisk II with the cxmon debugger. Default is "false".
788 +
789 +
790   Usage
791   -----
792  
# Line 752 | Line 887 | Acknowledgements
887   Contributions by (in alphabetical order):
888   - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
889   - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
890 <   lots of work on the Unix video code
890 >   lots of work on the Unix video code, fixes and improvements to the
891 >   JIT compiler
892   - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
893   - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
894     and networking
# Line 762 | Line 898 | Contributions by (in alphabetical order)
898   - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
899   - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
900   - David Lawrence <davidl@jlab.org>: incremental window refresh code
901 + - Bernie Meyer <bmeyer@csse.monash.edu.au>: original UAE-JIT code
902 + - Nigel Pearson <nigel@ind.tansu.com.au>: Mac OS X port
903   - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
904   - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
905 + - Michael Z. Sliczniak <msliczniak@comcast.net>: Mach memory fault recovery
906   - and others...
907  
908   Special thanks to:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines