@ciao-lang/ts-ciao-interface

<!DOCTYPE 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>Operating system utilities — The Ciao System v1.22</title></head><body><div class="lpdoc-page fixleftbar"><a href="#" id="sidebar-toggle-button" class="lpdoc-navbutton">☰</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"><a class="lpdoc-navbutton" href="StdLibs.html">↑</a><a class="lpdoc-navbutton" href="libpaths.html">←</a><a class="lpdoc-navbutton" href="pathnames.html">→</a><a class="lpdoc-navbutton" href="ciaosearch.html">🔍</a><a href="ciaofulltoc.html">TOC</a></div><hr></hr><ul class="lpdoc-itemize-sectpath"><li><a href="ciao.html">The Ciao System</a> » </li><li><a href="StdLibs.html">PART VII - Standard libraries</a> » </li><li><a href="">Operating system utilities</a></li></ul><hr></hr>ON THIS PAGE<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>Operating system utilities</h1><a class="lpdoc-idx-anchor" href="ciaosearch.html#system"></a> Author(s): <a class="lpdoc-idx-anchor" id="Daniel Cabeza" href="ciaosearch.html#Daniel Cabeza">Daniel Cabeza</a>, <a class="lpdoc-idx-anchor" id="Manuel Carro" href="ciaosearch.html#Manuel Carro">Manuel Carro</a>. This module contains predicates for invoking services which are typically provided by the operating system. Note that the predicates which take names of files or directories as arguments in this module expect atoms, not <a class="lpdoc-idx-anchor" id="0" href="ciaosearch.html#path alias">path alias</a>es. I.e., generally these predicates will not call <a class="lpdoc-idx-anchor" id="1" href="iso_incomplete.html#absolute_file_name/2"><tt>absolute_file_name/2</tt></a> on names of files or directories taken as arguments. <div id="Usage and interface"><h2>Usage and interface</h2><div class="lpdoc-cartouche"><ul><li>Library usage: <tt>:- use_module(library(system)).</tt><li>Exports: <ul class="lpdoc-itemize-minus"><li>Predicates: <a class="lpdoc-idx-anchor" id="2" href="#now/1"><tt>now/1</tt></a>, <a class="lpdoc-idx-anchor" id="3" href="#datime/1"><tt>datime/1</tt></a>, <a class="lpdoc-idx-anchor" id="4" href="#datime/9"><tt>datime/9</tt></a>, <a class="lpdoc-idx-anchor" id="5" href="#copy_file/2"><tt>copy_file/2</tt></a>, <a class="lpdoc-idx-anchor" id="6" href="#copy_file/3"><tt>copy_file/3</tt></a>, <a class="lpdoc-idx-anchor" id="7" href="#getenvstr/2"><tt>getenvstr/2</tt></a>, <a class="lpdoc-idx-anchor" id="8" href="#setenvstr/2"><tt>setenvstr/2</tt></a>, <a class="lpdoc-idx-anchor" id="9" href="#set_env/2"><tt>set_env/2</tt></a>, <a class="lpdoc-idx-anchor" id="10" href="#del_env/1"><tt>del_env/1</tt></a>, <a class="lpdoc-idx-anchor" id="11" href="#current_env/2"><tt>current_env/2</tt></a>, <a class="lpdoc-idx-anchor" id="12" href="#extract_paths/2"><tt>extract_paths/2</tt></a>, <a class="lpdoc-idx-anchor" id="13" href="#current_host/1"><tt>current_host/1</tt></a>, <a class="lpdoc-idx-anchor" id="14" href="#current_executable/1"><tt>current_executable/1</tt></a>, <a class="lpdoc-idx-anchor" id="15" href="#umask/2"><tt>umask/2</tt></a>, <a class="lpdoc-idx-anchor" id="16" href="#working_directory/2"><tt>working_directory/2</tt></a>, <a class="lpdoc-idx-anchor" id="17" href="#cd/1"><tt>cd/1</tt></a>, <a class="lpdoc-idx-anchor" id="18" href="#directory_files/2"><tt>directory_files/2</tt></a>, <a class="lpdoc-idx-anchor" id="19" href="#mktemp/2"><tt>mktemp/2</tt></a>, <a class="lpdoc-idx-anchor" id="20" href="#mktemp_in_tmp/2"><tt>mktemp_in_tmp/2</tt></a>, <a class="lpdoc-idx-anchor" id="21" href="#file_exists/1"><tt>file_exists/1</tt></a>, <a class="lpdoc-idx-anchor" id="22" href="#file_exists/2"><tt>file_exists/2</tt></a>, <a class="lpdoc-idx-anchor" id="23" href="#file_property/2"><tt>file_property/2</tt></a>, <a class="lpdoc-idx-anchor" id="24" href="#file_properties/6"><tt>file_properties/6</tt></a>, <a class="lpdoc-idx-anchor" id="25" href="#modif_time/2"><tt>modif_time/2</tt></a>, <a class="lpdoc-idx-anchor" id="26" href="#modif_time0/2"><tt>modif_time0/2</tt></a>, <a class="lpdoc-idx-anchor" id="27" href="#touch/1"><tt>touch/1</tt></a>, <a class="lpdoc-idx-anchor" id="28" href="#fmode/2"><tt>fmode/2</tt></a>, <a class="lpdoc-idx-anchor" id="29" href="#chmod/2"><tt>chmod/2</tt></a>, <a class="lpdoc-idx-anchor" id="30" href="#chmod/3"><tt>chmod/3</tt></a>, <a class="lpdoc-idx-anchor" id="31" href="#set_exec_mode/2"><tt>set_exec_mode/2</tt></a>, <a class="lpdoc-idx-anchor" id="32" href="#delete_directory/1"><tt>delete_directory/1</tt></a>, <a class="lpdoc-idx-anchor" id="33" href="#delete_file/1"><tt>delete_file/1</tt></a>, <a class="lpdoc-idx-anchor" id="34" href="#rename_file/2"><tt>rename_file/2</tt></a>, <a class="lpdoc-idx-anchor" id="35" href="#make_directory/2"><tt>make_directory/2</tt></a>, <a class="lpdoc-idx-anchor" id="36" href="#make_directory/1"><tt>make_directory/1</tt></a>, <a class="lpdoc-idx-anchor" id="37" href="#system_error_report/1"><tt>system_error_report/1</tt></a>, <a class="lpdoc-idx-anchor" id="38" href="#get_tmp_dir/1"><tt>get_tmp_dir/1</tt></a>, <a class="lpdoc-idx-anchor" id="39" href="#dev_null/1"><tt>dev_null/1</tt></a>, <a class="lpdoc-idx-anchor" id="40" href="#pause/1"><tt>pause/1</tt></a>, <a class="lpdoc-idx-anchor" id="41" href="#wait/2"><tt>wait/2</tt></a>, <a class="lpdoc-idx-anchor" id="42" href="#kill/2"><tt>kill/2</tt></a>, <a class="lpdoc-idx-anchor" id="43" href="#get_pid/1"><tt>get_pid/1</tt></a>, <a class="lpdoc-idx-anchor" id="44" href="#get_uid/1"><tt>get_uid/1</tt></a>, <a class="lpdoc-idx-anchor" id="45" href="#get_gid/1"><tt>get_gid/1</tt></a>, <a class="lpdoc-idx-anchor" id="46" href="#get_pwnam/1"><tt>get_pwnam/1</tt></a>, <a class="lpdoc-idx-anchor" id="47" href="#get_grnam/1"><tt>get_grnam/1</tt></a>, <a class="lpdoc-idx-anchor" id="48" href="#get_numcores/1"><tt>get_numcores/1</tt></a>, <a class="lpdoc-idx-anchor" id="49" href="#shell/0"><tt>shell/0</tt></a>, <a class="lpdoc-idx-anchor" id="50" href="#shell/1"><tt>shell/1</tt></a>, <a class="lpdoc-idx-anchor" id="51" href="#shell/2"><tt>shell/2</tt></a>, <a class="lpdoc-idx-anchor" id="52" href="#system/1"><tt>system/1</tt></a>, <a class="lpdoc-idx-anchor" id="53" href="#system/2"><tt>system/2</tt></a>, <a class="lpdoc-idx-anchor" id="54" href="#fd_dup/2"><tt>fd_dup/2</tt></a>, <a class="lpdoc-idx-anchor" id="55" href="#fd_close/1"><tt>fd_close/1</tt></a>, <a class="lpdoc-idx-anchor" id="56" href="#winpath/3"><tt>winpath/3</tt></a>, <a class="lpdoc-idx-anchor" id="57" href="#winpath/2"><tt>winpath/2</tt></a>, <a class="lpdoc-idx-anchor" id="58" href="#winpath_c/3"><tt>winpath_c/3</tt></a>, <a class="lpdoc-idx-anchor" id="59" href="#cyg2win/3"><tt>cyg2win/3</tt></a>, <a class="lpdoc-idx-anchor" id="60" href="#no_swapslash/3"><tt>no_swapslash/3</tt></a>, <a class="lpdoc-idx-anchor" id="61" href="#cyg2win_a/3"><tt>cyg2win_a/3</tt></a>, <a class="lpdoc-idx-anchor" id="62" href="#using_windows/0"><tt>using_windows/0</tt></a>, <a class="lpdoc-idx-anchor" id="63" href="#get_home/1"><tt>get_home/1</tt></a>, <a class="lpdoc-idx-anchor" id="64" href="#find_executable/2"><tt>find_executable/2</tt></a>. <li>Regular Types: <a class="lpdoc-idx-anchor" id="65" href="#datime_struct/1"><tt>datime_struct/1</tt></a>, <a class="lpdoc-idx-anchor" id="66" href="#copy_option/1"><tt>copy_option/1</tt></a>, <a class="lpdoc-idx-anchor" id="67" href="#copy_options/1"><tt>copy_options/1</tt></a>. </ul></ul></div></div><div id="Documentation on exports"><h2>Documentation on exports</h2><div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="now/1" href="ciaosearch.html#now/1">now/1</a></div><div class="lpdoc-deftext"><tt>now(Time)</tt> Time is unified with the number of seconds elapsed since January, 1, 1970 (UTC).Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="68" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="69" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="datime/1" href="ciaosearch.html#datime/1">datime/1</a></div><div class="lpdoc-deftext"><tt>datime(Datime)</tt> Datime is unified with a term of the form <tt>datime(Year,Month,Day,Hour,Minute,Second)</tt> which contains the current date and time.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="71" href="#datime_struct/1"><tt>system:datime_struct/1</tt></a>)<a class="lpdoc-idx-anchor" id="70" href="ciaosearch.html#datime_struct(Datime)"><tt>system:datime_struct(Datime)</tt></a> <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="73" href="#datime_struct/1"><tt>system:datime_struct/1</tt></a>)<a class="lpdoc-idx-anchor" id="72" href="ciaosearch.html#datime_struct(Datime)"><tt>system:datime_struct(Datime)</tt></a> </ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="datime_struct/1" href="ciaosearch.html#datime_struct/1">datime_struct/1</a></div><div class="lpdoc-deftext">A regular type, defined as follows:<pre class="lpdoc-codeblock">datime_struct(datime(Year,Month,Day,Hour,Min,Sec)) :- int(Year), int(Month), int(Day), int(Hour), int(Min), int(Sec). </pre> </div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="datime/9" href="ciaosearch.html#datime/9">datime/9</a></div><div class="lpdoc-deftext"><tt>datime(Time,Year,Month,Day,Hour,Min,Sec,WeekDay,YearDay)</tt> Time is as in <a class="lpdoc-idx-anchor" id="74" href="#now/1"><tt>now/1</tt></a>. WeekDay is the number of days since Sunday, in the range 0 to 6. YearDay is the number of days since January 1, in the range 0 to 365.Usage 1:If Time is given, the rest of the arguments are unified with the date and time to which the Time argument refers.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="75" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Year is an integer. (<a class="lpdoc-idx-anchor" id="76" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Month is an integer. (<a class="lpdoc-idx-anchor" id="77" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Day is an integer. (<a class="lpdoc-idx-anchor" id="78" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Hour is an integer. (<a class="lpdoc-idx-anchor" id="79" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Min is an integer. (<a class="lpdoc-idx-anchor" id="80" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sec is an integer. (<a class="lpdoc-idx-anchor" id="81" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="82" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="83" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="84" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Year is an integer. (<a class="lpdoc-idx-anchor" id="85" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Month is an integer. (<a class="lpdoc-idx-anchor" id="86" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Day is an integer. (<a class="lpdoc-idx-anchor" id="87" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Hour is an integer. (<a class="lpdoc-idx-anchor" id="88" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Min is an integer. (<a class="lpdoc-idx-anchor" id="89" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sec is an integer. (<a class="lpdoc-idx-anchor" id="90" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="91" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. </ul>Usage 2:Bound Time, WeekDay and YearDay as determined by the input arguments.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="92" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. (<a class="lpdoc-idx-anchor" id="93" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="94" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="95" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Year is an integer. (<a class="lpdoc-idx-anchor" id="96" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Month is an integer. (<a class="lpdoc-idx-anchor" id="97" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Day is an integer. (<a class="lpdoc-idx-anchor" id="98" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Hour is an integer. (<a class="lpdoc-idx-anchor" id="99" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Min is an integer. (<a class="lpdoc-idx-anchor" id="100" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sec is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="101" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. (<a class="lpdoc-idx-anchor" id="102" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="103" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. </ul>Usage 3:Bound Time to current time and the rest of the arguments refer to current time.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="104" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="105" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="106" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Time is a free variable. (<a class="lpdoc-idx-anchor" id="107" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Year is a free variable. (<a class="lpdoc-idx-anchor" id="108" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Month is a free variable. (<a class="lpdoc-idx-anchor" id="109" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Day is a free variable. (<a class="lpdoc-idx-anchor" id="110" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Hour is a free variable. (<a class="lpdoc-idx-anchor" id="111" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Min is a free variable. (<a class="lpdoc-idx-anchor" id="112" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)Sec is a free variable. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="113" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Time is an integer. (<a class="lpdoc-idx-anchor" id="114" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Year is an integer. (<a class="lpdoc-idx-anchor" id="115" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Month is an integer. (<a class="lpdoc-idx-anchor" id="116" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Day is an integer. (<a class="lpdoc-idx-anchor" id="117" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Hour is an integer. (<a class="lpdoc-idx-anchor" id="118" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Min is an integer. (<a class="lpdoc-idx-anchor" id="119" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Sec is an integer. (<a class="lpdoc-idx-anchor" id="120" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)WeekDay is an integer. (<a class="lpdoc-idx-anchor" id="121" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)YearDay is an integer. </ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="copy_option/1" href="ciaosearch.html#copy_option/1">copy_option/1</a></div><div class="lpdoc-deftext">Usage:<tt>copy_option(Opt)</tt> Opt is a file copy option. <pre class="lpdoc-codeblock">copy_option(overwrite). copy_option(timestamp). copy_option(symlink). copy_option(append). </pre><ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">REGTYPE<a class="lpdoc-idx-anchor" id="copy_options/1" href="ciaosearch.html#copy_options/1">copy_options/1</a></div><div class="lpdoc-deftext">Usage:<tt>copy_options(Opts)</tt> Opts is a list of file copy options.<ul class="lpdoc-itemize-minus"></ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="copy_file/2" href="ciaosearch.html#copy_file/2">copy_file/2</a></div><div class="lpdoc-deftext"><tt>copy_file(Source,Destination)</tt> Copies the file Source to Destination.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="122" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Source is an atom. (<a class="lpdoc-idx-anchor" id="123" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Destination is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="copy_file/3" href="ciaosearch.html#copy_file/3">copy_file/3</a></div><div class="lpdoc-deftext">Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="124" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg1 is an atom. (<a class="lpdoc-idx-anchor" id="125" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Arg2 is an atom. (<a class="lpdoc-idx-anchor" id="126" href="#copy_options/1"><tt>system:copy_options/1</tt></a>)Arg3 is a list of file copy options. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="getenvstr/2" href="ciaosearch.html#getenvstr/2">getenvstr/2</a></div><div class="lpdoc-deftext"><tt>getenvstr(Name,Value)</tt> The environment variable Name has Value. Fails if variable Name is not defined.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="127" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)Value is a string (a list of character codes). <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="128" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="129" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)Value is a string (a list of character codes). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="setenvstr/2" href="ciaosearch.html#setenvstr/2">setenvstr/2</a></div><div class="lpdoc-deftext"><tt>setenvstr(Name,Value)</tt> The environment variable Name is assigned Value.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="130" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. (<a class="lpdoc-idx-anchor" id="131" href="basic_props.html#string/1"><tt>basic_props:string/1</tt></a>)Value is a string (a list of character codes). </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="set_env/2" href="ciaosearch.html#set_env/2">set_env/2</a></div><div class="lpdoc-deftext"><tt>set_env(Name,Value)</tt> The environment variable Name is assigned Value.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="132" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. (<a class="lpdoc-idx-anchor" id="133" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Value is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="del_env/1" href="ciaosearch.html#del_env/1">del_env/1</a></div><div class="lpdoc-deftext"><tt>del_env(Name)</tt> The environment variable Name is removed.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="134" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_env/2" href="ciaosearch.html#current_env/2">current_env/2</a></div><div class="lpdoc-deftext"><tt>current_env(Name,Value)</tt> If Name is an atom, then unifies the environment variable Name with its value. Note that this predicate can be used to enumerate all the environment variables using backtracking.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="135" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. (<a class="lpdoc-idx-anchor" id="136" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Value is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="137" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Name is an atom. (<a class="lpdoc-idx-anchor" id="138" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Value is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="extract_paths/2" href="ciaosearch.html#extract_paths/2">extract_paths/2</a></div><div class="lpdoc-deftext"><tt>extract_paths(PathList,Paths)</tt> Split PathList atom into the list of paths Paths. Paths in String are separated by the <a class="lpdoc-idx-anchor" id="139" href="ciaosearch.html#path list separator character">path list separator character</a> (colons in POSIX-like systems, semicolons in Windows). Empty paths are removed from Paths. Paths is empty if PathList is the empty atom.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="140" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Paths is a list of atms. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="141" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)PathList is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="142" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)Paths is a list of atms. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_host/1" href="ciaosearch.html#current_host/1">current_host/1</a></div><div class="lpdoc-deftext"><tt>current_host(Hostname)</tt> Hostname is unified with the fully qualified name of the host.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="143" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Hostname is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="144" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Hostname is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="current_executable/1" href="ciaosearch.html#current_executable/1">current_executable/1</a></div><div class="lpdoc-deftext"><tt>current_executable(Path)</tt> Unifies Path with the path to the current Ciao executable (which may be a standalone binary or bytecode executable)Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="145" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Path is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="146" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Path is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="umask/2" href="ciaosearch.html#umask/2">umask/2</a></div><div class="lpdoc-deftext">Usage 1:<tt>umask(OldMask,NewMask)</tt> The process file creation mask was OldMask, and it is changed to NewMask.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="147" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)NewMask is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="148" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)OldMask is an integer. </ul>Usage 2:<tt>umask(OldMask,NewMask)</tt> Gets the process file creation mask without changing it.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="149" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)OldMask is a free variable. (<a class="lpdoc-idx-anchor" id="150" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)NewMask is a free variable. (<a class="lpdoc-idx-anchor" id="151" href="ciaosearch.html#== /2"><tt>term_compare:== /2</tt></a>)The terms OldMask and NewMask are strictly identical. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="152" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)OldMask is an integer. (<a class="lpdoc-idx-anchor" id="153" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)NewMask is an integer. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="working_directory/2" href="ciaosearch.html#working_directory/2">working_directory/2</a></div><div class="lpdoc-deftext"><tt>working_directory(OldDir,NewDir)</tt> Unifies current working directory with OldDir, and then changes the working directory to NewDir. Calling <tt>working_directory(Dir,Dir)</tt> simply unifies <tt>Dir</tt> with the current working directory without changing anything else.Usage 1:Changes current working directory.<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="154" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)OldDir is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="155" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)NewDir is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="156" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)OldDir is an atom. </ul>Usage 2:<tt>working_directory(OldDir,NewDir)</tt> Gets current working directory.<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="157" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)OldDir is a free variable. (<a class="lpdoc-idx-anchor" id="158" href="term_typing.html#var/1"><tt>term_typing:var/1</tt></a>)NewDir is a free variable. (<a class="lpdoc-idx-anchor" id="159" href="ciaosearch.html#== /2"><tt>term_compare:== /2</tt></a>)The terms OldDir and NewDir are strictly identical. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="160" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)OldDir is an atom. (<a class="lpdoc-idx-anchor" id="161" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)NewDir is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="cd/1" href="ciaosearch.html#cd/1">cd/1</a></div><div class="lpdoc-deftext"><tt>cd(Path)</tt> Changes working directory to Path.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="162" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Path is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="directory_files/2" href="ciaosearch.html#directory_files/2">directory_files/2</a></div><div class="lpdoc-deftext"><tt>directory_files(Directory,FileList)</tt> FileList is the unordered list of entries (files, directories, etc.) in Directory.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="163" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)FileList is a list of atms. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="164" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Directory is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="165" href="basic_props.html#list/2"><tt>basic_props:list/2</tt></a>)FileList is a list of atms. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="mktemp/2" href="ciaosearch.html#mktemp/2">mktemp/2</a></div><div class="lpdoc-deftext"><tt>mktemp(Template,Filename)</tt> Returns a unique Filename based on Template: Template must be a valid file name with six trailing X, which are substituted to create a new file name. Filename is created in read/write mode but closed immediately after creation.Usage:<ul class="lpdoc-itemize-minus"><li>Calls should, and exit will be compatible with: (<a class="lpdoc-idx-anchor" id="166" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Filename is an atom. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="167" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Template is an atom. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="168" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)Filename is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="mktemp_in_tmp/2" href="ciaosearch.html#mktemp_in_tmp/2">mktemp_in_tmp/2</a></div><div class="lpdoc-deftext">No further documentation available for this predicate.</div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="file_exists/1" href="ciaosearch.html#file_exists/1">file_exists/1</a></div><div class="lpdoc-deftext"><tt>file_exists(File)</tt> Succeeds if File (a file or directory) exists (and is accessible).Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="169" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)File is an atom. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="file_exists/2" href="ciaosearch.html#file_exists/2">file_exists/2</a></div><div class="lpdoc-deftext"><tt>file_exists(File,Mode)</tt> File (a file or directory) exists and it is accessible with Mode, as in the Unix call <tt>access(2)</tt>. Typically, Mode is 4 for read permission, 2 for write permission and 1 for execute permission.Usage:<ul class="lpdoc-itemize-minus"><li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="170" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)File is an atom. (<a class="lpdoc-idx-anchor" id="171" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Mode is an integer. <li>The following properties hold upon exit: (<a class="lpdoc-idx-anchor" id="172" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)File is an atom. (<a class="lpdoc-idx-anchor" id="173" href="basic_props.html#int/1"><tt>basic_props:int/1</tt></a>)Mode is an integer. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="file_property/2" href="ciaosearch.html#file_property/2">file_property/2</a></div><div class="lpdoc-deftext"><tt>file_property(File,Property)</tt> File has the property Property. The possible properties are:<dl> <dt>type(Type)<dd> Type is one of <tt>regular</tt>, <tt>directory</tt>, <tt>fifo</tt>, <tt>socket</tt> or <tt>unknown</tt>.<dt>linkto(Linkto)<dd> If File is a symbolic link, Linkto is the file pointed to by the link (and the other properties come from that file, not from the link itself).<dt>mod_time(ModTime)<dd> ModTime is the time of last modification (seconds since January, 1, 1970).<dt>mode(Protection)<dd> Protection is the protection mode.<dt>size(Size)<dd> Size is the size.</dl> If Property is uninstantiated, the predicate will enumerate the properties on backtracking.Usage:<ul class="lpdoc-itemize-minus"><li>Call and exit should be compatible with: (<a class="lpdoc-idx-anchor" id="174" href="basic_props.html#struct/1"><tt>basic_props:struct/1</tt></a>)Property is a compound term. <li>The following properties should hold at call time: (<a class="lpdoc-idx-anchor" id="175" href="basic_props.html#atm/1"><tt>basic_props:atm/1</tt></a>)File is an atom. <li>The following properties should hold upon exit: (<a class="lpdoc-idx-anchor" id="176" href="basic_props.html#struct/1"><tt>basic_props:struct/1</tt></a>)Property is a compound term. </ul></div></div> <div><div class="lpdoc-defname">PREDICATE<a class="lpdoc-idx-anchor" id="file_properties/6" href="ciaosearch.html#file_properties/6">file_properties/6</a></div><div class="lpdoc-deftext"><tt>file_properties(Path,Type,Linkto,Time,Protection,Size)</tt> The file Path has the following properties:<ul> <li>File type Type (one of <tt>regular</tt>, <tt>directory</tt>, <tt>fifo</tt>, <tt>socket</tt> or <tt>unknown</tt>).<li>If Path is a symbolic link, Linkto is the file pointed to. All other properties come from the file pointed, not the link. Linkto is '' if Path is not a symbolic link.