70599e54b35962316f083f5b98f44959efec1b94
[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           <itemizedlist>
43             <listitem>
44               <para>
45                                                                 <literal>"1st column" (mandatory)</literal>: devoted to module's
46                                                                 technical name.
47                                                         </para>
48             </listitem>
49             <listitem>
50               <para>
51                                                                 <literal>"2nd column" (optional)</literal>: devoted to module's
52                                                                 version. If this field is empty or is not present, all versions
53                                                                 of the module are removed from the autoload system.
54                                                         </para>
55             </listitem>
56             <listitem>
57               <para>
58                                                                 <literal>"3rd column" (optional)</literal>: devoted to module's
59                                                                 installed section. If this field is empty or is not present,
60                                                                 Modules installed in both "user" and "allusers" sections are searched.
61                                                         </para>
62             </listitem>
63           </itemizedlist>
64         </listitem>
65       </varlistentry>
66                         
67                         <!-- 2nd input parameter -->
68                         
69                         <varlistentry>
70         <term>section</term>
71         <listitem>
72           <para>
73                                                 This argument controls the list of sections where search
74                                                 modules(s) to remove from autoload system.
75                                         </para>
76           <para>
77                                                 <literal>section</literal> is a single-string and its value should be :
78                                         </para>
79           <itemizedlist>
80             <listitem>
81               <para>
82                                                                 <literal>"all"</literal>: module(s) to remove from autotoload list
83                                                                 are searched in both "user" and "allusers" sections.
84                                                         </para>
85             </listitem>
86             <listitem>
87               <para>
88                                                                 <literal>"allusers"</literal>: module(s) to remove from autotoload
89                                                                 system are only searched in the "allusers" autoload list.
90                                                         </para>
91             </listitem>
92             <listitem>
93               <para>
94                                                                 <literal>"user"</literal>: module(s) to remove from autotoload
95                                                                 system are only searched in the "user" autoload list.
96                                                         </para>
97             </listitem>
98           </itemizedlist>
99                                         <para>
100                                                 If SCI is write accessible, "all" is the default value.
101                                                 Otherwise, the default value is "user".
102                                         </para>
103         </listitem>
104                         </varlistentry>
105                         
106       <varlistentry>
107         <term>nbDel</term>
108         <listitem>
109           <para>
110                                                 An integer : the number of modules successfully removed from the
111                                                 autoload system.
112                                         </para>
113         </listitem>
114       </varlistentry>
115     </variablelist>
116   </refsection>
117   <!-- ===================================================================== -->
118   <!-- Description -->
119   <!-- ===================================================================== -->
120   <refsection>
121     <title>Description</title>
122     <para>
123                         <literal>atomsAutoloadDel</literal> remove one or several modules from the
124                         autoload system.
125         </para>
126   </refsection>
127   <!-- ===================================================================== -->
128   <!-- Examples -->
129   <!-- ===================================================================== -->
130   <refsection>
131     <title>Examples</title>
132     <programlisting role="example"><![CDATA[
133
134 atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
135
136 atomsInstall("toolbox_5","user");
137 atomsAutoloadList()
138
139 atomsAutoloadDel("toolbox_5");
140 atomsAutoloadList()
141
142
143 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
144 atomsAutoloadList()
145 atomsAutoloadDel(["toolbox_5" "1.0"]);
146 atomsAutoloadList()
147
148 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
149 atomsAutoloadList()
150 atomsAutoloadDel(["toolbox_5" "1.0" "user"]);
151 atomsAutoloadList()
152
153 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
154 atomsAutoloadList()
155 atomsAutoloadDel(["toolbox_5" "1.0" "user"],"user");
156 atomsAutoloadList()
157
158 atomsRemove("toolbox_5","user");
159 atomsRepositoryDel('http://scene1.test.atoms.scilab.org');
160  ]]></programlisting>
161   </refsection>
162   <!-- ===================================================================== -->
163   <!-- See also -->
164   <!-- ===================================================================== -->
165   <refsection>
166     <title>See Also</title>
167     <simplelist type="inline">
168       <member>
169         <link linkend="atomsAutoloadAdd">atomsAutoloadAdd</link>
170       </member>
171       <member>
172         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
173       </member>
174     </simplelist>
175   </refsection>
176   <!-- ===================================================================== -->
177   <!-- Authors -->
178   <!-- ===================================================================== -->
179   <refsection>
180     <title>Authors</title>
181     <simplelist type="vert">
182       <member>Pierre MARECHAL - DIGITEO</member>
183     </simplelist>
184   </refsection>
185 </refentry>