*  XXCalc INSTALL file
*  Copyright (C)  2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
*                 2011, 2012, 2013  Ivano Primi  <ivprimi@libero.it>    
*
*   Copying and distribution of this file, with or without modification,
*   are permitted in any medium without royalty provided the copyright
*   notice and this notice are preserved.
*
***************************************************************************

INSTRUCTIONS FOR THE INSTALLATION OF THE XXCalc LIBRARY ON AN UNIX(R)
SYSTEM.

Before the installation of the XXCalc library you should make sure that the
system where you are going to install the library provides:

1 - The `bash' shell (or another shell sh-compatible);
2 - The `GNU make' utility;
3 - Whatever you need to compile an ANSI-C program. The compiler
    should accept at least the options -c (for compile only), 
    -I (to specify the path where to search for non-standard include files) 
    and -D (to define macros).
    I built up the library and tested it by using the GNU C Compiler (gcc) 
    (I worked with the versions 2.95.3 on SunOS(R) 5.8, 3.2.2 on RedHat 
    Linux(R) 9.0, 3.2.3 on Slackware(R) GNU/Linux 9.1, and 4.7.2 on Linux 
    Mint(R) 14). 
    If you are interested in gcc you may get it at the address

		gcc.gnu.org		.


TO START THE BUILDING OF THE LIBRARY XXCalc (WHOSE FINAL NAME WILL
BE `libxxcalc.a': THE SUPPLIED MAKEFILE WILL ONLY CREATE A STATIC
VERSION OF THE LIBRARY), YOU SHOULD OPEN A SHELL AND ENTER IN THE DIRECTORY
CONTAINING THE SOURCE OF THE LIBRARY (AND THIS FILE TOO). THEN, AFTER
HAVING A LOOK AT THE SUPPLIED MAKEFILE TO EVENTUALLY CHANGE SOME PREDEFINED
SETTINGS, YOU CAN SIMPLY LAUNCH THE COMMAND:

	make install

THIS WILL BUILD AND INSTALL THE LIBRARY INTO '/usr/local/lib', THE NECESSARY
HEADER FILES INTO '/usr/local/include/xxcalc', THE DOCUMENTATION INTO
'/usr/local/doc/xxcalc', AND THE TOOL xxcconf INTO '/usr/local/bin'.

You may change the root directory of the installation by changing
the value of the variable PREFIX within the supplied makefile:
'make install' will put the archive file of the library in "$PREFIX/lib",
the header files in "$PREFIX/include/xxcalc", the documentation
in "$PREFIX/doc/xxcalc" and the program xxcconf in "$PREFIX/bin".
If one or more of these subdirectories do not exist the installation procedure
will try to create them.

You may also change the values of the variables LIBDIR, INCLUDEDIR, BINDIR 
or/and DOCDIR to control in a better way where the installation procedure will
put the files to be installed. 
Of course, all these modifications should be done before
launching the command 'make install'.
Mind that, if you want to install the library inside a system-directory,
you will have to launch the 'make install' command as root.

If you are a programmer and you want to contribute to the debug of the
XXCalc library then you can be interested in producing
debugging informations for the code you are about to compile;
you can do this by defining the variable DEBUG_MACRO (see makefile)
as '-g' (or -g2, -g3, -ggdb if you are using the gcc compiler).
I assume that your compiler uses -g as debugging option: if your
compiler makes use of another option to switches the production of
debugging symbols on, then you should use that one instead of -g. 

If you want to produce optimized code and gcc is your compiler, 
then you should define the variable OPT_MACRO as '-O' or '-O2'.
	
If gcc is your compiler, you can enable debug
and optimization at the same time (if you wish to do so).

After the installation, you can use the commands:

'make clean'		to remove the file xxcconf, the object-files 
      			and the archive file of XXCalc (libxxcalc.a) from
			the source directory of the library,

'make uninstall' 	to remove the library, the header files and the other
      			files previously installed from their destinations.

'make uninstall' will also remove the subdirectory 'xxcalc' from 'PREFIX/doc'
and from 'PREFIX/include'.

I am sorry, but I do not supply the Makefile for Microsoft Windows(R) 
or MacOS X(R), I work only on GNU/Linux(R) and SunOS(R).

For information on how to use XXCalc functions in your code and 
how to build your XXCalc based programs, see README.xxcalc and REFMAN.xxcalc
(both files are contained in the same directory where you have found 
 this file).

