188 lines
4.2 KiB
HTML
188 lines
4.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of OCAMLDEBUG</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>OCAMLDEBUG</H1>
|
|
Section: User Commands (1)<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<P>
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
ocamldebug - the OCaml source-level replay debugger.
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>ocamldebug</B>
|
|
|
|
[ <I>options</I> ] <I>program</I> [ <I>arguments</I> ]
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<B>ocamldebug</B>
|
|
|
|
is the OCaml source-level replay debugger.
|
|
<P>
|
|
Before the debugger can be used, the program must be compiled and
|
|
linked with the
|
|
<B>-g</B>
|
|
|
|
option: all .cmo and .cma files that are part
|
|
of the program should have been created with
|
|
<B>ocamlc -g</B>,
|
|
|
|
and they must be linked together with
|
|
<B>ocamlc -g</B>.
|
|
|
|
<P>
|
|
Compiling with
|
|
<B>-g</B>
|
|
|
|
entails no penalty on the running time of
|
|
programs: object files and bytecode executable files are bigger and
|
|
take longer to produce, but the executable files run at
|
|
exactly the same speed as if they had been compiled without
|
|
<B>-g</B>.
|
|
|
|
<P>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
A summary of options are included below.
|
|
For a complete description, see the html documentation in the ocaml-doc
|
|
package.
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-c</B><I> count</I>
|
|
|
|
<DD>
|
|
Set the maximum number of simultaneously live checkpoints to
|
|
<I>count</I>.
|
|
|
|
<DT id="2"><B>-cd</B><I> dir</I>
|
|
|
|
<DD>
|
|
Run the debugger program from the working directory
|
|
<I>dir</I>,
|
|
|
|
instead of the current working directory. (See also the
|
|
<B>cd</B>
|
|
|
|
command.)
|
|
<DT id="3"><B>-emacs</B>
|
|
|
|
<DD>
|
|
Tell the debugger it is executed under Emacs. (See
|
|
<I>The OCaml user's manual</I>
|
|
|
|
for information on how to run the debugger under Emacs.)
|
|
Implies
|
|
<B>-machine-readable</B>.
|
|
|
|
<DT id="4"><B>-I</B><I> directory</I>
|
|
|
|
<DD>
|
|
Add
|
|
<I>directory</I>
|
|
|
|
to the list of directories searched for source files and
|
|
compiled files. (See also the
|
|
<B>directory</B>
|
|
|
|
command.)
|
|
<DT id="5"><B>-machine-readable</B>
|
|
|
|
<DD>
|
|
Print information in a format more suitable for machines instead of human
|
|
operators where applicable. For example, when describing a location in a
|
|
program, such as when printing a backtrace, print the program counter and
|
|
character offset in a file instead of the filename, line number, and character
|
|
offset in that line.
|
|
<DT id="6"><B>-s</B><I> socket</I>
|
|
|
|
<DD>
|
|
Use
|
|
<I>socket</I>
|
|
|
|
for communicating with the debugged program. See the description
|
|
of the command
|
|
<B>set socket</B>
|
|
|
|
in
|
|
<I>The OCaml user's manual</I>
|
|
|
|
for the format of
|
|
<I>socket</I>.
|
|
|
|
<DT id="7"><B>-version</B>
|
|
|
|
<DD>
|
|
Print version string and exit.
|
|
<DT id="8"><B>-vnum</B>
|
|
|
|
<DD>
|
|
Print short version number and exit.
|
|
<DT id="9"><B>-help</B> or<B> --help</B>
|
|
|
|
<DD>
|
|
Display a short usage summary and exit.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>INITIALIZATION FILE</H2>
|
|
|
|
<P>
|
|
When
|
|
<B><A HREF="/cgi-bin/man/man2html?1+ocamldebug">ocamldebug</A></B>(1)
|
|
|
|
is invoked, it will read commands from an initialization file before
|
|
giving control to the user. The default file is
|
|
<B>.ocamldebug</B>
|
|
|
|
in the current directory if it exists, otherwise
|
|
<B>.ocamldebug</B>
|
|
|
|
in the user's home directory.
|
|
<P>
|
|
Note that you can also use the
|
|
<B>source file</B>
|
|
|
|
command to read commands from a file.
|
|
<P>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+ocamlc">ocamlc</A></B>(1)
|
|
|
|
<BR>
|
|
|
|
<I>The OCaml user's manual</I>,
|
|
|
|
chapter "The debugger".
|
|
<A NAME="lbAH"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
This manual page was written by Sven LUTHER <<A HREF="mailto:luther@debian.org">luther@debian.org</A>>,
|
|
for the Debian GNU/Linux system (but may be used by others).
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="13"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="14"><A HREF="#lbAF">INITIALIZATION FILE</A><DD>
|
|
<DT id="15"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
<DT id="16"><A HREF="#lbAH">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:20 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|