123ccc7e0cf1e087133f8b2b9896168c62f98ce7
[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           <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, the most recent
53                                                                 version is used.
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, the most recent
60                                                                 version is installed.
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 which autoload list is changed.
74                                         </para>
75           <para>
76                                                 <literal>section</literal> is a single-string and its value should be :
77                                         </para>
78           <itemizedlist>
79             <listitem>
80               <para>
81                                                                 <literal>"allusers"</literal>: modules are added to the
82                                                                 "allusers" autoload list and all users of scilab are affected.
83                                                         </para>
84             </listitem>
85             <listitem>
86               <para><literal>"user"</literal>: modules are added to the
87                                                                 "user" autoload list and only the current user is affected.
88                                                         </para>
89             </listitem>
90           </itemizedlist>
91                                         <para>
92                                                 If SCI/contrib is write accessible, "allusers" is the default value.
93                                                 Otherwise, the default value is "user".
94                                         </para>
95         </listitem>
96                         </varlistentry>
97                         
98                         <!-- output parameter -->
99                         
100       <varlistentry>
101         <term>nbAdd</term>
102         <listitem>
103           <para>
104                                                 An integer : the number of modules successfully added.
105                                         </para>
106         </listitem>
107       </varlistentry>
108                         
109     </variablelist>
110   </refsection>
111   <!-- ===================================================================== -->
112   <!-- Description -->
113   <!-- ===================================================================== -->
114   <refsection>
115     <title>Description</title>
116     <para>
117           
118         </para>
119   </refsection>
120   <!-- ===================================================================== -->
121   <!-- Examples -->
122   <!-- ===================================================================== -->
123   <refsection>
124     <title>Examples</title>
125     <programlisting role="example"><![CDATA[
126
127 atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
128 atomsSetConfig("autoloadAddAfterInstall","False");
129
130 atomsInstall("toolbox_5","user");
131 atomsAutoloadList()
132
133 atomsAutoloadAdd("toolbox_5","user");
134 atomsAutoloadList()
135
136 atomsAutoloadDel(["toolbox_5"]);
137 atomsAutoloadAdd(["toolbox_5" "1.0"],"user");
138 atomsAutoloadList()
139
140 atomsAutoloadDel("toolbox_5");
141 atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
142 atomsAutoloadList()
143
144 atomsRemove("toolbox_5","user");
145 atomsSetConfig("autoloadAddAfterInstall","True");
146 atomsRepositoryDel('http://scene1.test.atoms.scilab.org');
147
148 atomsAutoloadList()
149
150  ]]></programlisting>
151   </refsection>
152   <!-- ===================================================================== -->
153   <!-- See also -->
154   <!-- ===================================================================== -->
155   <refsection>
156     <title>See Also</title>
157     <simplelist type="inline">
158       <member>
159         <link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
160       </member>
161       <member>
162         <link linkend="atomsAutoloadList">atomsAutoloadList</link>
163       </member>
164     </simplelist>
165   </refsection>
166   <!-- ===================================================================== -->
167   <!-- Authors -->
168   <!-- ===================================================================== -->
169   <refsection>
170     <title>Authors</title>
171     <simplelist type="vert">
172       <member>Pierre MARECHAL - DIGITEO</member>
173     </simplelist>
174   </refsection>
175 </refentry>