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.6 by cebix, 1999-10-21T13:19:11Z vs.
Revision 1.38 by gbeauche, 2004-05-09T16:15:36Z

# 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-2004 Christian Bauer et al.
6  
7  
8   License
# Line 16 | Line 15 | See the file "COPYING" that is included
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 +  - Mac OS X 10.1, 10.2
30  
31   Some features of Basilisk II:
32    - Emulates either a Mac Classic (which runs MacOS 0.x thru 7.5)
# Line 35 | Line 37 | Some features of Basilisk II:
37    - Floppy disk driver (only 1.44MB disks supported)
38    - Driver for HFS partitions and hardfiles
39    - CD-ROM driver with basic audio functions
40 +  - Easy file exchange with the host OS via a "Host Directory Tree" icon
41 +    on the Mac desktop
42    - Ethernet driver
43    - Serial drivers
44    - SCSI Manager (old-style) emulation
45    - Emulates extended ADB keyboard and 3-button mouse
46 <  - Uses UAE 68k emulation or (under AmigaOS) real 68k processor
46 >  - Uses UAE 68k emulation or (under AmigaOS and NetBSD/m68k) real 68k
47 >    processor
48  
49   The emulator is not yet complete. See the file "TODO" for a list of
50   unimplemented stuff.
# Line 64 | Line 69 | The settings are stored in a text file:
69   BeOS:
70    /boot/home/config/settings/BasiliskII_prefs
71  
72 < Unix:
72 > Unix, Mac OS X:
73    ~/.basilisk_ii_prefs
74  
75   AmigaOS:
# Line 90 | Line 95 | disk <volume description>
95    This item describes one MacOS volume to be mounted by Basilisk II.
96    There can be multiple "disk" lines in the preferences file. Basilisk II
97    can handle hardfiles (byte-per-byte images of HFS volumes in a file on
98 <  the host system) as well as HFS partitions on hard disks etc. (but Basilisk
99 <  II doesn't know about MacOS partition tables; it relies on the host OS to
100 <  handle this). The "volume description" is either the pathname of a hardfile
101 <  or a platform-dependant description of an HFS partition or drive. If the
102 <  volume description starts with an asterisk ("*"), the volume is write
103 <  protected for MacOS (and the "*" is discarded).
98 >  the host system), HFS partitions on hard disks etc., and MacOS-partitioned
99 >  disks (it can only access the first partition, though). The "volume
100 >  description" is either the pathname of a hardfile or a platform-dependant
101 >  description of an HFS partition or drive. If the volume description is
102 >  prefixed by an asterisk ("*"), the volume is write protected for MacOS.
103 >
104 >  Basilisk II can also handle some types of Mac "disk image" files directly,
105 >  as long as they are uncompressed and unencoded.
106  
107    BeOS:
108      To specify an HFS partition, simply specify its path (e.g.
109 <    "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volume, Basilisk II
109 >    "/dev/disk/scsi/0/1/0/0_3"). If you don't specify any volumes, Basilisk II
110      will search for and use all available HFS partitions.
111  
112    Unix:
113 <    To specify an HFS partition, simply specify its path (e.g.
114 <    "/dev/sda5").
113 >    To specify an HFS partition, simply specify its path (e.g. "/dev/sda5").
114 >    If you want to access a MacOS-partitioned hard disk or removable volume
115 >    (Jaz, Zip etc.) and your operating system doesn't understand MacOS
116 >    partition tables, you can specify the block device name (e.g. "/dev/sda")
117 >    to access the first HFS partition on the device. Under Linux, if you
118 >    don't specify any volumes, Basilisk II will search /etc/fstab for
119 >    unmounted HFS partitions and use these.
120  
121    AmigaOS:
122      Partitions/drives are specified in the following format:
# Line 137 | Line 149 | cdrom <CD-ROM drive description>
149    installed CD-ROM drives. The format of the "CD-ROM drive description"
150    is the same as that of "disk" lines.
151  
152 + extfs <direcory path>
153 +
154 +  This item specifies the root directory for the "Host Directory Tree"
155 +  file system (the "Unix/BeOS/Amiga/..." icon on the Finder desktop).
156 +  All objects contained in that directory are accessible by Mac applications.
157 +
158 +  This feature is only available when File System Manager V1.2 or later
159 +  is installed on the Mac side. FSM 1.2 is built-in beginning with MacOS 7.6
160 +  and can be installed as a system extension (downloadable from Apple, look
161 +  for the FSM SDK in the developer section) for earlier MacOS versions.
162 +
163   scsi0 <SCSI target> ... scsi6 <SCSI target>
164  
165    These items describe the SCSI target to be used for a given Mac SCSI
# Line 171 | Line 194 | scsi0 <SCSI target> ... scsi6 <SCSI targ
194  
195   screen <video mode>
196  
197 <  This item describes the type of video display to be used by Basilisk II.
198 <  If you are using a Mac Classic ROM, the display is always 1-bit 512x342
199 <  and this item is ignored. The format of the "video mode" is platform
200 <  specific.
197 >  This item describes the type of video display to be used by default for
198 >  Basilisk II. If you are using a Mac Classic ROM, the display is always
199 >  1-bit 512x342 and this item is ignored. The format of the "video mode" is
200 >  platform specific.
201  
202    BeOS:
203      The "video mode" is one of the following:
# Line 194 | Line 217 | screen <video mode>
217    Unix:
218      The "video mode" is one of the following:
219        win/<width>/<height>
220 <        Color display in an X11 window of the given size. The color depth
221 <        (8/15/24 bit) depends on the depth of the underlying X11 screen.
222 <        This is the default.
220 >        Color display in an X11 window of the given size. There are several
221 >        resolutions and color depths available. The set of color depths
222 >        depends on the capabilities of the X11 server, the operating system,
223 >        and Basilisk II compile-time options, but 1 bit and the default depth
224 >        of the X11 screen should always be available.
225        dga/<width>/<height>
226 <        Full-screen display using the X11 DGA extensions. The color depth
226 >        [if Basilisk II was configured with --enable-xf86-dga]
227 >        Full-screen display using the XFree86 DGA extension. The color depth
228          (8/15/24 bit) depends on the depth of the underlying X11 screen.
229          "width" and "height" specify the maximum width/height to use.
230 <        Saying "dga/0/0" means "complete screen". For DGA to work, Basilisk II
231 <        must be compiled with DGA support enabled (selectable in the configure
232 <        script).
230 >        Saying "dga/0/0" means "complete screen".
231 >      dga/<frame buffer name>
232 >        [if Basilisk II was configured with --enable-fbdev-dga]
233 >        Full-screen display using the frame buffer device /dev/fb. The color
234 >        depth (8/15/24 bit) depends on the depth of the underlying X11 screen.
235 >        The "frame buffer name" is looked up in the "fbdevices" file (whose
236 >        path can be specified with the "fbdevicefile" prefs item) to determine
237 >        certain characteristics of the device (doing a "ls -l /dev/fb" should
238 >        tell you what your frame buffer name is).
239  
240    AmigaOS:
241      The "video mode" is one of the following:
# Line 215 | Line 247 | screen <video mode>
247          15-bit truecolor display in a Picasso96 PIP. This requires
248          Picasso96 as well as a PIP-capable graphics card (e.g. Picasso IV).
249        scr/<hexadecimal mode ID>
250 <        8/15/24-bit fullscreen display on a Picasso96 screen with the given
251 <        mode ID. This requires Picasso96. For 15 and 24 bit, the frame buffer
252 <        format must be QuickDraw-compatible (big-endian, xRGB 1:5:5:5 or
253 <        xRGB 8:8:8:8). The screen size will be the default size for that
254 <        mode ID.
250 >        8/15/24-bit fullscreen display on a Picasso96/CyberGraphX screen with
251 >        the given mode ID. This requires Picasso96 or CyberGraphX. For 15 and
252 >        24 bit, the frame buffer format must be QuickDraw-compatible
253 >        (big-endian, xRGB 1:5:5:5 or xRGB 8:8:8:8). The screen size will be
254 >        the default size for that mode ID.
255  
256    Windows:
257      The "video mode" is one of the following:
# Line 253 | Line 285 | screen <video mode>
285      application via Alt-Tab, Basilisk II is put in "snooze" mode (i.e. MacOS
286      is frozen).
287  
288 +  Mac OS X:
289 +    The "video mode" is one of the following:
290 +      win/<width>/<height>
291 +      win/<width>/<height>/<bits per pixel>
292 +        A refreshed (and buffered) Quartz window.
293 +      full/<width>/<height>
294 +      full/<width>/<height>/<bits per pixel>
295 +        A CGDirectDisplay full screen mode. <bits> can currently be 8, 16 or 32.
296 +        If not specified, the default is 32. There is currently no way to switch
297 +        between the Mac OS X and Basilisk II display, but Apple-Option-Escape
298 +        instantly and safely terminates the Basilisk II program.
299 +
300   seriala <serial port description>
301  
302    This item describes the serial port to be used as Port A (Modem Port)
# Line 303 | Line 347 | ether <ethernet card description>
347    is not available and this setting is ignored. The "ethernet card description"
348    is a platform-dependant description of an ethernet card.
349  
350 +  General note: To use TCP/IP from MacOS, you should assign a different IP
351 +  address to the MacOS (entered into the MacOS TCP/IP (or MacTCP) control
352 +  panel). Otherwise there will be confusion about which operating system will
353 +  handle incoming packets.
354 +
355    BeOS:
356      It doesn't matter what you give as "ethernet card description", Basilisk II
357      will always use the first Ethernet card it finds as long an an "ether"
358 <    line exists (e.g. say "ether yes"). As Basilisk II requires the sheep_net
359 <    net server add-on from SheepShaver, you can only use Ethernet on PowerPC
360 <    machines.
358 >    line exists (e.g. say "ether yes"). Using Ethernet requires the "sheep_net"
359 >    Net Server add-on to be installed. The first time you start Basilisk II
360 >    with Ethernet enabled you will be asked whether it's OK to make the
361 >    necessary changes to your BeOS network configuration to enable sheep_net.
362  
363    Linux:
364      The "ethernet card description" is the name of an Ethernet interface.
365 <    There are two approaches to networking with Basilisk II:
366 <      1. Direct access to an Ethernet card via the "sheep_net" driver.
367 <         In this case, the "ethernet card description" must be the name
368 <         of a real Ethernet card, e.g. "eth0". It also requires the "sheep_net"
369 <         driver to be installed and accessible. This approach will allow you
370 <         to run all networking protocols under MacOS (TCP/IP, AppleTalk, IPX
371 <         etc.) but there is no connection between Linux networking and MacOS
372 <         networking. MacOS will only be able to talk to other machines on
373 <         the Ethernet, but not to other networks that your Linux box routes
374 <         (e.g. a second Ethernet or a PPP connection to the Internet).
365 >    There are three approaches to networking with Basilisk II:
366 >
367 >      1. Direct access to an Ethernet card via the "sheep_net" kernel module.
368 >         The "ethernet card description" must be the name of a real Ethernet
369 >         card, e.g. "eth0".
370 >
371 >         The sheep_net module is included in the Basilisk II source
372 >         distribution in the directory "src/Unix/Linux/NetDriver". You have
373 >         to compile and install the module yourself:
374 >
375 >           $ su
376 >           [enter root password]
377 >           # make
378 >           # make dev
379 >           [this will create a /dev/sheep_net device node; you should give
380 >            appropriate access rights to the user(s) running Basilisk II]
381 >           # insmod sheep_net.o
382 >
383 >         If you copy the sheep_net.o module to a place where it can be found
384 >         by the kernel module loader ("/lib/modules/<version>/kernel/drivers/net"
385 >         for 2.4 kernels) and add the line
386 >
387 >           alias char-major-10-198 sheep_net
388 >
389 >         to "/etc/modules.conf", the kernel should be able to load the module
390 >         automatically when Basilisk II is started.
391 >
392 >         The sheep_net module will allow you to run all networking protocols
393 >         under MacOS (TCP/IP, AppleTalk, IPX etc.) but there is no connection
394 >         between Linux networking and MacOS networking. MacOS will only be
395 >         able to talk to other machines on the Ethernet, but not to other
396 >         networks that your Linux box routes (e.g. a second Ethernet or a PPP
397 >         connection to the Internet).
398 >
399        2. Putting Basilisk II on a virtual Ethernet via the "ethertap" device.
400           In this case, the "ethernet card description" must be the name
401           of an ethertap interface, e.g. "tap0". It also requires that you
402 <         configure your kernel to enable routing and the ethertap device:
402 >         configure your kernel to enable routing and ethertap support:
403           under "Networking options", enable "Kernel/User netlink socket" and
404           "Netlink device emulation", under "Network device support", activate
405 <         "Ethertap network tap". Next, see /usr/src/linux/Documentation/
406 <         networking/ethertap.txt for information on how to set up /dev/tap*
407 <         device nodes and activate the ethertap interface. Under MacOS,
408 <         select an IP address that is on the virtual network and set the
409 <         default gateway to the IP address of the ethertap interface. This
410 <         approach will let you access all networks that your Linux box has
411 <         access to (especially, if your Linux box has a dial-up Internet
412 <         connection and is configured for IP masquerading, you can access
413 <         the Internet from MacOS). The drawback is that you can only use
414 <         network protocols that Linux can route, so you have to install and
415 <         configure netatalk if you want to use AppleTalk.
405 >         "Ethertap network tap". You also have to modify drivers/net/ethertap.c
406 >         a bit before compiling the new kernel:
407 >
408 >          - insert "#define CONFIG_ETHERTAP_MC 1" near the top (after the
409 >            #include lines)
410 >          - comment out the line "dev->flags|=IFF_NOARP;" in ethertap_probe()
411 >
412 >         Next, see /usr/src/linux/Documentation/networking/ethertap.txt for
413 >         information on how to set up /dev/tap* device nodes and activate the
414 >         ethertap interface. Under MacOS, select an IP address that is on the
415 >         virtual network and set the default gateway to the IP address of the
416 >         ethertap interface. This approach will let you access all networks
417 >         that your Linux box has access to (especially, if your Linux box has
418 >         a dial-up Internet connection and is configured for IP masquerading,
419 >         you can access the Internet from MacOS). The drawback is that you
420 >         can only use network protocols that Linux can route, so you have to
421 >         install and configure netatalk if you want to use AppleTalk. Here is
422 >         an example /etc/atalk/atalkd.conf for a LAN:
423 >
424 >           eth0 -seed -phase 2 -net 1 -addr 1.47 -zone "Ethernet"
425 >           tap0 -seed -phase 2 -net 2 -addr 2.47 -zone "Basilisknet"
426 >
427 >         (the "47" is an arbitrary node number). This will set up a zone
428 >         "Ethernet" (net 1) for the Ethernet and a zone "Basilisknet" (net 2)
429 >         for the internal network connection of the ethertap interface.
430 >         MacOS should automatically recognize the nets and zones upon startup.
431 >         If you are in an existing AppleTalk network, you should contact
432 >         your network administrator about the nets and zones you can use
433 >         (instead of the ones given in the example above).
434 >
435 >      3. Access the network through a "tuntap" interface.
436 >         The "ethernet card description" must be set to "tun".
437 >
438 >         TUN/TAP provides packet reception and transmission for user
439 >         space programs.  It can be viewed as a simple Point-to-Point
440 >         or Ethernet device, which instead of receiving packets from a
441 >         physical media, receives them from user space program and
442 >         instead of sending packets via physical media writes them to
443 >         the user space program.
444 >
445 >         A virtual network configuration script is required and the
446 >         default is /usr/local/BasiliskII/tunconfig unless you specify
447 >         a different file with the "etherconfig" item.
448 >
449 >         This script requires you that "sudo" is properly configured
450 >         so that "/sbin/ifconfig" and "/sbin/iptables" can be executed
451 >         as root. Otherwise, you can still write a helper script which
452 >         invokes your favorite program to enhance a user priviledges.
453 >         e.g. in a KDE environment, kdesu can be used as follows:
454 >
455 >           #!/bin/sh
456 >           exec /usr/bin/kdesu -c /path/to/tunconfig $1 $2
457 >
458 >  FreeBSD:
459 >    The "ethertap" method described above also works under FreeBSD, but since
460 >    no-one has found the time to write a section for this manual, you're on
461 >    your own here...
462  
463    AmigaOS:
464      You have to specify the name of the SANA-II Ethernet device and the device
# Line 347 | Line 467 | ether <ethernet card description>
467      not an Ethernet device, Basilisk II will display a warning message and
468      disable Ethernet networking.
469  
470 +  See the next item for an alternative way to do networking with Basilisk II.
471 +
472 + udptunnel <"true" or "false">
473 +
474 +  Setting this to "true" enables a special network mode in which all network
475 +  packets sent by MacOS are tunnelled over UDP using the host operating
476 +  system's native TCP/IP stack. This can only be used to connect computers
477 +  running Basilisk II (and not, for example, for connecting to the Internet
478 +  or an AppleShare server running on a real Mac), but it is probably the
479 +  easiest way to set up a network between two instances of Basilisk II
480 +  because the UDP tunnelling doesn't require any special kernel modules or
481 +  network add-ons. It relies on IP broadcasting, however, so its range is
482 +  limited. It should be fine though for doing a little file sharing or
483 +  playing Spectre.
484 +
485 + udpport <IP port number>
486 +
487 +  This item specifies the IP port number to use for the "UDP Tunnel" mode.
488 +  The default is 6066.
489 +
490   rom <ROM file path>
491  
492    This item specifies the file name of the Mac ROM file to be used by
# Line 375 | Line 515 | frameskip <frames to skip>
515    For refreshed graphics modes (usually window modes), this specifies
516    how many frames to skip after drawing one frame. Higher values make
517    the video display more responsive but require more processing power.
518 <  The default is "8".
518 >  The default is "8". Under Unix/X11, a value of "0" selects a "dynamic"
519 >  update mode that cuts the display into rectangles and updates each
520 >  rectangle individually, depending on display changes.
521  
522   modelid <MacOS model ID>
523  
524 <  Specifies the Model ID that Basilisk II should report to MacOS.
525 <  The default is "5" which corresponds to a Mac IIci. If you want to
526 <  run MacOS 8, you have to set this to "14" (Quadra 900). Other values
527 <  are not officially supported and may result in crashes. MacOS versions
528 <  earlier than 7.5 may only run with the Model ID set to "5". If you are
529 <  using a Mac Classic ROM, the model is always "Mac Classic" and this
530 <  setting is ignored.
524 >  Specifies the Macintosh model ID that Basilisk II should report to MacOS.
525 >  The default is "5" which corresponds to a Mac IIci. If you want to run
526 >  MacOS 8, you have to set this to "14" (Quadra 900). Other values are not
527 >  officially supported and may result in crashes. MacOS versions earlier
528 >  than 7.5 may only run with the Model ID set to "5". If you are using a Mac
529 >  Classic ROM, the model is always "Mac Classic" and this setting is
530 >  ignored.
531  
532   nosound <"true" or "false">
533  
# Line 405 | Line 547 | nogui <"true" or "false">
547    error alerts. All errors will then be reported to stdout. The default
548    is "false".
549  
550 + keyboardtype <keyboard-id>
551 +
552 +  Specifies the keyboard type that BasiliskII should report to the MacOS.
553 +  The default is "5" which is a "Apple Extended Keyboard II (ISO)",
554 +  but many other numbers are understood by most versions of the MacOS
555 +  (e.g. 11 is a "Macintosh Plus Keyboard with keypad",
556 +        13 is a "Apple PowerBook Keyboard (ISO)" )
557 +
558   For additional information, consult the source.
559  
560  
# Line 414 | Line 564 | System-specific configuration
564   Unix:
565  
566    keycodes <"true" or "false">
567 <  keycodefile <Keycode file path>
567 >  keycodefile <keycodes file path>
568  
569      By default, the X11 event handler in Basilisk II uses KeySyms to
570      translate keyboard event to Mac keycodes. While this method is very
# Line 425 | Line 575 | Unix:
575      not on the selected keymap. Unfortunately it depends on the X server
576      being used and possibly also on the type of keyboard attached. So
577      Basilisk II needs a table to translate X keycodes to Mac keycodes.
578 <    This table is read by default from /usr/local/lib/basilisk_ii_keycodes
578 >    This table is read by default from /usr/local/share/BasiliskII/keycodes
579      unless you specify a different file with the "keycodefile" item.
580 <    A sample keycode file ("basilisk_ii_keycodes") is included with
581 <    Basilisk II.
580 >    A sample keycode file is included with Basilisk II.
581 >
582 >  fbdevicefile <fbdevices file path>
583 >
584 >    This option specifies the file that contains frame buffer device
585 >    specifications for the fbdev-DGA video mode (when Basilisk II was
586 >    configured with --enable-fbdev-dga). The default location of the file
587 >    is /usr/local/share/BasiliskII/fbdevices. A sample file is included
588 >    with Basilisk II.
589 >
590 >  mousewheelmode <mode>
591 >
592 >    If you have a mouse with a wheel, this option specifies whether moving
593 >    the wheel will be reported to the MacOS as "Page up/down" (mode 0) or
594 >    "Cursor up/down" (mode 1) keys.
595 >
596 >  mousewheellines <number of lines>
597 >
598 >    If "mousewheelmode" is set to mode 1 (Cursor up/down), this option sets
599 >    the number of key events sent to MacOS for each wheel movement (the
600 >    number of lines to scroll).
601 >
602 >  ignoresegv <"true" or "false">
603 >
604 >    Set this to "true" to ignore illegal memory accesses. The default
605 >    is "false". This feature is only implemented on the following
606 >    platforms: Linux/x86, Linux/ppc, Darwin/ppc.
607 >
608 >  dsp <device name>
609 >  mixer <device name>
610 >
611 >    Under Linux and FreeBSD, this specifies the devices to be used for sound
612 >    output and volume control, respectively. The defaults are "/dev/dsp" and
613 >    "/dev/mixer".
614  
615   AmigaOS:
616  
# Line 440 | Line 622 | AmigaOS:
622  
623        ahi/<hexadecimal mode ID>
624  
625 +  scsimemtype <type>
626 +
627 +    This item controls the type of memory to use for SCSI buffers. Possible
628 +    values are:
629 +      0 Chip memory
630 +      1 24-bit DMA capable memory
631 +      2 Any memory
632 +
633 +    Be warned that many SCSI host adapters will not work with the "Any memory"
634 +    setting. Basilisk II has no way of knowing which memory type is supported
635 +    by the host adapter and setting an unsupported type will result in data
636 +    corruption.
637 +
638   Windows:
639  
640    noscsi <"true" or "false">
# Line 450 | Line 645 | Windows:
645      means is that the control is not returned to the application until the
646      command is completely finished. Normally this is not an issue, but when a
647      CDR/CDRW is closed or erased the burner program typically wants to wait in
648 <    some progress dialog The result may be that the application reports a
648 >    some progress dialog the result may be that the application reports a
649      time-out error, but the operation completes all right anyway.
650  
651    nofloppyboot <"true" or "false">
# Line 464 | Line 659 | Windows:
659      This is very useful since many devices have almost identical ATAPI and SCSI
660      versions of their hardware, and MacOS applications usually support the SCSI
661      version only. The example below is typical:
662 <  
662 >
663        replacescsi "HP" "CD-Writer+ 7100" "PHILIPS" "CDD3600"
664 <  
664 >
665      Note the use of quotes.
666  
667    rightmouse <0/1>
# Line 491 | Line 686 | Windows:
686      and some other need it to be turned off. Consult the documentation
687      of your CD software to learn which one is optimal for you.
688  
689 <  framesleepticks <milliseconds>    
689 >  framesleepticks <milliseconds>
690  
691      The amount of time between video frames.
692  
# Line 501 | Line 696 | Windows:
696  
697    stickymenu <true/false>
698  
699 <    If true, the main menu bar is kept open even after the mouse button is released,
700 <    under all OS versions (OS 8 has this feature already). There are extensions to do
701 <    the same thing, but it's faster to handle this in native code.
702 <    Default is "true".
699 >    If true, the main menu bar is kept open even after the mouse button is
700 >    released, under all OS versions (OS 8 has this feature already). There
701 >    are extensions to do the same thing, but it's faster to handle this in
702 >    native code. Default is "true".
703  
704    ntdx5hack <"true" or "false">
705  
706 <    You may need this on NT if your display adapter driver has a bug in DirectX
707 <    palette support. Black and white are reversed. It fixes the palette issue
708 <    by using GDI palette instead of D3D palette. Default is false.
706 >    You may need this on NT if your display adapter driver has a bug in
707 >    DirectX palette support. Black and white are reversed. It fixes the
708 >    palette issue by using GDI palette instead of D3D palette. Default is
709 >    false.
710 >
711 >
712 > JIT-specific configuration
713 > --------------------------
714 >
715 > A Just-In-Time (JIT) translation engine is available for x86. This is
716 > aimed at translating 68040 instructions to native equivalent code
717 > sequences, thus providing faster emulation speeds.
718 >
719 >  jit <"true" or "false">
720 >
721 >    Set this to "true" to enable the JIT compiler. Default value is
722 >    "true" if the JIT compiler was compiled in. Besides, this is
723 >    effective only if Basilisk II is configured to emulate a 68040.
724 >
725 >  jitfpu <"true" or "false">
726 >
727 >    Set this to "true" to enable translation of floating-point (FPU)
728 >    instructions. Default is "true".
729 >
730 >  jitcachesize <size>
731 >
732 >    Allocate "size" kilobytes of RAM for the translation cache. The
733 >    value given will be rounded down to the nearest multiple of a page
734 >    size. Minimal value is "2048" (2MB). Default value is "8192" (8MB).
735 >
736 >  jitlazyflush <"true" or "false">
737 >
738 >    Set this to "true" to enable lazy invalidation of the translation
739 >    cache. This is always recommended as it usually makes the system
740 >    more responsive and faster, especially while running MacOS
741 >    8.X. Default value is "true".
742 >
743 >  jitdebug <"true" or "false">
744 >
745 >    Set this to "true" to enable the JIT debugger. This requires a
746 >    build of Basilisk II with the cxmon debugger. Default is "false".
747  
748  
749   Usage
# Line 535 | Line 768 | Keyboard:
768    On PC-style keyboards, "Alt" is the Mac "Command" key, while the "Windows"
769    key is the Mac "Option" key.
770  
771 + Mouse:
772 +  Under Unix, pressing Ctrl-F5 while the Basilisk II window is active will
773 +  grab the mouse. This is needed for compatibility with some MacOS programs,
774 +  especially games such as flight simulators. Press Ctrl-F5 again to return
775 +  to normal mouse operation.
776 +
777   Floppy:
778    Basilisk II can only handle 1.44MB MFM floppies. Depending on your platform,
779 <  flopyy disk changes might not be detected automatically. Under Linux, press
779 >  floppy disk changes might not be detected automatically. Under Unix, press
780    Ctrl-F1 to mount a floppy. Under BeOS, select the appropriate "Mount" menu
781    item or press Ctrl-F1 to mount a floppy. Under Windows, press Ctrl-Shift-F11.
782  
783   HFS partitions:
784    Having HFS partitions mounted for read-write access under Basilisk II while
785    they are also mounted on the host OS will most likely result in volume
786 <  corruption and data losses. Unmount your HFS volumes before starting
786 >  corruption and data loss. Unmount your HFS volumes before starting
787    Basilisk II.
788  
789   ZIP drives:
# Line 563 | Line 802 | Mac Classic emulation:
802    ROM. Also, the video display is fixed to 512x342 in monochrome. The AmigaOS
803    and BeOS/PPC versions of Basilisk II cannot do Mac Classic emulation.
804  
805 + Video resolution switching:
806 +  Run-time switching of video resolutions requires the Display Manager. This
807 +  is included in MacOS versions 7.6 and above, and available as a system
808 +  extension for earlier MacOS versions as a free download from ftp.apple.com
809 +  (look for "Display Software 2.x"). Click on "Options..." in the "Monitors"
810 +  control panel to select the resolution.
811 +
812   Sound output:
813    Sound output under Basilisk II requires Sound Manager 3.0 or later. This
814 <  is included starting with MacOS 7.5 and available as a system extension
815 <  for earlier MacOS versions. Sample rate, bit resolution and mono/stereo
816 <  can be selected in the Sound control panel (section "Sound Out").
814 >  is included in MacOS versions 7.5 and above, and available as a system
815 >  extension for earlier MacOS versions as a free download from ftp.apple.com.
816 >  Sample rate, bit resolution and mono/stereo can be selected in the Sound
817 >  control panel (section "Sound Out").
818  
819   Ethernet:
820    Basilisk II supports all Ethernet protocols. Running a protocol under
821    Basilisk II that already runs within the host operating system on the same
822    network card (e.g. running MacTCP under Basilisk II on a BeOS machine) may
823    or may not work (generally, it should work, but some specific things like
824 <  "ping" may not). If you have problems with FTP, try setting your FTP client
824 >  "ping" may not). If you have problems with FTP, try setting the FTP client
825    to passive mode.
826  
827   LocalTalk:
# Line 584 | Line 831 | LocalTalk:
831  
832   Serial:
833    You can use the serial ports in Basilisk II to connect to the Internet
834 <  with a modem and "MacPPP".
834 >  with a modem and the "MacPPP" or "Open Transport/PPP" software.
835  
836  
837   Technical Documentation
# Line 596 | Line 843 | Please see the included file "TECH" for
843   Acknowledgements
844   ----------------
845  
846 < Contributions by:
600 < - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
601 < - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
602 <   and networking
603 < - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
846 > Contributions by (in alphabetical order):
847   - Orlando Bassotto <future@powercube.mediabit.net>: FreeBSD support
848 < - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
848 > - Gwenolé Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations,
849 >   lots of work on the Unix video code, fixes and improvements to the
850 >   JIT compiler
851   - Marc Chabanas <Marc.Chabanas@france.sun.com>: Solaris sound support
852 + - Marc Hellwig <Marc.Hellwig@uni-mainz.de>: audio output, BeOS video code
853 +   and networking
854   - Bill Huey <billh@mag.ucsd.edu>: 15/16 bit DGA and 15/16/32 bit X11
855     window support
856 + - Brian J. Johnson <bjohnson@sgi.com>: IRIX support
857 + - Jürgen Lachmann <juergen_lachmann@t-online.de>: AmigaOS CyberGraphX support
858 + - Samuel Lander <blair_sp@hotmail.com>: tile-based window refresh code
859   - David Lawrence <davidl@jlab.org>: incremental window refresh code
860 < - Gwenole Beauchesne <gb@dial.oleane.com>: SPARC assembly optimizations and
861 <   fbdev video code
860 > - Bernie Meyer <bmeyer@csse.monash.edu.au>: original UAE-JIT code
861 > - Nigel Pearson <nigel@ind.tansu.com.au>: Mac OS X port
862 > - Lauri Pesonen <lpesonen@nic.fi>: Windows NT port
863 > - Bernd Schmidt <crux@pool.informatik.rwth-aachen.de>: UAE 68k emulation
864 > - Michael Z. Sliczniak <msliczniak@comcast.net>: Mach memory fault recovery
865   - and others...
866  
867   Special thanks to:
# Line 626 | Line 879 | You found a bug? Well, use the source, f
879    <Christian.Bauer@uni-mainz.de>
880   for inclusion in the next release of Basilisk II.
881  
882 + If you don't have a fix, you should post a bug report using the Source Forge
883 + bug tracker, supplying as much information as possible (operating system and
884 + versions of Basilisk II and MacOS being used, relevant hardware information,
885 + the exact steps to reproduce the bug, etc.):
886 +  http://sourceforge.net/tracker/?group_id=2123&atid=102123
887 +
888 + I also strongly suggest reading this before posting a bug report:
889 +  http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
890 +
891  
892   Author
893   ------
894  
895 < You can contact me at <Christian.Bauer@uni-mainz.de>. Don't send bug
896 < reports, send fixes. Ports to other platforms are also very welcome.
897 < Please contact me before you intend to make major changes to the source.
898 < You might be working on something that I have already done or I may have
899 < different ideas about the Right Way to do it.
900 <
901 < Questions about ROM files will not be answered. There is also no point in
902 < sending me questions etc. that are specific to the Windows port of
903 < Basilisk II. I don't have Windows and can't say anything about that.
904 < Ask Lauri Pesonen instead.
895 > You can contact me at <Christian.Bauer@uni-mainz.de>, but please don't do
896 > so unless absolutely necessary. I'm maintaining Basilisk II in my spare
897 > time and am not able to provide technical support for everyone. If you have
898 > questions, consider posting them to one of the support forums mentioned
899 > below.
900 >
901 > You are encouraged to contact me personally when
902 > - you have bug fixes or small enhancements for the code
903 > - you want to port Basilisk II to another platform
904 > - you want to discuss technical issues
905 > - you intend to make major changes to the source; you might be working on
906 >   something that I have already done, or I may have different ideas about
907 >   the Right Way to do it
908 >
909 > There is no point in sending me questions about
910 > - ROM files and how/where to get them
911 > - versions of Basilisk II that run on operating systems other than Unix,
912 >   BeOS and AmigaOS. If you are using any other operating system, there's
913 >   no point in asking me how to to X or why Y doesn't work because I won't
914 >   know either. Instead, you should look in the "Acknowledgements" section
915 >   of this manual to find the person responsible. For example, if your
916 >   question is specific to the Windows operating system, ask Lauri Pesonen.
917 >   I don't have Windows and can't answer your questions and I'm too lazy to
918 >   forward mail to Lauri myself. In any case, it would probably be better
919 >   to post your questions to a public forum as it will get a much wider
920 >   audience there.
921  
922  
923   Support
# Line 648 | Line 926 | Support
926   The official Basilisk II home page is at
927    http://www.uni-mainz.de/~bauec002/B2Main.html
928  
929 < There is no user-level support for Basilisk II at the moment.
929 > The Basilisk II project page on SourceForge is at
930 >  http://sourceforge.net/projects/basilisk/
931 >
932 > If you have problems, you may want to visit the Basilisk II forums:
933 >  http://sourceforge.net/forum/?group_id=2123
934 >
935 > There is also a mailing list for Basilisk II users:
936 >  http://lists.sourceforge.net/lists/listinfo/basilisk-user
937 >
938 > And another mailing list for Basilisk II developers:
939 >  http://lists.sourceforge.net/lists/listinfo/basilisk-devel
940 >
941 > Some general advice about asking technical support questions can be found at
942 >  http://www.tuxedo.org/~esr/faqs/smart-questions.html
943 >
944 > Keeping this in mind will greatly increase your chances of getting a useful
945 > answer.
946  
947  
948   History

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines