| 1 | <HTML><HEAD> |
|---|
| 2 | <TITLE>Survex Hacker's Guide</TITLE> |
|---|
| 3 | <STYLE type="text/css"><!-- |
|---|
| 4 | BODY, TD, CENTER, UL, OL {font-family: sans-serif;} |
|---|
| 5 | --> |
|---|
| 6 | </STYLE> |
|---|
| 7 | </HEAD><BODY BGCOLOR=white TEXT=black> |
|---|
| 8 | <H1>Hacking Survex</H1> |
|---|
| 9 | |
|---|
| 10 | <p>(That's hacking in the "tinkering with code" sense, not in the |
|---|
| 11 | "breaking into other people's computer systems" sense). |
|---|
| 12 | |
|---|
| 13 | <p>This is currently a random collection of notes that need to be written |
|---|
| 14 | down while I remember. With time it should evolve into a more |
|---|
| 15 | coherent document. If you have any questions which this should answer |
|---|
| 16 | but doesn't then ask me and I'll add them. |
|---|
| 17 | |
|---|
| 18 | <H2>Network code debugging</H2> |
|---|
| 19 | |
|---|
| 20 | <P>You can pick which network simplifications are attempted using "-z" |
|---|
| 21 | with an argument listing code letters. So: |
|---|
| 22 | |
|---|
| 23 | <ul> |
|---|
| 24 | <li>-z= no special simplifications (articulation still performed) |
|---|
| 25 | <li>-z=l remove "lollipops" |
|---|
| 26 | <li>-z=p remove parallel legs |
|---|
| 27 | <li>-z=d convert deltas to stars |
|---|
| 28 | </ul> |
|---|
| 29 | |
|---|
| 30 | <P>And you can combine these in any combination: |
|---|
| 31 | |
|---|
| 32 | <ul> |
|---|
| 33 | <li>-z=lp remove "lollipops" and parallel legs |
|---|
| 34 | <li>-z=lpd remove "lollipops" and parallel legs; convert deltas to stars |
|---|
| 35 | </ul> |
|---|
| 36 | |
|---|
| 37 | <P>"-z=lpd" is the default (in 0.99 at least - more transformations may |
|---|
| 38 | conceivably be added in future, although the simple common cases are |
|---|
| 39 | already covered). |
|---|
| 40 | |
|---|
| 41 | <H2>Developing on Unix Platforms</H2> |
|---|
| 42 | |
|---|
| 43 | <P>You'll need automake 1.5 or later (earlier versions don't support |
|---|
| 44 | per-executable CFLAGS) and autoconf 2.50 or later (for AC_ARG_VAR). |
|---|
| 45 | For building the documentation you'll need sgmltools 2 or later, |
|---|
| 46 | docbook-to-man, and w3m. |
|---|
| 47 | |
|---|
| 48 | <H2>Building on Non-Unix Platforms</H2> |
|---|
| 49 | |
|---|
| 50 | <H3>DJGPP (MSDOS for 386 or better)</H3> |
|---|
| 51 | |
|---|
| 52 | <P>Currently I build this with a Linux hosted cross-compiler. I built |
|---|
| 53 | this myself mostly following instructions from: |
|---|
| 54 | |
|---|
| 55 | <P><A |
|---|
| 56 | HREF="http://www.objsw.com/CrossGCC/">http://www.objsw.com/CrossGCC/</A> |
|---|
| 57 | |
|---|
| 58 | <P>I suggest using binutils-2.10 rather than binutils-2.9.1. The newer version |
|---|
| 59 | includes the patch they supply, so the instructions boil down to this |
|---|
| 60 | sequence of commands: |
|---|
| 61 | |
|---|
| 62 | <pre> |
|---|
| 63 | bash |
|---|
| 64 | mkdir ~/djcross |
|---|
| 65 | cd ~/djcross |
|---|
| 66 | wget ftp://ftp.objsw.com/pub/crossgcc/build-djgpp.sh |
|---|
| 67 | mkdir tars |
|---|
| 68 | cd tars |
|---|
| 69 | # can't get it to build with djcrx203 |
|---|
| 70 | wget ftp://ftp.simtel.net/pub/simtelnet/gnu/djgpp/v2/old/djcrx202.zip |
|---|
| 71 | # can't get 2.95.3 to build |
|---|
| 72 | wget http://sunsite.org.uk/gnu/gcc/gcc-2.95.2.tar.gz |
|---|
| 73 | # can't get 2.10.1 to build |
|---|
| 74 | wget http://sunsite.org.uk/gnu/binutils/binutils-2.10.tar.gz |
|---|
| 75 | cd .. |
|---|
| 76 | patch -l build-djgpp.sh <<END |
|---|
| 77 | 26c26 |
|---|
| 78 | < binutils=binutils-2.9.1 |
|---|
| 79 | --- |
|---|
| 80 | > binutils=binutils-2.10 |
|---|
| 81 | 97c97 |
|---|
| 82 | < patch -p1 <\$patches/\$binutilsdiff |
|---|
| 83 | --- |
|---|
| 84 | > #patch -p1 <\$patches/\$binutilsdiff |
|---|
| 85 | END |
|---|
| 86 | sh build-djgpp.sh |
|---|
| 87 | </pre> |
|---|
| 88 | |
|---|
| 89 | <P>Then you need to build and install the allegro graphics library: |
|---|
| 90 | |
|---|
| 91 | <P><A |
|---|
| 92 | HREF="http://prdownloads.sourceforge.net/alleg/allegro-4.0.1.tar.gz" |
|---|
| 93 | >http://prdownloads.sourceforge.net/alleg/allegro-4.0.1.tar.gz</A> |
|---|
| 94 | |
|---|
| 95 | <P>And follow the instructions for building using a cross-compiler which |
|---|
| 96 | you can find starting from readme.txt. In 4.0.1 these boil down to: |
|---|
| 97 | |
|---|
| 98 | <pre> |
|---|
| 99 | cd allegro-4.0.1 |
|---|
| 100 | ./fix.sh djgpp --quick |
|---|
| 101 | NATIVEPATH=$PATH |
|---|
| 102 | export NATIVEPATH |
|---|
| 103 | DJDIR=/opt/crosstools/i386-pc-msdosdjgpp |
|---|
| 104 | export DJDIR |
|---|
| 105 | PATH=$DJDIR/bin:/opt/crosstools/bin:$PATH |
|---|
| 106 | CROSSCOMPILE=1 |
|---|
| 107 | export CROSSCOMPILE |
|---|
| 108 | make |
|---|
| 109 | make install |
|---|
| 110 | PATH=$NATIVEPATH |
|---|
| 111 | </pre> |
|---|
| 112 | |
|---|
| 113 | <P>Building Survex under DOS in a native djgpp environment will require |
|---|
| 114 | some tinkering. Best bet is either to install bash and use the current |
|---|
| 115 | configure script, or perhaps simpler to modify miniam.pl to generate a |
|---|
| 116 | suitable makefile. I'm happy to help if you want to try this, and |
|---|
| 117 | I'll incorporate patches provided they're fairly clean. |
|---|
| 118 | |
|---|
| 119 | <H3>Mingw (MS Windows)</H3> |
|---|
| 120 | |
|---|
| 121 | <P>Currently I build this with a Linux hosted cross-compiler. I use |
|---|
| 122 | the packaged cross-compiler in the debian testing/unstable distribution. |
|---|
| 123 | You can probably install these on other distributions using alien to |
|---|
| 124 | convert them to RPMs or similar. Alternatively, before that |
|---|
| 125 | I used to use pre-built binaries for gcc 2.95.2 obtained from: |
|---|
| 126 | |
|---|
| 127 | <P><A HREF="http://www.devolution.com/~slouken/SDL/Xmingw32/" |
|---|
| 128 | >http://www.devolution.com/~slouken/SDL/Xmingw32/</A> |
|---|
| 129 | |
|---|
| 130 | <P>Building on Windows in a native mingw environment will probably |
|---|
| 131 | require tinkering. Best bet is probably to install bash and use the |
|---|
| 132 | current configure script. I'm happy to help if you want to try this, |
|---|
| 133 | and I'll incorporate patches provided they're fairly clean. |
|---|
| 134 | |
|---|
| 135 | <P>Building on Windows with MSVC/BorlandC/Watcom/... is likely to be more |
|---|
| 136 | work, but could be a worthwhile project. I'd suggest patching the |
|---|
| 137 | perl script miniam.pl to generate a suitable makefile. Again, send |
|---|
| 138 | patches if you get this to work. |
|---|
| 139 | |
|---|
| 140 | <H3>MSDOS for 286 and earlier (BorlandC)</H3> |
|---|
| 141 | |
|---|
| 142 | <P>Wookey currently builds this with a rather elderly BorlandC++ 3.1. |
|---|
| 143 | BorlandC++ 5.5 can be downloaded for free, but it appears to only compile to |
|---|
| 144 | 32 bit code. You can also download TurboC version 2, which might do the job |
|---|
| 145 | (I've not tried). |
|---|
| 146 | |
|---|
| 147 | <P>You can build a suitable source archive for this version using |
|---|
| 148 | `make alien_src_zip' on the source distribution on a Unix box (you need to |
|---|
| 149 | have run `./configure' first). Then unzip the src<version>.zip file |
|---|
| 150 | produced on the MSDOS machine and run <code>make.bat</code>. |
|---|
| 151 | |
|---|
| 152 | <H3>RISC OS</H3> |
|---|
| 153 | |
|---|
| 154 | <P>We now build this with Acorn C V5. It will probably still build with |
|---|
| 155 | Acorn C V4. You also need to get and install OSLib from: |
|---|
| 156 | |
|---|
| 157 | <P><A HREF="http://www.arcade.demon.co.uk/oslib/homepage.html" |
|---|
| 158 | >http://www.arcade.demon.co.uk/oslib/homepage.html</A> |
|---|
| 159 | |
|---|
| 160 | <P>You can build a suitable source archive for compiling the RISC OS version by |
|---|
| 161 | running `make alien_src_zip' on the source distribution on a Unix box (you |
|---|
| 162 | need to have run `./configure' first). However for this you'll need a |
|---|
| 163 | specially tweaked version of zip to create the zip file with the correct |
|---|
| 164 | RISC OS file types. I can supply this on request. You need to put it in the |
|---|
| 165 | top level of the source tree and call it `zip-magic'. |
|---|
| 166 | |
|---|
| 167 | <P>You'll probably need to use Acorn's Make Utility (`amu') to build - the GNU |
|---|
| 168 | make 1.02 port doesn't seem up to the job. |
|---|
| 169 | |
|---|
| 170 | <P>To build, create a fresh directory (or empty one) and unpack the contents of |
|---|
| 171 | srcN_NN.zip into it (using !SparkFS or similar). Then double-click on |
|---|
| 172 | `!ObeyMe' in the unpacked directory to rename the source files into c and h |
|---|
| 173 | subdirectories. Then double-click on `!MakeMe' to build survex. |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | <H2>SURVEXHOME environmental variable</H2> |
|---|
| 177 | |
|---|
| 178 | <P>Survex needs various support files. Under UNIX the path to the |
|---|
| 179 | support files needs to be built into the programs, but this causes a |
|---|
| 180 | problem if the support files need to be installed elsewhere for some |
|---|
| 181 | reason and the programs can't be rebuilt. To get around this problem, |
|---|
| 182 | you can define an environmental variable SURVEXHOME to point to a |
|---|
| 183 | directory in which to look for support files. |
|---|
| 184 | |
|---|
| 185 | <P>This mechanism may sometimes useful on other operating systems. |
|---|
| 186 | |
|---|
| 187 | <P>Under UNIX, use "setenv SURVEXHOME /home/user/survex" (csh) |
|---|
| 188 | or "SURVEXHOME=/home/user/survex ; export SURVEXHOME" (sh). |
|---|
| 189 | |
|---|
| 190 | <P>For DOS, put SET SURVEXHOME=C:\SURVEX in your AUTOEXEC.BAT file |
|---|
| 191 | |
|---|
| 192 | <P>For RISC OS put *Set SURVEXHOME ADFS::4.$.Survex.!Survex into your |
|---|
| 193 | Boot !Run or !DeskTop |
|---|
| 194 | |
|---|
| 195 | </BODY></HTML> |
|---|
