Installation instructions for 'gnut'

This file contains:

  1. Brief summary of how to install and run

  2. Pointers to other files to read for more info

  3. Standard (and more complete) "generic" installation instructions

  4. Build problems that only affect a tiny percentage of users

Brief Summary
=============

First, build and install:

  ./configure
  make

See if it runs by typing:

  src/gnut

If it doesn't crash or do something really strange, you can probably
now proceed to the TUTORIAL file in the doc directory, which will lead
you through learning some of the gnut commands.

After you have done "src/gnut" at least once to test the executable to
see if it works, you can install gnut in the appropriate public
directory, usually something like /usr/local/bin:

  make install

Naturally, this requires that you actually have permission to put gnut
in the public directory. If you don't, it doesn't matter -- you can
always run gnut from src/gnut or copy it elsewhere in your own
directory. You can also install it in your own bin directory, read
below for instructions on things like that.

Please Also Read:
=================

 - The file "TUTORIAL" in the doc directory

 - The file README in the same directory as this file.

 - The FAQ file, in doc/gnut-5.html or on the Internet at:

     http://www.mrob.com/gnut/doc/gnut-5.html

 - The whole manual (perhaps for a newer version of gnut than the
   one you have) can be found on the Internet at:

     http://www.mrob.com/gnut/doc/gnut.html

How Installation and Building Works
===================================

If you don't know how all the special files (configure, configure.in,
Makefile.am, Makefile, aclocal.m4, etc.) depend on each other, you'll
get lost. The file HACKING explains the dependencies and gives
instructions on how to change any of the special files and make the
changes stick.



Generic Installation Instructions
=================================

The rest of this file gives the standard 'generic' instructions for
using 'configure' and 'make', including some options and variations
that may be useful if the simple steps above don't work.

Basic Installation

   These are generic installation instructions.

   The `configure' shell script attempts to guess correct values for
various system-dependent variables used during compilation.  It uses
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions.  Finally, it creates a shell script `config.status' that
you can run in the future to recreate the current configuration, a file
`config.cache' that saves the results of its tests to speed up
reconfiguring, and a file `config.log' containing compiler output
(useful mainly for debugging `configure').

   If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
be considered for the next release.  If at some point `config.cache'
contains results you don't want to keep, you may remove or edit it.

   The file `configure.in' is used to create `configure' by a program
called `autoconf'.  You only need `configure.in' if you want to change
it or regenerate `configure' using a newer version of `autoconf'.

The simplest way to compile this package is:

  1. `cd' to the directory containing the package's source code and type
     `./configure' to configure the package for your system.  If you're
     using `csh' on an old version of System V, you might need to type
     `sh ./configure' instead to prevent `csh' from trying to execute
     `configure' itself.

     Running `configure' takes awhile.  While running, it prints some
     messages telling which features it is checking for.

  2. Type `make' to compile the package.

  3. Optionally, type `make check' to run any self-tests that come with
     the package.

  4. Type `make install' to install the programs and any data files and
     documentation.

  5. You can remove the program binaries and object files from the
     source code directory by typing `make clean'.  To also remove the
     files that `configure' created (so you can compile the package for
     a different kind of computer), type `make distclean'.  There is
     also a `make maintainer-clean' target, but that is intended mainly
     for the package's developers.  If you use it, you may have to get
     all sorts of other programs in order to regenerate files that came
     with the distribution.

Compilers and Options

   Some systems require unusual options for compilation or linking that
the `configure' script does not know about.  You can give `configure'
initial values for variables by setting them in the environment.  Using
a Bourne-compatible shell, you can do that on the command line like
this:
     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure

Or on systems that have the `env' program, you can do it like this:
     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure

Compiling For Multiple Architectures

   You can compile the package for more than one kind of computer at the
same time, by placing the object files for each architecture in their
own directory.  To do this, you must use a version of `make' that
supports the `VPATH' variable, such as GNU `make'.  `cd' to the
directory where you want the object files and executables to go and run
the `configure' script.  `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.

   If you have to use a `make' that does not supports the `VPATH'
variable, you have to compile the package for one architecture at a time
in the source code directory.  After you have installed the package for
one architecture, use `make distclean' before reconfiguring for another
architecture.

Installation Names

   By default, `make install' will install the package's files in
`/usr/local/bin', `/usr/local/man', etc.  You can specify an
installation prefix other than `/usr/local' by giving `configure' the
option `--prefix=PATH'.

   You can specify separate installation prefixes for
architecture-specific files and architecture-independent files.  If you
give `configure' the option `--exec-prefix=PATH', the package will use
PATH as the prefix for installing programs and libraries.
Documentation and other data files will still use the regular prefix.

   In addition, if you use an unusual directory layout you can give
options like `--bindir=PATH' to specify different values for particular
kinds of files.  Run `configure --help' for a list of the directories
you can set and what kinds of files go in them.

   If the package supports it, you can cause programs to be installed
with an extra prefix or suffix on their names by giving `configure' the
option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.

Optional Features

   Some packages pay attention to `--enable-FEATURE' options to
`configure', where FEATURE indicates an optional part of the package.
They may also pay attention to `--with-PACKAGE' options, where PACKAGE
is something like `gnu-as' or `x' (for the X Window System).  The
`README' should mention any `--enable-' and `--with-' options that the
package recognizes.

   For packages that use the X Window System, `configure' can usually
find the X include and library files automatically, but if it doesn't,
you can use the `configure' options `--x-includes=DIR' and
`--x-libraries=DIR' to specify their locations.

Specifying the System Type

   There may be some features `configure' can not figure out
automatically, but needs to determine by the type of host the package
will run on.  Usually `configure' can figure that out, but if it prints
a message saying it can not guess the host type, give it the
`--host=TYPE' option.  TYPE can either be a short name for the system
type, such as `sun4', or a canonical name with three fields:
     CPU-COMPANY-SYSTEM

See the file `config.sub' for the possible values of each field.  If
`config.sub' isn't included in this package, then this package doesn't
need to know the host type.

   If you are building compiler tools for cross-compiling, you can also
use the `--target=TYPE' option to select the type of system they will
produce code for and the `--build=TYPE' option to select the type of
system on which you are compiling the package.

Sharing Defaults

   If you want to set default values for `configure' scripts to share,
you can create a site shell script called `config.site' that gives
default values for variables like `CC', `cache_file', and `prefix'.
`configure' looks for `PREFIX/share/config.site' if it exists, then
`PREFIX/etc/config.site' if it exists.  Or, you can set the
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.

Operation Controls

   `configure' recognizes the following options to control how it
operates.

`--cache-file=FILE'
     Use and save the results of the tests in FILE instead of
     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
     debugging `configure'.

`--help'
     Print a summary of the options to `configure', and exit.

`--quiet'
`--silent'
`-q'
     Do not print messages saying which checks are being made.  To
     suppress all normal output, redirect it to `/dev/null' (any error
     messages will still be shown).

`--srcdir=DIR'
     Look for the package's source code in directory DIR.  Usually
     `configure' can determine that directory automatically.

`--version'
     Print the version of Autoconf used to generate the `configure'
     script, and exit.

`configure' also accepts some other, not widely useful, options.


Problems that only affect a small or tiny percentage of users
=============================================================

These problems all apply to a specific operating system or OS version,
a specific compiler, or other very specific situations. You don't have
to bother reading all of this, but if you have problems, you might
want to use your "search" command to see if your OS is mentioned.

A HP-UX 10.20 user reported that the include file "pthread.h" was not
on his system. He got gnut to work by installing the GNU package "pth"
on his machine, and then placing "#define _POSIX_BACKCOMPAT" before
"#include pthread.h" in each file that includes it (or, at the very
least, in the three that need it, which are gnut_connection.c, gnut.c
and gnut_threads.c).

A Red Hat Linux 7.0 user reported that nothing requiring the "gcc"
compiler can be built on Red Hat Linux 7.0 unless the makefiles are
manually edited to set "CC = kgcc" instead of the standard "CC = gcc".
Apparently there is a note about this on the Red Hat web site.

A LinuxPPC user reported that they couldn't build gnut because they
didn't have a symbolic link from /usr/src/linux to
/usr/src/linux-2.x.x (look in your /usr/src to see which linux-2.x.x
directory you have; mine is called linux-2.2.14) Normally this is
created by the install, but their install didn't create it.

Some users (including a Corel Linux 1.2 user) get a bus error or
Segfault error just before gnut gives its first prompt. After some
investigation one of these users determined that it was a problem with
the readline library. gnut now detects this problem and prints
instructions that, if followed, allow you to rebuild gnut without
readline support and thereby avoid the problem. (The instructions are
to place '#undef USE_READLINE' at the beginning of src/cli.c
and then repeat the 'make' and/or 'make install' steps.)

As of veriion 0.3.29, gnut had been tested successfully on Linux
2.2.14, SunOS 5.5-5.7, FreeBSD 2.8, 3.4, 4.0-RELEASE, and Win32. Some
OS versions have not been tested recently, so if you have problems you
can always consider trying an older version of gnut.

Version 0.3.29 compiled under Win32, using the wgnut.dsw file. I don't
know if this still works.

Bugs with little or no qualifying information
=============================================

Many Solaris users have written to tell me that gnut crashes (with a
bus error or segment access fault) shortly after starting up.
Unfortunately, none of them has been able to debug this for me, or to
donate a Solaris machine so I can do it myself (HA! In your dreams
Robert!)
