diff options
Diffstat (limited to 'man/ocamlmktop.1')
-rw-r--r-- | man/ocamlmktop.1 | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/man/ocamlmktop.1 b/man/ocamlmktop.1 new file mode 100644 index 0000000000..09a4126c01 --- /dev/null +++ b/man/ocamlmktop.1 @@ -0,0 +1,97 @@ +.\"************************************************************************** +.\"* * +.\"* OCaml * +.\"* * +.\"* Xavier Leroy, projet Cristal, INRIA Rocquencourt * +.\"* * +.\"* Copyright 1999 Institut National de Recherche en Informatique et * +.\"* en Automatique. * +.\"* * +.\"* All rights reserved. This file is distributed under the terms of * +.\"* the GNU Lesser General Public License version 2.1, with the * +.\"* special exception on linking described in the file LICENSE. * +.\"* * +.\"************************************************************************** +.\" +.TH OCAMLMKTOP 1 + +.SH NAME +ocamlmktop \- Building custom toplevel systems + +.SH SYNOPSIS +.B ocamlmktop +[ +.BR \-v | \-version | \-vnum +] +[ +.BI \-cclib \ libname +] +[ +.BI \-ccopt \ option +] +[ +.B \-custom +[ +.BI \-o \ exec-file +] +[ +.BI \-I \ lib-dir +] +.I filename ... + +.SH DESCRIPTION + +The +.BR ocamlmktop (1) +command builds OCaml toplevels that +contain user code preloaded at start-up. +The +.BR ocamlmktop (1) +command takes as argument a set of +.IR x .cmo +and +.IR x .cma +files, and links them with the object files that implement the +OCaml toplevel. If the +.B \-custom +flag is given, C object files and libraries (.o and .a files) can also +be given on the command line and are linked in the resulting toplevel. + +.SH OPTIONS + +The following command-line options are recognized by +.BR ocamlmktop (1). +.TP +.B \-v +Print the version string of the compiler and exit. +.TP +.BR \-vnum \ or\ \-version +Print the version number of the compiler in short form and exit. +.TP +.BI \-cclib\ \-l libname +Pass the +.BI \-l libname +option to the C linker when linking in +``custom runtime'' mode (see the corresponding option for +.BR ocamlc (1). +.TP +.B \-ccopt +Pass the given option to the C compiler and linker, when linking in +``custom runtime'' mode. See the corresponding option for +.BR ocamlc (1). +.TP +.B \-custom +Link in ``custom runtime'' mode. See the corresponding option for +.BR ocamlc (1). +.TP +.BI \-I \ directory +Add the given directory to the list of directories searched for +compiled interface files (.cmo and .cma). +.TP +.BI \-o \ exec\-file +Specify the name of the toplevel file produced by the linker. +The default is is +.BR a.out . + +.SH SEE ALSO +.BR ocamlc (1). |