a8d07480e88d0bc6db30b72dba838ca1f33cfcd2
[scilab.git] / scilab / modules / core / help / en_US / variables / predefined / SCIHOME.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) 2011 - DIGITEO - Allan CORNET
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="SCIHOME" xml:lang="en">
14     <refnamediv>
15         <refname>SCIHOME</refname>
16         <refpurpose>contains the path to preferences, history files of your Scilab
17             session.
18         </refpurpose>
19     </refnamediv>
20     <refsection>
21         <title>Description</title>
22         <para>
23             The <literal>SCIHOME</literal> contains the path to preferences, history files
24             of your Scilab session.
25         </para>
26         <para>
27             <literal>SCIHOME</literal> definition:
28         </para>
29         <para>
30             On Windows XP: "C:/Documents and Settings/&lt;User&gt;/Scilab/&lt;Scilab-Version&gt;"
31         </para>
32         <para>
33             On Windows Vista and Seven:
34             "C:/User/AppData/Roaming/&lt;User&gt;/Scilab/&lt;Scilab-Version&gt;"
35         </para>
36         <para>
37             based on Windows %HOMEPATH% environment variable.
38         </para>
39         <para>
40             On GNU/Linux or Unix:
41             /home/&lt;User&gt;/.Scilab/&lt;Scilab-Version&gt;
42         </para>
43         <para>
44             On Mac OS X:
45             /Users/&lt;User&gt;/.Scilab/&lt;Scilab-Version&gt;
46         </para>
47         <para>
48             &lt;User&gt; is your current login name
49         </para>
50         <para>
51             &lt;Scilab-Version&gt; is current version of Scilab used.
52         </para>
53     </refsection>
54     <refsection>
55         <title>Examples</title>
56         <programlisting role="example"><![CDATA[
57 disp(SCIHOME);
58 isdir(SCIHOME)
59  ]]></programlisting>
60     </refsection>
61     <refsection role="see also">
62         <title>See Also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="SCI">SCI</link>
66             </member>
67         </simplelist>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="TMPDIR">TMPDIR</link>
71             </member>
72         </simplelist>
73     </refsection>
74 </refentry>