/usr/share/doc/racket/guide/scripts.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 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 | <!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>21.2 Scripts</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="../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="../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"><span style="font-weight: bold">The Racket Guide</span></a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="intro.html" class="tocviewlink" data-pltdoc="x">Welcome to Racket</a></td></tr><tr><td align="right">2 </td><td><a href="to-scheme.html" class="tocviewlink" data-pltdoc="x">Racket Essentials</a></td></tr><tr><td align="right">3 </td><td><a href="datatypes.html" class="tocviewlink" data-pltdoc="x">Built-<wbr></wbr>In Datatypes</a></td></tr><tr><td align="right">4 </td><td><a href="scheme-forms.html" class="tocviewlink" data-pltdoc="x">Expressions and Definitions</a></td></tr><tr><td align="right">5 </td><td><a href="define-struct.html" class="tocviewlink" data-pltdoc="x">Programmer-<wbr></wbr>Defined Datatypes</a></td></tr><tr><td align="right">6 </td><td><a href="modules.html" class="tocviewlink" data-pltdoc="x">Modules</a></td></tr><tr><td align="right">7 </td><td><a href="contracts.html" class="tocviewlink" data-pltdoc="x">Contracts</a></td></tr><tr><td align="right">8 </td><td><a href="i_o.html" class="tocviewlink" data-pltdoc="x">Input and Output</a></td></tr><tr><td align="right">9 </td><td><a href="regexp.html" class="tocviewlink" data-pltdoc="x">Regular Expressions</a></td></tr><tr><td align="right">10 </td><td><a href="control.html" class="tocviewlink" data-pltdoc="x">Exceptions and Control</a></td></tr><tr><td align="right">11 </td><td><a href="for.html" class="tocviewlink" data-pltdoc="x">Iterations and Comprehensions</a></td></tr><tr><td align="right">12 </td><td><a href="match.html" class="tocviewlink" data-pltdoc="x">Pattern Matching</a></td></tr><tr><td align="right">13 </td><td><a href="classes.html" class="tocviewlink" data-pltdoc="x">Classes and Objects</a></td></tr><tr><td align="right">14 </td><td><a href="units.html" class="tocviewlink" data-pltdoc="x">Units (Components)</a></td></tr><tr><td align="right">15 </td><td><a href="reflection.html" class="tocviewlink" data-pltdoc="x">Reflection and Dynamic Evaluation</a></td></tr><tr><td align="right">16 </td><td><a href="macros.html" class="tocviewlink" data-pltdoc="x">Macros</a></td></tr><tr><td align="right">17 </td><td><a href="languages.html" class="tocviewlink" data-pltdoc="x">Creating Languages</a></td></tr><tr><td align="right">18 </td><td><a href="concurrency.html" class="tocviewlink" data-pltdoc="x">Concurrency and Synchronization</a></td></tr><tr><td align="right">19 </td><td><a href="performance.html" class="tocviewlink" data-pltdoc="x">Performance</a></td></tr><tr><td align="right">20 </td><td><a href="parallelism.html" class="tocviewlink" data-pltdoc="x">Parallelism</a></td></tr><tr><td align="right">21 </td><td><a href="running.html" class="tocviewselflink" data-pltdoc="x">Running and Creating Executables</a></td></tr><tr><td align="right">22 </td><td><a href="More_Libraries.html" class="tocviewlink" data-pltdoc="x">More Libraries</a></td></tr><tr><td align="right">23 </td><td><a href="dialects.html" class="tocviewlink" data-pltdoc="x">Dialects of Racket and Scheme</a></td></tr><tr><td align="right">24 </td><td><a href="other-editors.html" class="tocviewlink" data-pltdoc="x">Command-<wbr></wbr>Line Tools and Your Editor of Choice</a></td></tr><tr><td align="right"></td><td><a href="doc-bibliography.html" class="tocviewlink" data-pltdoc="x">Bibliography</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 class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_1");">▼</a></td><td>21 </td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running and Creating Executables</a></td></tr></table><div class="tocviewsublist" style="display: block;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">21.1 </td><td><a href="racket.html" class="tocviewlink" data-pltdoc="x">Running <span class="stt">racket</span> and <span class="stt">gracket</span></a></td></tr><tr><td align="right">21.2 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Scripts</a></td></tr><tr><td align="right">21.3 </td><td><a href="exe.html" class="tocviewlink" data-pltdoc="x">Creating Stand-<wbr></wbr>Alone Executables</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_2");">►</a></td><td>21.2 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Scripts</a></td></tr></table><div class="tocviewsublistbottom" style="display: none;" id="tocview_2"><table cellspacing="0" cellpadding="0"><tr><td align="right">21.2.1 </td><td><a href="#%28part._.Unix_.Scripts%29" class="tocviewlink" data-pltdoc="x">Unix Scripts</a></td></tr><tr><td align="right">21.2.2 </td><td><a href="#%28part._.Windows_.Batch_.Files%29" class="tocviewlink" data-pltdoc="x">Windows Batch Files</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><span class="tocsublinknumber">21.2.1<tt> </tt></span><a href="#%28part._.Unix_.Scripts%29" class="tocsubseclink" data-pltdoc="x">Unix Scripts</a></td></tr><tr><td><span class="tocsublinknumber">21.2.2<tt> </tt></span><a href="#%28part._.Windows_.Batch_.Files%29" class="tocsubseclink" data-pltdoc="x">Windows Batch Files</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="racket.html" title="backward to "21.1 Running racket and gracket"" data-pltdoc="x">← prev</a> <a href="running.html" title="up to "21 Running and Creating Executables"" data-pltdoc="x">up</a> <a href="exe.html" title="forward to "21.3 Creating Stand-Alone Executables"" data-pltdoc="x">next →</a></span> </div><h4 x-source-module="(lib "scribblings/guide/guide.scrbl")" x-part-tag=""scripts"">21.2<tt> </tt><a name="(part._scripts)"></a>Scripts</h4><p>Racket files can be turned into executable scripts on Unix and Mac
OS X. On Windows, a compatibility layer like Cygwin support the
same kind of scripts, or scripts can be implemented as batch files.</p><h5 x-source-module="(lib "scribblings/guide/guide.scrbl")" x-part-tag=""Unix_Scripts"">21.2.1<tt> </tt><a name="(part._.Unix_.Scripts)"></a>Unix Scripts</h5><p>In a Unix environment (including Linux and Mac OS X), a Racket file can
be turned into an executable script using the shell’s <a name="(idx._(gentag._7._(lib._scribblings/guide/guide..scrbl)))"></a><span class="stt">#!</span>
convention. The first two characters of the file must be <span class="RktInBG"><span class="hspace"></span><span class="RktIn">#!</span><span class="hspace"></span></span>;
the next character must be either a space or <span class="RktInBG"><span class="hspace"></span><span class="RktIn">/</span><span class="hspace"></span></span>, and the
remainder of the first line must be a command to execute the script. For
some platforms, the total length of the first line is restricted to 32
characters, and sometimes the space is required.</p><blockquote class="refpara"><blockquote class="refcolumn"><blockquote class="refcontent"><p>Use <span class="RktMod">#lang</span> <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=index.html&version=6.1" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">racket/base</span></a> instead
of <span class="RktMod">#lang</span> <a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=index.html&version=6.1" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">racket</span></a> to produce scripts with a
faster startup time.</p></blockquote></blockquote></blockquote><p>The simplest script format uses an absolute path to a <span class="stt">racket</span>
executable followed by a module declaration. For example, if
<span class="stt">racket</span> is installed in <span class="stt">"/usr/local/bin"</span>, then a file
containing the following text acts as a “hello world” script:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">#! /usr/local/bin/racket</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">"Hello, world!"</span></p></td></tr></table></p><p>In particular, if the above is put into a file <span class="stt">"hello"</span> and
the file is made executable (e.g., with <span class="stt">chmod a+x hello</span>), then
typing <span class="stt">./hello</span> at the shell prompt produces the output
<span class="stt">"Hello, world!"</span>.</p><p>The above script works because the operating system automatically puts
the path to the script as the argument to the program started by the
<span class="stt">#!</span> line, and because <span class="stt">racket</span> treats a single non-flag
argument as a file containing a module to run.</p><p>Instead of specifying a complete path to the <span class="stt">racket</span>
executable, a popular alternative is to require that <span class="stt">racket</span>
is in the user’s command path, and then “trampoline” using
<span class="stt">/usr/bin/env</span>:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">#! /usr/bin/env racket</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">"Hello, world!"</span></p></td></tr></table></p><p>In either case, command-line arguments to a script are available via
<span class="RktSym"><a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-command-line-arguments%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">current-command-line-arguments</a></span>:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">#! /usr/bin/env racket</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(printf "Given arguments: ~s\n"</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">(current-command-line-arguments))</span></p></td></tr></table></p><p>If the name of the script is needed, it is available via
<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=Filesystem.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._find-system-path%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">find-system-path</a></span><span class="stt"> </span><span class="RktVal">'</span><span class="RktVal">run-file</span><span class="RktPn">)</span>, instead of via
<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=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-command-line-arguments%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">current-command-line-arguments</a></span><span class="RktPn">)</span>.</p><p>Usually, then best way to handle command-line arguments is to parse
them using the <span class="RktSym">command-line</span> form provided by
<a href="http://download.racket-lang.org/docs/6.1/html/local-redirect/index.html?doc=reference&rel=index.html&version=6.1" class="RktModLink Sq" data-pltdoc="x"><span class="RktSym">racket</span></a>. The <span class="RktSym">command-line</span> form extracts
command-line arguments from <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=runtime.html%23%2528def._%2528%2528quote._%7E23%7E25kernel%2529._current-command-line-arguments%2529%2529&version=6.1" class="RktValLink Sq" data-pltdoc="x">current-command-line-arguments</a></span><span class="RktPn">)</span>
by default:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">#! /usr/bin/env racket</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(define verbose? (make-parameter #f))</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(define greeting</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">(command-line</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">#:once-each</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">[("-v") "Verbose mode" (verbose? #t)]</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">#:args</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">(str) str))</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(printf "~a~a\n"</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">greeting</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">(if (verbose?) " to you, too!" ""))</span></p></td></tr></table></p><p>Try running the above script with the <span class="nobreak"><span class="stt">--help</span></span> flag to see what
command-line arguments are allowed by the script.</p><p>An even more general trampoline uses <span class="stt">/bin/sh</span> plus some lines
that are comments in one language and expressions in the other. This
trampoline is more complicated, but it provides more control over
command-line arguments to <span class="stt">racket</span>:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">#! /bin/sh</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#|</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">exec racket -e '(printf "Running...\n")' -u "$0" ${1+"$@"}</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">|#</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(printf "The above line of output had been produced via\n")</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(printf "a use of the `-e' flag.\n")</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">(printf "Given arguments: ~s\n"</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt"></span><span class="hspace"> </span><span class="stt">(current-command-line-arguments))</span></p></td></tr></table></p><p>Note that <span class="RktInBG"><span class="hspace"></span><span class="RktIn">#!</span><span class="hspace"></span></span> starts a line comment in Racket, and
<span class="RktInBG"><span class="hspace"></span><span class="RktIn">#|</span><span class="hspace"></span></span>...<span class="RktInBG"><span class="hspace"></span><span class="RktIn">|#</span><span class="hspace"></span></span> forms a block comment. Meanwhile,
<span class="RktInBG"><span class="hspace"></span><span class="RktIn">#</span><span class="hspace"></span></span> also starts a shell-script comment, while <span class="stt">exec
racket</span> aborts the shell script to start <span class="stt">racket</span>. That way,
the script file turns out to be valid input to both <span class="stt">/bin/sh</span> and
<span class="stt">racket</span>.</p><h5 x-source-module="(lib "scribblings/guide/guide.scrbl")" x-part-tag=""Windows_Batch_Files"">21.2.2<tt> </tt><a name="(part._.Windows_.Batch_.Files)"></a>Windows Batch Files</h5><p>A similar trick can be used to write Racket code in Windows
<a name="(idx._(gentag._8._(lib._scribblings/guide/guide..scrbl)))"></a><span class="stt">.bat</span> batch files:</p><p><table cellspacing="0" cellpadding="0"><tr><td><p><span class="hspace"> </span><span class="stt">; @echo off</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">; Racket.exe "%~f0" %*</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">; exit /b</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">#lang racket/base</span></p></td></tr><tr><td><p><span class="hspace"> </span><span class="stt">"Hello, world!"</span></p></td></tr></table></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="racket.html" title="backward to "21.1 Running racket and gracket"" data-pltdoc="x">← prev</a> <a href="running.html" title="up to "21 Running and Creating Executables"" data-pltdoc="x">up</a> <a href="exe.html" title="forward to "21.3 Creating Stand-Alone Executables"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|