Your company here — click to reach over 10,000 unique daily visitors

Package ocaml-docs

Documentation for OCaml


OCaml is a high-level, strongly-typed, functional and object-oriented
programming language from the ML family of languages.

This package contains man pages.

Version: 5.2.0

General Commands

ocaml The OCaml interactive toplevel
ocamlc The OCaml bytecode compiler
ocamlc.opt alias for ocamlc
ocamlcp The OCaml profiling compilers
ocamldebug the OCaml source-level replay debugger.
ocamldep Dependency generator for OCaml
ocamldoc The OCaml documentation generator
ocamllex The OCaml lexer generator
ocamlmktop Building custom toplevel systems
ocamlopt The OCaml native-code compiler
ocamlopt.opt alias for ocamlopt
ocamloptp alias for ocamlcp
ocamlprof The OCaml profiler
ocamlrun The OCaml bytecode interpreter
ocamlyacc The OCaml parser generator

Library Functions

Arg.3o Parsing of command line arguments.
Arg_helper.3o Decipher command line arguments of the form <value> | <key>=<value>,...
Arg_helper.Make.3o no description
Array.3o Array operations.
ArrayLabels.3o Array operations.
Ast_helper.3o Helpers to produce Parsetree fragments
Ast_helper.Attr.3o Attributes
Ast_helper.Cf.3o Class fields
Ast_helper.Ci.3o Classes
Ast_helper.Cl.3o Class expressions
Ast_helper.Const.3o no description
Ast_helper.Csig.3o Class signatures
Ast_helper.Cstr.3o Class structures
Ast_helper.Ctf.3o Class type fields
Ast_helper.Cty.3o Class type expressions
Ast_helper.Exp.3o Expressions
Ast_helper.Incl.3o Includes
Ast_helper.Mb.3o Module bindings
Ast_helper.Md.3o Module declarations
Ast_helper.Mod.3o Module expressions
Ast_helper.Ms.3o Module substitutions
Ast_helper.Mtd.3o Module type declarations
Ast_helper.Mty.3o Module type expressions
Ast_helper.Of.3o Object fields
Ast_helper.Opn.3o Opens
Ast_helper.Pat.3o Patterns
Ast_helper.Rf.3o Row fields
Ast_helper.Sig.3o Signature items
Ast_helper.Str.3o Structure items
Ast_helper.Te.3o Type extensions
Ast_helper.Typ.3o Type expressions
Ast_helper.Type.3o Type declarations
Ast_helper.Val.3o Value declarations
Ast_helper.Vb.3o Value bindings
Ast_invariants.3o Check AST invariants
Ast_iterator.3o Ast_iterator.iterator enables AST inspection using open recursion.
Ast_mapper.3o The interface of a -ppx rewriter
Asttypes.3o Auxiliary AST types used by parsetree and typedtree.
Atomic.3o Atomic references.
Attr_helper.3o Helpers for attributes
Bigarray.3o Large, multi-dimensional, numerical arrays.
Bigarray.Array0.3o Zero-dimensional arrays.
Bigarray.Array1.3o One-dimensional arrays.
Bigarray.Array2.3o Two-dimensional arrays.
Bigarray.Array3.3o Three-dimensional arrays.
Bigarray.Genarray.3o no description
Binutils.3o no description
Bool.3o Boolean values.
Buffer.3o Extensible buffers.
Build_path_prefix_map.3o Rewrite paths for reproducible builds
Builtin_attributes.3o Support for the builtin attributes:
Bytes.3o Byte sequence operations.
BytesLabels.3o Byte sequence operations.
Callback.3o Registering OCaml values with the C runtime.
CamlinternalFormat.3o no description
CamlinternalFormatBasics.3o no description
CamlinternalLazy.3o Run-time support for lazy values.
CamlinternalMenhirLib.3o no description
CamlinternalMenhirLib.Convert.3o no description
CamlinternalMenhirLib.Convert.Simplified.3o no description
CamlinternalMenhirLib.Engine.3o no description
CamlinternalMenhirLib.Engine.Make.3o no description
CamlinternalMenhirLib.EngineTypes.3o no description
CamlinternalMenhirLib.EngineTypes.ENGINE.3o no description
CamlinternalMenhirLib.EngineTypes.INCREMENTAL_ENGINE_START.3o no description
CamlinternalMenhirLib.EngineTypes.MONOLITHIC_ENGINE.3o no description
CamlinternalMenhirLib.EngineTypes.TABLE.3o no description
CamlinternalMenhirLib.EngineTypes.TABLE.Log.3o no description
CamlinternalMenhirLib.ErrorReports.3o no description
CamlinternalMenhirLib.General.3o no description
CamlinternalMenhirLib.IncrementalEngine.3o no description
CamlinternalMenhirLib.IncrementalEngine.EVERYTHING.3o no description
CamlinternalMenhirLib.IncrementalEngine.INCREMENTAL_ENGINE.3o no description
CamlinternalMenhirLib.IncrementalEngine.INSPECTION.3o no description
CamlinternalMenhirLib.IncrementalEngine.SYMBOLS.3o no description
CamlinternalMenhirLib.InfiniteArray.3o no description
CamlinternalMenhirLib.InspectionTableFormat.3o no description
CamlinternalMenhirLib.InspectionTableFormat.TABLES.3o no description
CamlinternalMenhirLib.InspectionTableInterpreter.3o no description
CamlinternalMenhirLib.InspectionTableInterpreter.Make.3o no description
CamlinternalMenhirLib.InspectionTableInterpreter.Symbols.3o no description
CamlinternalMenhirLib.LexerUtil.3o no description
CamlinternalMenhirLib.LinearizedArray.3o no description
CamlinternalMenhirLib.PackedIntArray.3o no description
CamlinternalMenhirLib.Printers.3o no description
CamlinternalMenhirLib.Printers.Make.3o no description
CamlinternalMenhirLib.RowDisplacement.3o no description
CamlinternalMenhirLib.StaticVersion.3o no description
CamlinternalMenhirLib.TableFormat.3o no description
CamlinternalMenhirLib.TableFormat.TABLES.3o no description
CamlinternalMenhirLib.TableInterpreter.3o no description
CamlinternalMenhirLib.TableInterpreter.MakeEngineTable.3o no description
CamlinternalMod.3o Run-time support for recursive modules.
CamlinternalOO.3o Run-time support for objects and classes.
Ccomp.3o Compiling C files and building C libraries
Char.3o Character operations.
Clflags.3o Command line flags
Clflags.Compiler_pass.3o no description
Clflags.Float_arg_helper.3o Optimization parameters represented as floats indexed by round number.
Clflags.Int_arg_helper.3o Optimization parameters represented as ints indexed by round number.
Compiler_libs.3o Warning This library is part of the internal OCaml compiler API, and is not the language standard library.
Complex.3o Complex numbers.
Compression.3o no description
Condition.3o Condition variables.
Config.3o System configuration
Config_boot.3o System configuration
Config_main.3o System configuration
Consistbl.3o Consistency tables: for checking consistency of module CRCs
Consistbl.Make.3o no description
Depend.3o Module dependencies.
Depend.String.3o no description
Diffing.3o Parametric diffing
Diffing.Define.3o Define(Defs) creates the diffing types from the types defined in Defs and the functors that need to be instantatied with the diffing algorithm parameters
Diffing.Define.Left_variadic.3o Variadic diffing
Diffing.Define.Parameters.3o no description
Diffing.Define.Right_variadic.3o no description
Diffing.Define.S.3o no description
Diffing.Define.Simple.3o no description
Diffing.Defs.3o The core types of a diffing implementation
Diffing_with_keys.3o When diffing lists where each element has a distinct key, we can refine the diffing patch by introducing two composite edit moves: swaps and moves.
Diffing_with_keys.Define.3o no description
Diffing_with_keys.Define.Parameters.3o no description
Diffing_with_keys.Define.Simple.3o no description
Digest.3o Message digest.
Digest.BLAKE128.3o BLAKE128 is the BLAKE2b hash function producing 128-bit (16-byte) digests.
Digest.BLAKE256.3o BLAKE256 is the BLAKE2b hash function producing 256-bit (32-byte) digests.
Digest.BLAKE512.3o BLAKE512 is the BLAKE2b hash function producing 512-bit (64-byte) digests.
Digest.MD5.3o MD5 is the MD5 hash function.
Digest.S.3o The signature for a hash function that produces digests of length hash_length from character strings, byte arrays, and files.
Docstrings.3o Documentation comments
Docstrings.WithMenhir.3o no description
Domain.3o no description
Domain.DLS.3o no description
Domainstate.3o no description
Dynarray.3o Dynamic arrays.
Dynlink.3o Dynamic loading of .cmo, .cma and .cmxs files.
Effect.3o no description
Effect.Deep.3o no description
Effect.Shallow.3o no description
Either.3o Either type.
Ephemeron.3o Ephemerons and weak hash tables.
Ephemeron.K1.3o Ephemerons with one key.
Ephemeron.K1.Bucket.3o no description
Ephemeron.K1.Make.3o Functor building an implementation of a weak hash table
Ephemeron.K1.MakeSeeded.3o Functor building an implementation of a weak hash table.
Ephemeron.K2.3o Ephemerons with two keys.
Ephemeron.K2.Bucket.3o no description
Ephemeron.K2.Make.3o Functor building an implementation of a weak hash table
Ephemeron.K2.MakeSeeded.3o Functor building an implementation of a weak hash table.
Ephemeron.Kn.3o Ephemerons with arbitrary number of keys of the same type.
Ephemeron.Kn.Bucket.3o no description
Ephemeron.Kn.Make.3o Functor building an implementation of a weak hash table
Ephemeron.Kn.MakeSeeded.3o Functor building an implementation of a weak hash table.
Ephemeron.S.3o The output signature of the functors Ephemeron.K1.Make and Ephemeron.K2.Make.
Ephemeron.SeededS.3o The output signature of the functors Ephemeron.K1.MakeSeeded and Ephemeron.K2.MakeSeeded.
Event.3o First-class synchronous communication.
Filename.3o Operations on file names.
Float.3o Floating-point arithmetic.
Float.Array.3o Float arrays with packed representation.
Float.ArrayLabels.3o Float arrays with packed representation (labeled functions).
Format.3o Pretty-printing.
Format_tutorial.3o Using the Format module
Fun.3o Function manipulation.
Gc.3o Memory management control and statistics; finalised values.
Gc.Memprof.3o Memprof is a profiling engine which randomly samples allocated memory words.
Hashtbl.3o Hash tables and hash functions.
Hashtbl.HashedType.3o The input signature of the functor Hashtbl.Make.
Hashtbl.Make.3o Functor building an implementation of the hashtable structure.
Hashtbl.MakeSeeded.3o Functor building an implementation of the hashtable structure.
Hashtbl.S.3o The output signature of the functor Hashtbl.Make.
Hashtbl.SeededHashedType.3o The input signature of the functor Hashtbl.MakeSeeded.
Hashtbl.SeededS.3o The output signature of the functor Hashtbl.MakeSeeded.
Identifiable.3o Uniform interface for common data structures over various things.
Identifiable.Make.3o no description
Identifiable.Map.3o no description
Identifiable.Map.T.3o no description
Identifiable.Pair.3o no description
Identifiable.S.3o no description
Identifiable.S.Map.3o no description
Identifiable.S.Set.3o no description
Identifiable.S.T.3o no description
Identifiable.S.Tbl.3o no description
Identifiable.Set.3o no description
Identifiable.Set.T.3o no description
Identifiable.Tbl.3o no description
Identifiable.Tbl.T.3o no description
Identifiable.Thing.3o no description
In_channel.3o Input channels.
Int.3o Integer values.
Int32.3o 32-bit integers.
Int64.3o 64-bit integers.
Int_replace_polymorphic_compare.3o no description
Lazy.3o Deferred computations.
Lazy_backtrack.3o no description
Lexer.3o The lexical analyzer
Lexing.3o The run-time library for lexers generated by ocamllex.
List.3o List operations.
ListLabels.3o List operations.
Load_path.3o Management of include directories.
Load_path.Dir.3o no description
Local_store.3o This module provides some facilities for creating references (and hash tables) which can easily be snapshoted and restored to an arbitrary version.
Location.3o Source code locations (ranges of positions), used in parsetree.
Longident.3o Long identifiers, used in parsetree.
Map.3o Association tables over ordered types.
Map.Make.3o Functor building an implementation of the map structure given a totally ordered type.
Map.OrderedType.3o Input signature of the functor Map.Make.
Map.S.3o Output signature of the functor Map.Make.
Marshal.3o Marshaling of data structures.
Misc.3o Miscellaneous useful types and functions
Misc.Color.3o Color support detection
Misc.Error_style.3o no description
Misc.Int_literal_converter.3o no description
Misc.Magic_number.3o no description
Misc.Stdlib.3o no description
Misc.Stdlib.Array.3o Extensions to the Array module
Misc.Stdlib.List.3o Extensions to the List module
Misc.Stdlib.Option.3o Extensions to the Option module
Misc.Stdlib.String.3o Extensions to the String module
Misc.Stdlib.String.Map.3o no description
Misc.Stdlib.String.Set.3o no description
Misc.Stdlib.String.Tbl.3o no description
Misc.Style.3o no description
MoreLabels.3o Extra labeled libraries.
MoreLabels.Hashtbl.3o no description
MoreLabels.Hashtbl.HashedType.3o The input signature of the functor MoreLabels.Hashtbl.Make.
MoreLabels.Hashtbl.Make.3o Functor building an implementation of the hashtable structure.
MoreLabels.Hashtbl.MakeSeeded.3o Functor building an implementation of the hashtable structure.
MoreLabels.Hashtbl.S.3o The output signature of the functor MoreLabels.Hashtbl.Make.
MoreLabels.Hashtbl.SeededHashedType.3o The input signature of the functor MoreLabels.Hashtbl.MakeSeeded.
MoreLabels.Hashtbl.SeededS.3o The output signature of the functor MoreLabels.Hashtbl.MakeSeeded.
MoreLabels.Map.3o no description
MoreLabels.Map.Make.3o Functor building an implementation of the map structure given a totally ordered type.
MoreLabels.Map.OrderedType.3o Input signature of the functor MoreLabels.Map.Make.
MoreLabels.Map.S.3o Output signature of the functor MoreLabels.Map.Make.
MoreLabels.Set.3o no description
MoreLabels.Set.Make.3o Functor building an implementation of the set structure given a totally ordered type.
MoreLabels.Set.OrderedType.3o Input signature of the functor MoreLabels.Set.Make.
MoreLabels.Set.S.3o Output signature of the functor MoreLabels.Set.Make.
Mutex.3o Locks for mutual exclusion.
Nativeint.3o Processor-native integers.
Numbers.3o Modules about numbers, some of which satisfy Identifiable.S.
Numbers.Float.3o no description
Numbers.Int.3o no description
Numbers.Int16.3o no description
Numbers.Int8.3o no description
Obj.3o Operations on internal representations of values.
Obj.Ephemeron.3o no description
Obj.Extension_constructor.3o no description
Ocaml_operators.3o Precedence level and associativity of operators
Oo.3o Operations on objects
Option.3o Option values.
Out_channel.3o Output channels.
Parse.3o Entry points in the parser
Parser.3o no description
Parser.Incremental.3o no description
Parser.MenhirInterpreter.3o no description
Parsetree.3o Abstract syntax tree produced by parsing
Parsing.3o The run-time library for parsers generated by ocamlyacc.
Pparse.3o Driver for the parser and external preprocessors.
Pprintast.3o Pretty-printers for Parsetree
Printast.3o Raw printer for Parsetree
Printexc.3o Facilities for printing exceptions and inspecting current call stack.
Printexc.Slot.3o no description
Printf.3o Formatted output functions.
Profile.3o Compiler performance recording
Queue.3o First-in first-out queues.
Random.3o Pseudo-random number generators (PRNG).
Random.State.3o no description
Result.3o Result values.
Runtime_events.3o Runtime events — ring buffer-based runtime tracing
Runtime_events.Callbacks.3o no description
Runtime_events.Timestamp.3o no description
Runtime_events.Type.3o no description
Runtime_events.User.3o no description
Scanf.3o Formatted input functions.
Scanf.Scanning.3o no description
Semaphore.3o Semaphores
Semaphore.Binary.3o no description
Semaphore.Counting.3o no description
Seq.3o Sequences.
Set.3o Sets over ordered types.
Set.Make.3o Functor building an implementation of the set structure given a totally ordered type.
Set.OrderedType.3o Input signature of the functor Set.Make.
Set.S.3o Output signature of the functor Set.Make.
Stack.3o Last-in first-out stacks.
StdLabels.3o Standard labeled libraries.
StdLabels.Array.3o no description
StdLabels.Bytes.3o no description
StdLabels.List.3o no description
StdLabels.String.3o no description
Stdlib.3o The OCaml Standard library.
Stdlib.Arg.3o no description
Stdlib.Array.3o no description
Stdlib.ArrayLabels.3o no description
Stdlib.Atomic.3o no description
Stdlib.Bigarray.3o no description
Stdlib.Bool.3o no description
Stdlib.Buffer.3o no description
Stdlib.Bytes.3o no description
Stdlib.BytesLabels.3o no description
Stdlib.Callback.3o no description
Stdlib.Char.3o no description
Stdlib.Complex.3o no description
Stdlib.Condition.3o no description
Stdlib.Digest.3o no description
Stdlib.Domain.3o no description
Stdlib.Dynarray.3o no description
Stdlib.Effect.3o no description
Stdlib.Either.3o no description
Stdlib.Ephemeron.3o no description
Stdlib.Filename.3o no description
Stdlib.Float.3o no description
Stdlib.Format.3o no description
Stdlib.Fun.3o no description
Stdlib.Gc.3o no description
Stdlib.Hashtbl.3o no description
Stdlib.In_channel.3o no description
Stdlib.Int.3o no description
Stdlib.Int32.3o no description
Stdlib.Int64.3o no description
Stdlib.LargeFile.3o Operations on large files.
Stdlib.Lazy.3o no description
Stdlib.Lexing.3o no description
Stdlib.List.3o no description
Stdlib.ListLabels.3o no description
Stdlib.Map.3o no description
Stdlib.Marshal.3o no description
Stdlib.MoreLabels.3o no description
Stdlib.Mutex.3o no description
Stdlib.Nativeint.3o no description
Stdlib.Obj.3o no description
Stdlib.Oo.3o no description
Stdlib.Option.3o no description
Stdlib.Out_channel.3o no description
Stdlib.Parsing.3o no description
Stdlib.Printexc.3o no description
Stdlib.Printf.3o no description
Stdlib.Queue.3o no description
Stdlib.Random.3o no description
Stdlib.Result.3o no description
Stdlib.Scanf.3o no description
Stdlib.Semaphore.3o no description
Stdlib.Seq.3o no description
Stdlib.Set.3o no description
Stdlib.Stack.3o no description
Stdlib.StdLabels.3o no description
Stdlib.String.3o no description
Stdlib.StringLabels.3o no description
Stdlib.Sys.3o no description
Stdlib.Type.3o no description
Stdlib.Uchar.3o no description
Stdlib.Unit.3o no description
Stdlib.Weak.3o no description
Str.3o Regular expressions and high-level string processing
String.3o Strings.
StringLabels.3o Strings.
Strongly_connected_components.3o Kosaraju's algorithm for strongly connected components.
Strongly_connected_components.Make.3o no description
Strongly_connected_components.S.3o no description
Strongly_connected_components.S.Id.3o no description
Syntaxerr.3o Auxiliary type for reporting syntax errors
Sys.3o System interface.
Sys.Immediate64.3o no description
Sys.Immediate64.Immediate.3o no description
Sys.Immediate64.Make.3o no description
Sys.Immediate64.Non_immediate.3o no description
Targetint.3o Target processor-native integers.
Terminfo.3o Basic interface to the terminfo database
Thread.3o Lightweight threads for Posix 1003.1c and Win32.
Type.3o Type introspection.
Type.Id.3o Type identifiers.
Uchar.3o Unicode characters.
Unit.3o Unit values.
Unit_info.3o This module centralize the handling of compilation files and their metadata.
Unit_info.Artifact.3o Build artifacts
Unix.3o Interface to the Unix system.
Unix.LargeFile.3o File operations on large files.
UnixLabels.3o Interface to the Unix system.
UnixLabels.LargeFile.3o File operations on large files.
Warnings.3o Warning definitions
Weak.3o Arrays of weak pointers and hash sets of weak pointers.
Weak.Make.3o Functor building an implementation of the weak hash set structure.
Weak.S.3o The output signature of the functor Weak.Make.