8a36ca8e68374094e9974477e8df968c34c3e244
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRemove.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="atomsRemove">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>atomsRemove</refname>
19     <refpurpose>Remove one or several modules</refpurpose>
20   </refnamediv>
21   <!-- ===================================================================== -->
22   <!-- Calling Sequence -->
23   <!-- ===================================================================== -->
24   <refsynopsisdiv>
25     <title>Calling Sequence</title>
26     <synopsis>
27           result = atomsRemove(modules[,section])
28         </synopsis>
29   </refsynopsisdiv>
30   <!-- ===================================================================== -->
31   <!-- Parameters -->
32   <!-- ===================================================================== -->
33   <refsection>
34     <title>Arguments</title>
35     <variablelist>
36       
37                         <varlistentry>
38         <term>modules</term>
39         <listitem>
40           <para>
41                                                 mx1 or mx2 character string matrix:
42                                         </para>
43                                         
44                                         <informaltable border="1">
45                                                 
46                                                 <!-- Technical name -->
47                                                 
48                                                 <tr>
49                                                         <td>
50                                                                 <emphasis>1st Col.</emphasis>
51                                                         </td>
52                                                         <td>
53                                                                 <emphasis role="strong">Technical name</emphasis>
54                                                         </td>
55                                                         <td>
56                                                                 Mandatory
57                                                         </td>
58                                                         <td>
59                                                         </td>
60                                                 </tr>
61                                                 
62                                                 <!-- Version -->
63                                                 
64                                                 <tr>
65                                                         <td>
66                                                                 <emphasis>2nd Col.</emphasis>
67                                                         </td>
68                                                         <td>
69                                                                 <emphasis role="strong">Version</emphasis>
70                                                         </td>
71                                                         <td>
72                                                                 Optionnal
73                                                         </td>
74                                                         <td>
75                                                                 If this field is empty or is not present, all versions
76                                                                 of the module are removed.
77                                                         </td>
78                                                 </tr>
79                                                 
80                                         </informaltable>
81                                         
82         </listitem>
83       </varlistentry>
84       
85                         <varlistentry>
86         <term>section</term>
87         <listitem>
88           <para>
89                                                 This argument controls the list of sections where search
90                                                 modules to remove.
91                                         </para>
92           <para>
93                                                 <literal>section</literal> is a single-string and its value should be :
94                                         </para>
95           <itemizedlist>
96             <listitem>
97               <para>
98                                                                 <literal>"all"</literal>: Modules to remove are searched in both
99                                                                 "user" and "allusers" sections.
100                                                         </para>
101             </listitem>
102             <listitem>
103               <para>
104                                                                 <literal>"allusers"</literal>: Modules to remove are only searched in
105                                                                 the "allusers" section.
106                                                         </para>
107             </listitem>
108             <listitem>
109               <para>
110                                                                 <literal>"user"</literal>: Modules to remove are only searched in
111                                                                 the "user" section.
112                                                         </para>
113             </listitem>
114           </itemizedlist>
115                                         <para>
116                                                 If SCI is write accessible, "all" is the default value.
117                                                 Otherwise, the default value is "user".
118                                         </para>
119         </listitem>
120                         </varlistentry>
121                         
122       <varlistentry>
123         <term>result</term>
124         <listitem>
125           <para>5xn character string matrix:</para>
126                                         
127                                         <informaltable border="1">
128                                                 
129                                                 <!-- Technical name -->
130                                                 
131                                                 <tr>
132                                                         <td>
133                                                                 <emphasis>1st Col.</emphasis>
134                                                         </td>
135                                                         <td>
136                                                                 <emphasis role="strong">Technical name</emphasis>
137                                                         </td>
138                                                         <td>
139                                                         </td>
140                                                 </tr>
141                                                 
142                                                 <!-- Version -->
143                                                 
144                                                 <tr>
145                                                         <td>
146                                                                 <emphasis>2nd Col.</emphasis>
147                                                         </td>
148                                                         <td>
149                                                                 <emphasis role="strong">Version</emphasis>
150                                                         </td>
151                                                         <td>
152                                                         </td>
153                                                 </tr>
154                                                 
155                                                 <!-- Section -->
156                                                 
157                                                 <tr>
158                                                         <td>
159                                                                 <emphasis>3rd Col.</emphasis>
160                                                         </td>
161                                                         <td>
162                                                                 <emphasis role="strong">Installation section</emphasis>
163                                                         </td>
164                                                         <td>
165                                                                 this parameter determines whether the module has been installed
166                                                                 for all users or only for the   current user.
167                                                         </td>
168                                                 </tr>
169                                                 
170                                                 <!-- Installation path -->
171                                                 
172                                                 <tr>
173                                                         <td>
174                                                                 <emphasis>4th Col.</emphasis>
175                                                         </td>
176                                                         <td>
177                                                                 <emphasis role="strong">Installation path</emphasis>
178                                                         </td>
179                                                         <td>
180                                                         </td>
181                                                 </tr>
182                                                 
183                                                 <!-- Status -->
184                                                 
185                                                 <tr>
186                                                         <td>
187                                                                 <emphasis>5th Col.</emphasis>
188                                                         </td>
189                                                         <td>
190                                                                 <emphasis role="strong">Status</emphasis>
191                                                         </td>
192                                                         <td>
193                                                                 "I" stands for "Intentionnaly", "A" stands for "Automatically"
194                                                         </td>
195                                                 </tr>
196                                                 
197                                         </informaltable>
198                                         
199         </listitem>
200       </varlistentry>
201     </variablelist>
202   </refsection>
203         
204   <!-- ===================================================================== -->
205   <!-- Description -->
206   <!-- ===================================================================== -->
207   <refsection>
208     <title>Description</title>
209     <para><literal>atomsRemove</literal> remove one or more modules.
210         </para>
211         
212   </refsection>
213   <!-- ===================================================================== -->
214   <!-- Examples -->
215   <!-- ===================================================================== -->
216   <refsection>
217     <title>Examples</title>
218     <programlisting role="example"><![CDATA[
219
220 // Display some additionnal informations
221 atomsSetConfig("Verbose","True");
222
223 // Load the test repository
224 atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
225
226 // install toolbox_4 : both 1.0 and 1.1 versions
227
228
229 // Remove all versions of a module
230 atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
231 atomsRemove(["toolbox_4"]);
232
233
234 // Remove a specific version
235 atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
236 atomsRemove(["toolbox_4" "1.0"]);
237 atomsRemove(["toolbox_4" "1.1"]);
238
239
240 // Remove several modules
241 atomsInstall(["toolbox_4";"toolbox_3"],"user");
242 atomsRemove(["toolbox_4";"toolbox_3"]);
243
244
245 // Remove a module from a specific section
246 // ! This example needs write access on SCI directory
247
248 atomsInstall("toolbox_4","user");
249 atomsInstall("toolbox_4","allusers");
250
251 disp(atomsGetInstalled());
252 atomsRemove("toolbox_4","user");
253 disp(atomsGetInstalled());
254 atomsRemove("toolbox_4","allusers");
255 disp(atomsGetInstalled());
256
257 // Unload the test repository
258 atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
259
260 ]]></programlisting>
261   </refsection>
262   <!-- ===================================================================== -->
263   <!-- See also -->
264   <!-- ===================================================================== -->
265   <refsection role="see also">
266 <title>See Also</title>
267     <simplelist type="inline">
268       <member>
269         <link linkend="atomsInstall">atomsRemove</link>
270       </member>
271       <member>
272         <link linkend="atomsIsInstalled">atomsIsInstalled</link>
273       </member>
274       <member>
275         <link linkend="atomsGetInstalled">atomsGetInstalled</link>
276       </member>
277     </simplelist>
278   </refsection>
279   <!-- ===================================================================== -->
280   <!-- Authors -->
281   <!-- ===================================================================== -->
282   <refsection>
283     <title>Authors</title>
284     <simplelist type="vert">
285       <member>Pierre MARECHAL - DIGITEO</member>
286     </simplelist>
287   </refsection>
288 </refentry>