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