1fc9de28f720732ecc89b408436a30a32767ff7d
[scilab.git] / scilab / modules / core / help / en_US / variables / predefined / TMPDIR.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2010 - Digiteo - Vincent LIARD
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="TMPDIR" xml:lang="en">
20     <refnamediv>
21         <refname>TMPDIR</refname>
22         <refpurpose>temporary directory path.</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>Description</title>
26         <para>
27             The <literal>TMPDIR</literal> constant holds the temporary directory
28             absolute path of a Scilab process. Each Scilab process has its own
29             temporary directory, created and referenced to <literal>TMPDIR</literal>
30             during Scilab startup. The temporary directory is deleted when Scilab
31             stops.
32         </para>
33         <para>The temporary directories are created as subdirectories of the
34             system temporary directory and named SCI_TMP_&lt;unique&gt; where
35             &lt;unique&gt; is some number generated at Scilab startup for the name to
36             be unique. Under GNU/Linux, UNIX and Mac OS X, directory access rights are
37             limited to the Scilab user.
38         </para>
39         <para>
40             The <literal>TMPDIR</literal> constant cannot be altered during
41             Scilab execution. However, under GNU/Linux, UNIX and Mac OS X, the system
42             temporary directory (usually <literal>/tmp</literal>) can be selected by
43             altering the <literal>TMPDIR</literal> system variable.
44         </para>
45         <note>
46           <literal>dirname(TMPDIR)</literal> can be used as a general temporary directory,
47           without respect to any Scilab session.
48         </note>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[
53 ls TMPDIR
54 ls(TMPDIR)
55 cd(TMPDIR)
56         ]]></programlisting>
57     </refsection>
58     <refsection role="see also">
59         <title>See also</title>
60         <simplelist type="inline">
61             <member>
62                 <link linkend="tempname">tempname</link>
63             </member>
64             <member>
65                 <link linkend="home">home</link>
66             </member>
67             <member>
68                 <link linkend="SCIHOME">SCIHOME</link>
69             </member>
70             <member>
71                 <link linkend="SCI">SCI</link>
72             </member>
73         </simplelist>
74     </refsection>
75 </refentry>