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

   1 \" $Id: ocamldebug.m 9025 2008-09-15 14:05:30Z doligez $
   2
   3 .TH OCAMLDEBUG 1
   4
   5 .SH NAME
   6 ocamldebug \- the Objective Caml source-level replay debugger.
   7 .SH SYNOPSIS
   8 .B ocamldebug
   9 .I "[options] program [arguments]"
  10 .SH DESCRIPTION
  11 .B ocamldebug
  12 is the Objective Caml source-level replay debugger.
  13
  14 Before the debugger can be used, the program must be compiled and
  15 linked with the
  16 .B \-g
  17 option: all .cmo and .cma files that are part
  18 of the program should have been created with
  19 .BR ocamlc\ \-g ,
  20 and they must be linked together with
  21 .BR ocamlc\ \-g .
  22
  23 Compiling with
  24 .B \-g
  25 entails no penalty on the running time of
  26 programs: object files and bytecode executable files are bigger and
  27 take longer to produce, but the executable files run at
  28 exactly the same speed as if they had been compiled without
  29 .BR \-g .
  30
  31 .SH OPTIONS
  32 A summary of options are included below.
  33 For a complete description, see the html documentation in the ocaml-doc
  34 package.
  35 .TP
  36 .BI \-c \ count
  37 Set the maximum number of simultaneously live checkpoints to
  38 .IR count .
  39 .TP
  40 .BI \-cd \ dir
  41 Run the debugger program from the working directory
  42 .IR dir ,
  43 instead of the current working directory. (See also the
  44 .B cd
  45 command.)
  46 .TP
  47 .B \-emacs
  48 Tell the debugger it is executed under Emacs.  (See
  49 .I "The Objective Caml user's manual"
  50 for information on how to run the debugger under Emacs.)
  51 .TP
  52 .BI \-I \ directory
  53 Add
  54 .I directory
  55 to the list of directories searched for source files and
  56 compiled files.  (See also the
  57 .B directory
  58 command.)
  59 .TP
  60 .BI \-s \ socket
  61 Use
  62 .I socket
  63 for communicating with the debugged program. See the description
  64 of the command
  65 .B set\ socket
  66 in
  67 .I "The Objective Caml user's manual"
  68 for the format of
  69 .IR socket .
  70 .TP
  71 .B \-version
  72 Print version and exit.
  73 .TP
  74 .BR \-help \ or \ \-\-help
  75 Display a short usage summary and exit.
  76 .SH SEE ALSO
  77 .BR ocamlc (1)
  78 .br
  79 .IR "The Objective Caml user's manual" ,
  80 chapter "The debugger".
  81 .SH AUTHOR
  82 This manual page was written by Sven LUTHER <luther@debian.org>,
  83 for the Debian GNU/Linux system (but may be used by others).