[ViewVC] Annotation of: cebix/BasiliskII/INSTALL

BASILISK II INSTALLATION INSTRUCTIONS
=====================================

System Requirements
-------------------

To use Basilisk II, you need either a 512K Mac Classic ROM image or a
512K or 1MB 32-bit clean Macintosh ROM image. You also need a copy of MacOS
(0.x thru 7.5 for Classic emulation, 7.x or 8.0/8.1 for Mac II emulation).
For copyright reasons, none of these items are included with Basilisk II.
MacOS 7.5.3 and earlier versions can be downloaded from Apple and various
other Internet sites. Mac ROM files are not freely available. You have to
own a real Mac and read out its ROM. No, I don't know where you can download
ROM files. No, I won't send you one.

Depending on the platform you use, Basilisk II has additional requirements:

BeOS:
  You need BeOS R4 or later versions.
  Basilisk II cannot do Mac Classic emulation.

Unix:
  You need X11R6 and a "make" utility with the VPATH feature (e.g. GNU make).
  For serial, ethernet and audio support, you need pthreads. To use the GUI
  preferences editor, you also need GTK+ version 1.2 or better. On Linux, you
  need glibc 2.0 or better.

AmigaOS:
  You need at least a 68020 and AmigaOS 3.0 or better. To get the GUI
  preferences editor, you need gtlayout.library V39 or later. To get sound
  output, you need AHI V2 or later. Both items can be found on Aminet. You
  also need the "PrepareEmul" utility that somes with ShapeShifter (or any
  equivalent PrepareEmul substitute). The AmigaOS version of Basilisk II
  cannot do Mac Classic emulation.

Windows:
  You need at least Windows NT 4.0. Windows 95 and 98 can be used too, with a
  somewhat reduced set of features. Basilisk II supports DirectX version 5 or
  later, but version 3 may also work, depending on your graphics card.


Installation
------------

BeOS:
  If you have a binary distribution of Basilisk II for BeOS, there are
  executables for BeOS/PPC and/or BeOS/x86 included. Basilisk II cannot run
  concurrently with SheepShaver. Trying to do so will crash Basilisk II, or
  SheepShaver, or both.

  If you have the source distribution, do the following:

    cd src/BeOS
    make

  This will produce an executable "BasiliskII" in the "obj.ppc" or "obj.x86"
  directory. To use Ethernet, you also have to do:

    cd SheepNet
    make install

  On a PowerPC system, you also have to do:

    cd SheepDriver
    make install

Unix:
  To compile Basilisk II, do the following:

    cd src/Unix
    ./configure
    make            [or "gmake" if you have GNU make and "make" fails]
    make install    [optionally]

  To use Ethernet networking under Linux, you either have to configure your
  kernel for ethertap support or make and install the "sheep_net" driver
  (this is explained in the README file, at the description of the "ether"
  preferences item).

  This is what Brian J. Johnson says about compiling for IRIX:
   "I recommend compiling with "-Ofast".  This requires changing "-g"
    to "-Ofast" in the Makefile, and adding "-ipa" to LDFLAGS.  This
    turns on massive interprocedural optimization, and makes for much
    better performance."

  ATTENTION NetBSD/m68k USERS:
  If you want to run Basilisk II natively (i.e. without CPU emulation), you
  must NOT use a pthreads library. User-level threads libraries such as PTL
  interfere with the signal handlers installed by Basilisk II and kernel-
  level threads are not supported by NetBSD, so you will have to live without
  pthreads, and thus without serial/ethernet/audio support (but the "UDP
  tunnelling" network should work).

  ATTENTION NetBSD/mac68k USERS:
  Current (as of July 2000) versions of the NetBSD/mac68k kernel have a bug
  that not only prevents Basilisk II from running properly but seems to even
  cause kernel panics under certain conditions! Apply the following patch to
  /sys/arch/mac68k/mac68k/macromasm.s, recompile and re-install the kernel
  and reboot before using Basilisk II:

    --- macromasm.s.orig    Wed Jul  5 19:29:01 2000
    +++ macromasm.s Wed Jul  5 19:12:34 2000
    @@ -37,6 +37,8 @@
 
     #include "opt_adb.h"
     #include "assym.h"
    +#include <machine/asm.h>
    +#include <machine/trap.h>
 
 
            /* Define this symbol as global with (v) value */
    @@ -437,8 +439,9 @@
            movw    sp@(FR_HW + 4), d0      | retrieve status register
            andw    #PSL_S, d0      | supervisor state?
            bne     Lalnosup        | branch if supervisor
    -       jbsr    _mrg_aline_user | user a-line trap
    -       bra     Lalrts
    +       addql   #4, sp          | pop frame ptr
    +       movql   #T_ILLINST, d0  | user-mode fault
    +       jra     _ASM_LABEL(fault)
     Lalnosup:
     #define FR_PC (FR_HW+2)
            movl    sp@(FR_PC + 4), a0      | retrieve PC

AmigaOS:
  If you have a binary distribution of Basilisk II for AmigaOS, there is an
  executable included. You must also have the "PrepareEmul" utility installed
  that comes with ShapeShifter (or any equivalent PrepareEmul substitute,
  see the ShapeShifter docs). If you have the source distribution, do the
  following:

    cd src/AmigaOS
    make

  To recompile Basilisk II, you need the GeekGadgets development suite and
  PhxAss (which can be found on Aminet).

Windows NT:
  If you have a binary distribution of Basilisk II for Windows, there is a
  Windows NT binary included. To access CD-ROMs under Windows NT, the driver
  "cdenable.sys" must be copied to your "\WinNT\System32\drivers" directory.
  To access CD-ROMs under Windows 9x, the driver "cdenable.vxd" must be copied
  to the "\Windows\System" directory. To recompile Basilisk II, you need
  MS Visual V++ 5.0 or later. Symantec C++ should work, too, with some
  modifications. See the "sysdeps.h" file in the "Windows" directory.

The ROM file has to be named "ROM" and put in the same directory as the
Basilisk II executable but you can specify a different location for the ROM
file with the "rom" option in the preferences file (or with the preferences
GUI).
Revision:	1.7
Committed:	2001-07-15T02:15:48Z (22 years, 9 months ago) by cebix
Branch:	MAIN
CVS Tags:	nigel-build-12, nigel-build-13, snapshot-15012002
Changes since 1.6:	+6 -16 lines
Log Message:	- documentation updated - UDP tunnelling not only works with AppleTalk but at least with TCP/IP and MacIPX as well
#	User	Rev	Content
1	cebix	1.1	BASILISK II INSTALLATION INSTRUCTIONS
2			=====================================
3
4			System Requirements
5			-------------------
6
7			To use Basilisk II, you need either a 512K Mac Classic ROM image or a
8			512K or 1MB 32-bit clean Macintosh ROM image. You also need a copy of MacOS
9			(0.x thru 7.5 for Classic emulation, 7.x or 8.0/8.1 for Mac II emulation).
10			For copyright reasons, none of these items are included with Basilisk II.
11			MacOS 7.5.3 and earlier versions can be downloaded from Apple and various
12			other Internet sites. Mac ROM files are not freely available. You have to
13			own a real Mac and read out its ROM. No, I don't know where you can download
14			ROM files. No, I won't send you one.
15
16			Depending on the platform you use, Basilisk II has additional requirements:
17
18			BeOS:
19	cebix	1.7	You need BeOS R4 or later versions.
20	cebix	1.1	Basilisk II cannot do Mac Classic emulation.
21
22			Unix:
23	cebix	1.5	You need X11R6 and a "make" utility with the VPATH feature (e.g. GNU make).
24			For serial, ethernet and audio support, you need pthreads. To use the GUI
25			preferences editor, you also need GTK+ version 1.2 or better. On Linux, you
26			need glibc 2.0 or better.
27	cebix	1.1
28			AmigaOS:
29			You need at least a 68020 and AmigaOS 3.0 or better. To get the GUI
30			preferences editor, you need gtlayout.library V39 or later. To get sound
31			output, you need AHI V2 or later. Both items can be found on Aminet. You
32			also need the "PrepareEmul" utility that somes with ShapeShifter (or any
33			equivalent PrepareEmul substitute). The AmigaOS version of Basilisk II
34			cannot do Mac Classic emulation.
35
36			Windows:
37			You need at least Windows NT 4.0. Windows 95 and 98 can be used too, with a
38			somewhat reduced set of features. Basilisk II supports DirectX version 5 or
39			later, but version 3 may also work, depending on your graphics card.
40
41
42			Installation
43			------------
44
45			BeOS:
46			If you have a binary distribution of Basilisk II for BeOS, there are
47	cebix	1.6	executables for BeOS/PPC and/or BeOS/x86 included. Basilisk II cannot run
48			concurrently with SheepShaver. Trying to do so will crash Basilisk II, or
49			SheepShaver, or both.
50
51			If you have the source distribution, do the following:
52	cebix	1.1
53			cd src/BeOS
54			make
55
56	cebix	1.3	This will produce an executable "BasiliskII" in the "obj.ppc" or "obj.x86"
57	cebix	1.6	directory. To use Ethernet, you also have to do:
58
59			cd SheepNet
60			make install
61
62			On a PowerPC system, you also have to do:
63
64			cd SheepDriver
65			make install
66	cebix	1.1
67			Unix:
68			To compile Basilisk II, do the following:
69
70			cd src/Unix
71			./configure
72	cebix	1.4	make [or "gmake" if you have GNU make and "make" fails]
73	cebix	1.1	make install [optionally]
74
75			To use Ethernet networking under Linux, you either have to configure your
76	cebix	1.7	kernel for ethertap support or make and install the "sheep_net" driver
77			(this is explained in the README file, at the description of the "ether"
78			preferences item).
79	cebix	1.1
80			This is what Brian J. Johnson says about compiling for IRIX:
81			"I recommend compiling with "-Ofast". This requires changing "-g"
82			to "-Ofast" in the Makefile, and adding "-ipa" to LDFLAGS. This
83			turns on massive interprocedural optimization, and makes for much
84			better performance."
85	cebix	1.5
86			ATTENTION NetBSD/m68k USERS:
87			If you want to run Basilisk II natively (i.e. without CPU emulation), you
88			must NOT use a pthreads library. User-level threads libraries such as PTL
89			interfere with the signal handlers installed by Basilisk II and kernel-
90			level threads are not supported by NetBSD, so you will have to live without
91	cebix	1.7	pthreads, and thus without serial/ethernet/audio support (but the "UDP
92			tunnelling" network should work).
93	cebix	1.5
94			ATTENTION NetBSD/mac68k USERS:
95			Current (as of July 2000) versions of the NetBSD/mac68k kernel have a bug
96			that not only prevents Basilisk II from running properly but seems to even
97			cause kernel panics under certain conditions! Apply the following patch to
98			/sys/arch/mac68k/mac68k/macromasm.s, recompile and re-install the kernel
99			and reboot before using Basilisk II:
100
101			--- macromasm.s.orig Wed Jul 5 19:29:01 2000
102			+++ macromasm.s Wed Jul 5 19:12:34 2000
103			@@ -37,6 +37,8 @@
104
105			#include "opt_adb.h"
106			#include "assym.h"
107			+#include <machine/asm.h>
108			+#include <machine/trap.h>
109
110
111			/* Define this symbol as global with (v) value */
112			@@ -437,8 +439,9 @@
113			movw sp@(FR_HW + 4), d0 \| retrieve status register
114			andw #PSL_S, d0 \| supervisor state?
115			bne Lalnosup \| branch if supervisor
116			- jbsr _mrg_aline_user \| user a-line trap
117			- bra Lalrts
118			+ addql #4, sp \| pop frame ptr
119			+ movql #T_ILLINST, d0 \| user-mode fault
120			+ jra _ASM_LABEL(fault)
121			Lalnosup:
122			#define FR_PC (FR_HW+2)
123			movl sp@(FR_PC + 4), a0 \| retrieve PC
124	cebix	1.1
125			AmigaOS:
126			If you have a binary distribution of Basilisk II for AmigaOS, there is an
127			executable included. You must also have the "PrepareEmul" utility installed
128			that comes with ShapeShifter (or any equivalent PrepareEmul substitute,
129			see the ShapeShifter docs). If you have the source distribution, do the
130			following:
131
132			cd src/AmigaOS
133	cebix	1.6	make
134	cebix	1.1
135	cebix	1.6	To recompile Basilisk II, you need the GeekGadgets development suite and
136			PhxAss (which can be found on Aminet).
137	cebix	1.1
138			Windows NT:
139			If you have a binary distribution of Basilisk II for Windows, there is a
140			Windows NT binary included. To access CD-ROMs under Windows NT, the driver
141			"cdenable.sys" must be copied to your "\WinNT\System32\drivers" directory.
142			To access CD-ROMs under Windows 9x, the driver "cdenable.vxd" must be copied
143			to the "\Windows\System" directory. To recompile Basilisk II, you need
144			MS Visual V++ 5.0 or later. Symantec C++ should work, too, with some
145			modifications. See the "sysdeps.h" file in the "Windows" directory.
146
147			The ROM file has to be named "ROM" and put in the same directory as the
148			Basilisk II executable but you can specify a different location for the ROM
149			file with the "rom" option in the preferences file (or with the preferences
150			GUI).