/usr/share/doc/racket/syntax/docprovide.html is in racket-doc 6.1-4.
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 | <!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>13 Attaching Documentation to Exports</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="index.html" class="tocviewlink" data-pltdoc="x">Syntax:<span class="mywbr"> </span> Meta-<wbr></wbr>Programming Helpers</a></td></tr></table></div><div class="tocviewsublistonly" style="display: block;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="stxparse.html" class="tocviewlink" data-pltdoc="x">Parsing and Specifying Syntax</a></td></tr><tr><td align="right">2 </td><td><a href="syntax-helpers.html" class="tocviewlink" data-pltdoc="x">Syntax Object Helpers</a></td></tr><tr><td align="right">3 </td><td><a href="Datum_Pattern_Matching.html" class="tocviewlink" data-pltdoc="x">Datum Pattern Matching</a></td></tr><tr><td align="right">4 </td><td><a href="module-helpers.html" class="tocviewlink" data-pltdoc="x">Module-<wbr></wbr>Processing Helpers</a></td></tr><tr><td align="right">5 </td><td><a href="transformer-helpers.html" class="tocviewlink" data-pltdoc="x">Macro Transformer Helpers</a></td></tr><tr><td align="right">6 </td><td><a href="reader-helpers.html" class="tocviewlink" data-pltdoc="x">Reader Helpers</a></td></tr><tr><td align="right">7 </td><td><a href="Parsing_for_Bodies.html" class="tocviewlink" data-pltdoc="x">Parsing <span class="RktSym"><span class="RktStxLink">for</span></span> Bodies</a></td></tr><tr><td align="right">8 </td><td><a href="Unsafe_for_Clause_Transforms.html" class="tocviewlink" data-pltdoc="x">Unsafe <span class="RktSym"><span class="RktStxLink">for</span></span> Clause Transforms</a></td></tr><tr><td align="right">9 </td><td><a href="Source_Locations.html" class="tocviewlink" data-pltdoc="x">Source Locations</a></td></tr><tr><td align="right">10 </td><td><a href="Preserving_Source_Locations.html" class="tocviewlink" data-pltdoc="x">Preserving Source Locations</a></td></tr><tr><td align="right">11 </td><td><a href="toplevel.html" class="tocviewlink" data-pltdoc="x">Non-<wbr></wbr>Module Compilation And Expansion</a></td></tr><tr><td align="right">12 </td><td><a href="trusted-xforms.html" class="tocviewlink" data-pltdoc="x">Trusting Standard Recertifying Transformers</a></td></tr><tr><td align="right">13 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Attaching Documentation to Exports</a></td></tr><tr><td align="right"></td><td><a href="doc-index.html" class="tocviewlink" data-pltdoc="x">Index</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><a href="#%28form._%28%28lib._syntax%2Fdocprovide..rkt%29._provide-and-document%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">provide-<wbr></wbr>and-<wbr></wbr>document</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._syntax%2Fdocprovide..rkt%29._lookup-documentation%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">lookup-<wbr></wbr>documentation</span></span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><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.1", "../");" 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.1");">top</a></span><span class="navright"> <a href="trusted-xforms.html" title="backward to "12 Trusting Standard Recertifying Transformers"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Syntax: Meta-Programming Helpers"" data-pltdoc="x">up</a> <a href="doc-index.html" title="forward to "Index"" data-pltdoc="x">next →</a></span> </div><h3 x-source-module="(lib "syntax/scribblings/syntax.scrbl")" x-part-tag=""docprovide"">13<tt> </tt><a name="(part._docprovide)"></a><a name="(mod-path._syntax/docprovide)"></a>Attaching Documentation to Exports</h3><p><table cellspacing="0" cellpadding="0" class="defmodule"><tr><td align="left"><span class="hspace"> </span><span class="RktPn">(</span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=require.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fbase..rkt%2529._require%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">require</a></span><span class="stt"> </span><a href="" class="RktModLink" data-pltdoc="x"><span class="RktSym">syntax/docprovide</span></a><span class="RktPn">)</span></td><td align="right"><span class="RpackageSpec"><span class="Smaller"> package:</span> <span class="stt">base</span></span></td></tr></table></p><blockquote><p><span style="background-color: yellow"><span style="font-weight: bold">NOTE:</span></span> This library is deprecated; use <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=scribble&rel=srcdoc.html%23%2528mod-path._scribble%252Fsrcdoc%2529&version=6.1" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">scribble/srcdoc</span></a>, instead. </p></blockquote><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>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._syntax/docprovide..rkt)._provide-and-document))"></a><span title="Provided from: syntax/docprovide | Package: base"><span class="RktSym"><a href="#%28form._%28%28lib._syntax%2Fdocprovide..rkt%29._provide-and-document%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">provide-and-document</a></span></span><span class="hspace"> </span><span class="RktVar">doc-label-id</span><span class="hspace"> </span><span class="RktVar">doc-row</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></p></blockquote></td></tr><tr><td><span class="stt"> </span></td></tr><tr><td><table cellspacing="0" cellpadding="0" class="specgrammar"><tr><td align="right" valign="baseline"><span class="RktVar">doc-row</span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktVar">section-string</span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktVar">name</span><span class="hspace"> </span><span class="RktVar">type-datum</span><span class="hspace"> </span><span class="RktVar">doc-string</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym">all-from</span><span class="hspace"> </span><span class="RktVar">prefix-id</span><span class="hspace"> </span><span class="RktVar">module-path</span><span class="hspace"> </span><span class="RktVar">doc-label-id</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktSym">all-from-except</span><span class="hspace"> </span><span class="RktVar">prefix-id</span><span class="hspace"> </span><span class="RktVar">module-path</span><span class="hspace"> </span><span class="RktVar">doc-label-id</span><span class="hspace"> </span><span class="RktVar">id</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></td></tr><tr><td align="right" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td></tr><tr><td align="right" valign="baseline"><span class="RktVar">name</span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline">=</td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="RktVar">id</span></td></tr><tr><td align="right" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="center" valign="baseline">|</td><td align="left" valign="baseline"><span class="stt"> </span></td><td align="left" valign="baseline"><span class="RktPn">(</span><span class="RktVar">local-name-id</span><span class="hspace"> </span><span class="RktVar">external-name-id</span><span class="RktPn">)</span></td></tr></table></td></tr></table></blockquote></div><div class="SIntrapara">A form that exports names and records documentation information.</div></p><p>The <span class="RktVar">doc-label-id</span> identifier is used as a key for accessing
the documentation through <span class="RktSym"><a href="#%28def._%28%28lib._syntax%2Fdocprovide..rkt%29._lookup-documentation%29%29" class="RktValLink" data-pltdoc="x">lookup-documentation</a></span>. The actual
documentation is organized into “rows”, each with a section title.</p><p>A <span class="RktSym">row</span> has one of the following forms:</p><ul><li><p><span class="RktPn">(</span><span class="RktVar">section-string</span><span class="stt"> </span><span class="RktPn">(</span><span class="RktVar">name</span><span class="stt"> </span><span class="RktVar">type-datum</span><span class="stt"> </span><span class="RktVar">doc-string</span><span class="stt"> </span><span class="RktMeta"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span><span class="RktPn">)</span><span class="stt"> </span><span class="RktMeta"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span><span class="RktPn">)</span></p><p>Creates a documentation section whose title is <span class="RktVar">section-string</span>,
and provides/documents each <span class="RktVar">name</span>. The <span class="RktVar">type-datum</span> is arbitrary,
for use by clients that call <span class="RktSym"><a href="#%28def._%28%28lib._syntax%2Fdocprovide..rkt%29._lookup-documentation%29%29" class="RktValLink" data-pltdoc="x">lookup-documentation</a></span>. The
<span class="RktVar">doc-string</span>s are also arbitrary documentation information,
usually concatenated by clients.</p><p>A <span class="RktVar">name</span> is either an identifier or a renaming sequence
<span class="RktPn">(</span><span class="RktVar">local-name-id</span><span class="stt"> </span><span class="RktSym">extenal-name-id</span><span class="RktPn">)</span>.</p><p>Multiple <span class="RktSym">row</span>s with the same section name will be merged in the
documentation output. The final order of sections matches the order of
the first mention of each section.</p></li><li><p><span class="RktPn">(</span><span class="RktSym">all-from</span><span class="stt"> </span><span class="RktVar">prefix-id</span><span class="stt"> </span><span class="RktVar">module-path</span><span class="stt"> </span><span class="RktVar">doc-label-id</span><span class="RktPn">)</span></p></li><li><p><span class="RktPn">(</span><span class="RktSym">all-from-except</span><span class="stt"> </span><span class="RktVar">prefix-id</span><span class="stt"> </span><span class="RktVar">module-path</span><span class="stt"> </span><span class="RktVar">doc-label-id</span><span class="stt"> </span><span class="RktVar">id</span><span class="stt"> </span><span class="RktMeta"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=stx-patterns.html%23%2528form._%2528%2528lib._racket%252Fprivate%252Fstxcase-scheme..rkt%2529._......%2529%2529&version=6.1" class="RktStxLink Sq" data-pltdoc="x">...</a></span><span class="RktPn">)</span></p><p>Merges documentation and provisions from the specified module
into the current one; the <span class="RktVar">prefix-id</span> is used to prefix the imports
into the current module (so they can be re-exported). If <span class="RktVar">id</span>s are
provided, the specified <span class="RktVar">id</span>s are not re-exported and their
documentation is not merged.</p></li></ul><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><table cellspacing="0" cellpadding="0" class="prototype RForeground"><tr><td><span class="RktPn">(</span><a name="(def._((lib._syntax/docprovide..rkt)._lookup-documentation))"></a><span title="Provided from: syntax/docprovide | Package: base"><span class="RktSym"><a href="#%28def._%28%28lib._syntax%2Fdocprovide..rkt%29._lookup-documentation%29%29" class="RktValDef RktValLink" data-pltdoc="x">lookup-documentation</a></span></span></td><td><span class="hspace"> </span></td><td><span class="RktVar">module-path-v</span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td></tr><tr><td><span class="hspace"> </span></td><td><span class="hspace"> </span></td><td><span class="RktVar">label-sym</span><span class="RktPn">)</span></td><td><span class="hspace"> </span></td><td>→</td><td><span class="hspace"> </span></td><td><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/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.1" class="RktStxLink Sq" data-pltdoc="x">any</a></span></td></tr></table></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">module-path-v</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._module-path%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">module-path?</a></span></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">label-sym</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=symbols.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._symbol%7E3f%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">symbol?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Returns documentation for the specified module and label. The
<span class="RktVar">module-path-v</span> argument is a quoted module path, like the
argument to <span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=Module_Names_and_Loading.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._dynamic-require%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">dynamic-require</a></span>. The
<span class="RktVar">label-sym</span> identifies a set of documentation using the symbol
as a label identifier in <span class="RktSym"><a href="#%28form._%28%28lib._syntax%2Fdocprovide..rkt%29._provide-and-document%29%29" class="RktStxLink" data-pltdoc="x">provide-and-document</a></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.1", "../");" 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.1");">top</a></span><span class="navright"> <a href="trusted-xforms.html" title="backward to "12 Trusting Standard Recertifying Transformers"" data-pltdoc="x">← prev</a> <a href="index.html" title="up to "Syntax: Meta-Programming Helpers"" data-pltdoc="x">up</a> <a href="doc-index.html" title="forward to "Index"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|