ViewVC Help
View File | Revision Log | Show Annotations | Revision Graph | Root Listing
root/cebix/BasiliskII/README
Revision: 1.1.1.1 (vendor branch)
Committed: 1999-10-03T14:16:25Z (25 years, 1 month ago) by cebix
Branch: cebix
CVS Tags: start
Changes since 1.1: +0 -0 lines
Log Message:
Imported sources

File Contents

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