home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 7 / FreshFishVol7.bin / bbs / gnu / libg++-2.6-fsf.lha / libg++-2.6 / libg++ / README < prev    next >
Text File  |  1994-07-14  |  10KB  |  244 lines
  1. This is version 2.6 of libg++, the GNU C++ class library.
  2. Release date July 1994 by Cygnus Support
  3.  
  4. * Please skim through this once BEFORE attempting to make and install libg++.
  5.  
  6. * Contents
  7.  
  8.     * g++ source files (with their include files) are in the ./src directory
  9.     * Some simple tests and demo programs are in ./tests
  10.     * documentation is in ./libg++.texi.
  11.     * A perfect hash function generator is in ./gperf.
  12.     * Some miscellaneous files of possible interest are in ./etc
  13.       (These files are not officially a part of the libg++ distribution,
  14.       and are subject to arbitrary changes, deletions, etc. from release
  15.       to release.)
  16.  
  17. * Copyright restrictions
  18.  
  19. The GNU Library General Public License (which is in the file
  20. ../COPYING.LIB) covers all libraries (specificly libg++.a) and
  21. include files that get installed (by 'make install').
  22.  
  23. Other parts of the libg++ *distribution* that are not part the libg++
  24. *library* per se have the GNU General Public License (which is in the
  25. file ../COPYING).
  26.  
  27. Individual files should bear the appropriate Copyright (let us know
  28. if you think there is a mistake).  But specificly, if your application
  29. only uses files that are installed by the normal build+install
  30. procedure, then it is bound by the restrictions of the GNU Library
  31. General Public License, but not those of the GNU General Public License.
  32.  
  33. * Pre-installation
  34.  
  35.     * This version of libg++ works best with gcc-2.6 or newer.
  36.       It assume that gcc is responsible for fixing standard C include
  37.       files (such as stdio.h) so that they are suitable for C++
  38.       (Using the new fixproto script that is part of gcc-2.6).
  39.  
  40.     * If you're using gcc-2.0 or 2.1 you may need to move aside any
  41.       installed g++-include header files installed from previous versions
  42.       of libg++, since they might conflict with the new ones.
  43.       This is not necessary if your version of gcc supports the
  44.       -nostdinc++ flag.
  45.  
  46.       In general, install a version of gcc (which now includes g++)
  47.       with at least as high a version number as this version of libg++.
  48.  
  49.       You can compile libg++ using a gcc that you haven't installed.
  50.       The most convenient way to do that is to make a symlink named
  51.       gcc in the top-level directory (i.e. libg++-2.6) that points to
  52.       the directory containing the new gcc.  (You should end up with
  53.       libg++/../gcc/xgcc being a valid filename for the uninstalled gcc.)
  54.  
  55.     * With only trivial modifications (like changing file extensions,
  56.       etc.) everything (perhaps except for some demos in ./etc)
  57.       should compile and run with any 2.0 C++ compiler. Please tell me
  58.       if this is not so.
  59.  
  60.       Exactly what changes you make depends on what part of libg++ you want.
  61.       If you don't want to use the libg++ version of iostreams,
  62.       edit 'IO_DIR=../libio' to 'IO_DIR=no-stream' in ../libio/config.shared.
  63.       You then need to 'make' with CC and CXX set appropriately.
  64.       You also need to set 'NOSTDINC=' on the make command line.
  65.  
  66. * Installation (see libg++.texi more more details)
  67.  
  68.     * For VMS, cd to ./vms, and read AAAREADME.TXT
  69.       [NOTE:  The VMS support is obsolete.  We need a volunteer to fix it.]
  70.  
  71.     * Make sure your sed is *not* GNU sed version 1.12.
  72.       Most other versions (including GNU sed 1.13) should be OK.
  73.  
  74.     * Go to the directory *above* libg++ (i.e.. libg++-2.6).
  75.  
  76.     * Run './configure' to configure the tree and create Makefiles.
  77.  
  78.     Typical example:
  79.     ./configure [SYSTEM] --prefix=/usr/gnu
  80.  
  81.     The prefix says that installation should be into
  82.     /usr/gnu/lib, /usr/gnu/bin, etc as appropriate.
  83.  
  84.     The SYSTEM indicates what machine configuration you're
  85.     running on.  If you don't specify it, the system can usually
  86.     guess a default.
  87.  
  88.     IMPORTANT:  The configure options (including SYSTEM and
  89.     --prefix) must match those used to configure gcc, otherwise
  90.     g++ may fail to find libg++.
  91.  
  92.     See etc/cfg-paper.texi for more details.  (This paper is
  93.     in texinfo format;  see the section below on Installing
  94.     the Documentation on how to make it more readable.)
  95.  
  96.     * Type `make all "CC=gcc -O"'. (Builds libg++.a and some other things.)
  97.         (The "CC=gcc -O' is optional.  It forces use of gcc to compile
  98.     C programs.)
  99.  
  100.     * Optionally, type `make check' to make and run some tests/demos of libg++.
  101.  
  102.     * Before installing, if you have an old version that was installed
  103.     into the same directory(s), you should probably remove it.
  104.     (There is currently no clean mechanism to do that.
  105.     You should at least remove $(prefix)/lib/g++-include/*.h,
  106.     where $(prefix) is by default /usr/local.)
  107.  
  108.     * Type `make install'  to install 
  109.  
  110.         libg++.a          (from .)
  111.         include files     (from src and ../libio)
  112.         prototype files   (from src/gen)
  113.         etags             (from etc)
  114.         g++dep            (from etc)
  115.         some other stuff
  116.  
  117.         You may also want to install etc/c++-mode.el in your
  118.         emacs/lisp directory, probably in byte-compiled form.
  119.  
  120.     * Install the documentation
  121.  
  122.     If you are a systems administrator installing libg++ for others,
  123.     please make the documentation available to users!
  124.  
  125.     The libg++.texi file may be formatted as a paper document by
  126.  
  127.         * Get a copy of texinfo.tex. 
  128.             This file defines various tex macros used in libg++.texi
  129.             One is in the gcc release.
  130.             You can temporarily copy it into the current directory.
  131.         * Run tex on libg++.texi
  132.              and do whatever you normally do from there to print it.
  133.  
  134.     It may be made into an emacs info file:
  135.  
  136.     * use the 'makeinfo' program (from the texinfo distribution).
  137.  
  138.         * Copy these files into your emacs info directory
  139.             (normally somewhere like /usr/gnu/emacs/info).
  140.         * If you have not done so before, edit the emacs/info/dir file
  141.             to add a libg++ node, by inserting a line like
  142.         
  143.             * Libg++: (libg++).    The GNU C++ Library
  144.  
  145.             to the bottom of the file.
  146.  
  147.     * (Optional) Install, from ./etc
  148.         etags (version of etags that understands c++)
  149.         g++dep (a version of mkdep that understands c++)
  150.         c++-mode.el (a c++-mode for GNU emacs)
  151.  
  152. * Notes on compiling and running libg++/tests
  153.  
  154. tCurses is not automatically run through `checktests'.
  155. You must run it manually:
  156.  
  157. tCurses attempts to place one of each curses library primitive (boxes,
  158. strings, numbers...) on your screen, and asks for some input, to test
  159. curses input routines. Since there is no way to describe the output
  160. in a system- and terminal- independent way, you will have to be the 
  161. judge of whether it works acceptably.
  162.  
  163. tCurses (and the curses-based classes generally) may fail on the
  164. Sequent and perhaps other systems with unusual or old curses library
  165. implementations if you do not end input with a <linefeed> instead of
  166. the normal <carriage-return>.
  167.  
  168. It is a very good idea to also cd to the test directory and run tests
  169. manually, to see what they do. 
  170.  
  171. Compiling and running the tests consumes a fair amount of time and
  172. disk space!
  173.  
  174. Some reported diffs may be perfectly reasonable, owing to things like
  175. floating point precision differences: The expected.out file was created
  176. on a Sun4/110.
  177.  
  178.     Some tRational and tFix results depend on floating point precision
  179.     and may generate slightly different output on different machines.
  180.  
  181.     tRandom seeds some random-numbers in a way that also relies on
  182.     floating-point representations -- Your output should be numerically
  183.     similar, but probably not identical.
  184.  
  185. * Changes since previous versions(s).
  186.  
  187.     See the file NEWS.
  188.  
  189. * Known bugs and problems
  190.  
  191.     * The file etc/HINTS is an emacs RMAIL file that contains recent
  192.         bug-lib-g++ list mail and related messages that may be useful.
  193.  
  194.     * If "make install" fails with the error message:
  195.  
  196.     Static constructor test failed - see libg++.README
  197.  
  198.       this indicates an error in installing gcc.
  199.       C++ needs special linker support beyond that needed for C, to make
  200.       sure that static objects get initialized and destroyed properly.
  201.       Some linkers (including the GNU linker as well as linkers for
  202.       the Elf object file format) already provide the needed support.
  203.       In other ca