man/ocamlprof.m

   1 .TH OCAMLPROF 1
   2
   3 .SH NAME
   4 ocamlprof \- The Objective Caml profiler
   5
   6 .SH SYNOPSIS
   7 .B ocamlprof
   8 [
   9 .BI \-f \ dump-file
  10 ]
  11 [
  12 .BI \-F \ text
  13 ]
  14 .I filename ...
  15
  16 .SH DESCRIPTION
  17 The
  18 .B ocamlprof
  19 command prints execution counts gathered during the execution of a
  20 Objective Caml program instrumented with
  21 .BR ocamlcp (1).
  22
  23 It produces a source listing of the program modules given as arguments
  24 where execution counts have been inserted as comments. For instance,
  25 .P
  26 ocamlprof foo.ml
  27 .P
  28 prints the source code for the foo module, with comments indicating
  29 how many times the functions in this module have been called. Naturally,
  30 this information is accurate only if the source file has not been modified
  31 since the profiling execution took place.
  32
  33 .SH OPTIONS
  34
  35 .TP
  36 .BI \-f \ dumpfile
  37 Specifies an alternate dump file of profiling information.
  38 The default is the file ocamlprof.dump in the current directory.
  39 .TP
  40 .BI \-F \ string
  41 Specifies an additional string to be output with profiling information.
  42 By default,
  43 .B ocamlprof
  44 will annotate programs with comments of the form
  45 .BI (* \ n \ *)
  46 where
  47 .I n
  48 is the counter value for a profiling point. With option
  49 .BI \-F \ string
  50 the annotation will be
  51 .BI (* \ s\ n \ *)
  52
  53 .SH SEE ALSO
  54 .BR ocamlcp (1).
  55 .br
  56 .I The Objective Caml user's manual,
  57 chapter "Profiling".