@c -*- texinfo -*-

@chapter Installation

@ifset TEXT-ONLY
@include version.texi
@end ifset

This file documents the installation of the Display Ghostscript System,
@samp{DGS}.  Copyright (C) 1996-98 Free Software Foundation, Inc.
You may copy, distribute, and modify this file freely as long as you
preserve this copyright notice and permission notice.

@section Installing @samp{DGS} version @value{DGS-VERSION}

You need the following packages before you try to install @samp{DGS}:

@enumerate

@item ghostscript-fonts.
Fonts do not come with the @samp{DGS} package, you need to get these separately
from the same place you got the @samp{DGS} package, or from ftp.gnu.org or it's
mirrors, or the Ghostscript site @url{http://www.cs.wisc.edu/~ghost/index.html}

@item The Z compression/decompression library.
This library is already available on many GNU systems. The configuration
script will tell you if it cannot find the library. If you need it, you can
get it from the same place you got the @samp{DGS} package, or the latest version 
from @url{ftp://ftp.cdrom.com/pub/infozip/zlib/zlib.tar.gz}.

@item The PNG library.
This library is already available on many GNU systems. The configuration
script will tell you if it cannot find the library. If you need it, you can
get it from the same place you got the @samp{DGS} package, or the latest version 
from @url{ftp://swrinde.nde.swri.edu/pub/png/src}.

@item The glib library, Version 1.2.2 or greater.
This library is already available on many GNU systems. The configuration
script will tell you if it cannot find the library. If you need it, you can
get it from @url{http://www.gtk.org}

@item The JPEG library SOURCE files. 
The library is already available on many GNU systems. However to build
@samp{DGS}, SOURCE code of the library is needed. Most @samp{DGS}
distributions already include this code in a directory named jpeg.
You can get the library from @url{ftp://ftp.uu.net/graphics/jpeg/}.
See also gs/Make.htm and gs/gcc-unix.mak.in.

@end enumerate

Installation instructions:

@enumerate

@item 
Compile and install the zlib library, the png library, and the glib
library, if you do not already have them.

@item
Put the JPEG library source directory to @samp{DGS} directory or somewhere 
else, if you do not already have the JPEG library in the @samp{DGS} directory.

If you add the JPEG library source directory to the @samp{DGS} directory, 
you must rename the directory to `jpeg'.  For example, if you get the JPEG
library source files from @url{ftp://ftp.uu.net/graphics/jpeg/}, the file
name is jpegsrc.v6b.tar.gz. Make the @samp{DGS} directory current, then
uncompress and unpack the archive, creating a directory named jpeg-6b.
Rename jpeg-6b to jpeg.

If you put the JPEG library source elsewhere than the @samp{DGS} directory,
tell the configure script (described below) the place using the 
@samp{--with-jpeg-src-prefix=JPATH} option.
  
@item
Configure the package for your system.  In the directory that this file
is in, type @samp{./configure}.  If you're using @samp{csh} on an old
version of System V, you might need to type @samp{sh configure} instead
to prevent @samp{csh} from trying to execute @samp{configure} itself.
Read the generic installation instructions below for more options.

@item
Type @samp{make} to compile the package.  

@item
Type @samp{make install} to install programs, data files, and
documentation.

@item
After installing the programs, you need to install ghostscript fonts.
Change to the directory @file{prefix/share/ghostscript/fonts}, where
@samp{prefix} is the root directory that the programs are installed in.
You may have specified this on the command line when you invoked
configure, with the @samp{--prefix} argument, otherwise it is in some
default location, like @file{/usr}, or @file{/usr/local}.
From here, unpack/untar the fonts package into this directory.

Note: If you are installing @samp{DGS} into the GNUstep directory structure, the 
fonts go in a different place. See the section below on installing @samp{DGS} 
into the GNUstep directory structure.

@item
See if things work by trying a test program. Type:

@example
texteroids "A Cute String"
@end example

and see what happens. Good Luck!

@end enumerate

@section Generic installation/configuration instructions:

@enumerate

@item
Configure the package for your system.  In the directory that this file
is in, type @samp{./configure}.  If you're using @samp{csh} on an old
version of System V, you might need to type @samp{sh configure} instead
to prevent @samp{csh} from trying to execute @samp{configure} itself.

The @samp{configure} shell script attempts to guess correct values for
various system-dependent variables used during compilation, and creates
the Makefile(s) (one in each subdirectory of the source directory).  In
some packages it creates a C header file containing system-dependent
definitions.  It also creates a file @samp{config.status} that you can
run in the future to recreate the current configuration.

Running @samp{configure} takes less than a minute or two.  While it is
running, it prints some messages that tell what it is doing.  If you
don't want to see the messages, run @samp{configure} with its standard
output redirected to @samp{/dev/null}; for example:
@smallexample 
./configure >/dev/null
@end smallexample

To compile the package in a different directory from the one containing
the source code, you must use a version of make that supports the VPATH
variable, such as GNU make.  @samp{cd} to the directory where you want
the object files and executables to go and run @samp{configure}.
@samp{configure} automatically checks for the source code in the
directory that @samp{configure} is in and in @samp{..}.  If for some
reason @samp{configure} is not in the source code directory that you are
configuring, then it will report that it can't find the source code.  In
that case, run @samp{configure} with the option @samp{--srcdir=DIR},
where DIR is the directory that contains the source code.

By default, @samp{make install} will install the package's files in
/usr/local/bin, /usr/local/lib, /usr/local/man, etc.  You can specify
an installation prefix other than /usr/local by giving @samp{configure} the
option @samp{--prefix=PATH}.  Alternately, you can do so by giving a value
for the @samp{prefix} variable when you run @samp{make}, e.g.,
@smallexample
make prefix=/usr/gnu
@end smallexample

You can specify separate installation prefixes for architecture-specific
files and architecture-independent files.  If you give @samp{configure}
the option @samp{--exec_prefix=PATH} or set the @samp{make} variable
@samp{exec_prefix} to PATH, the package will use PATH as the prefix for
installing programs and libraries.  Data files and documentation will
still use the regular prefix.  Normally, all files are installed using
the regular prefix.

You can tell @samp{configure} to figure out the configuration for your
system, and record it in @samp{config.status}, without actually
configuring the package (creating @samp{Makefile}s and perhaps a
configuration header file).  To do this, give @samp{configure} the
@samp{--no-create} option.  Later, you can run @samp{./config.status} to
actually configure the package.  This option is useful mainly in
@samp{Makefile} rules for updating @samp{config.status} and
@samp{Makefile}.  You can also give @samp{config.status} the
@samp{--recheck} option, which makes it re-run @samp{configure} with the
same arguments you used before.  This is useful if you change
@samp{configure}.

@samp{configure} ignores any other arguments that you give it.

If your system requires unusual options for compilation or linking that
@samp{configure} doesn't know about, you can give @samp{configure}
initial values for some variables by setting them in the environment.
In Bourne-compatible shells, you can do that on the command line like
this:
@smallexample
CC='gcc -traditional' DEFS=-D_POSIX_SOURCE ./configure
@end smallexample

The @samp{make} variables that you might want to override with environment
variables when running @samp{configure} are:

(For these variables, any value given in the environment overrides the
value that @samp{configure} would choose:)
@table @samp

@item CC
C compiler program.  Default is @samp{cc}, or @samp{gcc} if @samp{gcc}
is in your PATH. 

@item INSTALL
Program to use to install files.
Default is @samp{install} if you have it, @samp{install.sh} otherwise.
@end table


(For these variables, any value given in the environment is added to
the value that @samp{configure} chooses:)
@table @samp

@item DEFS
Configuration options, in the form @samp{-Dfoo -Dbar ...}

@item LIBS
Libraries to link with, in the form @samp{-lfoo -lbar ...}
@end table

If you need to do unusual things to compile the package, we encourage
you to figure out how @samp{configure} could check whether to do them, and
mail diffs or instructions to the address given in the @samp{README} so we
can include them in the next release.


@item
Type @samp{make} to compile the package.  If you want, you can override
the @samp{make} variables @samp{CFLAGS} and @samp{LDFLAGS} like this:
@smallexample
	make CFLAGS=-O2 LDFLAGS=-s
@end smallexample


@item
Type @samp{make install} to install programs, data files, and
documentation.

@item
You can remove the program binaries and object files from the source
directory by typing @samp{make clean}.  To also remove the Makefile(s),
and @samp{config.status} (all the files that @samp{configure} created),
type @samp{make distclean}.

The file @samp{configure.in} is used as a template to create
@samp{configure} by a program called @samp{autoconf}.  You will only
need it if you want to regenerate @samp{configure} using a newer version
of @samp{autoconf}.

@end enumerate

@section Install @samp{DGS} within the GNUstep directory structure.

If you are using @samp{DGS} in combination with GNUstep then you may
prefer to install @samp{DGS} in the GNUstep directory structure; this
can be easily accomplished when configuring @samp{DGS} by simply
specifying the GNUstep root directory as the prefix.

@smallexample 
./configure --prefix=$GNUSTEP_SYSTEM_ROOT
@end smallexample

You must already have the GNUstep Makefile Package installed and the
GNUstep environment variables defined.  The file
@file{$GNUSTEP_SYSTEM_ROOT/share/config.site}, which will get processed
by @file{configure}, defines the appropriate Autoconf variables so that
the binaries, libraries and resource files of @samp{DGS} are installed
in the proper locations.

In this case, the @samp{DGS} programs get installed in 
@file{$GNUSTEP_SYSTEM_ROOT/Tools}, and the data files (including fonts)
get installed in @file{$GNUSTEP_SYSTEM_ROOT/Library/share/ghostscript}.
Be sure to install the fonts in this location, rather than the one specified
in the previous installation instructions.

