Go to file
Pierre Weis 9c20fa10d8 Documentation.
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@5263 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
2002-11-15 10:57:14 +00:00
asmcomp amelioration de let rec 2002-11-07 17:57:23 +00:00
asmrun PR#1466 suite (et fin en ce qui concerne MacOS X) 2002-11-07 11:51:39 +00:00
boot changement des locations, deuxieme tranche 2002-11-02 22:36:46 +00:00
bytecomp amelioration de let rec 2002-11-07 17:57:23 +00:00
byterun DLL sur MacOS X 2002-11-14 19:01:26 +00:00
camlp4 changement des locations, suite 2002-11-05 13:52:50 +00:00
config Documentation LIBDIR, BINDIR 2002-08-19 12:24:23 +00:00
debugger changement des locations, suite 2002-11-05 16:33:24 +00:00
driver documentation 2002-11-04 12:40:51 +00:00
emacs interactions bizarres de with 2002-11-12 09:04:43 +00:00
lex changement des locations, deuxieme tranche 2002-11-02 22:36:46 +00:00
maccaml MacOS 9 2001-12-13 13:59:27 +00:00
man Typo (PR#1299) 2002-08-06 08:22:45 +00:00
ocamldoc gestion correcte du % 2002-11-14 14:41:32 +00:00
otherlibs do not depend on X11R6 2002-11-06 10:10:20 +00:00
parsing changement des locations 2002-11-14 20:06:59 +00:00
stdlib Documentation. 2002-11-15 10:57:14 +00:00
test amelioration de let rec 2002-11-07 17:57:23 +00:00
testasmcomp Nettoyage Makefile.nt pour Mingw 2002-06-11 08:30:20 +00:00
testlabl also tag driver 2002-11-08 07:13:53 +00:00
testobjects Changement de la licence 1999-11-17 18:59:06 +00:00
tools changement des locations, suite 2002-11-05 16:33:24 +00:00
toplevel changement des locations, premiere tranche 2002-11-01 17:06:47 +00:00
typing do not mark aliases as non-gen 2002-11-07 08:45:57 +00:00
utils changement des locations, premiere tranche 2002-11-01 17:06:47 +00:00
win32caml detabisation 2002-07-23 14:12:03 +00:00
yacc PR#63 2002-11-05 16:33:46 +00:00
.cvsignore changement des locations, premiere tranche 2002-11-01 17:06:47 +00:00
.depend changement des locations, premiere tranche 2002-11-01 17:06:47 +00:00
Changes amelioration de let rec 2002-11-07 17:57:23 +00:00
INSTALL add make world.opt 2002-07-01 01:21:45 +00:00
INSTALL.MPW MacOS 9 2001-12-13 13:59:27 +00:00
LICENSE Ajout d'une 'special exception' a la LGPL 2001-12-07 13:44:08 +00:00
Makefile + 2002-11-05 09:25:19 +00:00
Makefile.Mac + 2002-11-05 10:23:52 +00:00
Makefile.Mac.depend MacOS 9 2001-12-13 13:59:27 +00:00
Makefile.nt + 2002-11-05 10:23:52 +00:00
README Typo 2002-02-04 16:45:38 +00:00
README.win32 MAJ instructions Win98 2002-08-06 12:51:26 +00:00
Upgrading camlp4 under toplevel 2001-11-07 07:55:08 +00:00
configure bricole pour faciliter le debug de td_defs 2002-10-22 12:28:32 +00:00

README

OVERVIEW:

Objective Caml is an implementation of the ML language, based on
the Caml Light dialect extended with a complete class-based object system
and a powerful module system in the style of Standard ML.

Objective Caml comprises two compilers. One generates bytecode
which is then interpreted by a C program. This compiler runs quickly,
generates compact code with moderate memory requirements, and is
portable to essentially any 32 or 64 bit Unix platform. Performance of
generated programs is quite good for a bytecoded implementation:
almost twice as fast as Caml Light 0.7. This compiler can be used
either as a standalone, batch-oriented compiler that produces
standalone programs, or as an interactive, toplevel-based system.

The other compiler generates high-performance native code for a number
of processors. Compilation takes longer and generates bigger code, but
the generated programs deliver excellent performance, while retaining
the moderate memory requirements of the bytecode compiler. The
native-code compiler currently runs on the following platforms:

    Intel Pentium processors: PCs under Linux, FreeBSD, NetBSD, OpenBSD,
      Windows, NextStep, Solaris 2, BeOS.
    Alpha processors: Digital/Compaq Alpha machines under
      Digital Unix/Compaq Tru64, Linux, NetBSD and OpenBSD.
    Sparc processors: Sun Sparc under SunOS 4.1, Solaris 2, NetBSD, Linux
    Mips processors: SGI workstations and mainframes under IRIX 6
    HP PA-RISC processors: HP 9000/700 under HPUX 10
    PowerPC processors: IBM RS6000 and PowerPC workstations under AIX 4.3,
                        PowerMacintosh under MkLinux, LinuxPPC, MacOS X
    Strong ARM processors: Corel Netwinder under Linux
    Intel IA64 processors: prototypes under Linux

Other operating systems for the processors above have not been tested,
but the compiler may work under other operating systems with little work.

Before the introduction of objects, Objective Caml was known as Caml
Special Light. Objective Caml is almost upwards compatible with Caml
Special Light, except for a few additional reserved keywords that have
forced some renaming of standard library functions.

CONTENTS:

  Changes               what's new with each release
  INSTALL               instructions for installation
  INSTALL.MPW           infos on the Macintosh MPW port of Objective Caml
  LICENSE               license and copyright notice
  Makefile              main Makefile
  README                this file
  README.win32          infos on the MS Windows 98/ME/NT/2000 ports of O.Caml
  asmcomp/              native-code compiler and linker
  asmrun/               native-code runtime library
  boot/                 bootstrap compiler
  bytecomp/             bytecode compiler and linker
  byterun/              bytecode interpreter and runtime system
  config/               autoconfiguration stuff
  debugger/             source-level replay debugger
  driver/               driver code for the compilers
  emacs/                Caml editing mode and debugger interface for GNU Emacs
  lex/                  lexer generator
  maccaml/              the Macintosh GUI
  otherlibs/            several external libraries
  parsing/              syntax analysis
  stdlib/               standard library
  tools/                various utilities
  toplevel/             interactive system
  typing/               typechecking
  utils/                utility libraries
  yacc/                 parser generator

COPYRIGHT:

All files marked "Copyright INRIA" in this distribution are copyright
1996, 1997, 1998, 1999, 2000, 2001 Institut National de Recherche en
Informatique et en Automatique (INRIA) and distributed under the
conditions stated in file LICENSE.

INSTALLATION:

See the file INSTALL for installation instructions on Unix machines. 
For MS Windows, see README.win32.  For the Macintosh, see INSTALL.MPW.

DOCUMENTATION:

The Objective Caml manual is distributed in HTML, PDF, Postscript,
DVI, and Emacs Info files.  It can be obtained by anonymous FTP from
ftp.inria.fr as described below. It is also available on the World
Wide Web, at

        http://caml.inria.fr/

AVAILABILITY:

The complete Objective Caml distribution resides on ftp.inria.fr,
and can be accessed through a Web browser at

        http://caml.inria.fr/

or directly by anonymous FTP:

        host:       ftp.inria.fr (192.93.2.54)
        directory:  lang/caml-light

KEEPING IN TOUCH WITH THE CAML COMMUNITY:

There exists a mailing list of users of the Caml implementations
developed at INRIA. The purpose of this list is to share
experience, exchange ideas (and even code), and report on applications
of the Caml language. Messages can be written in English or in
French. The list has about 500 subscribers.

Messages to the list should be sent to:

              caml-list@inria.fr

If you wish to subscribe to this list, please send a message to:

              caml-list-request@inria.fr

with the single word "subscribe" in the body of the message.

Archives of the list are available on the World Wide Web at URL
http://caml.inria.fr/

The Usenet news groups comp.lang.ml and comp.lang.functional
also contains discussions about the ML family of programming languages,
including Caml.

BUG REPORTS AND USER FEEDBACK:

Send your bug reports by E-mail to:

              caml-bugs@inria.fr

or report them using the Web interface to the bug-tracking system
at http://caml.inria.fr/bin/caml-bugs

To be effective, bug reports should include a complete program
(preferably small) that exhibits the unexpected behavior, and the
configuration you are using (machine type, etc).

You can also contact the implementors directly at caml@inria.fr.