[doc] misc. fix & improvements
[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  * Copyright (C) 2013 - Scilab Enterprises - Vincent COUVERT
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml"
19           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
20           xmlns:scilab="http://www.scilab.org" xml:id="SCIHOME" xml:lang="en">
21     <refnamediv>
22         <refname>SCIHOME</refname>
23         <refpurpose>contains the path to preferences, history files of your Scilab
24             session.
25         </refpurpose>
26     </refnamediv>
27     <refsection>
28         <title>Description</title>
29         <para>
30             The <literal>SCIHOME</literal> contains the path to preferences, history files
31             of your Scilab session.
32         </para>
33         <para>
34             <literal>SCIHOME</literal> definition:
35         </para>
36         <para>
37             On Windows XP: "%USERPROFILE%\Application Data\Scilab\&lt;Scilab-Version&gt;" with %USERPROFILE% similar to "C:\Documents and Settings\&lt;User&gt;".
38         </para>
39         <para>
40             On Windows Vista, 7 and 8: "%USERPROFILE%\AppData\Roaming\Scilab\&lt;Scilab-Version&gt;" with %USERPROFILE% similar to "C:\Users\&lt;User&gt;".
41         </para>
42         <para>
43             On GNU/Linux or Unix: /home/&lt;User&gt;/.Scilab/&lt;Scilab-Version&gt;
44         </para>
45         <para>
46             On Mac OS X: /Users/&lt;User&gt;/.Scilab/&lt;Scilab-Version&gt;
47         </para>
48         <para>
49             &lt;User&gt; is your current login name
50         </para>
51         <para>
52             &lt;Scilab-Version&gt; is current version of Scilab used.
53         </para>
54         <note>
55            The default path assigned to <literal>SCIHOME</literal> may be replaced with a given path
56            specified with the <literal>-scihome</literal> option when launching Scilab.
57         </note>
58     </refsection>
59     <refsection>
60         <title>Examples</title>
61         <programlisting role="example"><![CDATA[
62 disp(SCIHOME);
63 isdir(SCIHOME)
64  ]]></programlisting>
65     </refsection>
66     <refsection role="see also">
67         <title>See also</title>
68         <simplelist type="inline">
69             <member>
70                 <link linkend="SCI">SCI</link>
71             </member>
72             <member>
73                 <link linkend="TMPDIR">TMPDIR</link>
74             </member>
75             <member>
76                 <link linkend="scilab">Scilab startup</link>
77             </member>
78         </simplelist>
79     </refsection>
80 </refentry>