@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
23 lines • 7.78 kB
HTML
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="viewport" content="width=device-width, initial-scale=1"/><meta name="theme-color" content="#273f79"/><link rel="stylesheet" href="lpdoc.css" type="text/css"/><script type="text/javascript" src="lpdoc.js"></script><title>Customizing path aliases — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton"><span id="sidebar-button-arrow">☰</span></a><div id="sidebar" class="lpdoc-sidebar"><div style="height: 40px; margin-left: auto; margin-right: auto"><img src="ciao-logo_autofig.png" width=auto height=100%></div><div class="lpdoc-nav"><span class="lpdoc-on-right"><a class="lpdoc-navbutton" href="StdLibs.html">↑</a><a class="lpdoc-navbutton" href="compiler.html">←</a><a class="lpdoc-navbutton" href="system.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a></span><span><a href="ciaofulltoc.html">TOC</a></span></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> »<br/> </li><li><a href="StdLibs.html">PART VII - Standard libraries</a> »<br/> </li><li><a href=""><strong>Customizing path aliases</strong></a></li></ul><hr></hr><em>ON THIS PAGE</em><ul><li><a href="#Usage and interface">Usage and interface</a></li><li><a href="#Documentation on exports">Documentation on exports</a></li><li><a href="#Documentation on multifiles">Documentation on multifiles</a></li><li><a href="#Documentation on imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>Customizing path aliases</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#libpaths"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>.<p>
This library provides means for customizing the <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#path alias">path alias</a>es known by an executable from the <tt>CIAOALIASPATH</tt> environment variable. This is used by many applications of Ciao, including <a class="lpdoc-idx-anchor" id="1" href="ciaosearch.html#ciaoc"><tt>ciaoc</tt></a>, <a class="lpdoc-idx-anchor" id="2" href="ciaosearch.html#ciaosh"><tt>ciaosh</tt></a>, and <a class="lpdoc-idx-anchor" id="3" href="ciaosearch.html#ciao-shell"><tt>ciao-shell</tt></a>, specially during system boostrapping.<p><div class="lpdoc-note"> This library is not recommended for user programs. Use <a class="lpdoc-idx-anchor" id="4" href="ciaosearch.html#bundle">bundle</a>s instead. </div><br/><div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li><strong>Library usage:</strong><br/><tt>:- use_module(library(libpaths)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="5" href="#get_alias_path/0"><tt>get_alias_path/0</tt></a>.
<li><em>Multifiles:</em><br/><a class="lpdoc-idx-anchor" id="6" href="stream_basic.html#file_search_path/2"><tt>file_search_path/2</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="stream_basic.html#library_directory/1"><tt>library_directory/1</tt></a>.
</ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="get_alias_path/0" href="ciaosearch.html#get_alias_path/0">get_alias_path/0</a></div><div class="lpdoc-deftext"><span class="lpdoc-usage-decl"><tt>get_alias_path</tt>
</span><p>Consult the environment variable <tt>CIAOALIASPATH</tt> and add facts to predicates <a class="lpdoc-idx-anchor" id="8" href="stream_basic.html#library_directory/1"><tt>library_directory/1</tt></a> and <a class="lpdoc-idx-anchor" id="9" href="stream_basic.html#file_search_path/2"><tt>file_search_path/2</tt></a> to define new library paths and <a class="lpdoc-idx-anchor" id="10" href="ciaosearch.html#path alias">path alias</a>es. The format of <tt>CIAOALIASPATH</tt> is a sequence of paths or alias assignments separated by a <a class="lpdoc-idx-anchor" id="11" href="ciaosearch.html#path list separator character">path list separator character</a> (see <a class="lpdoc-idx-anchor" id="12" href="system.html#extract_paths/2"><tt>extract_paths/2</tt></a>), an alias assignment is the name of the alias, an <tt>=</tt> and the path represented by that alias (no blanks allowed). For example, given <pre class="lpdoc-codeblock"> CIAOALIASPATH=/home/bardo/ciao:contrib=/usr/local/lib/ciao
</pre> the predicate will define <tt>/home/bardo/ciao</tt> as a library path and <tt>/usr/local/lib/ciao</tt> as the path represented by <tt>contrib</tt>.</div></div><p>
</div><div id="Documentation on multifiles"><h2>Documentation on multifiles</h2><div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="file_search_path/2" href="ciaosearch.html#file_search_path/2">file_search_path/2</a></div><div class="lpdoc-deftext">See <a href="stream_basic.html">Basic file/stream handling</a>.
The predicate is <em>multifile</em>.<br/>
The predicate is of type <em>dynamic</em>.<br/><span class="lpdoc-usage-decl"><tt>file_search_path(X,Y)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="13" href="basic_props.html#gnd/1"><tt>basic_props:gnd/1</tt></a>)</span><span><span class="lpdoc-var">X</span> is ground.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="14" href="basic_props.html#gnd/1"><tt>basic_props:gnd/1</tt></a>)</span><span><span class="lpdoc-var">Y</span> is ground.
</span>
</ul></div></div><p>
<div><div class="lpdoc-defname"><span class="lpdoc-predtag">PREDICATE</span><a class="lpdoc-idx-anchor" id="library_directory/1" href="ciaosearch.html#library_directory/1">library_directory/1</a></div><div class="lpdoc-deftext">See <a href="stream_basic.html">Basic file/stream handling</a>.
The predicate is <em>multifile</em>.<br/>
The predicate is of type <em>dynamic</em>.<br/><span class="lpdoc-usage-decl"><tt>library_directory(X)</tt>
</span><p></p><ul class="lpdoc-itemize-minus"><li><em>The following properties hold upon exit:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="15" href="basic_props.html#gnd/1"><tt>basic_props:gnd/1</tt></a>)</span><span><span class="lpdoc-var">X</span> is ground.
</span>
</ul></div></div><p>
</div><div id="Documentation on imports"><h2>Documentation on imports</h2>This module has the following direct dependencies:<ul class="lpdoc-itemize-minus"><li><em>System library modules:</em><br/><a class="lpdoc-idx-anchor" id="16" href="datafacts_rt.html"><tt>datafacts_rt</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="system.html"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="lists.html"><tt>lists</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="19" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="datafacts_doc.html"><tt>datafacts</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>