ATOMS: Online help : add a summary page
[scilab.git] / scilab / modules / atoms / help / en_US / atomsAutoloadAdd.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="atomsAutoloadAdd">
14   <refnamediv>
15     <refname>atomsAutoloadAdd</refname>
16     <refpurpose>Add one or several modules to autoload</refpurpose>
17   </refnamediv>
18   <!-- ===================================================================== -->
19   <!-- Calling Sequence -->
20   <!-- ===================================================================== -->
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>
24           nbAdd = atomsAutoloadAdd(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                                         
40           <para>
41                                                 mx1, mx2 or mx3 Matrix of strings:
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,
76                                                                 the most recent version is used
77                                                         </td>
78                                                 </tr>
79                                                 
80                                                 <!-- Section -->
81                                                 
82                                                 <tr>
83                                                         <td>
84                                                                 <emphasis>3rd Col.</emphasis>
85                                                         </td>
86                                                         <td>
87                                                                 <emphasis role="strong">Installed section</emphasis>
88                                                         </td>
89                                                         <td>
90                                                                 Optionnal
91                                                         </td>
92                                                         <td>
93                                                                 If this field is empty or is not present,
94                                                                 and <literal>module</literal> is installed in both "user" and
95                                                                 "allusers" sections, the section of autoload list is used.
96                                                         </td>
97                                                 </tr>
98                                                 
99                                         </informaltable>
100                                 </listitem>
101       </varlistentry>
102                         
103                         <!-- 2nd input parameter -->
104                         
105                         <varlistentry>
106         <term>section</term>
107         <listitem>
108           <para>
109                                                 This argument controls which autoload list is changed.
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>"allusers"</literal>: modules are added to the
118                                                                 "allusers" autoload list and all users of scilab are affected.
119                                                         </para>
120             </listitem>
121             <listitem>
122               <para><literal>"user"</literal>: modules are added to the
123                                                                 "user" autoload list and only the current user is affected.
124                                                         </para>
125             </listitem>
126           </itemizedlist>
127                                         <para>
128                                                 If SCI/contrib is write accessible, "allusers" is the default value.
129                                                 Otherwise, the default value is "user".
130                                         </para>
131         </listitem>
132                         </varlistentry>
133                         
134                         <!-- output parameter -->
135                         
136       <varlistentry>
137         <term>nbAdd</term>
138         <listitem>
139           <para>
140                                                 An integer : the number of modules successfully added.
141                                         </para>
142         </listitem>
143       </varlistentry>
144                         
145     </variablelist>
146   </refsection>
147   <!-- ===================================================================== -->
148   <!-- Description -->
149   <!-- ===================================================================== -->
150   <refsection>
151     <title>Description</title>
152     <para>
153           
154         </para>
155   </refsection>
156   <!-- ===================================================================== -->
157   <!-- Examples -->
158   <!-- ===================================================================== -->
159   <refsection>
160     <title>Examples</title>
161     <programlisting role="example"><![CDATA[
162
163 atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
164 atomsSetConfig("autoloadAddAfterInstall","False");
165
166 atomsInstall("toolbox_5","user");
167 atomsAutoloadList()
168
169 atomsAutoloadAdd("toolbox_5","user");
170 atomsAutoloadList()
171
172 atomsAutoloadDel(["toolbox_5"]);
173 atomsAutoloadAdd(["toolbox_5" "1.0"],"user");
174 atomsAutoloadList()
175
176 atomsAutoloadDel("toolbox_5");
177 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
178 atomsAutoloadList()
179
180 atomsRemove("toolbox_5","user");
181 atomsSetConfig("autoloadAddAfterInstall","True");
182 atomsRepositoryDel('http://scene1.test.atoms.scilab.org');
183
184 atomsAutoloadList()
185
186  ]]></programlisting>
187   </refsection>
188   <!-- ===================================================================== -->
189   <!-- See also -->
190   <!-- ===================================================================== -->
191   <refsection>
192     <title>See Also</title>
193     <simplelist type="inline">
194       <member>
195         <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
196       </member>
197       <member>
198         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
199       </member>
200     </simplelist>
201   </refsection>
202   <!-- ===================================================================== -->
203   <!-- Authors -->
204   <!-- ===================================================================== -->
205   <refsection>
206     <title>Authors</title>
207     <simplelist type="vert">
208       <member>Pierre MARECHAL - DIGITEO</member>
209     </simplelist>
210   </refsection>
211 </refentry>