scilab/modules/functions/help/en_US/libraries/whereis.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="whereis">
   3     <refnamediv>
   4         <refname>whereis</refname>
   5         <refpurpose>name of library containing a function</refpurpose>
   6     </refnamediv>
   7     <refsynopsisdiv>
   8         <title>Calling Sequence</title>
   9         <synopsis>[librname]=whereis(function-name)</synopsis>
  10     </refsynopsisdiv>
  11     <refsection>
  12         <title>Description</title>
  13         <para>
  14             returns as a character string
  15             the name of the library containing the function <literal>function-name</literal>.
  16             The path of the library is returned by typing <literal>"librname"</literal>.
  17         </para>
  18     </refsection>
  19     <refsection>
  20         <title>Exemples</title>
  21         <programlisting role="example"><![CDATA[
  22 whereis("ls") // Should return fileiolib
  23 whereis("plot") // Should return graphicslib
  24  ]]></programlisting>
  25     </refsection>
  26
  27     <refsection role="see also">
  28         <title>See Also</title>
  29         <simplelist type="inline">
  30             <member>
  31                 <link linkend="lib">lib</link>
  32             </member>
  33         </simplelist>
  34     </refsection>
  35 </refentry>