INSTALL

   1 Installation procedure for GNU Shogi
   2 ====================================
   3
   4 If you've never installed a software package using a configure script before,
   5 please read (or skim) the file "INSTALL.generic" which gives general
   6 information on using configure scripts.  This file contains information
   7 specific to GNU shogi.
   8
   9 The basic procedure:
  10 -------------------
  11
  12 1. Type 'configure --prefix=<where you want GNU shogi installed>'.  If you
  13    don't specify a prefix, it will be set to /usr/local.  There are a few GNU
  14    shogi-specific options you can use for this command; see below.
  15
  16 2. Type 'make' to create gnushogi, the binary book file gnushogi.bbk, and
  17    xshogi (the graphical interface to gnushogi).
  18
  19 3. Type 'make install' to copy the binary book file to the library
  20    destination directory and to copy the gnushogi executable to the
  21    binary destination directory.
  22
  23 4. OPTIONAL:
  24    Type 'make clean' to remove object files and binaries from destination
  25    source directory.
  26
  27
  28 Configuration options specific to GNU shogi:
  29 -------------------------------------------
  30
  31 These only affect xshogi.
  32
  33   --with-top-part-bitmaps    Use top part of Kanji bitmaps only.
  34
  35   --with-first-shogi-program=PROGNAME
  36         Use PROGNAME as the first shogi program (default: gnushogi)
  37
  38   --with-second-shogi-program=PROGNAME
  39         Use PROGNAME as the second shogi program (default: gnushogi)
  40
  41   --with-first-host=HOSTNAME
  42         Use HOSTNAME as the machine on which the first shogi program
  43         runs (default: localhost)
  44
  45   --with-second-host=HOSTNAME
  46         Use HOSTNAME as the machine on which the second shogi program
  47         runs (default: localhost)
  48
  49   --with-xshogi
  50         Compile the xshogi graphical interface to GNU shogi (default: yes)
  51
  52 If you don't want to compile xshogi, do
  53 'configure <other options> --without-xshogi'
  54
  55
  56 Other options:
  57 -------------
  58
  59 In the gnushogi directory, the file 'opts.h' includes a number of options that
  60 can be set to configure the evaluator, to set the debugging level, etc.  These
  61 options will probably only be of interest to people who are hacking the source
  62 code, with one exception: if you want to have your games automatically saved
  63 on exit, #define LIST_ON_EXIT in this file.
  64
  65
  66 Platforms GNU shogi is known to compile on:
  67 ------------------------------------------
  68
  69 Red Hat Linux 9.0
  70 Sun Solaris 2.6
  71
  72 Information about attempted or successful ports to other platforms would be
  73 appreciated.   If you submit such a report, please specify what you had to do
  74 to get GNU shogi to compile and run successfully.