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