l4/pkg/ocaml/ocaml/contrib/man/ocamlmktop.m

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