Bug #9798 fixed - .quit script of atoms modules were not evaluated when leaving Scilab.
[scilab.git] / scilab / modules / atoms / help / en_US / atomsQuit.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) DIGITEO - 2012 - Allan CORNET
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry version="5.0-subset Scilab" xml:id="atomsQuit" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <refnamediv>
21     <refname>atomsQuit</refname>
22     <refpurpose>Unload (call .quit file of) external modules previously loaded by ATOMS</refpurpose>
23   </refnamediv>
24   
25   <refsynopsisdiv>
26     <title>Calling Sequence</title>
27     <synopsis>
28       result = atomsQuit();
29     </synopsis>
30   </refsynopsisdiv>
31   
32   <refsection>
33     <title>Arguments</title>
34     
35     <variablelist>
36       <varlistentry>
37         <term>result</term>
38         <listitem>
39           <para>scalar boolean %T or %F</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   
45   <refsection>
46     <title>Description</title>
47     <para><literal>atomsQuit</literal>unload (call .quit file of) external modules previously loaded by ATOMS.</para>
48     <para>This function is called by SCI/etc/scilab.quit</para>
49   </refsection>
50
51   <refsection role="see also">
52     <title>See Also</title>
53     <simplelist type="inline">
54       <member>
55         <link linkend="atomsIsLoaded">atomsIsLoaded</link>
56       </member>
57       <member>
58         <link linkend="atomsGetLoaded">atomsGetLoaded</link>
59       </member>
60       <member>
61         <link linkend="atomsGetLoaded">atomsInstall</link>
62       </member>
63     </simplelist>
64   </refsection>
65   <refsection>
66     <title>History</title>
67     <revhistory>
68       <revision>
69         <revnumber>5.4.0</revnumber>
70         <revremark>This function added in Scilab 5.4.0</revremark>
71       </revision>
72     </revhistory>
73   </refsection>
74 </refentry>