37775215d85ac4d0c39b9a042f603fc68d969701
[scilab.git] / scilab / modules / core / help / en_US / configuration / getscilabmode.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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="getscilabmode">
3     <refnamediv>
4         <refname>getscilabmode</refname>
5         <refpurpose>returns scilab mode</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>m = getscilabmode()</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Description</title>
13         <para>Returns scilab mode. 4 modes are possible: STD, API, NW, NWNI.</para>
14         <para>
15             <literal>API</literal>: Scilab is launch as an API.
16         </para>
17         <para>
18             <literal>STD</literal>: the standard Scilab (gui, plot ...).
19         </para>
20         <para>
21             <literal>NW</literal>: Scilab in command line with the plots.
22         </para>
23         <para>
24             <literal>NWNI</literal>: Scilab in command line without any graphics.
25         </para>
26     </refsection>
27     <refsection>
28         <title>Examples</title>
29         <programlisting role="example"><![CDATA[
30 getscilabmode()
31  ]]></programlisting>
32     </refsection>
33     <refsection role="see also">
34         <title>See also</title>
35         <simplelist type="inline">
36             <member>
37                 <link linkend="scilab">scilab</link>
38             </member>
39         </simplelist>
40     </refsection>
41 </refentry>