API reference for utop : Index of values

# Index of values

A
add_keyword [UTop] | Add a new OCaml keyword.
at_new_command [UTop] | `at_new_command f` adds `f` to the hooks executed before each new commands.
auto_run_async [UTop] | If `true` (the default) toplevel Async expressions are automatically run with in a separate thread with `Thread_safe.block_on_async_exn`.
auto_run_lwt [UTop] | If `true` (the default) toplevel lwt expressions are automatically run with `Lwt_main.run`.
C
check_phrase [UTop] | `check_phrase phrase` checks that `phrase` can be executed without typing or compilation errors.
collect_formatters [UTop] | `collect_formatters buf pps f` executes `f` and redirect everything it prints on `pps` to `buf`.
count [UTop] | The number of commands already executed.
D
discard_formatters [UTop] | `discard_formatters pps f` executes `f`, dropping everything it prints on `pps`.
E
end_and_accept_current_phrase [UTop] | Action that add the phrase terminator at the end of the current phrase and accepts it.
external_editor [UTop] | External editor command.
G
get_auto_run_async [UTop] | Returns the value of `UTop.auto_run_async`.
get_auto_run_lwt [UTop] | Returns the value of `UTop.auto_run_lwt`.
get_external_editor [UTop] |
get_hide_reserved [UTop] | Returns the value of `UTop.hide_reserved`.
get_message [UTop] | `get_message printer x` applies `printer` on `x` and returns everything it prints as a string.
get_ocaml_error_message [UTop] | `get_ocaml_error_message exn` returns the location and error message for the exception `exn` which must be an exception from the compiler.
get_phrase_terminator [UTop] | Returns the value of `UTop.phrase_terminator`.
get_show_box [UTop] | Returns the value of `UTop.show_box`.
get_syntax [UTop] | Returns the current value of `UTop.syntax`.
get_topfind_verbose [UTop] | Returns the value of `UTop.topfind_verbose`.
get_ui [UTop] | Returns the user interface in use.
H
hide_reserved [UTop] | If `true` (the default) identifiers starting with a '_' will be hidden from the output.
history [UTop] | The history used by utop.
history_file_max_entries [UTop] | Maximum entries to store in the history file.
history_file_max_size [UTop] | Maximum size of the history file.
history_file_name [UTop] | Name of the history file.
I
input_name [UTop] | The name you must use in location to let ocaml know that it is from the toplevel.
interact [UTop_main] |
K
key_sequence [UTop] | The current key sequence entered by the user.
keywords [UTop] | The set of OCaml keywords.
L
lexbuf_of_string [UTop] | `lexbuf_of_string eof str` is the same as `Lexing.from_string str` except that if the lexer reach the end of `str` then `eof` is set to `true`.
load_path [UTop] | `load_path` is an alias of `Config.load_path`, normally hidden in toplevel.
M
main [UTop_main] | Start utop.
N
new_command_hooks [UTop] | Functions called before each new command.
P
parse_default [UTop] | The default parser.
parse_toplevel_phrase [UTop] | `parse_toplevel_phrase` is the function used to parse a phrase typed in the toplevel.
parse_toplevel_phrase_default [UTop] | The default parser for toplevel phrases.
parse_use_file [UTop] |
parse_use_file_default [UTop] | The default parser for toplevel regions.
phrase_terminator [UTop] | The phrase terminator.
profile [UTop] | The color profile.
prompt [UTop] | The prompt.
R
require [UTop] | Load all the given findlib packages
S
set_auto_run_async [UTop] | Modifies `UTop.auto_run_async`.
set_auto_run_lwt [UTop] | Modifies `UTop.auto_run_lwt`.
set_external_editor [UTop] |
set_hide_reserved [UTop] | Modifies `UTop.hide_reserved`.
set_margin_function [UTop] | Margin of the standard and error formatters as a function of the screen size.
set_phrase_terminator [UTop] | Modifies `UTop.phrase_terminator`.
set_profile [UTop] | Sets the color profile.
set_show_box [UTop] | Modifies `UTop.show_box`.
set_syntax [UTop] | Changes the syntax used in utop.
set_topfind_verbose [UTop] | Modifies `UTop.topfind_verbose`.
show_box [UTop] | If `true` (the default) the completion bar is displayed.
size [UTop] | The current size of the terminal.
split_words [UTop] |
syntax [UTop] | The syntax in use.
T
time [UTop] | The time of the beginning of the current command.
topfind_log [UTop] | List of messages logged by findlib since the beginning of the session.
topfind_verbose [UTop] | If `false` (the default) messages from findlib are hidden.
V
version [UTop] | Version of utop.