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