| 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; 1.6 has been tested and works, but wasn't a |
|---|
| 45 | very stable release - automake 1.6.1 is a better bet) |
|---|
| 46 | and autoconf 2.50 or later (autoconf 2.52, 2.53 and 2.64 have all |
|---|
| 47 | been used successfully). |
|---|
| 48 | |
|---|
| 49 | <P>For building the documentation you'll need sgmltools 2 or later, |
|---|
| 50 | jadetex, docbook-to-man, and w3m. |
|---|
| 51 | |
|---|
| 52 | <P>On debian squeeze: sudo apt-get install sgmltools-lite jadetex docbook-to-man w3m |
|---|
| 53 | |
|---|
| 54 | <H2>Building on Non-Unix Platforms</H2> |
|---|
| 55 | |
|---|
| 56 | <H3>Mingw (Microsoft Windows)</H3> |
|---|
| 57 | |
|---|
| 58 | <P>Currently I build this with a Linux hosted cross-compiler. I use |
|---|
| 59 | the packaged cross-compiler in the debian testing/unstable distribution. |
|---|
| 60 | You can probably install these on other distributions using alien to |
|---|
| 61 | convert them to RPMs or similar. |
|---|
| 62 | |
|---|
| 63 | <P>Building on Windows in a native mingw environment will probably |
|---|
| 64 | require tinkering. Best bet is probably to install bash and use the |
|---|
| 65 | current configure script. I'm happy to help if you want to try this, |
|---|
| 66 | and I'll incorporate patches provided they're fairly clean. |
|---|
| 67 | |
|---|
| 68 | <H2>Microsoft Windows Installer Builder</H2> |
|---|
| 69 | |
|---|
| 70 | <P>We use <A HREF="http://www.jrsoftware.org/isinfo.php">InnoSetup</A> to |
|---|
| 71 | build the MS Windows Installer. Survex 1.1.6 was built using InnoSetup |
|---|
| 72 | 5.4.2 (non-Unicode version, so that the installer works on older versions |
|---|
| 73 | of Microsoft Windows). |
|---|
| 74 | |
|---|
| 75 | <P>Here are some random notes: |
|---|
| 76 | |
|---|
| 77 | <H3>Packages Needed</H3> |
|---|
| 78 | |
|---|
| 79 | <P>On Debian, you'll need to install these packages to build the installer: |
|---|
| 80 | |
|---|
| 81 | <P>apt-get install wine wx2.8-i18n |
|---|
| 82 | |
|---|
| 83 | <H3>Translations</H3> |
|---|
| 84 | |
|---|
| 85 | <P>In addition to the translations included with InnoSetup as standard, we also |
|---|
| 86 | add these, which you can find in the <code>lib</code> subdirectory of Xapian's |
|---|
| 87 | SVN tree: |
|---|
| 88 | |
|---|
| 89 | <UL> |
|---|
| 90 | <LI>English_GB.isl (unofficial, done by Olly) |
|---|
| 91 | <LI>Romanian-7-5.1.11.isl (unofficial, asked Cristian to check it over) |
|---|
| 92 | </UL> |
|---|
| 93 | |
|---|
| 94 | <H3>survex.iss</H3> |
|---|
| 95 | |
|---|
| 96 | <P>This file is generated by configure (from the template survex.iss.in). |
|---|
| 97 | We could instead have a static survex.iss which uses #include to pull in |
|---|
| 98 | a file with the Survex version info in, but the current method works well |
|---|
| 99 | enough so we'll stick with it for now (I suspect #include was introduced since |
|---|
| 100 | we started using InnoSetup). |
|---|
| 101 | |
|---|
| 102 | </BODY></HTML> |
|---|
