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.23 by cebix, 2001-07-15T02:15:48Z vs.
Revision 1.36 by gbeauche, 2003-10-12T21:15:51Z

# Line 2 | Line 2
2    Basilisk II
3    A 68k Macintosh emulator
4  
5 <  Copyright (C) 1997-2001 Christian Bauer et al.
5 >  Copyright (C) 1997-2003 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, 10.2
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 511 | Line 524 | nogui <"true" or "false">
524    error alerts. All errors will then be reported to stdout. The default
525    is "false".
526  
527 + keyboardtype <keyboard-id>
528 +
529 +  Specifies the keyboard type that BasiliskII should report to the MacOS.
530 +  The default is "5" which is a "Apple Extended Keyboard II (ISO)",
531 +  but many other numbers are understood by most versions of the MacOS
532 +  (e.g. 11 is a "Macintosh Plus Keyboard with keypad",
533 +        13 is a "Apple PowerBook Keyboard (ISO)" )
534 +
535   For additional information, consult the source.
536  
537  
# Line 555 | Line 576 | Unix:
576      the number of key events sent to MacOS for each wheel movement (the
577      number of lines to scroll).
578  
579 +  ignoresegv <"true" or "false">
580 +
581 +    Set this to "true" to ignore illegal memory accesses. The default
582 +    is "false". This feature is only implemented on the following
583 +    platforms: Linux/x86, Linux/ppc, Darwin/ppc.
584 +
585 +  dsp <device name>
586 +  mixer <device name>
587 +
588 +    Under Linux and FreeBSD, this specifies the devices to be used for sound
589 +    output and volume control, respectively. The defaults are "/dev/dsp" and
590 +    "/dev/mixer".
591 +
592   AmigaOS:
593  
594    sound <sound output description>
# Line 652 | Line 686 | Windows:
686      false.
687  
688  
689 + JIT-specific configuration
690 + --------------------------
691 +
692 + A Just-In-Time (JIT) translation engine is available for x86. This is
693 + aimed at translating 68040 instructions to native equivalent code
694 + sequences, thus providing faster emulation speeds.
695 +
696 +  jit <"true" or "false">
697 +
698 +    Set this to "true" to enable the JIT compiler. Default value is
699 +    "true" if the JIT compiler was compiled in. Besides, this is
700 +    effective only if Basilisk II is configured to emulate a 68040.
701 +
702 +  jitfpu <"true" or "false">
703 +
704 +    Set this to "true" to enable translation of floating-point (FPU)
705 +    instructions. Default is "true".
706 +
707 +  jitcachesize <size>
708 +
709 +    Allocate "size" kilobytes of RAM for the translation cache. The
710 +    value given will be rounded down to the nearest multiple of a page
711 +    size. Minimal value is "2048" (2MB). Default value is "8192" (8MB).
712 +
713 +  jitlazyflush <"true" or "false">
714 +
715 +    Set this to "true" to enable lazy invalidation of the translation
716 +    cache. This is always recommended as it usually makes the system
717 +    more responsive and faster, especially while running MacOS
718 +    8.X. Default value is "true".
719 +
720 +  jitdebug <"true" or "false">
721 +
722 +    Set this to "true" to enable the JIT debugger. This requires a
723 +    build of Basilisk II with the cxmon debugger. Default is "false".
724 +
725 +
726   Usage
727   -----
728  
# Line 752 | Line 823 | Acknowledgements
823   Contributions by (in alphabetical order):
824   - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
825   - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
826 <   lots of work on the Unix video code
826 >   lots of work on the Unix video code, fixes and improvements to the
827 >   JIT compiler
828   - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
829   - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
830     and networking
# Line 762 | Line 834 | Contributions by (in alphabetical order)
834   - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
835   - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
836   - David Lawrence <davidl@jlab.org>: incremental window refresh code
837 + - Bernie Meyer <bmeyer@csse.monash.edu.au>: original UAE-JIT code
838 + - Nigel Pearson <nigel@ind.tansu.com.au>: Mac OS X port
839   - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
840   - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
841 + - Michael Z. Sliczniak <msliczniak@comcast.net>: Mach memory fault recovery
842   - and others...
843  
844   Special thanks to:
# Line 787 | Line 862 | versions of Basilisk II and MacOS being
862   the exact steps to reproduce the bug, etc.):
863    http://sourceforge.net/tracker/?group_id=2123&atid=102123
864  
865 + I also strongly suggest reading this before posting a bug report:
866 +  http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
867 +
868  
869   Author
870   ------
871  
872 < You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
873 < reports, send fixes. Ports to other platforms are also very welcome.
874 < Please contact me before you intend to make major changes to the source.
875 < You might be working on something that I have already done, or I may have
876 < different ideas about the Right Way to do it.
877 <
878 < Questions about ROM files will not be answered. There is also no point in
879 < sending me questions etc. that are specific to the Windows port of
880 < Basilisk II. I don't have Windows and can't say anything about that.
881 < Ask Lauri Pesonen instead.
872 > You can contact me at <Christian.Bauer@uni-mainz.de>, but please don't do
873 > so unless absolutely necessary. I'm maintaining Basilisk II in my spare
874 > time and am not able to provide technical support for everyone. If you have
875 > questions, consider posting them to one of the support forums mentioned
876 > below.
877 >
878 > You are encouraged to contact me personally when
879 > - you have bug fixes or small enhancements for the code
880 > - you want to port Basilisk II to another platform
881 > - you want to discuss technical issues
882 > - you intend to make major changes to the source; you might be working on
883 >   something that I have already done, or I may have different ideas about
884 >   the Right Way to do it
885 >
886 > There is no point in sending me questions about
887 > - ROM files and how/where to get them
888 > - versions of Basilisk II that run on operating systems other than Unix,
889 >   BeOS and AmigaOS. If you are using any other operating system, there's
890 >   no point in asking me how to to X or why Y doesn't work because I won't
891 >   know either. Instead, you should look in the "Acknowledgements" section
892 >   of this manual to find the person responsible. For example, if your
893 >   question is specific to the Windows operating system, ask Lauri Pesonen.
894 >   I don't have Windows and can't answer your questions and I'm too lazy to
895 >   forward mail to Lauri myself. In any case, it would probably be better
896 >   to post your questions to a public forum as it will get a much wider
897 >   audience there.
898  
899  
900   Support
# Line 821 | Line 915 | There is also a mailing list for Basilis
915   And another mailing list for Basilisk II developers:
916    http://lists.sourceforge.net/lists/listinfo/basilisk-devel
917  
918 + Some general advice about asking technical support questions can be found at
919 +  http://www.tuxedo.org/~esr/faqs/smart-questions.html
920 +
921 + Keeping this in mind will greatly increase your chances of getting a useful
922 + answer.
923 +
924  
925   History
926   -------

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines