INSTALL

   1
   2 Some installation notes for gwave2, a version of gwave using the Gtk2
   3 toolkit by way of guile-gnome-platform.
   4
   5 Updated Jan 2009
   6
   7 Prerequesites:
   8         Guile   version 1.8 (http://www.gnu.org/software/guile/guile.html)
   9         gtk2 2.x
  10         g-wrap                  (http://www.nongnu.org/g-wrap/)
  11         guile-gnome-platform    (http://www.gnu.org/software/guile-gnome/)
  12
  13
  14         GNU Plotutils-2.4.1 or later with patches
  15                         (optional, only used for ploting/exporting)
  16         GNUPlot         (optional, only used for ploting/exporting)
  17
  18 -------------
  19 tested configurations:
  20
  21 Fedora 8
  22         gtk2-2.12.8-2.fc8               (Standard with F8+updates)
  23
  24         guile-1.8.5-1sgt
  25         g-wrap-1.9.11-1sgt
  26         guile-gnome-platform-2.16.1-1sgt
  27
  28         (Note that in order to build from source, you also need the -devel
  29         versions of those RPMs)
  30
  31 -------------
  32
  33 CAUTION: Use only the version of guile-gnome-platform and g-wrap known
  34 to work with whatever version of guile you have. Mixing incompatibile
  35 versions of guile-gnome-platorm, g-wrap, and guile definitely fails.
  36
  37 I recommend verifying that guile, gtk2, and guile-gnome-platofrm all
  38 work individualy before trying to build gwave using them.  Gtk and
  39 guile-gnome-platform both come with "test-gtk" programs in their
  40 respective examples directories which are ideal for this purpose.  **
  41 Please try this before reporting guile-gtk related problems with
  42 gwave. **
  43
  44 *** I strongly recommend installing Guile and Guile-gtk the same way
  45 *** with the same prefix: either build both from source, installing
  46 *** both into /usr/local, or install both using your favorite packging
  47 *** system (RPM, DEB, or other).  Mixing packages and local-installs
  48 *** can be made to work, but often requires a lot of additional
  49 *** fiddling.
  50
  51 Note on Gnome and guile-gnome-platform: Although the name of the
  52 required Gui package is "guile-gnome-platform", it can be built
  53 without installing all of gnome, so long as the Gtk2 (gnome toolkit)
  54 is installed.  All that GWave requires is the Gtk2 portions of
  55 guile-gnome-platform.
  56
  57 ----
  58
  59
  60 Gwave requires external programs in order to export postscript and
  61 bitmap files for hardcopy or documentation use.  Either Gnu Graph
  62 (from Gnu plotutils) or GnuPlot can be used.
  63
  64 GNU graph is part of the GNU plotutils package.  The old berkely/sysv
  65 "graph" program sometimes found on commercial unixes doesn't work.
  66 Configure attempts to locate GNU graph and ignore other programs named
  67 "graph" that may be found in $PATH.  If the automatic detection
  68 doesn't work, try somthing like this:
  69         GRAPH="/path/to/gnu/graph" ./configure ...
  70
  71 GNU plotutils 2.4.1 contains bugs that cause it to generate bad
  72 postscript output and make it prone to crashing on plots with more
  73 than 1024 points.
  74 Applying "plotutils-2.4.1.patch" included in the gwave distribution
  75 and recompiling graph fixes these problems.
  76
  77
  78
  79
  80 Running gwave without installing it.
  81 ------------------------------------
  82
  83 After compiling, you may wish to test gwave before doing a "make install."
  84
  85 Gwave normally looks for its guile support files beneath
  86 $PREFIX/share/guile in the standard guile module structure; the
  87 complete pathnames would be somthing like
  88 $PREFIX/share/guile/app/gwave/cmds.scm
  89
  90 If gwave can't find any of its startup guile code, it aborts with a
  91 moderately useful error message.
  92
  93 The GWAVE_GUILE_DIR environment variable can be used to make gwave
  94 look in an alternate directory for these guile files.  Set
  95 GWAVE_GUILE_DIR to the full pathname of the src directory in this
  96 distribution, for example if this file is called
  97 /home/tell/build/gwave2/INSTALL, set
  98 GWAVE_GUILE_DIR=/home/tell/build/gwave2/src
  99
 100
 101
 102 Basic Installation
 103 ==================
 104
 105    These are generic installation instructions.
 106
 107    The `configure' shell script attempts to guess correct values for
 108 various system-dependent variables used during compilation.  It uses
 109 those values to create a `Makefile' in each directory of the package.
 110 It may also create one or more `.h' files containing system-dependent
 111 definitions.  Finally, it creates a shell script `config.status' that
 112 you can run in the future to recreate the current configuration, a file
 113 `config.cache' that saves the results of its tests to speed up
 114 reconfiguring, and a file `config.log' containing compiler output
 115 (useful mainly for debugging `configure').
 116
 117    If you need to do unusual things to compile the package, please try
 118 to figure out how `configure' could check whether to do them, and mail
 119 diffs or instructions to the address given in the `README' so they can
 120 be considered for the next release.  If at some point `config.cache'
 121 contains results you don't want to keep, you may remove or edit it.
 122
 123    The file `configure.in' is used to create `configure' by a program
 124 called `autoconf'.  You only need `configure.in' if you want to change
 125 it or regenerate `configure' using a newer version of `autoconf'.
 126
 127 The simplest way to compile this package is:
 128
 129   1. `cd' to the directory containing the package's source code and type
 130      `./configure' to configure the package for your system.  If you're
 131      using `csh' on an old version of System V, you might need to type
 132      `sh ./configure' instead to prevent `csh' from trying to execute
 133      `configure' itself.
 134
 135      Running `configure' takes awhile.  While running, it prints some
 136      messages telling which features it is checking for.
 137
 138   2. Type `make' to compile the package.
 139
 140   3. Optionally, type `make check' to run any self-tests that come with
 141      the package.
 142
 143   4. Type `make install' to install the programs and any data files and
 144      documentation.
 145
 146   5. You can remove the program binaries and object files from the
 147      source code directory by typing `make clean'.  To also remove the
 148      files that `configure' created (so you can compile the package for
 149      a different kind of computer), type `make distclean'.  There is
 150      also a `make maintainer-clean' target, but that is intended mainly
 151      for the package's developers.  If you use it, you may have to get
 152      all sorts of other programs in order to regenerate files that came
 153      with the distribution.
 154
 155 Compilers and Options
 156 =====================
 157
 158    Some systems require unusual options for compilation or linking that
 159 the `configure' script does not know about.  You can give `configure'
 160 initial values for variables by setting them in the environment.  Using
 161 a Bourne-compatible shell, you can do that on the command line like
 162 this:
 163      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 164
 165 Or on systems that have the `env' program, you can do it like this:
 166      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 167
 168 Compiling For Multiple Architectures
 169 ====================================
 170
 171    You can compile the package for more than one kind of computer at the
 172 same time, by placing the object files for each architecture in their
 173 own directory.  To do this, you must use a version of `make' that
 174 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
 175 directory where you want the object files and executables to go and run
 176 the `configure' script.  `configure' automatically checks for the
 177 source code in the directory that `configure' is in and in `..'.
 178
 179    If you have to use a `make' that does not supports the `VPATH'
 180 variable, you have to compile the package for one architecture at a time
 181 in the source code directory.  After you have installed the package for
 182 one architecture, use `make distclean' before reconfiguring for another
 183 architecture.
 184
 185 Installation Names
 186 ==================
 187
 188    By default, `make install' will install the package's files in
 189 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
 190 installation prefix other than `/usr/local' by giving `configure' the
 191 option `--prefix=PATH'.
 192
 193    You can specify separate installation prefixes for
 194 architecture-specific files and architecture-independent files.  If you
 195 give `configure' the option `--exec-prefix=PATH', the package will use
 196 PATH as the prefix for installing programs and libraries.
 197 Documentation and other data files will still use the regular prefix.
 198
 199    In addition, if you use an unusual directory layout you can give
 200 options like `--bindir=PATH' to specify different values for particular
 201 kinds of files.  Run `configure --help' for a list of the directories
 202 you can set and what kinds of files go in them.
 203
 204    If the package supports it, you can cause programs to be installed
 205 with an extra prefix or suffix on their names by giving `configure' the
 206 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
 207
 208 Optional Features
 209 =================
 210
 211    Some packages pay attention to `--enable-FEATURE' options to
 212 `configure', where FEATURE indicates an optional part of the package.
 213 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
 214 is something like `gnu-as' or `x' (for the X Window System).  The
 215 `README' should mention any `--enable-' and `--with-' options that the
 216 package recognizes.
 217
 218    For packages that use the X Window System, `configure' can usually
 219 find the X include and library files automatically, but if it doesn't,
 220 you can use the `configure' options `--x-includes=DIR' and
 221 `--x-libraries=DIR' to specify their locations.
 222
 223 Specifying the System Type
 224 ==========================
 225
 226    There may be some features `configure' can not figure out
 227 automatically, but needs to determine by the type of host the package
 228 will run on.  Usually `configure' can figure that out, but if it prints
 229 a message saying it can not guess the host type, give it the
 230 `--host=TYPE' option.  TYPE can either be a short name for the system
 231 type, such as `sun4', or a canonical name with three fields:
 232      CPU-COMPANY-SYSTEM
 233
 234 See the file `config.sub' for the possible values of each field.  If
 235 `config.sub' isn't included in this package, then this package doesn't
 236 need to know the host type.
 237
 238    If you are building compiler tools for cross-compiling, you can also
 239 use the `--target=TYPE' option to select the type of system they will
 240 produce code for and the `--build=TYPE' option to select the type of
 241 system on which you are compiling the package.
 242
 243 Sharing Defaults
 244 ================
 245
 246    If you want to set default values for `configure' scripts to share,
 247 you can create a site shell script called `config.site' that gives
 248 default values for variables like `CC', `cache_file', and `prefix'.
 249 `configure' looks for `PREFIX/share/config.site' if it exists, then
 250 `PREFIX/etc/config.site' if it exists.  Or, you can set the
 251 `CONFIG_SITE' environment variable to the location of the site script.
 252 A warning: not all `configure' scripts look for a site script.
 253
 254 Operation Controls
 255 ==================
 256
 257    `configure' recognizes the following options to control how it
 258 operates.
 259
 260 `--cache-file=FILE'
 261      Use and save the results of the tests in FILE instead of
 262      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
 263      debugging `configure'.
 264
 265 `--help'
 266      Print a summary of the options to `configure', and exit.
 267
 268 `--quiet'
 269 `--silent'
 270 `-q'
 271      Do not print messages saying which checks are being made.  To
 272      suppress all normal output, redirect it to `/dev/null' (any error
 273      messages will still be shown).
 274
 275 `--srcdir=DIR'
 276      Look for the package's source code in directory DIR.  Usually
 277      `configure' can determine that directory automatically.
 278
 279 `--version'
 280      Print the version of Autoconf used to generate the `configure'
 281      script, and exit.
 282
 283 `configure' also accepts some other, not widely useful, options.