<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="generator" content="AsciiDoc 8.6.10">
<title>MLBasisPathMap</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css">
<link rel="stylesheet" href="./pygments.css" type="text/css">


<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install();
/*]]>*/
</script>
<link rel="stylesheet" href="./mlton.css" type="text/css">
</head>
<body class="article">
<div id="banner">
<div id="banner-home">
<a href="./Home">MLton 20201002</a>
</div>
</div>
<div id="header">
<h1>MLBasisPathMap</h1>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>An <a href="MLBasis">ML Basis</a> <em>path map</em> describes a map from ML Basis path
variables (of the form <span class="monospaced">$(VAR)</span>) to file system paths.  ML Basis path
variables provide a flexible way to refer to libraries while allowing
them to be moved without changing their clients.</p></div>
<div class="paragraph"><p>The format of an <span class="monospaced">mlb-path-map</span> file is a sequence of lines; each line
consists of two, white-space delimited tokens.  The first token is a
path variable <span class="monospaced">VAR</span> and the second token is the path to which the
variable is mapped.  The path may include path variables, which are
recursively expanded.</p></div>
<div class="paragraph"><p>The mapping from path variables to paths is initialized by the compiler.
Additional path maps can be specified with <span class="monospaced">-mlb-path-map</span> and
individual path variable mappings can be specified with
<span class="monospaced">-mlb-path-var</span> (see <a href="CompileTimeOptions">CompileTimeOptions</a>).  Configuration files are
processed from first to last and from top to bottom, later mappings
take precedence over earlier mappings.</p></div>
<div class="paragraph"><p>The compiler and system-wide configuration file makes the following
path variables available.</p></div>
<table class="tableblock frame-all grid-all"
style="
width:100%;
">
<col style="width:25%;">
<col style="width:75%;">
<thead>
<tr>
<th class="tableblock halign-center valign-top" >MLB path variable</th>
<th class="tableblock halign-left valign-top" >Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">SML_LIB</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">path to system-wide libraries, usually <span class="monospaced">/usr/lib/mlton/sml</span></p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">TARGET_ARCH</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">string representation of target architecture</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">TARGET_OS</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">string representation of target operating system</p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">DEFAULT_INT</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">binding for default int, usually <span class="monospaced">int32</span></p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">DEFAULT_WORD</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">binding for default word, usually <span class="monospaced">word32</span></p></td>
</tr>
<tr>
<td class="tableblock halign-center valign-top" ><p class="tableblock"><span class="monospaced">DEFAULT_REAL</span></p></td>
<td class="tableblock halign-left valign-top" ><p class="tableblock">binding for default real, usually <span class="monospaced">real64</span></p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div id="footnotes"><hr></div>
<div id="footer">
<div id="footer-text">
</div>
<div id="footer-badges">
</div>
</div>
</body>
</html>
