ATOMS: Online help : add a summary page
[scilab.git] / scilab / modules / atoms / help / en_US / atomsAutoloadDel.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="atomsAutoloadDel">
14   <refnamediv>
15     <refname>atomsAutoloadDel</refname>
16     <refpurpose>Remove one or several modules from the autoload system</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24           nbDel = atomsAutoloadDel(modules[,section])
25         </synopsis>
26   </refsynopsisdiv>
27   <!-- ===================================================================== -->
28   <!-- Parameters -->
29   <!-- ===================================================================== -->
30   <refsection>
31     <title>Parameters</title>
32     <variablelist>
33                         
34                         <!-- 1st input parameter -->
35                         
36                         <varlistentry>
37         <term>modules</term>
38         <listitem>
39           <para>
40                                                 mx1, mx2 or mx3 Matrix of strings:
41                                         </para>
42                                         
43                                         <informaltable border="1">
44                                                 
45                                                 <!-- Technical name -->
46                                                 
47                                                 <tr>
48                                                         <td>
49                                                                 <emphasis>1st Col.</emphasis>
50                                                         </td>
51                                                         <td>
52                                                                 <emphasis role="strong">Technical name</emphasis>
53                                                         </td>
54                                                         <td>
55                                                                 Mandatory
56                                                         </td>
57                                                         <td>
58                                                         </td>
59                                                 </tr>
60                                                 
61                                                 <!-- Version -->
62                                                 
63                                                 <tr>
64                                                         <td>
65                                                                 <emphasis>2nd Col.</emphasis>
66                                                         </td>
67                                                         <td>
68                                                                 <emphasis role="strong">Version</emphasis>
69                                                         </td>
70                                                         <td>
71                                                                 Optionnal
72                                                         </td>
73                                                         <td>
74                                                                 If this field is empty or is not present, all versions
75                                                                 of the module are removed from the autoload system
76                                                         </td>
77                                                 </tr>
78                                                 
79                                                 <!-- Section -->
80                                                 
81                                                 <tr>
82                                                         <td>
83                                                                 <emphasis>3rd Col.</emphasis>
84                                                         </td>
85                                                         <td>
86                                                                 <emphasis role="strong">Installed section</emphasis>
87                                                         </td>
88                                                         <td>
89                                                                 Optionnal
90                                                         </td>
91                                                         <td>
92                                                                 If this field is empty or is not present, modules installed in
93                                                                 both "user" and "allusers" sections are searched.
94                                                         </td>
95                                                 </tr>
96                                                 
97                                         </informaltable>
98                                         
99         </listitem>
100       </varlistentry>
101                         
102                         <!-- 2nd input parameter -->
103                         
104                         <varlistentry>
105         <term>section</term>
106         <listitem>
107           <para>
108                                                 This argument controls the list of sections where search
109                                                 modules(s) to remove from autoload system.
110                                         </para>
111           <para>
112                                                 <literal>section</literal> is a single-string and its value should be :
113                                         </para>
114           <itemizedlist>
115             <listitem>
116               <para>
117                                                                 <literal>"all"</literal>: module(s) to remove from autotoload list
118                                                                 are searched in both "user" and "allusers" sections.
119                                                         </para>
120             </listitem>
121             <listitem>
122               <para>
123                                                                 <literal>"allusers"</literal>: module(s) to remove from autotoload
124                                                                 system are only searched in the "allusers" autoload list.
125                                                         </para>
126             </listitem>
127             <listitem>
128               <para>
129                                                                 <literal>"user"</literal>: module(s) to remove from autotoload
130                                                                 system are only searched in the "user" autoload list.
131                                                         </para>
132             </listitem>
133           </itemizedlist>
134                                         <para>
135                                                 If SCI is write accessible, "all" is the default value.
136                                                 Otherwise, the default value is "user".
137                                         </para>
138         </listitem>
139                         </varlistentry>
140                         
141       <varlistentry>
142         <term>nbDel</term>
143         <listitem>
144           <para>
145                                                 An integer : the number of modules successfully removed from the
146                                                 autoload system.
147                                         </para>
148         </listitem>
149       </varlistentry>
150     </variablelist>
151   </refsection>
152   <!-- ===================================================================== -->
153   <!-- Description -->
154   <!-- ===================================================================== -->
155   <refsection>
156     <title>Description</title>
157     <para>
158                         <literal>atomsAutoloadDel</literal> remove one or several modules from the
159                         autoload system.
160         </para>
161   </refsection>
162   <!-- ===================================================================== -->
163   <!-- Examples -->
164   <!-- ===================================================================== -->
165   <refsection>
166     <title>Examples</title>
167     <programlisting role="example"><![CDATA[
168
169 atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
170
171 atomsInstall("toolbox_5","user");
172 atomsAutoloadList()
173
174 atomsAutoloadDel("toolbox_5");
175 atomsAutoloadList()
176
177
178 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
179 atomsAutoloadList()
180 atomsAutoloadDel(["toolbox_5" "1.0"]);
181 atomsAutoloadList()
182
183 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
184 atomsAutoloadList()
185 atomsAutoloadDel(["toolbox_5" "1.0" "user"]);
186 atomsAutoloadList()
187
188 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
189 atomsAutoloadList()
190 atomsAutoloadDel(["toolbox_5" "1.0" "user"],"user");
191 atomsAutoloadList()
192
193 atomsRemove("toolbox_5","user");
194 atomsRepositoryDel('http://scene1.test.atoms.scilab.org');
195  ]]></programlisting>
196   </refsection>
197   <!-- ===================================================================== -->
198   <!-- See also -->
199   <!-- ===================================================================== -->
200   <refsection>
201     <title>See Also</title>
202     <simplelist type="inline">
203       <member>
204         <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
205       </member>
206       <member>
207         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
208       </member>
209     </simplelist>
210   </refsection>
211   <!-- ===================================================================== -->
212   <!-- Authors -->
213   <!-- ===================================================================== -->
214   <refsection>
215     <title>Authors</title>
216     <simplelist type="vert">
217       <member>Pierre MARECHAL - DIGITEO</member>
218     </simplelist>
219   </refsection>
220 </refentry>