@ciao-lang/ts-ciao-interface
Version:
Simple Ciao interface for node.
13 lines • 6.64 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>File archiver — 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="ExtraLibs.html">↑</a><a class="lpdoc-navbutton" href="parse_shell_args.html">←</a><a class="lpdoc-navbutton" href="file_locks.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="ExtraLibs.html">PART VIII - Additional libraries</a> »<br/> </li><li><a href=""><strong>File archiver</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 imports">Documentation on imports</a></li></ul></div><div class="lpdoc-main"><div id=""><h1>File archiver</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#archive_files"></a>
<strong>Author(s):</strong> <a class="lpdoc-idx-anchor" id="The Ciao Development Team" href="ciaosearch.html#The Ciao Development Team">The Ciao Development Team</a>, <a class="lpdoc-idx-anchor" id="Jose F. Morales" href="ciaosearch.html#Jose F. Morales">Jose F. Morales</a>.<p>
This module offers predicates to generate file <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#archive">archive</a>s in some common formats. An archive file is a file that is composed of one or more computer files along with metadata, with can be compressed. See <a class="lpdoc-idx-anchor" id="1" href="#archive_files/4"><tt>archive_files/4</tt></a> for the supported formats. <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(archive_files)).</tt><li><strong>Exports:</strong><br/><ul class="lpdoc-itemize-minus"><li><em>Predicates:</em><br/><a class="lpdoc-idx-anchor" id="2" href="#archive_files/4"><tt>archive_files/4</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="archive_files/4" href="ciaosearch.html#archive_files/4">archive_files/4</a></div><div class="lpdoc-deftext"><p><span class="lpdoc-usage-header">Usage:</span><span class="lpdoc-usage-decl"><tt>archive_files(SourceDir,Files,TopDir,Archive)</tt>
</span><p>Create an archive <span class="lpdoc-var">Archive</span> of the given files at <span class="lpdoc-var">Files</span>, relative to <span class="lpdoc-var">SourceDir</span>. If <span class="lpdoc-var">TopDir</span> is not <tt>''</tt>, files are placed inside the archive under <span class="lpdoc-var">TopDir</span>.<p>The format is automatically detected from the extension of <span class="lpdoc-var">Archive</span> (where valid formats are: <tt>.tar.gz</tt>, <tt>.tgz</tt>, <tt>.tar.bz2</tt>, <tt>.tbz</tt>, and <tt>.zip</tt>).</p><ul class="lpdoc-itemize-minus"><li><em>Call and exit should be compatible with:</em><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="3" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)</span><span><span class="lpdoc-var">SourceDir</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="4" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)</span><span><span class="lpdoc-var">Files</span> is a list of <span class="lpdoc-var">atm</span>s.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="5" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)</span><span><span class="lpdoc-var">TopDir</span> is an atom.
</span><br/><span class="lpdoc-on-right"> (<a class="lpdoc-idx-anchor" id="6" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)</span><span><span class="lpdoc-var">Archive</span> is an atom.
</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="7" href="ciaosearch.html#native_props"><tt>native_props</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="terms.html"><tt>terms</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="process.html"><tt>process</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="pathnames.html"><tt>pathnames</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="system.html"><tt>system</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="system_extra.html"><tt>system_extra</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="port_reify.html"><tt>port_reify</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="ciaosearch.html#bundle_flags"><tt>bundle_flags</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="stream_utils.html"><tt>stream_utils</tt></a>.
<li><em>Packages:</em><br/><a class="lpdoc-idx-anchor" id="16" href="ciaosearch.html#prelude"><tt>prelude</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="ciaosearch.html#initial"><tt>initial</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="condcomp_doc.html"><tt>condcomp</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="assertions_doc.html"><tt>assertions</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="ciaosearch.html#assertions/assertions_basic"><tt>assertions/assertions_basic</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="basicmodes_doc.html"><tt>basicmodes</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="ciaosearch.html#nativeprops"><tt>nativeprops</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="regtypes_doc.html"><tt>regtypes</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="fsyntax_doc.html"><tt>fsyntax</tt></a>.
</ul></div></div><div class="lpdoc-footer">Generated with LPdoc using Ciao</div></div><div class="lpdoc-clearer"></div></div></body></html>