ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/cebix/BasiliskII/README
Revision: 1.11
Committed: 2000-07-06T16:04:23Z (23 years, 10 months ago) by cebix
Branch: MAIN
Changes since 1.10: +5 -5 lines
Log Message:
- AmigaOS: added CyberGraphX support

File Contents

# User Rev Content
1 cebix 1.1
2 cebix 1.7 Basilisk II, Version 0.8
3 cebix 1.1 A free, portable Mac II emulator
4    
5 cebix 1.10 Copyright (C) 1997-2000 Christian Bauer et al.
6 cebix 1.1 Freely distributable
7    
8    
9     License
10     -------
11    
12     Basilisk II is available under the terms of the GNU General Public License.
13 cebix 1.3 See the file "COPYING" that is included in the distribution for details.
14 cebix 1.1
15    
16     Overview
17     --------
18    
19     Basilisk II is a free, portable, Open Source 68k Mac emulator. It requires
20     a copy of a Mac ROM and a copy of MacOS to run. Basilisk II is freeware and
21     distributed under the GNU General Public License.
22    
23     Basilisk II has currently been ported to the following systems:
24     - BeOS R4 (PowerPC and x86)
25     - Unix (tested under Linux, Solaris 2.5, FreeBSD 3.x and IRIX 6.5)
26     - AmigaOS 3.x
27     - Windows NT 4.0 (mostly works under Windows 95/98, too)
28    
29     Some features of Basilisk II:
30     - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
31     or a Mac II series machine (which runs MacOS 7.x, 8.0 and 8.1),
32     depending on the ROM being used
33     - Color video display
34     - CD quality sound output
35     - Floppy disk driver (only 1.44MB disks supported)
36     - Driver for HFS partitions and hardfiles
37     - CD-ROM driver with basic audio functions
38 cebix 1.7 - Easy file exchange with the host OS via a "Host Directory Tree" icon
39     on the Mac desktop
40 cebix 1.1 - Ethernet driver
41     - Serial drivers
42     - SCSI Manager (old-style) emulation
43     - Emulates extended ADB keyboard and 3-button mouse
44     - Uses UAE 68k emulation or (under AmigaOS) real 68k processor
45    
46     The emulator is not yet complete. See the file "TODO" for a list of
47     unimplemented stuff.
48    
49    
50 cebix 1.3 Requirements and Installation
51     -----------------------------
52 cebix 1.1
53 cebix 1.3 Please consult the file "INSTALL" for a list of system requirements and
54     installation instructions.
55 cebix 1.1
56    
57     Configuration
58     -------------
59    
60     Basilisk II is configured via the preferences editor that appears on startup.
61     If you have a version without preferences editor (e.g. because of missing GTK+
62     under Unix), you have to edit the preferences file manually.
63    
64     The settings are stored in a text file:
65    
66     BeOS:
67     /boot/home/config/settings/BasiliskII_prefs
68    
69     Unix:
70     ~/.basilisk_ii_prefs
71    
72     AmigaOS:
73     ENV:BasiliskII_prefs
74    
75     Windows:
76     BasiliskII_prefs (in the same directory as the executable)
77    
78     If no preferences file is present, Basilisk II will create one with the
79     default settings upon startup.
80    
81    
82     Preferences File Format
83     -----------------------
84    
85     The preferences file is a text file editable with any text editor.
86     Each line in this file has the format "keyword value" and describes
87     one preferences item. For each keyword, the meaning of the "value"
88     string may vary across platforms. The following keywords exist:
89    
90     disk <volume description>
91    
92     This item describes one MacOS volume to be mounted by Basilisk II.
93     There can be multiple "disk" lines in the preferences file. Basilisk II
94     can handle hardfiles (byte-per-byte images of HFS volumes in a file on
95     the host system) as well as HFS partitions on hard disks etc. (but Basilisk
96     II doesn't know about MacOS partition tables; it relies on the host OS to
97     handle this). The "volume description" is either the pathname of a hardfile
98     or a platform-dependant description of an HFS partition or drive. If the
99     volume description starts with an asterisk ("*"), the volume is write
100     protected for MacOS (and the "*" is discarded).
101    
102     BeOS:
103     To specify an HFS partition, simply specify its path (e.g.
104     "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volume, Basilisk II
105     will search for and use all available HFS partitions.
106    
107     Unix:
108     To specify an HFS partition, simply specify its path (e.g.
109     "/dev/sda5").
110    
111     AmigaOS:
112     Partitions/drives are specified in the following format:
113     /dev/<device name>/<unit>/<open flags>/<start block>/<size>/<block size>
114     "start block" and "size" are given in blocks, "block size" is given in
115     bytes.
116    
117     Windows:
118     To define a logical volume (Windows NT only), specify its path (e.g. "c:\").
119     To define a physical volume (NT and 9x), additionally give the "physical"
120     keyword (E.g. "physical c:\"). For safety reasons, volumes are mounted as
121     read-only. This is due to the bugs in PC Exchange. If you don't specify
122     any volume, the files *.hfv and *.dsk are searched from the current
123     directory. Note that in this case, Basilisk II tries to boot from the first
124     volume file found, which is random and may not be what you want.
125    
126     floppy <floppy drive description>
127    
128     This item describes one floppy drive to be used by Basilisk II. There
129     can be multiple "floppy" lines in the preferences file. If no "floppy"
130     line is given, Basilisk II will try to automatically detect and use
131     installed floppy drives. The format of the "floppy drive description"
132     is the same as that of "disk" lines.
133    
134     cdrom <CD-ROM drive description>
135    
136     This item describes one CD-ROM drive to be used by Basilisk II. There
137     can be multiple "cdrom" lines in the preferences file. If no "cdrom"
138     line is given, Basilisk II will try to automatically detect and use
139     installed CD-ROM drives. The format of the "CD-ROM drive description"
140     is the same as that of "disk" lines.
141    
142 cebix 1.7 extfs <direcory path>
143    
144     This item specifies the root directory for the "Host Directory Tree"
145     file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
146     All objects contained in that directory are accessible by Mac applications.
147     This feature is only available when File System Manager V1.2 or later
148     is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
149     and can be installed as a system extension (downloadable from Apple, look
150     for the FSM SDK in the developer section) for earlier MacOS versions.
151    
152 cebix 1.1 scsi0 <SCSI target> ... scsi6 <SCSI target>
153    
154     These items describe the SCSI target to be used for a given Mac SCSI
155     ID by Basilisk II. Basilisk II emulates the old SCSI Manager and allows
156     to assign a different SCSI target (they don't even have to be on the
157     same SCSI bus) for each SCSI ID (0..6) as seen by the MacOS. "scsi0"
158     describes the target for ID 0, "scsi1" the target for ID 1 etc.
159     The format of the "SCSI target" is platform specific.
160    
161     BeOS:
162     The "SCSI target" has the format "<bus>/<unit>" (e.g. "0/2").
163     Due to a bug in BeOS, using SCSI with Basilisk II may cause the
164     SCSI bus to hang. Use with caution.
165    
166     Linux:
167     The "SCSI target" has to be the name of a device that complies to
168     the Generic SCSI driver API. On a standard Linux installation, these
169     devices are "/dev/sg0", "/dev/sg1" etc. Note that you must have
170     appropriate access rights to these devices and that Generic SCSI
171     support has to be compiled into the kernel.
172    
173     FreeBSD:
174     The "SCSI target" has the format "<id>/<lun>" (e.g. "2/0").
175    
176     AmigaOS:
177     The "SCSI target" has the format "<device name>/<unit>" (e.g.
178     "scsi.device/2").
179    
180     Windows:
181 cebix 1.5 The "SCSI target" has the format <"Vendor"> <"Model"> (e.g.
182     scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes.
183 cebix 1.1
184     screen <video mode>
185    
186     This item describes the type of video display to be used by Basilisk II.
187     If you are using a Mac Classic ROM, the display is always 1-bit 512x342
188     and this item is ignored. The format of the "video mode" is platform
189     specific.
190    
191     BeOS:
192     The "video mode" is one of the following:
193     win/<width>/<height>
194     8-bit color display in a window of the given size. This is the
195     default.
196     scr/<mode>
197     Full-screen display in BWindowScreen. <mode> is the bit number of
198     the video mode to use (see headers/be/interface/GraphicsDefs.h).
199     E.g. 0 = 640x480x8, 1 = 800x600x8 etc., 10 = 640x480x24,
200     11 = 800x600x24 etc., 18 = 640x480x15, 19 = 800x600x15 etc.
201     15 bit modes are preferable to 16 bit modes (which may show false
202     colors on PowerPC machines).
203     When you run in full-screen mode and switch to another Workspace,
204     Basilisk II is put in "suspend" mode (i.e. MacOS will be frozen).
205    
206     Unix:
207     The "video mode" is one of the following:
208     win/<width>/<height>
209     Color display in an X11 window of the given size. The color depth
210     (8/15/24 bit) depends on the depth of the underlying X11 screen.
211     This is the default.
212 cebix 1.4 dga/<width>/<height>
213 cebix 1.7 [if Basilisk II was configured with --enable-xf86-dga]
214     Full-screen display using the XFree86 DGA extension. The color depth
215 cebix 1.1 (8/15/24 bit) depends on the depth of the underlying X11 screen.
216 cebix 1.4 "width" and "height" specify the maximum width/height to use.
217 cebix 1.7 Saying "dga/0/0" means "complete screen".
218     dga/<frame buffer name>
219     [if Basilisk II was configured with --enable-fbdev-dga]
220     Full-screen display using the frame buffer device /dev/fb. The color
221     depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
222     The "frame buffer name" is looked up in the "fbdevices" file (whose
223     path can be specified with the "fbdevicefile" prefs item) to determine
224     certain characteristics of the device (doing a "ls -l /dev/fb" should
225     tell you what your frame buffer name is).
226 cebix 1.1
227     AmigaOS:
228     The "video mode" is one of the following:
229     win/<width>/<height>
230     Black-and-white display in a window of the given size on the
231     Workbench screen. This is the default and will also be used when
232     one of the other options (PIP/screen) fails to open.
233     pip/<width>/<height>
234     15-bit truecolor display in a Picasso96 PIP. This requires
235     Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
236     scr/<hexadecimal mode ID>
237 cebix 1.11 8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
238     the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
239     24 bit, the frame buffer format must be QuickDraw-compatible
240     (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
241     the default size for that mode ID.
242 cebix 1.1
243     Windows:
244     The "video mode" is one of the following:
245     win/<width>/<height>/<bits per pixel>
246     A refreshed screen mode that uses Windows GDI calls to write to the
247     screen. You may have other windows on top of Basilisk II.
248     dx/<width>/<height>/<bits per pixel>
249     A refreshed DirectX mode (minimum version 5.0). There are ways to
250     install DirectX 5 on NT 4. Some new display adapters work fine even
251     with DirectX 3.
252     fb/<width>/<height>/<bits per pixel>
253     A non-refreshed video mode that works only on NT. It accesses the
254     linear frame buffer directly (best performance of all three modes).
255     Use the hotkey Control-Shift-F12 to switch between Windows and Mac
256     displays. Fast task switch (Alt-Tab) and Explorer start menu
257     (Control-Esc) are disabled, Control-Alt-Del is enabled.
258     <width> and <height> can be either zeroes (uses current screen values),
259     or something else. "win" mode can use almost anything, for other modes
260     there must be a corresponding DirectX mode.
261     <bits> is ignored for mode "win" (uses current screen values).
262     If the mode is "win" and the dimensions are different than the desktop
263     dimensions, windowed mode is used. The window can be moved around by
264     dragging with the right mouse button. This mode remembers window positions
265     separately for different dimensions.
266     The supported values are 8,15,16,24,32. It is possible that some of them
267     do not work for you. In particular, it may be that only one of the
268     two modes, 15 and 16, is suitable for your card. You need to find out
269     the best solution by experimenting.
270     Basilisk II checks what display mode you are currently running and uses
271     that mode. The screen is always full screen. When you switch to another
272     application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
273     is frozen).
274    
275     seriala <serial port description>
276    
277     This item describes the serial port to be used as Port A (Modem Port)
278     by Basilisk II. If no "seriala" line is given, Basilisk II will try to
279     automatically detect and use installed serial ports. The "serial port
280     description" is a platform-dependant description of a serial port.
281    
282     BeOS:
283     Either specify the name of a serial port (e.g. "serial1") or one of
284     "parallel1", "parallel2" or "parallel3". See below for more information
285     about parallel ports.
286    
287     Unix:
288     Specify the device name of a serial port (e.g. "/dev/ttyS0") or a
289     parallel "lp" port (e.g. "/dev/lp1"; this only works under Linux and
290     FreeBSD). See below for more information about parallel ports.
291    
292     AmigaOS:
293     You have to specify the name of the serial device and the device unit
294     as "<device name>/<unit>" (e.g. "serial.device/0"). If the given device
295     is not compatible to serial.device, Basilisk II will crash. If the
296     device name starts with an asterisk (e.g. "*parallel.device/0"), the
297     device is treated as a parallel.device compatible device. See below for
298     more information about parallel ports.
299    
300     Windows:
301     Specify "COM1" or "COM2" for com port 1 or 2, respectively.
302    
303     Parallel ports: If you select a parallel port it will look like a serial
304     port to MacOS but Basilisk II will only allow data output and ignore baud
305     rate settings etc. You should be able to get some printers to work with
306     this method (provided that you have the right printer driver, like
307     "Power Print" (see www.gdt.com)).
308    
309     serialb <serial port description>
310    
311     This item describes the serial port to be used as Port B (Printer Port)
312     by Basilisk II. If no "serialb" line is given, Basilisk II will try to
313     automatically detect and use installed serial ports. The format of the
314     "serial port description" is the same as that of the "seriala" option.
315    
316     ether <ethernet card description>
317    
318     This item describes the Ethernet card to be used for Ethernet networking
319     by Basilisk II. If no "ether" line is given, Ethernet networking is disabled
320     (although the Ethernet driver of Basilisk II will behave like a "dummy"
321     Ethernet card in this case). If you are using a Mac Classic ROM, Ethernet
322     is not available and this setting is ignored. The "ethernet card description"
323     is a platform-dependant description of an ethernet card.
324    
325     BeOS:
326     It doesn't matter what you give as "ethernet card description", Basilisk II
327     will always use the first Ethernet card it finds as long an an "ether"
328     line exists (e.g. say "ether yes"). As Basilisk II requires the sheep_net
329     net server add-on from SheepShaver, you can only use Ethernet on PowerPC
330     machines.
331    
332     Linux:
333     The "ethernet card description" is the name of an Ethernet interface.
334     There are two approaches to networking with Basilisk II:
335 cebix 1.8
336 cebix 1.1 1. Direct access to an Ethernet card via the "sheep_net" driver.
337     In this case, the "ethernet card description" must be the name
338     of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net"
339     driver to be installed and accessible. This approach will allow you
340     to run all networking protocols under MacOS (TCP/IP, AppleTalk, IPX
341     etc.) but there is no connection between Linux networking and MacOS
342     networking. MacOS will only be able to talk to other machines on
343     the Ethernet, but not to other networks that your Linux box routes
344     (e.g. a second Ethernet or a PPP connection to the Internet).
345 cebix 1.8
346 cebix 1.1 2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
347     In this case, the "ethernet card description" must be the name
348     of an ethertap interface, e.g. "tap0". It also requires that you
349     configure your kernel to enable routing and the ethertap device:
350     under "Networking options", enable "Kernel/User netlink socket" and
351     "Netlink device emulation", under "Network device support", activate
352 cebix 1.8 "Ethertap network tap". You also have to modify devices/net/ethertap.c
353     a bit before compiling the new kernel:
354    
355     - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
356     #include lines)
357     - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
358    
359     Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
360     information on how to set up /dev/tap* device nodes and activate the
361     ethertap interface. Under MacOS, select an IP address that is on the
362     virtual network and set the default gateway to the IP address of the
363     ethertap interface. This approach will let you access all networks
364     that your Linux box has access to (especially, if your Linux box has
365     a dial-up Internet connection and is configured for IP masquerading,
366     you can access the Internet from MacOS). The drawback is that you
367     can only use network protocols that Linux can route, so you have to
368     install and configure netatalk if you want to use AppleTalk. Here is
369     an example /etc/atalk/atalkd.conf for a LAN:
370    
371     eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
372     tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
373    
374     (the "47" is an arbitrary node number). This will set up a zone
375     "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
376     for the internal network connection of the ethertap interface.
377     MacOS should automatically recognize the nets and zones upon startup.
378     If you are in an existing AppleTalk network, you should contact
379     your network administrator about the nets and zones you can use
380     (instead of the ones given in the example above).
381 cebix 1.1
382     AmigaOS:
383     You have to specify the name of the SANA-II Ethernet device and the device
384     unit as "<device name>/<unit>" (e.g. "ariadne.device/0"). If the given
385     device is not a SANA-II device, Basilisk II will crash. If the device is
386     not an Ethernet device, Basilisk II will display a warning message and
387     disable Ethernet networking.
388    
389     rom <ROM file path>
390    
391     This item specifies the file name of the Mac ROM file to be used by
392     Basilisk II. If no "rom" line is given, the ROM file has to be named
393     "ROM" and put in the same directory as the Basilisk II executable.
394    
395     bootdrive <drive number>
396    
397     Specify MacOS drive number of boot volume. "0" (the default) means
398     "boot from first bootable volume".
399    
400     bootdriver <driver number>
401    
402     Specify MacOS driver number of boot volume. "0" (the default) means
403     "boot from first bootable volume". Use "-62" to boot from CD-ROM.
404    
405     ramsize <bytes>
406    
407     Allocate "bytes" bytes of RAM for MacOS system and application memory.
408     The value given will be rounded down to the nearest multiple of 1MB.
409     If you are using a Mac Classic ROM, the maximum available value is 4MB
410     and higher values will be ignored. The default is 8MB.
411    
412     frameskip <frames to skip>
413    
414     For refreshed graphics modes (usually window modes), this specifies
415     how many frames to skip after drawing one frame. Higher values make
416     the video display more responsive but require more processing power.
417     The default is "8".
418    
419     modelid <MacOS model ID>
420    
421     Specifies the Model ID that Basilisk II should report to MacOS.
422     The default is "5" which corresponds to a Mac IIci. If you want to
423     run MacOS 8, you have to set this to "14" (Quadra 900). Other values
424     are not officially supported and may result in crashes. MacOS versions
425     earlier than 7.5 may only run with the Model ID set to "5". If you are
426     using a Mac Classic ROM, the model is always "Mac Classic" and this
427     setting is ignored.
428    
429     nosound <"true" or "false">
430    
431     Set this to "true" to disable all sound output. This is useful if the
432     sound takes too much CPU time on your machine or to get rid of warning
433     messages if Basilisk II can't use your audio hardware.
434    
435     nocdrom <"true" or "false">
436    
437     Set this to "true" to disable Basilisk's built-in CD-ROM driver.
438     The only reason to do this is if you want to use a third-party CD-ROM
439     driver that uses the SCSI Manager. The default is "false".
440    
441     nogui <"true" or "false">
442    
443     Set this to "true" to disable the GUI preferences editor and GUI
444     error alerts. All errors will then be reported to stdout. The default
445     is "false".
446    
447     For additional information, consult the source.
448    
449    
450     System-specific configuration
451     -----------------------------
452    
453     Unix:
454    
455     keycodes <"true" or "false">
456 cebix 1.7 keycodefile <keycodes file path>
457 cebix 1.1
458     By default, the X11 event handler in Basilisk II uses KeySyms to
459     translate keyboard event to Mac keycodes. While this method is very
460     compatible and ought to work with all X servers, it only works well
461     if your keyboard has a US layout. If you set "keycodes" to "true",
462     Basilisk II will use raw keycodes instead of KeySyms. The keycode
463     depends only on the physical location of a key on the keyboard and
464     not on the selected keymap. Unfortunately it depends on the X server
465     being used and possibly also on the type of keyboard attached. So
466     Basilisk II needs a table to translate X keycodes to Mac keycodes.
467 cebix 1.7 This table is read by default from /usr/local/share/BasiliskII/keycodes
468 cebix 1.1 unless you specify a different file with the "keycodefile" item.
469 cebix 1.7 A sample keycode file is included with Basilisk II.
470    
471     fbdevicefile <fbdevices file path>
472    
473     This option specifies the file that contains frame buffer device
474     specifications for the fbdev-DGA video mode (when Basilisk II was
475     configured with --enable-fbdev-dga). The default location of the file
476     is /usr/local/share/BasiliskII/fbdevices. A sample file is included
477     with Basilisk II.
478 cebix 1.1
479     AmigaOS:
480    
481     sound <sound output description>
482    
483     This item specifies what method to use for sound output. The only choice
484     is currently AHI, but you can specify the AHI mode ID to be used. The
485     "sound output description" looks like this:
486    
487     ahi/<hexadecimal mode ID>
488    
489     Windows:
490    
491     noscsi <"true" or "false">
492    
493     Completely disables SCSI Manager support when set to "true".
494     Note that currently all SCSI operations are executed synchronously,
495     even if Mac application has requested asynchronous operation. What this
496     means is that the control is not returned to the application until the
497     command is completely finished. Normally this is not an issue, but when a
498     CDR/CDRW is closed or erased the burner program typically wants to wait in
499     some progress dialog The result may be that the application reports a
500     time-out error, but the operation completes all right anyway.
501    
502     nofloppyboot <"true" or "false">
503    
504     Set this to "true" to disable booting from a floppy.
505    
506     replacescsi <"Vendor1"> <"Model1"> <"Vendor2"> <"Model2">
507    
508     This command tricks the Mac to believe that you have a SCSI device Model2
509     from vendor Vendor2, although your real hardware is Model1 from Vendor1.
510     This is very useful since many devices have almost identical ATAPI and SCSI
511     versions of their hardware, and MacOS applications usually support the SCSI
512     version only. The example below is typical:
513    
514     replacescsi "HP" "CD-Writer+ 7100" "PHILIPS" "CDD3600"
515    
516     Note the use of quotes.
517    
518 cebix 1.5 rightmouse <0/1>
519 cebix 1.1
520 cebix 1.5 Defines what the right mouse button is used for. The default values of 0
521     means that it is used to move windowed mode BasiliskII screen.
522     Value 1 sends a combination Control and mouse click to the MacOS.
523     This may be useful under OS versions 8 and above.
524 cebix 1.1
525 cebix 1.5 keyboardfile <path>
526    
527     Defines the path of the customized keyboard code file.
528    
529     pollmedia <"true" or "false">
530    
531     If true (default), tries to automatically detect new media.
532     Applies to all "floppy", "cd" or "disk" removable media except
533     1.44 MB floppies. May cause modest slow down. If unchecked,
534     use Ctrl-Shift-F11 to manually mount new media.
535     If you have auto-insert notification (AIN) enabled, you may turn this
536     option off. Note that some CD related software require AIN,
537     and some other need it to be turned off. Consult the documentation
538     of your CD software to learn which one is optimal for you.
539    
540     framesleepticks <milliseconds>
541    
542     The amount of time between video frames.
543    
544     showfps <true/false>
545    
546     If true, the real frame rate is displayed.
547    
548     stickymenu <true/false>
549    
550     If true, the main menu bar is kept open even after the mouse button is released,
551     under all OS versions (OS 8 has this feature already). There are extensions to do
552     the same thing, but it's faster to handle this in native code.
553     Default is "true".
554 cebix 1.1
555     ntdx5hack <"true" or "false">
556    
557     You may need this on NT if your display adapter driver has a bug in DirectX
558     palette support. Black and white are reversed. It fixes the palette issue
559     by using GDI palette instead of D3D palette. Default is false.
560    
561    
562     Usage
563     -----
564    
565     Quitting:
566     The right way to quit Basilisk II is to select the "Shut Down" menu item
567     from the Finder's "Special" menu. You should not kill it from the shell
568     unless it hangs. Under Unix, pressing "Esc" while holding the Ctrl key will
569     also quit Basilisk II (in case you are using it in DGA mode and it crashed).
570     Under Windows, try Alt-F4 (or Control-Alt-Del to log off and back on again
571     if it crashes really badly).
572    
573     Suspending:
574     The Unix version of Basilisk II can be suspended while running in DGA mode
575     by pressing "Tab" while holding the Ctrl key. Pressing "Space" in the
576     "suspended" window will resume the emulation. Under BeOS, switching to
577     a different Workspace when BasiliskII is in full-screen mode will also
578     suspend the emulation.
579    
580     Keyboard:
581     On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
582     key is the Mac "Option" key.
583    
584     Floppy:
585     Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
586     flopyy disk changes might not be detected automatically. Under Linux, press
587     Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
588     item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
589    
590     HFS partitions:
591     Having HFS partitions mounted for read-write access under Basilisk II while
592     they are also mounted on the host OS will most likely result in volume
593     corruption and data losses. Unmount your HFS volumes before starting
594     Basilisk II.
595    
596     ZIP drives:
597     Iomega ZIP disks can be mounted either with the "disk" prefs item or (on
598     platforms that support the SCSI Manager emulation of Basilisk II) by
599     installing the IomegaWare on the Mac side. Do not use both ways
600     simultaneously!
601    
602     Hardfiles:
603     In addition to plain images of HFS volumes, Basilisk II can also handle
604     some types of Mac "disk image" files, as long as they are uncompressed
605     and unencoded.
606    
607     Mac Classic emulation:
608     Sound output and Ethernet are not supported if you are using a Mac Classic
609     ROM. Also, the video display is fixed to 512x342 in monochrome. The AmigaOS
610     and BeOS/PPC versions of Basilisk II cannot do Mac Classic emulation.
611    
612     Sound output:
613     Sound output under Basilisk II requires Sound Manager 3.0 or later. This
614     is included starting with MacOS 7.5 and available as a system extension
615     for earlier MacOS versions. Sample rate, bit resolution and mono/stereo
616     can be selected in the Sound control panel (section "Sound Out").
617    
618     Ethernet:
619     Basilisk II supports all Ethernet protocols. Running a protocol under
620     Basilisk II that already runs within the host operating system on the same
621     network card (e.g. running MacTCP under Basilisk II on a BeOS machine) may
622     or may not work (generally, it should work, but some specific things like
623     "ping" may not). If you have problems with FTP, try setting your FTP client
624     to passive mode.
625    
626     LocalTalk:
627     LocalTalk is not supported by Basilisk II. There is no way of getting
628     LocalTalk to work with the serial drivers of Basilisk II. Any attempt to
629     activate LocalTalk will either result in a crash or revert to Ethernet.
630    
631     Serial:
632     You can use the serial ports in Basilisk II to connect to the Internet
633     with a modem and "MacPPP".
634    
635    
636     Technical Documentation
637     -----------------------
638    
639     Please see the included file "TECH" for a technical overview of the emulator.
640    
641    
642     Acknowledgements
643     ----------------
644    
645     Contributions by:
646     - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
647     - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
648     and networking
649     - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
650     - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
651     - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
652     - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
653     - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
654     window support
655     - David Lawrence <davidl@jlab.org>: incremental window refresh code
656 cebix 1.9 - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
657 cebix 1.6 - Gwenole Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations and
658     fbdev video code
659     - and others...
660 cebix 1.1
661     Special thanks to:
662     - Bernd Schmidt for letting me use his UAE 68k emulation
663     - Daniel Bobbert who printed dozens of pages from the THINK Reference for
664     me years ago
665     - All ShapeShifter and SheepShaver users and beta testers
666     - Apple Computer Inc., who made writing a Macintosh emulator a child's play
667    
668    
669     Bug reports
670     -----------
671    
672     You found a bug? Well, use the source, fix it and send the fix to
673     <Christian.Bauer@uni-mainz.de>
674     for inclusion in the next release of Basilisk II.
675    
676    
677     Author
678     ------
679    
680     You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
681     reports, send fixes. Ports to other platforms are also very welcome.
682     Please contact me before you intend to make major changes to the source.
683     You might be working on something that I have already done or I may have
684     different ideas about the Right Way to do it.
685    
686     Questions about ROM files will not be answered. There is also no point in
687     sending me questions etc. that are specific to the Windows port of
688     Basilisk II. I don't have Windows and can't say anything about that.
689     Ask Lauri Pesonen instead.
690    
691    
692     Support
693     -------
694    
695     The official Basilisk II home page is at
696     http://www.uni-mainz.de/~bauec002/B2Main.html
697    
698     There is no user-level support for Basilisk II at the moment.
699    
700    
701     History
702     -------
703    
704 cebix 1.2 Please consult the file "ChangeLog" for the release history.
705 cebix 1.1
706    
707     Christian Bauer
708     <Christian.Bauer@uni-mainz.de>