Bug #9798 fixed - .quit script of atoms modules were not evaluated when leaving Scilab.
[scilab.git] / scilab / modules / modules_manager / help / en_US / tbx_build_loader.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) INRIA
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 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" version="5.0-subset Scilab" xml:id="tbx_build_loader" xml:lang="en">
14   <info>
15     <pubdate>$LastChangedDate: 2008-08-19 17:25:59 +0200 $</pubdate>
16   </info>
17   <refnamediv>
18     <refname>tbx_build_loader</refname>
19     <refpurpose>Generate loader.sce and unloader scripts (toolbox compilation process)</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24       tbx_build_loader(toolbox_name)
25       tbx_build_loader(toolbox_name, toolbox_path)
26     </synopsis>
27   </refsynopsisdiv>
28   <refsection>
29     <title>Arguments</title>
30     <variablelist>
31       <varlistentry>
32         <term>toolbox_name</term>
33         <listitem>
34           <para>Toolbox short name ; that is, the prefix of the .start file of the toolbox (which shall be in the etc subdirectory).</para>
35         </listitem>
36       </varlistentry>
37       <varlistentry>
38         <term>toolbox_path</term>
39         <listitem>
40           <para>Root directory of toolbox sources ; the script will be generated here (default: current directory).</para>
41         </listitem>
42       </varlistentry>
43     </variablelist>
44   </refsection>
45   <refsection>
46     <title>Examples</title>
47     <programlisting role="example"><![CDATA[ 
48 // Recommended usage
49 tbx_build_loader("mytoolbox", get_absolute_file_path('builder.sce'))
50  ]]></programlisting>
51   </refsection>
52   <refsection>
53     <title>History</title>
54     <revhistory>
55       <revision>
56         <revnumber>5.4.0</revnumber>
57         <revremark>This function generates also an unloader.sce script</revremark>
58       </revision>
59     </revhistory>
60   </refsection>
61   
62 </refentry>