flag to force scilab exit after -e or -f execution added.
[scilab.git] / scilab / modules / core / help / en_US / scilab.xml
index 3fd9c32..38dcb69 100644 (file)
@@ -13,8 +13,8 @@
             scilab-cli <Options>
         </synopsis>
     </refsynopsisdiv>
-    <refsection>
-        <title>Description</title>
+    <refsection role="arguments">
+        <title>Arguments</title>
         <variablelist>
             <varlistentry>
                 <term>-args Arguments</term>
                 </listitem>
             </varlistentry>
             <varlistentry>
+                <term>-quit</term>
+                <listitem>
+                    This option forces scilab to always exit after the instruction(s) passed with the <literal>-e</literal>
+                    option, or the script referred to by the <literal>-f</literal> option, have been executed,
+                    even in case of a runtime error. This option should always be used in batch mode.
+                    It is ignored if neither <literal>-e</literal> nor <literal>-f</literal> options are present.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
                 <term>-l lang</term>
                 <listitem>
                     <para>If this option is present it fixes the user language.
             </varlistentry>
         </variablelist>
     </refsection>
-    <refsection>
+    <refsection role="description">
         <title>Description of environment variables</title>
         <variablelist>
             <varlistentry>
                 <term>SCIVERBOSE</term>
                 <listitem>
                     <para>
-                        If this variable is present, Scilab startup script will show a startup debug information. 
+                        If this variable is present, Scilab startup script will show a startup debug information.
                         Mainly used for bug report and debugging purposes.
                     </para>
                 </listitem>
                 <term>JAVA_HOME</term>
                 <listitem>
                     <para>
-                        Specify which Java to use. For example, 
+                        Specify which Java to use. For example,
                         <literal>JAVA_HOME=/usr/lib/jvm/java-7-openjdk/ scilab</literal> will start Scilab with Java 7.
                     </para>
                 </listitem>
             </varlistentry>
         </variablelist>
     </refsection>
-    <refsection>
+    <refsection role="description">
         <title>Java Virtual Machine options</title>
         <para>Starting from Scilab 5.0, the graphical user interface (GUI) and the
             build documentation are based on Java features. In some cases, it can be
             change look and feel, change memory managements... See: <ulink url="http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html">http://www.oracle.com/technetwork/java/javase/tech/vmoptions-jsp-140102.html</ulink>.
         </para>
     </refsection>
-    <refsection>
+    <refsection role="examples">
         <title>Examples</title>
-        <programlisting role="no-scilab-exec"><![CDATA[ 
+        <programlisting role="no-scilab-exec"><![CDATA[
 # Let's start Scilab in profiling mode without attaching a gdb once a SIGSEGV is met.
 # We are under Bash shell
 export SCILAB_VALGRIND_OPT="--db-attach=no --log-file=myfile.txt"
@@ -384,7 +394,7 @@ echo $? ]]></programlisting>
             </member>
         </simplelist>
     </refsection>
-    <refsection>
+    <refsection role="history">
         <title>History</title>
         <revhistory>
             <revision>
@@ -398,7 +408,7 @@ echo $? ]]></programlisting>
             <revision>
                 <revnumber>6.0.0</revnumber>
                 <revremark>
-                    <literal>-mem</literal> option removed.
+                    <literal>-quit</literal> option added. <literal>-mem</literal> option removed.
                 </revremark>
             </revision>
         </revhistory>