← Back to branch summary

~ubuntu-branches/debian/sid/ocaml/sid

« back to all changes in this revision

Viewing changes to man/ocamlprof.m

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Zacchiroli
  • Date: 2009-02-22 08:49:13 UTC
  • mfrom: (12.1.1 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090222084913-3i0uw2bhd0lgw0ok
* Uploading to unstable
* debian/control: bump dh-ocaml to (>= 0.4) to avoid buggy ocamlinit.mk

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/ocamlprof.m
 
1
\" $Id: ocamlprof.m,v 1.6 2008/09/15 14:25:42 doligez Exp $
1
2
.TH OCAMLPROF 1
2
3
 
3
4
.SH NAME
22
23
 
23
24
It produces a source listing of the program modules given as arguments
24
25
where execution counts have been inserted as comments. For instance,
25
 
.P
26
 
ocamlprof foo.ml
27
 
.P
 
26
 
 
27
.B ocamlprof foo.ml
 
28
 
28
29
prints the source code for the foo module, with comments indicating
29
30
how many times the functions in this module have been called. Naturally,
30
31
this information is accurate only if the source file has not been modified
33
34
.SH OPTIONS
34
35
 
35
36
.TP
36
 
.BI \-f \ dumpfile 
 
37
.BI \-f \ dumpfile
37
38
Specifies an alternate dump file of profiling information.
38
 
The default is the file ocamlprof.dump in the current directory.
39
39
.TP
40
40
.BI \-F \ string
41
41
Specifies an additional string to be output with profiling information.
42
42
By default,
43
 
.B ocamlprof
 
43
.BR ocamlprof (1)
44
44
will annotate programs with comments of the form
45
45
.BI (* \ n \ *)
46
46
where
47
47
.I n
48
48
is the counter value for a profiling point. With option
49
 
.BI \-F \ string
 
49
.BI \-F \ s
50
50
the annotation will be
51
 
.BI (* \ s\ n \ *)
 
51
.BI (* \ sn \ *)
 
52
.TP
 
53
.BI \-impl \ filename
 
54
Compile the file
 
55
.I filename
 
56
as an implementation file, even if its extension is not .ml.
 
57
.TP
 
58
.BI \-intf \ filename
 
59
Compile the file
 
60
.I filename
 
61
as an interface file, even if its extension is not .mli.
 
62
.TP
 
63
.B \-version
 
64
Print the version number of ocamlprof and exit.
 
65
.TP
 
66
.BR \-help \ or \ \-\-help
 
67
Display a short usage summary and exit.
52
68
 
53
69
.SH SEE ALSO
54
70
.BR ocamlcp (1).
55
71
.br
56
 
.I The Objective Caml user's manual,
 
72
.IR "The Objective Caml user's manual" ,
57
73
chapter "Profiling".