scilab/modules/functions/help/en_US/libraries/libraryinfo.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <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" xml:lang="en" xml:id="libraryinfo">
   3     <refnamediv>
   4         <refname>libraryinfo</refname>
   5         <refpurpose>get macros and path of a scilab library</refpurpose>
   6     </refnamediv>
   7     <refsynopsisdiv>
   8         <title>Syntax</title>
   9         <synopsis>macros = libraryinfo(libraryname)
  10             [macros,path] = libraryinfo(libraryname)
  11         </synopsis>
  12     </refsynopsisdiv>
  13     <refsection>
  14         <title>Arguments</title>
  15         <variablelist>
  16             <varlistentry>
  17                 <term>macros</term>
  18                 <listitem>
  19                     <para>a string matrix (all main functions of the library)</para>
  20                 </listitem>
  21             </varlistentry>
  22         </variablelist>
  23         <variablelist>
  24             <varlistentry>
  25                 <term>path</term>
  26                 <listitem>
  27                     <para>a string (path of library)</para>
  28                 </listitem>
  29             </varlistentry>
  30         </variablelist>
  31         <variablelist>
  32             <varlistentry>
  33                 <term>libraryname</term>
  34                 <listitem>
  35                     <para>a string (library name)</para>
  36                 </listitem>
  37             </varlistentry>
  38         </variablelist>
  39     </refsection>
  40     <refsection>
  41         <title>Description</title>
  42         <para>get functions names  and path of a scilab library.The function names
  43             returned correspond to those which correspond to the associated .sci or .bin
  44             file names. The other ones are subsidiary functions.
  45         </para>
  46     </refsection>
  47     <refsection>
  48         <title>Examples</title>
  49         <programlisting role="example"><![CDATA[
  50 [m,p]=libraryinfo('corelib')
  51  ]]></programlisting>
  52     </refsection>
  53     <refsection role="see also">
  54         <title>See also</title>
  55         <simplelist type="inline">
  56             <member>
  57                 <link linkend="librarieslist">librarieslist</link>
  58             </member>
  59             <member>
  60                 <link linkend="whereis">whereis</link>
  61             </member>
  62         </simplelist>
  63     </refsection>
  64 </refentry>