add CDATA + role in the helptools module
[scilab.git] / scilab / modules / helptools / help / en_US / apropos.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) 2008 - 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="apropos">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>apropos</refname>
19     <refpurpose> searches keywords in Scilab help</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>apropos(key)
24 apropos(regexp)</synopsis>
25   </refsynopsisdiv>
26   <refsection>
27     <title>Parameters</title>
28     <variablelist>
29       <varlistentry>
30         <term>key</term>
31         <listitem>
32           <para>character string. give the sequence of characters to be found</para>
33         </listitem>
34       </varlistentry>
35       <varlistentry>
36         <term>regexp</term>
37         <listitem>
38           <para> character string. give the regular expression to be found
39             (only with "Scilab Browser")</para>
40         </listitem>
41       </varlistentry>
42     </variablelist>
43   </refsection>
44   <refsection>
45     <title>Description</title>
46     <para><literal>apropos(key)</literal> looks for Scilab help files containing
47       keywords <literal>key</literal>in their short description section.</para>
48     <para><literal>apropos(regexp)</literal> looks for Scilab
49       help files containing regular expression  <literal>regexp</literal>in their short
50       description section.</para>
51   </refsection>
52   <refsection>
53     <title>Examples</title>
54     <programlisting role="example"><![CDATA[ 
55 apropos('ode')
56 apropos ode 
57 apropos "list of"
58 apropos "sin.*hyperbolic"
59 apropos "^ab"  //search help beginning the two characters "ab"
60 apropos "quadratic.*solver"
61  ]]></programlisting>
62   </refsection>
63   <refsection>
64     <title>See Also</title>
65     <simplelist type="inline">
66       <member>
67         <link linkend="help">help</link>
68       </member>
69       <member>
70         <link linkend="man">man</link>
71       </member>
72     </simplelist>
73   </refsection>
74 </refentry>