Massive indent of all codes:
[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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="atoms">
14         <refnamediv>
15             <refname>Functions Summary</refname>
16         </refnamediv>
17         <!-- ===================================================================== -->
18         <!-- Install/Remove/Update modules -->
19         <!-- ===================================================================== -->
20         <refsection>
21             <title>Install/Remove/Update modules ...</title>
22             <para>
23                 <informaltable border="1">
24                     <tr>
25                         <td>
26                             <link linkend="atomsInstall">atomsInstall</link>
27                         </td>
28                         <td>
29                             Install one or several modules
30                         </td>
31                     </tr>
32                     <tr>
33                         <td>
34                             <link linkend="atomsUpdate">atomsUpdate</link>
35                         </td>
36                         <td>
37                             Update one or several modules
38                         </td>
39                     </tr>
40                     <tr>
41                         <td>
42                             <link linkend="atomsRemove">atomsRemove</link>
43                         </td>
44                         <td>
45                             Remove one or several modules
46                         </td>
47                     </tr>
48                     <tr>
49                         <td>
50                             <link linkend="atomsGetInstalled">atomsGetInstalled</link>
51                         </td>
52                         <td>
53                             Get the list of installed external modules
54                         </td>
55                     </tr>
56                     <tr>
57                         <td>
58                             <link linkend="atomsIsInstalled">atomsIsInstalled</link>
59                         </td>
60                         <td>
61                             Determine whether the module is installed or not
62                         </td>
63                     </tr>
64                     <tr>
65                         <td>
66                             <link linkend="atomsIsInstalled">atomsTest</link>
67                         </td>
68                         <td>
69                             Execute the tests of an installed module
70                         </td>
71                     </tr>
72                     <tr>
73                         <td>
74                             <link linkend="atomsIsInstalled">atomsCheckModule</link>
75                         </td>
76                         <td>
77                             Install, load, test and remove one or several modules
78                         </td>
79                     </tr>
80                 </informaltable>
81             </para>
82         </refsection>
83         <!-- ===================================================================== -->
84         <!-- Load modules -->
85         <!-- ===================================================================== -->
86         <refsection>
87             <title>Load modules ...</title>
88             <para>
89                 <informaltable border="1">
90                     <tr>
91                         <td>
92                             <link linkend="atomsLoad">atomsLoad</link>
93                         </td>
94                         <td>
95                             Load one or several modules
96                         </td>
97                     </tr>
98                     <tr>
99                         <td>
100                             <link linkend="atomsLoad">atomsAutoLoad</link>
101                         </td>
102                         <td>
103                             Load the modules marked as "autoload"
104                         </td>
105                     </tr>
106                     <tr>
107                         <td>
108                             <link linkend="atomsGetLoaded">atomsGetLoaded</link>
109                         </td>
110                         <td>
111                             Get the list of loaded modules
112                         </td>
113                     </tr>
114                     <tr>
115                         <td>
116                             <link linkend="atomsIsLoaded">atomsIsLoaded</link>
117                         </td>
118                         <td>
119                             Determines whether the module is loaded or not
120                         </td>
121                     </tr>
122                     <tr>
123                         <td>
124                             <link linkend="atomsAutoloadList">atomsAutoloadList</link>
125                         </td>
126                         <td>
127                             Get the list of modules registered to autoload at Scilab start.
128                         </td>
129                     </tr>
130                     <tr>
131                         <td>
132                             <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
133                         </td>
134                         <td>
135                             Add one or several modules to autoload system.
136                         </td>
137                     </tr>
138                     <tr>
139                         <td>
140                             <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
141                         </td>
142                         <td>
143                             Remove one or several modules from autoload system.
144                         </td>
145                     </tr>
146                     <tr>
147                         <td>
148                             <link linkend="atomsAutoloadDel">atomsQuit</link>
149                         </td>
150                         <td>
151                             Launch the .quit file of all loaded modules
152                         </td>
153                     </tr>
154                 </informaltable>
155             </para>
156         </refsection>
157         <!-- ===================================================================== -->
158         <!-- Information -->
159         <!-- ===================================================================== -->
160         <refsection>
161             <title>Get information ...</title>
162             <para>
163                 <informaltable border="1">
164                     <tr>
165                         <td>
166                             <link linkend="atomsList">atomsList</link>
167                         </td>
168                         <td>
169                             List available modules
170                         </td>
171                     </tr>
172                     <tr>
173                         <td>
174                             <link linkend="atomsList">atomsCategoryList</link>
175                         </td>
176                         <td>
177                             List available categories
178                         </td>
179                     </tr>
180                     <tr>
181                         <td>
182                             <link linkend="atomsSearch">atomsSearch</link>
183                         </td>
184                         <td>
185                             Searches for modules
186                         </td>
187                     </tr>
188                     <tr>
189                         <td>
190                             <link linkend="atomsShow">atomsShow</link>
191                         </td>
192                         <td>
193                             Show the characteristics of a module
194                         </td>
195                     </tr>
196                     <tr>
197                         <td>
198                             <link linkend="atomsDepTreeShow">atomsDepTreeShow</link>
199                         </td>
200                         <td>
201                             Show the dependency tree of a module
202                         </td>
203                     </tr>
204                     <tr>
205                         <td>
206                             <link linkend="atomsDepTreeShow">atomsGetInstalledPath</link>
207                         </td>
208                         <td>
209                             Get the installation path of an module
210                         </td>
211                     </tr>
212                     <tr>
213                         <td>
214                             <link linkend="atomsDepTreeShow">atomsGetLoadedPath</link>
215                         </td>
216                         <td>
217                             Get the installation path of a loaded module
218                         </td>
219                     </tr>
220                     <tr>
221                         <td>
222                             <link linkend="atomsDepTreeShow">atomsVersion</link>
223                         </td>
224                         <td>
225                             Get the ATOMS's module version
226                         </td>
227                     </tr>
228                 </informaltable>
229             </para>
230         </refsection>
231         <!-- ===================================================================== -->
232         <!-- Repository management -->
233         <!-- ===================================================================== -->
234         <refsection>
235             <title>Manage repositories ...</title>
236             <para>
237                 <informaltable border="1">
238                     <tr>
239                         <td>
240                             <link linkend="atomsRepositoryList">atomsRepositoryList</link>
241                         </td>
242                         <td>
243                             Get the list of managed repositories
244                         </td>
245                     </tr>
246                     <tr>
247                         <td>
248                             <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
249                         </td>
250                         <td>
251                             Add one or several URLs to the list of managed repositories
252                         </td>
253                     </tr>
254                     <tr>
255                         <td>
256                             <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
257                         </td>
258                         <td>
259                             Remove one or several URLs from the list of managed repositories
260                         </td>
261                     </tr>
262                 </informaltable>
263             </para>
264         </refsection>
265         <!-- ===================================================================== -->
266         <!-- Atoms  -->
267         <!-- ===================================================================== -->
268         <refsection>
269             <title>Manage ATOMS system ...</title>
270             <para>
271                 <informaltable border="1">
272                     <tr>
273                         <td>
274                             <link linkend="atomsSystemUpdate">atomsSystemUpdate</link>
275                         </td>
276                         <td>
277                             Update the list of available modules
278                         </td>
279                     </tr>
280                     <tr>
281                         <td>
282                             <link linkend="atomsSetConfig">atomsSetConfig</link>
283                         </td>
284                         <td>
285                             Manage ATOMS parameters
286                         </td>
287                     </tr>
288                     <tr>
289                         <td>
290                             <link linkend="atomsSetConfig">atomsGetConfig</link>
291                         </td>
292                         <td>
293                             Get the list of ATOMS parameters
294                         </td>
295                     </tr>
296                     <tr>
297                         <td>
298                             <link linkend="atomsSetConfig">atomsRestoreConfig</link>
299                         </td>
300                         <td>
301                             Restore the configuration from the backup file
302                         </td>
303                     </tr>
304                     <tr>
305                         <td>
306                             <link linkend="atomsSetConfig">atomsSaveConfig</link>
307                         </td>
308                         <td>
309                             Make a backup of the configuration file
310                         </td>
311                     </tr>
312                     <tr>
313                         <td>
314                             <link linkend="atomsSetConfig">atomsSystemInit</link>
315                         </td>
316                         <td>
317                             Set the rightful write access for the ATOMS system
318                         </td>
319                     </tr>
320                 </informaltable>
321             </para>
322         </refsection>
323         <!-- ===================================================================== -->
324         <!-- Authors -->
325         <!-- ===================================================================== -->
326     </refentry>