~ chicken-core (chicken-5) /chicken-profile.mdoc

 1.\"  Copyright (c) 2007-2022, The CHICKEN Team
 2.\"  All rights reserved.
 3.\"
 4.\"  Redistribution and use in source and binary forms, with or without
 5.\"  modification, are permitted provided that the following conditions
 6.\"  are met:
 7.\"  1. Redistributions of source code must retain the above copyright
 8.\"     notice, this list of conditions and the following disclaimer.
 9.\"  2. Redistributions in binary form must reproduce the above copyright
10.\"     notice, this list of conditions and the following disclaimer in the
11.\"     documentation and/or other materials provided with the distribution.
12.\"  3. The name of the authors may not be used to endorse or promote products
13.\"     derived from this software without specific prior written permission.
14.\"
15.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
16.\"  IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\"  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\"  IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\"  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\"  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\"  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\"  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\"  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\"  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.\"
27.Dd Apr 26, 2017
28.Dt CHICKEN-PROFILE 1
29.Os
30.Sh NAME
31.Nm chicken-profile
32.Nd generate a report from profile-information
33.Sh SYNOPSIS
34.Nm
35.Op Ar OPTION ...
36.Op Ar FILENAME
37.Sh DESCRIPTION
38.Nm
39reads in profiling information generated by CHICKEN
40Scheme programs compiled with the
41.Fl profile
42option, and generates a table listing function names
43and their execution times.
44.Ar FILENAME
45defaults to the
46.Sq PROFILE.<number> ,
47selecting the one with
48the highest modification time, in case multiple profiles exist.
49.Pp
50The program accepts following arguments:
51.Bl -tag -width Ds
52.It Fl help
53Show usage and exit.
54.It Fl version
55Show version and exit.
56.It Fl decimals Ar DDD
57Set number of decimals for seconds, average and percent columns
58.Po three digits, default: 333 Pc .
59.It Fl no-unused
60Remove procedures that are never called.
61.It Fl sort-by-avg
62Sort output by average procedure execution time.
63.It Fl sort-by-calls
64Sort output by call frequency.
65.It Fl sort-by-name
66Sort output alpabetically by procedure name.
67.It Fl sort-by-time
68Sort output by procedure execution time.
69.It Fl top Ar N
70Display only the top
71.Ar N
72entries.
73.El
74.Sh EXIT STATUS
75.Ex -std
76.Sh SEE ALSO
77.Xr chicken 1 ,
78.Xr csc 1
79.Pp
80More information can be found in the
81.Lk http://wiki.call-cc.org/manual/index "CHICKEN User's Manual".
82.Sh AUTHORS
83.An The CHICKEN Team
84.Sh BUGS
85Submit bug reports by e-mail to
86.Mt chicken-janitors@nongnu.org