1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
*
* This file must be used under the terms of the CeCILL.
* This source file is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at
* http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
*
-->
<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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="atomsAutoloadAdd">
<refnamediv>
<refname>atomsAutoloadAdd</refname>
<refpurpose>Add one or several modules to autoload</refpurpose>
</refnamediv>
<!-- ===================================================================== -->
<!-- Calling Sequence -->
<!-- ===================================================================== -->
<refsynopsisdiv>
<title>Calling Sequence</title>
<synopsis>
nbAdd = atomsAutoloadAdd(modules[,section])
</synopsis>
</refsynopsisdiv>
<!-- ===================================================================== -->
<!-- Parameters -->
<!-- ===================================================================== -->
<refsection>
<title>Arguments</title>
<variablelist>
<!-- 1st input parameter -->
<varlistentry>
<term>modules</term>
<listitem>
<para>
mx1, mx2 or mx3 Matrix of strings:
</para>
<informaltable border="1">
<!-- Technical name -->
<tr>
<td>
<emphasis>1st Col.</emphasis>
</td>
<td>
<emphasis role="strong">Technical name</emphasis>
</td>
<td>
Mandatory
</td>
<td>
</td>
</tr>
<!-- Version -->
<tr>
<td>
<emphasis>2nd Col.</emphasis>
</td>
<td>
<emphasis role="strong">Version</emphasis>
</td>
<td>
Optional
</td>
<td>
If this field is empty or is not present,
the most recent version is used
</td>
</tr>
<!-- Section -->
<tr>
<td>
<emphasis>3rd Col.</emphasis>
</td>
<td>
<emphasis role="strong">Installed section</emphasis>
</td>
<td>
Optional
</td>
<td>
If this field is empty or is not present,
and <literal>module</literal> is installed in both "user" and
"allusers" sections, the section of autoload list is used.
</td>
</tr>
</informaltable>
</listitem>
</varlistentry>
<!-- 2nd input parameter -->
<varlistentry>
<term>section</term>
<listitem>
<para>
This argument controls which autoload list is changed.
</para>
<para>
<literal>section</literal> is a single-string and its value should be :
</para>
<itemizedlist>
<listitem>
<para>
<literal>"allusers"</literal>: modules are added to the
"allusers" autoload list and all users of scilab are affected.
</para>
</listitem>
<listitem>
<para>
<literal>"user"</literal>: modules are added to the
"user" autoload list and only the current user is affected.
</para>
</listitem>
</itemizedlist>
<para>
If SCI/contrib is write accessible, "allusers" is the default value.
Otherwise, the default value is "user".
</para>
</listitem>
</varlistentry>
<!-- output parameter -->
<varlistentry>
<term>nbAdd</term>
<listitem>
<para>
An integer : the number of modules successfully added.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<!-- ===================================================================== -->
<!-- Description -->
<!-- ===================================================================== -->
<refsection>
<title>Description</title>
<para>
</para>
</refsection>
<!-- ===================================================================== -->
<!-- Examples -->
<!-- ===================================================================== -->
<refsection>
<title>Examples</title>
<programlisting role="example"><![CDATA[
atomsRepositoryAdd('http://scene1.test.atoms.scilab.org');
atomsSetConfig("autoloadAddAfterInstall","False");
atomsInstall("toolbox_5","user");
atomsAutoloadList()
atomsAutoloadAdd("toolbox_5","user");
atomsAutoloadList()
atomsAutoloadDel(["toolbox_5"]);
atomsAutoloadAdd(["toolbox_5" "1.0"],"user");
atomsAutoloadList()
atomsAutoloadDel("toolbox_5");
atomsAutoloadAdd(["toolbox_5" "1.0" "user"],"user");
atomsAutoloadList()
atomsRemove("toolbox_5","user");
atomsSetConfig("autoloadAddAfterInstall","True");
atomsRepositoryDel('http://scene1.test.atoms.scilab.org');
atomsAutoloadList()
]]></programlisting>
</refsection>
<!-- ===================================================================== -->
<!-- See also -->
<!-- ===================================================================== -->
<refsection role="see also">
<title>See Also</title>
<simplelist type="inline">
<member>
<link linkend="atomsAutoloadDel">atomsAutoloadDel</link>
</member>
<member>
<link linkend="atomsAutoloadList">atomsAutoloadList</link>
</member>
</simplelist>
</refsection>
<!-- ===================================================================== -->
<!-- Authors -->
<!-- ===================================================================== -->
</refentry>
|
