d8c02185534aff5b39291523217c62d0630bf863
[scilab.git] / scilab / modules / atoms / help / en_US / atomsShow.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) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="atomsShow">
14     <refnamediv>
15         <refname>atomsShow</refname>
16         <refpurpose>Show the caracteristics of a module</refpurpose>
17     </refnamediv>
18     <!-- ===================================================================== -->
19     <!-- Calling Sequence -->
20     <!-- ===================================================================== -->
21     <refsynopsisdiv>
22         <title>Calling Sequence</title>
23         <synopsis>
24             atomsShow(module)
25         </synopsis>
26     </refsynopsisdiv>
27     <!-- ===================================================================== -->
28     <!-- Parameters -->
29     <!-- ===================================================================== -->
30     <refsection>
31         <title>Arguments</title>
32         <variablelist>
33             <varlistentry>
34                 <term>module</term>
35                 <listitem>
36                     <para>
37                         1x1 or 1x2 Matrix of strings:
38                     </para>
39                     <informaltable border="1">
40                         <!-- Technical name -->
41                         <tr>
42                             <td>
43                                 <emphasis>1st Col.</emphasis>
44                             </td>
45                             <td>
46                                 <emphasis role="strong">Technical name</emphasis>
47                             </td>
48                             <td>
49                                 Mandatory
50                             </td>
51                             <td>
52                             </td>
53                         </tr>
54                         <!-- Version -->
55                         <tr>
56                             <td>
57                                 <emphasis>2nd Col.</emphasis>
58                             </td>
59                             <td>
60                                 <emphasis role="strong">Version</emphasis>
61                             </td>
62                             <td>
63                                 Optional
64                             </td>
65                             <td>
66                                 If this field is empty or is not present,
67                                 the most recent version is used
68                             </td>
69                         </tr>
70                     </informaltable>
71                 </listitem>
72             </varlistentry>
73         </variablelist>
74     </refsection>
75     <!-- ===================================================================== -->
76     <!-- Description -->
77     <!-- ===================================================================== -->
78     <refsection>
79         <title>Description</title>
80         <para>
81             Show the caracteristics of a module
82         </para>
83     </refsection>
84     <!-- ===================================================================== -->
85     <!-- Examples -->
86     <!-- ===================================================================== -->
87     <refsection>
88         <title>Examples</title>
89         <programlisting role="example"><![CDATA[ 
90 atomsRepositoryAdd("http://scene1.test.atoms.scilab.org");
91 atomsShow("toolbox_5");
92 ]]></programlisting>
93     </refsection>
94     <!-- ===================================================================== -->
95     <!-- See also -->
96     <!-- ===================================================================== -->
97     <refsection role="see also">
98         <title>See Also</title>
99         <simplelist type="inline">
100             <member>
101                 <link linkend="atomsList">atomsList</link>
102             </member>
103             <member>
104                 <link linkend="atomsDepTreeShow">atomsDepTreeShow</link>
105             </member>
106         </simplelist>
107     </refsection>
108     <!-- ===================================================================== -->
109     <!-- Authors -->
110     <!-- ===================================================================== -->
111 </refentry>