1OCAMLDEBUG(1) General Commands Manual OCAMLDEBUG(1)
2
3
4
6 ocamldebug - the OCaml source-level replay debugger.
7
9 ocamldebug [ options ] program [ arguments ]
10
12 ocamldebug is the OCaml source-level replay debugger.
13
14 Before the debugger can be used, the program must be compiled and
15 linked with the -g option: all .cmo and .cma files that are part of the
16 program should have been created with ocamlc -g, and they must be
17 linked together with ocamlc -g.
18
19 Compiling with -g entails no penalty on the running time of programs:
20 object files and bytecode executable files are bigger and take longer
21 to produce, but the executable files run at exactly the same speed as
22 if they had been compiled without -g.
23
24
26 A summary of options are included below. For a complete description,
27 see the html documentation in the ocaml-doc package.
28
29 -c count
30 Set the maximum number of simultaneously live checkpoints to
31 count.
32
33 -cd dir
34 Run the debugger program from the working directory dir, instead
35 of the current working directory. (See also the cd command.)
36
37 -emacs Tell the debugger it is executed under Emacs. (See The OCaml
38 user's manual for information on how to run the debugger under
39 Emacs.) Implies -machine-readable.
40
41 -I directory
42 Add directory to the list of directories searched for source
43 files and compiled files. (See also the directory command.)
44
45 -machine-readable
46 Print information in a format more suitable for machines instead
47 of human operators where applicable. For example, when describ‐
48 ing a location in a program, such as when printing a backtrace,
49 print the program counter and character offset in a file instead
50 of the filename, line number, and character offset in that line.
51
52 -s socket
53 Use socket for communicating with the debugged program. See the
54 description of the command set socket in The OCaml user's manual
55 for the format of socket.
56
57 -version
58 Print version string and exit.
59
60 -vnum Print short version number and exit.
61
62 -help or --help
63 Display a short usage summary and exit.
64
65
67 When ocamldebug(1) is invoked, it will read commands from an initial‐
68 ization file before giving control to the user. The default file is
69 .ocamldebug in the current directory if it exists, otherwise .ocamlde‐
70 bug in the user's home directory.
71
72 Note that you can also use the source file command to read commands
73 from a file.
74
75
77 ocamlc(1)
78 The OCaml user's manual, chapter "The debugger".
79
81 This manual page was written by Sven LUTHER <luther@debian.org>, for
82 the Debian GNU/Linux system (but may be used by others).
83
84
85
86 OCAMLDEBUG(1)