844e07d6639b5eadde062338a1f4e3521f82e9f3
[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                         Determines whether the module is installed or not
62                     </td>
63                 </tr>
64             </informaltable>
65         </para>
66     </refsection>
67     <!-- ===================================================================== -->
68     <!-- Load modules -->
69     <!-- ===================================================================== -->
70     <refsection>
71         <title>Load modules ...</title>
72         <para>
73             <informaltable border="1">
74                 <tr>
75                     <td>
76                         <link linkend="atomsLoad">atomsLoad</link>
77                     </td>
78                     <td>
79                         Load one or several modules
80                     </td>
81                 </tr>
82                 <tr>
83                     <td>
84                         <link linkend="atomsGetLoaded">atomsGetLoaded</link>
85                     </td>
86                     <td>
87                         Get the list of loaded modules
88                     </td>
89                 </tr>
90                 <tr>
91                     <td>
92                         <link linkend="atomsIsLoaded">atomsIsLoaded</link>
93                     </td>
94                     <td>
95                         Determines whether the module is loaded or not
96                     </td>
97                 </tr>
98                 <tr>
99                     <td>
100                         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
101                     </td>
102                     <td>
103                         Get the list of modules registered to autoload at Scilab start.
104                     </td>
105                 </tr>
106                 <tr>
107                     <td>
108                         <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
109                     </td>
110                     <td>
111                         Add one or several modules to autoload system.
112                     </td>
113                 </tr>
114                 <tr>
115                     <td>
116                         <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
117                     </td>
118                     <td>
119                         Remove one or several modules from autoload system.
120                     </td>
121                 </tr>
122             </informaltable>
123         </para>
124     </refsection>
125     <!-- ===================================================================== -->
126     <!-- Information -->
127     <!-- ===================================================================== -->
128     <refsection>
129         <title>Get information ...</title>
130         <para>
131             <informaltable border="1">
132                 <tr>
133                     <td>
134                         <link linkend="atomsList">atomsList</link>
135                     </td>
136                     <td>
137                         List available modules
138                     </td>
139                 </tr>
140                 <tr>
141                     <td>
142                         <link linkend="atomsSearch">atomsSearch</link>
143                     </td>
144                     <td>
145                         Searches for modules
146                     </td>
147                 </tr>
148                 <tr>
149                     <td>
150                         <link linkend="atomsShow">atomsShow</link>
151                     </td>
152                     <td>
153                         Show the caracteristics of a module
154                     </td>
155                 </tr>
156                 <tr>
157                     <td>
158                         <link linkend="atomsDepTreeShow">atomsDepTreeShow</link>
159                     </td>
160                     <td>
161                         Show the dependency tree of a module
162                     </td>
163                 </tr>
164             </informaltable>
165         </para>
166     </refsection>
167     <!-- ===================================================================== -->
168     <!-- Repository management -->
169     <!-- ===================================================================== -->
170     <refsection>
171         <title>Manage repositories ...</title>
172         <para>
173             <informaltable border="1">
174                 <tr>
175                     <td>
176                         <link linkend="atomsRepositoryList">atomsRepositoryList</link>
177                     </td>
178                     <td>
179                         Get the list of managed repositories
180                     </td>
181                 </tr>
182                 <tr>
183                     <td>
184                         <link linkend="atomsRepositoryAdd">atomsRepositoryAdd</link>
185                     </td>
186                     <td>
187                         Add one or several URLs to the list of managed repositories
188                     </td>
189                 </tr>
190                 <tr>
191                     <td>
192                         <link linkend="atomsRepositoryDel">atomsRepositoryDel</link>
193                     </td>
194                     <td>
195                         Remove one or several URLs from the list of managed repositories
196                     </td>
197                 </tr>
198             </informaltable>
199         </para>
200     </refsection>
201     <!-- ===================================================================== -->
202     <!-- Atoms  -->
203     <!-- ===================================================================== -->
204     <refsection>
205         <title>Manage ATOMS system ...</title>
206         <para>
207             <informaltable border="1">
208                 <tr>
209                     <td>
210                         <link linkend="atomsSystemUpdate">atomsSystemUpdate</link>
211                     </td>
212                     <td>
213                         Update the list of available modules
214                     </td>
215                 </tr>
216                 <tr>
217                     <td>
218                         <link linkend="atomsSetConfig">atomsSetConfig</link>
219                     </td>
220                     <td>
221                         Manage ATOMS parameters
222                     </td>
223                 </tr>
224             </informaltable>
225         </para>
226     </refsection>
227     <!-- ===================================================================== -->
228     <!-- Authors -->
229     <!-- ===================================================================== -->
230 </refentry>