Disable the warning about examples missing. They are internal functions and should...
[scilab.git] / scilab / modules / dynamic_link / help / en_US / ilib_gen_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:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" scilab:needs-examples="no"  xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="ilib_gen_loader">
14     <refnamediv>
15         <refname>ilib_gen_loader</refname>
16         <refpurpose>utility for ilib_build: generates a loader file</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>ilib_gen_loader(name,table,[libs])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>name</term>
27                 <listitem>
28                     <para>a character string, the generic name of the library without path and extension.</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>table</term>
33                 <listitem>
34                     <para>2 column string matrix giving the table of pairs 'scilab-name' 'interface name'</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>libs</term>
39                 <listitem>
40                     <para>a string matrix, externals dynamic libraries filenames to load by loader file (optional).</para>
41                 </listitem>
42             </varlistentry>
43         </variablelist>
44     </refsection>
45     <refsection>
46         <title>Description</title>
47         <para>
48             Utility function used by <literal>ilib_build</literal>
49             This function generates a loader file.
50         </para>
51         <para>
52             <warning>This function should not be used directly.</warning>
53         </para>
54     </refsection>
55     <refsection role="see also">
56         <title>See Also</title>
57         <simplelist type="inline">
58             <member>
59                 <link linkend="addinter">addinter</link>
60             </member>
61             <member>
62                 <link linkend="link">link</link>
63             </member>
64             <member>
65                 <link linkend="ilib_build">ilib_build</link>
66             </member>
67             <member>
68                 <link linkend="ilib_compile">ilib_compile</link>
69             </member>
70             <member>
71                 <link linkend="ilib_gen_Make">ilib_gen_Make</link>
72             </member>
73             <member>
74                 <link linkend="ilib_gen_loader">ilib_gen_loader</link>
75             </member>
76             <member>
77                 <link linkend="ilib_for_link">ilib_for_link</link>
78             </member>
79             <member>
80                 <link linkend="api_scilab">api_scilab</link>
81             </member>
82         </simplelist>
83     </refsection>
84 </refentry>