summaryrefslogtreecommitdiff
path: root/man/ocamlprof.m
diff options
context:
space:
mode:
Diffstat (limited to 'man/ocamlprof.m')
-rw-r--r--man/ocamlprof.m57
1 files changed, 57 insertions, 0 deletions
diff --git a/man/ocamlprof.m b/man/ocamlprof.m
new file mode 100644
index 0000000000..2f71779968
--- /dev/null
+++ b/man/ocamlprof.m
@@ -0,0 +1,57 @@
+.TH CSLPROF 1
+
+.SH NAME
+ocamlprof \- The Objective Caml profiler
+
+.SH SYNOPSIS
+.B ocamlprof
+[
+.BI \-f \ dump-file
+]
+[
+.BI \-F \ text
+]
+.I filename ...
+
+.SH DESCRIPTION
+The
+.B ocamlprof
+command prints execution counts gathered during the execution of a
+Objective Caml program instrumented with
+.BR ocamlcp (1).
+
+It produces a source listing of the program modules given as arguments
+where execution counts have been inserted as comments. For instance,
+.P
+ocamlprof foo.ml
+.P
+prints the source code for the foo module, with comments indicating
+how many times the functions in this module have been called. Naturally,
+this information is accurate only if the source file has not been modified
+since the profiling execution took place.
+
+.SH OPTIONS
+
+.TP
+.BI \-f \ dumpfile
+Specifies an alternate dump file of profiling information.
+The default is the file ocamlprof.dump in the current directory.
+.TP
+.BI \-F \ string
+Specifies an additional string to be output with profiling information.
+By default,
+.B ocamlprof
+will annotate progams with comments of the form
+.BI (* \ n \ *)
+where
+.I n
+is the counter value for a profiling point. With option
+.BI \-F \ string
+the annotation will be
+.BI (* \ s\ n \ *)
+
+.SH SEE ALSO
+.BR ocamlcp (1).
+.br
+.I The Objective Caml user's manual,
+chapter "Profiling".