c6c497eadf5c56da74bc824fe96c36adb933ce42
[scilab.git] / scilab / modules / atoms / help / en_US / checkToolbox.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) 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 version="5.0-subset Scilab" xml:id="checkToolbox" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>$LastChangedDate: 2008-06-10 11:00:00 +0200 (Tue, 10 Jun 2008)
22     $</pubdate>
23   </info>
24
25   <refnamediv>
26     <refname>checkToolbox</refname>
27
28     <refpurpose>Check a Scilab toolbox</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>checkToolbox(name)</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>name</term>
43
44         <listitem>
45           <para>A character string.</para>
46         </listitem>
47       </varlistentry>
48     </variablelist>
49   </refsection>
50
51   <refsection>
52     <title>Description</title>
53
54     <para>This function checks if all the mandatory information are present.</para>
55   </refsection>
56
57   <refsection>
58     <title>Examples</title>
59
60     <programlisting role="example">
61
62 checkToolbox("maToolbox")
63
64   </programlisting>
65   </refsection>
66
67   <refsection>
68     <title>See Also</title>
69
70     <simplelist type="inline">
71       <member><link linkend="installToolbox">installToolbox</link></member>
72     </simplelist>
73   </refsection>
74 </refentry>