| 1 | GNU GO INSTALLATION INSTRUCTIONS |
| 2 | |
| 3 | Get the most recent tar file from ftp.gnu.org or a mirror (see |
| 4 | http://www.gnu.org/order/ftp.html for a list). |
| 5 | |
| 6 | Untar the sources, change to the directory gnugo-3.6. Now do: |
| 7 | |
| 8 | ./configure [OPTIONS] |
| 9 | make |
| 10 | |
| 11 | Several configure options will be explained below. You do not need to set |
| 12 | these unless you are dissatisfied with GNU Go's performance or wish to vary |
| 13 | the experimental options. |
| 14 | |
| 15 | As an example, |
| 16 | |
| 17 | ./configure --enable-level=9 --enable-cosmic-gnugo |
| 18 | |
| 19 | will make a binary in which the default level is 9, and the experimental |
| 20 | "cosmic"' option is enabled. A list of all configure options can be obtained |
| 21 | by running `./configure --help'. Further information about the experimental |
| 22 | options can be found in the next section. |
| 23 | |
| 24 | After running configure and make, you have now made a binary called |
| 25 | `interface/gnugo'. Now (running as root) type |
| 26 | |
| 27 | make install |
| 28 | |
| 29 | to install gnugo in `/usr/local/bin'. |
| 30 | |
| 31 | There are different methods of using GNU Go. You may run it from the |
| 32 | command line by just typing: |
| 33 | |
| 34 | gnugo |
| 35 | |
| 36 | but it is nicer to run it using CGoban 1 (under X Window System) or Jago (on |
| 37 | any platform with a Java Runtime Environment). |
| 38 | |
| 39 | You can get the most recent version of CGoban 1 from |
| 40 | http://sourceforge.net/projects/cgoban1/. The earlier version |
| 41 | 1.12 is available from http://www.igoweb.org/~wms/comp/cgoban/index.html. |
| 42 | The CGoban version number MUST be 1.9.1 at least or it won't work. CGoban 2 |
| 43 | will not work. |
| 44 | |
| 45 | See the file README for instructions on how to run GNU Go from Cgoban, or |
| 46 | for Jago. |
| 47 | |
| 48 | |
| 49 | RAM CACHE |
| 50 | |
| 51 | By default, GNU Go makes a cache of 8 Megabytes in RAM for its |
| 52 | internal use. The cache is used to store intermediate results during |
| 53 | its analysis of the position. |
| 54 | |
| 55 | Increasing the cache size will often give a modest speed improvement. |
| 56 | If your system has lots of RAM, consider increasing the cache |
| 57 | size. But if the cache is too large, swapping will occur, |
| 58 | causing hard drive accesses and degrading performance. If |
| 59 | your hard drive seems to be running excessively your cache |
| 60 | may be too large. On GNU/Linux systems, you may detect swapping |
| 61 | using the program 'top'. Use the 'f' command to toggle SWAP |
| 62 | display. |
| 63 | |
| 64 | You may override the size of the default cache at compile time |
| 65 | by running one of: |
| 66 | |
| 67 | ./configure --enable-cache-size=n |
| 68 | |
| 69 | To set the cache size to n. For example |
| 70 | |
| 71 | ./configure --enable-cache-size=48 |
| 72 | |
| 73 | creates a cache of size 48. If you omit this, your default |
| 74 | cache size will be 8. You must recompile and reinstall GNU Go |
| 75 | after reconfiguring it by running make and make install. |
| 76 | |
| 77 | You may override the compile-time defaults by running gnugo with |
| 78 | the option `--cache-size n', where n is the size (in megabytes) of |
| 79 | the cache you want, and `--level n' where n is the level desired. |
| 80 | We will discuss setting these parameters next in detail. |
| 81 | |
| 82 | DEFAULT LEVEL |
| 83 | |
| 84 | GNU Go can play at different levels. Up to level 10 is |
| 85 | supported. At level 10 GNU Go is much more accurate but takes |
| 86 | an average of about 1.6 times longer to play than at level 8. |
| 87 | |
| 88 | The level can be set at run time using the --level option. |
| 89 | If you don't set this, the default level will be used. You |
| 90 | can set the default level with the configure option |
| 91 | --enable-level=n. For example |
| 92 | |
| 93 | ./configure --enable-level=9 |
| 94 | |
| 95 | sets the default level to 9. If you omit this parameter, |
| 96 | the compiler sets the default level to 10. We recommend |
| 97 | using level 10 unless you find it too slow. If you decide |
| 98 | you want to change the default you may rerun configure |
| 99 | and recompile the program. |
| 100 | |
| 101 | DFA |
| 102 | |
| 103 | GNU Go has two versions of the pattern matcher. The default |
| 104 | version uses a Discrete Finite Automaton (DFA). It can be |
| 105 | disabled, giving the old matcher (which was the default in |
| 106 | GNU Go 3.0) with './configure --disable-dfa'. |
| 107 | |
| 108 | EXPERIMENTAL OPTIONS |
| 109 | |
| 110 | --enable-experimental-semeai enables an experimental semeai |
| 111 | module. This will result in an engine that is probably stronger |
| 112 | but slightly slower and less debugged. It is not guaranteed |
| 113 | that the semeai code could not cause crashes in some situations. |
| 114 | |
| 115 | --enable-owl-threats will result in an engine that does more |
| 116 | life and death analysis. It will be stronger but slower. |
| 117 | |
| 118 | There are other experimental options but we only mention these. |
| 119 | |
| 120 | WINDOWS |
| 121 | |
| 122 | Windows installation is described in a separate file, called WINDOWS. |
| 123 | |
| 124 | MACINTOSH |
| 125 | |
| 126 | If you have Mac OS X you can build GNU Go using Apple's compiler, |
| 127 | which is derived from GCC. We recommend adding the flag -no-cpp-precomp |
| 128 | to CFLAGS. |
| 129 | |
| 130 | THE MANUAL |
| 131 | |
| 132 | You can obtain a printed copy of the manual by running 'make |
| 133 | gnugo.ps' in the doc/ directory, then printing the resulting |
| 134 | postscript file @file{gnugo.ps}. The manual contains a great |
| 135 | deal of information about the algorithms of GNU Go. The first |
| 136 | few sections serve as a user's manual. |
| 137 | |
| 138 | On platforms supporting info documentation, you can usually |
| 139 | install the manual by executing `make install' (running as |
| 140 | root) from the doc/ directory. The info documentation can |
| 141 | be read conveniently from within Emacs by executing the |
| 142 | command `Control-h i'. |
| 143 | |
| 144 | |
| 145 | |
| 146 | |