diff --git a/doc/web/buildpost.bat b/doc/web/buildpost.bat index 3c4a609..fb6e98f 100644 --- a/doc/web/buildpost.bat +++ b/doc/web/buildpost.bat @@ -1,3 +1,5 @@ cd target\site perl -i.orig -p ..\..\removeMaven.re index.html +perl -i.orig -p ..\..\removeMaven.re developing.html +perl -i.orig -p ..\..\removeMaven.re ethernet.html cd ..\.. diff --git a/doc/web/buildpost.sh b/doc/web/buildpost.sh index a3949f4..b5b6ff2 100644 --- a/doc/web/buildpost.sh +++ b/doc/web/buildpost.sh @@ -1,29 +1,6 @@ -#!/bin/sh -cd target/site -perl -i.orig -p ../../removeMaven.re batch.html -perl -i.orig -p ../../removeMaven.re bootstrap.html -perl -i.orig -p ../../removeMaven.re bootstrap3.html -perl -i.orig -p ../../removeMaven.re bootstrapaudio.html -perl -i.orig -p ../../removeMaven.re bootstrapmain.html -perl -i.orig -p ../../removeMaven.re compatibility.html -perl -i.orig -p ../../removeMaven.re configmain.html -perl -i.orig -p ../../removeMaven.re configaudio.html -perl -i.orig -p ../../removeMaven.re configaudiomain.html -perl -i.orig -p ../../removeMaven.re configethernet.html -perl -i.orig -p ../../removeMaven.re configserial.html -perl -i.orig -p ../../removeMaven.re configserialmain.html -perl -i.orig -p ../../removeMaven.re connectionsaudio.html -perl -i.orig -p ../../removeMaven.re connectionsserial.html -perl -i.orig -p ../../removeMaven.re credits.html -perl -i.orig -p ../../removeMaven.re developing.html -perl -i.orig -p ../../removeMaven.re history.html -perl -i.orig -p ../../removeMaven.re historyold.html -perl -i.orig -p ../../removeMaven.re index.html -perl -i.orig -p ../../removeMaven.re install.html -perl -i.orig -p ../../removeMaven.re misc.html -perl -i.orig -p ../../removeMaven.re protocol.html -perl -i.orig -p ../../removeMaven.re receiving.html -perl -i.orig -p ../../removeMaven.re sending.html -perl -i.orig -p ../../removeMaven.re starting.html -perl -i.orig -p ../../removeMaven.re webring.html -cd ../.. +#!/bin/sh +cd target/site +perl -i.orig -p ../../removeMaven.re developing.html +perl -i.orig -p ../../removeMaven.re index.html +perl -i.orig -p ../../removeMaven.re ethernet.html +cd ../.. diff --git a/doc/web/src/site/apt/developing.apt b/doc/web/src/site/apt/developing.apt new file mode 100644 index 0000000..55aec18 --- /dev/null +++ b/doc/web/src/site/apt/developing.apt @@ -0,0 +1,132 @@ + ----- + Developing GSport + ----- + David Schmidt (david__schmidt at users dot souceforge dot net) + ----- + +Developing GSport + + Information, mosly concerning building, about various platforms: + +* General build instructions + + You need to build with a make utility. +There's a default Makefile, which should work for nearly any environment. +The Makefile includes a file called "vars" which defines the platform- +dependent variables. You need to make vars point to the appropriate +file for your machine. + + This makes my maintenance of the diverse platforms a bit easier. + +* Win32 + + There is a different port of KEGS by Chea Chee Keong (akilgard) called +KEGS32. You can get it from {{http://www.geocities.com/akilgard/kegs32}}. +This port is leveraged from KEGS32, but mostly a rewrite (perhaps for +the worse). + + GSport can be compiled with {{{http://www.mingw.org/}Mingw}} +and {{{http://www.cygwin.com/}Cygwin}} as well as via standard Microsoft compiler suites. + + In order to compile: + +------------------ +cd into the src/ directory +rm vars +ln -s vars_win32 vars +./make_win +------------------ + + You need to have a ROM file (named +ROM, ROM.01, or ROM.03) in the same directory. + + To quit, either click the close box, or force quit the application. +You can also middle-click (if you have a 3-button mouse) or +Shift-F6 to get the debugger in the terminal window, and then type "q". + + +* Mac OS X + + GSport is easy to compile. Just cd to the src directory and type "make". +GSport requires perl to be in your path (or just edit the vars file to give +the full path to wherever you installed perl). Perl version 4 or 5 is +fine. + + After the "make" has finished, it will create the application GSportMac. + +* X86 Linux + + Use the vars_x86linux file with: + +------------------------------------- +rm vars; ln -s vars_x86linux vars +make +------------------------------------- + + The resulting executable is called "gsportx". + + The build scripts assume perl is in your path. If it is somewhere else, +you need to edit the "PERL = perl" line in the vars file and make it point +to the correct place. + + For audio, GSport needs access to /dev/dsp. If the permissions do not allow +GSport to access /dev/dsp, it can fail with a cryptic error message. As root, +just do: "chmod 666 /dev/dsp". + + +* PowerPC Linux + + Use the vars_linuxppc vars file by: + +------------- +rm vars; ln -s vars_linuxppc vars +make +--------- + + The build scripts assume perl is in your path. If it is somewhere else, +you need to edit the "PERL = perl" line in the vars file and make it point +to the correct place. + + Audio is currently disabled by default, but you can try turning it on +by runnning "gsportx -audio 1". It sounds horrible to me, but sounds do +come out. + +* Solaris SPARC + + Use the vars_solaris vars file by: + +------------------------------------- +rm vars; ln -s vars_solaris vars +make +------------------------------------- + + The build scripts assume perl is in your path. If it is somewhere else, +you need to edit the "PERL = perl" line in the vars file and make it point +to the correct place. + + Audio is currently disabled by default, but you can try turning it on +by runnning "gsportx -audio 1". + +* Solaris x86 + + Use the vars_x86solaris vars file by: + +------------------------------------- +rm vars; ln -s vars_x86solaris vars +make +------------------------------------- + + The build scripts assume perl is in your path. If it is somewhere else, +you need to edit the "PERL = perl" line in the vars file and make it point +to the correct place. + + Audio is currently disabled by default, but you can try turning it on +by runnning "gsportx -audio 1". + +* Other platforms - "C" + + If you are porting to an X-windows and Unix-based machine, it should be +easy. Start with vars_x86linux if you are a little-endian machine, or +vars_linuxppc if you are big endian. Don't define -DKEGS_LITTLE_ENDIAN +unless your processor is little-endian (x86, Alpha). Mac, Sun, MIPS, +HP, Motorola, and IBM are big-endian. \ No newline at end of file diff --git a/doc/web/src/site/apt/ethernet.apt b/doc/web/src/site/apt/ethernet.apt new file mode 100644 index 0000000..1a6f936 --- /dev/null +++ b/doc/web/src/site/apt/ethernet.apt @@ -0,0 +1,69 @@ + ----- + GSport Ethernet + ----- + David Schmidt (david__schmidt at users dot souceforge dot net) + ----- + +GSport Emulated Ethernet + + The Uthernet (TFE) support in GSport was made possible by implementing the GPL source written by Spiro Trikaliotis for the {{{http://www.viceteam.org/}Vice emulator}}. This version of GSport contains the latest code from VICE 2.2. + +* Details + + Right now Uthernet emulation only works under Windows. Future support for PCap under OS X and Linux is planned. +In order to use Uthernet emulation, you must install {{{http://www.WinPcap.org/install/default.html}WinPCap}} and +have a wired (not wireless) ethernet connecton on the host computer. + + +* GSport Setup + + After GSport starts, press F4 to enter the text based menu and select the "Ethernet Card Configuration" option. + + By default, Uthernet emulation is turned off. Enable it by setting "Uthernet Card in Slot 3" to "On". + + Next, select the host interface you wish to use to communicate with the outside world. A list of available +interfaces is provided on screen. For most the default of interface "0" is correct. + + Return back to the main menu and save your configuration for good measure. Due to limitations, you must exit +and restart GSport for the changes you made to take effect. Next is configuring the Apple IIgs side of things. + +* GS/OS Setup + + In order to use TCP/IP connectivity under GS/OS, you have to install the latest version of Marinetti and the +Uthernet Link Layer. + + First download and install the latest version of Marinetti 3.0 available at: +{{{http://www.apple2.org/marinetti/Marinetti3.0b1.SHK}http://www.apple2.org/marinetti/Marinetti3.0b1.SHK}} + + Then install the latest TCPIP INIT available at: +{{{http://www.apple2.org/marinetti/TCPIP30b3.SHK}http://www.apple2.org/marinetti/TCPIP30b3.SHK}} + + Just extract and copy the file to the "System.Setup" folder in your GS/OS system folder, overwriting the existing file + + Last, install the latest Uthernet Link Layer (1.0.1b5) available at: +{{{http://www.wannop.info/speccie/uthernetll.bxy}http://www.wannop.info/speccie/uthernetll.bxy}} + + Just extract and copy the file to the "TCPIP" folder in your GS/OS system folder. +After copying over all the files, reboot the emulated IIgs. Once at the desktop, bring up the graphical control +panel available in the Apple menu and double click the "TCP/IP" icon. + + Click on "Setup Connection..." Select the "Uthernet" link layer from the drop down and then click "Configure..." + + Set "Lan Slot:" to "3", check off the DHCP option and then click "Save". Click "OK" to leave the setup dialog. + + You should be able to click "Connect to network" and successfully connect to your TCP/IP netowork. + From this point on, you are free to run any TCP/IP aware GS/OS applications. + + The following applications have been tested and seem to work fine: + + Spectrum Automated File Exchange 2.1.9 (FTP client, use passive mode) +Telnet application included with Marinetti + + The following applications have been tested and DO NOT work: + + Casper web server: It will not serve web pages. This is likely a limitation of WinPCap. + + A note about 8-bit applications: + + Uthernet enabled versions of Contiki seem to work fine with GSport. Other 8-bit software should work fine but +are untested at this time. diff --git a/doc/web/src/site/site.xml b/doc/web/src/site/site.xml index 0fb1c06..06e798f 100644 --- a/doc/web/src/site/site.xml +++ b/doc/web/src/site/site.xml @@ -11,5 +11,11 @@ + + + + + +