man/ocamlmktop.m

   1 .TH OCAMLMKTOP 1
   2
   3 .SH NAME
   4 ocamlmktop \- Building custom toplevel systems
   5
   6 .SH SYNOPSIS
   7 .B ocamlmktop
   8 [
   9 .B \-v
  10 ]
  11 [
  12 .BI \-cclib \ libname
  13 ]
  14 [
  15 .BI \-ccopt \ option
  16 ]
  17 [
  18 .B \-custom
  19 [
  20 .BI \-o \ exec-file
  21 ]
  22 [
  23 .BI \-I \ lib-dir
  24 ]
  25 .I filename ...
  26
  27 .SH DESCRIPTION
  28
  29 The
  30 .BR ocamlmktop (1)
  31 command builds Objective Caml toplevels that
  32 contain user code preloaded at start-up.
  33 The
  34 .BR ocamlmktop (1)
  35 command takes as argument a set of
  36 .IR x \&.cmo
  37 and
  38 .IR x \&.cma
  39 files, and links them with the object files that implement the Objective
  40 Caml toplevel.  If the
  41 .B -custom
  42 flag is given, C object files and libraries (.o and .a files) can also
  43 be given on the command line and are linked in the resulting toplevel.
  44
  45 .SH OPTIONS
  46
  47 The following command-line options are recognized by
  48 .BR ocamlmktop (1).
  49
  50 .TP
  51 .B \-v
  52 Print the version number of the compiler.
  53
  54 .TP
  55 .BI \-cclib\ -l libname
  56 Pass the
  57 .BI \-l libname
  58 option to the C linker when linking in
  59 ``custom runtime'' mode (see the corresponding option for
  60 .BR ocamlc (1).
  61
  62 .TP
  63 .B \-ccopt
  64 Pass the given option to the C compiler and linker, when linking in
  65 ``custom runtime'' mode. See the corresponding option for
  66 .BR ocamlc (1).
  67
  68 .TP
  69 .B \-custom
  70 Link in ``custom runtime'' mode. See the corresponding option for
  71 .BR ocamlc (1).
  72
  73 .TP
  74 .BI \-I  directory
  75 Add the given directory to the list of directories searched for
  76 compiled interface files (.cmo and .cma).
  77
  78 .TP
  79 .BI \-o \ exec-file
  80 Specify the name of the toplevel file produced by the linker.
  81 The default is is
  82 .BR a.out .
  83
  84 .SH SEE ALSO
  85 .BR ocamlc (1).