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.32 by gbeauche, 2003-03-14T17:10:47Z

# 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-2002 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
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) [and very slow] Quartz window.
293 +        The default <bits> is 32, which is the only depth currently supported.
294 +      full/<width>/<height>
295 +      full/<width>/<height>/<bits per pixel>
296 +        A CGDirectDisplay full screen mode. <bits> can currently be 8, 16 or 32.
297 +        If not specified, the default is 32. There is currently no way to switch
298 +        between the Mac OS X and Basilisk II display, but Apple-Option-Escape
299 +        instantly and safely terminates the Basilisk II program.
300 +      opengl/<width>/<height>
301 +      opengl/<width>/<height>/<bits per pixel>
302 +        Currently unimplemented, will be a fast windowed mode.
303 +
304   seriala <serial port description>
305  
306    This item describes the serial port to be used as Port A (Modem Port)
# Line 555 | Line 572 | Unix:
572      the number of key events sent to MacOS for each wheel movement (the
573      number of lines to scroll).
574  
575 +  ignoresegv <"true" or "false">
576 +
577 +    Set this to "true" to ignore illegal memory accesses. The default
578 +    is "false". This feature is only implemented on the following
579 +    platforms: Linux/x86, Linux/ppc, Darwin/ppc.
580 +
581 +  dsp <device name>
582 +  mixer <device name>
583 +
584 +    Under Linux and FreeBSD, this specifies the devices to be used for sound
585 +    output and volume control, respectively. The defaults are "/dev/dsp" and
586 +    "/dev/mixer".
587 +
588   AmigaOS:
589  
590    sound <sound output description>
# Line 652 | Line 682 | Windows:
682      false.
683  
684  
685 + JIT-specific configuration
686 + --------------------------
687 +
688 + A Just-In-Time (JIT) translation engine is available for x86. This is
689 + aimed at translating 68040 instructions to native equivalent code
690 + sequences, thus providing faster emulation speeds.
691 +
692 +  jit <"true" or "false">
693 +
694 +    Set this to "true" to enable the JIT compiler. Default value is
695 +    "true" if the JIT compiler was compiled in. Besides, this is
696 +    effective only if Basilisk II is configured to emulate a 68040.
697 +
698 +  jitfpu <"true" or "false">
699 +
700 +    Set this to "true" to enable translation of floating-point (FPU)
701 +    instructions. Default is "true".
702 +
703 +  jitcachesize <size>
704 +
705 +    Allocate "size" kilobytes of RAM for the translation cache. The
706 +    value given will be rounded down to the nearest multiple of a page
707 +    size. Minimal value is "2048" (2MB). Default value is "8192" (8MB).
708 +
709 +  jitlazyflush <"true" or "false">
710 +
711 +    Set this to "true" to enable lazy invalidation of the translation
712 +    cache. This is always recommended as it usually makes the system
713 +    more responsive and faster, especially while running MacOS
714 +    8.X. Default value is "true".
715 +
716 +  jitdebug <"true" or "false">
717 +
718 +    Set this to "true" to enable the JIT debugger. This requires a
719 +    build of Basilisk II with the cxmon debugger. Default is "false".
720 +
721 +
722   Usage
723   -----
724  
# Line 752 | Line 819 | Acknowledgements
819   Contributions by (in alphabetical order):
820   - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
821   - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
822 <   lots of work on the Unix video code
822 >   lots of work on the Unix video code, fixes and improvements to the
823 >   JIT compiler
824   - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
825   - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
826     and networking
# Line 762 | Line 830 | Contributions by (in alphabetical order)
830   - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
831   - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
832   - David Lawrence <davidl@jlab.org>: incremental window refresh code
833 + - Bernier Meyer <bmeyer@csse.monash.edu.au>: original UAE-JIT code
834 + - Nigel Pearson <nigel@ind.tansu.com.au>: Mac OS X port
835   - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
836   - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
837   - and others...
# Line 787 | Line 857 | versions of Basilisk II and MacOS being
857   the exact steps to reproduce the bug, etc.):
858    http://sourceforge.net/tracker/?group_id=2123&atid=102123
859  
860 + I also strongly suggest reading this before posting a bug report:
861 +  http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
862 +
863  
864   Author
865   ------
866  
867 < You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
868 < reports, send fixes. Ports to other platforms are also very welcome.
869 < Please contact me before you intend to make major changes to the source.
870 < You might be working on something that I have already done, or I may have
871 < different ideas about the Right Way to do it.
872 <
873 < Questions about ROM files will not be answered. There is also no point in
874 < sending me questions etc. that are specific to the Windows port of
875 < Basilisk II. I don't have Windows and can't say anything about that.
876 < Ask Lauri Pesonen instead.
867 > You can contact me at <Christian.Bauer@uni-mainz.de>, but please don't do
868 > so unless absolutely necessary. I'm maintaining Basilisk II in my spare
869 > time and am not able to provide technical support for everyone. If you have
870 > questions, consider posting them to one of the support forums mentioned
871 > below.
872 >
873 > You are encouraged to contact me personally when
874 > - you have bug fixes or small enhancements for the code
875 > - you want to port Basilisk II to another platform
876 > - you want to discuss technical issues
877 > - you intend to make major changes to the source; you might be working on
878 >   something that I have already done, or I may have different ideas about
879 >   the Right Way to do it
880 >
881 > There is no point in sending me questions about
882 > - ROM files and how/where to get them
883 > - versions of Basilisk II that run on operating systems other than Unix,
884 >   BeOS and AmigaOS. If you are using any other operating system, there's
885 >   no point in asking me how to to X or why Y doesn't work because I won't
886 >   know either. Instead, you should look in the "Acknowledgements" section
887 >   of this manual to find the person responsible. For example, if your
888 >   question is specific to the Windows operating system, ask Lauri Pesonen.
889 >   I don't have Windows and can't answer your questions and I'm too lazy to
890 >   forward mail to Lauri myself. In any case, it would probably be better
891 >   to post your questions to a public forum as it will get a much wider
892 >   audience there.
893  
894  
895   Support
# Line 821 | Line 910 | There is also a mailing list for Basilis
910   And another mailing list for Basilisk II developers:
911    http://lists.sourceforge.net/lists/listinfo/basilisk-devel
912  
913 + Some general advice about asking technical support questions can be found at
914 +  http://www.tuxedo.org/~esr/faqs/smart-questions.html
915 +
916 + Keeping this in mind will greatly increase your chances of getting a useful
917 + answer.
918 +
919  
920   History
921   -------

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines