62b304366c57ee54780ca794cbb8a4ee5fbccd6f
[scilab.git] / scilab / modules / core / help / en_US / startup.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
4           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
5           xmlns:scilab="http://www.scilab.org" xml:id="startup" xml:lang="en">
6     <refnamediv>
7         <refname>startup</refname>
8         <refpurpose>startup files</refpurpose>
9     </refnamediv>
10     <refsection>
11         <title>Description</title>
12         <para>
13             The startup files <link linkend="SCIHOME">SCIHOME</link>/.scilab or
14             <link linkend="SCIHOME">SCIHOME</link>/scilab.ini are automatically executed (if
15             present) when Scilab is invoked, in addition with the file
16             <link linkend="SCI">SCI</link>/etc/scilab.start.
17         </para>
18     </refsection>
19     <refsection>
20         <title>Remarks</title>
21         <para>Last line of startup file must be terminated by a newline to be
22             taken into account.
23         </para>
24     </refsection>
25     <refsection>
26         <title>Examples</title>
27         <programlisting role="example"><![CDATA[
28 ls(SCIHOME)
29 if ls(SCIHOME+"/scilab.ini") == [] & ls(SCIHOME+"/.scilab") == []
30    disp("No startup file defined");
31 end
32  ]]></programlisting>
33     </refsection>
34
35     <refsection role="see also">
36         <title>See also</title>
37         <simplelist type="inline">
38             <member>
39                 <link linkend="scilab">scilab</link>
40             </member>
41             <member>
42                 <link linkend="SCIHOME">SCIHOME</link>
43             </member>
44             <member>
45                 <link linkend="SCI">SCI</link>
46             </member>
47             <member>
48                 <link linkend="TMPDIR">TMPDIR</link>
49             </member>
50         </simplelist>
51     </refsection>
52 </refentry>