Ubuntu Manpage: utop - Universal toplevel for OCaml

NAME

       utop - Universal toplevel for OCaml

SYNOPSIS

       utop [ options ] [ object-files ] [ script-file ]

DESCRIPTION

utop is a enhanced toplevel for OCaml with many features, including context sensitive
completion.

When you start utop what you see is the prompt followed by a bar containing words. This is
the completion bar, it contains the possible completion and is updated as you type. The
highlighted word in the completion bar is the selected word. You can navigate using the
keys Alt+Left and Alt+Right and you can complete using the currently selected word by
pressing Alt+Tab (you can configure these bindings in the file ~/.config/lambda-term-
inputrc , see lambda-term-inputrc(5) for details).

utop supports completion on:

* directives and directive arguments
* identifiers
* record fields
* variants
* function labels
* object methods

Colors are by default configured for terminals with dark colors, such as white on black,
so the prompt may looks too bright on light colors terminals. You can change that by
setting the color profile of utop. For that type:

UTop.set_profile UTop.Light;;

You can then add this line to your ~/.config/utop/init.ml file.

To turn off utop's advanced prompt features, add the following to init.ml to turn off
respectively (a) colors and the upper information line, and (b) the lower boxed list of
possible completions:

#utop_prompt_dummy;;
UTop.set_show_box false

You can enable basic syntax highlighting in utop by writing a ~/.utoprc file. See
utoprc(5) for that.

Finally utop can run in emacs. For that you have to add the following line to your
~/.emacs file:

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

then you can run utop by pressing M-x and typing "utop". utop support completion in emacs
mode. Just press Tab to complete a word. You can also integrate it with the tuareg, caml
or typerex mode. For that add the following lines to your ~/.emacs file:

(autoload 'utop-minor-mode "utop" "Minor mode for utop" t)
(add-hook 'tuareg-mode-hook 'utop-minor-mode)

OPTIONS

       See  utop --help for the the list of available options. There is considerable overlap with
       options available for ocaml(1).

       A commonly used option is -require package to load package into the execution environment.
       It is equivalent to using #require from inside utop(1).

       -absname
              Show absolute filenames in error message.

       -I dir Add dir to the list of include directories.

       -init file
              Load file instead of default init file.

       -labels
              Use commuting label mode.

       -no-app-funct
              Deactivate applicative functors.

       -noassert
              Do not compile assertion checks.

       -nolabels
              Ignore non-optional labels in types.

       -nostdlib
              Do not add default directory to the list of include directories.

       -ppx command
              Pipe abstract syntax trees through preprocessor command.

       -principal
              Check principality of type inference.

       -safe-string
              Make strings immutable.

       -short-paths
              Shorten paths in types (the default).

       -no-short-paths
              Do not shorten paths in types.

       -rectypes
              Allow arbitrary recursive types.

       -stdin Read script from standard input.

       -strict-sequence
              Left-hand part of a sequence must have type unit.

       -unsafe
              Do not compile bounds checking on array and string access.

       -version
              Print version and exit.

       -vnum  Print version number and exit.

       -w list
              Enable or disable warnings according to list.

       -warn-error list
              Enable  or  disable error status for warnings according to list.  See option -w for
              the syntax of list.  Default setting is -a+31.

       -warn-help
              Show description of warning numbers.

       -emacs Run in emacs mode.

       -hide-reserved
              Hide identifiers starting with a '_' (the default).

       -show-reserved
              Show identifiers starting with a '_'.

       -no-implicit-bindings
              Don't add implicit bindings for expressions (the default).

       -implicit-bindings
              Add implicit bindings: expr;; -> let _0 = expr;;

       -no-autoload
              Disable autoloading of files in $OCAML_TOPLEVEL_PATH/autoload.

       -require package
              Load this package.

       -dparsetree
              Dump OCaml AST after rewriting.

       -dsource
              Dump OCaml source after rewriting.

       -help  Display this list of options.

       --help Display this list of options.

FILES

       ~/.config/utop/init.ml
              The initialization file of the toplevel.
       ~/.ocamlinit
              The alternative initialization file of the toplevel.
       ~/.utoprc
              The configuration file for utop. See utoprc(5).
       ~/.config/lambda-term-inputrc
              The file containing key bindings. See lambda-term-inputrc(5).

AUTHOR