bug fix 8648 - delete the tarball when uninstalling
[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][,delete])
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                         <varlistentry>
122         <term>delete</term>
123         <listitem>
124           <para>
125                                                 <literal>delete</literal> is a boolean. If set to %T (True), the .zip or .tar.gz file containing 
126 the sources will also be deleted. This includes the dependencies' archives files that were installed with the module, if any.
127                                         </para>
128         </listitem>
129                         </varlistentry>
130                         
131       <varlistentry>
132         <term>result</term>
133         <listitem>
134           <para>5xn character string matrix:</para>
135                                         
136                                         <informaltable border="1">
137                                                 
138                                                 <!-- Technical name -->
139                                                 
140                                                 <tr>
141                                                         <td>
142                                                                 <emphasis>1st Col.</emphasis>
143                                                         </td>
144                                                         <td>
145                                                                 <emphasis role="strong">Technical name</emphasis>
146                                                         </td>
147                                                         <td>
148                                                         </td>
149                                                 </tr>
150                                                 
151                                                 <!-- Version -->
152                                                 
153                                                 <tr>
154                                                         <td>
155                                                                 <emphasis>2nd Col.</emphasis>
156                                                         </td>
157                                                         <td>
158                                                                 <emphasis role="strong">Version</emphasis>
159                                                         </td>
160                                                         <td>
161                                                         </td>
162                                                 </tr>
163                                                 
164                                                 <!-- Section -->
165                                                 
166                                                 <tr>
167                                                         <td>
168                                                                 <emphasis>3rd Col.</emphasis>
169                                                         </td>
170                                                         <td>
171                                                                 <emphasis role="strong">Installation section</emphasis>
172                                                         </td>
173                                                         <td>
174                                                                 this parameter determines whether the module has been installed
175                                                                 for all users or only for the   current user.
176                                                         </td>
177                                                 </tr>
178                                                 
179                                                 <!-- Installation path -->
180                                                 
181                                                 <tr>
182                                                         <td>
183                                                                 <emphasis>4th Col.</emphasis>
184                                                         </td>
185                                                         <td>
186                                                                 <emphasis role="strong">Installation path</emphasis>
187                                                         </td>
188                                                         <td>
189                                                         </td>
190                                                 </tr>
191                                                 
192                                                 <!-- Status -->
193                                                 
194                                                 <tr>
195                                                         <td>
196                                                                 <emphasis>5th Col.</emphasis>
197                                                         </td>
198                                                         <td>
199                                                                 <emphasis role="strong">Status</emphasis>
200                                                         </td>
201                                                         <td>
202                                                                 "I" stands for "Intentionnaly", "A" stands for "Automatically"
203                                                         </td>
204                                                 </tr>
205                                                 
206                                         </informaltable>
207                                         
208         </listitem>
209       </varlistentry>
210     </variablelist>
211   </refsection>
212         
213   <!-- ===================================================================== -->
214   <!-- Description -->
215   <!-- ===================================================================== -->
216   <refsection>
217     <title>Description</title>
218     <para><literal>atomsRemove</literal> remove one or more modules.
219         </para>
220         
221   </refsection>
222   <!-- ===================================================================== -->
223   <!-- Examples -->
224   <!-- ===================================================================== -->
225   <refsection>
226     <title>Examples</title>
227     <programlisting role="example"><![CDATA[
228
229 // Display some additionnal informations
230 atomsSetConfig("Verbose","True");
231
232 // Load the test repository
233 atomsRepositoryAdd("http://scene2.test.atoms.scilab.org");
234
235 // install toolbox_4 : both 1.0 and 1.1 versions
236
237
238 // Remove all versions of a module
239 atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
240 atomsRemove(["toolbox_4"]);
241
242
243 // Remove a specific version
244 atomsInstall(["toolbox_4" "1.0";"toolbox_4" "1.1"],"user");
245 atomsRemove(["toolbox_4" "1.0"]);
246 atomsRemove(["toolbox_4" "1.1"]);
247
248
249 // Remove several modules
250 atomsInstall(["toolbox_4";"toolbox_3"],"user");
251 atomsRemove(["toolbox_4";"toolbox_3"]);
252
253
254 // Remove a module from a specific section
255 // ! This example needs write access on SCI directory
256
257 atomsInstall("toolbox_4","user");
258 atomsInstall("toolbox_4","allusers");
259
260 disp(atomsGetInstalled());
261 atomsRemove("toolbox_4","user");
262 disp(atomsGetInstalled());
263 atomsRemove("toolbox_4","allusers");
264 disp(atomsGetInstalled());
265
266 // Remove a module, including its archive file
267
268 atomsInstall("toolbox_4");
269 atomsRemove("toolbox_4",%T);
270
271 // Remove a module from a specific section, including its archive file
272
273 atomsInstall("toolbox_4");
274 atomsRemove("toolbox_4","user",%T);
275
276 // Unload the test repository
277 atomsRepositoryDel("http://scene2.test.atoms.scilab.org");
278
279 ]]></programlisting>
280   </refsection>
281   <!-- ===================================================================== -->
282   <!-- See also -->
283   <!-- ===================================================================== -->
284   <refsection role="see also">
285 <title>See Also</title>
286     <simplelist type="inline">
287       <member>
288         <link linkend="atomsInstall">atomsInstall</link>
289       </member>
290       <member>
291         <link linkend="atomsIsInstalled">atomsIsInstalled</link>
292       </member>
293       <member>
294         <link linkend="atomsGetInstalled">atomsGetInstalled</link>
295       </member>
296     </simplelist>
297   </refsection>
298   <!-- ===================================================================== -->
299   <!-- Authors -->
300   <!-- ===================================================================== -->
301   <refsection>
302     <title>Authors</title>
303     <simplelist type="vert">
304       <member>Simon GARESTE - DIGITEO</member>
305     </simplelist>
306   </refsection>
307 </refentry>