- rename end-user functions => prefix them with "atoms"
[scilab.git] / scilab / modules / atoms / help / en_US / atomsSearch.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
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" version="5.0-subset Scilab" xml:lang="en" xml:id="atomsSearch">
14   <info>
15     <pubdate>$LastChangedDate: 2008-06-10 11:00:00 +0200 (Tue, 10 Jun 2008) $</pubdate>
16   </info>
17   <refnamediv>
18     <refname>atomsSearch</refname>
19     <refpurpose>Search a toolbox</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>atomsSearch(keyWord, typeSearch)</synopsis>
24   </refsynopsisdiv>
25   <refsection>
26     <title>Parameters</title>
27     <variablelist>
28       <varlistentry>
29         <term>keyWord</term>
30         <listitem>
31           <para>A character string.</para>
32         </listitem>
33       </varlistentry>
34       <varlistentry>
35         <term>typeSearch</term>
36         <listitem>
37           <para>A character string.</para>
38         </listitem>
39       </varlistentry>
40     </variablelist>
41   </refsection>
42   <refsection>
43     <title>Description</title>
44     <para>This function search toolboxes which have keyword in their description.</para>
45   </refsection>
46   <refsection>
47     <title>Examples</title>
48     <programlisting role="example"><![CDATA[
49
50 atomsSearch("toto", "author")
51 atomsSearch("inria", "entity")
52 atomsSearch("modelisation 3D", "function")
53 atomsSearch("toto inria modelisation")
54
55   ]]></programlisting>
56   </refsection>
57   <refsection>
58     <title>See Also</title>
59     <simplelist type="inline">
60       <member>
61         <link linkend="atomsInstall">atomsInstall</link>
62       </member>
63       <member>
64         <link linkend="atomsInfo">atomsInfo</link>
65       </member>
66     </simplelist>
67   </refsection>
68 </refentry>