experimental patches to utop
Go to file
Jeremie Dimino 41e8b10e64 add Toploop and Topmain manually to the list of modules to keep
Ignore-this: c300c14dfd007c9ab16616c7be150466

darcs-hash:20120731145322-c41ad-584b36703d3e719d8e0e5acefb276a6a40201e1a
2012-07-31 16:53:22 +02:00
man typerex mode integration 2012-02-22 20:19:10 +01:00
src allow to complete text in a tuareg buffer using the toplevel environment 2012-07-16 17:40:00 +02:00
syntax next gen utop 2012-02-11 10:21:07 +01:00
utils fix the install-compiler-libs.sh script on Windows 2011-09-20 01:50:11 +02:00
CHANGES update CHANGES 2012-07-31 07:33:18 +02:00
LICENSE fix LICENSE date 2011-08-25 10:22:13 +02:00
README allow to complete text in a tuareg buffer using the toplevel environment 2012-07-16 17:40:00 +02:00
_oasis bump version number 2012-07-30 20:01:30 +02:00
_tags Basic functionality is almost there, however still plenty to make it production quality. In this changeset I regenerated setup.ml via. oasis 3 so it contains a huge diff. 2012-03-21 04:15:30 +01:00
boring next gen utop 2012-02-11 10:21:07 +01:00
dist.sh initial import 2011-07-23 08:59:13 +02:00
myocamlbuild.ml add Toploop and Topmain manually to the list of modules to keep 2012-07-31 16:53:22 +02:00
predist.sh add a script to install compiler libraries 2011-08-03 13:32:51 +02:00
setup.ml fix setup.ml 2012-04-25 08:08:51 +02:00
style.css build ocamldoc documentation 2011-08-04 14:54:57 +02:00
utoprc-dark remove unused gtk resources 2012-02-26 19:28:02 +01:00
utoprc-light remove unused gtk resources 2012-02-26 19:28:02 +01:00

README

A universal toplevel for OCaml.

url: https://forge.ocamlcore.org/projects/utop/

* Requirements:

  utop depends on the following packages:

  * findlib      (http://projects.camlcity.org/projects/findlib.html)
  * react        (http://erratique.ch/software/react)
  * lwt          (http://ocsigen.org/lwt/)
  * camomile     (http://camomile.sourceforge.net/)
  * zed          (http://forge.ocamlcore.org/projects/zed/)
  * lambda-term  (http://forge.ocamlcore.org/projects/lambda-term/)

  Lwt must be compiled with react support, configure it with:

    $ ./configure --enable-react

  utop also requires OCaml compiler libraries. If you are using
  debian, they are available as the package ocaml-compiler-libs, if
  you are using godi, they are installed by default. If you installed
  ocaml by hand, you can run the script utils/install-compiler-libs.sh.

* Installation:

  To compile and install lambda-term just type:

    $ ocaml setup.ml -configure
    $ ocaml setup.ml -build
    $ ocaml setup.ml -install

  If you get the development version of utop you must obtain oasis
  (http://oasis.forge.ocamlcore.org/).

* Usage:

  To use utop, simply run:

    $ utop

  utop display a bar after the prompt which is used to show possible
  completions in real-time. You can navigate in it using Alt+Left and
  Alt+Right, and select one completion using Alt+Tab.

* Customization:

  To add colors to utop, copy one of the files utoprc-dark or
  utoprc-light to ~/.utoprc. utoprc-dark is for terminals with dark
  colors (such as white on black) and utoprc-light is for terminals
  with light colors (such as black on white).

  You can also customize the prompt of utop by setting the reference
  UTop.prompt.

* Integration with emacs:

  To use utop in emacs, add the following line to your ~/.emacs file:

    (autoload 'utop "utop" "Toplevel for OCaml" t)

  Then you can run utop by executing the command "utop" in emacs.

* Integration with the tuareg/typerex mode:

  You can replace the default toplevel used by the tuareg or typerex
  mode by utop, for that add the following lines to your ~/.emacs
  file:

    (autoload 'utop-setup-ocaml-buffer "utop" "Toplevel for OCaml" t)
    (add-hook 'tuareg-mode-hook 'utop-setup-ocaml-buffer)
    (add-hook 'typerex-mode-hook 'utop-setup-ocaml-buffer)

  You can also complete text in a tuareg or typerex buffer using the
  environment of the toplevel. For that bind the function
  "utop-edit-complete" to the key you want.

* Development:

  The last development version of utop can always be found in the
  darcs repository hosted at darcs.ocamlcore.org:

  $ darcs get http://darcs.ocamlcore.org/repos/utop