Disable the warning about examples missing. They are internal functions and should...
[scilab.git] / scilab / modules / dynamic_link / help / en_US / ilib_compile.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" xmlns:scilab="http://www.scilab.org" scilab:needs-examples="no" xml:lang="en" xml:id="ilib_compile">
14     <refnamediv>
15         <refname>ilib_compile</refname>
16         <refpurpose>ilib_build utility: executes the Makefile produced by ilib_gen_Make</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>libn=ilib_compile(lib_name,makename [,files,ldflags,cflags,fflags,cc])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>lib_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>makename</term>
33                 <listitem>
34                     <para>character string. The path of the Makefile file without extension.</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>files</term>
39                 <listitem>
40                     <para>optional vector of character strings. If files is given the make is performed on each 
41                         target contained in files then a whole make is performed 
42                     </para>
43                 </listitem>
44             </varlistentry>
45             <varlistentry>
46                 <term>libn</term>
47                 <listitem>
48                     <para>character string. The path of the actual generated shared library file.</para>
49                 </listitem>
50             </varlistentry>
51             <varlistentry>
52                 <term>ldflags,cflags,fflags,cc</term>
53                 <listitem>
54                     <para>character strings to provide options/flags for the loader, the C compiler, the Fortran compiler. cc provides the name of the compiler.</para>
55                 </listitem>
56             </varlistentry>
57         </variablelist>
58     </refsection>
59     <refsection>
60         <title>Description</title>
61         <para>
62             Utility function used by <literal>ilib_build</literal>
63         </para>
64         <para>
65             <warning>This function should not be used directly.</warning>
66         </para>
67         <para>
68             This executes the Makefile produced by <literal>ilib_gen_Make</literal>, compiles
69             the C and fortran files and generates the shared library.
70         </para>
71         <para>
72             Shared libraries can then be used with the <literal>link</literal> and
73             <literal>addinter</literal> Scilab function for incremental/dynamic link.
74         </para>
75         <para>
76             <emphasis role="bold">Note that a compiler must be available on the system to use this function.</emphasis>
77         </para>
78         <para>
79             On the internal technical level, under GNU/Linux and Mac OS X, the ilib_* function are based on the autotools. First, a configure is executed to detect compilers available. Then, a make is launched with the provided arguments. For more information: <ulink url="http://wiki.scilab.org/Full%20technical%20description%20of%20the%20incremental%20link">Full technical description of the incremental link / dynamic link</ulink>
80         </para>
81         <para>
82             Since version 5.3.2, under GNU/Linux, Scilab detects where the libstdc++ is located (thanks to the command <emphasis role="italic">gcc -print-search-dirs|grep ^install:|awk '{print $2}'</emphasis>). Previously, the dynamic link was using the libstdc++ embedded in Scilab.
83         </para>
84     </refsection>
85     <refsection role="see also">
86         <title>See Also</title>
87         <simplelist type="inline">
88             <member>
89                 <link linkend="addinter">addinter</link>
90             </member>
91             <member>
92                 <link linkend="link">link</link>
93             </member>
94             <member>
95                 <link linkend="ilib_build">ilib_build</link>
96             </member>
97             <member>
98                 <link linkend="ilib_gen_Make">ilib_gen_Make</link>
99             </member>
100             <member>
101                 <link linkend="ilib_gen_gateway">ilib_gen_gateway</link>
102             </member>
103             <member>
104                 <link linkend="ilib_gen_loader">ilib_gen_loader</link>
105             </member>
106             <member>
107                 <link linkend="ilib_for_link">ilib_for_link</link>
108             </member>
109             <member>
110                 <link linkend="api_scilab">api_scilab</link>
111             </member>
112         </simplelist>
113     </refsection>
114 </refentry>