Added ilib_include_flag macro to handle platform
[scilab.git] / scilab / modules / dynamic_link / help / en_US / ilib_include_flag.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!-- * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab * 
3         Copyright (C) 2008 - INRIA * * This file must be used under the terms of 
4         the CeCILL. * This source file is licensed as described in the file COPYING, 
5         which * you should have received as part of this distribution. The terms 
6         * are also available at * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt 
7         * -->
8 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
9         xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
10         xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab"
11         xml:lang="en" xml:id="ilib_include_flag">
12         <info>
13                 <pubdate>$LastChangedDate$</pubdate>
14         </info>
15         <refnamediv>
16                 <refname>ilib_include_flag</refname>
17                 <refpurpose> Return a formated includes related string to pass to
18                         system compiler</refpurpose>
19         </refnamediv>
20         <refsynopsisdiv>
21                 <title>Call Sequence</title>
22                 <synopsis>compiler_flag = ilib_include_flag(path_strings)</synopsis>
23         </refsynopsisdiv>
24         <refsection>
25                 <title>Arguments</title>
26                 <variablelist>
27                         <varlistentry>
28                                 <term>path_strings</term>
29                                 <listitem>
30                                         <para>Vector of relative or absolute path as string.</para>
31                                 </listitem>
32                         </varlistentry>
33                         <varlistentry>
34                                 <term>compiler_flag</term>
35                                 <listitem>
36                                         <para>Compiler flag as string</para>
37                                 </listitem>
38                         </varlistentry>
39                 </variablelist>
40         </refsection>
41
42         <refsection>
43                 <title>Description</title>
44                 <para>This function is an utility function provided to handle several
45                         includes path. The result can be passed to tbx_build_gateway.</para>
46         </refsection>
47
48         <refsection>
49                 <title>Exemples</title>
50                 <programlisting role="example"><![CDATA[ 
51     
52     includes_path = ["../src/includes";"/usr/include/somelib/includes";"."];
53     includes_src_c = ilib_include_flag(includes_path);
54     
55     ilib_build('somelib',['myfun',sci_myfun'],['myfile.c'],[],[],includes_src_c);
56     
57 ]]></programlisting>
58         </refsection>
59         <refsection>
60                 <title>See Also</title>
61                 <simplelist type="inline">
62                         <member>
63                                 <link linkend="tbx_build_gateway">tbx_build_gateway</link>
64                                 <link linkend="ilib_build">ilib_build</link>
65                         </member>
66                 </simplelist>
67         </refsection>
68 </refentry>