2765b547fd7adedad5edca087fdf8115b7e764d1
[scilab.git] / scilab / modules / atoms / help / en_US / _atomsSummary.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" version="5.0-subset Scilab" xml:lang="en" xml:id="atoms">
14
15   <refnamediv>
16     <refname>Functions Summary</refname>
17   </refnamediv>
18
19   <!-- ===================================================================== -->
20         <!-- Install/Remove/Update modules -->
21   <!-- ===================================================================== -->
22         
23   <refsection>
24     <title>Install/Remove/Update modules ...</title>
25     <para>
26                         <informaltable border="1">
27                                 <tr>
28                                         <td>
29                                                 <link linkend="atomsInstall">atomsInstall</link>
30                                         </td>
31                                         <td>
32                                                 Install one or several modules
33                                         </td>
34                                 </tr>
35                                 
36                                 <tr>
37                                         <td>
38                                                 <link linkend="atomsUpdate">atomsUpdate</link>
39                                         </td>
40                                         <td>
41                                                 Update one or several modules
42                                         </td>
43                                 </tr>
44                                 
45                                 <tr>
46                                         <td>
47                                                 <link linkend="atomsRemove">atomsRemove</link>
48                                         </td>
49                                         <td>
50                                                 Remove one or several modules
51                                         </td>
52                                 </tr>
53                                 
54                                 <tr>
55                                         <td>
56                                                 <link linkend="atomsGetInstalled">atomsGetInstalled</link>
57                                         </td>
58                                         <td>
59                                                 Get the list of installed external modules
60                                         </td>
61                                 </tr>
62                                 
63                                 <tr>
64                                         <td>
65                                                 <link linkend="atomsIsInstalled">atomsIsInstalled</link>
66                                         </td>
67                                         <td>
68                                                 Determines whether the module is installed or not
69                                         </td>
70                                 </tr>
71                         </informaltable>
72                 </para>
73   </refsection>
74         
75   <!-- ===================================================================== -->
76         <!-- Load modules -->
77   <!-- ===================================================================== -->
78         
79   <refsection>
80     <title>Load modules ...</title>
81     <para>
82                         <informaltable border="1">
83                                 <tr>
84                                         <td>
85                                                 <link linkend="atomsLoad">atomsLoad</link>
86                                         </td>
87                                         <td>
88                                                 Load one or several modules
89                                         </td>
90                                 </tr>
91                                 <tr>
92                                         <td>
93                                                 <link linkend="atomsGetLoaded">atomsGetLoaded</link>
94                                         </td>
95                                         <td>
96                                                 Get the list of loaded modules
97                                         </td>
98                                 </tr>
99                                 <tr>
100                                         <td>
101                                                 <link linkend="atomsIsLoaded">atomsIsLoaded</link>
102                                         </td>
103                                         <td>
104                                                 Determines whether the module is loaded or not
105                                         </td>
106                                 </tr>
107                                 <tr>
108                                         <td>
109                                                 <link linkend="atomsAutoloadList">atomsAutoloadList</link>
110                                         </td>
111                                         <td>
112                                                 Get the list of modules registered to autoload at Scilab start.
113                                         </td>
114                                 </tr>
115                                 <tr>
116                                         <td>
117                                                 <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
118                                         </td>
119                                         <td>
120                                                 Add one or several modules to autoload system.
121                                         </td>
122                                 </tr>
123                                 <tr>
124                                         <td>
125                                                 <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
126                                         </td>
127                                         <td>
128                                                 Remove one or several modules from autoload system.
129                                         </td>
130                                 </tr>
131                         </informaltable>
132                 </para>
133   </refsection>
134         
135   <!-- ===================================================================== -->
136         <!-- Information -->
137   <!-- ===================================================================== -->
138         
139   <refsection>
140     <title>Get information ...</title>
141     <para>
142                         <informaltable border="1">
143                                 <tr>
144                                         <td>
145                                                 <link linkend="atomsList">atomsList</link>
146                                         </td>
147                                         <td>
148                                                 List available modules
149                                         </td>
150                                 </tr>
151                                 <tr>
152                                         <td>
153                                                 <link linkend="atomsSearch">atomsSearch</link>
154                                         </td>
155                                         <td>
156                                                 Searches for modules
157                                         </td>
158                                 </tr>
159                                 <tr>
160                                         <td>
161                                                 <link linkend="atomsShow">atomsShow</link>
162                                         </td>
163                                         <td>
164                                                 Show the caracteristics of a module
165                                         </td>
166                                 </tr>
167                                 <tr>
168                                         <td>
169                                                 <link linkend="atomsDepTreeShow">atomsDepTreeShow</link>
170                                         </td>
171                                         <td>
172                                                 Show the dependency tree of a module
173                                         </td>
174                                 </tr>
175                         </informaltable>
176                 </para>
177   </refsection> 
178         
179   <!-- ===================================================================== -->
180         <!-- Repository management -->
181   <!-- ===================================================================== -->
182         
183   <refsection>
184     <title>Manage repositories ...</title>
185     <para>
186                         <informaltable border="1">
187                                 <tr>
188                                         <td>
189                                                 <link linkend="atomsRepositoryList">atomsRepositoryList</link>
190                                         </td>
191                                         <td>
192                                                 Get the list of managed repositories
193                                         </td>
194                                 </tr>
195                                 <tr>
196                                         <td>
197                                                 <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
198                                         </td>
199                                         <td>
200                                                 Add one or several URLs to the list of managed repositories
201                                         </td>
202                                 </tr>
203                                 <tr>
204                                         <td>
205                                                 <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
206                                         </td>
207                                         <td>
208                                                 Remove one or several URLs from the list of managed repositories
209                                         </td>
210                                 </tr>
211                         </informaltable>
212                 </para>
213   </refsection> 
214         
215         <!-- ===================================================================== -->
216         <!-- Atoms  -->
217   <!-- ===================================================================== -->
218         
219   <refsection>
220     <title>Manage ATOMS system ...</title>
221     <para>
222                         <informaltable border="1">
223                                 <tr>
224                                         <td>
225                                                 <link linkend="atomsSystemUpdate">atomsSystemUpdate</link>
226                                         </td>
227                                         <td>
228                                                 Update the list of available modules
229                                         </td>
230                                 </tr>
231                                 <tr>
232                                         <td>
233                                                 <link linkend="atomsSetConfig">atomsSetConfig</link>
234                                         </td>
235                                         <td>
236                                                 Manage ATOMS parameters
237                                         </td>
238                                 </tr>
239                         </informaltable>
240                 </para>
241   </refsection>
242         
243   <!-- ===================================================================== -->
244   <!-- Authors -->
245   <!-- ===================================================================== -->
246   <refsection>
247     <title>Authors</title>
248     <simplelist type="vert">
249       <member>Pierre MARECHAL - DIGITEO</member>
250     </simplelist>
251   </refsection>
252 </refentry>