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.1 by cebix, 1999-10-03T14:16:25Z vs.
Revision 1.23 by cebix, 2001-07-15T02:15:48Z

# Line 1 | Line 1
1  
2 <        Basilisk II, Version 0.7
3 <        A free, portable Mac II emulator
2 >  Basilisk II
3 >  A 68k Macintosh emulator
4  
5 <        Copyright (C) 1997-1999 Christian Bauer et al.
6 <        Freely distributable
5 >  Copyright (C) 1997-2001 Christian Bauer et al.
6  
7  
8   License
9   -------
10  
11   Basilisk II is available under the terms of the GNU General Public License.
12 < See the file "COPYING" that is included in this archive for details.
12 > See the file "COPYING" that is included in the distribution for details.
13  
14  
15   Overview
16   --------
17  
18 < Basilisk II is a free, portable, Open Source 68k Mac emulator. It requires
19 < a copy of a Mac ROM and a copy of MacOS to run. Basilisk II is freeware and
20 < distributed under the GNU General Public License.
18 > Basilisk II is an Open Source 68k Macintosh emulator. That is, it enables
19 > you to run 68k MacOS software on you computer, even if you are using a
20 > different operating system. However, you still need a copy of MacOS and
21 > a Macintosh ROM image to use Basilisk II.
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)
25 >  - Unix (tested under Linux, Solaris 2.x, FreeBSD 3.x, NetBSD 1.4.x and
26 >    IRIX 6.5)
27    - AmigaOS 3.x
28    - Windows NT 4.0 (mostly works under Windows 95/98, too)
29  
# Line 35 | Line 36 | Some features of Basilisk II:
36    - Floppy disk driver (only 1.44MB disks supported)
37    - Driver for HFS partitions and hardfiles
38    - CD-ROM driver with basic audio functions
39 +  - Easy file exchange with the host OS via a "Host Directory Tree" icon
40 +    on the Mac desktop
41    - Ethernet driver
42    - Serial drivers
43    - SCSI Manager (old-style) emulation
44    - Emulates extended ADB keyboard and 3-button mouse
45 <  - Uses UAE 68k emulation or (under AmigaOS) real 68k processor
45 >  - Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k
46 >    processor
47  
48   The emulator is not yet complete. See the file "TODO" for a list of
49   unimplemented stuff.
50  
51  
52 < Requirements
53 < ------------
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."
52 > Requirements and Installation
53 > -----------------------------
54  
55 < AmigaOS:
56 <  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.
55 > Please consult the file "INSTALL" for a list of system requirements and
56 > installation instructions.
57  
58  
59   Configuration
# Line 174 | Line 94 | disk <volume description>
94    This item describes one MacOS volume to be mounted by Basilisk II.
95    There can be multiple "disk" lines in the preferences file. Basilisk II
96    can handle hardfiles (byte-per-byte images of HFS volumes in a file on
97 <  the host system) as well as HFS partitions on hard disks etc. (but Basilisk
98 <  II doesn't know about MacOS partition tables; it relies on the host OS to
99 <  handle this). The "volume description" is either the pathname of a hardfile
100 <  or a platform-dependant description of an HFS partition or drive. If the
101 <  volume description starts with an asterisk ("*"), the volume is write
102 <  protected for MacOS (and the "*" is discarded).
97 >  the host system), HFS partitions on hard disks etc., and MacOS-partitioned
98 >  disks (it can only access the first partition, though). The "volume
99 >  description" is either the pathname of a hardfile or a platform-dependant
100 >  description of an HFS partition or drive. If the volume description is
101 >  prefixed by an asterisk ("*"), the volume is write protected for MacOS.
102 >
103 >  Basilisk II can also handle some types of Mac "disk image" files directly,
104 >  as long as they are uncompressed and unencoded.
105  
106    BeOS:
107      To specify an HFS partition, simply specify its path (e.g.
108 <    "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volume, Basilisk II
108 >    "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volumes, Basilisk II
109      will search for and use all available HFS partitions.
110  
111    Unix:
112 <    To specify an HFS partition, simply specify its path (e.g.
113 <    "/dev/sda5").
112 >    To specify an HFS partition, simply specify its path (e.g. "/dev/sda5").
113 >    If you want to access a MacOS-partitioned hard disk or removable volume
114 >    (Jaz, Zip etc.) and your operating system doesn't understand MacOS
115 >    partition tables, you can specify the block device name (e.g. "/dev/sda")
116 >    to access the first HFS partition on the device. Under Linux, if you
117 >    don't specify any volumes, Basilisk II will search /etc/fstab for
118 >    unmounted HFS partitions and use these.
119  
120    AmigaOS:
121      Partitions/drives are specified in the following format:
# Line 221 | Line 148 | cdrom <CD-ROM drive description>
148    installed CD-ROM drives. The format of the "CD-ROM drive description"
149    is the same as that of "disk" lines.
150  
151 + extfs <direcory path>
152 +
153 +  This item specifies the root directory for the "Host Directory Tree"
154 +  file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
155 +  All objects contained in that directory are accessible by Mac applications.
156 +
157 +  This feature is only available when File System Manager V1.2 or later
158 +  is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
159 +  and can be installed as a system extension (downloadable from Apple, look
160 +  for the FSM SDK in the developer section) for earlier MacOS versions.
161 +
162   scsi0 <SCSI target> ... scsi6 <SCSI target>
163  
164    These items describe the SCSI target to be used for a given Mac SCSI
# Line 250 | Line 188 | scsi0 <SCSI target> ... scsi6 <SCSI targ
188      "scsi.device/2").
189  
190    Windows:
191 <    Ignored. Basilisk II scans for all SCSI devices and the first 6 found
192 <    devices are made visible to the MacOS. You cannot explicitly enable a
255 <    device, but you can disable a device (see the "disablescsi" command).
191 >    The "SCSI target" has the format <"Vendor"> <"Model"> (e.g.
192 >    scsi0 "HP" "CD-Writer+ 7100"). Note the use of quotes.
193  
194   screen <video mode>
195  
196 <  This item describes the type of video display to be used by Basilisk II.
197 <  If you are using a Mac Classic ROM, the display is always 1-bit 512x342
198 <  and this item is ignored. The format of the "video mode" is platform
199 <  specific.
196 >  This item describes the type of video display to be used by default for
197 >  Basilisk II. If you are using a Mac Classic ROM, the display is always
198 >  1-bit 512x342 and this item is ignored. The format of the "video mode" is
199 >  platform specific.
200  
201    BeOS:
202      The "video mode" is one of the following:
# Line 279 | Line 216 | screen <video mode>
216    Unix:
217      The "video mode" is one of the following:
218        win/<width>/<height>
219 <        Color display in an X11 window of the given size. The color depth
220 <        (8/15/24 bit) depends on the depth of the underlying X11 screen.
221 <        This is the default.
222 <      dga
223 <        Full-screen display using the X11 DGA extensions. The color depth
219 >        Color display in an X11 window of the given size. There are several
220 >        resolutions and color depths available. The set of color depths
221 >        depends on the capabilities of the X11 server, the operating system,
222 >        and Basilisk II compile-time options, but 1 bit and the default depth
223 >        of the X11 screen should always be available.
224 >      dga/<width>/<height>
225 >        [if Basilisk II was configured with --enable-xf86-dga]
226 >        Full-screen display using the XFree86 DGA extension. The color depth
227          (8/15/24 bit) depends on the depth of the underlying X11 screen.
228 <        For DGA to work, Basilisk II must be compiled with DGA support
229 <        enabled (selectable in the configure script).
228 >        "width" and "height" specify the maximum width/height to use.
229 >        Saying "dga/0/0" means "complete screen".
230 >      dga/<frame buffer name>
231 >        [if Basilisk II was configured with --enable-fbdev-dga]
232 >        Full-screen display using the frame buffer device /dev/fb. The color
233 >        depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
234 >        The "frame buffer name" is looked up in the "fbdevices" file (whose
235 >        path can be specified with the "fbdevicefile" prefs item) to determine
236 >        certain characteristics of the device (doing a "ls -l /dev/fb" should
237 >        tell you what your frame buffer name is).
238  
239    AmigaOS:
240      The "video mode" is one of the following:
# Line 298 | Line 246 | screen <video mode>
246          15-bit truecolor display in a Picasso96 PIP. This requires
247          Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
248        scr/<hexadecimal mode ID>
249 <        8/15/24-bit fullscreen display on a Picasso96 screen with the given
250 <        mode ID. This requires Picasso96. For 15 and 24 bit, the frame buffer
251 <        format must be QuickDraw-compatible (big-endian, xRGB 1:5:5:5 or
252 <        xRGB 8:8:8:8). The screen size will be the default size for that
253 <        mode ID.
249 >        8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
250 >        the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
251 >        24 bit, the frame buffer format must be QuickDraw-compatible
252 >        (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
253 >        the default size for that mode ID.
254  
255    Windows:
256      The "video mode" is one of the following:
# Line 386 | Line 334 | ether <ethernet card description>
334    is not available and this setting is ignored. The "ethernet card description"
335    is a platform-dependant description of an ethernet card.
336  
337 +  General note: To use TCP/IP from MacOS, you should assign a different IP
338 +  address to the MacOS (entered into the MacOS TCP/IP (or MacTCP) control
339 +  panel). Otherwise there will be confusion about which operating system will
340 +  handle incoming packets.
341 +
342    BeOS:
343      It doesn't matter what you give as "ethernet card description", Basilisk II
344      will always use the first Ethernet card it finds as long an an "ether"
345 <    line exists (e.g. say "ether yes"). As Basilisk II requires the sheep_net
346 <    net server add-on from SheepShaver, you can only use Ethernet on PowerPC
347 <    machines.
345 >    line exists (e.g. say "ether yes"). Using Ethernet requires the "sheep_net"
346 >    Net Server add-on to be installed. The first time you start Basilisk II
347 >    with Ethernet enabled you will be asked whether it's OK to make the
348 >    necessary changes to your BeOS network configuration to enable sheep_net.
349  
350    Linux:
351      The "ethernet card description" is the name of an Ethernet interface.
352      There are two approaches to networking with Basilisk II:
353 <      1. Direct access to an Ethernet card via the "sheep_net" driver.
354 <         In this case, the "ethernet card description" must be the name
355 <         of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net"
356 <         driver to be installed and accessible. This approach will allow you
357 <         to run all networking protocols under MacOS (TCP/IP, AppleTalk, IPX
358 <         etc.) but there is no connection between Linux networking and MacOS
359 <         networking. MacOS will only be able to talk to other machines on
360 <         the Ethernet, but not to other networks that your Linux box routes
361 <         (e.g. a second Ethernet or a PPP connection to the Internet).
353 >
354 >      1. Direct access to an Ethernet card via the "sheep_net" kernel module.
355 >         The "ethernet card description" must be the name of a real Ethernet
356 >         card, e.g. "eth0".
357 >
358 >         The sheep_net module is included in the Basilisk II source
359 >         distribution in the directory "src/Unix/Linux/NetDriver". You have
360 >         to compile and install the module yourself:
361 >
362 >           $ su
363 >           [enter root password]
364 >           # make
365 >           # make dev
366 >           [this will create a /dev/sheep_net device node; you should give
367 >            appropriate access rights to the user(s) running Basilisk II]
368 >           # insmod sheep_net.o
369 >
370 >         If you copy the sheep_net.o module to a place where it can be found
371 >         by the kernel module loader ("/lib/modules/<version>/kernel/drivers/net"
372 >         for 2.4 kernels) and add the line
373 >
374 >           alias char-major-10-198 sheep_net
375 >
376 >         to "/etc/modules.conf", the kernel should be able to load the module
377 >         automatically when Basilisk II is started.
378 >
379 >         The sheep_net module will allow you to run all networking protocols
380 >         under MacOS (TCP/IP, AppleTalk, IPX etc.) but there is no connection
381 >         between Linux networking and MacOS networking. MacOS will only be
382 >         able to talk to other machines on the Ethernet, but not to other
383 >         networks that your Linux box routes (e.g. a second Ethernet or a PPP
384 >         connection to the Internet).
385 >
386        2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
387           In this case, the "ethernet card description" must be the name
388           of an ethertap interface, e.g. "tap0". It also requires that you
389 <         configure your kernel to enable routing and the ethertap device:
389 >         configure your kernel to enable routing and ethertap support:
390           under "Networking options", enable "Kernel/User netlink socket" and
391           "Netlink device emulation", under "Network device support", activate
392 <         "Ethertap network tap". Next, see /usr/src/linux/Documentation/
393 <         networking/ethertap.txt for information on how to set up /dev/tap*
394 <         device nodes and activate the ethertap interface. Under MacOS,
395 <         select an IP address that is on the virtual network and set the
396 <         default gateway to the IP address of the ethertap interface. This
397 <         approach will let you access all networks that your Linux box has
398 <         access to (especially, if your Linux box has a dial-up Internet
399 <         connection and is configured for IP masquerading, you can access
400 <         the Internet from MacOS). The drawback is that you can only use
401 <         network protocols that Linux can route, so you have to install and
402 <         configure netatalk if you want to use AppleTalk.
392 >         "Ethertap network tap". You also have to modify drivers/net/ethertap.c
393 >         a bit before compiling the new kernel:
394 >
395 >          - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
396 >            #include lines)
397 >          - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
398 >
399 >         Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
400 >         information on how to set up /dev/tap* device nodes and activate the
401 >         ethertap interface. Under MacOS, select an IP address that is on the
402 >         virtual network and set the default gateway to the IP address of the
403 >         ethertap interface. This approach will let you access all networks
404 >         that your Linux box has access to (especially, if your Linux box has
405 >         a dial-up Internet connection and is configured for IP masquerading,
406 >         you can access the Internet from MacOS). The drawback is that you
407 >         can only use network protocols that Linux can route, so you have to
408 >         install and configure netatalk if you want to use AppleTalk. Here is
409 >         an example /etc/atalk/atalkd.conf for a LAN:
410 >
411 >           eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
412 >           tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
413 >
414 >         (the "47" is an arbitrary node number). This will set up a zone
415 >         "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
416 >         for the internal network connection of the ethertap interface.
417 >         MacOS should automatically recognize the nets and zones upon startup.
418 >         If you are in an existing AppleTalk network, you should contact
419 >         your network administrator about the nets and zones you can use
420 >         (instead of the ones given in the example above).
421 >
422 >  FreeBSD:
423 >    The "ethertap" method described above also works under FreeBSD, but since
424 >    no-one has found the time to write a section for this manual, you're on
425 >    your own here...
426  
427    AmigaOS:
428      You have to specify the name of the SANA-II Ethernet device and the device
# Line 430 | Line 431 | ether <ethernet card description>
431      not an Ethernet device, Basilisk II will display a warning message and
432      disable Ethernet networking.
433  
434 +  See the next item for an alternative way to do networking with Basilisk II.
435 +
436 + udptunnel <"true" or "false">
437 +
438 +  Setting this to "true" enables a special network mode in which all network
439 +  packets sent by MacOS are tunnelled over UDP using the host operating
440 +  system's native TCP/IP stack. This can only be used to connect computers
441 +  running Basilisk II (and not, for example, for connecting to the Internet
442 +  or an AppleShare server running on a real Mac), but it is probably the
443 +  easiest way to set up a network between two instances of Basilisk II
444 +  because the UDP tunnelling doesn't require any special kernel modules or
445 +  network add-ons. It relies on IP broadcasting, however, so its range is
446 +  limited. It should be fine though for doing a little file sharing or
447 +  playing Spectre.
448 +
449 + udpport <IP port number>
450 +
451 +  This item specifies the IP port number to use for the "UDP Tunnel" mode.
452 +  The default is 6066.
453 +
454   rom <ROM file path>
455  
456    This item specifies the file name of the Mac ROM file to be used by
# Line 458 | Line 479 | frameskip <frames to skip>
479    For refreshed graphics modes (usually window modes), this specifies
480    how many frames to skip after drawing one frame. Higher values make
481    the video display more responsive but require more processing power.
482 <  The default is "8".
482 >  The default is "8". Under Unix/X11, a value of "0" selects a "dynamic"
483 >  update mode that cuts the display into rectangles and updates each
484 >  rectangle individually, depending on display changes.
485  
486   modelid <MacOS model ID>
487  
488 <  Specifies the Model ID that Basilisk II should report to MacOS.
489 <  The default is "5" which corresponds to a Mac IIci. If you want to
490 <  run MacOS 8, you have to set this to "14" (Quadra 900). Other values
491 <  are not officially supported and may result in crashes. MacOS versions
492 <  earlier than 7.5 may only run with the Model ID set to "5". If you are
493 <  using a Mac Classic ROM, the model is always "Mac Classic" and this
494 <  setting is ignored.
488 >  Specifies the Macintosh model ID that Basilisk II should report to MacOS.
489 >  The default is "5" which corresponds to a Mac IIci. If you want to run
490 >  MacOS 8, you have to set this to "14" (Quadra 900). Other values are not
491 >  officially supported and may result in crashes. MacOS versions earlier
492 >  than 7.5 may only run with the Model ID set to "5". If you are using a Mac
493 >  Classic ROM, the model is always "Mac Classic" and this setting is
494 >  ignored.
495  
496   nosound <"true" or "false">
497  
# Line 497 | Line 520 | System-specific configuration
520   Unix:
521  
522    keycodes <"true" or "false">
523 <  keycodefile <Keycode file path>
523 >  keycodefile <keycodes file path>
524  
525      By default, the X11 event handler in Basilisk II uses KeySyms to
526      translate keyboard event to Mac keycodes. While this method is very
# Line 508 | Line 531 | Unix:
531      not on the selected keymap. Unfortunately it depends on the X server
532      being used and possibly also on the type of keyboard attached. So
533      Basilisk II needs a table to translate X keycodes to Mac keycodes.
534 <    This table is read by default from /usr/local/lib/basilisk_ii_keycodes
534 >    This table is read by default from /usr/local/share/BasiliskII/keycodes
535      unless you specify a different file with the "keycodefile" item.
536 <    A sample keycode file ("basilisk_ii_keycodes") is included with
537 <    Basilisk II.
536 >    A sample keycode file is included with Basilisk II.
537 >
538 >  fbdevicefile <fbdevices file path>
539 >
540 >    This option specifies the file that contains frame buffer device
541 >    specifications for the fbdev-DGA video mode (when Basilisk II was
542 >    configured with --enable-fbdev-dga). The default location of the file
543 >    is /usr/local/share/BasiliskII/fbdevices. A sample file is included
544 >    with Basilisk II.
545 >
546 >  mousewheelmode <mode>
547 >
548 >    If you have a mouse with a wheel, this option specifies whether moving
549 >    the wheel will be reported to the MacOS as "Page up/down" (mode 0) or
550 >    "Cursor up/down" (mode 1) keys.
551 >
552 >  mousewheellines <number of lines>
553 >
554 >    If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets
555 >    the number of key events sent to MacOS for each wheel movement (the
556 >    number of lines to scroll).
557  
558   AmigaOS:
559  
# Line 523 | Line 565 | AmigaOS:
565  
566        ahi/<hexadecimal mode ID>
567  
568 +  scsimemtype <type>
569 +
570 +    This item controls the type of memory to use for SCSI buffers. Possible
571 +    values are:
572 +      0 Chip memory
573 +      1 24-bit DMA capable memory
574 +      2 Any memory
575 +
576 +    Be warned that many SCSI host adapters will not work with the "Any memory"
577 +    setting. Basilisk II has no way of knowing which memory type is supported
578 +    by the host adapter and setting an unsupported type will result in data
579 +    corruption.
580 +
581   Windows:
582  
583    noscsi <"true" or "false">
# Line 533 | Line 588 | Windows:
588      means is that the control is not returned to the application until the
589      command is completely finished. Normally this is not an issue, but when a
590      CDR/CDRW is closed or erased the burner program typically wants to wait in
591 <    some progress dialog The result may be that the application reports a
591 >    some progress dialog the result may be that the application reports a
592      time-out error, but the operation completes all right anyway.
593  
594    nofloppyboot <"true" or "false">
# Line 547 | Line 602 | Windows:
602      This is very useful since many devices have almost identical ATAPI and SCSI
603      versions of their hardware, and MacOS applications usually support the SCSI
604      version only. The example below is typical:
605 <  
605 >
606        replacescsi "HP" "CD-Writer+ 7100" "PHILIPS" "CDD3600"
607 <  
607 >
608      Note the use of quotes.
609  
610 <  disablescsi <"Vendor"> <"Model">
610 >  rightmouse <0/1>
611 >
612 >    Defines what the right mouse button is used for. The default values of 0
613 >    means that it is used to move windowed mode BasiliskII screen.
614 >    Value 1 sends a combination Control and mouse click to the MacOS.
615 >    This may be useful under OS versions 8 and above.
616 >
617 >  keyboardfile <path>
618 >
619 >    Defines the path of the customized keyboard code file.
620 >
621 >  pollmedia <"true" or "false">
622 >
623 >    If true (default), tries to automatically detect new media.
624 >    Applies to all "floppy", "cd" or "disk" removable media except
625 >    1.44 MB floppies. May cause modest slow down. If unchecked,
626 >    use Ctrl-Shift-F11 to manually mount new media.
627 >    If you have auto-insert notification (AIN) enabled, you may turn this
628 >    option off. Note that some CD related software require AIN,
629 >    and some other need it to be turned off. Consult the documentation
630 >    of your CD software to learn which one is optimal for you.
631 >
632 >  framesleepticks <milliseconds>
633 >
634 >    The amount of time between video frames.
635 >
636 >  showfps <true/false>
637 >
638 >    If true, the real frame rate is displayed.
639  
640 <    Disables this vendor/model combination. You may need this simply because
641 <    you have more than 6 SCSI devices, or the particular device has problems
642 <    under BasiliskII. E.g.
643 <
644 <      disablescsi "HP" "CD-Writer+ 7100"
645 <  
563 <    Again, note the use of quotes.
640 >  stickymenu <true/false>
641 >
642 >    If true, the main menu bar is kept open even after the mouse button is
643 >    released, under all OS versions (OS 8 has this feature already). There
644 >    are extensions to do the same thing, but it's faster to handle this in
645 >    native code. Default is "true".
646  
647    ntdx5hack <"true" or "false">
648  
649 <    You may need this on NT if your display adapter driver has a bug in DirectX
650 <    palette support. Black and white are reversed. It fixes the palette issue
651 <    by using GDI palette instead of D3D palette. Default is false.
649 >    You may need this on NT if your display adapter driver has a bug in
650 >    DirectX palette support. Black and white are reversed. It fixes the
651 >    palette issue by using GDI palette instead of D3D palette. Default is
652 >    false.
653  
654  
655   Usage
# Line 591 | Line 674 | Keyboard:
674    On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
675    key is the Mac "Option" key.
676  
677 + Mouse:
678 +  Under Unix, pressing Ctrl-F5 while the Basilisk II window is active will
679 +  grab the mouse. This is needed for compatibility with some MacOS programs,
680 +  especially games such as flight simulators. Press Ctrl-F5 again to return
681 +  to normal mouse operation.
682 +
683   Floppy:
684    Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
685 <  flopyy disk changes might not be detected automatically. Under Linux, press
685 >  floppy disk changes might not be detected automatically. Under Unix, press
686    Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
687    item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
688  
689   HFS partitions:
690    Having HFS partitions mounted for read-write access under Basilisk II while
691    they are also mounted on the host OS will most likely result in volume
692 <  corruption and data losses. Unmount your HFS volumes before starting
692 >  corruption and data loss. Unmount your HFS volumes before starting
693    Basilisk II.
694  
695   ZIP drives:
# Line 619 | Line 708 | Mac Classic emulation:
708    ROM. Also, the video display is fixed to 512x342 in monochrome. The AmigaOS
709    and BeOS/PPC versions of Basilisk II cannot do Mac Classic emulation.
710  
711 + Video resolution switching:
712 +  Run-time switching of video resolutions requires the Display Manager. This
713 +  is included in MacOS versions 7.6 and above, and available as a system
714 +  extension for earlier MacOS versions as a free download from ftp.apple.com
715 +  (look for "Display Software 2.x"). Click on "Options..." in the "Monitors"
716 +  control panel to select the resolution.
717 +
718   Sound output:
719    Sound output under Basilisk II requires Sound Manager 3.0 or later. This
720 <  is included starting with MacOS 7.5 and available as a system extension
721 <  for earlier MacOS versions. Sample rate, bit resolution and mono/stereo
722 <  can be selected in the Sound control panel (section "Sound Out").
720 >  is included in MacOS versions 7.5 and above, and available as a system
721 >  extension for earlier MacOS versions as a free download from ftp.apple.com.
722 >  Sample rate, bit resolution and mono/stereo can be selected in the Sound
723 >  control panel (section "Sound Out").
724  
725   Ethernet:
726    Basilisk II supports all Ethernet protocols. Running a protocol under
727    Basilisk II that already runs within the host operating system on the same
728    network card (e.g. running MacTCP under Basilisk II on a BeOS machine) may
729    or may not work (generally, it should work, but some specific things like
730 <  "ping" may not). If you have problems with FTP, try setting your FTP client
730 >  "ping" may not). If you have problems with FTP, try setting the FTP client
731    to passive mode.
732  
733   LocalTalk:
# Line 640 | Line 737 | LocalTalk:
737  
738   Serial:
739    You can use the serial ports in Basilisk II to connect to the Internet
740 <  with a modem and "MacPPP".
740 >  with a modem and the "MacPPP" or "Open Transport/PPP" software.
741  
742  
743   Technical Documentation
# Line 652 | Line 749 | Please see the included file "TECH" for
749   Acknowledgements
750   ----------------
751  
752 < 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
752 > Contributions by (in alphabetical order):
753   - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
754 < - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
754 > - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
755 >   lots of work on the Unix video code
756   - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
757 + - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
758 +   and networking
759   - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
760     window support
761 + - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
762 + - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
763 + - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
764   - David Lawrence <davidl@jlab.org>: incremental window refresh code
765 + - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
766 + - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
767 + - and others...
768  
769   Special thanks to:
770   - Bernd Schmidt for letting me use his UAE 68k emulation
# Line 679 | Line 781 | You found a bug? Well, use the source, f
781    <Christian.Bauer@uni-mainz.de>
782   for inclusion in the next release of Basilisk II.
783  
784 + If you don't have a fix, you should post a bug report using the Source Forge
785 + bug tracker, supplying as much information as possible (operating system and
786 + versions of Basilisk II and MacOS being used, relevant hardware information,
787 + the exact steps to reproduce the bug, etc.):
788 +  http://sourceforge.net/tracker/?group_id=2123&atid=102123
789 +
790  
791   Author
792   ------
# Line 686 | Line 794 | Author
794   You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
795   reports, send fixes. Ports to other platforms are also very welcome.
796   Please contact me before you intend to make major changes to the source.
797 < You might be working on something that I have already done or I may have
797 > You might be working on something that I have already done, or I may have
798   different ideas about the Right Way to do it.
799  
800   Questions about ROM files will not be answered. There is also no point in
# Line 701 | Line 809 | Support
809   The official Basilisk II home page is at
810    http://www.uni-mainz.de/~bauec002/B2Main.html
811  
812 < There is no user-level support for Basilisk II at the moment.
812 > The Basilisk II project page on SourceForge is at
813 >  http://sourceforge.net/projects/basilisk/
814 >
815 > If you have problems, you may want to visit the Basilisk II forums:
816 >  http://sourceforge.net/forum/?group_id=2123
817 >
818 > There is also a mailing list for Basilisk II users:
819 >  http://lists.sourceforge.net/lists/listinfo/basilisk-user
820 >
821 > And another mailing list for Basilisk II developers:
822 >  http://lists.sourceforge.net/lists/listinfo/basilisk-devel
823  
824  
825   History
826   -------
827  
828 < Please consult the file "CHANGES" for the release history.
828 > Please consult the file "ChangeLog" for the release history.
829  
830  
831   Christian Bauer

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines