/usr/share/doc/racket/trace/index.html is in racket-doc 6.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>Trace: Instrumentation to Show Function Calls</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="" class="tocviewselflink" data-pltdoc="x">Trace:<span class="mywbr"> </span> Instrumentation to Show Function Calls</a></td></tr></table></div><div class="tocviewsublistonly" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="#%28part._quick-instructions%29" class="tocviewlink" data-pltdoc="x">Quick Instructions</a></td></tr><tr><td align="right">2 </td><td><a href="#%28part._.Installing_.Calltrace%29" class="tocviewlink" data-pltdoc="x">Installing Calltrace</a></td></tr><tr><td align="right">3 </td><td><a href="#%28part._.Calltrace_.Library%29" class="tocviewlink" data-pltdoc="x">Calltrace Library</a></td></tr></table></div></div></div><div class="tocsub"><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber"></span><a href="#%28part._top%29" class="tocsubseclink" data-pltdoc="x">Trace:<span class="mywbr"> </span> Instrumentation to Show Function Calls</a></td></tr><tr><td><span class="tocsublinknumber">1<tt> </tt></span><a href="#%28part._quick-instructions%29" class="tocsubseclink" data-pltdoc="x">Quick Instructions</a></td></tr><tr><td><span class="tocsublinknumber">2<tt> </tt></span><a href="#%28part._.Installing_.Calltrace%29" class="tocsubseclink" data-pltdoc="x">Installing Calltrace</a></td></tr><tr><td><span class="tocsublinknumber">3<tt> </tt></span><a href="#%28part._.Calltrace_.Library%29" class="tocsubseclink" data-pltdoc="x">Calltrace Library</a></td></tr><tr><td><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">instrumenting-<wbr></wbr>enabled</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._calltrace-eval-handler%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym">calltrace-<wbr></wbr>eval-<wbr></wbr>handler</span></a></td></tr><tr><td><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._annotate%29%29" class="tocsubnonseclink" data-pltdoc="x"><span class="RktSym">annotate</span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="versionbox"><span class="version">6.7</span></div><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <span class="nonavigation">← prev</span> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">up</a> <span class="nonavigation">next →</span></span> </div><h2 x-source-module="(lib "trace/scribblings/trace.scrbl")" x-source-pkg="trace" x-part-tag=""top""><a name="(part._top)"></a>Trace: Instrumentation to Show Function Calls</h2><p><span style="font-weight: bold">Calltrace</span> is a tool that displays all calls to user procedures.
It displays the arguments to the calls, and it indents to show the
depth of the continuation.</p><h3 x-source-module="(lib "trace/scribblings/trace.scrbl")" x-source-pkg="trace" x-part-tag=""quick-instructions"">1<tt> </tt><a name="(part._quick-instructions)"></a>Quick Instructions</h3><ul><li><p>Throw away <span class="stt">".zo"</span> versions of your source</p></li><li><p><div class="SIntrapara">Prefix your program with
</div><div class="SIntrapara"><blockquote class="SCodeFlow"><p><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="hspace"> </span><span class="RktSym">trace</span><span class="RktPn">)</span></p></blockquote></div><div class="SIntrapara">perhaps by starting <span class="stt">racket</span> with
</div><div class="SIntrapara"><span class="hspace"> </span><span class="stt">racket -l trace ...</span></div><div class="SIntrapara">before arguments to load your program.</div></p></li><li><p>Run your program</p></li></ul><p>The <a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a> module is odd; don’t import it
into another module. Instead, the <a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a>
module is meant to be invoked from the top-level, so that it can
install an evaluation handler, exception handler, etc.</p><p>To reuse parts of the code of <a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a>, import
<a href="#%28mod-path._trace%2Fcalltrace-lib%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace/calltrace-lib</span></a>. It contains all of the bindings
described here, but it but does not set the <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=eval.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-eval%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">current-eval</a></span>
parameter.</p><h3 x-source-module="(lib "trace/scribblings/trace.scrbl")" x-source-pkg="trace" x-part-tag=""Installing_Calltrace"">2<tt> </tt><a name="(part._.Installing_.Calltrace)"></a><a name="(mod-path._trace)"></a>Installing Calltrace</h3><p><div class="SIntrapara"><table cellspacing="0" cellpadding="0" class="defmodule"><tr><td align="left"><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller"> package:</span> <span class="stt">trace</span></span></td></tr></table></div><div class="SIntrapara">Invoking the
<a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a> module sets the evaluation handler
(via <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=eval.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-eval%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">current-eval</a></span>) to instrument Racket source code.</div></p><p>NOTE: <a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a> has no effect on code loaded as
compiled byte code (i.e., from a <span class="stt">".zo"</span> file) or native code
(i.e., from a <span class="stt">".dll"</span>, <span class="stt">".so"</span>, or <span class="stt">".dylib"</span>
file).</p><p>Calltrace’s instrumentation can be explicitly disabled via the
<span class="RktSym"><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="RktValLink" data-pltdoc="x">instrumenting-enabled</a></span> parameter. Instrumentation is on by
default. The <span class="RktSym"><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="RktValLink" data-pltdoc="x">instrumenting-enabled</a></span> parameter affects only the
way that source code is compiled, not the way that exception
information is reported.</p><p>Do not load <a href="#%28mod-path._trace%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace</span></a> before writing
<span class="stt">".zo"</span> files. Calltrace instruments S-expressions with
unprintable values; this works fine if the instrumented S-expression
is passed to the default eval handler, but neither the S-expression
nor its byte-code form can be marshalled to a string.</p><h3 x-source-module="(lib "trace/scribblings/trace.scrbl")" x-source-pkg="trace" x-part-tag=""Calltrace_Library"">3<tt> </tt><a name="(part._.Calltrace_.Library)"></a><a name="(mod-path._trace/calltrace-lib)"></a>Calltrace Library</h3><p><div class="SIntrapara"><table cellspacing="0" cellpadding="0" class="defmodule"><tr><td align="left"><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="#%28mod-path._trace%2Fcalltrace-lib%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace/calltrace-lib</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller"> package:</span> <span class="stt">trace</span></span></td></tr></table></div><div class="SIntrapara">The
<a href="#%28mod-path._trace%2Fcalltrace-lib%29" class="RktModLink" data-pltdoc="x"><span class="RktSym">trace/calltrace-lib</span></a> module provides functions that
implement <span class="RktSym">trace</span>.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>parameter</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._trace/calltrace-lib..rkt)._instrumenting-enabled))"></a><span title="Provided from: trace/calltrace-lib | Package: trace"><span class="RktSym"><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="RktValDef RktValLink" data-pltdoc="x">instrumenting-enabled</a></span></span><span class="RktPn"></span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=booleans.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._boolean%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">boolean?</a></span></p></blockquote></td></tr><tr><td><span class="RktPn">(</span><span title="Provided from: trace/calltrace-lib | Package: trace"><span class="RktSym"><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="RktValDef RktValLink" data-pltdoc="x">instrumenting-enabled</a></span></span><span class="hspace"> </span><span class="RktVar">on?</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=void.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._void%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">void?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">on?</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></blockquote></div><div class="SIntrapara">A parameter that determines whether tracing instrumentation is
enabled.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._trace/calltrace-lib..rkt)._calltrace-eval-handler))"></a><span title="Provided from: trace/calltrace-lib | Package: trace"><span class="RktSym"><span class="RktSymDef RktSym">calltrace-eval-handler</span></span></span><span class="hspace"> </span><span class="RktVar">e</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528form._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%2529%2529&version=6.7" class="RktStxLink Sq" data-pltdoc="x">any</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">e</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></blockquote></div><div class="SIntrapara">A procedure suitable for use with <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=eval.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-eval%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">current-eval</a></span>, which
instruments expressions for Calltrace output (when instrumentation is
not disabled via <span class="RktSym"><a href="#%28def._%28%28lib._trace%2Fcalltrace-lib..rkt%29._instrumenting-enabled%29%29" class="RktValLink" data-pltdoc="x">instrumenting-enabled</a></span>).</div></p><p>Requiring <span class="RktSym">trace</span> installs this procedure as the
value for <span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=eval.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-eval%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">current-eval</a></span>.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._trace/calltrace-lib..rkt)._annotate))"></a><span title="Provided from: trace/calltrace-lib | Package: trace"><span class="RktSym"><span class="RktSymDef RktSym">annotate</span></span></span><span class="hspace"> </span><span class="RktVar">e</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=stxops.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._syntax%7E3f%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">syntax?</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">e</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Instruments the expression <span class="RktVar">e</span> with Calltrace support. This
function is normally used by <span class="RktSym">calltrace-eval-handler</span>.</div></p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <span class="nonavigation">← prev</span> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">up</a> <span class="nonavigation">next →</span></span> </div></div></div><div id="contextindicator"> </div></body></html>
|